Hulp nodig in PowerShell? Gebruik Get-Help!

 

 

PowerShell is een veelgebruikte taal voor het schrijven van scripts in de Microsoft omgeving. Er zijn veel verschillende voorgeprogrammeerde cmdlets beschikbaar, waarmee eenvoudige taken geautomatiseerd kunnen worden. Toch kan het voor beginnende gebruikers lastig zijn om bepaalde cmdlets goed uit te voeren. Iedere cmdlet heeft eigen parameters die ingevuld moeten worden. Sommige parameters zijn verplicht. Anderen zijn optioneel. In dit artikel leggen we kort uit wat get-help doet en waarvoor je het kan gebruiken.

 

Get-Help

Get-help is bedoeld om gebruikers snel te laten zien waarvoor een cmdlet wordt gebruikt. Er zijn verschillende parameters die ingevuld kunnen worden, naast de gebruikelijke parameters, ‘CommonParameters’.

 

 

Synopsis legt zeer kort uit wat het cmdlet doet.

Syntax geeft uit hoe het cmdlet gebruikt kan worden en hoe de parameters werken.

Description geeft meer tekstuele uitleg over het cmdlet.

Onderaan staat verwante cmdlets en eventuele opmerkingen.

 

Get-Help en Syntax

Voor het gebruik van PowerShell is vooral de syntax belangrijk. Syntax geeft namelijk aan hoe een parameter werkt. Wordt er bijvoorbeeld gezocht naar een bepaalde string of wordt er op een andere manier input verwacht? Bijvoorbeeld cijfers of een Boolean expression? In het geval van Get-Service wordt er vooral gezocht naar een string.

 

 

In dit geval worden er drie verschillende resultaten getoond. Deze resultaten zijn exclusief. Als je er dus voor kiest om de parameter -Name te gebruiken, dan is het niet mogelijk om ook de parameter -DisplayName of de parameter -InputObject te gebruiken. In dit geval zijn ze exclusief voor een variant van Get-Service. Kortom, je kan dus slechts één van de variaties van het cmdlet gebruiken als je deze parameter toevoegt.

 

 

Opvallend is dat bij een van de voorbeelden, -DisplayName niet tussen vierkante haken staat. Dit komt doordat -DisplayName een verplichte parameter is. Een verplicht parameter moet ingevuld worden voordat het cmdlet goed werkt. De andere parameters zijn optioneel en hoef je dus niet te specificeren. Het kan voorkomen dat een cmdlet een verplicht parameter heeft, maar dat hoeft niet zo te zijn.

 

Update-Help

Belangrijk is wel dat Get-Help over de belangrijkste informatie beschikt. Dit doe je door Update-Help in te voeren. PowerShell beschikt dan over de meest recente Get-Help bestanden en worden de hulpbestanden van alle geïnstalleerde modules ook bijgewerkt. Let erop dat Update-Help alleen werkt voor de geïnstalleerde modules. Dus als je een bepaalde module niet hebt geïnstalleerd, dan zal Update-Help daar ook niet voor werken.

 

 

-Examples en -Online

Het kan handig zijn om voorbeelden te krijgen bij het cmdlet, zodat je direct een beeld krijgt van hoe het gebruikt wordt. Dit kan je doen door ‘-examples’ toe te voegen. PowerShell laat direct een aantal voorbeelden zien. Let bij de voorbeelden wel erop welke variant van het cmdlet gebruikt wordt en niet alle cmdlets hebben voorbeelden.

 

 

Wil je liever online kijken? Ook dat is mogelijk. Je kan namelijk de parameter ‘-online’ toevoegen. De meeste cmdlets hebben een eigen website waarin meer informatie wordt gegeven. PowerShell opent deze site automatisch. In het geval van Get-Service, wordt de onderstaande link geopend: Get-Service (Microsoft.PowerShell.Management) – PowerShell | Microsoft Learn. Daar staat nog meer informatie en worden er voorbeelden getoond.

 

Afsluitend

Voor beginnende gebruikers is Get-Help een snelle manier om meer te weten te komen over een cmdlet. Er is uitleg over wat het cmdlet doet, welke parameters er zijn en hoe je deze parameters kunt gebruiken. Je kan voorbeelden krijgen door ‘-examples’ toe te voegen en je kan de website bekijken door ‘-online’ toe te voegen. Om te zorgen dat Get-Help goed werkt, is het belangrijk om Update-Help te gebruiken.

 

Dit blog is geschreven door Samuel de Korte, specialist DevOps & Automation