Comando Get-Help: sintaxis, parámetros, ejemplos
Explorar temas de publicaciones
- Introducción
- Powershell Get-Help-Befehlssyntax
- Parámetro de ayuda de Powershell
- Ejemplos de obtención de ayuda de Powershell
- Powershell Get-Help Ejemplo 1: Ayuda básica de Powershell
- Powershell Get-Help ejemplo 2: Ayuda detallada y completa de Powershell
- Powershell Get-Help Ejemplo 3: Ayuda en línea de Powershell
- Powershell Get-Help Ejemplo 4: categoría de ayuda de Powershell
- Powershell Get-Help Ejemplo 5: Obtener ejemplos de un cmdlet
- Conclusión
- Otras guías útiles
- Recursos y referencias adicionales
Introducción
¿No sabe cómo usar un cmdlet de PowerShell? El cmdlet Get-Help de PowerShell le brinda información sobre cada comando de PowerShell.
Esta guía le muestra cómo usar el cmdlet Get-Help de PowerShell. Su sintaxis, parámetros y algunos ejemplos.
Powershell Get-Help-Befehlssyntax
La sintaxis simplificada de Powershell Get-Help es:
|_+_| Algunos parámetros del cmdlet Get-Help de Powershell no se muestran arriba. Solo enumeré los parámetros que necesita para el uso diario. El cmdlet Get-Help puede proporcionar información de ayuda de PowerShell para cmdlets, funciones, comandos CIM, flujos de trabajo, proveedores, alias y scripts.
Parámetro de ayuda de Powershell
La siguiente tabla lista los parámetros mostrados en la última sección y su significado. También incluye ejemplos. Para ver ejemplos detallados, consulte los ejemplos más adelante en esta guía.
| S/N | Parámetro | sentido | Ejemplo de obtención de ayuda de Powershell |
| como | Nombre | Especifica el nombre del cmdlet, la función, el script, el flujo de trabajo, el proveedor o el alias. | Obtener-Ayuda-Nombre Get-Befehl |
| dos | Parámetro | Se usa para especificar un parámetro del cmdlet con el que desea ayuda | Obtener ayuda -Nombre Obtener comando -Nombre de parámetro |
| 3 | ejemplos | Este parámetro no requiere un valor de entrada. Si se especifica, Get-Help devuelve ejemplos para el cmdlet | Ejemplos de Get-Help -Name Get-Command |
| 4 | Categoría | Muestra ayuda solo para los elementos de la categoría especificada y sus alias. Algunos valores aceptados: alias, cmdlet, etc. | Get-Help-Categoría-Alias |
| 5 | Completo | Muestra todo el tema de ayuda de un cmdlet, incluidos parámetros, atributos y ejemplos. | Obtener-Ayuda Obtener-Comando -Completo |
| 6 | Detallado | Agrega descripciones de parámetros y ejemplos al visor de ayuda básica. | Obtener-Ayuda Obtener-Comando -Detallado |
| 7 | En línea | Abre la versión en línea de un tema de ayuda en el navegador de Internet predeterminado | Obtener ayuda Obtener comando - En línea |
Ejemplos de obtención de ayuda de Powershell
Estos son algunos ejemplos del cmdlet Get-Help de PowerShell. En esta sección, usaré Get-Help para obtener información sobre el cmdlet Get-Command.
Powershell Get-Help Ejemplo 1: Ayuda básica de Powershell
Ejecute el siguiente comando para obtener información de ayuda básica sobre el cmdlet Get-Command:
|_+_|
En este ejemplo, el cmdlet es obtener comando . Tenga en cuenta que no incluí el parámetro -Name. No tiene que estar incluido. Aquí está el resultado del comando en PowerShell.
ejercitar videos en kodi
El comando volvió RESUMEN (Descripción del cmdlet), su SINTAXIS (Usando el cmdlet) y su DESCRIPCIÓN (información detallada sobre el cmdlet).
Powershell Get-Help ejemplo 2: Ayuda detallada y completa de Powershell
Para ver información más detallada sobre un cmdlet, simplemente agregue el Detallado Parámetro. Aquí está el ejemplo modificado.
|_+_|si los incluyes Detallado -Parameter agrega descripciones y ejemplos de parámetros Get-Help a la información de ayuda básica de PowerShell.
La mayor parte de la información no se muestra en la imagen anterior.Si también desea ver la información de ayuda completa sobre el cmdlet, use el Completo Parámetro.
Aquí hay un comando de ejemplo:
jugar m4b en iphone|_+_|
Powershell Get-Help Ejemplo 3: Ayuda en línea de Powershell
Si desea que Get-Help abra la ayuda en línea para el cmdlet, use el En línea Parámetro. Get-Help abre la información de ayuda para el cmdlet utilizando su navegador predeterminado.
Este es el comando para mostrar la información en línea del cmdlet Get-Command.
|_+_|Aquí está el resultado. Abierto en Chrome (mi navegador predeterminado):
Powershell Get-Help Ejemplo 4: categoría de ayuda de Powershell
El comando Get-Help tiene un parámetro llamado Categoría . Puede usar esto para obtener información de ayuda sobre cualquiera de las siguientes categorías:
Alias, Cmdlet, Proveedor, General, Preguntas frecuentes, Glosario, Archivo de ayuda, ScriptCommand, Función, Filtro, Script externo, Todo, Ayuda predeterminada, Flujo de trabajo, DscResource, Clase y Configuración
Un uso muy útil de esto es mostrar una lista completa de alias de todos los cmdlets de PowerShell en su computadora.
Aquí está el comando:
|_+_|Y el resultado…
El uso de alias de cmdlet acorta su secuencia de comandos. La próxima vez que cree una secuencia de comandos, puede usar el comando anterior para obtener los alias de los cmdlets.En otro ejemplo, para devolver TODOS los cmdlets en su computadora, use el siguiente comando:
|_+_|Si necesita cmdlets específicos, puede usar el cmdlet Where-Object para devolverlos.
Como ejemplo para devolver comandos que comienzan con las palabras Estaba , usa el siguiente comando
|_+_|Esto devuelve los cmdlets cerca de lo que quiero. Echa un vistazo a los siguientes resultados:
Powershell Get-Help Ejemplo 5: Obtener ejemplos de un cmdlet
Uno de los beneficios del comando Powershell Get-Help es que puede brindarle ejemplos de cómo usar un cmdlet.
raíz samsung sm-g950u
Para ver ejemplos del uso de Get-Command, use el siguiente comando:
|_+_|El comando muestra todos los ejemplos disponibles:
Conclusión
Espero que esta guía le haya facilitado el uso de Powershell Get-Help. Lo que es más importante, espero que haya aprendido una o dos cosas que necesita saber sobre cómo escribir su próximo script de PowerShell.
Si tiene alguna pregunta o comentario, utilice el formulario para dejar una respuesta en la parte inferior de esta página. También puede compartir sus experiencias personales con PowerShell.
Para obtener más información sobre PowerShell, visite nuestra página de PowerShell. También puede buscar en PowerShell para obtener una lista de todas nuestras guías de PowerShell.
Otras guías útiles
- Los 18 comandos de Powershell más útiles para administradores de Windows
- Cómo programar un script de PowerShell para que se ejecute automáticamente en un servidor de Windows
