Paramètres

 

Sapplique à :Exchange Server 2013

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.

Cette rubrique traite des paramètres suivants et de leur comportement dans le Shell :

Paramètres de position

Paramètres booléens

Paramètres de commutateur

Paramètres communs de Windows PowerShell

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. Pour plus d’informations sur les différents attributs qui configurent un paramètre, consultez la section Détails de paramètre ultérieurement dans cette rubrique.

La plupart des cmdlets ont un seul paramètre de position : Identity. Le paramètre Identity est toujours en position 1 s’il est disponible dans une cmdlet. Certaines cmdlets possèdent plusieurs paramètres positionnels. Avec ces cmdlets, vous pouvez spécifier les valeurs pour chaque paramètre positionnel dans l’ordre spécifié par l’attribut Parameter Position sur chaque paramètre. Les valeurs pour chaque paramètre doivent être en position correcte sur la ligne de commande pour fonctionner correctement.

Si un paramètre n’est pas de type positionnel, il est considéré comme paramètre named. Vous devez spécifier le nom et la valeur des paramètres named.

Les deux commandes suivantes permettent d’effectuer la même tâche de renvoi des informations de configuration pour un connecteur de réception appelé "Contoso".

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

Les deux commandes suivantes exécutent la même tâche. Les valeurs de paramètre positionnel dans la première commande sont placées en ordre précis tel que requis par l’attribut de position de paramètre.

Set-ExampleCmdlet "Seattle Users" $True "Contoso.com"
Set-ExampleCmdlet -Name "Seattle Users" -Enabled $True -Domain "Contoso.com"

Les attributs, également appelés métadonnées sur chaque paramètre sont inclus dans la section Paramètres de l’aide du Shell qui est récupérée par la cmdlet Get-Help. 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 spécifiques sur les types de valeur pouvant être transmis 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 suivant.

Configuration des paramètres

Paramètre Description

Required?

Ce réglage indique si la cmdlet est exécutée si vous ne fournissez pas le paramètre. Lorsque Required? est défini sur True, l'environnement de ligne de commande 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.

Default value

Ce réglage indique la valeur par défaut de ce paramètre si aucune autre valeur n’est fournie.

Accept pipeline input?

Ce réglage indique si le paramètre peut recevoir sa valeur comme une entrée via un pipeline d’une autre cmdlet.

Accept wildcard characters?

Ce réglage indique si la valeur du paramètre peut contenir des caractères génériques et si elle peut être mise en correspondance avec plusieurs objets.

Les paramètres booléens sont utilisés dans le Shell pour déterminer, entre autres choses, 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

Les paramètres de commutateur sont généralement utilisés pour indiquer si la commande en cours doit continuer avec une boîte de dialogue supplémentaire ou activer une autre option pour exécuter la commande. Cet état n’est pas enregistré d’une commande à l’autre. Les paramètres de commutateur ressemblent aux paramètres booléens mais servent des objectifs différents et requièrent une syntaxe différente. Les paramètres de commutateur ne nécessitent aucune valeur. Lorsque vous spécifiez un paramètre de commutateur sur une ligne de commande sans ajouter une valeur, le paramètre l’évalue à $True.

Sur certaines cmdlets, la cmdlet peut s’exécuter comme si le paramètre de commutateur était inclus sur la ligne de commande, même si vous ne l’avez pas inclus par vous-même. Ce comportement se produit le plus souvent avec le paramètre de commutateur Confirm sur les cmdlets, ce qui risque de provoquer la perte de données si ces cmdlets sont exécutées involontairement. Dans le cas du paramètre de commutateur Confirm sur une telle cmdlet, cette cmdlet vous invite toujours à confirmer avant l'exécution, sauf si vous spécifiez explicitement à la cmdlet de ne pas procéder à l'exécution en remplaçant le paramètre de commutateur. Vous pouvez le remplacer en incluant le paramètre de commutateur Confirm sur la ligne de commande avec la valeur :$False. Contrairement aux autres paramètres, le caractère « deux-points » (:) est obligatoire entre les paramètres de commutateur et la valeur $False.

Le premier des exemples suivants demande à la cmdlet Start-EdgeSynchronization d’afficher une boîte de dialogue de confirmation avant le démarrage de synchronisation EdgeSync. Le second exemple demande à la cmdlet Remove-ReceiveConnector de ne pas afficher une boîte de dialogue de confirmation avant la suppression du connecteur de réception "Contoso.com":

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

Plusieurs paramètres de Windows PowerShell sont ajoutés automatiquement à toutes les commandes par l’environnement de ligne de commande Exchange Management Shell. Ces paramètres exécutent des fonctions qui peuvent être utilisées avec ou par les commandes auxquelles ils sont appliqués. Le tableau suivant répertorie tous les paramètres communs disponibles dans le Shell. Trois paramètres supplémentaires, WhatIf,Confirm et ValidateOnly, peuvent également être ajoutés aux cmdlets. Pour plus d’informations sur ces paramètres supplémentaires, voir Commutateurs WhatIf, Confirm et ValidateOnly.

Paramètres communs de Windows PowerShell dans l’environnement de ligne de commande Exchange Management Shell

Nom de paramètre Obligatoire Type Description

Debug

Facultatif

System.Boolean

Le paramètre Debug demande à la commande de fournir des détails au niveau du programmeur sur l'opération.

ErrorAction

Facultatif

System.Enum

Le paramètre ErrorAction contrôle le comportement de la commande en cas d'erreur. Les valeurs sont les suivantes :

  • Continue est la valeur par défaut

  • Stop

  • SilentlyContinue

  • Inquire, qui demande à l’utilisateur ce qu’il veut faire

ErrorVariable

Facultatif

System.String

Le paramètre ErrorVariable 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

Le paramètre OutVariable 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

Verbose

Facultatif

System.Boolean

Le paramètre Verbose demande à la commande de fournir des informations détaillées sur l'opération.

RemarqueRemarque :
La plupart des cmdlets Get ne renvoient que des informations récapitulatives lorsque vous les exécutez. Pour que la cmdlet Get renvoie toutes les propriétés d'un objet, canalisez la commande vers la cmdlet Format-List.
Pour plus d’informations, voir Traitement en pipeline et Utilisation de la sortie de la commande.
 
Afficher: