Update-Help

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.

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

Exempel 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 -Verbose

Exempel 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='http://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

Parametrar

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-Scope

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Indata

DirectoryInfo

Du kan skicka en katalogsökväg till Update-Help.

PSModuleInfo

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 de grundläggande PowerShell-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 de grundläggande PowerShell-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 kärn snapin-moduler för PowerShell. 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).

Relaterade länkar

• Get-Culture
• Get-Help
• Get-Module
• Get-UICulture
• Start-Job
• Save-Help