ARGOMENTO
about_Parameters
DESCRIZIONE BREVE
Descrive la modalità di utilizzo dei parametri dei cmdlet in Windows
PowerShell.
DESCRIZIONE DETTAGLIATA
La maggior parte dei cmdlet e delle funzioni di Windows
PowerShell si basa su parametri per consentire agli utenti di
selezionare opzioni o fornire input. I parametri seguono il nome
del cmdlet o della funzione e in genere hanno il formato seguente:
-<nome_parametro> <valore_parametro>
Il nome del parametro è preceduto da un trattino (-), che segnala
a Windows PowerShell che la parola successiva al trattino è un
parametro e non un valore da passare al cmdlet o alla funzione.
Non tutti i parametri richiedono un valore e non tutti i nomi di
parametro devono essere specificati. In alcuni casi il nome del
parametro è implicito e non è necessario includerlo nel comando.
Il tipo e i requisiti dei parametri variano in base al cmdlet e alla
funzione. Per informazioni sui parametri di un cmdlet, utilizzare il
cmdlet Get-Help. Ad esempio, per informazioni sui parametri del cmdlet
Get-ChildItem, digitare:
get-help get-childitem
Per informazioni sui parametri di una funzione, rivedere le
definizioni dei parametri. I parametri sono definiti dopo il nome
della funzione o nel corpo della stessa, mediante la parola
chiave Param. Per ulteriori informazioni, vedere about_Functions.
Alcune funzioni contengono inoltre la Guida basata su commenti
relativa ai parametri. Utilizzare il cmdlet Get-Help con queste
funzioni. Per ulteriori informazioni, vedere l'argomento della Guida
relativo a Get-Help e about_Comment_Based_Help.
Il cmdlet Get-Help restituisce vari dettagli sul cmdlet o la
funzione, tra cui una descrizione, la sintassi del comando,
informazioni sui parametri ed esempi di utilizzo del cmdlet o
della funzione.
È possibile utilizzare anche il parametro Parameter del cmdlet o della
funzione Get-Help per trovare informazioni su un determinato parametro.
In alternativa, è possibile utilizzare il carattere jolly (*) con il
parametro Parameter per trovare informazioni su tutti i parametri del
cmdlet o della funzione. Ad esempio, con il comando seguente è possibile
ottenere informazioni su tutti i parametri del cmdlet o della funzione
Get-Member:
get-help get-member -parameter *
In queste informazioni sono inclusi i dettagli necessari per
l'utilizzo del parametro. Ad esempio, nell'argomento della Guida
relativo al cmdlet Get-ChildItem sono inclusi i dettagli seguenti sul
parametro Path:
-path <string[]>
Specifica un percorso di una o più posizioni. È consentito
l'utilizzo di caratteri jolly. La posizione predefinita è la
directory corrente (.).
Required? false
Position? 1
Valore predefinito Current directory
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? true
Le informazioni sul parametro includono la sintassi, una
descrizione e gli attributi del parametro.
Nelle sezioni seguenti vengono descritti gli attributi dei parametri.
Parameter Required?
Questa impostazione indica se il parametro è obbligatorio, ovvero
se tutti i comandi che utilizzano questo cmdlet devono includere il
parametro. Se il valore è "True" e il parametro non è presente nel
comando, viene richiesto un valore per il parametro.
Parameter Position?
Questa impostazione indica se è possibile fornire il valore di un
parametro senza farlo precedere dal nome del parametro. Se
l'impostazione è "0" o "named", il nome del parametro è
obbligatorio. Questo tipo di parametro è noto come parametro
denominato. Un parametro denominato può essere immesso in
qualsiasi punto dopo il nome del cmdlet.
Se l'impostazione "Parameter position?" è impostata su un numero
intero diverso da 0, il nome del parametro non è obbligatorio.
Questo tipo di parametro è noto come posizionale. Il numero indica la
posizione in cui il parametro deve essere inserito rispetto agli
altri parametri posizionali. Se si include il nome di un parametro
posizionale, quest'ultimo può essere inserito in qualsiasi posizione
dopo il nome del cmdlet.
Ad esempio, il cmdlet Get-ChildItem dispone dei parametri Path ed
Exclude. L'impostazione "Parameter position?" del parametro Path è 1,
pertanto si tratta di un parametro posizionale. L'impostazione "Parameter
position?" di Exclude è 0, pertanto si tratta di un parametro denominato.
Pertanto, non è necessario immettere il nome del parametro Path, ma il
valore di tale parametro deve essere il primo o l'unico valore di
parametro non denominato nel comando. Poiché tuttavia Exclude è un
parametro denominato, è possibile immetterlo in qualsiasi posizione
nel comando.
Come conseguenza delle impostazioni "Parameter position?" di
questi due parametri, è possibile utilizzare uno qualsiasi tra i
comandi seguenti:
Get-ChildItem -path c:\techdocs -exclude *.ppt
Get-ChildItem c:\techdocs -exclude *.ppt
Get-ChildItem -exclude *.ppt -path c:\techdocs
Get-ChildItem -exclude *.ppt c:\techdocs
Se occorre includere un altro parametro posizionale senza
indicarne il nome, è necessario collocarlo nell'ordine specificato
dall'impostazione "Parameter position?".
Parameter Type
Con questa impostazione viene specificato il tipo Microsoft .NET
Framework del valore del parametro. Ad esempio, se il tipo è Int32, il
valore del parametro deve essere un valore intero. Se il tipo è string, il
valore del parametro deve essere una stringa di caratteri. Qualora la
stringa contenga spazi, il valore deve essere racchiuso tra
virgolette oppure gli spazi devono essere preceduti dal carattere di
escape (`).
Default Value
Con questa impostazione viene specificato il valore attribuito al
parametro qualora non ne venga fornito un altro. Ad esempio, il valore
predefinito del parametro Path è spesso la directory corrente. I parametri
obbligatori non dispongono mai di un valore predefinito. Per molti
parametri facoltativi, non è previsto alcun valore predefinito poiché
non vi sono conseguenze se il parametro non viene utilizzato.
Accepts Multiple Values?
Questa impostazione indica se un parametro accetta più valori.
Quando un parametro accetta più valori, è possibile digitare un elenco
separato da virgole come valore del parametro nel comando oppure
salvare un elenco separato da virgole (matrice) in una variabile,
quindi specificare la variabile come valore del parametro.
Ad esempio, il parametro ServiceName del cmdlet Get-Service
accetta più valori. I comandi seguenti sono entrambi validi:
get-service -servicename winrm, netlogon
$s = "winrm", "netlogon"
get-service -servicename $s
Accepts Pipeline Input?
Questa impostazione indica se è possibile utilizzare l'operatore
pipeline (|) per inviare un valore al parametro.
Valore Descrizione
----- -----------
False Indica che non è possibile reindirizzare un
valore al parametro.
True (by Value) Indica che è possibile reindirizzare
qualsiasi valore al parametro, purché
il valore disponga del tipo .NET Framework
specificato per il parametro o possa essere
convertito nel tipo .NET Framework specificato.
Quando un parametro è "True (by Value)",
in Windows PowerShell viene tentata
l'associazione di qualsiasi valore
reindirizzato con tale parametro prima
che vengano tentati altri metodi per
interpretare il comando.
True (by Property Name) Indica che è possibile reindirizzare un valore
al parametro, ma il tipo .NET Framework del
parametro deve includere una proprietà con lo
stesso nome del parametro.
Ad esempio, è possibile reindirizzare solo un
valore a un parametro Name solo quando il valore
dispone di una proprietà denominata "Name."
Accepts Wildcard Characters?
Questa impostazione indica se il valore del parametro può contenere
caratteri jolly, così da poterlo confrontare con più elementi del
contenitore di destinazione.
Parametri comuni
I parametri comuni sono parametri che è possibile utilizzare con
qualsiasi cmdlet.
Per ulteriori informazioni sui parametri comuni, digitare:
help about_commonparameters
VEDERE ANCHE
about_Command_syntax
about_Comment_Based_Help
about_Functions_Advanced
about_Pipelines
about_Wildcards