Paramètres

 

S’applique à : Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007

Dernière rubrique modifiée : 2007-06-20

La plupart des cmdlets s’appuient sur des paramètres. Les paramètres sont des éléments qui fournissent des informations à la cmdlet, soit en identifiant un objet et ses attributs sur lesquels agir, soit en contrôlant la manière dont la cmdlet exécute sa tâche. Le nom du paramètre est précédé d’un trait d’union (-) et suivi par la valeur du paramètre comme illustré ci-après :

Verb-Noun -ParameterName <ParameterValue> 

Dans cet exemple simple, le trait d’union précédant le nom du paramètre indique à Exchange Management Shell que le mot qui suit immédiatement le trait d’union est un paramètre transmis à la cmdlet et que le mot distinct suivant le paramètre est la valeur du paramètre.

Paramètres de position

Un paramètre de position est un paramètre qui vous permet de spécifier la valeur du paramètre sans spécifier le nom du paramètre. Un paramètre est un paramètre de position si l’attribut Parameter Position est un nombre entier. Ce nombre entier indique la position de la ligne de commande où la cmdlet peut trouver la valeur du paramètre.

La plupart des cmdlets n’ont qu’un seul paramètre de position, Identité. Identité est toujours à la position 1 si ce paramètre est disponible sur une cmdlet. Si un paramètre n’est pas un paramètre de position, il est considéré comme un paramètre named. Vous devez spécifier le nom et la valeur des paramètres named.

Les deux commandes suivantes exécutent la même tâche : le retour des informations de configuration d’un connecteur de réception appelé "Contoso".

Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"

Détails de paramètre

Dans la section Paramètres des informations récupérées par la cmdlet Get-Help, sont inclus les détails, ou métadonnées, de chaque paramètre. L'exemple suivant est tiré de la cmdlet Get-Service.

PARAMETERS
    -ServiceName System.String[]

        Parameter required?           false
        Parameter position?           1
        Default value                 *
        Accept pipeline input?       true
        Accept wildcard characters?  True

Cet exemple de la cmdlet Get-Service inclut certains détails extrêmement spécifiques sur les types de valeur pouvant être passés pour le paramètre ServiceName. Toutes les cmdlets n’incluent pas de tels détails. Toutefois, la plupart des cmdlets incluent certains réglages pour chaque paramètre, comme décrit dans le tableau 1.

Table 1   Paramétrage

Paramètre	Description
Obligatoire ?	Ce réglage indique si la cmdlet est exécutée si vous ne fournissez pas le paramètre. Lorsque Obligatoire ? est défini sur True, Exchange Management Shell vous invite à entrer la valeur si le paramètre n’est pas fourni dans la ligne de commande.
Position ?	Ce réglage indique si vous devez insérer le nom du paramètre devant la valeur du paramètre. Lorsque Position ? est défini sur Named, le nom du paramètre est obligatoire. Lorsque Position ? est défini sur un nombre entier, le nom n’est pas obligatoire, seule la valeur l'est.
Valeur par défaut	Ce réglage indique la valeur par défaut de ce paramètre si aucune autre valeur n’est fournie.
Accepter l’entrée en pipeline ?	Ce réglage indique si le paramètre peut recevoir sa valeur comme une entrée via un pipeline d'une autre cmdlet.
Accepter les caractères génériques ?	Ce réglage indique si la valeur du paramètre peut contenir des caractères génériques et peut être mise en correspondance avec plusieurs objets.

Paramètres booléens

Les Paramètres booléens sont utilisés dans Exchange Management Shell pour déterminer si une fonction ou une option est activée, $True, ou désactivée, $False. La valeur que vous affectez à un paramètre booléen est stockée dans la configuration de l’objet que vous modifiez. Lorsque vous fournissez une valeur à un paramètre booléen, vous devez utiliser les valeurs $True ou 1, ou $False ou 0. Le signe dollar ($) doit être inclus avec $True et $False. Certaines commandes insèrent deux-points (:) entre le nom et la valeur du paramètre booléen. Pour les paramètres booléens, les deux-points sont facultatifs. L’exemple suivant désactive le connecteur de réception « Contoso.com » :

Set-ReceiveConnector "Contoso.com" -Enabled $False

Paramètres booléens

Les paramètres booléens sont utilisés dans Exchange Management Shell pour définir un état pour l’exécution immédiate d’une commande. Cet état n’est pas enregistré d’une commande à l’autre. Les paramètres booléens ressemblent aux paramètres booléens mais servent des objectifs différents et requièrent une syntaxe différente. Les paramètres booléens ne requièrent pas de valeur. Par défaut, si vous spécifiez un paramètre booléen sur une ligne de commande sans valeur, le paramètre se voit affecter la valeur $True. Les paramètres booléens, tout comme les paramètres booléens, acceptent uniquement soit $True ou 1, soit $False ou 0. Le signe dollar ($) doit être inclus avec $True et $False. Contrairement aux paramètres booléens, les paramètres booléens doivent comprendre deux-points (:) entre le nom et la valeur du paramètre. Le premier des exemples suivants demande à Exchange Management Shell d'afficher une invite de confirmation avant de laisser la synchronisation EdgeSync démarrer. Le second exemple demande à Exchange Management Shell de ne pas afficher d'invite de confirmation avant de supprimer le connecteur de réception « Contoso.com » :

Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False

Paramètres communs

Les paramètres communs sont des paramètres ajoutés automatiquement à toutes les commandes par Exchange Management Shell. Ces paramètres exécutent des fonctions qui peuvent être utilisées avec, ou utilisées par, les commandes auxquelles ils sont appliqués. Le tableau 2 répertorie tous les paramètres communs disponibles dans Exchange Management Shell. Trois paramètres supplémentaires, WhatIf, Confirm et ValidateOnly peuvent également être ajoutés à des cmdlets. Pour plus d'informations sur ces paramètres supplémentaires, consultez la rubrique Paramètres WhatIf, Confirm et ValidateOnly.

Tableau 2   Paramètres communs dans Exchange Management Shell

Nom de paramètre	Obligatoire	Type	Description
Commentaires	Facultatif	System.Boolean	Ce paramètre demande à la commande de fournir des informations détaillées sur l’opération. Remarque : La plupart des cmdlets Get ne renvoient que des informations récapitulatives lorsque vous les exécutez. Pour que la cmdlet Get renvoie des informations détaillées lorsque vous exécutez une commande, canalisez la commande vers la cmdlet Format-List. Pour plus d'informations sur le traitement en pipeline, consultez la rubrique Traitement en pipeline. Pour plus d'informations sur la sortie de la commande, consultez la rubrique Utilisation de la sortie d'une commande.
Débogage	Facultatif	System.Boolean	Ce paramètre demande à la commande de fournir des détails au niveau du programmeur sur l’opération.
ErrorAction	Facultatif	System.Enum	Ce paramètre contrôle le comportement de le commande en cas d'erreur. Les valeurs sont les suivantes : NotifyContinue est la valeur par défaut NotifyStop SilentContinue SilentStop Inquire, qui demande à l’utilisateur ce qu’il veut faire
ErrorVariable	Facultatif	System.String	Ce paramètre spécifie le nom de la variable que la commande utilise pour stocker les erreurs rencontrées pendant le traitement. Cette variable est renseignée en plus de $ERROR.
OutVariable	Facultatif	System.String	Ce paramètre spécifie le nom de la variable que la commande utilise pour les objets générés par cette commande. Cela équivaut à canaliser la commande sur Set-Variable <name> -Passthru:$true