El cmdlet Get-Help es una herramienta de gran utilidad para conocer Windows PowerShell. Mediante las descripciones de los cmdlets, los conceptos y los temas relativos al lenguaje, podrá comprender cómo se utiliza Windows PowerShell.

El primer tema de interés puede ser el propio sistema de Ayuda. Para mostrar información sobre el sistema de Ayuda en Windows PowerShell, escriba:

get-help

Es posible que después desee conocer algunos de los cmdlets básicos, como Get-Help, Get-Command, Get-Process, Get-Service y Get-Eventlog.

Para ver la Ayuda de un cmdlet con el formato más sencillo, escriba "get-help" seguido del nombre del cmdlet. Por ejemplo, para obtener la Ayuda del cmdlet Get-Command, escriba:

get-help get-command

Si la Ayuda del cmdlet no tiene el formato correcto, es decir, comienza con etiquetas XMLNS, es posible que la directiva de ejecución de Windows PowerShell impida que el sistema cargue el archivo de configuración que da formato a la Ayuda de los cmdlets. Para obtener más información sobre las directivas de ejecución, escriba:

get-help about_execution_policies

Para ver la Ayuda detallada sobre un cmdlet que incluya descripciones de los parámetros y ejemplos, utilice el parámetro Detailed de Get-Help. Por ejemplo, para ver la Ayuda detallada del cmdlet Get-Command, escriba:

get-help get-command -detailed

Para ver toda la Ayuda disponible de un cmdlet que incluya información técnica sobre el cmdlet y sus parámetros, utilice el parámetro Full. Por ejemplo, para ver la Ayuda completa del cmdlet Get-Command, escriba:

get-help get-command -full

También puede ver partes seleccionadas del archivo de Ayuda. Para ver exclusivamente los ejemplos, utilice el parámetro Examples. Por ejemplo, para mostrar los ejemplos del cmdlet Get-Command, escriba:

get-help get-command -examples

Para ver exclusivamente descripciones detalladas de los parámetros, utilice el parámetro Parameter de Get-Help. Puede especificar el nombre de un parámetro o utilizar el carácter comodín (*) para especificar todos los parámetros. Por ejemplo, para ver una descripción del parámetro TotalCount de Get-Command, escriba:

get-help get-command -parameter totalcount

Para ver todos los parámetros del cmdlet Get-Command, escriba:

get-help get-command -parameter *

La Ayuda de Windows PowerShell también está disponible en el tema Windows PowerShell de Microsoft TechNet Library. La versión en línea de la Ayuda suele ser más fácil de leer y se actualiza con más frecuencia que la Ayuda que se muestra en el símbolo del sistema.

En Windows PowerShell 2.0 puede utilizar el parámetro Online del cmdlet Get-Help para ver la versión en línea del tema de Ayuda de un cmdlet. De forma predeterminada, el parámetro Online proporciona vínculos a los temas de Ayuda de TechNet Library.

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

get-help get-process -online

También puede utilizar una de las funciones de Windows PowerShell que llaman a Get-Help. La función Help muestra una pantalla de la Ayuda cada vez. La función Man muestra la Ayuda de forma similar a las páginas Man de UNIX. Si desea utilizar las funciones Help y Man para mostrar la Ayuda del cmdlet Get-Command, escriba:

man get-command

O bien

help get-command

Cuando se solicita un tema de Ayuda determinado, Get-Help muestra el contenido de dicho tema. Sin embargo, si se utilizan caracteres comodín para solicitar varios temas, Get-Help muestra una lista de temas. Por ejemplo, para ver una lista de temas de Ayuda de los cmdlets "Get", escriba:

get-help get-*

Los temas de Ayuda que explican conceptos de Windows PowerShell empiezan por "about_". Para mostrar la Ayuda sobre un concepto de Windows PowerShell, escriba "get-help" seguido del nombre del concepto. El nombre del concepto se debe escribir en inglés, incluso en las versiones de Windows PowerShell que no estén en inglés.

Por ejemplo, para ver la Ayuda sobre caracteres comodín, escriba:

get-help about_wildcards

Para mostrar una lista de todos los temas de Ayuda conceptuales de Windows PowerShell, escriba:

get-help about_*

Si lee los temas de Ayuda e intenta ejecutar los ejemplos, aprenderá a utilizar Windows PowerShell.

Vea también




Tabla de contenido