Get-Help

  • Referencia
Módulo:
Microsoft.PowerShell.Core

Muestra información sobre los conceptos y comandos de PowerShell.

Syntax

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Description

El Get-Help cmdlet muestra información sobre los conceptos y comandos de PowerShell, incluidos cmdlets, funciones, comandos de Common Information Model (CIM), flujos de trabajo, proveedores, alias y scripts.

Para obtener ayuda para un cmdlet de PowerShell, escriba Get-Help seguido del nombre del cmdlet, como: Get-Help Get-Process.

Los artículos de ayuda conceptual de PowerShell comienzan con about_, como about_Comparison_Operators. Para ver todos los artículos de about_ , escriba Get-Help about_*. Para ver un artículo determinado, escriba Get-Help about_<article-name>, como Get-Help about_Comparison_Operators.

Para obtener ayuda para un proveedor de PowerShell, escriba Get-Help seguido del nombre del proveedor. Por ejemplo, para obtener ayuda para el proveedor de certificados, escriba Get-Help Certificate.

También puede escribir help o man, que muestra una pantalla de texto a la vez. O bien, <cmdlet-name> -?, que es idéntico a Get-Help, pero solo funciona para cmdlets.

Get-Help obtiene el contenido de ayuda que se muestra a partir de archivos de ayuda en el equipo. Sin los archivos de ayuda, Get-Help solo muestra información básica sobre los cmdlets. Algunos módulos de PowerShell incluyen archivos de ayuda. A partir de PowerShell 3.0, los módulos que vienen con el sistema operativo Windows no incluyen archivos de ayuda. Para descargar o actualizar los archivos de ayuda de un módulo en PowerShell 3.0, use el Update-Help cmdlet .

También puede ver los documentos de ayuda de PowerShell en línea. Para obtener la versión en línea de un archivo de ayuda, use el parámetro Online , como: Get-Help Get-Process -Online.

Si escribe Get-Help seguido del nombre exacto de un artículo de ayuda o por una palabra única para un artículo de ayuda, Get-Help muestra el contenido del artículo. Si especifica el nombre exacto de un alias de comando, Get-Help muestra la ayuda del comando original. Si escribe un patrón de palabras o palabras que aparece en varios títulos del artículo de ayuda, Get-Help muestra una lista de los títulos coincidentes. Si escribe algún texto que no aparezca en ningún título de artículo de ayuda, Get-Help muestra una lista de artículos que incluyen ese texto en su contenido.

Get-Help puede obtener artículos de ayuda para todos los idiomas y configuraciones regionales admitidos. Get-Help primero busca archivos de ayuda en la configuración regional establecida para Windows y, a continuación, en la configuración regional primaria, como pt para pt-BR y, a continuación, en una configuración regional de reserva. A partir de PowerShell 3.0, si Get-Help no encuentra ayuda en la configuración regional de reserva, busca artículos de ayuda en inglés, en-US, antes de devolver un mensaje de error o mostrar ayuda generada automáticamente.

Para obtener información sobre los símbolos que Get-Help se muestran en el diagrama de sintaxis de comandos, vea about_Command_Syntax. Para obtener información sobre los atributos de parámetro, como Required y Position, consulte about_Parameters.

Nota:

En PowerShell 3.0 y PowerShell 4.0, Get-Help no se pueden encontrar artículos acerca de los módulos a menos que el módulo se importe en la sesión actual. Para obtener información acerca de los artículos de un módulo, importe el módulo mediante el Import-Module cmdlet o ejecutando un cmdlet incluido en el módulo.

A partir de PSReadLine v2.2.2, el módulo se incluye con dos funciones que proporcionan acceso rápido para ayudarle mientras escribe un comando en la línea de comandos. La ayuda se muestra en el terminal en un búfer de pantalla alternativo con paginación.

Cuando se alcanza la tecla F1 , la función PSReadLineShowCommandHelp invoca Get-Help -Full para el nombre del cmdlet más cercano a la izquierda del cursor. Cuando el cursor está inmediatamente a la izquierda de un parámetro, la función salta a la descripción de ese parámetro en el tema de ayuda completo. Al presionar Q para salir de la vista de ayuda, se le devuelve a la línea de comandos en la misma posición del cursor para poder seguir escribiendo el comando.

Cuando se usa la combinación de teclas Alt+h, la función PSReadLineShowParameterHelp muestra información de ayuda para el parámetro inmediatamente a la izquierda del cursor. El texto de ayuda se muestra debajo de la línea de comandos. Esto le permite ver la descripción del parámetro y continuar escribiendo el comando.

Para obtener más información, consulte Uso de la ayuda dinámica.

Ejemplos

Ejemplo 1: Mostrar información de ayuda básica sobre un cmdlet

