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 Save-Help Cmdlet lädt die neuesten Hilfedateien für PowerShell-Module herunter und speichert sie in einem von Ihnen angegebenen Verzeichnis. Mit dieser Funktion können Sie die Hilfedateien auf Computern aktualisieren, die keinen Internetzugriff haben, und sie vereinfacht die Aktualisierung der Hilfedateien auf mehreren Computern.

In Windows PowerShell 3.0 funktionierte nur für Module, Save-Help 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.

In Windows PowerShell 4.0 wird die HelpInfoUri-Eigenschaft über PowerShell-Remoting beibehalten, sodass Save-Help module verwendet werden können, die auf Remotecomputern installiert sind. Es ist auch möglich, ein PSModuleInfo-Objekt auf einem Datenträger oder Wechselmedium zu speichern, indem Sie auf einem Computer ohne Internetzugriff ausführenExport-Clixml, das Objekt auf einem Computer importieren, der über Internetzugriff verfügt, und dann auf dem PSModuleInfo-Objekt ausführenSave-Help. Die gespeicherte Hilfe kann mithilfe von Wechselmedien, z. B. einem USB-Laufwerk, auf den Remotecomputer übertragen werden. Die Hilfe kann auf dem Remotecomputer installiert werden, indem Sie ausführen Update-Help. Dieser Prozess kann zum Installieren der Hilfe auf Computern verwendet werden, die überhaupt keinen Zugriff auf das Netzwerk haben.

Um gespeicherte Hilfedateien zu installieren, führen Sie das Update-Help Cmdlet 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 In der Umgebungsvariablen PSModulePath aufgeführten Speicherort installiert sind. Diese Aktion überspringt Module, die keine aktualisierbare Hilfe ohne Warnung unterstützen.

Das Save-Help Cmdlet ü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 Save-Help Cmdlet funktioniert genau wie das Update-Help Cmdlet, mit dem Unterschied, dass es die heruntergeladenen Kabinettdateien (.cab) speichert, anstatt die Hilfedateien aus den Kabinettdateien zu extrahieren und sie auf dem Computer zu installieren.

Die gespeicherte Hilfe für jedes Modul besteht aus einer Hilfeinformationsdatei (HelpInfo XML) und einer Kabinettdatei (.cab) für die Hilfedateien jeder Benutzeroberflächenkultur. Sie müssen die Hilfedateien nicht aus der Kabinettdatei extrahieren. Das Update-Help Cmdlet extrahiert die Hilfedateien, überprüft die XML-Datei 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 ein 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 das DhcpServer-Modul

# Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote DHCP Server module,
# save the PSModuleInfo object in the variable $m, and then run Save-Help.

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


# Option 2: Open a PSSession--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

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


# Option 3: Open a CIM session--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

$c = New-CimSession -ComputerName "RemoteServer"
$m = Get-Module -CimSession $c -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"

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

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

# First, run Export-CliXml to export the PSModuleInfo object to a shared folder or to removable media.

$m = Get-Module -Name "DhcpServer" -ListAvailable
Export-CliXml -Path "E:\UsbFlashDrive\DhcpModule.xml" -InputObject $m

# Next, transport the removable media to a computer that has Internet access, and then import the
# PSModuleInfo object with Import-CliXml. Run Save-Help to save the Help for the imported DhcpServer
# module PSModuleInfo object.

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

# Finally, transport the removable media back to the computer that does not have network access, and
# then install the help by running Update-Help.

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

In diesem Beispiel wird gezeigt, wie Sie hilfe installieren, die Sie in Beispiel 1 für das DhcpServer-Modul auf einem Computer ohne Internetzugriff gespeichert haben.

Beispiel 3: Speichern der Hilfe für alle Module

Save-Help -DestinationPath "\\Server01\FileShare01"

Mit diesem Befehl werden die neuesten Hilfedateien für alle Module in der Benutzeroberflächenkultur für Windows auf den lokalen Computer heruntergeladen. Die Hilfedateien werden im \\Server01\Fileshare01 Ordner gespeichert.

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

Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01

