Share via

about_Updatable_Help

  • Artikel

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 aktualisierbare Hilfesystem, das in PowerShell 3.0 eingeführt wurde, soll sicherstellen, dass Sie immer über die neuesten Hilfethemen auf Ihrem lokalen Computer verfügen, sodass Sie diese über die Befehlszeile lesen können. Es erleichtert das Herunterladen und Installieren von Hilfedateien und deren Aktualisierung, wenn neuere Hilfedateien verfügbar werden.

Um aktualisierte Hilfe für mehrere Computer in einem Unternehmen und für Computer bereitzustellen, 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. Dadurch kann Save-Help für Module verwendet werden, 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 Wechseldatenträger (z. B. einem USB-Laufwerk) speichern, indem Sie auf einem Computer ohne Internetzugriff ausführenExport-Clixml, das PSModuleInfo-Objekt auf einem Computer importieren, der über Internetzugriff verfügt, und dann auf dem PSModuleInfo-Objekt ausgeführt werdenSave-Help. Die gespeicherte Hilfe kann mithilfe von Wechselmedien auf den remote getrennten Computer kopiert und dann installiert werden, indem Sie ausführen Update-Help. Mit diesen Verbesserungen der Save-Help Funktionalität können Sie Hilfe auf Computern installieren, die keinen Netzwerkzugriff haben. Ein Beispiel für die Verwendung der neuen Save-Help Funktionalität finden Sie unter Aktualisieren der 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 auf dem Computer keine Hilfedateien 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 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 einem Dateisystemverzeichnis oder einer Dateifreigabe. Um die Hilfedateien auf Computern zu installieren, verwenden Sie Update-Help.

  • Get-Help: Zeigt Hilfethemen an der Befehlszeile an. Ruft Hilfe aus den Hilfedateien auf dem Computer ab. Zeigt automatisch generierte Hilfe für Cmdlets und Funktionen ohne Hilfedateien an. Öffnet Onlinehilfethemen für Cmdlets, Funktionen, Skripts und Workflows in Ihrem Standard-Internetbrowser.

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 zur Verwendung der aktualisierbaren Hilfe-Cmdlets und zum Zugreifen auf die Onlinehilfethemen.

Der folgende Befehl erhält beispielsweise grundlegende Hilfe für das Get-Culture Cmdlet. 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 umfasst Hilfe für alle Cmdlets, Funktionen, Workflows, Anbieter, Skripts und Konzepte in einem Modul. Sie können die 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 nicht die 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

Geben Sie beispielsweise Folgendes ein, um das Modul zu finden, das das Set-ExecutionPolicy Cmdlet enthält:

(Get-Command Set-ExecutionPolicy).ModuleName

Geben Sie Folgendes ein, um die Hilfe für ein bestimmtes Modul zu aktualisieren:

Update-Help -Module <ModuleName>

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

Update-Help -Module Microsoft.PowerShell.Security

Berechtigungen für aktualisierbare Hilfe

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

Wenn Sie nicht 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 online Hilfe anzeigen.

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

Die Update-Help Cmdlets und Save-Help verfügen über einen UseDefaultCredentials-Parameter , der die expliziten Anmeldeinformationen des aktuellen Benutzers bereitstellt. Dieser Parameter ist für den Zugriff auf sichere Internetstandorte konzipiert.

Die Update-Help Cmdlets und Save-Help verfügen außerdem über einen Credential-Parameter , 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 die Parameter DestinationPath oder LiteralPath von Save-Helpverwenden.

Installieren und Aktualisieren von Hilfedateien

Verwenden Sie das Update-Help Cmdlet, um Hilfedateien zum ersten Mal herunterzuladen und zu installieren oder die Hilfedateien auf Ihrem Computer zu aktualisieren.

Das Update-Help Cmdlet übernimmt alle harten Aufgaben 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 es sich bei den Dateien um gültige Hilfedateien handelt.
  • Installiert die Hilfedateien im sprachspezifischen Unterverzeichnis des Modulverzeichnisses.

Verwenden Sie das Get-Help Cmdlet, um auf die neuen Hilfethemen zuzugreifen. Sie müssen PowerShell nicht neu starten.

Geben Sie Folgendes ein, um hilfe für alle Module auf dem Computer zu installieren oder zu aktualisieren, der die aktualisierbare Hilfe unterstützt:

Update-Help

Um die Hilfe für bestimmte Module zu aktualisieren, fügen Sie den Parameter Module von hinzu Update-Help. Im Modulnamen sind Feldhalterzeichen zulässig.

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

Update-Help -Module ServerManager

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

Wenn der Wert des Modulparameters (alle) ist * , Update-Help versucht, die 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 stößt, die die aktualisierbare Hilfe nicht unterstützen.

Aktualisieren der Hilfe aus einer Dateifreigabe

Verwenden Sie das Save-Help Cmdlet, um Computer zu unterstützen, die nicht mit dem Internet verbunden sind, oder um die Aktualisierung von Hilfe in einem Unternehmen zu steuern oder zu optimieren. 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.

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

