PowerShell mit Get-Help meistern

Mit dem PowerShell-Cmdlet Get-Help erweiterst du dein Verständnis dieser leistungsstarken IT-Automatisierungstechnologie – eine kleine Einführung: 

PowerShell, Microsofts Framework für Aufgabenautomatisierung und Konfigurationsmanagement, bietet eine leistungsstarke Befehlszeilen- und Skriptsprache für jeden Systemadministrator und IT-Profi. Eines der grundlegendsten und nützlichsten Cmdlets in PowerShell ist Get-Help. Dieses Cmdlet ist dein Einstieg in das Verstehen und Verwenden der vielen Befehle, die in PowerShell verfügbar sind. Get-Help ist sowohl für Anfänger als auch für Fortgeschrittene unverzichtbar, um die PowerShell-Befehle zu verstehen und zu beherrschen.

Get-Help verstehen

Get-Help ist ein Cmdlet, das detaillierte Informationen über PowerShell-Cmdlets, -Funktionen, -Skripte und -Konzepte abruft. Es hilft Nutzern, mehr über die Befehle, ihre Syntax, Anwendungsbeispiele, Parameter etc. zu lernen. Im Grunde ist es ein eingebautes Handbuch, das die notwendige Anleitung für die effektive Nutzung von PowerShell bietet.

Syntax und Verwendung

Die grundlegende Syntax von Get-Help ist denkbar einfach:

Get-Help <Name> [-Full] [-Examples] [-Parameter <Name>] [-Online]

• <Name>: Der Name des Cmdlets, der Funktion, des Skripts oder des Konzepts, zu dem du Hilfe benötigst.
• -Full: Zeigt die vollständigen Hilfeinformationen an, einschließlich Beschreibungen, Parameter, Beispiele und zusätzliche Hinweise.
• -Examples: Zeigt Beispiele für die Verwendung des Cmdlets an.
• -Parameter: Bietet detaillierte Informationen zu einem bestimmten Parameter des Cmdlets.
• -Online: Öffnet die Online-Version des Hilfedokuments in deinem Standard-Webbrowser und bietet die aktuellsten Informationen.

So verwendest du Get-Help 

Zeige Hilfeinformationen über das PowerShell-Hilfesystem an:

Get-Help

Um zu verstehen, wie ein bestimmtes Cmdlet funktioniert, verwende einfach Get-Help gefolgt von dem Namen des Cmdlets. Um zum Beispiel mehr über Get-Process zu erfahren, gibtst du das hier ein:

Get-Help Get-Process

Wenn du den genauen Namen eines Cmdlets nicht kennst, kannst du Platzhalter verwenden:

Get-Help Get-Pr*

Eine weitere Möglichkeit, um Hilfe anzufordern:

Get-Process -?

Du möchtest etwas über konzeptionelle PowerShell-Themen erfahren? Verwende about_, um anzugeben, wonach du suchst. Um zu erfahren, wie ForEach-Schleifen funktionieren, hilft das hier weiter:

Get-Help about_ForEach

Weitere hilfreiche Optionen 

Für diejenigen, die umfassende Details suchen, ist der Parameter -Full von unschätzbarem Wert. Er liefert dir alles, was du über ein Cmdlet wissen musst, einschließlich detaillierter Beschreibungen der Parameter sowie der Ein- und Ausgaben.

Get-Help Get-Process -Full

Wenn du nach praktischen Anwendungsbeispielen suchst, ist der Parameter -Examples besonders nützlich. Er zeigt verschiedene Möglichkeiten, das Cmdlet in realen Szenarien zu verwenden, und hilft dir, die Vielseitigkeit des Cmdlets zu verstehen.

Get-Help Get-Process -Examples

Mit dem Parameter -Online kannst du die aktuellste Hilfedokumentation aus dem Internet aufrufen. Es wird ein Browserfenster geöffnet und der Online-Artikel von Microsoft angezeigt.

Get-Help Get-Process -Online

Mit -ShowWindow kannst du das PowerShell-Hilfesystem in einem separaten Fenster öffnen.

Hinweis: Dieser Parameter funktioniert nur auf einem Windows-Rechner.

Get-Help Get-Process -ShowWindow

Halte deine PowerShell Hilfe up-to-date 

Mit der Weiterentwicklung der PowerShell wird auch die Dokumentation aktualisiert. Neue Cmdlets werden eingeführt und bestehende Cmdlets werden mit neuen Funktionen und Parametern aktualisiert. Um sicherzustellen, dass die Hilfeinhalte auf deinem System auf dem neuesten Stand sind, bietet PowerShell das Cmdlet Update-Help. Dieses Cmdlet lädt die neuesten Hilfedateien für PowerShell-Module herunter und installiert sie. Dadurch wird sichergestellt, dass du die neuesten verfügbaren Informationen erhältst, wenn du Get-Help verwendest.

Update-Help lädt die neuesten Hilfedateien aus dem Internet herunter und aktualisiert die Hilfe für die auf dem System installierten Module. Dies ist eine einfache, aber effektive Methode, um die Hilfedokumentation mit den neuesten PowerShell-Versionen und -Funktionen auf dem neuesten Stand zu halten.

Die grundlegende Syntax für Update-Help lautet wie folgt:

Update-Help [-Module <String[]>] [-Force] [-UICulture <CultureInfo[]>] [-Credential <PSCredential>]

• -Module <String[]>: Gibt die Module an, für die die Hilfe aktualisiert werden soll. Wenn nichts angegeben wird, aktualisiert Update-Help alle Module, die aktualisierbare Hilfe unterstützen und auf dem Computer installiert sind.
• -Force: Erzwingt eine Aktualisierung der Hilfedateien, auch wenn diese innerhalb der letzten 24 Stunden aktualisiert wurden.
• -UICulture <CultureInfo[]>: Gibt die UI-Kultur (Sprache) für die aktualisierten Hilfedateien an. Dies ist nützlich, wenn du Hilfeinhalte in einer bestimmten Sprache bevorzugst.
• -Credential <PSCredential>: Gibt die Zugangsdaten an, die für den Internetzugang berechtigt sind, wenn deine Umgebung eine Authentifizierung erfordert.

Für ein Update der Hilfeinhalte aller Module, die solch eine aktualisierbare Hilfe unterstützen, führe einfach Folgendes aus:

Update-Help

Du möchtest die Hilfedateien für ein bestimmtes Modul aktualisieren? Das ist kein Problem. Hier ist ein Beispiel, das nur die Hilfe für das Modul Applocker aktualisiert:

Update-Help -Module Applocker

Conclusion

Die Cmdlets Get-Help und Update-Help sind mehr als nur Funktionen; sie sind grundlegende Werkzeuge, die es den Nutzern ermöglichen, PowerShell voll auszuschöpfen. Wenn du diese Cmdlets in deinen täglichen Arbeitsablauf integrierst, stellst du sicher, dass du immer mit dem neuesten Wissen und den besten Methoden arbeitest und jede Aufgabe in der PowerShell effizient und effektiv lösen kannst.

Weiterführende Links

• ScriptRunner YouTube channel
• ScriptRunner Newsletter