about_Updatable_Help

Artikel
10/20/2023

Kurze Beschreibung

Beschreibt das aktualisierbare Hilfesystem in PowerShell.

Lange Beschreibung

PowerShell bietet verschiedene Möglichkeiten, auf die aktuellsten Hilfethemen für PowerShell-Cmdlets und -Konzepte zuzugreifen.

Das in PowerShell 3.0 eingeführte aktualisierbare Hilfesystem soll sicherstellen, dass Sie immer über die neuesten Hilfethemen auf Ihrem lokalen Computer verfügen, damit Sie sie über die Befehlszeile lesen können. Es erleichtert das Herunterladen und Installieren von Hilfedateien und die Aktualisierung, sobald neuere Hilfedateien verfügbar sind.

Wenn Sie aktualisierte Hilfe für mehrere Computer in einem Unternehmen und für Computer bereitstellen möchten, die keinen Zugriff auf das Internet haben, können Sie mithilfe der aktualisierbaren Hilfe Hilfedateien in ein Dateisystemverzeichnis oder eine Dateifreigabe herunterladen und dann die Hilfedateien aus der Dateifreigabe installieren.

In PowerShell 4.0 wird die HelpInfoUri-Eigenschaft über Windows PowerShell-Remoting beibehalten, sodass Module funktionieren können Save-Help , die auf einem Remotecomputer installiert sind, aber nicht unbedingt auf dem lokalen Computer installiert sind. Sie können ein PSModuleInfo-Objekt auf einem Datenträger oder Wechselmedien (z. B. einem USB-Laufwerk) speichern, indem Export-Clixml Sie auf einem Computer, auf dem kein Internetzugang verfügbar ist, das PSModuleInfo-Objekt auf einem Computer importieren, auf dem ein Internetzugang besteht, und dann auf dem PSModuleInfo-Objekt ausgeführt wirdSave-Help. Die gespeicherte Hilfe kann mithilfe von Wechselmedien in die Remote-, getrennten Computer kopiert und dann durch Ausführen Update-Helpinstalliert werden. Mit diesen Verbesserungen der Save-Help Funktionalität können Sie Hilfe auf Computern installieren, die ohne Netzwerkzugriff vorhanden sind. Ein Beispiel für die Verwendung der neuen Save-Help Funktionalität finden Sie unter "So aktualisieren Sie Hilfe aus einer Dateifreigabe in diesem Thema".

Die aktualisierbare Hilfe unterstützt auch den Onlinezugriff auf die neuesten Hilfethemen und grundlegende Hilfe für Cmdlets, auch wenn keine Hilfedateien auf dem Computer vorhanden sind.

PowerShell enthält keine Hilfedateien. Sie können das Feature "Aktualisierbare Hilfe" verwenden, um die Hilfedateien für alle Befehle zu installieren, die standardmäßig in PowerShell und für alle Windows-Module enthalten sind.

Aktualisierbare Hilfe-Cmdlets

Update-Help: Lädt die neuesten Hilfedateien aus dem Internet oder eine Dateifreigabe herunter und installiert sie auf dem lokalen Computer.
Save-Help: Lädt die neuesten Hilfedateien aus dem Internet herunter und speichert sie in einem Dateisystemverzeichnis oder in einer Dateifreigabe. Verwenden Sie die Hilfedateien, um die Hilfedateien auf Computern zu Update-Helpinstallieren.
Get-Help: Zeigt Hilfethemen in der Befehlszeile an. Ruft Hilfe aus den Hilfedateien auf dem Computer ab. Zeigt automatisch generierte Hilfe für Cmdlets und Funktionen an, die keine Hilfedateien enthalten. Öffnet Onlinehilfethemen für Cmdlets, Funktionen, Skripts und Workflows in Ihrem Standard-Internetbrowser.

Aktualisieren der Hilfe in PowerShell ISE

Sie können auch Hilfe mithilfe des Hilfeelements "PowerShell aktualisieren" im Hilfemenü in der integrierten Skriptumgebung (ISE) von PowerShell aktualisieren.

Das PowerShell-Hilfeelement aktualisieren führt einen Update-Help Befehl ohne Parameter aus.

Automatisch generierte Hilfe: Hilfe ohne Hilfedateien