Geben Sie beispielsweise Folgendes ein, um hilfe für alle installierten Module im \\Server\Share Verzeichnis zu speichern:

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 zum Speichern von Save-Help Hilfe für Module, die nicht auf dem lokalen Computer installiert sind. In diesem Beispiel führt Save-Help der Administrator aus, 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: Führen Sie ausInvoke-Command, um das PSModuleInfo-Objekt für das Remotemodul abzurufen, in einer Variablen zu speichern, und führen Sie dann für das 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, es in einer Variablen $mzu speichern, und führen Sie dann für das Objekt aus Save-Help , 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 den Computer ausgerichtet ist, auf dem das DHCP-Servermodul ausgeführt wird, um das PSModuleInfo-Objekt für das Modul abzurufen, es in einer Variablen $mzu speichern und dann für das Objekt auszuführen Save-Help , 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 ohne Netzwerkzugriff.

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

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

Als Nächstes transportieren Sie die Wechselmedien auf einen Computer mit Internetzugriff, und importieren Sie dann das PSModuleInfo-Objekt mit Import-Clixml. Führen Sie aus Save-Help , um die Hilfe für das importierte PSModuleInfo-Objekt des DhcpServer-Moduls zu speichern.

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

Transportieren Sie schließlich die Wechselmedien zurück auf den Computer, der keinen Netzwerkzugriff hat, und installieren Sie dann die Hilfe, indem Sie 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 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.

Aktualisieren von Hilfedateien in verschiedenen Sprachen

Standardmäßig laden die Update-Help Cmdlets und Save-Help 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, verwenden Save-Help Sie die Windows-Sprachfallbackregeln, Update-Help um die am besten unterstützte Sprache zu finden.

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

Geben Sie beispielsweise Folgendes ein, um die neuesten Hilfedateien für alle Module in der Sitzung auf Japanisch (ja-Jp) und Französisch (fr-FR) zu speichern:

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

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

Hinweis

Aktuell werden die Inhalte der aktualisierbaren Hilfe nur auf Englisch (en-US) veröffentlicht.

Verwenden der Onlinehilfe

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

Verwenden Sie den Online-Parameter des Cmdlets, um das Onlinehilfethema für beliebige Cmdlets Get-Help oder Funktionen 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 Online-Parameter und den vollständigen Pfad zum Skript.

Der Online-Parameter funktioniert nicht mit About-Themen. Informationen zu Den Themen für PowerShell, einschließlich Hilfethemen zur PowerShell-Sprache, finden Sie unter PowerShell About Topics.

Minimieren oder Verhindern von Internetdownloads

Verwenden Sie das Save-Help Cmdlet, um Internetdownloads zu minimieren und Benutzern, die nicht mit dem Internet verbunden sind, aktualisierbare Hilfe bereitzustellen. Laden Sie Hilfe aus dem Internet herunter, und speichern Sie sie in einer Netzwerkfreigabe. Erstellen Sie dann eine Gruppenrichtlinie Einstellung 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 mit Internetzugriff aktualisierbare Hilfe aus dem Internet herunterladen, verwenden Sie die Einstellung Festlegen des Standardquellpfads für Update-Help Gruppenrichtlinie.

Diese Gruppenrichtlinie Einstellung fügt jedem Befehl auf jedem Update-Help betroffenen Computer implizit den SourcePath-Parameter mit dem angegebenen Dateisystemspeicherort 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

Die Einstellung Festlegen des Standardquellpfads für Update-Help-Gruppenrichtlinien wird unter Computerkonfiguration und Benutzerkonfiguration angezeigt. Allerdings ist nur die Richtlinieneinstellung unter Computerkonfiguration wirksam. Die Richtlinieneinstellung unter Benutzerkonfiguration wird ignoriert.

Weitere Informationen finden Sie unter about_Group_Policy_Settings.

Aktualisieren der Hilfe für nicht standardmäßige Module

Um Hilfe für ein Modul zu aktualisieren oder zu speichern, das nicht vom ListAvailable-Parameter des Get-Module Cmdlets zurückgegeben wird, importieren Sie das Modul in die aktuelle Sitzung, bevor Sie einen Update-Help Befehl oder Save-Help ausführen. Importieren Sie das Modul auf einem Remotecomputer, bevor Sie den Save-Help Befehl ausführen, 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 Cmdlets oder Save-Help ohne Parameter aus, oder verwenden Sie den Parameter Module , um den Modulnamen anzugeben.

Die Module-Parameter der Update-Help Cmdlets und Save-Help akzeptieren nur einen Modulnamen. Sie akzeptieren nicht den Pfad zu einer Moduldatei.

Verwenden Sie diese Technik, 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).

Unterstützung aktualisierbarer 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ützung der aktualisierbaren Hilfe und Unterstützende Onlinehilfe.

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

Hinweise

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

Weitere Informationen