Freigeben über

Save-Help

  • Referenz
Modul:
Microsoft.PowerShell.Core

Lädt die neuesten Hilfedateien herunter und speichert sie in einem Dateisystemverzeichnis.

Syntax

Save-Help
    [-DestinationPath] <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]
Save-Help
    -LiteralPath <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]

Beschreibung

Das Cmdlet Save-Help lädt die neuesten Hilfedateien für PowerShell-Module herunter und speichert sie in einem von Ihnen angegebenen Verzeichnis. Mit diesem Feature können Sie die Hilfedateien auf Computern aktualisieren, die keinen Zugriff auf das Internet haben, und die Aktualisierung der Hilfedateien auf mehreren Computern erleichtert. Dieses Cmdlet wurde in Windows PowerShell 3.0 eingeführt.

Ab Windows PowerShell 4.0 können Sie Save-Help verwenden, um Hilfedateien für Module herunterzuladen, die auf Remotecomputern installiert sind. Es ist auch möglich, ein PSModuleInfo--Objekt mithilfe von Export-Clixml auf einem Computer zu speichern, auf dem kein Internetzugang verfügbar ist, das Objekt auf einem Computer importieren, auf dem internetzugriff verfügt, und führen Sie dann Save-Help auf dem PSModuleInfo-Objekt aus. Nachdem Sie die gespeicherte Hilfe gespeichert haben, können Sie sie auf den Remotecomputer kopieren und installieren, indem Sie Update-Helpausführen. Dieser Vorgang kann verwendet werden, um Hilfe auf Computern zu installieren, die keinen Netzwerkzugriff haben.

Ohne Parameter lädt ein Save-Help-Befehl die neueste Hilfe für alle Module in der Sitzung und für Module herunter, die auf dem Computer an einem Speicherort installiert sind, der in der PSModulePath Umgebungsvariablen aufgeführt ist. Mit dieser Aktion werden Module übersprungen, die die aktualisierbare Hilfe nicht ohne Warnung unterstützen.

Das Cmdlet Save-Help überprüft die Version aller Hilfedateien im Zielordner. Wenn neuere Hilfedateien verfügbar sind, lädt dieses Cmdlet die neuesten Hilfedateien aus dem Internet herunter und speichert sie dann im Ordner. Das cmdlet Save-Help funktioniert genau wie das Cmdlet Update-Help, mit der Ausnahme, dass der heruntergeladene Inhalt gespeichert wird, anstatt die Hilfedateien zu extrahieren und auf dem Computer zu installieren.

Die gespeicherte Hilfe für jedes Modul besteht aus einer Hilfeinformationsdatei (HelpInfo XML) und einem Cab- oder ZIP-Archiv (.cab oder .zip) für die Hilfedateien in jeder Sprache. Unter Windows lädt der Befehl die Cab-Dateien herunter. Unter Linux und macOS lädt der Befehl ZIP-Dateien herunter.

Um die Hilfedateien für Module im PowerShell-Installationsordner ($PSHOME\Modules) zu speichern, starten Sie PowerShell mithilfe der option Als Administrator ausführen. Sie müssen Mitglied der Gruppe "Administratoren" auf dem Computer sein, um die Hilfedateien für diese Module herunterzuladen.

Um gespeicherte Hilfedateien zu installieren, führen Sie Update-Help mit dem parameter SourcePath aus, um den Ordner anzugeben, der die gespeicherten Hilfedateien enthält. Update-Help extrahiert die Hilfedateien aus dem Archiv und installiert sie am entsprechenden Speicherort.

Beispiele

Beispiel 1: Speichern der Hilfe für das DhcpServer-Modul

In diesem Beispiel werden drei verschiedene Möglichkeiten gezeigt, Save-Help zum Speichern der Hilfe für das DhcpServer Modul von einem mit dem Internet verbundenen Clientcomputer zu verwenden, ohne das DhcpServer-modul oder die DHCP-Serverrolle auf dem lokalen Computer zu installieren.

