Windows PowerShell incluye temas detallados de la Ayuda que explican conceptos de Windows PowerShell y el lenguaje de Windows PowerShell. También hay temas de Ayuda para cada cmdlet y cada proveedor, y temas de Ayuda para muchas funciones y scripts.

Puede ver estos temas de Ayuda en el símbolo del sistema. También puede ver las versiones actualizadas más recientes de estos temas en Microsoft TechNet Library. Muchos programas que hospedan Windows PowerShell, como Entorno de scripting integrado de Windows PowerShell, proporcionan otras características de Ayuda, como la Ayuda contextual y el archivo de Ayuda compilado (.chm).

Obtener la Ayuda de los cmdlets

Para obtener la Ayuda de los cmdlets de Windows PowerShell, utilice el cmdlet Get-Help. Por ejemplo, para obtener la Ayuda del cmdlet Get-ChildItem, escriba:

get-help get-childitem

O bien

get-childitem -?

Puede obtener incluso la Ayuda del cmdlet Get-Help. Por ejemplo:

get-help get-help

Para obtener una lista de todos los temas de Ayuda de cmdlets en su sesión, escriba:

get-help -category cmdlet

Para ver los temas de Ayuda página a página, utilice la función help o su alias man. Por ejemplo, para ver la Ayuda del cmdlet Get-ChildItem, escriba:

man get-childitem

O bien

help get-childitem

Para ver información detallada sobre un cmdlet, una función o un script, incluidas las descripciones de sus parámetros y ejemplos de cómo se utilizan, use el parámetro Detailed del cmdlet Get-Help. Por ejemplo, para obtener información detallada sobre el cmdlet Get-ChildItem, escriba:

get-help get-childitem -detailed

Para ver todo el contenido del tema de Ayuda, utilice el parámetro Full del cmdlet Get-Help. Por ejemplo, para ver todo el contenido del tema de Ayuda del cmdlet Get-ChildItem, escriba:

get-help get-childitem -full

Para obtener la Ayuda detallada de los parámetros de un cmdlet, utilice el parámetro Parameter del cmdlet Get-Help. Por ejemplo, para obtener la Ayuda detallada de todos los parámetros del cmdlet Get-ChildItem, escriba:

get-help get-childitem -parameter *

Para ver solo los ejemplos de un tema de Ayuda, utilice el parámetro Example del cmdlet Get-Help. Por ejemplo, para ver solamente los ejemplos del tema de Ayuda del cmdlet Get-ChildItem, escriba:

get-help get-childitem -examples

Para obtener información sobre cómo se escriben los temas de Ayuda de los cmdlets que escribe, vea el tema acerca de cómo se escribe la Ayuda de los cmdlets en MSDN.

Obtener la Ayuda conceptual

El cmdlet Get-Help también muestra información sobre temas conceptuales de Windows PowerShell, incluidos los temas que tratan del lenguaje de Windows PowerShell. Los nombres de los temas de Ayuda conceptuales tienen el prefijo "about_", como por ejemplo about_line_editing. El nombre del tema conceptual se debe escribir en inglés, incluso en las versiones de Windows PowerShell que no estén en inglés.

Para mostrar la lista de temas conceptuales, escriba:

get-help about_*

Para ver un tema de Ayuda específico, escriba el nombre del tema, por ejemplo:

get-help about_command_syntax

Los parámetros de Get-Help, como Detailed, Parameter y Examples, no afectan a la presentación de los temas de Ayuda conceptuales.

Obtener Ayuda sobre los proveedores

El cmdlet Get-Help muestra información acerca de los proveedores de Windows PowerShell. Para obtener la Ayuda de un proveedor, escriba "Get-Help" seguido del nombre del proveedor. Por ejemplo, para obtener la Ayuda del proveedor del Registro, escriba:

get-help registry

Para obtener una lista de todos los temas de Ayuda de proveedores en su sesión, escriba:

get-help -category provider

Los parámetros de Get-Help, como Detailed, Parameter y Examples, no afectan a la presentación de los temas de Ayuda de proveedores.

Obtener Ayuda sobre los scripts y las funciones

Muchos scripts y funciones de Windows PowerShell tienen temas de Ayuda. Use el cmdlet Get-Help para ver los temas de Ayuda de los scripts y las funciones.

Para ver la Ayuda de una función, escriba "get-help" seguido del nombre de la función. Por ejemplo, para obtener la Ayuda de la función Disable-PSRemoting, escriba:

get-help disable-psremoting

Para ver la Ayuda de un script, escriba la ruta de acceso completa al archivo de script. Si la ruta de acceso del script está en la variable de entorno Path, puede omitirla en el comando.

Por ejemplo, si hay un script denominado "TestScript.ps1" en el directorio C:\PS-Test, para ver el tema de Ayuda del script, escriba:

get-help c:\ps-test\TestScript.ps1

Los parámetros que se diseñaron para ver la Ayuda de cmdlets, como Detailed, Full, Examples y Parameter, también sirven para ver la Ayuda de scripts y de funciones. Sin embargo, cuando se escribe "get-help *" para ver toda la Ayuda, la Ayuda de scripts y de funciones no se muestra.

Para obtener información sobre cómo se escriben los temas de Ayuda de los scripts y las funciones, vea about_Functions, about_Scripts y about_Comment_Based_Help.

Obtener Ayuda en línea

Si está conectado a Internet, una de las mejores maneras de obtener Ayuda es ver los temas de Ayuda en línea. Dado que los temas en línea se actualizan fácilmente, es probable que proporcionen el contenido más actual.

Para obtener Ayuda en línea, intente utilizar el parámetro Online del cmdlet Get-Help. El parámetro Online del cmdlet Get-Help sólo funciona para la Ayuda de cmdlets, scripts y funciones. No se puede utilizar el parámetro Online con los temas conceptuales (temas "acerca de") ni con los temas de Ayuda de proveedores. Además, como esta característica es opcional, no funciona para los temas de Ayuda de cada cmdlet, script o función.

Sin embargo, todos los temas de Ayuda que se proporcionan con Windows PowerShell, incluidos los temas de Ayuda conceptuales (temas "acerca de") y los temas de Ayuda de proveedores, están disponibles en la sección Windows PowerShell de Microsoft TechNet Library.

Para utilizar el parámetro Online del cmdlet Get-Help, utilice el formato de comando siguiente.

get-help <command-name> -online

Por ejemplo, para abrir la versión en línea del tema de Ayuda del cmdlet Get-ChildItem, escriba:

get-help get-childitem -online

Si una versión en línea del tema de Ayuda está disponible, se abrirá en el explorador predeterminado.

Si un tema de Ayuda admite la Ayuda en línea, también podrá ver la dirección de Internet (URL) del tema de Ayuda. La dirección de Internet aparece en la sección Vínculos relacionados de un tema de Ayuda.

Por ejemplo, para ver la dirección URL de la versión en línea del cmdlet Add-Computer, escriba:

get-help add-computer

A continuación se muestra la primera línea de la sección Vínculos relacionados del tema.

Online version: https://go.microsoft.com/fwlink/?LinkID=135194

Para obtener información sobre cómo se proporciona soporte técnico en línea para los temas de Ayuda, vea about_Comment_Based_Help y "How to Write Cmdlet Help" (en inglés) (https://go.microsoft.com/fwlink/?LinkID=123415) en MSDN (Microsoft Developer Network) Library.

Vea también




Tabla de contenido