Get-Help

  • Riferimento
Modulo:
Microsoft.PowerShell.Core

Visualizza informazioni sui comandi e sui concetti di PowerShell.

Sintassi

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Descrizione

Il Get-Help cmdlet visualizza informazioni sui concetti e i comandi di PowerShell, inclusi cmdlet, funzioni, comandi CIM (Common Information Model), flussi di lavoro, provider, alias e script.

Per ottenere assistenza per un cmdlet di PowerShell, digitare Get-Help seguito dal nome del cmdlet, ad esempio : Get-Help Get-Process.

Gli articoli della Guida concettuale in PowerShell iniziano con about_, ad esempio about_Comparison_Operators. Per visualizzare tutti gli articoli about_ , digitare Get-Help about_*. Per visualizzare un articolo specifico, digitare Get-Help about_<article-name>, ad esempio Get-Help about_Comparison_Operators.

Per ottenere assistenza per un provider di PowerShell, digitare Get-Help seguito dal nome del provider. Ad esempio, per ottenere assistenza per il provider di certificati, digitare Get-Help Certificate.

È anche possibile digitare help o man, che visualizza una schermata di testo alla volta. In alternativa, <cmdlet-name> -?è identico a Get-Help, ma funziona solo per i cmdlet.

Get-Help ottiene il contenuto della Guida visualizzato dai file della Guida nel computer. Senza i file della Guida, Get-Help visualizza solo informazioni di base sui cmdlet. Alcuni moduli di PowerShell includono file della Guida. A partire da PowerShell 3.0, i moduli inclusi nel sistema operativo Windows non includono i file della Guida. Per scaricare o aggiornare i file della Guida per un modulo in PowerShell 3.0, usare il Update-Help cmdlet .

È anche possibile visualizzare online i documenti della Guida di PowerShell. Per ottenere la versione online di un file della Guida, usare il parametro Online , ad esempio : Get-Help Get-Process -Online.

Se si digita Get-Help seguito dal nome esatto di un articolo della Guida o da una parola univoca per un articolo della Guida, Get-Help visualizza il contenuto dell'articolo. Se si specifica il nome esatto di un alias di comando, Get-Help visualizza la Guida per il comando originale. Se si immette una parola o un criterio di parola visualizzato in diversi titoli degli articoli della Guida, Get-Help viene visualizzato un elenco dei titoli corrispondenti. Se si immette un testo che non viene visualizzato nei titoli degli articoli della Guida, Get-Help viene visualizzato un elenco di articoli che includono tale testo nel relativo contenuto.

Get-Help può ottenere articoli della Guida per tutte le lingue e le impostazioni locali supportate. Get-Helpcerca innanzitutto i file della Guida nelle impostazioni locali impostate per Windows, quindi nelle impostazioni locali padre, ad esempio pt per pt-BR, e quindi in impostazioni locali di fallback. A partire da PowerShell 3.0, se Get-Help non trova assistenza nelle impostazioni locali di fallback, cerca gli articoli della Guida in inglese, en-US, prima di restituire un messaggio di errore o visualizzare la Guida generata automaticamente.

Per informazioni sui simboli Get-Help visualizzati nel diagramma della sintassi dei comandi, vedere about_Command_Syntax. Per informazioni sugli attributi dei parametri, ad esempio Required e Position, vedere about_Parameters.

Nota

In PowerShell 3.0 e PowerShell 4.0 non è possibile trovare gli articoli Informazioni nei moduli a Get-Help meno che il modulo non venga importato nella sessione corrente. Per ottenere gli articoli Informazioni su in un modulo, importare il modulo usando il Import-Module cmdlet o eseguendo un cmdlet incluso nel modulo.

A partire da PSReadLine v2.2.2, il modulo viene fornito con due funzioni che forniscono accesso rapido alla Guida durante la digitazione di un comando nella riga di comando. La Guida viene visualizzata nel terminale in un buffer dello schermo alternativo con paging.

Quando si preme il tasto F1 , la funzione PSReadLine ShowCommandHelp richiama Get-Help -Full per il nome del cmdlet più vicino a sinistra del cursore. Quando il cursore si trova immediatamente a sinistra di un parametro, la funzione passa alla descrizione del parametro nell'argomento della Guida completa. Quando si preme Q per uscire dalla visualizzazione della Guida, si torna alla riga di comando nella stessa posizione del cursore in modo da poter continuare a digitare il comando.

Quando si usa la combinazione di tasti ALT+h, la funzione PSReadLine ShowParameterHelp visualizza le informazioni della Guida per il parametro immediatamente a sinistra del cursore. Il testo della Guida viene visualizzato sotto la riga di comando. In questo modo è possibile visualizzare la descrizione del parametro e continuare a digitare il comando.

Per altre informazioni, vedere Uso della Guida dinamica.

