Save-Help
Lädt die neuesten Hilfedateien herunter und speichert sie in einem Dateisystemverzeichnis.
Syntax
Path (Standard)
Save-Help
[-DestinationPath] <String[]>
[[-Module] <PSModuleInfo[]>]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[<CommonParameters>]
LiteralPath
Save-Help
[[-Module] <PSModuleInfo[]>]
[[-UICulture] <CultureInfo[]>]
-LiteralPath <String[]>
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[<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.
In Windows PowerShell 3.0 funktionierte Save-Help nur für Module, die auf dem lokalen Computer installiert sind. Obwohl es möglich war, ein Modul von einem Remotecomputer zu importieren oder einen Verweis auf ein PSModuleInfo-Objekt von einem Remotecomputer mithilfe von PowerShell-Remoting abzurufen, wurde die HelpInfoUri-Eigenschaft nicht beibehalten, und Save-Help funktionierte nicht für die Hilfe des Remotemoduls.
Um gespeicherte Hilfedateien zu installieren, führen Sie das Cmdlet Update-Help aus. Fügen Sie den SourcePath Parameter hinzu, um den Ordner anzugeben, in dem Sie die Hilfedateien gespeichert 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 Umgebungsvariablen PSModulePath aufgeführt ist. Diese Aktion überspringt Module, die die aktualisierbare Hilfe ohne Warnung nicht 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 genauso wie das Cmdlet Update-Help, mit dem Unterschied, dass es die heruntergeladenen CAB-Dateien (.cab) speichert, anstatt die Hilfedateien aus den CAB-Dateien zu extrahieren und auf dem Computer zu installieren.
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 auf Sicherheit und installiert dann die Hilfedateien und die Hilfeinformationsdatei in einem sprachspezifischen Unterordner des Modulordners.
Um die Hilfedateien für Module im PowerShell-Installationsordner ($pshome\Modules) zu speichern, starten Sie PowerShell mit 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.
Dieses Cmdlet wurde in Windows PowerShell 3.0 eingeführt.
Beispiele
Beispiel 1: Speichern der Hilfe für alle Module
PS> Save-Help -DestinationPath \\Server01\FileShare01
Mit diesem Befehl werden die neuesten Hilfedateien für alle Module der Benutzeroberflächenkultur für Windows auf dem lokalen Computer heruntergeladen. Die Hilfedateien werden im Verzeichnis \\Server01\Fileshare01 gespeichert.
Beispiel 2: Speichern der Hilfe für ein Modul auf dem Computer
PS> Save-Help -Module ServerManager -DestinationPath \\Server01\FileShare01 -Credential Domain01/Admin01
Mit diesem Befehl werden die neuesten Hilfedateien für das ServerManager-Modul heruntergeladen und im Verzeichnis \\Server01\Fileshare01 gespeichert.
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 3: Speichern der Hilfe für ein Modul auf einem anderen Computer
PS> Invoke-Command -ComputerName Server02 {Get-Module -Name CustomSQL -ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01
Mit diesen Befehlen werden die neuesten Hilfedateien für das CustomSQL-Modul heruntergeladen und im Verzeichnis \\Server01\Fileshare01 gespeichert.
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 Computer Server02 abruft und dann das Modulobjekt an das Cmdlet Save-Help weiterleitet.
Wenn ein Modul nicht auf dem Computer installiert ist, benötigt Save-Help das Modulobjekt, das Informationen über den Speicherort der neuesten Hilfedateien enthält.
Beispiel 4: Speichern der Hilfe für ein Modul in mehreren Sprachen
PS> Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath D:\Help
Mit diesem Befehl wird die Hilfe für die Windows PowerShell Core-Module in vier verschiedenen Benutzeroberflächenkulturen gespeichert. Die Sprachpakete für diese Gebietsschemas müssen nicht auf dem Computer installiert werden.
Save-Help kann Hilfedateien für Module in verschiedenen UI-Kulturen nur herunterladen, wenn der Modulbesitzer die übersetzten Dateien im Internet zur Verfügung stellt.
Beispiel 5: Speichern der Hilfe mehr als einmal pro Tag
PS> Save-Help -Force -DestinationPath \\Server3\AdminShare\Help
Dieser Befehl speichert Hilfe für alle Module, die auf dem Computer installiert sind. Der Befehl verwendet den Parameter Force , um die Regel außer Kraft zu setzen, die verhindert, dass das Cmdlet Save-Help die Hilfe mehr als einmal pro 24-Stunden-Zeitraum herunterlädt.
Der Force-Parameter überschreibt auch die Beschränkung von 1 GB und umgeht die Versionsprüfung, sodass Sie Dateien auch dann herunterladen können, wenn die Version nicht größer ist als die Version im Zielverzeichnis.
Der Befehl verwendet das Cmdlet Save-Help , um die Hilfedateien herunterzuladen und im angegebenen Verzeichnis zu speichern. Der Parameter Force ist erforderlich, wenn Sie einen Save-Help-Befehl mehr als einmal pro Tag 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.
Parametereigenschaften
| Typ: | PSCredential |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-DestinationPath
Gibt den Pfad des Ordners an, in dem die Hilfedateien gespeichert werden. Geben Sie keine Dateinamen- oder Dateinamenerweiterung an.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
Path
| Position: | 0 |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Force
Gibt an, dass dieses Cmdlet die Einschränkung für einmal pro Tag nicht befolgt, 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 unkomprimierten Inhalt pro Modul beschränkt, und Hilfedateien für ein Modul werden nur installiert, wenn sie neuer sind als die Dateien auf dem Computer.
Das Limit von einmal pro Tag schützt die Server, auf denen die Hilfedateien gehostet werden, und macht es praktisch, 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
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen signalisieren PowerShell, dass keine Zeichen als Escapesequenzen interpretiert werden sollen.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | PSPath |
Parametersätze
LiteralPath
| Position: | Named |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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. Platzhalterzeichen sind zulässig. Sie können Modulobjekte auch über die Pipeline aus dem Cmdlet Get-Module an Save-Help übergeben.
Standardmäßig lädt Save-Help die 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 Umgebungsvariablen PSModulePath aufgeführt ist.
Wenn Sie Hilfe für Module speichern möchten, die nicht auf dem Computer installiert sind, führen Sie den Befehl Get-Module auf einem Remotecomputer aus. Übergeben Sie dann die resultierenden Modulobjekte an das Cmdlet Save-Help , oder übermitteln Sie die Modulobjekte als Wert des Module-Parameters oder des InputObject-Parameters .
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. ein Objekt, 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. Wenn Sie Hilfe für ein Modul speichern möchten, das sich nicht an 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 die aktualisierbare Hilfe nicht unterstützen.
Parametereigenschaften
| Typ: | PSModuleInfo[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | True |
| Nicht anzeigen: | False |
| Aliase: | Name |
Parametersätze
(All)
| Position: | 1 |
| Obligatorisch: | False |
| Wert aus Pipeline: | True |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | True |
| Wert aus verbleibenden Argumenten: | 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. einen Get-Culture- oder Get-UICulture Befehl.
Platzhalterzeichen sind nicht zulässig. Geben Sie keinen teilweisen Sprachcode an, z. B. "de".
Standardmäßig ruft Save-Help Hilfedateien in der für Windows festgelegten Benutzeroberflächenkultur oder in der Fallbackkultur ab. Wenn Sie den UICulture-Parameter angeben, sucht Save-Help nur nach Hilfe für die angegebene Benutzeroberflächenkultur, nicht in einer Fallbackkultur.
Parametereigenschaften
| Typ: | CultureInfo[] |
| Standardwert: | Current UI culture |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 2 |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
Eingaben
PSModuleInfo
Sie können ein Modulobjekt über die Pipeline aus dem Cmdlet Get-Module an den Modul-Parameter von Save-Help übergeben.
Ausgaben
None
Dieses Cmdlet generiert keine Ausgabe.
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 für Module 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.
- Mit dem Cmdlet Save-Help kann Hilfe für Module gespeichert werden, die nicht auf dem Computer installiert sind. Da Hilfedateien jedoch im Modulordner installiert werden, kann das Cmdlet Update-Help die aktualisierte Hilfedatei nur für Module installieren, die auf dem Computer installiert sind.
- Wenn Save-Help keine aktualisierten Hilfedateien für ein Modul oder keine aktualisierten Hilfedateien in der angegebenen Sprache finden kann, wird es im Hintergrund fortgesetzt, ohne dass eine Fehlermeldung angezeigt wird. 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 suchen, das ein bestimmtes Cmdlet enthält, verwenden Sie die ModuleName-Eigenschaft zusammen mit dem Cmdlet Get-Command, z. B.
(Get-Command \<cmdlet-name\>).ModuleName - Save-Help unterstützt alle Module und die PowerShell Core-Snap-Ins. Andere Snap-Ins werden nicht 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 in der Windows-Vorinstallationsumgebung (Windows PE) nicht unterstützt.