Save-Help

Modul:

Microsoft.PowerShell.Core Module

Stáhne a uloží nejnovější soubory nápovědy do adresáře systému souborů.

Syntaxe

Path (Výchozí)

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

LiteralPath

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

Description

Rutina Save-Help stáhne nejnovější soubory nápovědy pro moduly PowerShellu a uloží je do zadaného adresáře. Tato funkce umožňuje aktualizovat soubory nápovědy na počítačích, které nemají přístup k internetu, a usnadňuje aktualizaci souborů nápovědy na více počítačích. Tato rutina byla zavedena ve Windows PowerShellu 3.0.

Počínaje windows PowerShellem 4.0 můžete pomocí Save-Help stáhnout soubory nápovědy pro moduly nainstalované na vzdálených počítačích. Je také možné uložit objekt PSModuleInfo pomocí Export-Clixml na počítači, který nemá přístup k internetu, importovat objekt do počítače, který má přístup k internetu, a potom spustit Save-Help na PSModuleInfo objektu. Jakmile budete mít uloženou nápovědu, můžete ji zkopírovat do vzdáleného počítače a nainstalovat ji spuštěním Update-Help. Tento proces lze použít k instalaci nápovědy na počítače, které nemají žádný typ síťového přístupu.

Bez parametrů stáhne příkaz Save-Help nejnovější nápovědu pro všechny moduly v relaci a moduly nainstalované v počítači v umístění uvedeném v proměnné prostředí PSModule Path. Tato akce přeskočí moduly, které nepodporují aktualizovatelnou nápovědu bez upozornění.

Rutina Save-Help zkontroluje verzi všech souborů nápovědy v cílové složce. Pokud jsou k dispozici novější soubory nápovědy, tato rutina stáhne nejnovější soubory nápovědy z internetu a uloží je do složky. Rutina Save-Help funguje stejně jako rutina Update-Help s tím rozdílem, že ukládá stažený obsah místo extrahování souborů nápovědy a jejich instalaci do počítače.

Uložená nápověda pro každý modul se skládá z jednoho souboru nápovědy (HelpInfo XML) a archivu CAB nebo ZIP (.cab nebo .zip) pro soubory nápovědy v jednotlivých jazycích. Ve Windows příkaz stáhne soubory CAB. V Linuxu a macOS příkaz stáhne soubory ZIP.

Pokud chcete uložit soubory nápovědy pro moduly v instalační složce PowerShellu ($PSHOME\Modules), spusťte PowerShell pomocí možnosti Spustit jako správce. Abyste mohli stáhnout soubory nápovědy pro tyto moduly, musíte být členem skupiny Administrators na počítači.

Pokud chcete nainstalovat uložené soubory nápovědy, spusťte Update-Help pomocí parametru SourcePath a určete složku obsahující uložené soubory nápovědy. Update-Help extrahuje soubory nápovědy z archivu a nainstaluje je do příslušného umístění.

Příklady

Příklad 1: Uložení nápovědy pro modul DhcpServer

Tento příklad ukazuje tři různé způsoby použití Save-Help k uložení nápovědy pro modul DhcpServer z klientského počítače připojeného k internetu bez instalace modulu DhcpServer nebo role serveru DHCP na místním počítači.

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

Příklad 2: Instalace nápovědy pro modul DhcpServer

Tento příklad ukazuje, jak nainstalovat nápovědu pro počítač, který není připojený k síti. V tomto příkladu není první počítač připojený k přístupné síti. Soubory se do něj musí zkopírovat pomocí vyměnitelného média. Druhý počítač je připojený k internetu a může stáhnout soubory nápovědy.

# 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

Příklad 3: Uložení nápovědy pro všechny moduly

Tento příkaz stáhne nejnovější soubory nápovědy pro všechny moduly na místním počítači. Uloží soubory nápovědy do složky \\Server01\Fileshare01.

Save-Help -DestinationPath \\Server01\FileShare01

Příklad 4: Uložení nápovědy pro modul v počítači

