Cómo usar la ayuda de un comando
Podemos obtener ayuda de un comando de varias formas. Vamos a usar el comando Get-Help como ejemplo para ver las diferentes opciones de ayuda disponibles. EL comando Get-Help obtiene ayuda de un comando y, sí, es posible obtener ayuda de Get-Help de las siguientes maneras:Get-Help
SINTAXIS
Get-Help [[-Name] <string>] [...] [<CommonParameters>]
[...]
ALIAS
Ninguno
NOTAS
Get-Help no encuentra los archivos de Ayuda para este cmdlet en el equipo. Mostrará solo una parte de la Ayuda.
-- Para descargar e instalar los archivos de Ayuda para el módulo que incluye este cmdlet, use Update-Help.
-- Para ver en línea el tema de Ayuda de este cmdlet, escriba "Get-Help Get-Help -Online" o
vaya a http://go.microsoft.com/fwlink/?LinkID=113316.
El propio comando posiblemente nos indique en las notas que no encuentra la ayuda y debemos descargarla o bien consultarla online.
En este caso nos abrirá en el navegador el siguiente enlace:
NOMBRE
Get-Help
SINOPSIS
Displays information about Windows PowerShell commands and concepts.
SINTAXIS
Get-Help [[-Name] <String>] [-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter | ExternalScript | All | DefaultHelp | Workflow | DscResource | Class | Configuration}] [-Component <String[]>] -Detailed
[-Functionality <String[]>] [-Path <String>] [-Role <String[]>] [<CommonParameters>]
…
DESCRIPCIÓN
The Get-Help cmdlet displays information about Windows PowerShell concepts and commands, including cmdlets, functions, CIM commands, workflows, providers, aliases and scripts.
To get help for a Windows PowerShell command, type `Get-Help` followed by the command name, such as: `Get-Help Get-Process`. To get a list of all help topics on your system, type `Get-Help *`. You can display the whole help topic or use the parameters of the
Get-Help cmdlet to get selected parts of the topic, such as the syntax, parameters, or examples.
…
VÍNCULOS RELACIONADOS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821483
Updatable Help Status Table (http://go.microsoft.com/fwlink/?LinkID=270007) http://go.microsoft.com/fwlink/?LinkID=270007
about_Command_Syntax
Get-Command
NOTAS
Para ver los ejemplos, escriba: "get-help Get-Help -examples".
Para obtener más información, escriba: "get-help Get-Help -detailed".
Para obtener información técnica, escriba: "get-help Get-Help -full".
Para obtener ayuda disponible en línea, escriba: "get-help Get-Help -online"
- Nombre
- Sinopsis
- Sintaxis
- Descripción
- Vínculos relacionados
- Notas
Opciones de ayuda
- -ShowWindow
- -Online
- -Detailed y –Full
- -Parameter
- -Examples
En este caso nos abrirá en el navegador el siguiente enlace:
El comando del ejemplo siguiente proporciona la salida con el parámetro –Detailed:
NOMBRE
Get-Module
SINTAXIS
Get-Module [[-Name] <string[]>] [<CommonParameters>]
PARÁMETROS
-All
-CimNamespace <string>
-CimResourceUri <uri>
-CimSession <CimSession>
-FullyQualifiedName <ModuleSpecification[]>
-ListAvailable
-Name <string[]>
-PSEdition <string>
-PSSession <PSSession>
-Refresh
<CommonParameters>
Este cmdlet admite los parámetros comunes Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable y OutVariable. Para obtener más información, consulte
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
ALIAS
gmo
NOTAS
Get-Help no encuentra los archivos de Ayuda para este cmdlet en el equipo. Mostrará solo una parte de la Ayuda.
-- Para descargar e instalar los archivos de Ayuda para el módulo que incluye este cmdlet, use Update-Help.
-- Para ver en línea el tema de Ayuda de este cmdlet, escriba "Get-Help Get-Module -Online" o
vaya a http://go.microsoft.com/fwlink/?LinkID=141552.
-Name <string[]>
¿Requerido? false
¿Posición? 0
¿Aceptar canalización? true (ByValue)
Nombre de conjunto de parámetros Loaded, Available, PsSession, CimSession
Alias Ninguno
¿Dinámico? false