Sintaxe

  • Artigo

 

Aplica-se a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007

Tópico modificado em: 2007-02-08

Este tópico explica como ler os conjuntos e exemplos de parâmetros do Shell de Gerenciamento do Exchange na documentação da Ajuda do Exchange e como formatar um comando para que o Shell de Gerenciamento do Exchange possa processá-lo. No Shell de Gerenciamento do Exchange, os conjuntos de parâmetros são exibidos na seção Uso de um tópico da ajuda do cmdlet. No arquivo de Ajuda do Microsoft Exchange Server 2007, os conjuntos de parâmetros são exibidos na seção Sintaxe do tópico de ajuda do cmdlet.

Para obter mais informações sobre a ajuda do cmdlet, consulte Obtendo ajuda.

Convenções de comandos no Shell de Gerenciamento do Exchange

O Shell de Gerenciamento do Exchange segue várias convenções de comandos que ajudam a compreender quais informações são necessárias ou opcionais ao executar um comando e como você deve apresentar os parâmetros e seus valores. Consulte a seção Conjuntos de parâmetros posteriormente neste tópico para obter exemplos de como os conjuntos de parâmetros são apresentados na Ajuda do Shell de Gerenciamento do Exchange e no arquivo de Ajuda do Exchange 2007.

A Tabela 1 lista essas convenções de comandos.

Tabela 1   Convenções de comandos do Shell de Gerenciamento do Exchange

Símbolo Descrição

-

Um hífen indica que a próxima palavra na linha de comando é um parâmetro. O parâmetro mais comum é Identity. Para obter mais informações sobre parâmetros, consulte Parâmetros.

< >

Sinais de maior e menor são usados para delimitar valores de parâmetros. Esses valores podem ser opções ou nomes. Por exemplo, em -Parameter1 <1 | 2 | 3>, os números representam opções de valores específicos. Em -Parameter2 <ServerName>, ServerName representa o valor real.

[ ]

Colchetes são usados para delimitar um parâmetro opcional e seu valor. Se um parâmetro e seu valor não estiverem entre colchetes, eles são necessários.

|

Quando o símbolo de barra vertical é usado em uma lista de valores de parâmetro, como -Parameter1 <1 | 2 | 3>, ele indica uma opção entre valores disponíveis. Essa convenção se aplica a parâmetros System.Enum e System.Boolean.

Essas convenções de comandos ajudam a compreender como um comando deve ser construído. Você não digita essas convenções ao inserir o comando na linha de comando.

Conjuntos de parâmetros

Na documentação da Ajuda do Exchange, todos os cmdlets exibem seus parâmetros associados em conjuntos de parâmetros. Os conjuntos de parâmetros são grupos de parâmetros que podem ser usados em combinação. Parâmetros existentes em um conjunto de parâmetros, mas não em outro, são mutuamente exclusivos. Eles não podem ser usados juntos.

Embora todos os cmdlets possuam conjuntos de parâmetros, muitos têm apenas um conjunto de parâmetros. Isso significa que todos os parâmetros no cmdlet podem ser combinados entre si. Outros cmdlets podem ter vários conjuntos de parâmetros. O exemplo a seguir exibe os conjuntos de parâmetros disponíveis no 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>]

O cmdlet New-SystemMessage tem dois conjuntos de parâmetros. O primeiro conjunto contém os parâmetros DsnCode e Internal e o segundo contém o parâmetro QuotaMessageType. Isso significa que os parâmetros DsnCode e Internal podem ser usados em conjunto. Mas, eles não podem ser usados com o parâmetro QuotaMessageType. Os parâmetros restantes, Language, Text, DomainController e TemplateInstance, são listados nos dois conjuntos de parâmetros. Isso significa que eles podem ser usados com os parâmetros DsnCode e Internal e com o parâmetro QuotaMessageType.

Conjuntos de parâmetros podem indicar que um único cmdlet pode ter vários usos. Por exemplo, você pode usar o cmdlet New-SystemMessage para configurar mensagens de DSN (notificação de status de entrega) personalizadas ou configurar mensagens de limite de cota de caixa de correio personalizadas. No entanto, os cmdlets têm normalmente vários conjuntos de parâmetros, já que um parâmetro pode realizar uma função que é incompatível com outro parâmetro. O exemplo a seguir exibe os conjuntos de parâmetros do 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>]

