Syntaxe
S’applique à : Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Dernière rubrique modifiée : 2007-02-08
Cette rubrique explique comment lire les ensembles de paramètres et les exemples de l'environnement de ligne de commande Exchange Management Shell dans la documentation d’aide sur Exchange et comment mettre en forme une commande afin que l'environnement de ligne de commande Exchange Management Shell traite cette commande. Dans l'environnement de ligne de commande Exchange Management Shell, les ensembles de paramètres sont affichés dans la section d’utilisation de la rubrique d’aide d’une cmdlet. Dans le fichier d’aide d'Microsoft Exchange Server 2007, les ensembles de paramètres sont affichés dans la section Syntaxe de la rubrique d’aide de la cmdlet.
Pour plus d'informations sur l'aide de la cmdlet, consultez la rubrique Obtenir de l'Aide.
Conventions de commande dans l'environnement de ligne de commande Exchange Management Shell
L'environnement de ligne de commande Exchange Management Shell obéit à de nombreuses conventions de commandes vous permettant de comprendre les informations obligatoires et facultatives lorsque vous exécutez une commande et la manière dont vous devez présenter les paramètres et leurs valeurs. Consulter la section Ensemble des paramètres à la suite de cette rubrique sur les exemples de présentation des ensembles de paramètres dans l’aide de l'environnement de ligne de commande Exchange Management Shell et dans le fichier d’aide Exchange 2007.
Le tableau 1 répertorie ces conventions de commande.
Tableau 1 Conventions de commande de l'environnement de ligne de commande Exchange Management Shell
| symbole | Description |
|---|---|
- |
Un trait d’union indique que le mot suivant sur la ligne de commande est un paramètre. Le paramètre le plus répandu est Identity. Pour plus d'informations sur les paramètres, consultez la rubrique Paramètres. |
< > |
Les signes plus grand que permettent d’entourer les valeurs des paramètres. Ces valeurs peuvent être des choix ou des noms. Dans |
[ ] |
Les crochets permettent d’entourer un paramètre facultatif et sa valeur. Un paramètre et sa valeur qui ne sont ne sont pas entourés par des crochets ne sont pas obligatoires. |
| |
Lorsque le symbole de canalisation est utilisé dans une liste de valeur de paramètre, telle que |
Ces conventions de commande permettent de comprendre la manière dont une commande doit être construite. Vous ne tapez pas ces conventions lorsque vous entrez la commande sur la ligne de commande.
Ensemble de paramètres
Dans la documentation d’aide d’Exchange, toutes les cmdlets affichent leurs paramètres associés dans les ensembles de paramètres. Les ensembles de paramètres sont des regroupements de paramètres pouvant être utilisés ensemble. Les paramètres qui existent dans un ensemble de paramètres, et non dans l’autre, s’excluent mutuellement. Ils ne peuvent être utilisés ensemble.
Bien que toutes les cmdlets aient des ensembles de paramètres, la plupart n’ont qu’un seul. Cela signifie que tous les paramètres de cette cmdlet peuvent être utilisés ensemble. D’autres cmdlets peuvent avoir plusieurs ensembles de paramètres. L’exemple suivant affiche les ensembles de paramètres disponibles dans la cmdlet New-SystemMessage :
New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false>
-Language <CultureInfo> -Text <String> [-DomainController <String>] [-Templ
ateInstance <MshObject>]
New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailbox
UnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | Warning
PublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSen
dReceiveMailBox> -Text <String> [-DomainController <String>] [-TemplateInst
ance <MshObject>]
La cmdlet New-SystemMessage contient deux ensembles de paramètres. Le premier ensemble de paramètres contient le paramètre DsnCode et le paramètre Internal, et le deuxième ensemble de paramètres contient le paramètre QuotaMessageType. Ceci signifie que le paramètre DsnCode et le paramètre Internal peuvent être utilisés ensemble. Il n'est cependant pas possible de l'utiliser avec le paramètre QuotaMessageType. Les paramètres restants, Language, Text, DomainController, et TemplateInstance, sont énumérés dans les deux ensembles de paramètres. Ceci signifie qu’ils peuvent être utilisés avec le paramètre DsnCode et le paramètre Internal et avec le paramètre QuotaMessageType.
Les ensembles de paramètres peuvent indiquer qu’une seule cmdlet peut avoir plusieurs usages. Par exemple, vous pouvez utiliser la cmdlet New-SystemMessage pour configurer les messages de notification de statuts de remise personnalisée (DSN) ou les messages de limite de quota de boîte aux lettres personnalisée. Cependant, les cmdlets contiennent généralement de nombreux ensembles de paramètres car un paramètre peut exécuter une fonction incompatible avec un autre paramètre. L'exemple suivant affiche les ensembles de paramètres pour la cmdlet New-AddressList :
New-AddressList -Name <String> [-Company <MultiValuedProperty>] [-Container
<AddressListIdParameter>] [-Department <MultiValuedProperty>] [-DisplayNam
e <String>] [-DomainController <String>] [-IncludedRecipients <Nullable>] [
-StateOrProvince <MultiValuedProperty>] [-TemplateInstance <MshObject>]
New-AddressList -Name <String> [-Container <AddressListIdParameter>] [-Disp
layName <String>] [-DomainController <String>] [-RecipientFilter <String>]
[-TemplateInstance <MshObject>]
Dans la cmdlet New-AddressList, le premier ensemble de paramètre répertorie les paramètres vous permettant de créer une nouvelle liste d’adresses basée sur les valeurs fournies aux paramètres Company, Department, IncludedRecipients, et StateOrProvice. Cependant, vous pouvez également créer une nouvelle liste d’adresses en utilisant un filtrage personnalisé spécifié avec le paramètre RecipientFilter. Lorsque vous créez une nouvelle liste d’adresses, un filtrage personnalisé spécifié en utilisant le paramètre RecipientFilter réécrit toute configuration en utilisant les paramètres existants dans le premier ensemble de paramètres. Ainsi, le paramètre RecipientFilter est placé dans son propre ensemble de paramètres. Exchange 2007 ne vous permet pas de spécifier les deux paramètres sur la même ligne de commande. Comme avec la cmdlet New-SystemMessage, le reste des paramètres existants dans les deux ensembles de paramètres de la cmdlet New-AddressList peuvent être utilisés dans toute combinaison.
Utilisation des guillemets
Les guillemets doubles ( " ) sont les plus communément utilisés pour encadrer une valeur contenant des espaces lorsque vous transmettez une valeur à un paramètre. Par exemple, si vous voulez transmettre Contoso Receive Connector au paramètre Name de la cmdlet Set-ReceiveConnector, vous devez entourer Contoso Receive Connector de guillemets, comme dans l'exemple suivant :
Set-ReceiveConnector -Name "Contoso Receive Connector"
Si vous ne placez pas la chaîne entre guillemets, l'environnement de ligne de commande Exchange Management Shell tente d'interpréter chaque mot de la chaîne comme un nouvel argument de la ligne de commande et affiche une erreur.
Dans l'environnement de ligne de commande Exchange Management Shell, les guillemets doubles et les guillemets simples ( ' ) ont une signification différente. Lorsque vous placez une chaîne entre guillemets doubles, l'environnement de ligne de commande Exchange Management Shell remplace les variables par une valeur correspondante. Par exemple, la valeur ServerName est affectée à la variable $Server. La commande suivante est entrée dans la ligne de commande :
"$Server Example"
La sortie suivante est affichée :
ServerName Example
La variable $Server est remplacée par la valeur ServerName dans la sortie.
Lorsque vous placez une chaîne entre guillemets simples, l'environnement de ligne de commande Exchange Management Shell ne tente pas de remplacer les variables par une valeur correspondante. Supposons que la variable $Server a toujours la valeur ServerName. La commande suivante est entrée dans la ligne de commande :
'$Server-Example'
La sortie suivante est affichée :
$Server-Example
La variable $Server n'a pas été remplacée par une valeur car l'environnement de ligne de commande Exchange Management Shell n'interprète pas les variables incluses dans le texte entre guillemets simples.
Pour plus d'informations sur les variables, consultez les rubriques variables définies par l'utilisateur et Variables shell.
Vous pouvez afficher certains caractères, tels que le signe dollar ( $ ), les guillemets simples ou doubles ou l'accent grave ( ` ). Ces caractères ont des significations spéciales lorsque vous les utilisez dans l'environnement de ligne de commande Exchange Management Shell. Pour que l'environnement de ligne de commande Exchange Management Shell n'interprète pas ces caractères et les affiche lorsqu'ils sont inclus dans une chaîne entourée de guillemets doubles, vous devez utiliser le caractère d'échappement accent grave ( ` ). Par exemple, tapez le texte suivant dans la ligne de commande :
"The price is `$23."
La sortie suivante est affichée :
The price is $23.
Comme le caractère d'échappement accent grave a été utilisé avec le signe dollar ( $ ), l'environnement de ligne de commande Exchange Management Shell n'interprète pas le signe $ au début de la variable.
Si vous placez une chaîne entre guillemets simples, vous n'avez pas à ignorer de caractère, sauf si vous voulez afficher un guillemet simple dans une chaîne. Si vous voulez afficher un guillemet simple dans une chaîne placée entre guillemets simples, vous devez utiliser deux guillemets simples ( '' ). Par exemple, tapez le texte suivant dans la ligne de commande :
'Don''t confuse two single quotation marks with a double quotation mark!'
La sortie suivante est affichée :
Don't confuse two single quotation marks with a double quotation mark!
Opérateurs de commande dans l'environnement de ligne de commande Exchange Management Shell
Utilisez les opérateurs du Tableau 2 lorsque vous tapez les commandes dans l'environnement de ligne de commande Exchange Management Shell. Certains opérateurs peuvent correspondre à certaines conventions de commande mentionnées précédemment. Cependant, ils n’ont pas la même signification lorsqu’ils sont tapés dans la ligne de commande. Le tableau 2 présente les opérateurs valides que vous pouvez utiliser dans une commande.
Tableau 2 Opérateurs de commande de l'environnement de ligne de commande Exchange Management Shell
| Opérateur | Description |
|---|---|
= |
Le signe Égal est utilisé comme caractère d’affectation. La valeur à droite du signe Égal est affectée à la variable à gauche du signe Égal. Les caractères ci-après sont également des caractères d’affectation :
|
: |
Deux points peuvent être utilisés pour séparer le nom et la valeur d’un paramètre, comme dans l’exemple suivant : |
! |
Le point d’exclamation est un opérateur logique NOT. Lorsqu’il est utilisé avec le signe Égal (= ), la paire combinée signifie « est différent de ». |
[ ] |
Les crochets permettent de spécifier la valeur d’index d’une position de tableau. Par exemple, Les crochets permettent également d’affecter un type de variable, comme dans l’exemple suivant : |
{ } |
Les accolades permettent d’inclure une expression dans une commande, comme dans l’exemple suivant : |
| |
Le symbole de canalisation est utilisé quand une cmdlet canalise un résultat vers une autre cmdlet. La commande suivante par exemple, canalise les résultats à partir de la cmdlet Get-Mailbox vers la cmdlet Move-Mailbox : |
> |
L’angle droit de la parenthèse permet d’envoyer la sortie d’une commande vers un fichier, comme dans l’exemple suivant : |
>> |
Les parenthèses à double angle droit permettent d’ajouter la sortie d’une commande dans un fichier, si le fichier existe. Si le fichier n’existe pas, un nouveau fichier est créé. L’exemple suivant montre comment utiliser les parenthèses à double angle droit : |
" " |
Les guillemets permettent d’encadrer une chaîne contenant des espaces. |
$ |
Un signe de dollar indique une variable. Par exemple, |
@ |
Le symbole @ fait référence à un tableau associatif. Pour plus d'informations, consultez la rubrique Tableaux. |
$( ) |
Un signe de dollar ( |
.. |
Les points doubles permettent d’indiquer une plage de valeurs. Par exemple, si un tableau contient plusieurs indices, vous pouvez spécifier la commande suivante pour renvoyer les valeurs de tous les indices situés entre les deuxièmes et les cinquièmes indices, comme dans l’exemple suivant : |
+ |
L’opérateur + associe deux valeurs. Par exemple, |
- |
L’opérateur - extrait une valeur à partir d’une autre valeur. Par exemple, L’opérateur - permet également de représenter un nombre négatif tel que |
* |
Un caractère générique a plusieurs significations. Les caractères génériques permettent de faire correspondre les chaînes, de multiplier les valeurs numériques, ou, au cas où les chaînes et les valeurs numériques sont utilisées ensembles, de répéter la valeur de la chaîne le nombre de fois spécifié par la valeur numérique, comme dans l’exemple suivant : |
/ |
L’opérateur / divise une valeur par une autre. Par exemple, |
% |
L’opérateur % renvoie le reste à partir d’un opérateur de division. Par exemple, |