Tento příkaz stáhne nejnovější soubory nápovědy pro modul ServerManager a uloží je do složky \\Server01\Fileshare01.

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

Když je na počítači nainstalovaný modul, můžete název modulu zadat jako hodnotu parametru Module, a to i v případě, že modul není importován do aktuální relace.

Příkaz používá parametr credential k zadání přihlašovacích údajů uživatele, který má oprávnění k zápisu do sdílené složky.

Příklad 5: Uložení nápovědy pro modul na jiném počítači

Tyto příkazy stáhnou nejnovější soubory nápovědy pro modul CustomSQL a uloží je do složky \\Server01\Fileshare01.

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

Vzhledem k tomu, že v počítači není nainstalovaný modul CustomSQL, obsahuje sekvence příkaz Invoke-Command, který získá objekt modulu pro modul CustomSQL z počítače Serveru02 a potom objekt modulu předá rutině Save-Help.

Pokud na počítači není nainstalovaný modul, Save-Help potřebuje objekt modulu, který obsahuje informace o umístění nejnovějších souborů nápovědy.

Příklad 6: Uložení nápovědy pro modul ve více jazycích

Tento příkaz uloží nápovědu pro základní moduly PowerShellu ve čtyřech různých jazykových verzích uživatelského rozhraní. Jazykové sady pro tato národní prostředí nemusí být v počítači nainstalované.

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

Save-Help mohou stáhnout soubory nápovědy pro moduly v různých jazykových verzích uživatelského rozhraní pouze v případě, že vlastník modulu zpřístupní přeložené soubory na internetu.

Příklad 7: Uložení nápovědy více než jednou denně

Tento příkaz uloží nápovědu pro všechny moduly nainstalované v počítači. Příkaz určuje parametr Force přepsání pravidla, které brání rutině Save-Help stahovat nápovědu více než jednou v každém 24hodinovém období.

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

Parametr Force také přepíše omezení o velikosti 1 GB a obchází kontrolu verzí. Proto si můžete stáhnout soubory i v případě, že verze není novější než verze v cílové složce.

Příkaz používá rutinu Save-Help ke stažení a uložení souborů nápovědy do zadané složky. Parametr Force se vyžaduje, když potřebujete spustit příkaz Save-Help více než jednou denně.

Parametry

-Credential

Určuje přihlašovací údaje uživatele. Tato rutina spustí příkaz pomocí přihlašovacích údajů uživatele, který má oprávnění pro přístup k umístění systému souborů určenému parametrem DestinationPath. Tento parametr je platný pouze v případě, že se v příkazu použije parametr DestinationPath nebo LiteralPath.

Tento parametr umožňuje spouštět příkazy Save-Help, které na vzdálených počítačích používají parametr DestinationPath. Zadáním explicitních přihlašovacích údajů můžete příkaz spustit na vzdáleném počítači a přistupovat ke sdílené složce na třetím počítači, aniž by došlo k chybě odepření přístupu nebo k delegování přihlašovacích údajů pomocí ověřování CredSSP.

Zadejte uživatelské jméno, například User01 nebo Domain01\User01, nebo zadejte objekt PSCredential vygenerovaný rutinou Get-Credential. Pokud zadáte uživatelské jméno, zobrazí se výzva k zadání hesla.

Přihlašovací údaje jsou uloženy v objektu PSCredential a heslo je uloženo jako SecureString.

Poznámka:

Další informace o ochraně dat SecureString najdete v tématu Jak zabezpečený je SecureString?.

Vlastnosti parametru

Typ:	PSCredential
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-DestinationPath

Určuje cestu ke složce, do které jsou uloženy soubory nápovědy. Nezadávejte název souboru ani příponu názvu souboru.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	Cesta

Sady parametrů

Path

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Force

Označuje, že tato rutina neodpovídá omezení jednou za den, přeskočí kontrolu verzí a stáhne soubory, které překračují limit 1 GB.

Bez tohoto parametru je v každém 24hodinovém období povolen pouze jeden příkaz Save-Help pro každý modul, stahování je omezené na 1 GB nekomprimovaného obsahu na modul a soubory nápovědy pro modul se nainstalují jenom v případě, že jsou novější než soubory v počítači.