Estos ejemplos muestran información básica de ayuda sobre el Format-Table cmdlet.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> es la sintaxis más sencilla y predeterminada del Get-Help cmdlet. Puede omitir el parámetro Name .

La sintaxis <cmdlet-name> -? solo funciona para cmdlets.

Ejemplo 2: Mostrar información básica de una página a la vez

Estos ejemplos muestran información básica de ayuda sobre el cmdlet de una página a la Format-Table vez.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help es una función que ejecuta Get-Help el cmdlet internamente y muestra el resultado una página a la vez.

man es un alias para la help función .

Get-Help Format-Table envía el objeto a la canalización. Out-Host -Paging recibe la salida de la canalización y la muestra una página a la vez. Para obtener más información, consulte Out-Host.

Ejemplo 3: Mostrar más información para un cmdlet

Estos ejemplos muestran información de ayuda más detallada sobre el Format-Table cmdlet.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

El parámetro Detailed muestra la vista detallada del artículo de ayuda que incluye descripciones y ejemplos de parámetros.

El parámetro Full muestra la vista completa del artículo de ayuda que incluye descripciones de parámetros, ejemplos, tipos de objetos de entrada y salida y notas adicionales.

Los parámetros Detailed y Full son efectivos solo para los comandos que tienen archivos de ayuda instalados en el equipo. Los parámetros no son eficaces para los artículos de ayuda conceptuales (about_).

Ejemplo 4: Mostrar las partes seleccionadas de un cmdlet mediante parámetros

Estos ejemplos muestran partes seleccionadas de la ayuda del Format-Table cmdlet.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

El parámetro Examples muestra las secciones NAME y SYNOPSIS del archivo de ayuda y todos los ejemplos. No se puede especificar un número de ejemplo porque el parámetro Examples es un parámetro switch.

El parámetro Parameter muestra solo las descripciones de los parámetros especificados. Si especifica solo el carácter comodín asterisco (*), muestra las descripciones de todos los parámetros. Cuando Parameter especifica un nombre de parámetro como GroupBy, se muestra información sobre ese parámetro.

Estos parámetros no son eficaces para los artículos de ayuda conceptuales (about_).

Ejemplo 5: Mostrar la versión en línea de ayuda

En este ejemplo se muestra la versión en línea del artículo de ayuda del cmdlet en el Format-Table explorador web predeterminado.

Get-Help Format-Table -Online

Ejemplo 6: Mostrar ayuda sobre el sistema de ayuda

El Get-Help cmdlet sin parámetros muestra información sobre el sistema de ayuda de PowerShell.

Get-Help

Ejemplo 7: Mostrar artículos de ayuda disponibles

En este ejemplo se muestra una lista de todos los artículos de ayuda disponibles en el equipo.

Get-Help *

Ejemplo 8: Mostrar una lista de artículos conceptuales

En este ejemplo se muestra una lista de los artículos conceptuales incluidos en la ayuda de PowerShell. Todos estos artículos comienzan con los caracteres about_. Para mostrar un archivo de ayuda determinado, escriba Get-Help \<about_article-name\>, por ejemplo, Get-Help about_Signing.

Solo se muestran los artículos conceptuales que tienen archivos de ayuda instalados en el equipo. Para obtener información sobre cómo descargar e instalar archivos de ayuda en PowerShell 3.0, consulte Update-Help.

Get-Help about_*

Ejemplo 9: Buscar una palabra en la ayuda del cmdlet

En este ejemplo se muestra cómo buscar una palabra en un artículo de ayuda de cmdlet.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help usa el parámetro Full para obtener información de ayuda para Add-Member. El objeto MamlCommandHelpInfo se envía a la canalización. Out-String usa el parámetro Stream para convertir el objeto en una cadena. Select-String usa el parámetro Pattern para buscar la cadena de Clixml.

Ejemplo 10: Mostrar una lista de artículos que incluyen una palabra

En este ejemplo se muestra una lista de artículos que incluyen la palabra comunicación remota.

Cuando escriba una palabra que no aparezca en ningún título de artículo, Get-Help muestra una lista de artículos que incluyen esa palabra.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Ejemplo 11: Mostrar ayuda específica del proveedor

En este ejemplo se muestran dos maneras de obtener la ayuda específica del proveedor para Get-Item. Estos comandos obtienen ayuda que explica cómo usar el Get-Item cmdlet en el nodo DataCollection del proveedor de SQL Server de PowerShell.

En el primer ejemplo se usa el Get-Helpparámetro Path para especificar la ruta de acceso del proveedor de SQL Server. Dado que se especifica la ruta de acceso del proveedor, puede ejecutar el comando desde cualquier ubicación de ruta de acceso.