Esempio

Esempio 1: Visualizzare informazioni di base sulla Guida su un cmdlet

Questi esempi visualizzano informazioni di base sulla Guida sul Format-Table cmdlet.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> è la sintassi più semplice e predefinita del Get-Help cmdlet. È possibile omettere il parametro Name .

La sintassi <cmdlet-name> -? funziona solo per i cmdlet.

Esempio 2: Visualizzare informazioni di base una pagina alla volta

Questi esempi visualizzano informazioni di base sulla Guida sul Format-Table cmdlet una pagina alla volta.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help è una funzione che esegue Get-Help internamente il cmdlet e visualizza il risultato una pagina alla volta.

man è un alias per la help funzione.

Get-Help Format-Table invia l'oggetto verso il basso nella pipeline. Out-Host -Paging riceve l'output dalla pipeline e lo visualizza una pagina alla volta. Per altre informazioni, vedere Out-Host.

Esempio 3: Visualizzare altre informazioni per un cmdlet

Questi esempi visualizzano informazioni della Guida più dettagliate sul Format-Table cmdlet.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Il parametro Dettagliato visualizza la visualizzazione dettagliata dell'articolo della Guida che include descrizioni dei parametri ed esempi.

Il parametro Full visualizza la visualizzazione completa dell'articolo della Guida che include descrizioni dei parametri, esempi, tipi di oggetto di input e output e note aggiuntive.

I parametri Detailed e Full sono validi solo per i comandi in cui sono installati i file della Guida nel computer. I parametri non sono validi per gli articoli della Guida concettuali (about_).

Esempio 4: Visualizzare le parti selezionate di un cmdlet usando i parametri

Questi esempi visualizzano parti selezionate della Guida del Format-Table cmdlet.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Il parametro Examples visualizza le sezioni NAME e SYNOPSIS del file della Guida e tutti gli esempi. Non è possibile specificare un numero di esempio perché il parametro Examples è un parametro switch.

Il parametro Parameter visualizza solo le descrizioni dei parametri specificati. Se si specifica solo il carattere jolly asterisco (*), vengono visualizzate le descrizioni di tutti i parametri. Quando Parameter specifica un nome di parametro, ad esempio GroupBy, vengono visualizzate informazioni su tale parametro.

Questi parametri non sono validi per gli articoli della Guida concettuali (about_).

Esempio 5: Visualizzare la versione online della Guida

In questo esempio viene visualizzata la versione online dell'articolo della Guida per il Format-Table cmdlet nel Web browser predefinito.

Get-Help Format-Table -Online

Esempio 6: Visualizzare la Guida sul sistema della Guida

Il Get-Help cmdlet senza parametri visualizza informazioni sul sistema della Guida di PowerShell.

Get-Help

Esempio 7: Visualizzare gli articoli della Guida disponibili

In questo esempio viene visualizzato un elenco di tutti gli articoli della Guida disponibili nel computer.

Get-Help *

Esempio 8: Visualizzare un elenco di articoli concettuali

In questo esempio viene visualizzato un elenco degli articoli concettuali inclusi nella Guida di PowerShell. Tutti questi articoli iniziano con i caratteri about_. Per visualizzare un particolare file della Guida, digitare Get-Help \<about_article-name\>, ad esempio Get-Help about_Signing.

Vengono visualizzati solo gli articoli concettuali in cui sono installati i file della Guida nel computer. Per informazioni sul download e l'installazione di file della Guida in PowerShell 3.0, vedere Update-Help.

Get-Help about_*

Esempio 9: Cercare una parola nella Guida del cmdlet

In questo esempio viene illustrato come cercare una parola in un articolo della Guida del cmdlet.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help usa il parametro Full per ottenere informazioni della Guida per Add-Member. L'oggetto MamlCommandHelpInfo viene inviato alla pipeline. Out-String usa il parametro Stream per convertire l'oggetto in una stringa. Select-Stringusa il parametro Pattern per cercare Clixml nella stringa.

Esempio 10: Visualizzare un elenco di articoli che includono una parola

In questo esempio viene visualizzato un elenco di articoli che includono la parola comunicazione remota.

Quando si immette una parola che non viene visualizzata in alcun titolo dell'articolo, Get-Help viene visualizzato un elenco di articoli che includono tale parola.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Esempio 11: Visualizzare la Guida specifica del provider

Questo esempio illustra due modi per ottenere la Guida specifica del provider per Get-Item. Questi comandi ottengono la Guida che illustra come usare il Get-Item cmdlet nel nodo DataCollection del provider SQL Server di PowerShell.

Il primo esempio usa il Get-Help parametro Path per specificare il percorso del provider SQL Server. Poiché il percorso del provider è specificato, è possibile eseguire il comando da qualsiasi percorso.

