Utiliser les commandes Show-Command et Get-Help dans PowerShell

Effectué

L’applet de commande Show-Command ouvre une fenêtre qui affiche une liste de commandes ou des paramètres d’une commande spécifique. Cette fenêtre est la même que celle qui s’affiche lorsque vous sélectionnez l’option Afficher la fenêtre de commande dans l’environnement ISE.

Pour afficher les paramètres d’une commande spécifique, indiquez le nom de la commande comme valeur pour le paramètre -Name . Par exemple, pour ouvrir la fenêtreCommandes avec la commande utilisée pour récupérer un utilisateur Active Directory, saisissez la commande suivante dans la console, puis appuyez sur la touche Entrée :

Show-Command –Name Get-ADUser

Le paramètre –Name est positionnel. La commande suivante produit donc le même résultat :

Show-Command Get-ADUser

Si vous sélectionnez l’option Afficher la fenêtre commande dans l’environnement ISE et que votre curseur se trouve à côté ou immédiatement à côté d’un nom de commande dans le volet console ou script, les résultats sont identiques.

Remarque

Dans ces exemples, Show-Command est la commande que vous exécutez réellement, mais Get-ADUser est le nom de la commande que vous souhaitez examiner dans la boîte de dialogue.

Dans la fenêtreAfficher la commande, chaque jeu de paramètres pour la commande spécifiée s’affiche sous un onglet distinct. Cela rend visuellement clair que vous ne pouvez pas combiner et mettre en correspondance les paramètres entre les ensembles.

Une fois que vous avez fourni des valeurs pour tous les paramètres requis, vous pouvez exécuter la commande immédiatement en sélectionnant Exécuter dans la fenêtre Afficher les commandes. Vous pouvez également le copier dans le Presse-papiers en sélectionnant Copier. Vous pouvez coller la commande dans la console à partir du Presse-papiers pour examiner la syntaxe de ligne de commande correcte sans exécuter la commande.

Notez que Show-Command expose également les paramètres communs Windows PowerShell, qui sont un ensemble de paramètres que Windows PowerShell ajoute à toutes les commandes pour fournir un ensemble prédéfini de fonctionnalités principales. Vous en apprendrez davantage sur la plupart des paramètres communs dans les prochains modules. Toutefois, si vous souhaitez les connaître maintenant, exécutez l’aide about_common_parameters dans Windows PowerShell et passez en revue les résultats.

Utilisation de Get-Help

Windows PowerShell offre une aide intégrée complète sur les commandes. Vous pouvez accéder à cette aide à l’aide de la commande Get-Help . Get-Help affiche tout le contenu de l’aide à l’écran et vous permet de le parcourir. Vous pouvez également utiliser la fonction d’aide ou l’alias Man , qui est mappé à la commande Get-Help . Les trois retournent essentiellement les mêmes résultats. Ces résultats incluent une description courte et une description longue de la cmdlet, la syntaxe, d’éventuelles remarques supplémentaires de l’auteur de l’aide et des liens vers des cmdlet connexes ou des informations supplémentaires en ligne. Les commandes d’aide et d’assistance affichent du contenu dans la console une page à la fois. L’ISE affiche l’ensemble du contenu d’aide.

Par exemple, pour afficher les informations d’aide de l’applet de commande Get-ChildItem , entrez la commande suivante dans la console, puis appuyez sur entrée :

Get-Help Get-ChildItem

Paramètres Get-Help

La commande Get-Help accepte les paramètres qui vous permettent de trouver des informations supplémentaires au-delà des informations affichées par défaut. L’accès à des exemples d’utilisation d’une commande est un motif fréquent de recherche d’aide supplémentaire. À ce titre, les commandes Windows PowerShell incluent généralement de nombreux exemples. Par exemple, l’exécution de la commande Get-Help Stop-Process –Exemples fournit des exemples d’utilisation de l’applet de commande Stop-Process .

Le paramètre -Full fournit des informations détaillées sur une applet de commande, notamment :

• Description de chaque paramètre
• Si chaque paramètre a une valeur par défaut (même si ces informations ne sont pas documentées de manière cohérente pour toutes les commandes)
• Si un paramètre est obligatoire
• Indique si un paramètre peut accepter une valeur dans une position spécifique (auquel cas le numéro de position, à partir de 1, est donné) ou si vous devez entrer le nom du paramètre (auquel cas nommé affiche).
• Si un paramètre accepte une entrée de pipeline et, le cas échéant, comment

Les autres paramètres Get-Help sont les suivants :

• -ShowWindow. Affiche la rubrique d’aide dans une fenêtre distincte, permettant d’accéder facilement à l’aide tout en entrant des commandes.
• -En ligne. Affiche la version en ligne de la rubrique d’aide (avec, généralement, les informations les plus à jour) dans une fenêtre de navigateur.
• ‑Parameter NomParamètre. Affiche la description d’un paramètre nommé.
• -Catégorie. Affiche l’aide uniquement pour certaines catégories de commandes telles que les cmdlets et les fonctions.

Utilisation de Get-Help pour rechercher des commandes

La commande Get-Help peut être très utile pour rechercher des commandes. Elle accepte les caractères génériques (*, ?), notamment l’astérisque (*). Quand vous recherchez de l’aide et utilisez des caractères génériques avec un nom de commande partiel, Windows PowerShell affiche une liste de rubriques d’aide correspondantes.

En utilisant les informations que vous avez apprises précédemment sur la structure détaillée des applets de commande, vous pouvez utiliser Get-Help en tant qu’outil pour découvrir les applets de commande même si vous ne connaissez pas leurs noms. Par exemple, si vous souhaitez toutes les applets de commande qui opèrent sur des processus, vous pouvez entrer la commande Get-Help *process* dans la console, puis appuyer sur la touche Entrée. Les résultats correspondent à ceux retournés par la commande Get-Command *process*, sauf que Get-Help affiche un synopsis. Ce synopsis est une brève description qui vous aide à identifier la commande souhaitée.

Il peut vous arriver de spécifier une recherche avec caractères génériques qui ne correspond à aucun nom de commande. Par exemple, l’exécution deGet-Help *beep* ne trouve pas de commandes qui ont un bip dans leur nom. Quand aucun résultat n’est trouvé, le système d’aide effectue une recherche en texte intégral des descriptions et synopsis de commande disponibles. Cette recherche localise tous les fichiers d'aide contenant bip. Si un seul fichier correspond, le système d’aide affiche son contenu plutôt qu’une liste avec un seul élément. Dans le cas du terme de recherche bip, Get-Help renvoie une liste de deux rubriques : Set-PSReadlineOption, un cmdlet, et about_Special_Characters, une rubrique d’aide conceptuelle.