No cmdlet New-AddressList, o primeiro conjunto de parâmetros lista os parâmetros que permitem criar uma nova lista de endereços com base nos valores fornecidos para os parâmetros Company, Department, IncludedRecipients e StateOrProvice. No entanto, você também pode criar uma nova lista de endereços usando um filtro personalizado que é especificado com o parâmetro RecipientFilter. Ao criar uma nova lista de endereços, um filtro personalizado que foi especificado com o parâmetro RecipientFilter substitui qualquer item configurado com os parâmetros do primeiro conjunto de parâmetros. Portanto, o parâmetro RecipientFilter é colocado em seu próprio conjunto de parâmetros. O Exchange 2007 não permite especificar ambos os parâmetros na mesma linha de comando. Como ocorre com o cmdlet New-SystemMessage, os parâmetros restantes existentes nos dois conjuntos de parâmetros do cmdlet New-AddressList podem ser usados em qualquer combinação.

Uso de aspas

Aspas duplas ( " ) são normalmente usadas para incluir um valor que tenha espaços quando você passa esse valor para um parâmetro. Por exemplo, se desejar passar Contoso Receive Connector para o parâmetro Name do cmdlet Set-ReceiveConnector, você deverá colocar Contoso Receive Connector entre aspas, como no exemplo a seguir:

Set-ReceiveConnector -Name "Contoso Receive Connector"

Se você não colocar a cadeia de caracteres entre aspas, o Shell de Gerenciamento do Exchange tentará interpretar cada palavra como um novo argumento da linha de comando e exibirá um erro.

No Shell de Gerenciamento do Exchange, aspas duplas e aspas simples ( ' ) têm significados diferentes. Quando você coloca uma cadeia de caracteres entre aspas duplas, o Shell de Gerenciamento do Exchange substitui qualquer variável por um valor correspondente. Por exemplo, presuma que o valor ServerName tenha a variável $Server atribuída a ele. Em seguida, imagine que o comando a seguir seja digitado na linha de comando:

"$Server Example"

O resultado a seguir é exibido:

ServerName Example

A variável $Server é substituída pelo valor ServerName no resultado.

Quando você coloca uma cadeia de caracteres entre aspas simples, o Shell de Gerenciamento do Exchange não tenta substituir variáveis por um valor correspondente. Presuma que a variável $Server ainda tenha o valor ServerName atribuído a ela. Em seguida, imagine que o comando a seguir seja digitado na linha de comando:

'$Server-Example'

O resultado a seguir é exibido:

$Server-Example

A variável $Server não foi substituída por um valor, porque o Shell de Gerenciamento do Exchange não interpreta variáveis incluídas no texto que está entre aspas simples.

Para obter mais informações sobre variáveis, consulte Variáveis definidas pelo usuário e Variáveis de Shell.

Você também pode desejar exibir alguns caracteres, como o cifrão ( $  ), aspas simples ou duplas ou a crase (  `  ). Esses caracteres possuem significados especiais quando usados no Shell de Gerenciamento do Exchange. Para instruir o Shell de Gerenciamento do Exchange para não interpretar esses caracteres e exibi-los quando forem incluídos em uma cadeia de caracteres entre aspas duplas, você deverá usar o caractere de escape da crase ( ` ). Por exemplo, digite o texto a seguir na linha de comando:

"The price is `$23."

O resultado a seguir é exibido:

The price is $23.

Como usamos o caractere de escape da crase com o cifrão ( $  ), o Shell de Gerenciamento do Exchange não interpreta o $ como o início de uma variável.

Se você colocar uma cadeia de caracteres entre aspas simples, não será necessário escapar nenhum caractere, a não ser que deseje exibir uma aspa simples na cadeia de caracteres. Se desejar exibir uma aspa simples em uma cadeia de caracteres que esteja entre aspas simples, você deverá usar duas aspas simples ( '' ). Por exemplo, digite o seguinte na linha de comando:

'Don''t confuse two single quotation marks with a double quotation mark!'

O resultado a seguir é exibido:

Don't confuse two single quotation marks with a double quotation mark!

Operadores de comandos no Shell de Gerenciamento do Exchange

Use os operadores na Tabela 2 ao digitar comandos no Shell de Gerenciamento do Exchange. Alguns dos operadores podem coincidir com algumas das convenções de comando mencionadas anteriormente. Mas eles não têm o mesmo significado quando são digitados na linha de comando. A Tabela 2 mostra os operadores válidos que podem ser usados em um comando.

Tabela 2   Operadores de comandos do Shell de Gerenciamento do Exchange

Operador Descrição

=

O sinal de igual é usado como um caractere de atribuição. O valor à direita do sinal de igual é atribuído à variável à esquerda do sinal de igual. Os caracteres a seguir também são caracteres de atribuição:

  • +=   Adicione o valor à direita do sinal de igual ao valor atual contido na variável à esquerda do sinal de igual.

  • -=   Subtraia o valor à direita do sinal de igual do valor atual contido na variável à esquerda do sinal de igual.

  • *=   Multiplique o valor atual da variável à esquerda do sinal de igual pelo valor especificado à direita do sinal de igual.

  • /=   Divida o valor atual da variável à esquerda do sinal de igual pelo valor especificado à direita do sinal de igual.

  • %=   Modifique o valor atual da variável à esquerda do sinal de igual pelo valor especificado à direita do sinal de igual.

:

Dois pontos podem ser usados para separar o nome de um parâmetro e seu valor, como no exemplo a seguir: -Enabled:$True. O uso de dois pontos é opcional com todos os tipos de parâmetros, exceto com parâmetros de opção. Para obter mais informações sobre parâmetros de opção, consulte Parâmetros.

!

O ponto de exclamação é um operador lógico NOT. Quando usado com o sinal de igual ( = ), o par combinado significa "não é igual a".

[ ]

Parênteses são usados para especificar o valor de índice de uma posição de matriz. Por exemplo, $Red[9] refere-se à décima posição de índice na matriz, $Red. Refere-se à décima posição de índice, já que os índices de uma matriz começam com zero ( 0 ).

Parênteses também podem ser usados para atribuir um tipo a uma variável, como no seguinte exemplo: $A=[XML] "<Test><A>value</A></Test>". Os tipos a seguir são válidos: Array, Bool, Byte, Char, Char[], Decimal, Double, Float, Int, Int[], Long, Long[], RegEx, Single, ScriptBlock, String, Type, e XML.

{ }

Chaves são usadas para incluir uma expressão em um comando, como no exemplo a seguir: Get-Process | Where { $_.HandleCount -gt 400 }

|

O símbolo de barra vertical é usado quando um cmdlet canaliza um resultado para outro cmdlet. Por exemplo, o comando a seguir canaliza os resultados do cmdlet Get-Mailbox para o cmdlet Move-Mailbox: Get-Mailbox -Server SRV1 | Move-Mailbox -TargetDatabase SRV2

>

O sinal de maior é usado para enviar a saída de um comando para um arquivo, como no exemplo a seguir: Get-TransportRulePredicate > c:\out.txt. O arquivo de destino é substituído.

>>

Dois sinais de maior são usados para anexar a saída de um comando a um arquivo, se o arquivo estiver presente. Se o arquivo não existir, um novo arquivo será criado. A seguir está um exemplo de como usar dois sinais de maior: Get-TransportRulePredicate >>c:\out.txt

" "

Aspas são usadas para envolver uma cadeia de caracteres que contenha espaços.

$

Um sinal de cifrão indica uma variável. Por exemplo, $Blue = 10 atribui o valor 10 à variável $Blue.

@

O símbolo @ refere-se a uma matriz associativa. Para obter mais informações, consulte Matrizes. 

$( )

Um sinal de cifrão ( $ ) com parênteses indica uma substituição de comando. Você pode usar a substituição de comando quando quiser usar a saída de um comando como um argumento em outro comando, como no exemplo a seguir: Get-ChildItem $(Read-Host -Prompt "Enter FileName: ")

..

Pontos duplos indicam um intervalo de valores. Por exemplo, se uma matriz contiver vários índices, você poderá especificar o comando a seguir para retornar os valores de todos os índices entre o segundo e o quinto índices, como no exemplo a seguir: $Blue[2..5]

+

O operador + adiciona dois valores juntos. Por exemplo, 6 + 6 é igual a 12.

-

O operador - subtrai um valor de outro valor. Por exemplo, 12 - 6 é igual a 6.

O operador - também pode ser usado para representar um número negativo, como -6. Por exemplo, -6 * 6 é igual a -36.

*

Um caractere curinga tem vários significados. Você pode usar caracteres curinga para corresponder cadeias de caracteres, para multiplicar valores numéricos ou, se as cadeias de caracteres e os valores numéricos forem usados juntos, para repetir o valor da cadeia quantas vezes estiver especificado pelo valor numérico, como no exemplo a seguir: "Test" * 3 é igual a TestTestTest.

/

O operador / divide um valor por outro. Por exemplo, 6 / 6 é igual a 1.

%

O operador % retorna o restante de um operador de divisão. Por exemplo, , 6 % 4 é igual a 2.