Wenn Sie nicht über die Hilfedatei für ein Cmdlet, eine Funktion oder einen Workflow auf dem Computer verfügen, zeigt das Get-Help Cmdlet automatisch generierte Hilfe an und fordert Sie auf, die Hilfedateien herunterzuladen oder online zu lesen.

Die automatisch generierte Hilfe umfasst Syntax und Aliase sowie Hinweise, mit denen erläutert wird, wie Sie die aktualisierbaren Hilfe-Cmdlets verwenden und auf die Onlinehilfethemen zugreifen können.

Der folgende Befehl ruft beispielsweise grundlegende Hilfe für das Get-Culture Cmdlet ab. Die Ausgabe zeigt die Get-Help Anzeige an, wenn keine Hilfedateien auf dem Computer vorhanden sind.

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

Hilfedateien für Module

Die kleinste Einheit der aktualisierbaren Hilfe ist Hilfe für ein Modul. Die Modulhilfe enthält Hilfe zu allen Cmdlets, Funktionen, Workflows, Anbietern, Skripts und Konzepten in einem Modul. Sie können Hilfe für alle Module aktualisieren, die auf dem Computer installiert sind, auch wenn sie nicht in die aktuelle Sitzung importiert werden.

Sie können die Hilfe für das gesamte Modul aktualisieren, aber sie können keine Hilfe für einzelne Cmdlets aktualisieren.

Verwenden Sie das folgende Befehlsformat, um das Modul zu finden, das ein bestimmtes Cmdlet enthält:

(Get-Command <cmdlet-name>).ModuleName

Um z. B. das Modul zu finden, das das Set-ExecutionPolicy Cmdlet enthält, geben Sie Folgendes ein:

(Get-Command Set-ExecutionPolicy).ModuleName

Um Hilfe für ein bestimmtes Modul zu aktualisieren, geben Sie Folgendes ein:

Update-Help -Module <ModuleName>

Um beispielsweise Hilfe für das Modul zu aktualisieren, das das Cmdlet Set-ExecutionPolicy enthält, geben Sie Folgendes ein:

Update-Help -Module Microsoft.PowerShell.Security

Berechtigungen für aktualisierbare Hilfe

Um Hilfe für die Module im Verzeichnis $pshome/Moduleszu aktualisieren, müssen Sie Mitglied der Gruppe "Administratoren" auf dem Computer sein.

Wenn Sie kein Mitglied der Gruppe "Administratoren" sind, können Sie die Hilfe für diese Module nicht aktualisieren. Wenn Sie jedoch über Internetzugriff verfügen, können Sie Hilfe online anzeigen.

Das Aktualisieren der Hilfe für Module im Verzeichnis $HOME/Documents/PowerShell/Modules oder modul in anderen Unterverzeichnissen des $HOME Verzeichnisses erfordert keine speziellen Berechtigungen.

Die Update-Help Und Save-Help Cmdlets verfügen über einen UseDefaultCredentials-Parameter , der die expliziten Anmeldeinformationen des aktuellen Benutzers bereitstellt. Dieser Parameter wurde für den Zugriff auf sichere Internetspeicherorte entwickelt.

Außerdem verfügen die Update-Help Cmdlets über Save-Help einen Anmeldeinformationsparameter , mit dem Sie den Befehl auf einem Remotecomputer ausführen und auf eine Dateifreigabe auf einem dritten Computer zugreifen können. Der Credential-Parameter ist nur gültig, wenn Sie die Parameter "SourcePath" oder "LiteralPath" von Update-Help und "DestinationPath" oder "LiteralPath" verwendenSave-Help.

Installieren und Aktualisieren von Hilfedateien

Wenn Sie Hilfedateien zum ersten Mal herunterladen und installieren oder die Hilfedateien auf Ihrem Computer aktualisieren möchten, verwenden Sie das Update-Help Cmdlet.

Das Update-Help Cmdlet erledigt alle harte Arbeit für Sie, einschließlich der folgenden Aufgaben.

Bestimmt, welche Module die aktualisierbare Hilfe unterstützen.
Sucht den Internetspeicherort, an dem jedes Modul seine aktualisierbaren Hilfedateien speichert.
Vergleicht die Hilfedateien für jedes Modul auf Ihrem Computer mit den neuesten Hilfedateien, die für jedes Modul verfügbar sind.
Lädt die neuen Dateien aus dem Internet herunter.
Entpackt das Hilfedateipaket.
Überprüft, ob die Dateien gültige Hilfedateien sind.
Installiert die Hilfedateien im sprachspezifischen Unterverzeichnis des Modulverzeichnisses.

