Sintaxis
Se aplica a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Última modificación del tema: 2007-02-08
En este tema, se explica cómo leer los ejemplos y conjuntos de parámetros del Shell de administración de Exchange de la documentación de ayuda de Exchange y cómo dar formato a un comando para que el Shell de administración de Exchange pueda procesarlo. En el Shell de administración de Exchange, los conjuntos de parámetros se muestran en la sección de uso del tema de ayuda del cmdlet. En el archivo de ayuda de Microsoft Exchange Server 2007, los conjuntos de parámetros se muestran en la sección de sintaxis del tema de ayuda del cmdlet.
Para obtener más información acerca de la ayuda de cmdlet, vea Ayuda.
Convenciones de comandos del Shell de administración de Exchange
El Shell de administración de Exchange utiliza muchas convenciones de comandos que le ayudan a saber qué información es necesaria u opcional al ejecutar un comando y cómo debe representar los parámetros y sus valores. Vea la sección Conjuntos de parámetros más adelante en este tema para conocer ejemplos de presentación de los conjuntos de parámetros en la ayuda del Shell de administración de Exchange y el archivo de ayuda de Exchange 2007.
En la Tabla 1, se enumeran estas convenciones de comandos.
Tabla 1 Convenciones de comandos del Shell de administración de Exchange
| Símbolo | Descripción |
|---|---|
- |
El guión indica que la siguiente palabra de la línea de comandos es un parámetro. El parámetro más común es Identity. Para obtener más información acerca de los parámetros, vea Parámetros. |
< > |
Los corchetes angulares se utilizan para delimitar valores de parámetros. Estos valores pueden ser opciones o nombres. Por ejemplo, en |
[ ] |
Los corchetes se utilizan para delimitar un parámetro opcional y su valor. Es necesario que haya un parámetro y un valor que no estén entre corchetes. |
| |
Si se utiliza una barra vertical en una lista de valores de parámetros (por ejemplo, |
Estas convenciones de comandos le ayudan a entender cómo se debería construir un comando. No hay que escribir estas convenciones al introducir el comando en la línea de comandos.
Conjuntos de parámetros
En la documentación de ayuda de Exchange, todos los cmdlets muestran sus parámetros asociados en conjuntos de parámetros. Los conjuntos de parámetros son grupos de parámetros que se pueden utilizar juntos. Los parámetros que están en un conjunto de parámetros, pero no en otro, son mutuamente excluyentes. Es decir, no se pueden utilizar juntos.
Aunque todos los cmdlets tienen conjuntos de parámetros, muchos sólo tienen un conjunto de parámetros. Esto significa que todos los parámetros de ese cmdlet se pueden utilizar juntos. Otros cmdlets pueden tener muchos conjuntos de parámetros. En el siguiente ejemplo, se muestran los conjuntos de parámetros que están disponibles en el 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>]
El cmdlet New-SystemMessage posee dos conjuntos de parámetros. El primero contiene el parámetro DsnCode y el parámetro Internal, y el segundo contiene el parámetro QuotaMessageType. Esto significa que el parámetro DsnCode y el parámetro Internal se pueden utilizar juntos. Sin embargo, no se pueden utilizar con el parámetro QuotaMessageType. El resto de los parámetros (Language, Text, DomainController y TemplateInstance) se incluyen en ambos conjuntos de parámetros. Eso significa que se pueden utilizar con el parámetro DsnCode, el parámetro Internal y el parámetro QuotaMessageType.
Los conjuntos de parámetros pueden indicar que un solo cmdlet puede tener varios usos. Por ejemplo, se puede utilizar el cmdlet New-SystemMessage para configurar mensajes de notificación de estado de entrega (DSN) personalizados o configurar mensajes de límite de la cuota del buzón personalizados. Sin embargo, los cmdlets suelen tener varios conjuntos de parámetros, porque un parámetro podría realizar una función que es incompatible con otro. En el siguiente ejemplo, se muestran los conjuntos de parámetros del 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>]
En el cmdlet New-AddressList, el primer conjunto de parámetros incluye parámetros que permiten crear una nueva lista de direcciones basándose en los valores que se proporcionan a los parámetros Company, Department, IncludedRecipients y StateOrProvice. Sin embargo, también se puede crear una nueva lista de direcciones utilizando un filtro personalizado que se especifica con el parámetro RecipientFilter. Al crear una nueva lista de direcciones, el filtro personalizado que se ha especificado con el parámetro RecipientFilter anula cualquier opción configurada con los parámetros incluidos en el primer conjunto de parámetros. Por lo tanto, el parámetro RecipientFilter se encuentra en su propio conjunto de parámetros. Exchange 2007 no permite especificar ambos parámetros en la misma línea de comandos. Al igual que con el cmdlet New-SystemMessage, los demás parámetros que están incluidos en los dos conjuntos de parámetros del cmdlet New-AddressList se pueden utilizar en cualquier combinación.
Utilización de comillas
Las dobles comillas ( " ) se utilizan habitualmente para delimitar un valor con espacios al pasar este valor a un parámetro. Por ejemplo, si quiere pasar Contoso Receive Connector al parámetro Name del cmdlet Set-ReceiveConnector, debe delimitar Contoso Receive Connector entre comillas como en el siguiente ejemplo:
Set-ReceiveConnector -Name "Contoso Receive Connector"
Si no delimita la cadena entre comillas, el Shell de administración de Exchange intenta interpretar cada palabra de la cadena como un argumento nuevo en la línea de comandos y muestra un error.
En el Shell de administración de Exchange, las comillas dobles y las comillas simples ( ' ) tienen significados diferentes. Cuando se delimita una cadena entre comillas dobles, el Shell de administración de Exchange sustituye cualquier variable por un valor coincidente. Por ejemplo, suponga que el valor de ServerName se asigna a la variable $Server. A continuación, suponga que se introduce el siguiente comando en la línea de comandos:
"$Server Example"
Aparecerá lo siguiente:
ServerName Example
La variable $Server se sustituye por la variable ServerName en la salida.
Cuando se cierra una cadena entre comillas simples, el Shell de administración de Exchange no intenta sustituir ninguna variable por un valor coincidente. Suponga que la variable $Server sigue asignada al valor de ServerName. A continuación, suponga que se introduce el siguiente comando en la línea de comandos:
'$Server-Example'
Aparecerá lo siguiente:
$Server-Example
La variable $Server no se ha sustituido por un valor porque el Shell de administración de Exchange no interpreta ninguna variable incluida en el texto delimitado entre comillas simples.
Para obtener más información sobre las variables, consulte Variables definidas por el usuario y Variables de shell. .
También es posible que quiera mostrar algunos caracteres, tales como el signo de dólar ( $ ), comillas dobles o simples o comilla inclinada ( ` ). Estos caracteres tienen significados especiales cuando se utilizan en el Shell de administración de Exchange. Para indicar al Shell de administración de Exchange que no interprete estos caracteres y los muestre cuando se incluyan en una cadena delimitada entre comillas, debe utilizar el carácter de escape de comilla inclinada ( ` ). Por ejemplo, escriba el siguiente texto en la línea de comandos:
"The price is `$23."
Aparecerá lo siguiente:
The price is $23.
Dado que utilizamos el carácter de escape de comilla inclinada con el signo del dólar ( $ ), el Shell de administración de Exchange no interpreta el $ como el comienzo de una variable.
Si delimita una cadena entre comillas simples, no tiene que salir de ningún carácter a no ser que desee mostrar una comilla simple en una cadena. Si desea mostrar una comilla simple en una cadena delimitada entre comillas simples, debe utilizar dos comillas dobles ('') Por ejemplo, escriba lo siguiente en la línea de comandos:
'Don''t confuse two single quotation marks with a double quotation mark!'
Aparecerá lo siguiente:
Don't confuse two single quotation marks with a double quotation mark!
Operadores de comandos del Shell de administración de Exchange
Utilice los operadores de la Tabla 2 para escribir los comandos en el Shell de administración de Exchange. Algunos de los operadores pueden utilizar algunas de las convenciones de comandos mencionadas anteriormente. Sin embargo, no tienen el mismo significado cuando se escriben en la línea de comandos. En la Tabla 2, se indican los operadores válidos que se pueden utilizar en un comando.
Tabla 2 Operadores de comandos del Shell de administración de Exchange
| Operador | Descripción |
|---|---|
= |
El signo igual se utiliza como carácter de asignación. El valor del lado derecho del signo igual se asigna a la variable del lado izquierdo. Los siguientes caracteres también son de asignación:
|
: |
Se pueden utilizar dos puntos para separar el nombre de un parámetro de su valor, como en el ejemplo siguiente: |
! |
El signo de exclamación es un operador NOT lógico. Cuando se utiliza con el signo igual (= ), la combinación significa "distinto a". |
[ ] |
Los paréntesis se utilizan para especificar el valor de índice de una posición de matriz. Por ejemplo, Los paréntesis también se utilizan para asignar un tipo a una variable, como en el ejemplo siguiente: |
{ } |
Las llaves se utilizan para incluir una expresión en un comando, como en el ejemplo siguiente: |
| |
La barra vertical se utiliza cuando un cmdlet canaliza un resultado a otro cmdlet. Por ejemplo, el siguiente comando canaliza los resultados desde el cmdlet Get-Mailbox al cmdlet Move-Mailbox: |
> |
El corchete angular derecho se utiliza para enviar el resultado de un comando a un archivo, como en el ejemplo siguiente: |
>> |
Los corchetes angulares derechos dobles se utilizan para adjuntar el resultado de un comando a un archivo, si dicho archivo existe. Si no existe, se crea un archivo nuevo. En el siguiente ejemplo, se ilustra cómo utilizar los corchetes angulares derechos dobles: |
" " |
Las comillas se utilizan para delimitar una cadena que contiene espacios. |
$ |
El signo de dólar indica una variable. Por ejemplo, |
@ |
El símbolo @ hace referencia a una matriz asociativa. Para obtener más información, vea Matrices (en inglés). |
$( ) |
El signo de dólar ( |
.. |
Los puntos dobles indican un intervalo de valores. Por ejemplo, si una matriz contiene varios índices, puede especificar el comando siguiente para recuperar los valores de todos los índices comprendidos entre el segundo y el quinto, como en el ejemplo siguiente: |
+ |
El operador + suma dos valores. Por ejemplo, |
- |
El operador - resta un valor de otro. Por ejemplo, El operador - también se puede utilizar para representar un valor negativo (por ejemplo, |
* |
El carácter del comodín tiene varios significados. Puede utilizarlo para hacer coincidir cadenas, para multiplicar valores numéricos o, si se utilizan cadenas y valores numéricos juntos, para repetir el valor de la cadena el número de veces que especifique el valor numérico, como en el ejemplo siguiente: |
/ |
El operador / divide un valor entre otro. Por ejemplo, |
% |
El operador % devuelve el resto de un operador de división. Por ejemplo, |