Powershell : commande Get-Help
Introduction.
Depuis Powershell 3 ; Microsoft intégre un système d’aide, sauf qu’entre temps, ils ont aussi retirés l’aide en français. Ainsi pour pouvoir bénéficier du système d’aide, très complet mais maintenant en Anglais, il faudra le télécharger. Seul bémol, et on s’en doute, il faudra que la machine puisse avoir accès à internet, et ce sans passer par un proxy. Il sera néanmoins possible de télécharger tout l’aide sur un partage réseaux en local, mais ce n’est pas le sujet de l’article pour le moment.
Mise à jour de help.
On peut vite se rendre compte si l’aide est installée sur la machine, car seule l’aide syntaxique est proposée. En d’autres termes, on aura accès qu’à la découverte des paramètres, mais sans explication.
Une commande intéressante pour connaître sa version de Powershell est en fait de faire appelle à une variable d'environnement :
PS:C:\\> $PSVersionTable
En raison du retrait de la langue française, il y a un risque que la mise à jour du help échoue, même en étant en mode administrateur.
Ainsi lorsqu’on va procéder à la mise à jour via la commande Update-help, on se retrouve avec ce message d’erreur.
Ce qui donnera comme commande :
PS:C:\\ Update-help -Force -Verbose -ErrorAction SilentlyContinue
A noter également que la commande Update-Help ne va réaliser que les mise à jour des modules installer sur le système.
Pour info un module est un container d’un certain nombre de commande qui concerne soit une fonctionnalité spécifique, soit un service. Ainsi il est possible de faire la mise à jour d’aide uniquement d’un module en précisant avec le paramètre –module suivi de son nom. Si l’on veut mettre à jour plusieurs modules à la suite, on les sépare d’une virgule.
Exemple :
PS:C:\\ Update-help -Module ActiveDirectory, Hyper-V
Aide sur les commandes
On obtient l’aide sur les commandes de trois manières différentes :
- Get-help macommande
- Help macommande
- maCommande -?
Il faut aussi tenir compte que l’aide de Powershell possède trois niveau de détail :
- l’aide standard
- l’aide détaillée
- l’aide complète
Pour l’aide détaillée, on utilise le paramètre –Detailled
PS:C:\\>Get-Help ActiveDirectory -detailled
Pour l’aide complète, ce sera le paramètre –full
A noter qu’il est préférable de demander l’aide détaillée car l’aide standard n’offre aucun exemple et offre beaucoup plus d’explication sur le fonctionnement de chaque paramètre des commandes.
Pour finir, lorsqu’on tape MaCommande – ? c’est l’aide standard qui est retournée. Il est néanmoins conseillé d’écrire help au lieu de get-help suivi du niveau de détail désiré. ( -detailled ou –full).
Ceci offre un avantage : l’aide s’affiche page par page. Pour passer d’une page à l’autre on utilisera la barre d’espace.