Mit diesem Befehl werden die neuesten Hilfedateien für das Modul ServerManager heruntergeladen und anschließend im \\Server01\Fileshare01 Ordner gespeichert.

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

Der Befehl verwendet den Credential-Parameter, um die Anmeldeinformationen eines Benutzers anzugeben, der über die Berechtigung zum Schreiben in der Dateifreigabe verfügt.

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

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

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

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 das Modulobjekt dann an das Save-Help Cmdlet leitet.

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

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

Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"

Dieser Befehl speichert Hilfe für die Wichtigsten PowerShell-Module in vier verschiedenen Benutzeroberflächenkulturen. Die Sprachpakete für diese Gebietsschemas müssen nicht auf dem Computer installiert werden.

Save-Help kann Hilfedateien für Module in verschiedenen Benutzeroberflächenkulturen nur herunterladen, wenn der Modulbesitzer die übersetzten Dateien im Internet verfügbar macht.

Beispiel 7: Hilfe mehr als einmal täglich speichern

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

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

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

Der Befehl verwendet das Save-Help Cmdlet, um die Hilfedateien herunterzuladen und in den angegebenen Ordner zu speichern. Der Force-Parameter ist erforderlich, wenn Sie einen Save-Help Befehl mehrmals täglich ausführen müssen.

Parameter

-Credential

Gibt Benutzeranmeldeinformationen an. Dieses Cmdlet führt den Befehl mithilfe der Anmeldeinformationen eines Benutzers aus, der über die Berechtigung zum Zugriff auf den durch den DestinationPath-Parameter 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 Befehle ausführen Save-Help , die den Parameter DestinationPath auf Remotecomputern verwenden. Durch Bereitstellen expliziter Anmeldeinformationen 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 vom Get-Credential Cmdlet generiertes PSCredential-Objekt ein. 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.

Hinweis

Weitere Informationen zum Schutz von SecureString-Daten finden Sie unter Wie sicher ist SecureString?.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DestinationPath

Gibt den Pfad des Ordners an, in dem die Hilfedateien gespeichert werden. Geben Sie keinen Dateinamen und keine Dateierweiterung an.

Type:String[]
Aliases:Path
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Force

Gibt an, dass dieses Cmdlet die Einmal-pro-Tag-Einschränkung nicht befolgt, die Versionsprüfung überspringt und Dateien herunterlädt, die den Grenzwert von 1 GB überschreiten.

Ohne diesen Parameter ist in jedem 24-Stunden-Zeitraum nur ein Save-Help Befehl für jedes Modul 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 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 macht es für Sie praktisch, Ihrem PowerShell-Profil einen Save-Help Befehl hinzuzufügen.

Um Hilfe für ein Modul in mehreren Benutzeroberflächenkulturen ohne den Force-Parameter 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

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-FullyQualifiedModule

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

Wenn es sich bei dem Wert um einen Pfad handelt, kann der Pfad vollständig qualifiziert oder relativ sein. Ein relativer Pfad wird relativ zum Skript aufgelöst, das die using-Anweisung enthält.

Wenn der Wert ein Name oder eine Modulspezifikation ist, durchsucht PowerShell den PSModulePath nach dem angegebenen Modul.

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

  • ModuleName - Erforderlich Gibt den Modulnamen an.
  • GUID - Optional Gibt die GUID des Moduls an.
  • Es ist auch erforderlich , mindestens einen der drei folgenden Schlüssel anzugeben.
    • ModuleVersion – Gibt eine zulässige Mindestversion des Moduls an.
    • MaximumVersion – Gibt die maximal zulässige Version des Moduls an.
    • RequiredVersion – Gibt eine exakte, 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 einen Module-Parameter angeben. die beiden Parameter schließen sich gegenseitig aus.

Type:ModuleSpecification[]
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters: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 Platzhalter interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einzelne Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Module

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

