Update-Help

Syntax

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [[-SourcePath] <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [-LiteralPath <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-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 göra ändringen effektiv. 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 hämtar de senaste hjälpfilerna. Hjälpfilerna kan laddas ned och installeras från Internet eller en filresurs.

Utan parametrar uppdaterar Update-Help 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 miljövariabeln $env:PSModulePath. Mer information finns i about_Updatable_Help.

Du kan använda parametern Module 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 använda Update-Help på datorer som inte är anslutna till Internet. Använd cmdleten Save-Help för att ladda ned hjälpfiler från Internet och spara dem på en filsystemplats, till exempel en delad mapp eller filsystemkatalog. Använd sedan parametern SourcePath för Update-Help för att ladda ned de uppdaterade hjälpfilerna från en filsystemplats och installera dem på datorn.

Du kan automatisera hjälpuppdateringar genom att lägga till Update-Help-cmdleten i din PowerShell-profil. Som standard körs Update-Help 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 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älpfiler för olika språk

Cmdleten Update-Help uppdaterar japanska (ja-JP) och engelska (en-US) hjälpfiler för alla moduler.

Om en modul inte tillhandahåller hjälpfiler för en angiven användargränssnittskultur visas ett felmeddelande för modulen och användargränssnittskulturen. I det här exemplet anger felmeddelandet att ja-JP hjälpfiler 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 automatiskt

I det här exemplet skapas ett schemalagt jobb som uppdaterar hjälpen för alla moduler varje dag kl. 03: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

Cmdleten Register-ScheduledJob skapar ett schemalagt jobb som kör ett Update-Help kommando. Kommandot använder parametern Credential för att köra Update-Help med hjälp av autentiseringsuppgifterna för en medlem i gruppen Administratörer på datorn. Värdet för parametern Trigger är ett New-JobTrigger kommando som skapar en jobbutlösare som startar jobbet varje dag klockan 03:00.

Om du vill köra kommandot Register-ScheduledJob startar du PowerShell med alternativet Kör som administratör. PowerShell frågar efter lösenordet för användaren som anges i parametern Credential. Autentiseringsuppgifterna lagras med det schemalagda jobbet. Du uppmanas inte när jobbet körs.

Du kan använda cmdleten Get-ScheduledJob för att visa det schemalagda jobbet, använda cmdleten Set-ScheduledJob för att ändra det och använda cmdleten Unregister-ScheduledJob för att ta bort det. Du kan också visa och hantera det schemalagda jobbet i Schemaläggaren på följande sökväg:

Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.

Exempel 5: 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.

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
}

Kommandot Save-Help hämtar de senaste hjälpfilerna för alla moduler som stöder uppdateringsbar hjälp. Parametern DestinationPath sparar filerna i \\Server01\Share\PSHelp filresursen. 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 kommandot Update-Help och använder parametern SourcePath 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 6: 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örliga för att visa utdata för alla hjälpfiler eller hjälpfiler för en specifik modul.

Utan parametern Utförlig visar Update-Help inte kommandots resultat. Den utförliga parameterutdata är användbar för att kontrollera att hjälpfilerna har uppdaterats eller om den senaste versionen är installerad.

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

Exempel 7: 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 egenskap HelpInfoUri 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 8: 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 PSCustomObject-klass 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.0

Parametrar

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-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 PowerShell Core-modulerna, som innehåller kommandona som är installerade med PowerShell eller någon modul i $PSHOME\Modules-katalogen, startar du PowerShell med alternativet att Kör som administratör.

Endast medlemmar i gruppen Administratörer på datorn kan uppdatera hjälpen för PowerShell Core-modulerna, kommandona som installeras tillsammans med PowerShell och för moduler i mappen $PSHOME\Modules. 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 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 Get-Command-cmdleten, till exempel (Get-Command Update-Help).ModuleName.

Eftersom hjälpfiler installeras i modulkatalogen kan Update-Help-cmdleten endast installera den uppdaterade hjälpfilen för moduler som är installerade på datorn. Men cmdleten Save-Help kan spara hjälp för moduler som inte är installerade på datorn.

Om Update-Help inte kan hitta uppdaterade hjälpfiler för en modul eller inte kan hitta uppdaterad hjälp på det angivna språket fortsätter den tyst utan att ett felmeddelande visas. Om du vill se status- och förloppsinformation använder du parametern Utförlig.

Cmdleten Update-Help introducerades i Windows PowerShell 3.0. Det fungerar inte i tidigare versioner av Windows 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 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 parametern Module för att ange modulnamnet. Parametern Module för cmdletarna Update-Help 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.

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