# Option 1:
# 1. Run Invoke-Command to get the PSModuleInfo object for the DhcpServer module,
# 2. Save-Help on the PSModuleInfo object to save the help files to a folder on
#    the local computer.

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


# Option 2:
# 1. Open a PSSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object

$session = New-PSSession -ComputerName "RemoteServer"
$mod = Get-Module -PSSession $session -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath C:\SavedHelp


# Option 3:
# 1. Open a CimSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object
$cimsession = New-CimSession -ComputerName "RemoteServer"
$mod = Get-Module -CimSession $cimsession -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath "C:\SavedHelp"

Beispiel 2: Installieren der Hilfe für das DhcpServer-Modul

In diesem Beispiel wird gezeigt, wie Sie Hilfe für einen Computer installieren, der nicht mit dem Netzwerk verbunden ist. In diesem Beispiel ist der erste Computer nicht mit einem barrierefreien Netzwerk verbunden. Dateien müssen mithilfe von Wechselmedien in die Datei kopiert werden. Der zweite Computer ist mit dem Internet verbunden und kann die Hilfedateien herunterladen.

# On the first computer, get the PSModuleInfo object for the module and save it to
# removable media.

Get-Module -Name "DhcpServer" -ListAvailable |
    Export-CliXml -Path E:\UsbFlashDrive\DhcpModule.xml

# Move the removable media to a computer that has internet access, and then import the
# PSModuleInfo object. Run Save-Help on the imported PSModuleInfo object and save the help
# files to the removable media.

$moduleInfo = Import-CliXml E:\UsbFlashDrive\DhcpModule.xml
Save-Help -Module $moduleInfo -DestinationPath E:\UsbFlashDrive\SavedHelp

# Finally, move the removable media back to the first computer and install the help.

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

Beispiel 3: Speichern der Hilfe für alle Module

Mit diesem Befehl werden die neuesten Hilfedateien für alle Module auf dem lokalen Computer heruntergeladen. Sie speichert die Hilfedateien im ordner \\Server01\Fileshare01.

Save-Help -DestinationPath \\Server01\FileShare01

Beispiel 4: Speichern der Hilfe für ein Modul auf dem Computer

Dieser Befehl lädt die neuesten Hilfedateien für das ServerManager Modul herunter und speichert sie dann im Ordner \\Server01\Fileshare01.

$saveHelpSplat = @{
    Module = 'ServerManager'
    DestinationPath = '\\Server01\FileShare01'
    Credential = 'Domain01/Admin01'
}
Save-Help @saveHelpSplat

Wenn ein Modul auf dem Computer installiert ist, können Sie den Modulnamen als Wert des parameters Module eingeben, auch wenn das Modul nicht in die aktuelle Sitzung importiert wird.

Der Befehl verwendet den Parameter Credential, um die Anmeldeinformationen eines Benutzers mit der Berechtigung zum Schreiben in die Dateifreigabe anzugeben.

Beispiel 5: Speichern der Hilfe für ein Modul auf einem anderen Computer

Diese Befehle laden die neuesten Hilfedateien für das CustomSQL Modul herunter und speichern sie im Ordner \\Server01\Fileshare01.

Invoke-Command -ComputerName Server02 { Get-Module -Name CustomSQL -ListAvailable } |
    Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

Da das CustomSQL Modul nicht auf dem Computer installiert ist, enthält die Sequenz einen Invoke-Command Befehl, der das Modulobjekt für das CustomSQL-Modul vom Server02-Computer abruft und dann das Modulobjekt an das cmdlet Save-Help übergibt.

Wenn ein Modul nicht auf dem Computer installiert ist, benötigt Save-Help das Modulobjekt, das Informationen zum Speicherort der neuesten Hilfedateien enthält.

Beispiel 6: Speichern der Hilfe für ein Modul in mehreren Sprachen

Dieser Befehl speichert Hilfe für die wichtigsten PowerShell-Module in vier verschiedenen UI-Kulturen. Die Sprachpakete für diese Gebietsschemas müssen nicht auf dem Computer installiert werden.

