Update-Help

Sintassi

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

Descrizione

Il cmdlet Update-Help scarica i file della Guida più recenti per i moduli di PowerShell e li installa nel computer. Non è necessario riavviare PowerShell per rendere effettiva la modifica. È possibile usare il cmdlet Get-Help per visualizzare immediatamente i nuovi file della Guida.

Update-Help controlla la versione dei file della Guida nel computer. Se non si hanno file della Guida per un modulo o se i file della Guida non sono aggiornati, Update-Help scarica i file della Guida più recenti. I file della Guida possono essere scaricati e installati da Internet o da una condivisione file.

Senza parametri, Update-Help aggiorna i file della Guida per i moduli che supportano la Guida aggiornabile e vengono caricati nella sessione o installati in un percorso incluso nella $env:PSModulePath. Per altre informazioni, vedere about_Updatable_Help.

Update-Help controlla la versione della Guida installata. Se Update-Help non riesce a trovare i file della Guida aggiornati per un modulo, continua automaticamente senza visualizzare un messaggio di errore. Usare il parametro Force per ignorare il controllo della versione. Usare il parametro dettagliato per visualizzare i dettagli sullo stato e sullo stato. Usare il parametro module per aggiornare i file della Guida per un modulo specifico.

È anche possibile usare Update-Help nei computer che non sono connessi a Internet. Usare prima di tutto il cmdlet Save-Helpper scaricare i file della Guida da Internet e salvarli in una cartella condivisa accessibile al sistema non connesso a Internet. Usare quindi il parametro SourcePath di per scaricare i file della Guida aggiornati dal file condiviso e installarli nel computer.

Il cmdlet Update-Help è stato introdotto in Windows PowerShell 3.0.

Esempio

Esempio 1: Aggiornare i file della Guida per tutti i moduli

Il cmdlet Update-Help aggiorna i file della Guida per i moduli installati che supportano la Guida aggiornabile. La lingua delle impostazioni cultura dell'interfaccia utente è impostata nel sistema operativo.

Update-Help

Esempio 2: Aggiornare i file della Guida per i moduli specificati

Il cmdlet Update-Help aggiorna i file della Guida solo per i nomi dei moduli che iniziano con Microsoft.PowerShell.

Update-Help -Module Microsoft.PowerShell*

Esempio 3: Aggiornamento della Guida in un sistema non impostato sulle impostazioni locali di en-US

Il cmdlet Update-Help è progettato per scaricare la Guida in più lingue. Tuttavia, quando non è disponibile alcuna guida per la lingua usata dal sistema, ha esito negativo in modo invisibile all'utente, a meno che non si usi il parametro UICulture .

In questo esempio Update-Help viene eseguito in un sistema impostato sulle impostazioni locali en-GB.

Update-Help Microsoft.PowerShell.Utility -Force
Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB

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.

I file della Guida vengono sempre pubblicati per le impostazioni locali en-US. Per scaricare la Guida in lingua inglese, eseguire con il parametro UICulture e specificare le impostazioni locali .

Esempio 4: Aggiornare i file della Guida in più computer da una condivisione file

In questo esempio i file della Guida aggiornati vengono scaricati da Internet e salvati in una condivisione file. Le credenziali utente sono necessarie per accedere alla condivisione file e installare gli aggiornamenti. Quando si usa una condivisione file, è possibile aggiornare i computer che si trovano dietro firewall o che non sono connessi a 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
}

Il comando Save-Help scarica i file della Guida più recenti per tutti i moduli che supportano la Guida aggiornabile. Il parametro DestinationPath salva i file nella condivisione file \\Server01\Share\PSHelp. Il parametro Credential consente di specificare un utente autorizzato ad accedere alla condivisione file.

Il cmdlet Invoke-Command esegue comandi Update-Help remoti in più computer. Il parametro ComputerName ottiene un elenco di computer remoti dal file Servers.txt. Il parametro ScriptBlock esegue il comando e usa il parametro SourcePath per specificare la condivisione file contenente i file della Guida aggiornati. Il parametro credenziali specifica un utente che può accedere alla condivisione file ed eseguire il comando remoto.

Esempio 5: Ottenere un elenco di file della Guida aggiornati

