TEMA about_Command_Syntax DESCRIPCIÓN BREVE Describe la notación utilizada para la sintaxis de Windows PowerShell en la Ayuda. DESCRIPCIÓN DETALLADA El cmdlet Get-Help muestra el uso de los parámetros para un cmdlet. El cmdlet Get-Help utiliza los símbolos especiales siguientes: Los corchetes angulares (<>) indican texto de marcadores de posición. Los corchetes ([]) indican elementos opcionales. Las llaves ({}) indican una opción entre varios valores. Algunos cmdlets tienen más de un conjunto de parámetros. Es posible que conjuntos de parámetros distintos compartan algunos parámetros. El cmdlet Get-Help muestra todos los conjuntos de parámetros de un cmdlet. Encontrará información adicional sobre un parámetro en la descripción del parámetro y en su tabla de atributos. Para ver la información completa sobre un parámetro, se utilizan los parámetros 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 documentación de Windows PowerShell, se utiliza la notación siguiente. <nombre del cmdlet> -<nombre de parámetro obligatorio> <valor de parámetro obligatorio> [-<nombre de parámetro opcional> <valor de parámetro opcional>] [-<parámetro de modificador opcional>] [-<nombre de parámetro opcional>] <valor de parámetro obligatorio> A continuación 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 mayúsculas para mejorar la legibilidad, pero Windows PowerShell no efectúa distinción entre mayúsculas y minúsculas. Los parámetros aparecen en orden. El orden de los parámetros es significativo solamente cuando los nombres de parámetro son opcionales. Si no se especifican los nombres de parámetro al utilizar un cmdlet, Windows PowerShell asigna los valores a los parámetros según su posición y tipo. Los nombres de los parámetros van precedidos por un guión (-). Los parámetros de modificador aparecen sin tipo de valor. Otros parámetros aparecen con el tipo de Microsoft .NET Framework del argumento necesario o con una enumeración de valores posibles. Para obtener más información sobre los tipos de .NET Framework, vea https://go.microsoft.com/fwlink/?LinkId=143682. Los corchetes angulares (<>) indican texto de marcadores de posición. Este texto puede describir el tipo de un elemento (como una cadena o un objeto Process). También puede tratarse de un marcador de posición para uno o más parámetros comunes. Los corchetes ([]) indican elementos opcionales. Un parámetro puede ser opcional o puede que el nombre de un parámetro necesario sea opcional. Los parámetros de modificador siempre son opcionales. Las llaves ({}) aparecen alrededor de los valores de una enumeración. En el ejemplo del cmdlet New-Alias, el parámetro Option puede tener cualquiera de los valores enumerados. Elementos opcionales Los elementos opcionales se indican entre corchetes ([]). Por ejemplo, en la descripción de la sintaxis del cmdlet New-Alias, el parámetro Scope es opcional. Esto se indica en la sintaxis poniendo el nombre y el tipo del parámetro 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 parámetro puede ser opcional aunque su valor sea necesario. Esto se indica en la sintaxis poniendo el nombre del parámetro 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 parámetro no se incluye en la instrucción tal y como se ha indicado, Windows PowerShell intenta utilizar la posición de los argumentos para asignar valores a los parámetros. El ejemplo siguiente no está completo: New-Alias utd Este cmdlet requiere valores para los parámetros Value y Name. En los ejemplos de la sintaxis, también 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 también 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 parámetro 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 TAMBIÉN Get-Help