about_Updatable_Help
Letzte Aktualisierung: Mai 2014
Betrifft: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0
THEMA
About_Updatable_Help
KURZE BESCHREIBUNG
Beschreibt das aktualisierbare Hilfesystem (Updatable Help) von Windows PowerShell®.
LANGE BESCHREIBUNG
Windows PowerShell bietet verschiedene Zugriffsmöglichkeiten auf die aktuellsten Hilfethemen zu den Cmdlets und Konzepten von Windows PowerShell.
Durch das in Windows PowerShell 3.0 eingeführte aktualisierbare Hilfesystem (Updatable Help) wird sichergestellt, dass Ihnen auf Ihrem lokalen Computer stets die neuesten Hilfethemen zur Verfügung stehen und auf Abruf an der Befehlszeile angezeigt werden. Dieses Hilfesystem vereinfacht das Herunterladen, das Installieren und schließlich auch das Aktualisieren der Hilfedateien, sobald neuere Hilfedateien verfügbar sind.
Damit die aktualisierte Hilfe auch für mehrere Computer in einem Unternehmen bzw. für Computer bereitsteht, die keinen Zugriff auf das Internet haben, können Sie die Hilfedateien der Updatable Help in ein Dateisystemverzeichnis oder in eine Dateifreigabe herunterladen und dann aus dieser Dateifreigabe installieren.
In Windows PowerShell 4.0 wurde die Eigenschaft HelpInfoUri für Windows PowerShell Remoting beibehalten, damit Save-Help auch für Module funktioniert, die zwar auf einem Remotecomputer, nicht aber in jedem Fall auch auf dem lokalen Computer installiert sind. Sie können auf einem Computer, der über keinen Internetzugriff verfügt, ein PSModuleInfo-Objekt durch Ausführung von Export-CliXml auf einen Datenträger oder ein Wechselmedium (z. B. auf einen USB-Stick) speichern, das PSModuleInfo-Objekt auf einen Computer ohne Internetzugriff importieren und dann an diesem PSModuleInfo-Objekt Save-Help ausführen. Die solchermaßen gespeicherte Hilfe kann mithilfe von Wechselmedien auf den nicht verbundenen Remotecomputer kopiert und durch Ausführung von Update-Help installiert werden. Durch diese Verbesserung an der Save-Help-Funktion lässt sich die Hilfe auch auf Computern installieren, die über keinen Netzwerkzugriff verfügen. Ein Beispiel zur Verwendung der neuen Save-Help-Funktion finden Sie unter "AKTUALISIEREN DER HILFE AUS EINER DATEIFREIGABE: SAVE-HELP" in diesem Thema.
Updatable Help unterstützt auch einen Online-Zugriff auf die neuesten Hilfethemen und die grundlegende Hilfe für Cmdlets, selbst wenn auf dem Computer keine Hilfedateien installiert sind.
Mit Windows PowerShell 3.0 werden keine Hilfedateien installiert. Jedoch können Sie die Hilfedateien zu allen Standardbefehlen von Windows PowerShell und zu allen Windows-Modulen mithilfe der Updatable Help-Funktion installieren.
CMDLETS FÜR DIE UPDATABLE HELP
Update-Help:
Lädt die neuesten Hilfedateien aus dem Internet oder einer Dateifreigabe herunter und installiert sie auf dem lokalen Computer.
Save-Help:
Lädt die neuesten Hilfedateien aus dem Internet herunter und speichert sie in ein Dateisystemverzeichnis oder in eine Dateifreigabe. Zum anschließenden Installieren der Hilfedateien auf Computern verwenden Sie Update-Help.
Get-Help:
Zeigt Hilfethemen in der Befehlszeile an.
Die Hilfe wird aus den auf dem Computer gespeicherten Hilfedateien abgerufen.
Für Cmdlets und Funktionen, für die keine Hilfedateien verfügbar sind, wird eine automatisch generierte Hilfe angezeigt.
Die Online-Hilfethemen für Cmdlets, Funktionen, Skripts und Workflows werden in Ihrem Standard-Internetbrowser geöffnet.
AKTUALISIEREN DER HILFE IN WINDOWS POWERSHELL ISE
Sie können die Hilfe auch mit der Option "Windows PowerShell-Hilfe aktualisieren" aus dem Hilfemenü von Windows PowerShell Integrated Scripting Environment (ISE) aktualisieren.
Die Option "Windows PowerShell-Hilfe aktualisieren" führt den Befehl Update-Help ohne Parameter aus.
AUTOMATISCH GENERIERTE HILFE: HILFE OHNE HILFEDATEIEN
Wenn Sie die Hilfedatei für ein Cmdlet, eine Funktion oder einen Workflow nicht auf Ihrem Computer installiert haben, zeigt das Cmdlet Get-Help eine automatisch generierte Hilfe an, die Sie fragt, ob Sie die Hilfedateien herunterladen oder online lesen möchten.
Die automatisch generierte Hilfe enthält den Namen, die Syntax und die Aliase der Komponente sowie Hinweise, die die Verwendung der Cmdlets der Updatable Help sowie den Zugriff auf die Online-Hilfethemen erläutern.
Der folgende Befehl ruft zum Beispiel eine grundlegende Hilfe für das Cmdlet Get-Culture ab. Wenn auf dem Computer keine Hilfedateien vorhanden sind, gibt der Befehl die Get-Help-Anzeige zurück.
PS C:\> Get-Help Get-Culture
NAME
Get-Culture
SYNTAX
Get-Culture [<CommonParameters>]
ALIASES
Keine
HINWEISE
Geben Sie zum Abrufen der aktuellsten Hilfe einschließlich Beschreibungen und Beispielen Folgendes ein: Update-Help.
HILFEDATEIEN FÜR MODULE
Die kleinste Einheit der Updatable Help ist die Hilfe für ein Modul. Die Modul-Hilfe enthält Hilfe für alle Cmdlets, Funktionen, Workflows, Anbieter, Skripts und Konzepte eines Moduls. Sie können die Hilfe zu allen Modulen aktualisieren, die auf dem Computer installiert sind, selbst wenn die Module nicht in die aktuelle Sitzung importiert wurden.
Allerdings kann nur die Hilfe für das gesamte Modul, nicht für einzelne Cmdlets aktualisiert werden.
Zur Ermittlung des Moduls, das ein bestimmtes Cmdlet enthält, verwenden Sie das folgende Befehlsformat:
(Get-Command <cmdlet-name>).ModuleName
Beispielsweise geben Sie zur Ermittlung des Moduls, das das Cmdlet Set-ExecutionPolicy enthält, Folgendes ein:
(Get-Command Set-ExecutionPolicy).ModuleName
Zur Aktualisierung der Hilfe eines bestimmten Moduls geben Sie Folgendes ein:
Update-Help -Module <ModuleName>
Beispielsweise geben Sie zur Aktualisierung der Hilfe des Moduls, das das Cmdlet Set-ExecutionPolicy enthält, Folgendes ein:
Update-Help -Module Microsoft.PowerShell.Security
BERECHTIGUNGEN FÜR UPDATABLE HELP
Zur Aktualisierung der Hilfe zu den Modulen im Verzeichnis $pshome\Modules müssen Sie auf dem Computer Mitglied der Gruppe "Administratoren" sein.
Andernfalls können Sie die Hilfe für diese Module nicht aktualisieren; wenn Sie aber über Internetzugang verfügen, können Sie die Hilfe online aus der TechNet-Bibliothek anzeigen.
Zur Aktualisierung der Hilfe zu den Modulen im Verzeichnis $home\Documents\WindowsPowerShell\Modules oder zu den Modulen in anderen Unterverzeichnissen des Verzeichnisses $home sind keine besonderen Berechtigungen erforderlich.
Die Cmdlets Update-Help und Save-Help enthalten den Parameter UseDefaultCredentials, der die expliziten Anmeldeinformationen des aktuellen Benutzers bereitstellt. Dieser Parameter wird für den Zugriff auf sichere Internetstandorte benötigt.
Darüber hinaus enthalten die Cmdlets Update-Help und Save-Help den Parameter Credential, der die Ausführung des Befehls und den Zugriff auf eine Dateifreigabe auch auf einem Remotecomputer zulässt. Der Parameter Credential wird nur verwendet, wenn Sie den Parameter SourcePath oder LiteralPath des Cmdlets Update-Help bzw. den Parameter DestinationPath oder LiteralPath des Cmdlets Save-Help verwenden.
INSTALLIEREN UND AKTUALISIEREN DER HILFEDATEIEN
Zum erstmaligen Herunterladen und Installieren bzw. zum Aktualisieren der Hilfedateien auf Ihrem Computer verwenden Sie das Cmdlet Update-Help.
Das Cmdlet Update-Help erledigt die gesamte Arbeit, u. a. die folgenden Aufgaben, für Sie.
Ermittlung der Module, die Updatable Help unterstützen.
Lokalisieren der Internetstandorte, an denen die Module ihre Updatable Help-Dateien speichern.
Vergleich der Hilfedateien der einzelnen Module auf Ihrem Computer mit den aktuellsten Hilfedateien, die für jedes Modul verfügbar sind.
Herunterladen der neuen Dateien aus dem Internet.
Entpacken des Hilfepakets.
Überprüft, ob es sich bei den Dateien um gültige Hilfedateien handelt.
Installieren der Hilfedateien im sprachspezifischen Unterverzeichnis des Modulverzeichnisses.
Für den Zugriff auf die neuen Hilfethemen verwenden Sie das Cmdlet Get-Help. Sie müssen Windows PowerShell nicht neu starten.
Zum Installieren oder Aktualisieren der Hilfe für alle Module auf dem Computer, die Updatable Help unterstützen, geben Sie Folgendes ein:
Update-Help
Zum Aktualisieren der Hilfe für bestimmte Module fügen Sie dem Cmdlet Update-Help den Parameter Module hinzu. Der Modulname darf auch Platzhalterzeichen enthalten.
Update-Help -Module ServerManager
HINWEISE
Ohne Angabe von Parametern aktualisiert Update-Help die Hilfe für alle in der Sitzung geladenen Module sowie für alle installierten Module, die Updatable Help unterstützen. Um in der Aktualisierung eingeschlossen zu werden, müssen die Module in Verzeichnissen installiert sein, die in der Umgebungsvariablen PSModulePath enthalten sind. Diese Module werden auch vom Befehl "Get-Help -ListAvailable" zurückgegeben.
Wenn der Wert des Parameters Module * (alle) ist, versucht Update-Help die Hilfe für alle installierten Module zu aktualisieren, auch für Module, die Updatable Help gar nicht unterstützen. Dieser Befehl führt meist zu sehr vielen Fehlern, da viele vom Cmdlet erkannten Module Updatable Help nicht unterstützen.
AKTUALISIEREN DER HILFE AUS EINER DATEIFREIGABE: SAVE-HELP
Zur Unterstützung von Computern, die nicht mit dem Internet verbunden sind, oder zur Steuerung oder Optimierung der Hilfeaktualisierung in einem Unternehmen, verwenden Sie das Cmdlet Save-Help. Das Cmdlet Save-Help lädt Hilfedateien aus dem Internet herunter und speichert diese in dem von Ihnen angegebenen Dateisystemverzeichnis.
Save-Help vergleicht die Hilfedateien im angegebenen Verzeichnis mit den neuesten für die einzelnen Module verfügbaren Hilfedateien. Wenn das Verzeichnis keine Hilfedateien enthält bzw. für ein Modul neuere Hilfedateien verfügbar sind, lädt das Cmdlet Save-Help die neuen Dateien aus dem Internet herunter. Es entpackt oder installiert die Hilfedateien jedoch nicht.
Zum Installieren oder Aktualisieren der Hilfedateien auf einem Computer aus Hilfedateien, die in ein Dateisystemverzeichnis gespeichert wurden, verwenden Sie das Cmdlet Update-Help mit dem Parameter SourcePath. Das Cmdlet Update-Help identifiziert die neuesten Hilfedateien, entpackt und überprüft sie und installiert sie in den sprachspezifischen Unterverzeichnissen des Modulverzeichnisses.
Zum Speichern der Hilfe für alle installierten Module im Verzeichnis \\Server\Share geben Sie beispielsweise Folgendes ein:
Save-Help -DestinationPath \\Server\Share
Zum Aktualisieren der Hilfe aus dem Verzeichnis \\Server\Share geben Sie dann Folgendes ein:
Update-Help -SourcePath \\Server\Share
Die folgenden Beispiele zeigen die Verwendung des Cmdlets Save-Help zum Speichern der Hilfe für Module, die nicht auf dem lokalen Computer installiert sind. In diesem Beispiel führt der Administrator Save-Help zum Speichern der Hilfe für das DhcpServer-Modul von einem Clientcomputer mit Internetzugang aus, ohne das DhcpServer-Modul oder die DHCP-Serverrolle auf dem lokalen Computer zu installieren.
Option 1:
Führen Sie Invoke-Command aus, um das PSModuleInfo-Objekt für das Remotemodul abzurufen, speichern Sie es in der Variablen $m und führen Sie dann Save-Help für das PSModuleInfo-Objekt aus, indem Sie die Variable $m als Modulnamen angeben.
$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
{ Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath C:\SavedHelp
Option 2:
Öffnen Sie eine PSSession mit dem Computer, auf dem das DHCP-Servermodul ausgeführt wird, rufen Sie das PSModuleInfo-Objekt für das Modul ab, speichern Sie es in der Variablen $m und führen Sie dann Save-Help für das in der $m-Variablen gespeicherte Objekt aus.
$s = New-PSSession -ComputerName RemoteServer
$m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp
Option 3:
Öffnen Sie eine CIM-Sitzung mit dem Computer, auf dem das DHCP-Servermodul ausgeführt wird, rufen Sie das PSModuleInfo-Objekt für das Modul ab, speichern Sie es in der Variablen $m und führen Sie dann Save-Help für das in der $m-Variablen gespeicherte Objekt aus.
$c = New-CimSession -ComputerName RemoteServer
$m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
Save-Help -Module $m -DestinationPath C:\SavedHelp
Im folgenden Beispiel installiert der Administrator die Hilfe für das DHCP-Servermodul auf einem Computer, der über keinen Netzwerkzugriff verfügt.
# Führen Sie zuerst Export-CliXml aus, um das PSModuleInfo-Objekt in einen freigegebenen Ordner oder auf ein Wechselmedium zu exportieren.
$m = Get-Module -Name DhcpServer –ListAvailable
Export-CliXml –Path E:\UsbFlashDrive\DhcpModule.xml –InputObject $m
# Schließen Sie das Wechselmedium danach an einem Computer mit Internetzugriff an und importieren Sie das PSModuleInfo-Objekt mit Import-CliXml. Führen Sie Save-Help aus, um die Hilfe für das PSModuleInfo-Objekt des importierten DHCP-Servermoduls zu speichern.
$deserialized_m = Import-CliXml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $deserialized_m –DestinationPath
E:\UsbFlashDrive\SavedHelp
# Schließen Sie das Wechselmedium wieder an dem Computer ohne Netzwerkzugriff an und installieren Sie die Hilfe durch Ausführen von Update-Help.
Update-Help –Module DhcpServer –SourcePath
E:\UsbFlashDrive\SavedHelp
HINWEISE:
Ohne Angabe von Parametern lädt Save-Help die Hilfe für alle in der Sitzung geladenen Module sowie für alle installierten Module herunter, die Updatable Help unterstützen. Um im Download eingeschlossen zu werden, müssen die Module entweder auf dem lokalen Computer oder auf einem Remotecomputer, für den Sie die Hilfe speichern möchten, in Verzeichnissen installiert sein, die in der Umgebungsvariablen PSModulePath enthalten sind. Diese Module werden auch vom Befehl "Get-Help -ListAvailable" zurückgegeben.
AKTUALISIEREN DER HILFEDATEIEN IN VERSCHIEDENEN SPRACHEN
Standardmäßig laden die Cmdlets Update-Help und Save-Help die Hilfe in der UI-Kultur und -Sprache herunter, die für Windows auf dem lokalen Computer eingestellt ist. Wenn für die angegebenen Module in der lokalen UI-Kultur keine Hilfedateien verfügbar sind, gehen Update-Help und Save-Help nach den Windows-Fallbackregeln für die Sprachauswahl vor, um die beste unterstützte Sprache zu finden.
Mit dem Parameter UICulture der Cmdlets Update-Help und Save-Help können Sie die Hilfedateien jedoch in jeder UI-Kultur herunterladen und installieren, in der die Dateien verfügbar sind.
Um die neuesten Hilfedateien für alle Module der Sitzung in Japanisch (Ja-jp) und Französisch (fr-FR) zu speichern, geben Sie zum Beispiel Folgendes ein:
Save-Help -Path \\Server\Share -UICulture ja-jp, fr-fr
Wenn in der angegebenen Sprache keine Hilfedateien für die Module verfügbar sind, geben die Cmdlets Update-Help und Save-Help eine Fehlermeldung zurück, in der auch die für die einzelnen Modulhilfen verfügbaren Sprachen aufgelistet werden, damit Sie die beste für Ihre Anforderungen geeignete Alternative selbst auswählen können.
AUTOMATISCHES AKTUALISIEREN DER HILFE
Um sicherzustellen, dass Ihre Hilfedateien stets aktuell sind, können Sie Ihrem Windows PowerShell-Profil einen Update-Help-Befehl hinzufügen.
Ein internes Kontingent verhindert, dass der Update-Help-Befehl häufiger als einmal pro Tag ausgeführt wird. Dieses Limit können Sie jedoch mit dem Parameter Force überschreiben.
Verwenden Sie in Ihrem Profil einen Befehl wie den folgenden. Dieser Befehl aktualisiert die Hilfe für alle installierten Module im Hintergrund, sodass Ihre Arbeit davon nicht beeinträchtigt wird. Mit dem Befehl Out-Null unterdrückt er die Rückgabe des Auftrags sowie alle Fehlermeldungen, die andernfalls zurückgegeben werden würden, wenn Sie den Befehl mehrmals pro Tag verwenden.
Start-Job {Update-Help} | Out-Null
Sie können auch einen geplanten Auftrag erstellen, der Update-Help oder Save-Help im von Ihnen angegebenen Intervall ausführt.
Der folgende Befehl erstellt zum Beispiel einen geplanten Auftrag, der den Befehl Update-Help jeden Freitag um 5:00 Uhr ausführt. Zur Ausführung dieses Befehls müssen Sie Windows PowerShell mit der Option "Als Administrator ausführen" starten.
Register-ScheduledJob -Name UpdateHelpJob -ScriptBlock {Update-Help} `
-Trigger (New-JobTrigger -Weekly -DaysOfWeek Friday -At "5:00 AM")
Weitere Informationen zu geplanten Aufträgen finden Sie unter "about_Scheduled_Jobs".
VERWENDEN DER ONLINE-HILFE
Wenn Sie die Hilfedateien auf Ihrem lokalen Computer nicht aktualisieren können oder wollen, können Sie die neuesten Hilfedateien online abrufen.
Zum Öffnen des Online-Hilfethemas zu einem Cmdlet oder einer Funktion führen Sie das Cmdlet Get-Help mit dem Parameter Online aus.
Der folgende Befehl öffnet beispielsweise das Online-Hilfethema für das Cmdlet Get-Job in Ihrem Standardinternetbrowser:
Get-Help Get-Job -Online
- oder -
Get-Help -on Get-Job
Zum Abrufen der Online-Hilfe für ein Skript verwenden Sie den Online-Parameter mit dem vollständigen Pfad zum Skript.
"About"-Themen (Informationen zu...) werden vom Parameter Online nicht unterstützt. Die konzeptionellen Hilfethemen für das Kernmodul von Windows PowerShell, einschließlich der Hilfethemen zur Sprache von Windows PowerShell, finden Sie unter "Konzeptionelle Hilfethemen für Windows PowerShell Core" (https://go.microsoft.com/fwlink/?LinkID=113206).
MINIMIEREN BZW. VERMEIDEN VON INTERNETDOWNLOADS
Zum Minimieren von Internetdownloads und zum Bereitstellen der Updatable Help auch für Benutzer, die nicht mit dem Internet verbunden sind, verwenden Sie das Cmdlet Save-Help. Damit laden Sie die Hilfe einmal aus dem Internet herunter und speichern sie in einer Netzwerkfreigabe. Danach erstellen Sie eine Gruppenrichtlinieneinstellung oder einen geplanten Auftrag, die bzw. der auf allen Computern einen Update-Help-Befehl ausführt. Als Wert für den Parameter SourcePath des Cmdlets Update-Help geben Sie die Netzwerkfreigabe an.
Wenn Sie verhindern möchten, dass Benutzer mit Internetzugriff Updatable Help selbst aus dem Internet herunterladen, verwenden Sie die Gruppenrichtlinieneinstellung "Set the default source path for Update-Help" (Standardquellenpfad für Update-Help festlegen).
Mit dieser Gruppenrichtlinieneinstellung fügen Sie dem Update-Help-Befehl auf jedem betroffenen Computer implizit den Parameter SourcePath mit dem von Ihnen angegebenen Dateisystemverzeichnis hinzu. Die Benutzer können den Parameter SourcePath dann zwar noch explizit zur Angabe eines anderen Dateisystemverzeichnisses verwenden, Sie können den Parameter SourcePath jedoch nicht ausschließen, um Hilfe aus dem Internet herunterzuladen.
HINWEIS:
Die Gruppenrichtlinieneinstellung "Set the default source path for Update-Help" erscheint sowohl unter "Computer Configuration" als auch unter "User Configuration". Allerdings ist nur die Richtlinieneinstellung unter "Computer Configuration" wirksam. Die Richtlinieneinstellung unter "User Configuration" wird ignoriert.
Weitere Informationen finden Sie unter "about_Group_Policy_Settings".
AKTUALISIEREN DER HILFE FÜR NICHT STANDARDGEMÄSSE MODULE
Zum Aktualisieren oder Speichern der Hilfe für ein Modul, das nicht vom Parameter ListAvailable des Cmdlets Get-Module zurückgegeben wird, importieren Sie das Modul vor der Ausführung des Update-Help- oder Save-Help-Befehls in die aktuelle Sitzung. Importieren Sie das Modul auf einem Remotecomputer vor der Ausführung des Befehls Save-Help in die aktuelle, mit dem Remotecomputer verbundene CIM- oder PSSession (bzw. in den Invoke-Command-Skriptblock).
Wenn sich das Modul in der aktuellen Sitzung befindet, führen Sie das Cmdlet Update-Help oder Save-Help ohne Parameter aus. Andernfalls verwenden Sie den Parameter Module zur Angabe des Modulnamens.
Der Parameter Module der Cmdlets Update-Help und Save-Help akzeptiert nur den Namen eines Moduls. Den Pfad einer Moduldatei akzeptiert er nicht.
Verwenden Sie dieses Verfahren zum Aktualisieren oder Speichern der Hilfe für jedes Modul, das nicht durch den Parameter ListAvailable zurückgegeben wird, beispielsweise für ein Modul, das in einem Verzeichnis installiert ist, das nicht in der Umgebungsvariablen PSModulePath enthalten ist, oder für ein falsch deklariertes Modul (das Modulverzeichnis enthält keine Datei, deren Stammname dem Namen des Verzeichnisses entspricht).
UNTERSTÜTZUNG FÜR UPDATABLE HELP
Bei der Erstellung eines Moduls können Sie festlegen, ob das Modul die Onlinehilfe und Updatable Help unterstützt. Weitere Informationen finden Sie in der MSDN-Bibliothek unter "Supporting Updatable Help" (Unterstützung für Updatable Help) und "Supporting Online Help" (Unterstützung für die Onlinehilfe).
Für Windows PowerShell-Snap-ins und kommentarbasierte Hilfen ist keine Updatable Help verfügbar.
SCHLÜSSELWÖRTER
About_Updateable_Help
HINWEISE
Die Cmdlets Update-Help und Save-Help werden unter Windows Preinstallation Environment (Windows PE) nicht unterstützt.
SIEHE AUCH
Get-Help
Save-Help
Update-Help
Statustabelle der Updatable Help