Get-Help
Visualizza informazioni sui comandi e i concetti relativi a Windows PowerShell.
Sintassi
Get-Help [-Full] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Detailed] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Esempi] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Get-Help [-Parameter <string>] [[-Name] <string>] [-Category <string[]>] [-Component <string[]>] [-Functionality <string[]>] [-Online] [-Path <string>] [-Role <string[]>] [<CommonParameters>]
Descrizione
Mediante il cmdlet Get-Help vengono visualizzate informazioni su comandi e concetti relativi a Windows PowerShell, inclusi cmdlet, provider, funzioni e script. Per ottenere un elenco di tutti i titoli degli argomenti della Guida relativi ai cmdlet, digitare "get-help *".
Se si digita "Get-Help" seguito dal nome esatto di un argomento della Guida o da una parola univoca presente in un argomento della Guida, Get-Help visualizza il contenuto dell'argomento. Se si immette una parola o un gruppo di parole che compare in diversi titoli della guida, mediante Get-Help viene visualizzato un elenco di titoli corrispondenti. Se si immette una parola che non è presente in alcun titolo della guida, mediante Get-Help viene visualizzato un elenco di argomenti che presentano tale parola nel contenuto.
Oltre a "get-help", è possibile digitare "help" o "man" per visualizzare una schermata di testo alla volta, oppure "<nome-cmdlet> -?" che corrisponde a Get-Help ma funziona solo per i cmdlet.
È possibile visualizzare l'intero file della Guida o parti selezionate del file, ad esempio la sintassi, i parametri o gli esempi. È inoltre possibile utilizzare il parametro Online per visualizzare una versione online di un file della Guida nel browser Internet. Questi parametri non hanno effetto sugli argomenti concettuali della Guida.
Gli argomenti concettuali della Guida in Windows PowerShell iniziano con "about_", ad esempio "about_Comparison_Operators". Per vedere tutti gli argomenti "about_", digitare "get-help about_*". Per visualizzare un determinato argomento, digitare "get-help about_<nome-argomento>", ad esempio "get-help about_Comparison_Operators".
Parametri
-Category <string[]>
Visualizza la Guida per gli elementi della categoria specificata. I valori validi sono Alias, Cmdlet, Provider e HelpFile. Gli argomenti concettuali sono inclusi nella categoria HelpFile.
Category è una proprietà dell'oggetto MamlCommandHelpInfo restituito da Get-Help. Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("about_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Component <string[]>
Visualizza un elenco di strumenti con il valore del componente specificato, ad esempio "Exchange". Immettere un nome di componente. È consentito l'utilizzo di caratteri jolly.
Component è una proprietà dell'oggetto MamlCommandHelpInfo restituito da Get-Help. Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("About_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Detailed
Aggiunge esempi e descrizioni dei parametri alla visualizzazione di base della Guida.
Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("About_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Esempi
Visualizza solo il nome, il riepilogo e gli esempi. Per visualizzare solo gli esempi, digitare "(get-help <cmdlet-name>).examples".
Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("About_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Full
Visualizza l'intero file della Guida per un cmdlet, comprese le descrizioni e gli attributi dei parametri, gli esempi, tipi di oggetti di input e output e note aggiuntive.
Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("About_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Functionality <string[]>
Visualizza la Guida per gli elementi con la funzionalità specificata. Immettere la funzionalità. È consentito l'utilizzo di caratteri jolly.
Functionality è una proprietà dell'oggetto MamlCommandHelpInfo restituito da Get-Help. Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("About_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Name <string>
Richiede la Guida sullo strumento o sull'argomento concettuale specificato. Immettere un nome di cmdlet, provider, script o funzione, ad esempio Get-Member, un nome di argomento concettuale, ad esempio "about_Objects", o un alias, ad esempio "ls". I caratteri jolly sono consentiti nei nomi dei cmdlet e dei provider, ma non è possibile utilizzarli per trovare i nomi degli argomenti della Guida relativi a funzioni e script.
Per ottenere la Guida per uno script che non si trova in un percorso elencato nella variabile di ambiente Path, digitare il percorso e il nome file dello script.
Se si immette il nome esatto di un argomento della guida, tramite Get-Help viene visualizzato il contenuto di tale argomento. Se si immette una parola o un gruppo di parole che compare in diversi titoli della guida, mediante Get-Help viene visualizzato un elenco di titoli corrispondenti. Se si immette una parola che non ha corrispondenza in alcun titolo della guida, mediante Get-Help viene visualizzato un elenco di argomenti che presentano tale parola nel contenuto.
I nomi degli argomenti concettuali, ad esempio about_Objects, devono essere inseriti in inglese, anche nelle versioni di Windows PowerShell non in lingua inglese.
Obbligatorio? |
false |
Posizione? |
1 |
Valore predefinito |
|
Accettare input da pipeline? |
true (ByPropertyName) |
Accettare caratteri jolly? |
false |
-Online
Visualizza la versione online di un argomento della Guida nel browser Internet predefinito. Questo parametro è valido solo per gli argomenti della Guida relativi a cmdlet, funzioni e script.
Get-Help utilizza l'indirizzo Internet (Uniform Resource Identifier [URI]) riportato nel primo elemento della sezione Argomenti correlati dell'argomento della Guida di un cmdlet, funzione o script. Questo parametro funziona solo quando l'argomento della Guida include un URI che inizia con "Http" o "Https" e nel sistema è installato un browser Internet.
Per informazioni sul supporto di questa funzionalità negli argomenti della Guida scritti, vedere about_comment_based_help e l'argomento relativo alla scrittura di argomenti della Guida per i cmdlet in MSDN library (Microsoft Developer Network) all'indirizzo (le informazioni potrebbero essere in lingua inglese).
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
nessuno |
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Parameter <string>
Visualizza solo le descrizioni dettagliate dei parametri specificati. È consentito l'utilizzo di caratteri jolly.
Questo parametro non ha alcun effetto sulla visualizzazione degli argomenti concettuali ("About_") della Guida.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Path <string>
Ottiene informazioni della guida che spiegano il funzionamento del cmdlet nel percorso del provider specificato. Immettere il percorso di un provider Windows PowerShell.
Questo parametro ottiene una versione personalizzata dell'argomento della Guida dedicato al cmdlet che ne illustra il funzionamento nel percorso del provider Windows PowerShell specificato. Questo parametro ha effetto solo per la Guida relativa a un cmdlet del provider e solo quando il provider include una versione personalizzata dell'argomento della Guida relativo al cmdlet del provider.
Per visualizzare la Guida del cmdlet personalizzato per un percorso del provider, passare al percorso del provider e immettere un comando Get-Help oppure, da qualsiasi percorso, utilizzare il parametro Path di Get-Help per specificare il percorso del provider. Per ulteriori informazioni, vedere about_Providers.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
-Role <string[]>
Visualizza la Guida personalizzata per il ruolo utente specificato. Immettere un ruolo. È consentito l'utilizzo di caratteri jolly.
Immettere il ruolo svolto dall'utente in un'organizzazione. In base al valore di questo parametro, per alcuni cmdlet viene visualizzato testo diverso nei relativi file della Guida. Questo parametro non ha alcun effetto sulla Guida dei cmdlet principali.
Obbligatorio? |
false |
Posizione? |
named |
Valore predefinito |
|
Accettare input da pipeline? |
false |
Accettare caratteri jolly? |
false |
<CommonParameters>
Questo cmdlet supporta i parametri comuni -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Per ulteriori informazioni, vedere about_Commonparameters.
Input e output
Il tipo di input è il tipo degli oggetti che è possibile reindirizzare al cmdlet. Il tipo restituito è il tipo degli oggetti restituiti dal cmdlet.
Input |
Nessuno Non è possibile reindirizzare oggetti a questo cmdlet. |
Output |
System.String o MamlCommandHelpInfo Se si richiede un argomento concettuale, Get-Help lo restituisce come stringa. Se si specifica il nome di un cmdlet, una funzione o uno script, viene restituito un oggetto MamlCommandHelpInfo. In caso contrario, Get-Help restituisce una delle visualizzazioni formattate specificate nel file Help.Format.ps1xml nella directory $pshome. |
Note
Se non si specifica alcun parametro, "Get-Help" visualizza informazioni sulla Guida di Windows PowerShell.
Nella visualizzazione completa della Guida (-full) è inclusa una tabella contenente le informazioni sui parametri. Nella tabella sono inclusi i campi seguenti:
-- Required: indica se il parametro è obbligatorio (true) o facoltativo (false).
-- Position: indica se il parametro è denominato o posizionale (numerato). I parametri posizionali devono essere inseriti in una posizione specifica nel comando.
-- "Named": indica che il nome del parametro è obbligatorio, ma che il parametro può essere immesso in qualsiasi punto del comando.
-- <Number>: indica che il nome del parametro è facoltativo, ma che, se si omette il nome, il parametro deve essere immesso nella posizione specificata dal numero. "2", ad esempio, indica che quando si omette il nome il parametro deve essere il secondo (2) o unico parametro senza nome presente nel comando. Se viene specificato il nome, il parametro può essere immesso in qualsiasi punto del comando.
-- Default value: valore del parametro utilizzato da Windows PowerShell se non si include il parametro nel comando.
-- Accepts pipeline input: indica se è possibile (true) o meno (false) inviare oggetti al parametro attraverso una pipeline. "By Property Name" indica che l'oggetto inviato attraverso la pipeline deve avere una proprietà con lo stesso nome del parametro.
-- Accepts wildcard characters: indica se il valore di un parametro può includere caratteri jolly, ad esempio "* e ?".
Esempio 1
C:\PS>get-help
Descrizione
-----------
Tramite questo comando viene visualizzata la Guida di Windows PowerShell.
Esempio 2
C:\PS>get-help *
Descrizione
-----------
Tramite questo comando viene visualizzato un elenco di tutti i file della Guida di Windows PowerShell.
Esempio 3
C:\PS>get-help get-alias
C:\PS>help get-alias
C:\PS>get-alias -?
Descrizione
-----------
Tramite questi comandi vengono visualizzate informazioni di base sul cmdlet get-alias. Tramite i comandi "Get-Help" e "-?" le informazioni vengono visualizzate in una sola pagina. Con il comando "Help" le informazioni vengono visualizzate una pagina per volta.
Esempio 4
C:\PS>get-help about_*
Descrizione
-----------
Tramite questo comando viene visualizzato un elenco di argomenti concettuali inclusi nella Guida di Windows PowerShell. Tutti questi argomenti iniziano con i caratteri "about_". Per visualizzare un file della Guida specifico, digitare "get-help <nome-argomento>, ad esempio "get-help about_signing".
Esempio 5
C:\PS>get-help ls -detailed
Descrizione
-----------
Tramite questo comando viene visualizzata la Guida dettagliata per il cmdlet Get-ChildItem specificando uno dei relativi alias, "ls". Il parametro Detailed richiede la visualizzazione dettagliata del file della Guida che include descrizioni dei parametri ed esempi. Per visualizzare il file completo della Guida per un cmdlet, utilizzare il parametro Full.
Esempio 6
C:\PS>get-help format-string -full
Descrizione
-----------
Tramite questo comando viene visualizzata la Guida completa per il cmdlet Format-String. La visualizzazione completa della Guida include le descrizioni dei parametri, gli esempi, nonché una tabella contenente informazioni tecniche sui parametri.
Esempio 7
C:\PS>get-help start-service -examples
Descrizione
-----------
Con questo comando vengono visualizzati alcuni esempi di utilizzo di start-service nei comandi di Windows PowerShell.
Esempio 8
C:\PS>get-help get-childitem -parameter f*
Descrizione
-----------
Tramite questo comando vengono visualizzate le descrizioni dei parametri del cmdlet Get-ChildItem che iniziano con "f" (Filter e Force). Per le descrizioni di tutti i parametri, digitare "get-help get-childitem parameter*".
Esempio 9
C:\PS>(get-help write-output).syntax
Descrizione
-----------
Tramite questo comando viene visualizzata solo la sintassi del cmdlet Write-Output.
La sintassi è una delle numerose proprietà degli oggetti della Guida. Le altre sono description, details, examples e parameters. Per trovare tutti i metodi e le proprietà degli oggetti della Guida, digitare "get-help <nome-cmdlet> | get-member"; ad esempio "get-help start-service | get member".
Esempio 10
C:\PS>(get-help trace-command).alertset
Descrizione
-----------
Tramite questo comando vengono visualizzate le note sul cmdlet. Le note vengono archiviate nella proprietà alertSet dell'oggetto della Guida.
Le note includono informazioni concettuali e suggerimenti per l'utilizzo del cmdlet. Per impostazione predefinita, le note vengono visualizzate solo quando si utilizza il parametro Full di Get-Help, ma è possibile visualizzarle anche tramite la proprietà alertSet.
Esempio 11
C:\PS>get-help add-member -full | out-string -stream | select-string -pattern clixml
Descrizione
-----------
In questo esempio viene illustrato come cercare una parola in un particolare argomento della Guida del cmdlet. Tramite questo comando viene cercata la parola "clixml" nella versione completa dell'argomento della Guida relativo al cmdlet Add-Member.
Poiché tramite il cmdlet Get-Help viene generato un oggetto MamlCommandHelpInfo e non una stringa, è necessario utilizzare un comando che trasforma il contenuto dell'argomento della Guida in una stringa, ad esempio Out-String o Out-File.
Esempio 12
C:\PS>get-help get-member -online
Descrizione
-----------
Tramite questo comando viene visualizzata la versione online dell'argomento della Guida relativo al cmdlet Get-Member.
Esempio 13
C:\PS>get-help remoting
Descrizione
-----------
Con questo comando viene visualizzato un elenco di argomenti nel cui contenuto è presente la parola "comunicazione remota".
Quando si immette una parola che non è presente in nessun titolo degli argomenti, tramite Get-Help viene visualizzato un elenco di argomenti che presentano tale parola.
Esempio 14
C:\PS>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.
...
C:\PS> cd SQLSERVER:\DataCollection
C:\PS> 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.
...
C:\PS> Get-Item
NAME
Get-Item
SYNOPSIS
Gets the item at the specified location.
...
Descrizione
-----------
In questo esempio viene illustrato come ottenere la Guida per il cmdlet Get-Item in cui viene spiegato come utilizzare il cmdlet nel nodo DataCollection del provider SQL Server di Windows PowerShell.
Nell'esempio vengono illustrate due modalità per l'acquisizione della Guida personalizzata su Get-Item.
Nel primo comando viene utilizzato il parametro Path di Get-Help per specificare il percorso del provider. È possibile immettere questo comando in qualsiasi percorso.
Nel secondo comando viene utilizzato il cmdlet Set-Location (alias = "cd") per passare al percorso del provider. Da tale percorso, anche senza il parametro Path, il comando Get-Help consente di ottenere la Guida personalizzata per il percorso del provider.
Con il terzo comando viene illustrato come un comando Get-Help in un percorso del file system e senza il parametro Path, consenta di ottenere la Guida standard per il cmdlet Get-Item.
Esempio 15
C:\PS>get-help c:\ps-test\MyScript.ps1
Descrizione
-----------
Con questo comando si ottiene la Guida per lo script MyScript.ps1. Per informazioni sulla modalità di scrittura della Guida per funzioni e script, vedere about_Comment_Based_Help.