$saveHelpSplat = @{
    Module = 'Microsoft.PowerShell*'
    UICulture = 'de-DE', 'en-US', 'fr-FR', 'ja-JP'
    DestinationPath = "D:\Help"
}
Save-Help @saveHelpSplat

Save-Help können Hilfedateien nur für Module in unterschiedlichen UI-Kulturen herunterladen, wenn der Modulbesitzer die übersetzten Dateien im Internet zur Verfügung stellt.

Beispiel 7: Speichern von Hilfe pro Tag mehr als eine Uhrzeit

Dieser Befehl speichert Hilfe für alle Module, die auf dem Computer installiert sind. Der Befehl gibt den parameter Force an, um die Regel außer Kraft zu setzen, die verhindert, dass das cmdlet Save-Help Hilfe mehr als einmal in jedem 24-Stunden-Zeitraum herunterdownloaden kann.

Save-Help -Force -DestinationPath \\Server3\AdminShare\Help

Der Parameter Force setzt auch die Einschränkung von 1 GB außer Kraft und umgeht die Versionsüberprüfung. Daher können Sie Dateien auch dann herunterladen, wenn die Version nicht höher als die Version im Zielordner ist.

Der Befehl verwendet das Cmdlet Save-Help, um die Hilfedateien im angegebenen Ordner herunterzuladen und zu speichern. Der parameter "Force" ist erforderlich, wenn Sie jeden Tag einen Save-Help Befehl ausführen müssen.

Parameter

-Credential

Gibt eine Benutzeranmeldeinformation an. Dieses Cmdlet führt den Befehl mithilfe von Anmeldeinformationen eines Benutzers aus, der über die Berechtigung für den Zugriff auf den durch den parameter DestinationPath angegebenen Dateisystemspeicherort verfügt. Dieser Parameter ist nur gültig, wenn der parameter DestinationPath oder LiteralPath- im Befehl verwendet wird.

Mit diesem Parameter können Sie Save-Help Befehle ausführen, die den parameter DestinationPath auf Remotecomputern verwenden. Indem Sie explizite Anmeldeinformationen angeben, können Sie den Befehl auf einem Remotecomputer ausführen und auf eine Dateifreigabe auf einem dritten Computer zugreifen, ohne dass ein Zugriff verweigert wird oder die CredSSP-Authentifizierung zum Delegieren von Anmeldeinformationen verwendet wird.

Geben Sie einen Benutzernamen ein, z. B. User01 oder Domain01\User01, oder geben Sie ein PSCredential-Objekt ein, das vom cmdlet Get-Credential generiert wird. Wenn Sie einen Benutzernamen eingeben, werden Sie aufgefordert, das Kennwort einzugeben.

Anmeldeinformationen werden in einem PSCredential-Objekt gespeichert, und das Kennwort wird als SecureString-gespeichert.

Anmerkung

Weitere Informationen zu SecureString Datenschutz finden Sie unter Wie sicher ist SecureString?.

Typ:PSCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DestinationPath

Gibt den Pfad des Ordners an, in dem die Hilfedateien gespeichert werden. Geben Sie keine Dateinamen- oder Dateinamenerweiterung an.

Typ:String[]
Aliase:Path
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Gibt an, dass dieses Cmdlet nicht der Einschränkung von einmal pro Tag folgt, die Versionsüberprüfung überspringt und Dateien herunterlädt, die den Grenzwert von 1 GB überschreiten.

Ohne diesen Parameter ist nur ein Save-Help Befehl für jedes Modul in jedem 24-Stunden-Zeitraum zulässig, Downloads sind auf 1 GB nicht komprimierter Inhalte pro Modul beschränkt, und Hilfedateien für ein Modul werden nur installiert, wenn sie neuer als die Dateien auf dem Computer sind.

Der Grenzwert für einmal pro Tag schützt die Server, auf denen die Hilfedateien gehostet werden, und ermöglicht es Ihnen, Ihrem PowerShell-Profil einen Save-Help-Befehl hinzuzufügen.

Um Hilfe für ein Modul in mehreren Benutzeroberflächenkulturen ohne den Parameter "force" zu speichern, schließen Sie alle Benutzeroberflächenkulturen in denselben Befehl ein, z. B.: Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-FullyQualifiedModule

