Update-Help
Laddar ned och installerar de senaste hjälpfilerna på datorn.
Syntax
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
Cmdleten Update-Help laddar ned de senaste hjälpfilerna för PowerShell-moduler och installerar dem på datorn. Du behöver inte starta om PowerShell för att ändringen ska gälla. Du kan använda cmdleten Get-Help för att visa de nya hjälpfilerna omedelbart.
Update-Help kontrollerar versionen av hjälpfilerna på datorn. Om du inte har hjälpfiler för en modul eller om dina hjälpfiler är inaktuella laddar Update-Help du ned de senaste hjälpfilerna. Hjälpfilerna kan laddas ned och installeras från Internet eller en filresurs.
Utan parametrar Update-Help uppdaterar hjälpfilerna för moduler i sessionen och för alla installerade moduler som stöder uppdateringsbar hjälp. Moduler som installeras men inte läses in i den aktuella sessionen ingår. PowerShell-moduler lagras på en plats som anges i $env:PSModulePath miljövariabeln. Mer information finns i about_Updatable_Help.
Du kan använda modulparametern för att uppdatera hjälpfiler för en viss modul. Använd parametern UICulture för att ladda ned hjälpfiler på flera språk och nationella inställningar.
Du kan också använda Update-Help på datorer som inte är anslutna till Internet. Använd först cmdleten Save-Helpför att ladda ned hjälpfiler från Internet och spara dem i en delad mapp som är tillgänglig för systemet som inte är anslutet till Internet. Använd sedan SourcePath-parameternUpdate-Help för för att ladda ned de uppdaterade hjälpfilerna från den delade och installera dem på datorn.
Du kan automatisera hjälpuppdateringar genom att lägga till cmdleten i Update-Help din PowerShell-profil. Som standard Update-Help körs bara en gång per dag på varje dator. Om du vill åsidosätta gränsen en gång per dag använder du parametern Force .
Cmdleten Update-Help introducerades i Windows PowerShell 3.0.
Viktigt
Update-Help kräver administratörsbehörighet i PowerShell 6.0 och lägre.
PowerShell 6.1 och senare anger standardomfånget till CurrentUser.
Före PowerShell 6.1 var parametern Scope inte tillgänglig.
Du måste vara medlem i gruppen Administratörer på datorn för att kunna uppdatera hjälpfilerna för PowerShell Core-modulerna.
Om du vill ladda ned eller uppdatera hjälpfilerna för moduler i PowerShell-installationskatalogen ($PSHOME\Modules), inklusive PowerShell Core-modulerna, startar du PowerShell med alternativet Kör som administratör .
Exempel: Start-Process pwsh.exe -Verb RunAs.
Exempel
Exempel 1: Uppdatera hjälpfiler för alla moduler
Cmdleten Update-Help uppdaterar hjälpfilerna för installerade moduler som stöder uppdateringsbar hjälp. Kulturspråket användargränssnitt (UI) anges i operativsystemet.
Update-HelpExempel 2: Uppdatera hjälpfiler för angivna moduler
Cmdleten Update-Help uppdaterar endast hjälpfiler för modulnamn som börjar med Microsoft.PowerShell.
Update-Help -Module Microsoft.PowerShell*Exempel 3: Uppdatera hjälpfiler för olika språk
Cmdleten Update-Help uppdaterar hjälpfilerna japanska (ja-JP) och engelska (en-US) för alla moduler.
Om en modul inte tillhandahåller hjälpfiler för en angiven UI-kultur visas ett felmeddelande för modulen och användargränssnittskulturen. I det här exemplet anger felmeddelandet att ja-JP-hjälpfilerna inte hittades för modulen 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.Exempel 4: Uppdatera hjälpfiler på flera datorer från en filresurs
I det här exemplet laddas uppdaterade hjälpfiler ned från Internet och sparas i en filresurs. Användarautentiseringsuppgifter krävs som har behörighet att komma åt filresursen och installera uppdateringar. När en filresurs används går det att uppdatera datorer som finns bakom brandväggar eller som inte är anslutna till Internet.
Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}Kommandot Save-Help hämtar de senaste hjälpfilerna för alla moduler som stöder uppdateringsbar hjälp.
Parametern DestinationPath sparar filerna i filresursen\\Server01\Share\PSHelp. Parametern Credential anger en användare som har behörighet att komma åt filresursen.
Cmdleten Invoke-Command kör fjärrkommandon Update-Help på flera datorer. Parametern ComputerName hämtar en lista över fjärrdatorer från Servers.txt-filen . Parametern ScriptBlock kör Update-Help kommandot och använder SourcePath-parametern för att ange den filresurs som innehåller de uppdaterade hjälpfilerna. Parametern Credential anger en användare som kan komma åt filresursen och köra fjärrkommandot Update-Help .
Exempel 5: Hämta en lista över uppdaterade hjälpfiler
Cmdleten Update-Help uppdaterar hjälpen för en angiven modul. Cmdleten använder den utförliga gemensamma parametern för att visa listan över hjälpfiler som har uppdaterats. Du kan använda Utförlig för att visa utdata för alla hjälpfiler eller hjälpfiler för en specifik modul.
Utan den utförliga parametern Update-Help visar inte kommandots resultat. Utförliga parameterutdata är användbara för att verifiera att hjälpfilerna har uppdaterats eller om den senaste versionen har installerats.
Update-Help -Module Microsoft.PowerShell.Utility -VerboseExempel 6: Hitta moduler som stöder uppdateringsbar hjälp
I det här exemplet visas moduler som stöder uppdateringsbar hjälp. Kommandot använder modulens HelpInfoUri-egenskap för att identifiera moduler som stöder uppdateringsbar hjälp. Egenskapen HelpInfoUri innehåller en adress som omdirigeras när cmdleten Update-Help körs.
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, ... }Exempel 7: Inventering uppdaterade hjälpfiler
I det här exemplet skapar skriptet Get-UpdateHelpVersion.ps1 en inventering av uppdateringsbara hjälpfiler för varje modul och deras versionsnummer.
Skriptet identifierar moduler som stöder uppdateringsbar hjälp med hjälp av egenskapen HelpInfoUri för moduler. För moduler som stöder uppdateringsbar hjälp söker skriptet efter och parsar hjälpinformationsfilen (*helpinfo.xml) för att hitta det senaste versionsnumret.
Skriptet använder klassen PSCustomObject och en hash-tabell för att skapa ett anpassat utdataobjekt.
# 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.0Parametrar
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Anger autentiseringsuppgifter för en användare som har behörighet att komma åt filsystemplatsen som anges av SourcePath. Den här parametern är endast giltig när parametern SourcePath eller LiteralPath används i kommandot .
Med parametern Credential kan du köra Update-Help kommandon med parametern SourcePath på fjärrdatorer. Genom att ange explicita autentiseringsuppgifter kan du köra kommandot på en fjärrdator och komma åt en filresurs på en tredje dator utan att stöta på ett felmeddelande om nekad åtkomst eller använda CredSSP-autentisering för att delegera autentiseringsuppgifter.
Ange ett användarnamn, till exempel User01 eller Domain01\User01, eller ange ett PSCredential-objekt som genereras av cmdleten Get-Credential . Om du skriver ett användarnamn uppmanas du att ange lösenordet.
Autentiseringsuppgifter lagras i ett PSCredential-objekt och lösenordet lagras som en SecureString.
Anteckning
Mer information om SecureString-dataskydd finns i Hur säker är SecureString?.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Anger att den här cmdleten inte följer begränsningen en gång per dag, hoppar över versionskontroll och laddar ned filer som överskrider gränsen på 1 GB.
Utan den här parametern Update-Help körs bara en gång under varje 24-timmarsperiod. Nedladdningar är begränsade till 1 GB okomprimerat innehåll per modul och hjälpfiler installeras bara när de är nyare än de befintliga filerna på datorn.
Gränsen en gång per dag skyddar de servrar som är värdar för hjälpfilerna och gör det praktiskt att lägga till ett Update-Help kommando i PowerShell-profilen utan att behöva debiteras resurskostnaden för upprepade anslutningar eller nedladdningar.
Om du vill uppdatera hjälpen för en modul i flera gränssnittskulturer utan force-parametern inkluderar du alla gränssnittskulturer i samma kommando, till exempel:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullyQualifiedModule
Anger moduler med namn som anges i form av ModuleSpecification-objekt . Dessa moduler beskrivs i avsnittet Anmärkningar i ModuleSpecification Constructor (Hashtable).
Parametern FullyQualifiedModule accepterar till exempel ett modulnamn som anges i formatet:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
eller
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName och ModuleVersion krävs, men Guid är valfritt.
Du kan inte ange parametern FullyQualifiedModule i samma kommando som en modulparameter .
| Type: | ModuleSpecification[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LiteralPath
Anger mappen för uppdaterade hjälpfiler i stället för att ladda ned dem från Internet. Använd den här parametern eller SourcePath om du har använt cmdleten Save-Help för att ladda ned hjälpfiler till en katalog.
Du kan pipelinesa ett katalogobjekt, till exempel från Get-Item cmdletarna eller Get-ChildItem till Update-Help.
Till skillnad från värdet för SourcePath används värdet för LiteralPath exakt som det skrivs. Inga tecken tolkas som jokertecken. Om sökvägen innehåller escape-tecken omger du den inom enkla citattecken. Enkla citattecken säger till PowerShell att inte tolka några tecken som escape-sekvenser.
| Type: | String[] |
| Aliases: | PSPath, LP |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Module
Uppdateringar hjälp för de angivna modulerna. Ange ett eller flera modulnamn eller namnmönster i en kommaavgränsad lista eller ange en fil som visar ett modulnamn på varje rad. Jokertecken tillåts. Du kan pipelinemoduler från cmdleten Get-Module till cmdleten Update-Help .
De moduler som du anger måste vara installerade på datorn, men de behöver inte importeras till den aktuella sessionen. Du kan ange valfri modul i sessionen eller valfri modul som är installerad på en plats som anges i $env:PSModulePath miljövariabeln.
* Värdet (alla) försöker uppdatera hjälpen för alla moduler som är installerade på datorn.
Moduler som inte stöder uppdateringsbar hjälp ingår. Det här värdet kan generera fel när kommandot påträffar moduler som inte stöder uppdateringsbar hjälp. Kör Update-Help i stället utan parametrar.
Modulparametern för cmdleten Update-Help accepterar inte den fullständiga sökvägen till en modulfil eller modulmanifestfil. Om du vill uppdatera hjälpen för en modul som inte finns på en $env:PSModulePath plats importerar du modulen till den aktuella sessionen innan du kör Update-Help kommandot.
| Type: | String[] |
| Aliases: | Name |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Recurse
Utför en rekursiv sökning efter hjälpfiler i den angivna katalogen. Den här parametern är endast giltig när kommandot använder SourcePath-parametern .
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
Anger systemomfånget där hjälpen uppdateras. Uppdateringar i AllUsers-omfånget kräver administratörsbehörighet på Windows-system. Parametern -Scope introducerades i PowerShell Core version 6.1.
CurrentUser är standardomfånget för hjälpfiler i PowerShell 6.1 och senare. Allaanvändare kan anges för att installera eller uppdatera hjälp för alla användare. På Unix-systembehörigheter sudo krävs för att uppdatera hjälpen för alla användare. Exempelvis: sudo pwsh -c Update-Help
De godtagbara värdena är:
- CurrentUser
- AllUsers
| Type: | UpdateHelpScope |
| Position: | Named |
| Default value: | CurrentUser |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourcePath
Anger en filsystemmapp där Update-Help hämtar uppdaterade hjälpfiler i stället för att ladda ned dem från Internet. Ange sökvägen till en mapp. Ange inte ett filnamn eller filnamnstillägg. Du kan skapa en pipeline för en mapp, till exempel en från Get-Item cmdletarna eller Get-ChildItem till Update-Help.
Som standard Update-Help laddar ned uppdaterade hjälpfiler från Internet. Använd SourcePath när du har använt cmdleten Save-Help för att ladda ned uppdaterade hjälpfiler till en katalog.
Om du vill ange ett standardvärde för SourcePath går du till grupprincip, Datorkonfiguration och Anger standardsökvägen för Uppdateringshjälp. Den här inställningen grupprincip förhindrar användare från att använda Update-Help för att ladda ned hjälpfiler från Internet.
Mer information finns i about_Group_Policy_Settings.
| Type: | String[] |
| Aliases: | Path |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UICulture
Anger UI-kulturvärden som Update-Help används för att hämta uppdaterade hjälpfiler. Ange en eller flera språkkoder, till exempel es-ES, en variabel som innehåller kulturobjekt eller ett kommando som hämtar kulturobjekt, till exempel ett Get-Culture eller Get-UICulture ett kommando. Jokertecken tillåts inte och du kan inte skicka in en partiell språkkod, till exempel de.
Som standard Update-Help hämtar hjälpfiler i UI-kulturuppsättningen för operativsystemet. Om du anger parametern Update-HelpUICulture söker du bara efter hjälp för den angivna användargränssnittskulturen.
Anteckning
Ubuntu 18.04 ändrade standardinställningen för nationella inställningar till C.UTF.8, vilket inte är en erkänd användargränssnittskultur. Update-Help det går inte att ladda ned hjälpen tyst om du inte använder den här parametern med ett språk som stöds som en-US. Detta kan inträffa på alla plattformar som använder ett värde som inte stöds.
Kommandon som använder parametern UICulture lyckas bara när modulen innehåller hjälpfiler för den angivna användargränssnittskulturen. Om kommandot misslyckas på grund av att den angivna användargränssnittskulturen inte stöds visas ett felmeddelande.
| Type: | CultureInfo[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
Anger att Update-Help kör kommandot, inklusive internetnedladdningen, med hjälp av den aktuella användarens autentiseringsuppgifter. Som standard körs kommandot utan explicita autentiseringsuppgifter.
Den här parametern gäller endast när webbnedladdningen använder NT LAN Manager (NTLM), förhandlar eller Kerberos-baserad autentisering.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Indata
Du kan skicka en katalogsökväg till Update-Help.
Du kan skicka ett modulobjekt från cmdleten Get-Module till Update-Help.
Utdata
None
Update-Help genererar inga utdata.
Kommentarer
Om du vill uppdatera hjälpen för PowerShell Core-modulerna, som innehåller de kommandon som är installerade med PowerShell eller valfri modul i $PSHOME\Modules katalogen, startar du PowerShell med alternativet Kör som administratör.
Endast medlemmar i gruppen Administratörer på datorn kan uppdatera hjälpen för PowerShell Core-modulerna, de kommandon som installeras tillsammans med PowerShell och för moduler i $PSHOME\Modules mappen . Om du inte har behörighet att uppdatera hjälpfiler kan du läsa hjälpfilerna online. Till exempel Get-Help Update-Help -Online.
Moduler är den minsta enheten med uppdateringsbar hjälp. Du kan inte uppdatera hjälpen för en viss cmdlet. Om du vill hitta modulen som innehåller en viss cmdlet använder du egenskapen ModuleName för cmdleten Get-Command , (Get-Command Update-Help).ModuleNametill exempel .
Eftersom hjälpfiler installeras i modulkatalogen kan cmdleten Update-Help endast installera den uppdaterade hjälpfilen för moduler som är installerade på datorn. Cmdleten Save-Help kan dock spara hjälp för moduler som inte är installerade på datorn.
Om Update-Help det inte går att hitta uppdaterade hjälpfiler för en modul, eller om det inte går att hitta uppdaterad hjälp på det angivna språket, fortsätter den tyst utan att visa ett felmeddelande. Om du vill se status- och förloppsinformation använder du parametern Verbose .
Cmdleten Update-Help introducerades i Windows PowerShell 3.0. Det fungerar inte i tidigare versioner av PowerShell. På datorer som har både Windows PowerShell 2.0 och Windows PowerShell 3.0 använder du cmdleten Update-Help i en Windows PowerShell 3.0-session för att ladda ned och uppdatera hjälpfiler. Hjälpfilerna är tillgängliga för både Windows PowerShell 2.0 och Windows PowerShell 3.0.
Cmdletarna Update-Help och Save-Help använder följande portar för att ladda ned hjälpfiler: Port 80 för HTTP och port 443 för HTTPS.
Update-Help stöder alla moduler och PowerShell Core-snapin-moduler. Det stöder inte några andra snapin-moduler.
Om du vill uppdatera hjälpen för en modul på en plats som inte finns med i $env:PSModulePath miljövariabeln importerar du modulen till den aktuella sessionen och kör sedan ett Update-Help kommando. Kör Update-Help utan parametrar eller använd modulparametern för att ange modulnamnet. Modulparametern för Update-Help cmdletarna och Save-Help accepterar inte den fullständiga sökvägen till en modulfil eller modulmanifestfil.
Alla moduler har stöd för uppdateringsbar hjälp. Anvisningar för att stödja uppdateringsbar hjälp i de moduler som du skapar finns i Stöd för uppdateringsbar hjälp.
Update-Help Cmdletarna och Save-Help stöds inte i Windows Preinstallation Environment (Windows PE).