Usare Show-Command e Get-Help in PowerShell

Completato

Il cmdlet Show-Command apre una finestra che visualizza un elenco di comandi o i parametri di un comando specifico. Questa finestra è la stessa che viene visualizzata quando si seleziona l'opzione MostraFinestra di comando nell'ISE.

Per visualizzare i parametri di un comando specifico, specificare il nome del comando come valore per il parametro -Name. Ad esempio, per aprire la finestra MostraFinestra di comando con il comando usato per recuperare un utente di Active Directory, immettere il comando seguente nella console e quindi premere INVIO:

Show-Command –Name Get-ADUser

Il parametro -Name è posizionale, quindi il comando seguente genera lo stesso risultato:

Show-Command Get-ADUser

Se si seleziona l'opzione MostraFinestra di comando nell'ISE e il cursore si trova all'interno o immediatamente accanto a un nome di comando all'interno della console o del riquadro di scripting, i risultati sono uguali.

Nota

In questi esempi Show-Command è il comando che si sta effettivamente eseguendo, ma Get-ADUser è il nome del comando che si vuole esaminare nella finestra di dialogo.

All'interno di MostraFinestra di comando ogni set di parametri per il comando specificato viene visualizzato in una scheda separata. Ciò rende visivamente chiaro che non è possibile combinare e associare i parametri tra set.

Dopo aver specificato i valori per tutti i parametri necessari, è possibile eseguire immediatamente il comando selezionando Esegui nella finestra Mostra comandi. È anche possibile copiarlo negli Appunti selezionando Copia. Dagli Appunti è possibile incollare il comando nella console, in modo da poter esaminare la sintassi della riga di comando corretta senza eseguire il comando.

Si noti che Show-Command espone anche i parametri comuni di Windows PowerShell, ovvero un set di parametri che Windows PowerShell aggiunge a tutti i comandi per fornire un set predefinito di funzionalità di base. Verranno fornite altre informazioni su molti dei parametri comuni in moduli futuri. Tuttavia, per trovare subito altre informazioni, eseguire help about_common_parameters in Windows PowerShell ed esaminare i risultati.

Uso di Get-Help

Windows PowerShell offre un'ampia Guida inclusa nel prodotto per i comandi. È possibile accedere a questa Guida usando il comando Get-Help. Get-Help visualizza tutti i contenuti della Guida sullo schermo e consente di scorrere il contenuto della Guida. È anche possibile usare la funzione Help o l'alias Man, che corrisponde al comando Get-Help. Tutti e tre restituiscono fondamentalmente gli stessi risultati. Questi risultati includono una descrizione breve e lunga del cmdlet, la sintassi, eventuali osservazioni aggiuntive dell'autore della Guida e collegamenti a cmdlet correlati o informazioni aggiuntive online. I comandi help e Man visualizzano il contenuto nella console una pagina alla volta. L'ISE visualizza l'intero contenuto della Guida.

Ad esempio, per visualizzare le informazioni della Guida per il cmdlet Get-ChildItem, immettere il comando seguente nella console e quindi premere INVIO:

Get-Help Get-ChildItem

Parametri di Get-Help

Il comando Get-Help accetta parametri che consentono di trovare informazioni aggiuntive oltre alle informazioni visualizzate per impostazione predefinita. Un motivo comune per cercare informazioni della Guida aggiuntive è per identificare esempi di utilizzo per un comando. I comandi di Windows PowerShell includono in genere molti esempi di questo tipo. Ad esempio, l'esecuzione del comando Get-Help Stop-Process -Examples fornirà esempi sull'uso del cmdlet Stop-Process.

Il parametro -Full fornisce informazioni approfondite su un cmdlet, tra cui:

• La descrizione di ogni parametro.
• Se ogni parametro ha un valore predefinito (anche se queste informazioni non sono documentate in modo coerente per tutti i comandi).
• Se un parametro è obbligatorio.
• Se un parametro può accettare un valore in una posizione specifica (nel qual caso viene indicato il numero di posizione, a partire da 1) o se è necessario immettere il nome del parametro (in questo caso il parametro viene indicato come denominato).
• Se un parametro accetta l'input nella pipeline e, in caso affermativo, come.

Altri parametri di Get-Help includono:

• ‑ShowWindow. Visualizza l'argomento della Guida in una finestra separata, che semplifica notevolmente l'accesso alla Guida durante l'immissione dei comandi.
• ‑Online. Visualizza la versione online dell'argomento della Guida (in genere le informazioni più aggiornate) in una finestra del browser.
• -Parameter ParameterName. Visualizza la descrizione di un parametro denominato.
• ‑Category. Visualizza la Guida solo per determinate categorie di comandi, ad esempio cmdlet e funzioni.

Uso di Get-Help per trovare i comandi

Il comando Get-Help può essere molto utile per trovare i comandi. Accetta caratteri jolly (*, ?), in particolare il carattere jolly asterisco (*). Quando si richiedono informazioni della Guida usando caratteri jolly con un nome di comando parziale, Windows PowerShell visualizzerà un elenco di argomenti della Guida corrispondenti.

Usando le informazioni apprese in precedenza sulla struttura verbo-sostantivo (in inglese) dei cmdlet, è possibile usare Get-Help come strumento per individuare i cmdlet anche se non si conoscono i nomi. Ad esempio, se si vuole ottenere un elenco di tutti i cmdlet che operano sui processi, è possibile immettere il comando Get-Help *process* nella console e quindi premere INVIO. I risultati corrispondono a quelli restituiti dal comando Get-Command *process*, ad eccezione del fatto che Get-Help visualizza una sintesi. Questa sintesi è una breve descrizione che consente di identificare il comando desiderato.

A volte, una ricerca con caratteri jolly potrebbe non restituire alcun nome di comando. Ad esempio, l'esecuzione di Get-Help *beep* non troverà alcun comando con beep nel nome. Quando non vengono trovati risultati, il sistema della Guida esegue una ricerca full-text delle descrizioni e delle sintesi disponibili dei comandi. Questa ricerca individua tutti i file della Guida che contengono beep. Se è presente solo un singolo file con una corrispondenza, il sistema della Guida visualizza il relativo contenuto anziché visualizzare un elenco di un solo elemento. Nel caso del termine di ricerca beep, Get-Help restituisce un elenco di due argomenti: Set-PSReadlineOption, un cmdlet e about_Special_Characters, un argomento della Guida concettuale.