Get-Help
Muestra información acerca de los comandos y conceptos de Windows PowerShell.
Sintaxis
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Ejemplos] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Descripción
El cmdlet Get-Help muestra información sobre los conceptos y comandos de Windows PowerShell, incluidos los cmdlets, proveedores, funciones y scripts. Para obtener una lista de todos los títulos de los temas de Ayuda de cmdlets, escriba "get-help *".
Si escribe "Get-Help" seguido del nombre exacto de un tema de la Ayuda o de una palabra que solo aparece en un tema de la Ayuda, Get-Help mostrará el contenido del tema. Si escribe una palabra o un patrón de palabra que aparece en varios títulos de temas de la Ayuda, Get-Help mostrará una lista de títulos coincidentes. Si escribe una palabra que no aparece en ningún título de temas de la Ayuda, Get-Help mostrará una lista de temas que incluyen esa palabra en su contenido.
Además de "get-help", también se puede escribir "help" o "man", que muestra una pantalla de texto cada vez, o "<nombreDeCmdlet> -?" que equivale exactamente a Get-Help pero funciona solamente para los cmdlets.
Se puede mostrar el archivo de Ayuda de cmdlets completo o partes seleccionadas del archivo, como la sintaxis, los parámetros o los ejemplos. También se puede utilizar el parámetro Online para mostrar una versión en pantalla de un archivo de Ayuda de cmdlets en el explorador de Internet. Estos parámetros no tienen ningún efecto en los temas de la Ayuda conceptual.
Los temas de la Ayuda conceptual de Windows PowerShell empiezan por "about_", como "about_Comparison_Operators". Para ver todos los temas "about_", escriba "get-help about_*". Para ver un tema concreto, escriba "get-help about_<nombreDeTema>", como "get-help "about_Comparison_Operators".
Parámetros
-Category <string[]>
Muestra la Ayuda de elementos correspondientes a la categoría especificada. Los valores válidos son Alias, Cmdlet, Provider y HelpFile. Los temas conceptuales están en la categoría HelpFile.
Category es una propiedad del objeto MamlCommandHelpInfo que devuelve Get-Help. Este parámetro no afecta a la presentación de la Ayuda conceptual ("about_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Component <string[]>
Muestra una lista de herramientas con el valor de componente especificado, como "Exchange". Escriba un nombre de componente. Se permite el uso de caracteres comodín.
Component es una propiedad del objeto MamlCommandHelpInfo que devuelve Get-Help. Este parámetro no afecta a la presentación de la Ayuda conceptual ("About_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Detailed
Agrega descripciones de parámetros y ejemplos a la presentación de Ayuda básica.
Este parámetro no afecta a la presentación de la Ayuda conceptual ("About_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Ejemplos
Muestra solo el nombre, la sinopsis y ejemplos. Para mostrar únicamente los ejemplos, escriba "(get-help <nombreDeCmdlet>).examples".
Este parámetro no afecta a la presentación de la Ayuda conceptual ("About_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Full
Muestra el archivo de Ayuda completo para un cmdlet, con las descripciones de parámetros y atributos, ejemplos, tipos de objeto de entrada y salida, y notas adicionales.
Este parámetro no afecta a la presentación de la Ayuda conceptual ("About_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Functionality <string[]>
Muestra la Ayuda de los elementos con la funcionalidad especificada. Escriba la funcionalidad. Se permite el uso de caracteres comodín.
Functionality es una propiedad del objeto MamlCommandHelpInfo que devuelve Get-Help. Este parámetro no afecta a la presentación de la Ayuda conceptual ("About_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Name <string>
Solicita ayuda acerca de la herramienta o tema conceptual especificado. Escriba un nombre de cmdlet, proveedor, script o función, como Get-Member, un nombre de tema conceptual, como "about_Objects", o un alias, como "ls". Se permite el uso de caracteres comodín en los nombres de proveedor y cmdlet, pero no se pueden utilizar estos caracteres para buscar nombres de temas de Ayuda de funciones y de scripts.
Para obtener ayuda para un script que no se encuentra en una ruta de acceso mostrada en la variable de entorno Path, escriba la ruta de acceso y el nombre de archivo del script.
Si escribe el nombre exacto de un tema de Ayuda, Get-Help mostrará el contenido del tema. Si escribe una palabra o un patrón de palabra que aparece en varios títulos de temas de Ayuda, Get-Help mostrará una lista de títulos coincidentes. Si escribe una palabra que no coincide con ningún título de temas de Ayuda, Get-Help mostrará una lista de temas que incluyen esa palabra en su contenido.
Los nombres de los temas conceptuales, como about_Objects, deben escribirse en inglés, incluso en las versiones de Windows PowerShell que no estén en inglés.
¿Requerido? |
false |
¿Posición? |
1 |
Valor predeterminado |
|
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-Online
Muestra la versión en pantalla de un tema de Ayuda en el explorador de Internet predeterminado. Este parámetro es válido solo para los temas de Ayuda de cmdlets, funciones y scripts.
Get-Help utiliza la dirección de Internet (identificador uniforme de recursos [URI]) que aparece en el primer elemento de la sección Vínculos relacionados de un tema de Ayuda de cmdlets, funciones o scripts. Este parámetro funciona solo cuando los temas de Ayuda incluyen un identificador URI que comienza por "Http" o "Https" y hay un explorador de Internet instalado en el sistema.
Para obtener información acerca de cómo se proporciona soporte técnico para esta función en los temas de Ayuda que escribe, vea about_comment_based_help y también el tema sobre cómo escribir la ayuda de los cmdlets en MSDN (Microsoft Developer Network) Library en https://go.microsoft.com/fwlink/?LinkID=123415.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Parameter <string>
Muestra solamente las descripciones detalladas de los parámetros especificados. Se permite el uso de caracteres comodín.
Este parámetro no afecta a la presentación de la Ayuda conceptual ("About_").
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Path <string>
Obtiene ayuda que explica cómo funciona el cmdlet en la ruta de acceso especificada del proveedor. Escriba la ruta de acceso de un proveedor de Windows PowerShell.
Este parámetro obtiene una versión personalizada de un tema de Ayuda de cmdlet en el que se explica cómo funciona el cmdlet en la ruta de acceso especificada del proveedor de Windows PowerShell. Este parámetro es efectivo únicamente para obtener ayuda sobre un cmdlet del proveedor y solamente si el proveedor incluye una versión personalizada del tema de Ayuda.
Si desea ver la Ayuda de cmdlets personalizada para una ruta de acceso de proveedor, vaya a la ubicación de la ruta de acceso del proveedor y escriba un comando Get-Help, o bien, desde cualquier ubicación de ruta de acceso, utilice el parámetro Path de Get-Help para especificar la ruta de acceso del proveedor. Para obtener más información, vea about_Providers.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Role <string[]>
Muestra la Ayuda personalizada para el rol de usuario especificado. Escriba un rol. Se permite el uso de caracteres comodín.
Escriba el rol que el usuario desempeña en una organización. Algunos cmdlets muestran texto distinto en sus archivos de Ayuda según el valor de este parámetro. Este parámetro no afecta a la Ayuda de los cmdlets principales.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
|
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
Entradas |
Ninguno No se pueden canalizar objetos a este cmdlet. |
Salidas |
System.String o MamlCommandHelpInfo Si se solicita un tema conceptual, Get-Help lo devuelve como una cadena. Si especifica el nombre de un cmdlet, una función o un script, devuelve un objeto MamlCommandHelpInfo. De lo contrario, Get-Help devuelve una o varias de las vistas con formato que se especifican en el archivo Help.Format.ps1xml del directorio $pshome. |
Notas
Sin parámetros, "Get-Help" muestra información acerca del sistema de Ayuda de Windows PowerShell.
La vista completa de la Ayuda (-full) incluye una tabla de información acerca de los parámetros. Esta tabla contiene los siguientes campos:
-- Required: indica si el parámetro es necesario (True) o es opcional (False).
-- Position: indica si el parámetro es un parámetro con nombre o posicional (numerado). Los parámetros posicionales deben aparecer en un lugar concreto del comando.
-- "Named" indica que el nombre del parámetro es necesario, pero que el parámetro puede aparecer en cualquier lugar del comando.
-- <Número> indica que el nombre del parámetro es opcional pero que, si se omite, el parámetro debe aparecer en el lugar especificado por el número. Por ejemplo, "2" indica que si se omite el nombre del parámetro, éste debe ser el segundo (2) parámetro o el único parámetro sin nombre del comando. Cuando se usa el nombre del parámetro, éste puede aparecer en cualquier lugar del comando.
-- Default value: valor del parámetro que Windows PowerShell usa si no se incluye el parámetro en el comando.
-- Accepts pipeline input: indica si se puede (True) o no se puede (False) enviar objetos al parámetro a través de una canalización. "ByPropertyName" significa que el objeto canalizado debe tener una propiedad con el mismo nombre que el parámetro.
-- Accepts wildcard characters: indica si el valor de un parámetro puede incluir caracteres comodín, como * y ?.
Ejemplo 1
C:\PS>get-help
Descripción
-----------
Este comando muestra la Ayuda acerca del sistema de Ayuda de Windows PowerShell.
Ejemplo 2
C:\PS>get-help *
Descripción
-----------
Este comando muestra una lista de todos los archivos del sistema de Ayuda de Windows PowerShell.
Ejemplo 3
C:\PS>get-help get-alias
C:\PS>help get-alias
C:\PS>get-alias -?
Descripción
-----------
Estos comandos muestran información básica acerca del cmdlet get-alias. Los comandos "Get-Help" y "-?" muestran la información en una sola página. El comando "Help" muestra la información, página a página.
Ejemplo 4
C:\PS>get-help about_*
Descripción
-----------
Este comando muestra una lista de los temas conceptuales incluidos en la Ayuda de Windows PowerShell. Todos estos temas comienzan por los caracteres "about_". Para mostrar un archivo de Ayuda concreto, escriba "get-help <nombreDeTema>", por ejemplo, "get-help about_signing".
Ejemplo 5
C:\PS>get-help ls -detailed
Descripción
-----------
Este comando muestra la Ayuda detallada referente al cmdlet Get-ChildItem especificando uno de sus alias, "ls". El parámetro Detailed solicita la vista detallada del archivo de Ayuda, que incluye descripciones de parámetros y ejemplos. Para ver el archivo de Ayuda completo de un cmdlet, use el parámetro Full.
Ejemplo 6
C:\PS>get-help format-string -full
Descripción
-----------
Este comando muestra la vista completa de la Ayuda del cmdlet Format-String. Esta vista completa de la Ayuda incluye descripciones, ejemplos y una tabla de información técnica acerca de los parámetros.
Ejemplo 7
C:\PS>get-help start-service -examples
Descripción
-----------
Este comando muestra ejemplos del uso de start-service en comandos de Windows PowerShell.
Ejemplo 8
C:\PS>get-help get-childitem -parameter f*
Descripción
-----------
Este comando muestra descripciones de los parámetros del cmdlet Get-ChildItem que empiezan por "f" (filter y force). Para obtener las descripciones de todos los parámetros, escriba "get-help get-childitem parameter*".
Ejemplo 9
C:\PS>(get-help write-output).syntax
Descripción
-----------
Este comando muestra únicamente la sintaxis del cmdlet Write-Output.
La sintaxis es una de muchas propiedades de los objetos de Ayuda, otras son la descripción, información detallada, ejemplos y parámetros. Para buscar todas las propiedades y métodos de los objetos de Ayuda, escriba "get-help <nombreDeCmdlet> | get-member", por ejemplo, "get-help start-service | get member".
Ejemplo 10
C:\PS>(get-help trace-command).alertset
Descripción
-----------
Este comando muestra las notas acerca del cmdlet. Las notas se almacenan en la propiedad alertSet del objeto de ayuda.
Las notas incluyen información conceptual y sugerencias para utilizar el cmdlet. De forma predeterminada, las notas se muestran solamente cuando se utiliza el parámetro Full de Get-Help, pero también se pueden mostrar utilizando la propiedad alertSet.
Ejemplo 11
C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml
Descripción
-----------
En este ejemplo se muestra la forma de buscar una palabra en un tema de Ayuda de cmdlet concreto. Este comando busca la palabra "clixml" en la versión completa del tema de Ayuda referente al cmdlet Add-Member.
Dado que el cmdlet Get-Help genera un objeto MamlCommandHelpInfo, no una cadena, se necesita utilizar un comando que transforme el contenido del tema de Ayuda en una cadena, como Out-String u Out-File.
Ejemplo 12
C:\PS>get-help get-member -online
Descripción
-----------
Este comando muestra la versión en pantalla del tema de Ayuda referente al cmdlet Get-Member.
Ejemplo 13
C:\PS>get-help remoting
Descripción
-----------
Este comando muestra una lista de temas que incluyen la palabra "remoting" (comunicación remota) en su contenido.
Si escribe una palabra que no aparece en ningún título de temas, Get-Help mostrará una lista de temas que incluyen esa palabra.
Ejemplo 14
C:\PS>get-help get-item -path SQLSERVER:\DataCollection
NAME
Get-Item
SYNOPSIS
Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.
...
C:\PS> cd SQLSERVER:\DataCollection
C:\PS> SQLSERVER:\DataCollection> get-help get-item
NAME
Get-Item
SYNOPSIS
Gets a collection of Server objects for the local computer and any computers to which you have made a SQL Server PowerShell connection.
...
C:\PS> Get-Item
NAME
Get-Item
SYNOPSIS
Gets the item at the specified location.
...
Descripción
-----------
En este ejemplo se muestra la forma de obtener ayuda para el cmdlet Get-Item que explica cómo se utiliza el cmdlet en el nodo DataCollection del proveedor SQL Server de Windows PowerShell.
En el ejemplo se muestran dos maneras de obtener ayuda personalizada para Get-Item.
El primer comando utiliza el parámetro Path de Get-Help para especificar la ruta de acceso del proveedor. Este comando se puede escribir en cualquier ubicación de ruta de acceso.
El segundo comando utiliza el cmdlet Set-Location (alias = "cd") para ir a la ruta de acceso del proveedor. Desde esa ubicación, incluso sin el parámetro Path, el comando Get-Help obtiene la ayuda personalizada para la ruta de acceso del proveedor.
El tercer comando muestra ese comando Get-Help en una ruta de acceso al sistema de archivos y, sin el parámetro Path, obtiene la ayuda estándar para el cmdlet Get-Item.
Ejemplo 15
C:\PS>get-help c:\ps-test\MyScript.ps1
Descripción
-----------
Este comando obtiene la Ayuda para el script MyScript.ps1. Para obtener información sobre cómo escribir ayuda para las funciones y los scripts, vea about_Comment_Based_Help.