PowerShell para principiantes (Parte 4): Ayuda de PowerShell (Obtener ayuda)
Ahora, después de la tercera parte de PowerShell para principiantes (Parte 3): Los parámetros, nos concentraremos en la ayuda de PowerShell. Pero antes de comenzar la respuesta del tercer ejercicio. También haremos un repaso rápido de lo que hemos aprendido hasta ahora.
Todas las partes de la serie se pueden encontrar aquí: PowerShell para principiantes (Serie)
Revisión (Parte 3)
Ejercicio
En la tercera parte pregunté por qué este comando no funciona:
¿Por qué no funciona este comando?
La primera tarea es encontrar los parámetros para el filtro *.txt y para la ruta C:\Temp.
Get-Help Get-ChildItem -Parameter *
Una vez que hayamos encontrado la ruta y el parámetro de filtro, podremos ver que son posicionales.
Esto significa que Path no requiere el nombre del parámetro (de lo contrario, se debe nombrar el valor de la posición), pero su valor de parámetro debe ser el primer o único valor de parámetro sin nombre en el comando. Esto también significa que el primer argumento de la llamada se vinculará automáticamente al parámetro de ruta. Pero nuestro primer argumento define el filtro (*.txt), no la ruta. Este funciona porque el valor de la ruta está en la primera posición y el valor del filtro está en la segunda posición:
Get-ChildItem C:\Temp\ *.txt
Resumen
Los parámetros son diferentes. Hay parámetros obligatorios, posicionales, conmutados, obligatorios y no obligatorios. Get-Help puede ayudarle a explorar todos los parámetros de un comando. Para hacer esto, ejecute Get-Help Your-Command -Parameter *. Utilice TAB siempre que sea posible.
Algunas palabras sobre la ayuda de PowerShell al principio
Ya hemos aprendido cómo utilizar la ayuda para explorar parámetros. Ahora damos un gran paso adelante. Esta parte trata sobre la ayuda y el uso de la ayuda. La ayuda de PowerShell es una fuente maravillosa para aprender y descubrir cosas nuevas. Estoy realmente convencido de que si no estás familiarizado con la ayuda, nunca llegarás a ser un buen experto en PowerShell.
Don Jones, autor de "Aprenda PowerShell en un mes de almuerzos" y veterano de PowerShell MVP dijo:
“Esté preparado para leer la ayuda o fallará en PowerShell. "
Puede acceder a la ayuda con el cmdlet Get-Help. Esto le informa que la versión detallada de la ayuda sólo está disponible en línea. Pero la buena noticia es que puedes descargarlo.
Ayuda en linea
Descargaremos los archivos de ayuda más tarde. Hay una solución. Para utilizar la ayuda completa para ejecutar el comando Get-ChildItem
Get-Help Get-ChildItem -Online
Una vez ejecutado, aparece una ventana del navegador que le redirige a la ayuda en línea de Microsoft PowerShell.
Vale la pena echar un vistazo a los ejemplos siguientes. Son geniales.
Los ejemplos y la ayuda detallada no se almacenan de forma predeterminada en computadoras que ejecutan Windows. Ahora vamos a descargar los archivos de ayuda de un repositorio en línea.
Revisar
PowerShell se envía con una Ayuda reducida. Hay una extensa ayuda en línea. Los ejemplos son el corazón de la ayuda. Get-Help Your-Command -Online abre la ayuda en línea en un navegador web.
Descargando la ayuda completa
Utilice Update-Help para descargar la ayuda. Este es un ejemplo de cómo descargar los archivos de ayuda para la cultura en-US (inglés). Abra Windows PowerShell. Correr
Update-Help -UICulture 'en-US' -Force
Tenga en cuenta que puede ejecutar el comando sin -Force solo una vez al día por dirección IP. Por lo tanto, si está detrás de un dispositivo NAT configurado para traducir direcciones en modo de sobrecarga (PAT), tenga en cuenta que debe proporcionar el parámetro Force, porque todos los clientes acceden a Internet con la misma dirección IP pública y la descarga para esta dirección IP pública se permite una vez al día.
Ahora está instalado todo el alcance de la ayuda. Es hora de jugar con eso.
Usando la ayuda
Get-Help ofrece una amplia gama de parámetros. Escriba Get-Help y luego escriba - y mantenga presionada CTRL + ESPACIO para verlos todos.
Para obtener el contenido de ayuda del tipo Get-ChildItem
Get-Help Get-ChildItem
o
Help Get-ChildItem
Nota: Ayuda es el alias de Get-Help.
Esto muestra la versión pequeña de la Ayuda. Para los principiantes puede resultar frustrante leer la ayuda de esta manera. No ofrece ejemplos ni información detallada sobre el uso del comando. Sigamos con el parámetro de ejemplo, que es más útil para “aprender haciendo”.
¿Qué hemos aprendido hasta ahora?
La ayuda completa se descarga usando el comando Actualizar-Ayuda. Ayuda es el alias de Get-Help. Al ejecutar Get-Help sin ningún parámetro, se muestra la versión pequeña de la ayuda.
Un parámetro útil: ShowWindow
Si prefiere una ventana emergente, utilice el parámetro ShowWindow.
Get-Help Get-ChildItem -ShowWindow
Los ejemplos
Los ejemplos de ayuda de PowerShell son una fuente realmente excelente y excelentemente adecuada para realizar sus primeros pasos con PowerShell. Para obtener el tipo de ejemplos Get-ChildItem
Get-Help Get-ChildItem -Examples
Otro ejemplo muestra cómo utilizar los atributos de Powershell con Get-Date. Aún no lo hemos aprendido. Pero eso no es una pierna rota, podemos probarlo.
Help Get-Date -Examples
Desplácese hacia abajo y busque el Ejemplo 4.
Ahora puedes empezar a jugar. Por ejemplo, puedes modificar el comando y completar tu fecha de nacimiento.
Consejo: Escriba (Get-Date). y luego presione CTRL + ESPACIO. Diviértete mientras exploras los atributos de Get-Date.
Ahora hemos llegado sin querer a objetos y atributos. Eso no forma parte de esta publicación, aparecerá en una etapa posterior, pero ¿por qué no jugar con eso? Prometí empezar desde el principio. Pero ahora me gustaría darles un pequeño anticipo de lo que les espera en las próximas partes de esta serie:
Ejemplos:
(Get-Date -Year 1976 -Month 03 -Date 23).IsDaylightSavingTime()
(Get-Date).AddDays(300)
Revisar
Los ejemplos son una excelente fuente para aprender PowerShell aprendiendo haciendo. Se pueden mostrar utilizando la ayuda en línea o utilizando el parámetro de ejemplos. Para hacer esto, ejecute Get-Help Your-Command -Examples
La ayuda completa
Para obtener la ayuda completa, ejecute
Get-Help Get-Date -Full
La ayuda completa muestra todo el tema de ayuda. Esto incluye parámetros, atributos y, por último, pero no menos importante, los ejemplos.
La ayuda detallada
Obtener ayuda con el parámetro Detallado muestra descripciones y ejemplos de parámetros.
Get-Help Get-Date -Detailed
¿Qué hemos aprendido hasta ahora?
La ayuda completa muestra todo el tema de ayuda. La ayuda detallada muestra descripciones detalladas de los parámetros y ejemplos. Y una vez más, no puedo mencionarlo lo suficiente: los ejemplos son los más importantes.
Ubicación de los archivos de ayuda
Los archivos de ayuda descargados se pueden encontrar en
C:\Windows\System32\WindowsPowerShell\v1.0\en-US\
El nombre del archivo es Microsoft.PowerShell.Commands.Management.dll-Help.xml.
Este archivo de ayuda también se puede mostrar en PowerShell:
(Get-Command Get-ChildItem).Helpfile
O muestre los archivos de ayuda con Get-Help. Nos hemos ocupado de los parámetros en la tercera parte. Aquí está el archivo sobre parámetros (en C:\Windows\System32\WindowsPowerShell\v1.0\en-US\)
Get-Help about_Parameters
Revisar
Los archivos de ayuda se encuentran en una carpeta específica de Windows C:\Windows\System32\WindowsPowerShell\v1.0\en-US
Más información sobre la ayuda de PowerShell en Microsoft Docs: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-help?view=powershell-5.1
Es todo por hoy. ¡Espero que lo hayas disfrutado! Aquí tenéis el ejercicio hasta la próxima.
Ejercicio
Recuerde nuestro Código de Prácticas:
Hágalo usted mismo. Todo lo que no hagas tú mismo pronto lo olvidarás.
¿Cuál es el cuarto ejemplo de ayuda del comando start-process? Una vez que lo hayas encontrado, ¡ejecútalo en tu computadora!
La solución se puede encontrar en la siguiente parte.
Nos vemos en el próximo artículo PowerShell para principiantes (Parte 5): La política de ejecución (archivos ps1)
Patrick Gruenauer, MVP de PowerShell