Uso de Show-Command y Get-Help en PowerShell

Completado

El cmdlet Show-Command abre una ventana que muestra una lista de comandos o parámetros de un comando específico. Esta ventana es la misma que se muestra al seleccionar la opción Mostrarventana de comandos en el ISE.

Para mostrar los parámetros de un comando específico, proporcione el nombre del comando como valor para el parámetro -Name. Por ejemplo, para abrir Mostrarventana de comandos con el comando usado para recuperar un usuario de Active Directory, escriba el siguiente comando en la consola y presione la tecla Entrar:

Show-Command –Name Get-ADUser

El parámetro –Name es posicional, por lo que el siguiente comando genera el mismo resultado:

Show-Command Get-ADUser

Si selecciona la opción Mostrarventana de comandos en el ISE y el cursor está dentro o inmediatamente junto a un nombre de comando dentro de la consola o el panel de scripting, los resultados son los mismos.

Nota:

En estos ejemplos, Show-Command es el comando que está ejecutando realmente, pero Get-ADUser es el nombre del comando que desea revisar en el cuadro de diálogo.

En la opción Mostrarventana Comandos, cada conjunto de parámetros para el comando especificado se muestra en una pestaña independiente. Esto deja claro que no se pueden mezclar y combinar parámetros entre conjuntos.

Una vez que proporcione valores para todos los parámetros necesarios, puede ejecutar el comando inmediatamente seleccionando Ejecutar en la ventana Mostrar comandos. También puede copiarlo en el Portapapeles seleccionando Copiar. Desde el Portapapeles, puede pegar el comando en la consola para poder revisar la sintaxis correcta de la línea de comandos sin ejecutar el comando.

Observe que Show-Command también expone los parámetros comunes de Windows PowerShell, que son un conjunto de parámetros que Windows PowerShell agrega a todos los comandos para proporcionar un conjunto predefinido de funcionalidades principales. Obtendrá más información sobre muchos de los parámetros comunes en los próximos módulos. Sin embargo, si quiere la información ahora, ejecute help about_common_parameters en Windows PowerShell y examine los resultados.

Uso de Get-Help

Windows PowerShell proporciona una amplia ayuda del producto sobre los comandos. Puede acceder a esta ayuda mediante el comando Get-Help. Get-Help muestra todo el contenido de ayuda en la pantalla y le permite desplazarse por él. También puede usar la función Ayuda o el alias Man, que se asigna al comando Get-Help . Los tres devuelven básicamente los mismos resultados. Estos resultados incluyen una breve y larga descripción del cmdlet, la sintaxis, cualquier comentario adicional del autor de la ayuda y vínculos a cmdlets relacionados o información adicional en línea. Los comandos help y Man muestran contenido en la consola página a página. El ISE muestra todo el contenido de ayuda.

Por ejemplo, para mostrar la información de ayuda del cmdlet Get-ChildItem, escriba el siguiente comando en la consola y presione la tecla Entrar:

Get-Help Get-ChildItem

Parámetros de Get-Help

El comando Get-Help acepta parámetros que le permiten encontrar información adicional más allá de la información mostrada de forma predeterminada. Un motivo común para buscar ayuda adicional es identificar ejemplos de uso para un comando. Los comandos de Windows PowerShell suelen incluir muchos ejemplos de este tipo. Por ejemplo, al ejecutar el comando Get-Help Stop-Process –Examples, se proporcionan ejemplos de uso del cmdlet Stop-Process.

El parámetro -Full proporciona información detallada sobre un cmdlet, como:

• Una descripción de cada parámetro.
• Si cada parámetro tiene un valor predeterminado (aunque esta información no se documenta de forma coherente en todos los comandos).
• Si un parámetro es obligatorio.
• Si un parámetro puede aceptar un valor en una posición específica (en cuyo caso, se da el número de posición, comenzando por 1) o si debe escribir el nombre del parámetro (en cuyo caso se muestra el nombre ).
• Si un parámetro acepta la entrada de canalización y, si es así, cómo.

Entre otros parámetros Get-Help, se incluyen:

• ‑ShowWindow. Muestra el tema de ayuda en una ventana independiente, lo que facilita mucho el acceso a la ayuda al escribir comandos.
• ‑Online. Muestra la versión en línea del tema de ayuda (normalmente la información más actualizada) en una ventana del explorador.
• ‑Parameter ParameterName. Muestra la descripción de un parámetro con nombre.
• ‑Category. Muestra ayuda solo para determinadas categorías de comandos, como cmdlets y funciones.

Uso de Get-Help para buscar comandos

El comando Get-Help puede ser muy útil para buscar comandos. Acepta caracteres comodín (*, ?), especialmente el carácter comodín asterisco (*). Cuando solicite ayuda y use caracteres comodín con un nombre de comando parcial, Windows PowerShell mostrará una lista de temas de ayuda coincidentes.

Con la información que aprendió anteriormente sobre la estructura verbo-sustantivo de los cmdlets, puede usar Get-Help como herramienta para detectar cmdlets incluso si no conoce sus nombres. Por ejemplo, si desea todos los cmdlets que operan en procesos, puede escribir el comando Get-Help *process* en la consola y, a continuación, presionar la tecla Entrar. Los resultados coinciden con los devueltos por el comando Get-Command *process*, excepto que Get-Help muestra una sinopsis. Esta sinopsis es una breve descripción que le ayuda a identificar el comando que desea.

A veces, puede que especifique una búsqueda con caracteres comodín que no coincida con ningún nombre de comando. Por ejemplo, la ejecución de Get-Help *beep* no encontrará ningún comando que contenga beep en su nombre. Cuando no se encuentra ningún resultado, el sistema de ayuda realiza una búsqueda de texto completo de descripciones y sinopsis de comandos disponibles. Esta búsqueda busca los archivos de ayuda que contengan beep. Si solo hay un único archivo que coincida, el sistema de ayuda muestra su contenido, en lugar de mostrar una lista de un solo elemento. En el caso del término de búsqueda beep, Get-Help devuelve una lista de dos temas: Set-PSReadlineOption, un cmdlet y about_Special_Characters, un tema de ayuda conceptual.