Omezení jednou za den chrání servery, které hostují soubory nápovědy, a umožňuje vám přidat Save-Help příkaz do profilu PowerShellu.

Pokud chcete uložit nápovědu pro modul ve více jazykových verzích uživatelského rozhraní bez parametru Force, zahrňte všechny jazykové verze uživatelského rozhraní do stejného příkazu, například: Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-FullyQualifiedModule

Hodnota může být název modulu, úplná specifikace modulu nebo cesta k souboru modulu.

Pokud je hodnota cesta, může být cesta plně kvalifikovaná nebo relativní. Relativní cesta je vyřešena vzhledem ke skriptu, který obsahuje příkaz using.

Pokud je hodnota název nebo specifikace modulu, PowerShell prohledá PSModulePath zadaného modulu.

Specifikace modulu je hashovatelná tabulka s následujícími klíči.

• ModuleName - Povinný Určuje název modulu.
• GUID - Volitelné Určuje identifikátor GUID modulu.
• Je také Povinné zadat aspoň jeden z následujících tří klíčů.
  • ModuleVersion – Určuje minimální přijatelnou verzi modulu.
  • MaximumVersion – Určuje maximální přijatelnou verzi modulu.
  • RequiredVersion – Určuje přesnou požadovanou verzi modulu. Tuto možnost nelze použít s jinými klíči verze.

Parametr FullyQualifiedMod ule nemůžete zadat ve stejném příkazu jako parametr Module. oba parametry se vzájemně vylučují.

Vlastnosti parametru

