Get-Help
Muestra información sobre los conceptos y comandos de PowerShell.
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>]El cmdlet Get-Help 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 muestra solo 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 cmdlet Update-Help.
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, a continuación, en la configuración regional primaria, como pt para pt-BRy, 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 que devuelva un mensaje de error o muestre la 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 requerido y Position, vea about_Parameters.
Nota
En PowerShell 3.0 y PowerShell 4.0, Get-Help no se pueden encontrar artículos acerca de en módulos a menos que el módulo se importe en la sesión actual. Para obtener acerca de artículos de un módulo, importe el módulo mediante el cmdlet Import-Module o mediante la ejecución de 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. Cuando se alcanza 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 ayuda dinámica.
Estos ejemplos muestran información básica de ayuda sobre el cmdlet Format-Table.
Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?
Get-Help <cmdlet-name> es la sintaxis más sencilla y predeterminada del cmdlet Get-Help. Puede omitir el parámetro Name.
La sintaxis <cmdlet-name> -? solo funciona para cmdlets.
Estos ejemplos muestran información básica de ayuda sobre el cmdlet Format-Table una página a la vez.
help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging
help es una función que ejecuta Get-Help cmdlet internamente y muestra el resultado una página a la vez.
man es un alias para la función help.
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 .
Estos ejemplos muestran información de ayuda más detallada sobre el cmdlet Format-Table.
Get-Help Format-Table -Detailed
Get-Help Format-Table -FullEl parámetro detallado 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 detallado y full solo son efectivos 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_).
Estos ejemplos muestran partes seleccionadas de la ayuda del cmdlet Format-Table.
Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupByEl parámetro Ejemplos de muestra las secciones NAME y SYNOPSIS y todos los ejemplos. No se puede especificar un número de ejemplo porque el Ejemplo parámetro 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_).
En este ejemplo se muestra la versión en línea del artículo de ayuda del cmdlet Format-Table en el explorador web predeterminado.
Get-Help Format-Table -OnlineEl cmdlet Get-Help sin parámetros muestra información sobre el sistema de ayuda de PowerShell.
Get-HelpEn este ejemplo se muestra una lista de todos los artículos de ayuda disponibles en el equipo.
Get-Help *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_*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 mamlCommandHelpInfo objeto 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.
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...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 cmdlet Get-Item en el nodo de DataCollection del proveedor de SQL Server de PowerShell.
En el primer ejemplo se usa el parámetro Get-HelpPath 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 ir a la ruta de acceso del proveedor de SQL Server. Desde esa ubicación, el parámetro Path de 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.
...En este ejemplo se obtiene ayuda para el 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.ps1Muestra ayuda solo para los elementos de la categoría especificada y sus alias. Los artículos conceptuales se encuentran en la categoría helpFile de.
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
- Todo
- DefaultHelp
- Flujo de trabajo
- DscResource
- Clase
- Configuración
| Tipo: | String[] |
| Valores aceptados: | Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
Muestra comandos con el valor de componente especificado, como Exchange. Escriba un nombre de componente. Se permiten caracteres comodín. Este parámetro no tiene ningún efecto en las pantallas de ayuda conceptual (About_).
| Tipo: | String[] |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | True |
Agrega descripciones de parámetros y ejemplos a la pantalla de ayuda básica. 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_).
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | False |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
Muestra solo el nombre, la sinopsis 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_).
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | False |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
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_).
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | False |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
Muestra ayuda para los elementos con la funcionalidad especificada. Escriba la funcionalidad. Se permiten caracteres comodín. Este parámetro no tiene ningún efecto en las pantallas de ayuda conceptual (About_).
| Tipo: | String[] |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | True |
Obtiene ayuda sobre el comando o el concepto especificados. 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_Objectso 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 variable de entorno $env:Path, 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.
| Tipo: | String |
| Posición: | 0 |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | True |
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_Helpy ayuda en línea auxiliary la Ayuda de escritura para cmdlets de PowerShell.
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | False |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
Muestra solo las descripciones detalladas de los parámetros especificados. Se permiten caracteres comodín. Este parámetro no tiene ningún efecto en las pantallas de ayuda conceptual (About_).
| Tipo: | String[] |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | True |
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 usar 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 comando Get-Help 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.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | True |
Muestra ayuda personalizada para el rol de usuario especificado. Escriba un rol. Se permiten 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.
| Tipo: | String[] |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | True |
Muestra el tema de ayuda en una ventana para facilitar la lectura. La ventana incluye una característica de búsqueda Buscar y un cuadro Configuración de 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 los comandos (cmdlets, funciones, comandos CIM, scripts) y artículos 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.
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | False |
| Requerido: | True |
| Aceptar entrada de canalización: | False |
| Aceptar caracteres comodín: | False |
None
No se pueden canalizar objetos a este cmdlet.
ExtendedCmdletHelpInfo
Si 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.
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.
PowerShell 3.0 no incluye archivos de ayuda. Para descargar e instalar los archivos de ayuda que Get-Help lee, use el cmdlet Update-Help. Puede usar el cmdlet Update-Help 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 para que la ayuda en su equipo nunca esté obsoleta.
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 y idioma en el Panel de control para cambiar la configuración. En Windows 10 o posterior, Configuración, hora & idioma.
La vista completa de ayuda incluye una tabla de información sobre los parámetros. La tabla incluye los siguientes campos:
obligatorio. Indica si el parámetro es obligatorio (true) o 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 en el comando .
Named 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,
2indica que cuando se omite el nombre del parámetro, el parámetro debe ser el segundo o solo parámetro sin nombre en el comando. Cuando se usa el nombre del parámetro, el parámetro puede aparecer en cualquier parte 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 (?).
Comentarios de PowerShell
PowerShell es un proyecto de código abierto. Seleccione un vínculo para proporcionar comentarios: