Save-Help

Module:

Microsoft.PowerShell.Core

Hiermee worden de nieuwste Help-bestanden gedownload en opgeslagen in een bestandssysteemmap.

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>]

Description

Met Save-Help de cmdlet worden de nieuwste Help-bestanden voor PowerShell-modules gedownload en opgeslagen in een map die u opgeeft. Met deze functie kunt u de Help-bestanden op computers die geen toegang hebben tot internet bijwerken en kunt u de Help-bestanden op meerdere computers gemakkelijker bijwerken.

In Windows PowerShell 3.0 werkte Save-Help alleen voor modules die op de lokale computer zijn geïnstalleerd. Hoewel het mogelijk was om een module van een externe computer te importeren of een verwijzing naar een PSModuleInfo-object van een externe computer te verkrijgen met behulp van Externe PowerShell-communicatie, werd de eigenschap HelpInfoUri niet behouden en Save-Help zou het niet werken voor Help voor externe modules.

In Windows PowerShell 4.0 blijft de eigenschap HelpInfoUri behouden via externe communicatie van PowerShell, waarmee u kunt Save-Help werken voor modules die zijn geïnstalleerd op externe computers. Het is ook mogelijk om een PSModuleInfo-object op te slaan op schijf of verwisselbare media door uit te voeren Export-Clixml op een computer die geen internettoegang heeft, het object te importeren op een computer met internettoegang en vervolgens uit te voeren Save-Help op het PSModuleInfo-object . De opgeslagen hulp kan worden overgebracht naar de externe computer met behulp van verwisselbare opslagmedia, zoals een USB-station. De help kan worden geïnstalleerd op de externe computer door uit te voeren Update-Help. Dit proces kan worden gebruikt om hulp te installeren op computers die geen enkele vorm van netwerktoegang hebben.

Voer de Update-Help cmdlet uit om opgeslagen Help-bestanden te installeren. Voeg de SourcePath-parameter toe om de map op te geven waarin u de Help-bestanden hebt opgeslagen.

Zonder parameters downloadt een Save-Help opdracht de nieuwste help voor alle modules in de sessie en voor modules die op de computer zijn geïnstalleerd op een locatie die wordt vermeld in de omgevingsvariabele PSModulePath . Met deze actie worden modules overgeslagen die geen ondersteuning bieden voor Updatable Help zonder waarschuwing.

De Save-Help cmdlet controleert de versie van help-bestanden in de doelmap. Als er nieuwere Help-bestanden beschikbaar zijn, worden met deze cmdlet de nieuwste Help-bestanden van internet gedownload en vervolgens opgeslagen in de map. De Save-Help cmdlet werkt net als de Update-Help cmdlet, behalve dat de gedownloade cabinetbestanden (.cab) worden opgeslagen in plaats van de Help-bestanden uit de cabinetbestanden te extraheren en te installeren op de computer.

De opgeslagen Help voor elke module bestaat uit één Help-informatiebestand (HelpInfo XML) en één cabinetbestand (.cab) voor de Help-bestanden elke UI-cultuur. U hoeft de Help-bestanden niet uit het cabinetbestand te extraheren. De Update-Help cmdlet extraheert de Help-bestanden, valideert de XML voor veiligheid en installeert vervolgens de Help-bestanden en het Help-informatiebestand in een taalspecifieke submap van de modulemap.

Als u de Help-bestanden voor modules wilt opslaan in de installatiemap van PowerShell ($pshome\Modules), start u PowerShell met behulp van de optie Uitvoeren als administrator. U moet lid zijn van de groep Administrators op de computer om de Help-bestanden voor deze modules te downloaden.

Deze cmdlet is geïntroduceerd in Windows PowerShell 3.0.

Voorbeelden

Voorbeeld 1: De Help voor de DhcpServer-module opslaan

# 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"

In dit voorbeeld ziet u drie verschillende manieren om Save-Help de Help voor de DhcpServer-module op te slaan vanaf een clientcomputer met internetverbinding, zonder de DhcpServer-module of de DHCP-serverfunctie op de lokale computer te installeren.

Voorbeeld 2: Help installeren voor de DhcpServer-module

# 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 dit voorbeeld ziet u hoe u hulp installeert die u hebt opgeslagen in voorbeeld 1 voor de DhcpServer-module op een computer die geen internettoegang heeft.

Voorbeeld 3: Help voor alle modules opslaan

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

Met deze opdracht worden de nieuwste Help-bestanden gedownload voor alle modules in de gebruikersinterfacecultuurset voor Windows op de lokale computer. De Help-bestanden worden opgeslagen in de \\Server01\Fileshare01 map.

Voorbeeld 4: Help opslaan voor een module op de computer

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

Met deze opdracht worden de nieuwste Help-bestanden voor de ServerManager-module gedownload en vervolgens opgeslagen in de \\Server01\Fileshare01 map.

Wanneer een module op de computer is geïnstalleerd, kunt u de naam van de module typen als de waarde van de moduleparameter, zelfs als de module niet in de huidige sessie wordt geïmporteerd.

De opdracht gebruikt de parameter Referentie om de referenties op te geven van een gebruiker die gemachtigd is om naar de bestandsshare te schrijven.

Voorbeeld 5: Help opslaan voor een module op een andere computer

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

Met deze opdrachten worden de nieuwste Help-bestanden voor de CustomSQL-module gedownload en opgeslagen in de \\Server01\Fileshare01 map.

Omdat de CustomSQL-module niet op de computer is geïnstalleerd, bevat de reeks een Invoke-Command opdracht waarmee het moduleobject voor de CustomSQL-module van de Server02-computer wordt opgehaald en vervolgens het moduleobject naar de Save-Help cmdlet wordt uitgevoerd.

Wanneer een module niet op de computer is geïnstalleerd, Save-Help heeft u het moduleobject nodig, dat informatie bevat over de locatie van de nieuwste Help-bestanden.

Voorbeeld 6: Help voor een module opslaan in meerdere talen

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

Met deze opdracht wordt help opgeslagen voor de kernmodules van PowerShell in vier verschillende ui-culturen. De taalpakketten voor deze landinstellingen hoeven niet op de computer te worden geïnstalleerd.

Save-Help kan Help-bestanden voor modules in verschillende UI-culturen alleen downloaden wanneer de eigenaar van de module de vertaalde bestanden beschikbaar maakt op internet.

Voorbeeld 7: Help meer dan één keer per dag opslaan

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

Met deze opdracht wordt help opgeslagen voor alle modules die op de computer zijn geïnstalleerd. Met de opdracht geeft u de parameter Force op om de regel te overschrijven die voorkomt dat de Save-Help cmdlet help meer dan één keer in elke periode van 24 uur downloadt.

De parameter Force overschrijft ook de beperking van 1 GB en omzeilt versiecontrole. Daarom kunt u bestanden downloaden, zelfs als de versie niet later is dan de versie in de doelmap.

De opdracht gebruikt de Save-Help cmdlet om de Help-bestanden te downloaden en op te slaan in de opgegeven map. De parameter Force is vereist wanneer u een Save-Help opdracht meer dan één keer per dag moet uitvoeren.

Parameters

-Credential

Hiermee geeft u een gebruikersreferentie op. Met deze cmdlet wordt de opdracht uitgevoerd met behulp van referenties van een gebruiker die gemachtigd is om toegang te krijgen tot de locatie van het bestandssysteem die is opgegeven door de parameter DestinationPath . Deze parameter is alleen geldig wanneer de parameter DestinationPath of LiteralPath wordt gebruikt in de opdracht.

Met deze parameter kunt u opdrachten uitvoeren Save-Help die gebruikmaken van de DestinationPath-parameter op externe computers. Door expliciete referenties op te geven, kunt u de opdracht uitvoeren op een externe computer en toegang krijgen tot een bestandsshare op een derde computer zonder dat er een fout met toegang is geweigerd of credSSP-verificatie wordt gebruikt om referenties te delegeren.

Typ een gebruikersnaam, zoals User01 of Domain01\User01, of voer een PSCredential-object in dat is gegenereerd door de Get-Credential cmdlet. Als u een gebruikersnaam typt, wordt u gevraagd het wachtwoord in te voeren.