Verwenden Sie das Get-Help Cmdlet, um auf die neuen Hilfethemen zuzugreifen. PowerShell muss nicht neu gestartet werden.

Um Hilfe für alle Module auf dem Computer zu installieren oder zu aktualisieren, die die aktualisierbare Hilfe unterstützt, geben Sie Folgendes ein:

Update-Help

Um Hilfe für bestimmte Module zu aktualisieren, fügen Sie den Modulparameter von Update-Help. Wild Karte Zeichen sind im Modulnamen zulässig.

Geben Sie beispielsweise Folgendes ein, um die Hilfe für das ServerManager-Modul zu aktualisieren:

Update-Help -Module ServerManager

Ohne Parameter helfen Update-Help Updates für alle Module in der Sitzung und für alle installierten Module, die die aktualisierbare Hilfe unterstützen. Um eingeschlossen zu werden, müssen Module in Verzeichnissen installiert werden, die im Wert der PSModulePath-Umgebungsvariable aufgeführt sind. Dies sind auch Module, die von einem Get-Module -ListAvailable Befehl zurückgegeben werden.

Wenn der Wert des Modulparameters (alle) lautet * , versucht, Update-Help Hilfe für alle installierten Module zu aktualisieren, einschließlich Modulen, die keine aktualisierbare Hilfe unterstützen. Dieser Befehl generiert in der Regel viele Fehler, da das Cmdlet auf Module trifft, die die aktualisierbare Hilfe nicht unterstützen.

Um Computer zu unterstützen, die nicht mit dem Internet verbunden sind, oder um die Aktualisierung in einem Unternehmen zu steuern oder zu optimieren, verwenden Sie das Save-Help Cmdlet. Das Save-Help Cmdlet lädt Hilfedateien aus dem Internet herunter und speichert sie in einem von Ihnen angegebenen Dateisystemverzeichnis.

Save-Help Vergleicht die Hilfedateien im angegebenen Verzeichnis mit den neuesten Hilfedateien, die für jedes Modul verfügbar sind. Wenn das Verzeichnis keine Hilfedateien enthält oder neuere Hilfedateien für das Modul verfügbar sind, lädt das Save-Help Cmdlet die neuen Dateien aus dem Internet herunter. Die Hilfedateien werden jedoch nicht entpackt oder installiert.

Um die Hilfedateien auf einem Computer aus Hilfedateien zu installieren oder zu aktualisieren, die in einem Dateisystemverzeichnis gespeichert wurden, verwenden Sie den SourcePath-Parameter des Update-Help Cmdlets. Das Update-Help Cmdlet identifiziert die neuesten Hilfedateien, entpackt und überprüft sie und installiert sie in den sprachspezifischen Unterverzeichnissen der Modulverzeichnisse.

Wenn Sie beispielsweise Hilfe für alle installierten Module im \\Server\Share Verzeichnis speichern möchten, geben Sie Folgendes ein:

Save-Help -DestinationPath \\Server\Share

Geben Sie dann Folgendes ein, um die Hilfe aus dem \\Server\Share Verzeichnis zu aktualisieren:

Update-Help -SourcePath \\Server\Share

Die folgenden Beispiele zeigen die Verwendung von Hilfe zum Speichern von Save-Help Modulen, die nicht auf dem lokalen Computer installiert sind. In diesem Beispiel wird der Administrator ausgeführt Save-Help , um die Hilfe für das DhcpServer-Modul von einem mit dem Internet verbundenen Clientcomputer zu speichern, ohne das DhcpServer-Modul oder die DHCP-Serverrolle auf dem lokalen Computer zu installieren.

Option 1: AusführenInvoke-Command, um das PSModuleInfo-Objekt für das Remotemodul abzurufen, speichern Sie es in einer Variablen, und führen Sie dann auf dem PSModuleInfo-Objekt ausSave-Help, $mindem Sie die Variable $m als Modulnamen angeben.

$invokeCommandSplat = @{
    ComputerName = 'RemoteServer'
    ScriptBlock = { Get-Module -Name DhcpServer -ListAvailable }
}
$m = Invoke-Command @invokeCommandSplat
Save-Help -Module $m -DestinationPath C:\SavedHelp

Option 2: Öffnen Sie eine PSSession für den Computer, auf dem das DHCP-Servermodul ausgeführt wird, um das PSModuleInfo-Objekt für das Modul abzurufen, speichern Sie sie in einer Variablen $m, und führen Sie Save-Help es dann für das Objekt aus, das in der $m Variablen gespeichert ist.

$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, die auf dem Computer mit dem DHCP-Servermodul ausgeführt wird, um das PSModuleInfo-Objekt für das Modul abzurufen, speichern Sie sie in einer Variablen $m, und führen Sie Save-Help es dann für das Objekt aus, das in der $m Variablen gespeichert ist.

$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 Hilfe für das DHCP-Servermodul auf einem Computer, auf dem kein Netzwerkzugriff vorhanden ist.

Führen Sie zunächst die Ausführung Export-Clixml aus, um das PSModuleInfo-Objekt in einen freigegebenen Ordner oder in Wechselmedien zu exportieren.

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\DhcpModule.xml -InputObject $m

Als Nächstes transportieren Sie das Wechselmedium auf einen Computer mit Internetzugang, und importieren Sie dann das PSModuleInfo -Objekt mit Import-Clixml. Führen Sie die Ausführung Save-Help aus, um die Hilfe für das importierte DHCPServer-Modul PSModuleInfo-Objekt zu speichern.

$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\SavedHelp

Zum Schluss können Sie das Wechselmedium zurück zu dem Computer transportieren, auf den kein Netzwerkzugriff verfügt, und installieren Sie dann die Hilfe, indem Sie die Hilfe ausführen Update-Help.

Update-Help -Module DhcpServer -SourcePath E:\UsbDrive\SavedHelp

Ohne Parameter laden Save-Help Sie Hilfe für alle Module in der Sitzung und für alle installierten Module herunter, die die aktualisierbare Hilfe unterstützen. Um eingeschlossen zu werden, müssen Module in Verzeichnissen installiert werden, die im Wert der $env:PSModulePath Umgebungsvariablen aufgeführt sind, entweder auf dem lokalen Computer oder auf einem Remotecomputer, für den Sie Hilfe speichern möchten. Dies sind auch Module, die durch Ausführen eines Get-Help -ListAvailable Befehls zurückgegeben werden.

So aktualisieren Sie Hilfedateien in verschiedenen Sprachen

Standardmäßig laden die und Save-Help die Update-Help Cmdlets Hilfe in der Benutzeroberflächenkultur und -sprache herunter, die für Windows auf dem lokalen Computer festgelegt ist. Wenn Hilfedateien für die angegebenen Module in der lokalen Benutzeroberflächenkultur nicht verfügbar sind, und Save-Help verwenden Sie die Windows-Sprach-Fallbackregeln, Update-Help um die am besten unterstützte Sprache zu finden.

Sie können jedoch die UICulture-Parameter der und Save-Help Cmdlets Update-Help verwenden, um Hilfedateien in allen UI-Kulturen herunterzuladen und zu installieren, in denen sie verfügbar sind.

Wenn Sie beispielsweise die neuesten Hilfedateien für alle Module in der Sitzung in Japanisch (ja-Jp) und Französisch (fr-FR) speichern möchten, geben Sie Folgendes ein:

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

Wenn Hilfedateien für die Module in den von Ihnen angegebenen Sprachen nicht verfügbar sind, geben die Update-Help und Save-Help cmdlets eine Fehlermeldung zurück, in der die Sprachen aufgelistet sind, in denen die Hilfe für jedes Modul verfügbar ist, damit Sie die Alternative auswählen können, die Ihren Anforderungen am besten entspricht.

Hinweis

Derzeit werden aktualisierbare Hilfeinhalte nur in Englisch (en-US) veröffentlicht.

Verwenden der Onlinehilfe

Wenn Sie die Hilfedateien auf Ihrem lokalen Computer nicht aktualisieren können, können Sie weiterhin die neuesten Hilfedateien online abrufen.

Verwenden Sie den Onlineparameter des Get-Help Cmdlets, um das Online-Hilfethema für ein beliebiges Cmdlet oder eine beliebige Funktion zu öffnen.

Mit dem folgenden Befehl wird beispielsweise das Onlinehilfethema für das Get-Job Cmdlet in Ihrem Standard-Internetbrowser geöffnet:

