Parâmetros
Aplica-se a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007
Tópico modificado em: 2007-06-20
A maioria dos cmdlets se baseia nos parâmetros. Parâmetros são elementos que fornecem informações ao cmdlet, quer identificando um objeto e seus atributos sobre os quais ele deve agir, quer controlando o modo como o cmdlet executa sua tarefa. O nome do parâmetro é precedido por um hífen (-) e seguido pelo valor do parâmetro, da seguinte forma:
Verb-Noun -ParameterName <ParameterValue>
Nesse exemplo simples, o hífen à frente do nome do parâmetro informa ao Shell de Gerenciamento do Exchange que a palavra posicionada imediatamente após o hífen é um parâmetro transmitido ao cmdlet, e que o termo seguinte, logo depois do parâmetro, é o valor do parâmetro.
Parâmetros posicionais
Um parâmetro posicional permite especificar o valor do parâmetro sem especificar o nome do parâmetro. Um parâmetro é posicional se o atributo Parameter Position for um inteiro. Esse inteiro indica a posição na linha de comando em que o cmdlet encontrará o valor do parâmetro.
A maioria dos cmdlets possui apenas um único parâmetro posicional, o Identity. O parâmetro Identity estará sempre na posição 1, se estiver disponível em um cmdlet. Se um parâmetro não for posicional, ele será considerado um parâmetro named. Você deve especificar o nome e o valor de um parâmetro para os parâmetros named.
Os dois comandos a seguir executam a mesma tarefa: retornar informações de configuração para um Conector de Recebimento denominado "Contoso".
Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"
Detalhes dos parâmetros
Os detalhes, também chamados de metadados, estão incluídos na seção Parâmetros das informações recuperadas pelo cmdlet Get-Help, em cada parâmetro. O exemplo a seguir é do cmdlet Get-Service.
PARAMETERS
-ServiceName System.String[]
Parameter required? false
Parameter position? 1
Default value *
Accept pipeline input? true
Accept wildcard characters? True
Este exemplo do cmdlet Get-Service contém alguns detalhes muito específicos sobre os tipos de valor que podem ser transmitidos para o parâmetro ServiceName. Nem todos os cmdlets possuem esses detalhes. Contudo, a maioria dos cmdlets realmente inclui algumas configurações de cada parâmetro, descritas na Tabela 1.
Tabela 1 Configurações de parâmetros
| Configuração | Descrição |
|---|---|
Necessário(s)? |
Essa configuração indica se o cmdlet será executado, caso você não forneça o parâmetro. Quando Necessário(s)? estiver definido como |
Posição? |
Esta configuração indica se você deverá colocar o nome do parâmetro na frente do valor. Quando Posição? for definido como Quando Posição? estiver definido como um inteiro, o nome não será obrigatório, só o valor. |
Valor padrão |
Essa configuração indica o valor padrão desse parâmetro, se nenhum outro valor for especificado. |
Aceitar entrada de pipeline? |
Essa configuração indica se o parâmetro pode aceitar seu valor como uma entrada através de uma pipeline de outro cmdlet. |
Aceitar caracteres curinga? |
Essa configuração indica se o valor do parâmetro pode conter caracteres curinga e corresponder a vários objetos. |
Parâmetros booleanos
Os Parâmetros booleanos são usados no Shell de Gerenciamento do Exchange para detectar se um recurso ou uma opção está habilitada(o), $True, ou desabilitada(o), $False. O valor atribuído a um parâmetro booleano é armazenado na configuração do objeto que está sendo modificado. Ao fornecer um valor para um parâmetro booleano, use os valores $True ou 1, ou $False ou 0. O símbolo de cifrão ($) deve constar em $True e em $False. Observe que alguns comandos inserem um caractere de dois-pontos (:) entre o nome e o valor do parâmetro booleano. Em parâmetros booleanos, esse caractere de dois-pontos é opcional. O exemplo a seguir desabilita o Conector de Recebimento "Contoso.com":
Set-ReceiveConnector "Contoso.com" -Enabled $False
Parâmetros de opção
Os Parâmetros de opção são usados no Shell de Gerenciamento do Exchange para definir um estado para a execução imediata de um comando. Esse estado não é salvo entre comandos. Os parâmetros de opção são parecidos com os parâmetros booleanos, mas atendem a outros propósitos e exigem uma sintaxe diferente. Os parâmetros de opção não exigem um valor. Por padrão, se você especificar um parâmetro de opção sem um valor em uma linha de comando, o parâmetro será avaliado como $True. Como os booleanos, os parâmetros de opção aceitam somente $True ou 1, ou $False ou 0. O símbolo de cifrão ($) deve constar em $True e em $False. Ao contrário dos parâmetros booleanos, você deverá inserir um caractere de dois-pontos (:) entre o nome e o valor do parâmetro de opção. O primeiro exemplo a seguir instrui o Shell de Gerenciamento do Exchange a exibir um prompt de confirmação antes que a sincronização do EdgeSync seja iniciada. O segundo exemplo instrui o Shell de Gerenciamento do Exchange a não exibir um prompt de confirmação antes de excluir o Conector de Recebimento "Contoso.com":
Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False
Parâmetros comuns
Os Parâmetros comuns são automaticamente adicionados a todos os comandos pelo Shell de Gerenciamento do Exchange. Esses parâmetros executam funções que podem ser usadas com ou pelos comandos em que são executadas. A Tabela 2 lista todos os parâmetros comuns disponíveis no Shell de Gerenciamento do Exchange. Três parâmetros adicionais, WhatIf,, Confirm e ValidateOnly, também podem ser adicionados aos cmdlets. Para obter mais informações sobre esses parâmetros adicionais, consulte Parâmetros WhatIf, Confirm e ValidateOnly.
Tabela 2 Parâmetros comuns no Shell de Gerenciamento do Exchange
| Nome do parâmetro | Necessário(s) | Tipo | Descrição |
|---|---|---|---|
Detalhado |
Opcional |
System.Boolean |
Esse parâmetro instrui o comando a fornecer informações detalhadas sobre a operação. Dica A maioria dos cmdlets Get retornam apenas informações resumidas quando são executados. Para dizer ao cmdlet Get que retorne informações detalhadas ao executar um comando, canalize o comando para o cmdlet Format-List. |
Depuração |
Opcional |
System.Boolean |
Este parâmetro instrui o comando a fornecer detalhes no nível do programador sobre a operação. |
ErrorAction |
Opcional |
System.Enum |
Esse parâmetro controla o comportamento do comando quando um erro ocorrer. Os valores são:
|
ErrorVariable |
Opcional |
System.String |
Esse parâmetro especifica o nome da variável que o comando usa para armazenar os erros detectados durante o processamento. Essa variável é preenchida, além de |
OutVariable |
Opcional |
System.String |
Esse parâmetro especifica o nome da variável que o comando usa para armazenar os objetos retornados por esse comando. É o mesmo que canalizar o comando para |