Referenties worden opgeslagen in een PSCredential-object en het wachtwoord wordt opgeslagen als securestring.

Notitie

Zie Hoe veilig is SecureString?voor meer informatie over SecureString-gegevensbeveiliging.

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

-DestinationPath

Hiermee geeft u het pad van de map waarin de Help-bestanden worden opgeslagen. Geef geen bestandsnaam of bestandsnaamextensie op.

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

-Force

Geeft aan dat deze cmdlet niet voldoet aan de beperking voor één keer per dag, het controleren van versies overslaat en bestanden downloadt die de limiet van 1 GB overschrijden.

Zonder deze parameter is slechts één Save-Help opdracht voor elke module toegestaan in elke periode van 24 uur, worden downloads beperkt tot 1 GB ongecomprimeerde inhoud per module en worden help-bestanden voor een module alleen geïnstalleerd wanneer ze nieuwer zijn dan de bestanden op de computer.

De limiet voor één keer per dag beveiligt de servers waarop de Help-bestanden worden gehost en maakt het praktisch voor u om een Save-Help opdracht toe te voegen aan uw PowerShell-profiel.

Als u hulp wilt opslaan voor een module in meerdere UI-culturen zonder de parameter Force , moet u alle UI-culturen in dezelfde opdracht opnemen, zoals: 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

Hiermee geeft u modules met namen op die zijn opgegeven in de vorm van ModuleSpecification-objecten . Zie de sectie Opmerkingen van ModuleSpecification Constructor (Hashtable).

De parameter FullyQualifiedModule accepteert bijvoorbeeld een modulenaam die is opgegeven in een van deze indelingen:

• @{ModuleName = "modulename"; ModuleVersion = "version_number"}
• @{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}

ModuleName en ModuleVersion zijn vereist, maar Guid is optioneel. U kunt de parameter FullyQualifiedModule niet opgeven in dezelfde opdracht als een moduleparameter . de twee parameters sluiten elkaar wederzijds uit.

Type:	ModuleSpecification[]
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

Hiermee geeft u een pad van de doelmap op. In tegenstelling tot de waarde van de parameter DestinationPath wordt de waarde van de Parameter LiteralPath precies gebruikt zoals deze wordt getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escapetekens bevat, plaatst u het tussen enkele aanhalingstekens. Enkele aanhalingstekens geven PowerShell aan dat u geen tekens als escape-reeksen interpreteert.

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

-Module

Hiermee geeft u modules op waarvoor deze cmdlet help downloadt. Voer een of meer modulenamen of naam patters in een door komma's gescheiden lijst of in een bestand met één modulenaam op elke regel. Jokertekens zijn toegestaan. U kunt ook moduleobjecten van de Get-Module cmdlet naar Save-Help.

Save-Help Standaard downloadt u help voor alle modules die Updatable Help ondersteunen en worden geïnstalleerd op de lokale computer op een locatie die wordt vermeld in de omgevingsvariabele PSModulePath.

Als u hulp wilt opslaan voor modules die niet op de computer zijn geïnstalleerd, voert u een Get-Module opdracht uit op een externe computer. Geef vervolgens de resulterende moduleobjecten door naar de Save-Help cmdlet of verzend de moduleobjecten als de waarde van de parameters Module of InputObject .

Als de module die u opgeeft, is geïnstalleerd op de computer, kunt u de modulenaam of een moduleobject invoeren. Als de module niet op de computer is geïnstalleerd, moet u een moduleobject invoeren, zoals een object dat wordt geretourneerd door de Get-Module cmdlet.

De moduleparameter van de Save-Help cmdlet accepteert niet het volledige pad van een modulebestand of modulemanifestbestand. Als u hulp wilt opslaan voor een module die zich niet op een PSModulePath-locatie bevindt, importeert u de module in de huidige sessie voordat u de Save-Help opdracht uitvoert.

Een waarde van '*' (alle) probeert help bij te werken voor alle modules die op de computer zijn geïnstalleerd. Dit omvat modules die geen ondersteuning bieden voor Updatable Help. Deze waarde kan fouten genereren wanneer de opdracht modules tegenkomt die geen ondersteuning bieden voor Updatable Help.

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