Il secondo esempio usa Set-Location per passare al percorso del provider SQL Server. Da tale posizione, il parametro Path non è necessario per Get-Help ottenere la Guida specifica del provider.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Esempio 12: Visualizzare la Guida per uno script

In questo esempio viene recuperata la Guida per l'oggetto MyScript.ps1 script. Per informazioni su come scrivere la Guida per le funzioni e gli script, vedere about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parametri

-Category

Visualizza la Guida solo per gli elementi della categoria specificata e per i relativi alias. Gli articoli concettuali si trovano nella categoria HelpFile .

I valori accettabili per questo parametro sono i seguenti:

  • Alias
  • Cmdlet
  • Provider
  • Generali
  • Domande frequenti
  • Glossario
  • FileGuida
  • ScriptCommand
  • Funzione
  • Filtro
  • ExternalScript
  • Tutte le date
  • DefaultHelp
  • Workflow
  • DscResource
  • Classe
  • Impostazione
Tipo:String[]
Valori accettati:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Component

Visualizza i comandi con il valore del componente specificato, ad esempio Exchange. Immettere un nome di componente. I caratteri jolly sono consentiti. Questo parametro non ha alcun effetto sulle visualizzazioni della Guida concettuale (About_).

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:True

-Detailed

Aggiunge descrizioni ed esempi di parametri alla visualizzazione della Guida di base. Questo parametro è efficace solo quando i file della Guida vengono installati nel computer. Non ha alcun effetto sulle visualizzazioni della Guida concettuale (About_).

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:False
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Examples

Visualizza solo il nome, il riepilogo e gli esempi. Questo parametro è efficace solo quando i file della Guida vengono installati nel computer. Non ha alcun effetto sulle visualizzazioni della Guida concettuale (About_).

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:False
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Full

Visualizza l'intero articolo della Guida per un cmdlet. Completo include descrizioni e attributi dei parametri, esempi, tipi di oggetti di input e output e note aggiuntive.

Questo parametro è efficace solo quando i file della Guida vengono installati nel computer. Non ha alcun effetto sulle visualizzazioni della Guida concettuale (About_).

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:False
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Functionality

Visualizza la Guida sugli elementi con le funzionalità specificate. Immettere le funzionalità. I caratteri jolly sono consentiti. Questo parametro non ha alcun effetto sulle visualizzazioni della Guida concettuale (About_).

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:True

-Name

Ottiene la Guida sul comando o sul concetto specificato. Immettere il nome di un cmdlet, una funzione, un provider, uno script o un flusso di lavoro, ad esempio Get-Member, un nome di articolo concettuale, ad esempio about_Objectso un alias, ad esempio ls. I caratteri jolly sono consentiti nei nomi di cmdlet e provider, ma non è possibile usare caratteri jolly per trovare i nomi degli articoli della Guida per le funzioni e della Guida per gli script.

Per ottenere assistenza per uno script che non si trova in un percorso elencato nella $env:Path variabile di ambiente, digitare il percorso e il nome file dello script.

Se si immette il nome esatto di un articolo della Guida, Get-Help visualizza il contenuto dell'articolo.

Se si immette una parola o un criterio di parola visualizzato in diversi titoli degli articoli della Guida, Get-Help viene visualizzato un elenco dei titoli corrispondenti.

Se si immette testo che non corrisponde ad alcun titolo degli articoli della Guida, Get-Help viene visualizzato un elenco di articoli che includono tale testo nel relativo contenuto.

I nomi degli articoli concettuali, ad esempio about_Objects, devono essere immessi in inglese, anche in versioni non inglesi di PowerShell.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:True

-Online

Visualizza la versione online di un articolo della Guida nel browser predefinito. Questo parametro è valido solo per gli articoli della Guida cmdlet, funzione, flusso di lavoro e script. Non è possibile usare il parametro Online con Get-Help in una sessione remota.

Per informazioni sul supporto di questa funzionalità negli articoli della Guida scritti, vedere about_Comment_Based_Help e Supporto della Guida online e Scrittura della Guida per i cmdlet di PowerShell.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:False
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Parameter

Visualizza solo le descrizioni dettagliate dei parametri specificati. I caratteri jolly sono consentiti. Questo parametro non ha alcun effetto sulle visualizzazioni della Guida concettuale (About_).

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:True

-Path

Ottiene la Guida che illustra il funzionamento del cmdlet nel percorso del provider specificato. Immettere un percorso del provider di PowerShell.

Questo parametro ottiene una versione personalizzata di un articolo della Guida sui cmdlet che illustra il funzionamento del cmdlet nel percorso del provider PowerShell specificato. Questo parametro è efficace solo per informazioni su un cmdlet del provider e solo quando il provider include una versione personalizzata dell'articolo della Guida del cmdlet del provider nel relativo file della Guida. Per usare questo parametro, installare il file della Guida per il modulo che include il provider.