Lädt standardmäßig Hilfe für alle Module herunter, Save-Help die aktualisierbare Hilfe unterstützen und auf dem lokalen Computer an einem In der Umgebungsvariablen PSModulePath aufgeführten Speicherort installiert sind.

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. Leiten Sie dann die resultierenden Modulobjekte an das Save-Help Cmdlet weiter, oder übermitteln Sie die Modulobjekte als Wert des Modul- oder 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 vom Get-Module Cmdlet zurückgegebenes Objekt.

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

Der Wert "*" (all) versucht, die Hilfe für alle Module zu aktualisieren, die auf dem Computer installiert sind. Dies schließt Module ein, die keine aktualisierbare Hilfe unterstützen. Dieser Wert kann Fehler generieren, wenn der Befehl auf Module stößt, die die aktualisierbare Hilfe nicht unterstützen.

Type:PSModuleInfo[]
Aliases:Name
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:True

-Scope

Dieser Paramater führt in diesem Cmdlet nichts aus.

Type:UpdateHelpScope
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-UICulture

Gibt Benutzeroberflächenkulturwerte an, für die dieses Cmdlet aktualisierte Hilfedateien erhält. Geben Sie einen oder mehrere Sprachcodes ein, z es-ES. B. eine Variable, die Kulturobjekte enthält, oder einen Befehl, mit dem Kulturobjekte abgerufen werden, z. B. einen Get-Culture oder Get-UICulture -Befehl.

Platzhalterzeichen sind nicht zulässig. Geben Sie keinen teilweisen Sprachcode an, z. B. "de".

Ruft standardmäßig Save-Help Hilfedateien im Benutzeroberflächenkultursatz für Windows oder dessen Fallbackkultur ab. Wenn Sie den UICulture-Parameter angeben, Save-Help sucht nur hilfe für die angegebene UI-Kultur, nicht für eine Fallbackkultur.

Type:CultureInfo[]
Position:2
Default value:Current UI culture
Accept pipeline input:False
Accept wildcard characters: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 gilt nur, wenn der Webdownload eine NTLM-, Negotiate- oder Kerberos-basierte Authentifizierung verwendet.

Type:SwitchParameter
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters: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 mit 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 Kabinettdatei (.cab) für die Hilfedateien jeder Benutzeroberflächenkultur. Sie müssen die Hilfedateien nicht aus der Kabinettdatei extrahieren. Das Update-Help Cmdlet extrahiert die Hilfedateien, überprüft den XML-Code und installiert dann die Hilfedateien und die Hilfeinformationsdatei in einem sprachspezifischen Unterordner des Modulordners.
  • Das Save-Help Cmdlet kann Hilfe für Module speichern, die nicht auf dem Computer installiert sind. Da Hilfedateien jedoch im Modulordner installiert sind, kann das Cmdlet aktualisierte Update-Help Hilfedatei nur für Module installieren, die auf dem Computer installiert sind.
  • Wenn Save-Help aktualisierte Hilfedateien für ein Modul nicht gefunden werden oder aktualisierte Hilfedateien in der angegebenen Sprache nicht gefunden werden können, wird es ohne Fehlermeldung fortgesetzt. Geben Sie den Verbose-Parameter an, um zu ermitteln, welche Dateien durch den Befehl gespeichert wurden.
  • Module sind die kleinste Einheit der aktualisierbaren 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 ModuleName-Eigenschaft zusammen mit dem Get-Command Cmdlet, z. B. (Get-Command \<cmdlet-name\>).ModuleName
  • Save-Help unterstützt alle Module und die wichtigsten PowerShell-Snap-Ins. Andere Snap-Ins werden nicht unterstützt.
  • Die Update-Help Cmdlets und Save-Help verwenden die folgenden Ports zum Herunterladen von Hilfedateien: Port 80 für HTTP und Port 443 für HTTPS.
  • Die Update-Help Cmdlets und Save-Help werden in Windows Preinstallation Environment (Windows PE) nicht unterstützt.