-Scope

Deze paramater doet niets in deze cmdlet.

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

-UICulture

Hiermee geeft u de cultuurwaarden van de gebruikersinterface op waarvoor deze cmdlet help-bestanden worden bijgewerkt. Voer een of meer taalcodes in, zoals es-ESeen variabele die cultuurobjecten bevat of een opdracht waarmee cultuurobjecten worden opgehaald, zoals een of Get-UICulture opdrachtGet-Culture.

Jokertekens zijn niet toegestaan. Geef geen gedeeltelijke taalcode op, zoals 'de'.

Save-Help Standaard worden help-bestanden in de UI-cultuurset voor Windows of de terugvalcultuur weergegeven. Als u de parameter UICulture opgeeft, Save-Help zoekt u alleen naar hulp voor de opgegeven UI-cultuur, niet in een terugvalcultuur.

Type:	CultureInfo[]
Position:	2
Default value:	Current UI culture
Accept pipeline input:	False
Accept wildcard characters:	False

-UseDefaultCredentials

Geeft aan dat met deze cmdlet de opdracht, inclusief het downloaden van het web, wordt uitgevoerd met de referenties van de huidige gebruiker. Standaard wordt de opdracht uitgevoerd zonder expliciete referenties.

Deze parameter is alleen effectief wanneer de webdownload gebruikmaakt van verificatie op basis van NTLM, onderhandelen of Kerberos.

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

Invoerwaarden

PSModuleInfo

U kunt een moduleobject van de Get-Module cmdlet doorsluisen naar de moduleparameter van Save-Help.

Uitvoerwaarden

None

Met deze cmdlet wordt geen uitvoer gegenereerd.

Notities

• Als u hulp wilt opslaan voor modules in de map $pshome\Modules, start u PowerShell met behulp van de optie Uitvoeren als beheerder. Alleen leden van de groep Administrators op de computer kunnen help downloaden voor modules in de map $pshome\Modules.
• De opgeslagen Help voor elke module bestaat uit één Help-informatiebestand (HelpInfo XML) en één cabinetbestand (.cab) voor de Help-bestanden elke UI-cultuur. U hoeft de Help-bestanden niet uit het cabinetbestand te extraheren. De Update-Help cmdlet extraheert de Help-bestanden, valideert de XML en installeert vervolgens de Help-bestanden en het Help-informatiebestand in een taalspecifieke submap van de modulemap.
• Met Save-Help de cmdlet kunt u hulp opslaan voor modules die niet op de computer zijn geïnstalleerd. Omdat Help-bestanden echter zijn geïnstalleerd in de modulemap, kan de Update-Help cmdlet alleen bijgewerkte Help-bestand installeren voor modules die op de computer zijn geïnstalleerd.
• Als Save-Help er geen bijgewerkte Help-bestanden voor een module kunnen worden gevonden of geen bijgewerkte Help-bestanden in de opgegeven taal kunnen vinden, wordt deze op de achtergrond voortgezet zonder een foutbericht weer te geven. Als u wilt zien welke bestanden zijn opgeslagen met de opdracht, geeft u de uitgebreide parameter op.
• Modules zijn de kleinste eenheid met hulp die kan worden bijgewerkt. U kunt geen hulp opslaan voor een bepaalde cmdlet, alleen voor alle cmdlets in de module. Als u de module wilt zoeken die een bepaalde cmdlet bevat, gebruikt u de eigenschap ModuleName samen met de Get-Command cmdlet, bijvoorbeeld (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help ondersteunt alle modules en de belangrijkste PowerShell-modules. Het biedt geen ondersteuning voor andere modules.
• De Update-Help en Save-Help cmdlets gebruiken de volgende poorten om Help-bestanden te downloaden: Poort 80 voor HTTP en poort 443 voor HTTPS.
• De Update-Help en Save-Help cmdlets worden niet ondersteund in Windows Preinstallation Environment (Windows PE).

Verwante koppelingen

• Get-Help
• Get-Module
• Update-Help