Per visualizzare la Guida del cmdlet personalizzata per un percorso del provider, passare al percorso del provider e immettere un Get-Help comando o, da qualsiasi percorso, usare il parametro Path di Get-Help per specificare il percorso del provider. È anche possibile trovare la Guida personalizzata dei cmdlet online nella sezione della Guida del provider degli articoli della Guida.

Per altre informazioni sui provider di PowerShell, vedere about_Providers.

Nota

Il provider per il percorso specificato deve avere installato un file della Guida del provider PowerShell. Se non è disponibile alcun file della Guida del provider, non vengono restituite informazioni della Guida. Non sono disponibili file della Guida del provider per i provider inclusi in questa versione di PowerShell.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:True

-Role

Visualizza la Guida personalizzata per il ruolo utente specificato. Immettere un ruolo. I caratteri jolly sono consentiti.

Immettere il ruolo svolto dall'utente in un'organizzazione. Per alcuni cmdlet viene visualizzato un testo diverso nei file della Guida in base al valore di questo parametro. Questo parametro non ha effetto sulla Guida per i cmdlet Core.

Tipo:String[]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:True

-ShowWindow

Visualizza l'argomento della Guida in una finestra per semplificarne la lettura. La finestra include una funzionalità di ricerca trova e una casella Impostazioni che consente di impostare le opzioni per la visualizzazione, incluse le opzioni per visualizzare solo le sezioni selezionate di un argomento della Guida.

Il parametro ShowWindow supporta gli argomenti della Guida per i comandi (cmdlet, funzioni, comandi CIM, script) e articoli di informazioni concettuali. Non supporta l'aiuto del provider.

Questo parametro è stato reintrodotto in PowerShell 7.0. Questo parametro è disponibile solo in Windows.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:False
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

None

Non è possibile inviare tramite pipe oggetti a questo cmdlet.

Output

ExtendedCmdletHelpInfo

Se si esegue Get-Help in un comando che non dispone di un file della Guida, Get-Help restituisce un oggetto ExtendedCmdletHelpInfo che rappresenta la Guida generata automaticamente.

String

Se si ottiene un articolo della Guida concettuale, Get-Help lo restituisce come stringa.

MamlCommandHelpInfo

Se si ottiene un comando con un file della Guida, Get-Help restituisce un oggetto MamlCommandHelpInfo .

Note

PowerShell 3.0 non include i file della Guida. Per scaricare e installare i file della Guida letti Get-Help , usare il Update-Help cmdlet . È possibile usare il Update-Help cmdlet per scaricare e installare i file della Guida per i comandi principali inclusi in PowerShell e per tutti i moduli installati. È inoltre possibile usarlo per aggiornare i file della Guida in modo che nel computer sia sempre disponibile la versione più recente.

È anche possibile leggere gli articoli della Guida sui comandi inclusi in PowerShell online a partire da Introduzione a Windows PowerShell.

Get-Help visualizza la Guida nelle impostazioni locali impostate per il sistema operativo Windows o nella lingua di fallback per tali impostazioni locali. Se non si dispone di file della Guida per le impostazioni locali primarie o di fallback, Get-Help si comporta come se non ci siano file della Guida nel computer. Per ottenere assistenza per impostazioni locali diverse, usare Area e lingua in Pannello di controllo per modificare le impostazioni. In Windows 10 o versione successiva, Impostazioni, Ora e lingua.

La visualizzazione completa della Guida include una tabella di informazioni sui parametri. con i campi seguenti:

  • Obbligatorio. indica se il parametro è obbligatorio (true) o facoltativo (false).

  • Posizionamento. Indica se il parametro è denominato o posizionale (numerico). I parametri posizionali devono comparire in un punto specifico del comando.

  • Named indica che il nome del parametro è obbligatorio, ma che il parametro può essere visualizzato in qualsiasi punto del comando.

  • Numeric indica che il nome del parametro è facoltativo, ma quando il nome viene omesso, il parametro deve trovarsi nella posizione specificata dal numero. Ad esempio, indica che quando 2 il nome del parametro viene omesso, il parametro deve essere il secondo o solo il parametro senza nome nel comando. Se viene usato il nome, il parametro può comparire in qualsiasi punto del comando.

  • Valore predefinito. Valore del parametro o comportamento predefinito usato da PowerShell se non si include il parametro nel comando .

  • Accetta l'input della pipeline. Indica se è possibile (true) o non è possibile (false) inviare oggetti al parametro tramite una pipeline. In Nome proprietà significa che l'oggetto pipeline deve avere una proprietà con lo stesso nome del parametro.

  • Accetta caratteri jolly. Indica se il valore di un parametro può includere caratteri jolly, ad esempio un asterisco (*) o un punto interrogativo (?).