Update-Help
Stáhne a nainstaluje nejnovější soubory nápovědy do počítače.
Syntax
Path (Výchozí)
Update-Help
[[-Module] <String[]>]
[[-SourcePath] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Update-Help
[[-Module] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Rutina Update-Help stáhne nejnovější soubory nápovědy pro moduly PowerShellu a nainstaluje je do počítače. Aby se změna projevila, nemusíte restartovat PowerShell. K okamžitému zobrazení nových souborů nápovědy můžete použít rutinu Get-Help.
Update-Help zkontroluje verzi souborů nápovědy v počítači. Pokud nemáte soubory nápovědy pro modul nebo pokud jsou vaše soubory nápovědy zastaralé, Update-Help stáhne nejnovější soubory nápovědy. Soubory nápovědy je možné stáhnout a nainstalovat z internetu nebo ze sdílené složky.
Bez parametrů Update-Help aktualizovat soubory nápovědy pro moduly v relaci a pro všechny nainstalované moduly, které podporují aktualizovatelnou nápovědu. Zahrnuté jsou moduly, které jsou nainstalovány, ale nenačtou se v aktuální relaci. Moduly PowerShellu se ukládají do umístění uvedeného v proměnné prostředí $env:PSModulePath.
Další informace najdete v tématu about_Updatable_Help.
K aktualizaci souborů nápovědy pro konkrétní modul můžete použít parametr modulu. Pomocí parametru UICulture stáhněte soubory nápovědy ve více jazycích a národních prostředích.
Update-Help můžete použít na počítačích, které nejsou připojené k internetu. Pomocí rutiny Save-Help stáhněte soubory nápovědy z internetu a uložte je do umístění systému souborů, jako je sdílená složka nebo adresář systému souborů. Potom pomocí parametru SourcePathUpdate-Help stáhněte aktualizované soubory nápovědy z umístění systému souborů a nainstalujte je do počítače.
Aktualizace nápovědy můžete automatizovat přidáním rutiny Update-Help do profilu PowerShellu. Ve výchozím nastavení Update-Help na každém počítači běží jenom jednou denně. K přepsání limitu jednou za den použijte parametr Force.
Rutina Update-Help byla zavedena ve Windows PowerShellu 3.0.
Důležité
Update-Help vyžaduje oprávnění správce.
Abyste mohli aktualizovat soubory nápovědy pro moduly PowerShell Core, musíte být členem skupiny Administrators na počítači.
Pokud chcete stáhnout nebo aktualizovat soubory nápovědy pro moduly v instalačním adresáři PowerShellu ($PSHOME\Modules), včetně modulů PowerShell Core, spusťte PowerShell pomocí možnosti Spustit jako správce.
Například: Start-Process powershell.exe -Verb RunAs.
Soubory nápovědy můžete aktualizovat také pomocí položky nabídky Aktualizovat nápovědu prostředí Windows PowerShell v nabídce Nápověda v integrovaném skriptovacím prostředí Windows PowerShellu (ISE).
Položka nápovědy k aktualizaci Windows PowerShellu spustí rutinu Update-Help bez parametrů.
Pokud chcete aktualizovat nápovědu pro moduly v adresáři $PSHOME, spusťte prostředí Windows PowerShell ISE pomocí možnosti Spustit jako správce.
Příklady
Příklad 1: Aktualizace souborů nápovědy pro všechny moduly
Rutina Update-Help aktualizuje soubory nápovědy pro nainstalované moduly, které podporují aktualizovatelnou nápovědu. Jazyk jazykové verze uživatelského rozhraní je nastavený v operačním systému.
Update-Help
Příklad 2: Aktualizace souborů nápovědy pro zadané moduly
Aktualizace Update-Help rutiny aktualizují soubory nápovědy pouze pro názvy modulů, které začínají Microsoft.PowerShell.
Update-Help -Module Microsoft.PowerShell*
Příklad 3: Aktualizace souborů nápovědy pro různé jazyky
Rutina Update-Help aktualizuje soubory nápovědy pro všechny moduly v japonštině (ja-JP) a angličtině (en-US).
Pokud modul neposkytuje soubory nápovědy pro zadanou jazykovou verzi uživatelského rozhraní, zobrazí se chybová zpráva pro modul a jazykovou verzi uživatelského rozhraní. V tomto příkladu chybová zpráva indikuje, že ja-JP soubory nápovědy nebyly nalezeny pro modul Microsoft.PowerShell.Utility.
Update-Help -UICulture ja-JP, en-US
Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.
Příklad 4: Automatické aktualizace souborů nápovědy
Tento příklad vytvoří naplánovanou úlohu, která aktualizuje nápovědu pro všechny moduly každý den v 3:00.
$jobParams = @{
Name = 'UpdateHelpJob'
Credential = 'Domain01\User01'
ScriptBlock = '{Update-Help}'
Trigger = (New-JobTrigger -Daily -At "3 AM")
}
Register-ScheduledJob @jobParams
Id Name JobTriggers Command Enabled
-- ---- ----------- ------- -------
1 UpdateHelpJob 1 Update-Help True
Rutina Register-ScheduledJob vytvoří naplánovanou úlohu, která spustí příkaz Update-Help. Příkaz používá parametr přihlašovacích údajů ke spuštění Update-Help pomocí přihlašovacích údajů člena skupiny Administrators v počítači. Hodnota parametru Trigger je New-JobTrigger příkaz, který vytvoří aktivační událost úlohy, která spustí úlohu každý den v 3:00.
Pokud chcete spustit příkaz Register-ScheduledJob, spusťte PowerShell pomocí možnosti Spustit jako správce. PowerShell vás vyzve k zadání hesla uživatele zadaného v parametru credential. Přihlašovací údaje se ukládají s naplánovanou úlohou. Po spuštění úlohy se nezobrazí výzva.
Pomocí rutiny Get-ScheduledJob můžete zobrazit naplánovanou úlohu, změnit ji pomocí rutiny Set-ScheduledJob a pomocí rutiny Unregister-ScheduledJob ji odstranit. Naplánovanou úlohu můžete také zobrazit a spravovat v Plánovači úloh v následující cestě:
Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.
Příklad 5: Aktualizace souborů nápovědy na více počítačích ze sdílené složky
V tomto příkladu se aktualizované soubory nápovědy stáhnou z internetu a uloží se do sdílené složky. Pro přístup ke sdílené složce a instalaci aktualizací jsou potřeba přihlašovací údaje uživatele. Při použití sdílené složky je možné aktualizovat počítače, které jsou za branami firewall nebo nejsou připojené k internetu.
PS> Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
PS> Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}
Příkaz Save-Help stáhne nejnovější soubory nápovědy pro všechny moduly, které podporují aktualizovatelnou nápovědu.
Parametr DestinationPath uloží soubory do sdílené složky \\Server01\Share\PSHelp. Parametr přihlašovacích údajů určuje uživatele, který má oprávnění pro přístup ke sdílené složce.
Rutina Invoke-Command spouští příkazy vzdáleného Update-Help na více počítačích. Parametr ComputerName získá seznam vzdálených počítačů ze souboru Servers.txt. Parametr ScriptBlock spustí příkaz Update-Help a pomocí parametru SourcePath určí sdílenou složku, která obsahuje aktualizované soubory nápovědy. Parametr přihlašovacích údajů určuje uživatele, který má přístup ke sdílené složce, a spustí vzdálený příkaz Update-Help.
Příklad 6: Získání seznamu aktualizovaných souborů nápovědy
Nápovědu k aktualizaci rutiny Update-Help pro zadaný modul. Rutina používá podrobný společný parametr k zobrazení seznamu souborů nápovědy, které byly aktualizovány. K zobrazení výstupu pro všechny soubory nápovědy nebo soubory nápovědy pro konkrétní modul můžete použít podrobné.
Bez parametru PodrobnéUpdate-Help nezobrazí výsledky příkazu. Výstup parametru Podrobné je užitečný k ověření, jestli byly soubory nápovědy aktualizovány nebo jestli je nainstalovaná nejnovější verze.
Update-Help -Module Microsoft.PowerShell.Utility -Verbose
Příklad 7: Vyhledání modulů, které podporují aktualizovatelnou nápovědu
Tento příklad uvádí moduly, které podporují aktualizovatelnou nápovědu. Příkaz používá vlastnost HelpInfoUri modulu k identifikaci modulů, které podporují aktualizovatelnou nápovědu. Vlastnost HelpInfoUri obsahuje adresu, která je při spuštění rutiny Update-Help přesměrována.
Get-Module -ListAvailable | Where-Object -Property HelpInfoUri
Directory: C:\program files\powershell\6\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 6.1.0.0 CimCmdlets Core {Get-CimAssociatedInstance... }
Manifest 1.2.2.0 Microsoft.PowerShell.Archive Desk {Compress-Archive... }
Manifest 6.1.0.0 Microsoft.PowerShell.Diagnostics Core {Get-WinEvent, New-WinEvent}
Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 2.0.1.0 Appx Core,Desk {Add-AppxPackage, ... }
Script 1.0.0.0 AssignedAccess Core,Desk {Clear-AssignedAccess, ... }
Manifest 1.0.0.0 BitLocker Core,Desk {Unlock-BitLocker, ... }
Příklad 8: Inventarizace aktualizovaných souborů nápovědy
V tomto příkladu skript Get-UpdateHelpVersion.ps1 vytvoří inventář souborů aktualizovatelné nápovědy pro každý modul a jejich čísla verzí.
Skript identifikuje moduly, které podporují aktualizovatelnou nápovědu pomocí HelpInfoUri vlastnost modulů. Pro moduly, které podporují aktualizovatelnou nápovědu, skript vyhledá a parsuje informační soubor nápovědy (*helpinfo.xml) a vyhledá číslo nejnovější verze.
Skript používá PSCustomObject třídu a tabulku hash k vytvoření vlastního výstupního objektu.
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='https://schemas.microsoft.com/powershell/help/2010/05'}
if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }
foreach ($mModule in $Modules)
{
$mDir = $mModule.ModuleBase
if (Test-Path $mdir\*helpinfo.xml)
{
$mName=$mModule.Name
$mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
foreach ($mNode in $mNodes)
{
$mCulture=$mNode.Node.UICultureName
$mVer=$mNode.Node.UICultureVersion
[PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
}
}
}
ModuleName Culture Version
---------- ------- -------
ActiveDirectory en-US 3.0.0.0
ADCSAdministration en-US 3.0.0.0
ADCSDeployment en-US 3.0.0.0
ADDSDeployment en-US 3.0.0.0
ADFS en-US 3.0.0.0
Parametry
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
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 |
-Credential
Určuje pověření uživatele, který má oprávnění pro přístup k umístění systému souborů určené SourcePath. Tento parametr je platný pouze v případě, že se v příkazu použije parametr SourcePath nebo LiteralPath.
Parametr přihlašovacích údajů
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 |
-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 se Update-Help spustí pouze jednou za každé 24hodinové období. Soubory ke stažení jsou omezené na 1 GB nekomprimovaného obsahu na jeden modul a soubory nápovědy se nainstalují jenom v novějších verzích než existující soubory v počítači.
Limit jednou za den chrání servery, které hostují soubory nápovědy, a umožňuje vám přidat do profilu PowerShellu Update-Help příkaz, aniž by se vám zabíjely náklady na prostředky opakovaných připojení nebo stahování.
Pokud chcete aktualizovat 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:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
Vlastnosti parametru
| Typ: | SwitchParameter |
| 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 |
-FullyQualifiedModule
Určuje moduly s názvy, které jsou určeny ve formě ModuleSpecification objekty. Tyto moduly jsou popsány v části Poznámky ModuleSpecification Konstruktor (Hashtable).
Například parametr FullyQualifiedModule přijímá název modulu zadaný ve formátu:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
nebo
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName a ModuleVersion jsou povinné, ale identifikátor GUID je volitelný.
Parametr FullyQualifiedMod ule nemůžete zadat ve stejném příkazu jako parametr Module.
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 složku pro aktualizované soubory nápovědy místo jejich stahování z internetu. Tento parametr nebo SourcePath použijte, pokud jste ke stažení souborů nápovědy do adresáře použili rutinu Save-Help.
Objekt adresáře, například z rutin Get-Item nebo Get-ChildItem, můžete vytvořit kanál pro Update-Help.
Na rozdíl od hodnoty SourcePathse hodnota LiterálPath používá přesně tak, jak je zadána. Žá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 |
Sady parametrů
LiteralPath
| 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 |
-Module
Aktualizuje nápovědu pro zadané moduly. Zadejte jeden nebo více názvů modulů nebo vzorů názvů v seznamu odděleném čárkami nebo zadejte soubor, který obsahuje jeden název modulu na každém řádku. Jsou povoleny zástupné znaky. Moduly můžete kanálovat z rutiny Get-Module do rutiny Update-Help.
Zadané moduly musí být nainstalovány v počítači, ale nemusí být importovány do aktuální relace. Můžete zadat libovolný modul v relaci nebo jakýkoli modul, který je nainstalovaný v umístění uvedeném v proměnné prostředí $env:PSModulePath.
Hodnota * (všechny) pokusy o aktualizaci nápovědy pro všechny moduly nainstalované v počítači.
Součástí jsou 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. Místo toho spusťte Update-Help bez parametrů.
Parametr Module rutiny Update-Help nepřijímá úplnou cestu k souboru modulu nebo souboru manifestu modulu. Pokud chcete aktualizovat nápovědu pro modul, který není v $env:PSModulePath umístění, importujte modul do aktuální relace před spuštěním příkazu Update-Help.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | True |
| DontShow: | False |
| Aliasy: | Název |
Sady parametrů
(All)
| Position: | 0 |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Recurse
Provede rekurzivní vyhledávání souborů nápovědy v zadaném adresáři. Tento parametr je platný pouze v případě, že příkaz používá parametr SourcePath.
Vlastnosti parametru
| Typ: | SwitchParameter |
| 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 |
-SourcePath
Určuje složku systému souborů, kde Update-Help získá aktualizované soubory nápovědy místo jejich stahování z internetu. Zadejte cestu ke složce. Nezadávejte název souboru ani příponu názvu souboru. Do Get-Itemmůžete vytvořit kanál složky, například složku z Get-ChildItem nebo rutin Update-Help .
Ve výchozím nastavení Update-Help stáhne aktualizované soubory nápovědy z internetu. Pokud jste k stažení aktualizovaných souborů nápovědy do adresáře použili rutinu , použijte Save-Help SourcePath.
Chcete-li zadat výchozí hodnotuUpdate-Help ke stahování souborů nápovědy z internetu.
Další informace naleznete v části about_Group_Policy_Settings.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
Path
| Position: | 1 |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-UICulture
Určuje hodnoty jazykové verze uživatelského rozhraní, které Update-Help používá k získání aktualizovaných souborů 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é a nemůžete odeslat částečný kód jazyka, například de.
Ve výchozím nastavení Update-Help získá soubory nápovědy v sadě jazykové verze uživatelského rozhraní pro operační systém. Pokud zadáte parametr UICulture, Update-Help hledá nápovědu pouze pro zadanou jazykovou verzi uživatelského rozhraní.
Příkazy, které používají parametr UICulture úspěch pouze v případě, že modul poskytuje soubory nápovědy pro zadanou jazykovou verzi uživatelského rozhraní. Pokud příkaz selže, protože zadaná jazyková verze uživatelského rozhraní není podporovaná, zobrazí se chybová zpráva.
Vlastnosti parametru
| Typ: | CultureInfo[] |
| Default value: | None |
| 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 Update-Help spustí příkaz, včetně stahování z internetu, pomocí přihlašovacích údajů 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á protokol NT LAN Manager (NTLM), vyjednávat nebo ověřování založené na protokolu Kerberos.
Vlastnosti parametru
| Typ: | SwitchParameter |
| 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 |
-WhatIf
Ukazuje, co se stane, když se příkaz spustí. Cmdlet se nespustil.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
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
DirectoryInfo
Cestu k adresáři můžete převést na Update-Help.
PSModuleInfo
Objekt modulu můžete převést z rutiny Get-Module do Update-Help.
Výstupy
None
Update-Help nevygeneruje žádný výstup.
Poznámky
Pokud chcete aktualizovat nápovědu k modulům PowerShell Core, které obsahují příkazy nainstalované pomocí PowerShellu nebo libovolného modulu v adresáři $PSHOME\Modules, spusťte PowerShell s možností Spustit jako správce.
Nápovědu pro moduly PowerShell Core, příkazy nainstalované společně s PowerShellem a moduly ve složce $PSHOME\Modules můžou aktualizovat jenom členové skupiny Administrators v počítači. Pokud nemáte oprávnění k aktualizaci souborů nápovědy, můžete si přečíst soubory nápovědy online. Například: Get-Help Update-Help -Online.
Moduly jsou nejmenší jednotkou aktualizovatelné nápovědy. Nápovědu pro konkrétní rutinu nejde aktualizovat. Pokud chcete najít modul obsahující konkrétní rutinu, použijte vlastnost ModuleName rutiny Get-Command, například (Get-Command Update-Help).ModuleName.
Protože soubory nápovědy jsou nainstalovány v adresáři modulu, může rutina Update-Help nainstalovat aktualizovaný soubor nápovědy pouze pro moduly nainstalované v počítači. Rutina Save-Help ale může uložit nápovědu pro moduly, které nejsou nainstalované v počítači.
Pokud Update-Help nemůže najít aktualizované soubory nápovědy pro modul nebo nemůže najít aktualizovanou nápovědu v zadaném jazyce, zůstane bezobslužná bez zobrazení chybové zprávy. Pokud chcete zobrazit podrobnosti o stavu a průběhu, použijte parametr Podrobné.
Rutina Update-Help byla zavedena ve Windows PowerShellu 3.0. V dřívějších verzích Windows PowerShellu nefunguje. Na počítačích s Windows PowerShellem 2.0 i Windows PowerShellem 3.0 použijte rutinu Update-Help v relaci Windows PowerShellu 3.0 ke stažení a aktualizaci souborů nápovědy. Soubory nápovědy jsou k dispozici pro Windows PowerShell 2.0 i Windows PowerShell 3.0.
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.
Update-Help podporuje všechny moduly a moduly snap-in PowerShell Core. Nepodporuje žádné další moduly snap-in.
Pokud chcete aktualizovat nápovědu pro modul v umístění, které není uvedené v proměnné prostředí $env:PSModulePath, naimportujte modul do aktuální relace a spusťte příkaz Update-Help. Spusťte
Jakýkoli modul může podporovat aktualizovatelnou nápovědu. Pokyny pro podporu aktualizovatelné nápovědy v modulech, které vytvoříte, najdete v tématu Podpora aktualizovatelné nápovědy.
Rutiny Update-Help a Save-Help nejsou podporovány v prostředí Windows Preinstallation Environment (Windows PE).