Parameters
Si applica a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Ultima modifica dell'argomento: 2007-06-20
La maggior parte dei cmdlet si basa su parametri. I parametri sono elementi che forniscono informazioni sul cmdlet, identificando un oggetto e i relativi attributi applicati o controllando il modo in cui il cmdlet effettua le operazioni. Il nome del parametro è preceduto da un trattino (-) ed è seguito dal valore del parametro come indicato di seguito:
Verb-Noun -ParameterName <ParameterValue>
In questo semplice esempio, il trattino davanti al nome del parametro indica a Exchange Management Shell che la parola immediatamente dopo il trattino è il parametro trasmesso al cmdlet e che la parola separata successiva posta dopo il parametro è il valore del parametro.
Parametri posizionali
Un parametro posizionale è un parametro che consente di specificare il valore del parametro senza specificare il nome del parametro. Un parametro è un parametro posizionale se l'attributo Parameter Position è un numero intero. Il numero intero indica la posizione nella riga di comando in cui il cmdlet può trovare il valore del parametro.
La maggior parte dei cmdlet dispone di un solo parametro posizionale, Identity. Identity è sempre in posizione 1 se è disponibile in un cmdlet. Se un parametro non è un parametro posizionale, viene considerato un parametro named. Nel caso di parametri named, occorre specificare il nome del parametro e il valore del parametro.
I due comandi indicati di seguito effettuano la stessa operazione: restituiscono le informazioni di configurazione di un connettore di ricezione denominato "Contoso".
Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"
Dettagli dei parametri
Nella sezione Parametri delle informazioni recuperate dal cmdlet Get-Help sono riportati i dettagli, denominati anche metadati, relativi a ciascun parametro. Il seguente esempio è tratto dal cmdlet Get-Service.
PARAMETERS
-ServiceName System.String[]
Parameter required? false
Parameter position? 1
Default value *
Accept pipeline input? true
Accept wildcard characters? True
In questo esempio tratto dal cmdlet Get-Service sono inclusi alcuni dettagli molto specifici sui tipi di valore che possono essere trasmessi al parametro ServiceName. Non tutti i cmdlet comprendono tali dettagli. La maggior parte dei cmdlet, tuttavia, comprende alcune impostazioni per ciascun parametro, come descritto nella Tabella 1.
Tabella 1 Impostazioni dei parametri
| Impostazione | Descrizione |
|---|---|
Obbligatorio? |
Questa impostazione indica se il cmdlet verrà eseguito se non si fornisce il parametro. Quando Obbligatorio? è impostato su |
Posizione? |
Questa impostazione indica se occorre immettere il nome del parametro davanti al valore del parametro. Quando Posizione? è impostato su Quando Posizione? è impostato su un numero intero, il nome non è obbligatorio, ma lo è il valore. |
Valore predefinito |
Questa impostazione indica il valore predefinito di questo parametro se non è fornito un altro valore. |
Accettare input nella pipeline? |
Questa impostazione indica se il parametro può ricevere il valore da un altro cmdlet sotto forma di input attraverso una pipeline. |
Accettare caratteri jolly? |
Questa impostazione indica se il valore del parametro può contenere caratteri jolly e se può essere associato a più oggetti. |
Parametri booleani
I Parametri booleani vengono utilizzati in Exchange Management Shell per determinare se una funzionalità o un'opzione è abilitata, $True, o disabilitata, $False. Il valore assegnato a un parametro booleano viene memorizzato nella configurazione dell'oggetto da modificare. Quando si fornisce un valore a un parametro booleano, occorre utilizzare i valori $True o 1 oppure $False o 0. Il simbolo del dollaro ($) deve essere incluso in $True e $False. Gli utenti potrebbero notare come alcuni comandi inseriscano i due punti (:) tra il nome del parametro booleano e il valore booleano. Nei parametri booleani i due punti sono facoltativi. Nel seguente esempio viene disabilitato il connettore di ricezione "Contoso.com":
Set-ReceiveConnector "Contoso.com" -Enabled $False
Parametri opzionali
I Parametri opzionali vengono utilizzati in Exchange Management Shell per impostare lo stato di esecuzione immediata di un comando. Tale stato non viene memorizzato tra i comandi. I parametri opzionali sono simili ai parametri booleani ma vengono utilizzati per scopi diversi e richiedono una sintassi diversa. I parametri opzionali non richiedono un valore. Per impostazione predefinita, se si specifica un parametro opzionale in una riga di comando senza un valore, il parametro viene impostato su $True. I parametri opzionali, come i parametri booleani, accettano solo $True o 1 oppure $False o 0. Il simbolo del dollaro ($) deve essere incluso in $True e $False. Diversamente dai parametri booleani, occorre includere i due punti (:) tra il nome del parametro opzionale e il valore dell'opzione. Nel primo esempio il parametro consente a Exchange Management Shell di visualizzare un prompt di conferma prima di avviare la sincronizzazione di EdgeSync. Nel secondo esempio il parametro consente a Exchange Management Shell di non visualizzare un prompt di conferma prima di eliminare il connettore di ricezione "Contoso.com":
Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False
Parametri comuni
I Parametri comuni sono parametri che vengono aggiunti automaticamente a tutti i comandi da Exchange Management Shell. Tali parametri eseguono funzioni che possono essere utilizzate con o dai comandi sui quali i parametri sono in esecuzione. La Tabella 2 elenca tutti i parametri comuni disponibili in Exchange Management Shell. Altri tre parametri, WhatIf, Confirm e ValidateOnly, possono essere aggiunti ai cmdlet. Per ulteriori informazioni su tali parametri aggiuntivi, vedere Parametri WhatIf, Confirm e ValidateOnly.
Tabella 2 Parametri comuni in Exchange Management Shell
| Nome parametro | Obbligatorio | Tipo | Descrizione |
|---|---|---|---|
Verbose |
Facoltativo |
System.Boolean |
Questo parametro consente al comando di fornire informazioni dettagliate sull'operazione. Nota La maggior parte dei cmdlet Get restituisce solo informazioni di riepilogo quando in esecuzione. Per richiedere al cmdlet Get di restituire informazioni dettagliate quando si esegue un comando, reindirizzare il comando al cmdlet Format-List. |
Debug |
Facoltativo |
System.Boolean |
Questo parametro consente al comando di fornire dettagli sull'operazione a livello di programmazione. |
ErrorAction |
Facoltativo |
System.Enum |
Questo parametro consente di verificare il comportamento del comando in caso di errore. Di seguito sono riportati i valori validi:
|
ErrorVariable |
Facoltativo |
System.String |
Questo parametro consente di specificare il nome della variabile utilizzata dal comando per memorizzare gli errori incontrati durante l'elaborazione. Tale variabile viene inserita in aggiunta a |
OutVariable |
Facoltativo |
System.String |
Questo parametro consente di specificare il nome della variabile utilizzata dal comando per gli oggetti visualizzati da questo comando. Questo corrisponde al reindirizzamento del comando a |