Interpretieren der Hilfedateiinhalte und Aktualisieren des lokalen Hilfeinhalts in PowerShell
Wenn Sie den Befehl für eine bestimmte Aufgabe gefunden haben, können Sie dessen Hilfedatei verwenden, um zu erfahren, wie Sie ihn verwenden können. Eine Möglichkeit, ein besseres Verständnis zu erhalten, besteht darin, die Beispiele durchzugehen und ihre Verwendung nachzuvollziehen. Allerdings decken die Beispiele in der Regel nicht alle möglichen Möglichkeiten der Verwendung des Befehls ab. Durch Interpretieren der Hilfetextsyntax können Sie alle Funktionen eines bestimmten Befehls identifizieren.
Hilfe zu Get-EventLog
Verwenden Sie die Hilfe für Get-EventLog als Beispiel. Wenn Sie den Befehl Get-Help Get-EventLog in der Konsole eingeben und die EINGABETASTE drücken, gibt die Hilfe die folgende Syntax zurück:
Get-EventLog [-LogName] <String> [[-InstanceId] <Int64[]>] [-After <DateTime>] [-AsBaseObject] [-Before <DateTime>] [-ComputerName <String[]>] [-EntryType {Error | Information | FailureAudit | SuccessAudit | Warning}] [-Index <Int32[]>] [-Message <String>] [-Newest <Int32>] [-Source <String[]>] [-UserName <String[]>] [<CommonParameters>]
Get-EventLog [-AsString] [-ComputerName <String[]>] [-List] [<CommonParameters>]
Die beiden Textblöcke sind Parametersätze, die jeweils eine Möglichkeit darstellen, in der Sie den Befehl ausführen können. Beachten Sie, dass jeder Parametersatz viele Parameter enthält und beide mehrere Parameter gemeinsam haben. Sie können keine Parameter aus verschiedenen Sätzen kombinieren. Wenn Sie den Parameter "–List " verwenden möchten, können Sie nicht auch "–LogName" verwenden, da diese Parameter nicht in demselben Parametersatz zusammen angezeigt werden.
Der Parametername "–LogName " wird in eckige Klammern eingeschlossen, d. h. es handelt sich um einen Positionsparameter. Sie können den Befehl nicht ohne einen Protokollnamen ausführen. Sie müssen jedoch nicht den Parameternamen "–LogName " eingeben. Sie müssen die Protokollnamenzeichenfolge als ersten Parameter übergeben, da dies die Position in der Hilfedatei ist, an der der Parameter "–LogName " angezeigt wird. Daher ergeben die folgenden beiden Befehle die gleichen Ergebnisse:
Get-EventLog –LogName Application
Get-EventLog Application
Weglassen von Parameternamen
Beim Weglassen von Parameternamen sollten Sie aus mehreren Gründen vorsichtig sein. Nicht jeder Parameter kann weggelassen werden. Der Parameter -ComputerName kann nicht ohne Angabe des Parameternamens verwendet werden. Außerdem besteht die Gefahr, dass Sie schnell den Bezug der einzelnen Parameter verlieren. Bei Angabe der Parameternamen können die Parameter in beliebiger Reihenfolge angezeigt werden, wie der folgende Befehl veranschaulicht:
Get-EventLog –ComputerName LON-DC1 –LogName Application –Newest 10
Lassen Sie jedoch Parameternamen weg, müssen Sie darauf achten, die Parameter in der richtigen Reihenfolge anzugeben. Der folgende Befehl funktioniert zum Beispiel nicht, weil der Wert für den Protokollnamen nicht an der richtigen Stelle angezeigt wird:
Get-EventLog –ComputerName LON-DC1 Application
Angeben von mehreren Werten
Einige Parameter akzeptieren mehrere Werte. Im SYNTAX-Abschnitt bezeichnet eine doppelt quadratische Klammernnotation im Parameterwerttyp diese Parameter. Beispiel:
-ComputerName <string[]>
Die obige Syntax gibt an, dass der Parameter "–ComputerName " einen oder mehrere Zeichenfolgenwerte akzeptieren kann. Mehrere Werte können beispielsweise in einer durch Kommas getrennten Liste angegeben werden. Sie müssen die Werte nicht in Anführungszeichen setzen, es sei denn, die Werte selbst enthalten ein Komma oder ein Leerzeichen, wie z. B. ein Leerzeichen oder ein Tabstoppzeichen. Mit dem folgenden Befehl können Sie zum Beispiel mehrere Computernamen angeben:
Get-EventLog –LogName Application –ComputerName LON-CL1,LON-DC1
Hinweis
Weitere Informationen zu den einzelnen Parametern finden Sie auf der ausführlichen Hilfeseite des Befehls. Führen Sie beispielsweise Get-Help Get-EventLog –Vollständig aus, um die vollständige Hilfe für Get-EventLog zu überprüfen, und beachten Sie die zusätzlichen Informationen, die angezeigt werden. Sie können beispielsweise bestätigen, dass der Parameter "–LogName " obligatorisch ist und an der ersten Position angezeigt wird.
Beste Praxis: Wenn Sie gerade erst mit Windows PowerShell beginnen, versuchen Sie, vollständige Parameternamen bereitzustellen, anstatt Parameterwerte nach Position zu übergeben. Vollständige Parameternamen erleichtern die Überprüfung und Fehlerbehebung von Befehlen und das Erkennen von Fehlern, wenn der Befehl nicht korrekt eingegeben wurde.
Aktualisieren der Hilfe
Im Lieferumfang von Windows PowerShell 3.0 und neueren Versionen sind keine Hilfedateien enthalten. Die Hilfedateien sind stattdessen als Onlinedienst verfügbar. Die Hilfedateien der von Microsoft erstellten Befehle werden auf Microsoft-eigenen Webservern gehostet. Befehle, die nicht von Microsoft stammen, sind manchmal online verfügbar, sofern der Autor oder Anbieter das Modul korrekt erstellt und einen Onlinespeicherort für die Hilfedateien bereitstellt. Mithilfe des Onlinemodells können Autoren, die Befehle schreiben, einschließlich Microsoft-Autoren, Korrekturen und Verbesserungen an ihren Hilfedateien im Laufe der Zeit vornehmen und diese dann bereitstellen, ohne ein gesamtes Produktupdate erstellen zu müssen.
Führen Sie "Update-Help" aus, um Ihren Computer nach allen installierten Modulen zu durchsuchen, Onlinehilfespeicherorte für die einzelnen Module abzurufen und ihre jeweiligen Hilfedateien herunterzuladen. Sie müssen diesen Befehl als Mitglied der lokalen Gruppe "Administratoren " ausführen, da die Windows PowerShell-Hauptbefehlshilfe im ordner%systemdir% gespeichert ist. Fehlermeldungen werden angezeigt, wenn die Hilfe nicht heruntergeladen werden kann. In diesem Fall stellt Windows PowerShell für die Befehle eine Standardhilfeanzeige bereit.
Windows PowerShell lädt standardmäßig Hilfedateien in der konfigurierten Sprache Ihres Systems herunter. Wenn die Hilfe in dieser Sprache nicht verfügbar ist, verwendet Windows PowerShell standardmäßig die Spracheen-US (US-Englisch). Sie können dieses Verhalten überschreiben, indem Sie einen Parameter von Update-Help verwenden, um die UICulture anzugeben, für die Sie Hilfe abrufen möchten.
Standardmäßig sucht die Update-Hilfe einmal alle 24 Stunden nach Hilfedateien, auch wenn Sie den Befehl mehrmals in einer Zeile ausführen. Um dieses Verhalten außer Kraft zu setzen, schließen Sie den Parameter "–Force " ein.
Der Begleiter für Update-Help ist Save-Help. Er lädt den Hilfeinhalt herunter und speichert ihn an einem von Ihnen angegebenen Speicherort. Mit diesem Feature können Sie diesen Inhalt auf Computer kopieren, die nicht mit dem Internet verbunden sind. Update-Help bietet einen Parameter zum Angeben eines alternativen Quellspeicherorts. Dieses Feature ermöglicht es, Hilfeinhalte auf Computern zu aktualisieren, die nicht mit dem Internet verbunden sind.
Vor Windows PowerShell 4.0 laden Update-Hilfe und Save-Help-Hilfe nur für die cmdlets herunter, die auf dem lokalen Computer installiert sind (auf dem Sie den Befehl ausführen). In Windows PowerShell 4.0 und höher können Sie die Speicherhilfe für Module verwenden, die auf Remotecomputern installiert sind.