Der Wert kann ein Modulname, eine vollständige Modulspezifikation oder ein Pfad zu einer Moduldatei sein.

Wenn der Wert ein Pfad ist, kann der Pfad vollqualifizierte oder relativ sein. Ein relativer Pfad wird relativ zum Skript aufgelöst, das die using-Anweisung enthält.

Wenn es sich bei dem Wert um einen Namen oder eine Modulspezifikation handelt, durchsucht PowerShell die PSModulePath- nach dem angegebenen Modul.

Eine Modulspezifikation ist eine Hashtabelle mit den folgenden Schlüsseln.

  • ModuleName - Erforderlicher Gibt den Modulnamen an.
  • GUID - Optionaler Gibt die GUID des Moduls an.
  • Außerdem Erforderlicher, um mindestens einen der drei folgenden Tasten anzugeben.
    • ModuleVersion – Gibt eine akzeptable Mindestversion des Moduls an.
    • MaximumVersion – Gibt die maximal zulässige Version des Moduls an.
    • RequiredVersion – Gibt eine genaue, erforderliche Version des Moduls an. Dies kann nicht mit den anderen Versionsschlüsseln verwendet werden.

Sie können den parameter FullyQualifiedModule nicht im selben Befehl wie ein Module-Parameter angeben. die beiden Parameter schließen sich gegenseitig aus.