En el segundo ejemplo se usa Set-Location para navegar a la ruta de acceso del proveedor de SQL Server. Desde esa ubicación, el parámetro Path no es necesario para Get-Help obtener la ayuda específica del proveedor.

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.
    ...

Set-Location SQLSERVER:\DataCollection
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.
    ...

Ejemplo 12: Mostrar ayuda para un script

En este ejemplo se obtiene ayuda para .MyScript.ps1 script Para obtener información sobre cómo escribir ayuda para las funciones y scripts, consulte about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parámetros

-Category

Muestra la ayuda solo para los elementos de la categoría especificada y sus alias. Los artículos conceptuales se encuentran en la categoría HelpFile .

Los valores aceptables para este parámetro son los siguientes:

  • Alias
  • Cmdlet
  • Proveedor
  • General
  • Preguntas más frecuentes
  • Glosario
  • HelpFile
  • ScriptCommand
  • Función
  • Filtro
  • ExternalScript
  • All
  • DefaultHelp
  • Flujo de trabajo
  • DscResource
  • Clase
  • Configuración
Type:String[]
Accepted values:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Muestra comandos con el valor de componente especificado, como Exchange. Escriba un nombre de componente. Se permite el uso de caracteres comodín. Este parámetro no tiene ningún efecto en las pantallas de ayuda conceptual (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Detailed

Agrega descripciones y ejemplos del parámetro para la visualización básica de la ayuda. Este parámetro solo es efectivo cuando los archivos de ayuda están instalados en el equipo. No tiene ningún efecto en las pantallas de ayuda conceptual (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Examples

Muestra únicamente el nombre, el resumen y los ejemplos. Este parámetro solo es efectivo cuando los archivos de ayuda están instalados en el equipo. No tiene ningún efecto en las pantallas de ayuda conceptual (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Full

Muestra todo el artículo de ayuda de un cmdlet. Full incluye descripciones de parámetros y atributos, ejemplos, tipos de objetos de entrada y salida y notas adicionales.

Este parámetro solo es efectivo cuando los archivos de ayuda están instalados en el equipo. No tiene ningún efecto en las pantallas de ayuda conceptual (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Functionality

Muestra ayuda para los elementos que tienen la funcionalidad especificada. Escriba la funcionalidad. Se permite el uso de caracteres comodín. Este parámetro no tiene ningún efecto en las pantallas de ayuda conceptual (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Obtiene ayuda sobre el comando o concepto especificado. Escriba el nombre de un cmdlet, una función, un proveedor, un script o un flujo de trabajo, como Get-Member, un nombre de artículo conceptual, como about_Objects, o un alias, como ls. Los caracteres comodín se permiten en los nombres de cmdlet y proveedor, pero no puede usar caracteres comodín para encontrar los nombres de los artículos de ayuda de funciones y de script help.

Para obtener ayuda para un script que no se encuentra en una ruta de acceso que aparece en la $env:Path variable de entorno, escriba la ruta de acceso y el nombre de archivo del script.

Si escribe el nombre exacto de un artículo de ayuda, Get-Help muestra el contenido del artículo.

Si escribe un patrón de palabras o palabras que aparece en varios títulos del artículo de ayuda, Get-Help muestra una lista de los títulos coincidentes.

Si escribe algún texto que no coincida con los títulos del artículo de ayuda, Get-Help muestra una lista de artículos que incluyen ese texto en su contenido.

Los nombres de los artículos conceptuales, como about_Objects, deben escribirse en inglés, incluso en versiones que no sean en inglés de PowerShell.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Online

Muestra la versión en línea de un artículo de ayuda en el explorador predeterminado. Este parámetro solo es válido para los artículos de ayuda cmdlet, función, flujo de trabajo y script. No puede usar el parámetro Online con Get-Help en una sesión remota.

Para obtener información sobre cómo admitir esta característica en artículos de ayuda que escriba, consulte about_Comment_Based_Help y Ayuda en línea de soporte técnico y Escritura de ayuda para cmdlets de PowerShell.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Muestra solo las descripciones detalladas de los parámetros especificados. Se permiten los caracteres comodín. Este parámetro no tiene ningún efecto en las pantallas de ayuda conceptual (About_).

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Path

Obtiene ayuda que explica cómo funciona el cmdlet en la ruta de acceso del proveedor especificada. Escriba una ruta de acceso del proveedor de PowerShell.

Este parámetro obtiene una versión personalizada de un artículo de ayuda de cmdlet que explica cómo funciona el cmdlet en la ruta de acceso del proveedor de PowerShell especificada. Este parámetro solo es eficaz para obtener ayuda sobre un cmdlet de proveedor y solo cuando el proveedor incluye una versión personalizada del artículo de ayuda del cmdlet del proveedor en su archivo de ayuda. Para utilizar este parámetro, instale el archivo de ayuda para el módulo que incluye el proveedor.

Para ver la ayuda del cmdlet personalizado para una ruta de acceso del proveedor, vaya a la ubicación de la ruta de acceso del proveedor y escriba un Get-Help comando o, desde cualquier ubicación de ruta de acceso, use el parámetro Path de Get-Help para especificar la ruta de acceso del proveedor. También puede encontrar ayuda personalizada de cmdlets en línea en la sección de ayuda del proveedor de los artículos de ayuda.

Para obtener más información sobre los proveedores de PowerShell, consulte about_Providers.

Nota:

El proveedor de la ruta de acceso especificada debe tener instalado un archivo de ayuda del proveedor de PowerShell. Si no hay ningún archivo de ayuda del proveedor disponible, no se devuelve información de ayuda. No hay ningún archivo de ayuda del proveedor disponible para los proveedores incluidos con esta versión de PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Role

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 desempeña el usuario en una organización. Algunos cmdlets muestran texto diferente en sus archivos de ayuda en función del valor de este parámetro. Este parámetro no tiene ningún efecto en la ayuda de los cmdlets principales.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowWindow

Muestra el tema de ayuda en una ventana para facilitar la lectura. La ventana incluye una característica buscar y un cuadro de Configuración que le permite establecer opciones para la presentación, incluidas las opciones para mostrar solo las secciones seleccionadas de un tema de ayuda.

El parámetro ShowWindow admite temas de ayuda para comandos (cmdlets, funciones, comandos CIM, scripts) y artículos conceptuales acerca de . No admite la ayuda del proveedor.

Este parámetro se ha vuelto a introducir en PowerShell 7.0. Este parámetro solo está disponible en Windows.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

No se pueden canalizar objetos a este cmdlet.

Salidas

ExtendedCmdletHelpInfo

Si se ejecuta Get-Help en un comando que no tiene un archivo de ayuda, Get-Help devuelve un objeto ExtendedCmdletHelpInfo que representa la ayuda generada automáticamente.

String

Si recibe un artículo de ayuda conceptual, Get-Help lo devuelve como una cadena.

MamlCommandHelpInfo

Si obtiene un comando que tiene un archivo de ayuda, Get-Help devuelve un objeto MamlCommandHelpInfo .

Notas

PowerShell 3.0 no incluye archivos de ayuda. Para descargar e instalar los archivos de ayuda que Get-Help lee, use el Update-Help cmdlet . Puede usar el Update-Help cmdlet para descargar e instalar archivos de ayuda para los comandos principales que se incluyen con PowerShell y para los módulos que instale. También puede usarlo para actualizar los archivos de ayuda del equipo para que estén siempre al día.

También puede leer los artículos de ayuda sobre los comandos que vienen con PowerShell en línea a partir de Introducción a Windows PowerShell.

Get-Help muestra ayuda en la configuración regional establecida para el sistema operativo Windows o en el idioma de reserva de esa configuración regional. Si no tiene archivos de ayuda para la configuración regional principal o de reserva, Get-Help se comporta como si no hubiera archivos de ayuda en el equipo. Para obtener ayuda para una configuración regional diferente, use Región e idioma en Panel de control para cambiar la configuración. En Windows 10 o superior, Configuración, hora e idioma.

La vista completa de ayuda incluye una tabla de información sobre los parámetros. con los campos siguientes:

  • Necesario. Indica si el parámetro es obligatorio (true) u opcional (false).

  • Posición. Indica si el parámetro se denomina o posicional (numérico). Los parámetros posicionales deben aparecer en un lugar especificado del comando.

  • Con nombre se indica que se requiere el nombre del parámetro, pero que el parámetro puede aparecer en cualquier parte del comando.

  • Numeric indica que el nombre del parámetro es opcional, pero cuando se omite el nombre, el parámetro debe estar en el lugar especificado por el número. Por ejemplo, 2 indica que cuando se omite el nombre del parámetro, el parámetro debe ser el segundo o solo un parámetro sin nombre en el comando. Cuando se utiliza el nombre del parámetro, el parámetro puede aparecer en cualquier lugar del comando.

  • Valor predeterminado. El valor del parámetro o el comportamiento predeterminado que Usa PowerShell si no incluye el parámetro en el comando .

  • Acepta la entrada de canalización. Indica si puede (true) o no (false) enviar objetos al parámetro a través de una canalización. Por Nombre de propiedad significa que el objeto canalización debe tener una propiedad que tenga el mismo nombre que el nombre del parámetro.

  • Acepta caracteres comodín. Indica si el valor de un parámetro puede incluir caracteres comodín, como un asterisco (*) o un signo de interrogación (?).