La Guida degli aggiornamenti del cmdlet Update-Help per un modulo specificato. Il cmdlet usa il dettagliato parametro comune per visualizzare l'elenco dei file della Guida aggiornati. È possibile usare dettagliato per visualizzare l'output per tutti i file della Guida o i file della Guida per un modulo specifico.

Senza il parametro dettagliato, Update-Help non visualizza i risultati del comando. L'output del parametro dettagliato è utile per verificare che i file della Guida siano stati aggiornati o se è installata la versione più recente.

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

Esempio 6: Trovare moduli che supportano la Guida aggiornabile

Questo esempio elenca i moduli che supportano la Guida aggiornabile. Il comando usa la proprietà HelpInfoUri del modulo per identificare i moduli che supportano la Guida aggiornabile. La proprietà helpInfoUri contiene un URL reindirizzato quando viene eseguito il cmdlet .

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, ... }

Esempio 7: File della Guida aggiornati dell'inventario

In questo esempio, lo script Get-UpdateHelpVersion.ps1 crea un inventario dei file della Guida aggiornabili per ogni modulo e i relativi numeri di versione.

Lo script identifica i moduli che supportano la Guida aggiornabile usando la proprietà helpinfoUri di . Per i moduli che supportano la Guida aggiornabile, lo script cerca e analizza il file di informazioni della Guida (*helpinfo.xml) per trovare il numero di versione più recente.

Lo script usa la classe PSCustomObject e una tabella hash per creare un oggetto di output personalizzato.

# 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

Parametri

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-Scope

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Input

DirectoryInfo

È possibile inviare tramite pipe un oggetto percorso directory a questo cmdlet.

PSModuleInfo

È possibile inviare tramite pipe un oggetto modulo a questo cmdlet.

Output

None

Questo cmdlet non restituisce alcun output.

Note

Per aggiornare la Guida per i moduli di PowerShell di base, che contengono i comandi installati con PowerShell o qualsiasi modulo nella directory $PSHOME\Modules, avviare PowerShell con l'opzione per Esegui come amministratore.

Solo i membri del gruppo Administrators nel computer possono aggiornare la Guida per i moduli di PowerShell principali, i comandi installati insieme a PowerShell e per i moduli nella cartella $PSHOME\Modules. Se non si dispone dell'autorizzazione per aggiornare i file della Guida, è possibile leggere i file della Guida online. Ad esempio, Get-Help Update-Help -Online.

I moduli sono l'unità più piccola della Guida aggiornabile. Non è possibile aggiornare la Guida per un cmdlet specifico. Per trovare il modulo contenente un cmdlet specifico, usare la proprietà ModuleName del cmdlet , ad esempio .

Poiché i file della Guida vengono installati nella directory del modulo, il cmdlet Update-Help può installare il file della Guida aggiornato solo per i moduli installati nel computer. Tuttavia, il cmdlet Save-Help può salvare la Guida per i moduli non installati nel computer.

Il cmdlet Update-Help è stato introdotto in Windows PowerShell 3.0. Non funziona nelle versioni precedenti di PowerShell. Nei computer con Windows PowerShell 2.0 e Windows PowerShell 3.0 usare il cmdlet Update-Help in una sessione di Windows PowerShell 3.0 per scaricare e aggiornare i file della Guida. I file della Guida sono disponibili sia per Windows PowerShell 2.0 che per Windows PowerShell 3.0.

I cmdlet Update-Help e Save-Help usano le porte seguenti per scaricare i file della Guida: Porta 80 per HTTP e porta 443 per HTTPS.

Update-Help supporta tutti i moduli e gli snap-in di PowerShell principali. Non supporta altri snap-in.

Per aggiornare la Guida per un modulo in un percorso non elencato nella variabile di ambiente $env:PSModulePath, importare il modulo nella sessione corrente ed eseguire un comando Update-Help. Eseguire senza parametri o usare il parametro Module per specificare il nome del modulo. Il parametro module dei cmdlet e non accetta il percorso completo di un file di modulo o di un file manifesto del modulo.

Qualsiasi modulo può supportare la Guida aggiornabile. Per istruzioni sul supporto della Guida aggiornabile nei moduli creati, vedere Supporto della Guida aggiornabile.

I cmdlet Update-Help e Save-Help non sono supportati in Windows Preinstallation Environment (Windows PE).

Collegamenti correlati

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