Typ:ModuleSpecification[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-LiteralPath

Gibt einen Pfad des Zielordners an. Im Gegensatz zum Wert des DestinationPath-Parameters wird der Wert des LiteralPath--Parameters genau so verwendet, wie er eingegeben wird. Es werden keine Zeichen als Wildcardzeichen interpretiert. Wenn der Pfad Escapezeichen enthält, schließen Sie ihn in einfache Anführungszeichen ein. Einfache Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.

Typ:String[]
Aliase:PSPath, LP
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Module

Gibt Module an, für die dieses Cmdlet Hilfe herunterlädt. Geben Sie einen oder mehrere Modulnamen oder Namens patter in einer durch Trennzeichen getrennten Liste oder in einer Datei ein, die in jeder Zeile einen Modulnamen enthält. Wildcardzeichen sind zulässig. Sie können Modulobjekte auch aus dem Cmdlet Get-Module an Save-Helpweiterleiten.

Standardmäßig laden Save-Help Hilfe für alle Module herunter, die die aktualisierbare Hilfe unterstützen und auf dem lokalen Computer an einem Speicherort installiert sind, der in der PSModulePath Umgebungsvariablen aufgeführt ist.

Um Hilfe für Module zu speichern, die nicht auf dem Computer installiert sind, führen Sie einen Get-Module Befehl auf einem Remotecomputer aus. Übergeben Sie dann die resultierenden Modulobjekte an das cmdlet Save-Help, oder übermitteln Sie die Modulobjekte als Wert der Parameter Module oder InputObject.

Wenn das angegebene Modul auf dem Computer installiert ist, können Sie den Modulnamen oder ein Modulobjekt eingeben. Wenn das Modul nicht auf dem Computer installiert ist, müssen Sie ein Modulobjekt eingeben, z. B. eines, das vom Cmdlet Get-Module zurückgegeben wird.

Der parameter Module des Cmdlets Save-Help akzeptiert nicht den vollständigen Pfad einer Moduldatei oder Modulmanifestdatei. Um Hilfe für ein Modul zu speichern, das sich nicht in einem PSModulePath- Speicherort befindet, importieren Sie das Modul in die aktuelle Sitzung, bevor Sie den befehl Save-Help ausführen.

Der Wert "*" (alle) versucht, Hilfe für alle Module zu aktualisieren, die auf dem Computer installiert sind. Dazu gehören Module, die die aktualisierbare Hilfe nicht unterstützen. Dieser Wert kann Fehler generieren, wenn der Befehl auf Module trifft, die keine aktualisierbare Hilfe unterstützen.

Typ:PSModuleInfo[]
Aliase:Name
Position:1
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-Scope

Dieser Parameter führt in diesem Cmdlet nichts aus.

Typ:UpdateHelpScope
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-UICulture

Gibt Werte für die Benutzeroberflächenkultur an, für die dieses Cmdlet aktualisierte Hilfedateien abruft. Geben Sie einen oder mehrere Sprachcodes ein, z. B. es-ES, eine Variable, die Kulturobjekte enthält, oder einen Befehl, der Kulturobjekte abruft, z. B. ein Get-Culture- oder Get-UICulture-Befehl. Platzhalterzeichen sind nicht erlaubt.

Standardmäßig ruft Save-Help Hilfedateien in der Ui-Kultur ab, die für das Betriebssystem oder die Fallbackkultur festgelegt ist. Wenn Sie den parameter UICulture angeben, sucht Save-Help nur nach Hilfe für die angegebene Sprache.

Ab PowerShell 7.4 können Sie einen teilweisen Sprachcode verwenden, z. B. en, um Hilfe für jede Region in Englisch herunterzuladen.

Typ:CultureInfo[]
Position:2
Standardwert:Current UI culture
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-UseDefaultCredentials

Gibt an, dass dieses Cmdlet den Befehl einschließlich des Webdownloads mit den Anmeldeinformationen des aktuellen Benutzers ausführt. Standardmäßig wird der Befehl ohne explizite Anmeldeinformationen ausgeführt.

Dieser Parameter ist nur wirksam, wenn der Webdownload NTLM, Negotiate oder Kerberos-basierte Authentifizierung verwendet.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

PSModuleInfo

Sie können ein Modulobjekt an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.

Hinweise

  • Um Hilfe für Module im Ordner $PSHOME\Modules zu speichern, starten Sie PowerShell mithilfe der Option "Als Administrator ausführen". Nur Mitglieder der Gruppe "Administratoren" auf dem Computer können Hilfe zu Modulen im Ordner "$PSHOME\Modules" herunterladen.
  • Die gespeicherte Hilfe für jedes Modul besteht aus einer Hilfeinformationsdatei (HelpInfo XML) und einer CAB-Datei (.cab) für die Hilfedateien jeder UI-Kultur. Sie müssen die Hilfedateien nicht aus der CAB-Datei extrahieren. Das cmdlet Update-Help extrahiert die Hilfedateien, überprüft den XML-Code und installiert dann die Hilfedateien und die Hilfeinformationsdatei in einem sprachspezifischen Unterordner des Modulordners.
  • Das Cmdlet Save-Help kann Hilfe für Module speichern, die nicht auf dem Computer installiert sind. Da hilfedateien jedoch im Modulordner installiert sind, kann das Cmdlet Update-Help aktualisierte Hilfedatei nur für Module installieren, die auf dem Computer installiert sind.
  • Wenn Save-Help aktualisierte Hilfedateien für ein Modul nicht finden oder aktualisierte Hilfedateien in der angegebenen Sprache nicht finden können, wird sie im Hintergrund fortgesetzt, ohne eine Fehlermeldung anzuzeigen. Um zu sehen, welche Dateien vom Befehl gespeichert wurden, geben Sie den parameter Verbose an.
  • Module sind die kleinste Einheit aktualisierbarer Hilfe. Sie können keine Hilfe für ein bestimmtes Cmdlet speichern, nur für alle Cmdlets im Modul. Um das Modul zu finden, das ein bestimmtes Cmdlet enthält, verwenden Sie die eigenschaft ModuleName zusammen mit dem Cmdlet Get-Command, z. B. (Get-Command \<cmdlet-name\>).ModuleName
  • Save-Help unterstützt alle Module und die wichtigsten PowerShell-Snap-Ins. Es werden keine anderen Snap-Ins unterstützt.
  • Die cmdlets Update-Help und Save-Help verwenden die folgenden Ports zum Herunterladen von Hilfedateien: Port 80 für HTTP und Port 443 für HTTPS.
  • Die Cmdlets Update-Help und Save-Help werden unter Windows Preinstallation Environment (Windows PE) nicht unterstützt.