Get-Help Get-Job -Online

Um Onlinehilfe für ein Skript zu erhalten, verwenden Sie den Parameter "Online" und den vollständigen Pfad zum Skript.

Der Parameter "Online" funktioniert nicht mit "Info".The Online parameter doesn't work with About topics. Informationen zu Den Themen für PowerShell, einschließlich Hilfethemen zur PowerShell-Sprache, finden Sie unter PowerShell About Topics.

Minimieren oder Verhindern von Internetdownloads

Um Internetdownloads zu minimieren und benutzern, die nicht mit dem Internet verbunden sind, aktualisierbare Hilfe bereitzustellen, verwenden Sie das Save-Help Cmdlet. Laden Sie Hilfe aus dem Internet herunter, und speichern Sie sie in einer Netzwerkfreigabe. Erstellen Sie dann eine Gruppenrichtlinieneinstellung oder einen geplanten Auftrag, der einen Update-Help Befehl auf allen Computern ausführt. Legen Sie den Wert des SourcePath-Parameters des Update-Help Cmdlets auf die Netzwerkfreigabe fest.

Um zu verhindern, dass Benutzer, die internetzugriff haben, die aktualisierbare Hilfe aus dem Internet herunterladen, verwenden Sie den Standardquellpfad für die Gruppenrichtlinieneinstellung "Update-Hilfe ".

Diese Gruppenrichtlinieneinstellung fügt implizit den SourcePath-Parameter mit dem von Ihnen angegebenen Dateisystemspeicherort jedem Update-Help Befehl auf jedem betroffenen Computer hinzu. Benutzer können den SourcePath-Parameter explizit verwenden, um einen anderen Dateisystemspeicherort anzugeben, aber sie können den SourcePath-Parameter nicht ausschließen und Hilfe aus dem Internet herunterladen.

Hinweis

The Set the default source path for Update-Help group policy setting appears under Computer Configuration and User Configuration. Allerdings ist nur die Richtlinieneinstellung unter "Computerkonfiguration " wirksam. Die Richtlinieneinstellung unter "Benutzerkonfiguration " wird ignoriert.

Weitere Informationen finden Sie unter about_Group_Policy_Settings.

So aktualisieren Sie Hilfe für nicht standardmäßige Module

Wenn Sie Hilfe für ein Modul aktualisieren oder speichern möchten, das nicht vom Parameter ListAvailable des Get-Module Cmdlets zurückgegeben wird, importieren Sie das Modul in die aktuelle Sitzung, bevor Sie einen Update-Help Befehl Save-Help ausführen. Importieren Sie auf einem Remotecomputer vor dem Ausführen des Save-Help Befehls das Modul in den aktuellen Sitzungs- oder Invoke-Command Skriptblock, der mit dem Remotecomputer verbunden ist.

Wenn sich das Modul in der aktuellen Sitzung befindet, führen Sie die Update-Help Oder Save-Help Cmdlets ohne Parameter aus, oder verwenden Sie den Parameter Module , um den Modulnamen anzugeben.

Die Modulparameter und Update-HelpSave-Help Cmdlets akzeptieren nur einen Modulnamen. Sie akzeptieren den Pfad zu einer Moduldatei nicht.

Verwenden Sie dieses Verfahren, um Hilfe für jedes Modul zu aktualisieren oder zu speichern, das nicht vom ListAvailable-Parameter des Get-Module Cmdlets zurückgegeben wird, z. B. ein Modul, das an einem Speicherort installiert ist, der nicht in der $env:PSModulePath Umgebungsvariablen aufgeführt ist, oder ein Modul, das nicht wohlgeformt ist (das Modulverzeichnis enthält nicht mindestens eine Datei, deren Basisname mit dem Verzeichnisnamen identisch ist).

So unterstützen Sie aktualisierbare Hilfe

Wenn Sie ein Modul erstellen, können Sie Onlinehilfe und aktualisierbare Hilfe für Ihre Module unterstützen. Weitere Informationen finden Sie unter Unterstützen der aktualisierbaren Hilfe und der Unterstützenden Onlinehilfe.

Aktualisierbare Hilfe für PowerShell-Snap-Ins oder kommentarbasierte Hilfe nicht verfügbar.

Hinweise

Die Update-Help Und Save-Help Cmdlets werden unter Windows Preinstallation Environment (Windows PE) nicht unterstützt.