Typ:	ModuleSpecification[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-LiteralPath

Určuje cestu cílové složky. Na rozdíl od hodnoty parametru DestinationPath se hodnota parametru LiteralPath použije přesně tak, jak je zadaný. Žádné znaky nejsou interpretovány jako zástupné znaky. Pokud cesta obsahuje únikové znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají PowerShellu, aby žádné znaky neinterpretoval jako únikové sekvence.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	PSPath, PO

Sady parametrů

LiteralPath

Position:	Named
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Module

Určuje moduly, pro které tato rutina stáhne nápovědu. Do seznamu odděleného čárkami nebo do souboru, který má na každém řádku jeden název modulu, zadejte jeden nebo více názvů modulů nebo vzorů názvů. Jsou povoleny zástupné znaky. Objekty modulu můžete také kanálovat z rutiny Get-Module do Save-Help.

Ve výchozím nastavení Save-Help nápovědu ke stažení pro všechny moduly, které podporují aktualizovatelnou nápovědu a jsou nainstalované v místním počítači v umístění uvedeném v proměnné prostředí PSModule Path.

Pokud chcete uložit nápovědu pro moduly, které nejsou nainstalované v počítači, spusťte na vzdáleném počítači příkaz Get-Module. Potom předejte výsledné objekty modulu do rutiny Save-Help nebo odešlete objekty modulu jako hodnotu Module nebo InputObject parametry.

Pokud je zadaný modul nainstalovaný v počítači, můžete zadat název modulu nebo objekt modulu. Pokud modul není v počítači nainstalovaný, musíte zadat objekt modulu, například objekt vrácený rutinou Get-Module.

Parametr Module rutiny Save-Help nepřijímá úplnou cestu k souboru modulu nebo souboru manifestu modulu. Chcete-li uložit nápovědu pro modul, který není v PSModulePath umístění, importujte modul do aktuální relace před spuštěním příkazu Save-Help.

Hodnota "*" (všechny) se pokusí aktualizovat nápovědu pro všechny moduly nainstalované v počítači. To zahrnuje moduly, které nepodporují aktualizovatelnou nápovědu. Tato hodnota může generovat chyby, když příkaz narazí na moduly, které nepodporují aktualizovatelnou nápovědu.

Vlastnosti parametru

Typ:	PSModuleInfo[]
Default value:	None
Podporuje zástupné znaky:	True
DontShow:	False
Aliasy:	Název

Sady parametrů

(All)

Position:	1
Povinné:	False
Hodnota z kanálu:	True
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-Scope

Tento parametr v této rutině nedělá nic.

Vlastnosti parametru

Typ:	UpdateHelpScope
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	True
Hodnota ze zbývajících argumentů:	False

-UICulture

Určuje hodnoty jazykové verze uživatelského rozhraní, pro které tato rutina získá aktualizované soubory nápovědy. Zadejte jeden nebo více kódů jazyka, například es-ES, proměnnou obsahující objekty jazykové verze nebo příkaz, který získává objekty jazykové verze, například Get-Culture nebo Get-UICulture příkaz. Zástupné znaky nejsou povolené.

Ve výchozím nastavení Save-Help získá soubory nápovědy v sadě jazykové verze uživatelského rozhraní pro operační systém nebo jeho záložní jazykovou verzi. Pokud zadáte parametr UICulture, Save-Help hledá nápovědu jenom pro zadaný jazyk.

Počínaje PowerShellem 7.4 můžete použít částečný kód jazyka, například en ke stažení nápovědy v angličtině pro libovolnou oblast.

Vlastnosti parametru

Typ:	CultureInfo[]
Default value:	Current UI culture
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	2
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-UseDefaultCredentials

Označuje, že tato rutina spustí příkaz, včetně stahování webu, s přihlašovacími údaji aktuálního uživatele. Ve výchozím nastavení se příkaz spustí bez explicitních přihlašovacích údajů.

Tento parametr je efektivní pouze v případě, že stahování webu používá ověřování založené na protokolu NTLM, negotiate nebo Kerberos.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

PSModuleInfo

Objekt modulu můžete do této rutiny převést.

Výstupy

None

Tento cmdlet nevrátí žádný výstup.

Poznámky

• Pokud chcete uložit nápovědu pro moduly ve složce $PSHOME\Modules, spusťte PowerShell pomocí možnosti Spustit jako správce. Nápovědu k modulům ve složce $PSHOME\Modules můžou stáhnout jenom členové skupiny Administrators v počítači.
• Uložená nápověda pro každý modul se skládá z jednoho souboru nápovědy (HelpInfo XML) a jednoho souboru CAB (.cab) pro soubory nápovědy každé jazykové verze uživatelského rozhraní. Soubory nápovědy nemusíte extrahovat ze souboru CAB. Rutina Update-Help extrahuje soubory nápovědy, ověří KÓD XML a pak nainstaluje soubory nápovědy a informační soubor nápovědy do podsložky modulu specifické pro jazyk.
• Rutina Save-Help může uložit nápovědu pro moduly, které nejsou nainstalované v počítači. Protože jsou ale soubory nápovědy nainstalované ve složce modulu, může rutina Update-Help nainstalovat aktualizovaný soubor nápovědy jenom pro moduly nainstalované v počítači.
• Pokud Save-Help nemůže najít aktualizované soubory nápovědy pro modul nebo nemůžete najít aktualizované soubory nápovědy v zadaném jazyce, bude bezobslužná bez zobrazení chybové zprávy. Pokud chcete zjistit, které soubory příkaz uložil, zadejte parametr Podrobné.
• Moduly jsou nejmenší jednotkou aktualizovatelné nápovědy. Nápovědu pro konkrétní rutinu nemůžete uložit, jenom pro všechny rutiny v modulu. Pokud chcete najít modul, který obsahuje konkrétní rutinu, použijte vlastnost ModuleName společně s rutinou Get-Command, například (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help podporuje všechny moduly a základní moduly modulu snap-in PowerShellu. Nepodporuje žádné další moduly snap-in.
• Rutiny Update-Help a Save-Help používají následující porty ke stažení souborů nápovědy: Port 80 pro HTTP a port 443 pro HTTPS.
• Rutiny příkazů Update-Help a Save-Help nejsou podporovány v prostředí Windows Preinstallation Environment (Windows PE).

Související odkazy

• Získat nápovědu
• Get-Module
• Aktualizace nápovědy