Curso básico de Powershell: Ayuda

Roberto Orayen 21 junio, 2013 PowerShell 3 Comentarios 9,606 Vistas

Artículos relacionados

Uno de los aspectos importantes cuando estamos trabajando con cualquier lenguaje de programación o comandos como pueden ser los de PowerShell, es disponer de un acceso rápido y sencillo a una ayuda donde poder resolver las dudas que tengamos respecto a la forma de ejecutar un comando, los parámetros que admite o incluso ver algún ejemplo.
Con PowerShell tenemos el comando Get-Help que nos permite acceder la documentación relativa a comandos, funciones, temas genéricos de PowerShell.

Get-Help incluye:

Sintaxis
Detalle de los parámetros
Alias
Ejemplos
Permite acceder a la ayuda utilizando wildcards
Es el interfaz común para la ayuda de comandos de terceros
Con PowerShell 3.0 también tenemos la opción de acceder a la ayuda online a través de Internet

Un parámetro muy útil de Get-Help es el parámetro -ShowWindow, ya que te abre la ayuda en una ventana separada donde se pueden realizar búsquedas en el texto de la ayuda.

Ayuda actualizable

Con PowerShell 3.0 se ha introducido el concepto de Ayuda actualizable.
La idea es que por defecto los archivos de la ayuda no estén instalados en los servidores, minimizando su impacto. Además, al ser PowerShell una parte importante del núcleo separan la ayuda para en el caso de necesitar actualizarla no sea necesario tocar el núcleo de PowerShell.
De esta forma PowerShell 3.0, por defecto cuenta con la ayuda mínima y nos da la opción de descargar el contenido que necesitemos.
El comando para actualizar la ayuda es Update-Help

Para poder actualizar la ayuda tenemos una serie de limitaciones:

Requiere conexión a Internet
Requiere credenciales de administración
Por defecto solo se puede actualizar una vez al día
No se instala la ayuda de los Snap-In
No todos los módulos soportan la ayuda actualizable
Puede que tengamos que forzar el lenguaje a EN-US para obtener toda la ayuda
Podemos actualizar toda la ayuda o solo un módulo en concreto

Tenemos la opción de guardar la ayuda con el comando Save-Help en una ubicación y compartir esa ubicación entre varios equipos de forma que solo tengamos un recurso con la ayuda disponible para todos los equipos.

Descarga la ayuda a una carpeta

Save-Help -Force -UICulture "en-us" -DestinationPath C:\PowerShell-Help

1	Save-Help -Force -UICulture "en-us" -DestinationPath C:\PowerShell-Help

Actualizar la ayuda desde esa carpeta

Update-Help -Force -UICulture "en-us" -SourcePath C:\PowerShell-Help

1	Update-Help -Force -UICulture "en-us" -SourcePath C:\PowerShell-Help

Ayuda con el comando Show-Command
Show-Command es una ayuda gráfica que podemos utilizar como asistente para la ejecución de comandos. Si no ponemos ningún parámetro podremos seleccionar el comando del que queremos la ayuda. También está integrado con PowerShell ISE.

Podemos rellenar los campos del cmdlet y una vez que hemos indicado todas las opciones tenemos dos opciones:

Copiar: nos copiará en el portapapeles el cmdlet con los parámetros que hemos indicado
Ejecutar: ejecutará directamente el cmdlet con los parámetros indicados

Get-Member

El cmdlet Get-Member no es propiamente una ayuda pero si un comando muy útil ya que ante cualquier objeto nos muestra el tipo de objeto que es, las propiedades y métodos disponibles.

Algunos ejemplos:

Vemos que primero nos muestra el tipo de objeto, en este caso System.ServiceProcess.ServiceController

A continuación nos muestra un listado de:

Alias: Name, RequiredServices…: que son enlaces a propiedades del objeto
Metodos: Close, Continue…: que son métodos que podemos ejecutar sobre el objeto (Objeto.Metodo())
Propiedades: CanShutdown, CanStop…: que son las propiedades del objeto a las que podemos acceder (Objeto.Propiedad)

Otros objetos nos muestra distinta salida para el comando Get-Member