TEMA

about_Command_Syntax
DESCRIPCIN BREVE
Describe la notacin utilizada para la sintaxis de Windows
PowerShell en la Ayuda.
DESCRIPCIN DETALLADA
El cmdlet Get-Help muestra el uso de los parmetros para un cmdlet.
El cmdlet Get-Help utiliza los smbolos especiales siguientes:
Los corchetes angulares (<>) indican texto de marcadores de posicin.
Los corchetes ([]) indican elementos opcionales. Las llaves
({}) indican una opcin entre varios valores.
Algunos cmdlets tienen ms de un conjunto de parmetros. Es posible
que conjuntos de parmetros distintos compartan algunos parmetros.
El cmdlet Get-Help muestra todos los conjuntos de parmetros de un cmdlet.
Encontrar informacin adicional sobre un parmetro en la
descripcin del parmetro y en su tabla de atributos. Para ver la
informacin completa sobre un parmetro, se utilizan los parmetros Full o
Parameter de Get-Help.
Sintaxis
En las descripciones de la sintaxis de los cmdlets de la Ayuda
de cmdlets, los temas de Ayuda y otra documentacin de Windows
PowerShell, se utiliza la notacin siguiente.
<nombre del cmdlet> -<nombre de parmetro obligatorio> <valor de
parmetro obligatorio>
[-<nombre de parmetro opcional> <valor de parmetro opcional
>]
[-<parmetro de modificador opcional>]
[-<nombre de parmetro opcional>] <valor de parmetro obligat
orio>
A continuacin se muestra la sintaxis del cmdlet New-Alias.
New-Alias [-Force] [-PassThru] [-Scope <string>]
[-Option {None | ReadOnly | Constant | Private | AllScope}]
[-Description <string>] [-Name] <string> [-Value] <string>
[-confirm] [-whatif] [<CommonParameters>]
La sintaxis se pone en maysculas para mejorar la legibilidad, pero
Windows PowerShell no efecta distincin entre maysculas y minsculas.
Los parmetros aparecen en orden. El orden de los parmetros es
significativo solamente cuando los nombres de parmetro son opcionales.
Si no se especifican los nombres de parmetro al utilizar un cmdlet,
Windows PowerShell asigna los valores a los parmetros segn su posicin y tipo.

Los nombres de los parmetros van precedidos por un guin (-). Los parmetros
de modificador aparecen sin tipo de valor. Otros parmetros aparecen con el
tipo
de Microsoft .NET Framework del argumento necesario o con una enumeracin de
valores posibles. Para obtener ms informacin sobre los tipos de .NET Framewo
rk,
vea http://go.microsoft.com/fwlink/?LinkId=143682.
Los corchetes angulares (<>) indican texto de marcadores de posicin.
Este texto puede describir el tipo de un elemento (como una cadena o un ob
jeto
Process). Tambin puede tratarse de un marcador de posicin para uno o ms
parmetros comunes.
Los corchetes ([]) indican elementos opcionales. Un parmetro puede ser
opcional o puede que el nombre de un parmetro necesario sea opcional.
Los parmetros de modificador siempre son opcionales.
Las llaves ({}) aparecen alrededor de los valores de una enumeracin.
En el ejemplo del cmdlet New-Alias, el parmetro Option puede tener
cualquiera de los valores enumerados.
Elementos opcionales
Los elementos opcionales se indican entre corchetes ([]). Por ejemplo,
en la descripcin de la sintaxis del cmdlet New-Alias, el parmetro
Scope es opcional. Esto se indica en la sintaxis poniendo el nombre
y el tipo del parmetro entre corchetes:
[-Scope <string>]
En los dos ejemplos siguientes se muestran usos correctos del
cmdlet New-Alias:
New-Alias -Name utd -Value Update-TypeData New-Alias -Name
utd -Value Update-TypeData -Scope global
El nombre de un parmetro puede ser opcional aunque su valor
sea necesario. Esto se indica en la sintaxis poniendo el nombre del
parmetro entre corchetes alrededor pero no su tipo, como en este
ejemplo del cmdlet New-Alias:
[-Name] <string> [-Value] <string>
Los comandos siguientes utilizan correctamente el cmdlet
New-Alias. Los comandos generan el mismo resultado:
New-Alias -Name utd -Value Update-TypeData New-Alias -Name
utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData

Si el nombre de parmetro no se incluye en la instruccin tal y

como se ha indicado, Windows PowerShell intenta utilizar la
posicin de los argumentos para asignar valores a los parmetros.
El ejemplo siguiente no est completo:
New-Alias utd
Este cmdlet requiere valores para los parmetros Value y Name.
En los ejemplos de la sintaxis, tambin se usan corchetes para
denominar y convertir tipos de .NET Framework. En este contexto, los
corchetes no indican que un elemento sea opcional.
Argumentos de matrices
Los corchetes tambin se utilizan en las descripciones de la
sintaxis para representar una matriz. En el ejemplo siguiente
se muestra la sintaxis para el cmdlet Restart-Service:
Restart-Service [-Name] <string[]> [-Include <string[]>]
[-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf]
[<CommonParameters>]
El parmetro Name requiere un argumento. En concreto, requiere
el nombre del servicio que se debe reiniciar. Puede aceptar una
lista de servicios separados por comas, como en el ejemplo
siguiente:
Restart-Service RasAuto, RasMan, RemoteAccess
VEA TAMBIN
Get-Help