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 Update-Help laddar du ned de senaste hjälpfilerna. Hjälpfilerna kan laddas ned och installeras från Internet eller en filresurs.

Utan parametrar Update-Help uppdaterar du hjälpfilerna för moduler som stöder uppdateringsbar hjälp och läses in i sessionen eller installeras på en plats som ingår i $env:PSModulePath. Mer information finns i about_Updatable_Help.

Update-Help kontrollerar versionen av den installerade hjälpen. Om Update-Help det inte går att hitta uppdaterade hjälpfiler för en modul fortsätter den tyst utan att ett felmeddelande visas. Använd parametern Force för att hoppa över versionskontrollen. Använd parametern Verbose för att se status- och förloppsinformation. Använd modulparametern för att uppdatera hjälpfiler för en viss modul.

Du kan också använda Update-Help på datorer som inte är anslutna till Internet. Börja med att använda 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 ansluten till Internet. Använd sedan parametern Update-Help SourcePath för för att ladda ned de uppdaterade hjälpfilerna från den delade och installera dem på datorn.

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 för användargränssnittet (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älpen i ett system som inte är inställt på nationella inställningar för en-US

Cmdleten Update-Help är utformad för att ladda ned hjälp på flera språk. Men när det inte finns någon tillgänglig hjälp för det språk som systemet använder visas ett felmeddelande för modulen och användargränssnittskulturen.

I det här exemplet Update-Help körs på ett system som är inställt en-GB på nationella inställningar.

Update-Help Microsoft.PowerShell.Utility -Force

Update-Help: Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with
UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a culture
from the following list: {en-US}..
English-US help content is available and can be installed using: Update-Help -UICulture en-US.

Hjälpfilerna publiceras alltid för språkvarianten en-US . Om du vill ladda ned den engelska hjälpen kör Update-Help du med parametern UICulture och anger nationella en-US inställningar.

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 är det möjligt 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 laddar ned 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 parametern SourcePath för att ange filresursen 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 parametern Update-Help Verbose visas inte resultatet av kommandot. Utförliga parameterutdata är användbara för att kontrollera att hjälpfilerna har uppdaterats eller om den senaste versionen är installerad.

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 URL 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 updatable-hjälpfilerna 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 ett katalogsökvägsobjekt till den här cmdleten.

PSModuleInfo

Du kan skicka ett modulobjekt till den här cmdleten.

Utdata

None

Den här cmdleten returnerar 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, kommandona 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. Exempel: Get-Help Update-Help -Online

Moduler är den minsta enheten med uppdaterad 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 endast installera den Update-Help 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.

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 har stöd för alla moduler och de grundläggande PowerShell-snapin-modulerna. Det stöder inte 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 Update-Help för cmdletarna och Save-Help accepterar inte den fullständiga sökvägen för en modulfil eller modulmanifestfil.

Alla moduler har stöd för uppdateringsbar hjälp. Anvisningar för stöd för uppdateringsbar hjälp i de moduler som du skapar finns i Support Updatable Help (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