Obtendo ajuda

Artigo
09/30/2014

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

Tópico modificado em: 2006-11-15

No Microsoft Exchange Server 2007, o Shell de Gerenciamento do Exchange fornece muitos recursos de ajuda para que você o use aproveitando o máximo de seu potencial. Este tópico descreve os seguintes recursos e funcionalidade de ajuda:

Arquivo de Ajuda do Exchange 2007 O arquivo de Ajuda do Exchange 2007 contém todos os tópicos de ajuda do cmdlet em uma hierarquia baseada em funções e tarefas. Os tópicos de ajuda do cmdlet também têm links para tópicos de procedimento que informam você como executar tarefas específicas.
Cmdlets de Ajuda O Shell de Gerenciamento do Exchange tem vários cmdlets de ajuda que permitem localizar as informações adequadas para realizar a tarefa.
Exibições da Ajuda A Ajuda do Shell de Gerenciamento do Exchange contém informações abrangentes sobre os cmdlets que estão disponíveis para você. As exibições da Ajuda permitem acessar as informações necessárias sobre um cmdlet.
Funções, componentes e funcionalidades de cmdlets Cmdlets podem ser listados por suas funções, componentes ou funcionalidade que gerenciam. Isso permite que você encontre o cmdlet apropriado para a função, componente ou funcionalidade que deseja gerenciar.
Conclusão de tabulação Você pode usar a conclusão de tabulação em nomes de cmdlets e nomes de parâmetros para reduzir o volume de digitação a fazer na linha de comando.

Arquivo de Ajuda do Exchange 2007

O arquivo de Ajuda do Exchange 2007 contém as mesmas informações de ajuda disponíveis em cada cmdlet do Shell de Gerenciamento do Exchange. Entretanto, no arquivo de Ajuda do Exchange 2007, a ajuda de todos os cmdlets é organizada por função de servidor e tarefa de administração para ajudar você a encontrar com facilidade os cmdlets específicos associados à tarefa que você deseja executar. Além disso, os tópicos dos cmdlets do arquivo de Ajuda do Exchange 2007 contêm links para tópicos que apresentam os recursos que eles gerenciam, mostram como usar os cmdlets para gerenciar esses recursos e fornecem detalhes específicos sobre os recursos ou os cenários comuns.

Para obter mais informações sobre os tópicos de ajuda de cmdlets disponíveis no arquivo da Ajuda do Exchange 2007, consulte Shell de Gerenciamento do Exchange (SP1 e SP2).

Para obter mais informações sobre como usar os cmdlets do Shell de Gerenciamento do Exchange para executar tarefas específicas, consulte Operações.

Cmdlets da Ajuda

As tabelas a seguir fornecem exemplos de como usar os cmdlets Get-Help, Get-Command e Get-ExCommand para acessar as informações de ajuda disponíveis para cada cmdlet do Shell de Gerenciamento do Exchange.

A Tabela 1 fornece exemplos de como o cmdlet Get-Help é usado.

Tabela 1 Exemplos de como usar o comando Get-Help

Comando	Descrição
`Get-Help`	Quando você usa o cmdlet Get-Help sozinho, ele apresenta instruções básicas sobre como usar o sistema de ajuda do Shell de Gerenciamento do Exchange.
`Get-Help <cmdlet>`	Quando você fornece ao cmdlet Get-Help um cmdlet do shell como argumento, ele exibe as informações de ajuda para aquele cmdlet. Por exemplo, para recuperar as informações de ajuda do cmdlet Get-SystemMessage, use o seguinte comando: `Get-Help Get-SystemMessage`
`Get-Help <cmdlet>`	Quando você fornece ao cmdlet Get-Help um cmdlet do shell como argumento, junto com um caractere curinga, o cmdlet Get-Help retorna uma lista de todos os cmdlets que correspondem ao texto que você forneceu. Você pode usar vários métodos para recuperar uma lista de cmdlets do shell. Esses métodos incluem o seguinte: *Get-Help Rules Esse comando retorna todos os cmdlets que terminam com a palavra `Rules`. Get-Help GetRules* Esse comando retorna todos os cmdlets que começam com a palavra `Get` e terminam com a palavra `Rules`. Get-Help Get-Export* Esse comando retorna todos os cmdlets que começam com a frase `Get-Export`. Usando caracteres curinga dessa forma, você pode facilmente exibir uma lista de todos os cmdlets disponíveis para um determinado recurso. Por exemplo, usando o comando *Get-Help -TransportAgent**, você pode exibir uma lista de todos os verbos de cmdlet disponíveis para agentes de transporte.
`Get-Help About_*`	O comando Get-Help About_* fornece uma lista de todos os tópicos gerais de ajuda do Shell de Gerenciamento do Exchange para ajudá-lo a compreender e usar melhor o Shell de Gerenciamento do Exchange. Se você quiser saber mais sobre um tópico da lista exibida, execute o comando > de recurso Get-Help About_<. Por exemplo, se você quiser saber mais sobre a instrução `Where`, execute `Get-Help About_Where`.
`Get-Help <cmdlet> -Detailed`	Consulte a seção Exibições da Ajuda posteriormente neste tópico.
`Get-Help <cmdlet> -Full`	Consulte a seção Exibições da Ajuda posteriormente neste tópico.
`Get-Help <cmdlet> -Examples`	Consulte a seção Exibições da Ajuda posteriormente neste tópico.
`Get-Help <cmdlet> -Parameter <parameter name>`	Consulte a seção Exibições da Ajuda posteriormente neste tópico.
`Get-Help -Role <server role>`	Consulte a seção Função, componente e parâmetros de funcionalidade adiante neste tópico.
`Get-Help -Component <component feature>`	Consulte a seção Função, componente e parâmetros de funcionalidade adiante neste tópico.
`Get-Help -Functionality <Global \| User \| Server>`	Consulte a seção Função, componente e parâmetros de funcionalidade adiante neste tópico.

A Tabela 2 fornece exemplos de como o cmdlet Get-Command é usado.

Tabela 2 Exemplos de como usar o comando Get-Command

Cmdlet	Descrição
`Get-Command`	O cmdlet Get-Command fornece uma lista de todos os cmdlets disponíveis para o shell. Como o cmdlet Get-Help, o cmdlet Get-Command permite expansão com caracteres curinga. Você pode usar esse cmdlet com os cmdlets Format-List e Format-Table para fornecer uma exibição mais legível. Por exemplo, use `Get-Command \| Format-List` para exibir a ajuda do cmdlet em formato de lista.
`Get-Command <Cmdlet>`	O comando Get-Command <Cmdlet> fornece informações detalhadas sobre os parâmetros e outros componentes do cmdlet especificado. Você pode usar esse comando juntamente com os cmdlets Format-List e Format-Table para fornecer uma exibição mais legível. Por exemplo, use `Get-Command Get-SystemMessage \| Format-List` para exibir a ajuda do cmdlet em formato de lista.
`Get-Command -Noun <CmdletNoun>`	O comando Get-Command -Noun <CmdletNoun> lista todos os cmdlets que existem com o substantivo especificado. Esse comando é útil quando você deseja exibir uma lista de todos os cmdlets associados a um recurso específico. Por exemplo, o comando Get-Help -Noun SystemMessage retorna todos os cmdlets disponíveis para o recurso `SystemMessage` . Você pode usar esse comando juntamente com os cmdlets Format-List e Format-Table para fornecer uma exibição mais legível. Por exemplo, use `Get-SystemMessage -Noun Get \| Format-List` para exibir a ajuda do comando em formato de lista.
`Get-Command -Verb <CmdletVerb>`	O comando Get-Command -Verb <CmdletVerb> lista todos os cmdlets que existem com o verbo especificado. Esse comando é útil quando você deseja exibir uma lista de todos os cmdlets associados a uma ação específica. Por exemplo, o comando Get-Help -Verb Enable retorna todos os cmdlets disponíveis que executam a ação de habilitar. Você pode usar esse comando juntamente com os cmdlets Format-List e Format-Table para fornecer uma exibição mais legível. Por exemplo, use `Get-Command -Verb SystemMessage \| Format-List` para exibir a ajuda do comando em formato de lista.
`Get-ExCommand`	O cmdlet Get-ExCommand comporta-se de forma idêntica ao cmdlet Get-Command, mas retorna somente cmdlets disponíveis para gerenciar o Exchange 2007.
`Get-PSCommand`	O cmdlet Get-PSCommand comporta-se de forma idêntica ao cmdlet Get-Command, mas exclui cmdlets usados para gerenciar o Exchange 2007.

A Tabela 3 fornece exemplos de como usar vários comandos da ajuda.

Tabela 3 Exemplos de como usar vários comandos da ajuda

Cmdlet	Descrição
`QuickRef`	O comando QuickRef abre um gráfico HTML para impressão que lista os cmdlets do Shell de Gerenciamento do Exchange usados com mais freqüência. Para exibir a versão mais atualizada desse gráfico, consulte Referência rápida do Shell de Gerenciamento do Exchange (em inglês).
`<Cmdlet> -?`	Use o comando <Cmdlet> -? junto com qualquer cmdlet para encontrar as mesmas informações de ajuda disponíveis quando você usa o cmdlet Get-Help. Por exemplo, digite `Get-SystemMessage -?` para exibir ajuda detalhada para o cmdlet Get-SystemMessage.
`Get-Tip`	O cmdlet Get-Tip gera uma nova Dica do Dia do Shell de Gerenciamento do Exchange.
`Get-ExBlog`	O cmdlet Get-ExBlog abre o Microsoft Internet Explorer para exibir o blog da Equipe do Exchange.

Exibições da Ajuda

Quando um cmdlet é especificado como parâmetro do cmdlet Get-Help, as informações da ajuda para o cmdlet especificado são exibidas. Em alguns casos, as informações retornadas podem ser extensas e você pode desejar apenas ver informações específicas. As exibições da ajuda permitem exibir informações específicas sobre um cmdlet sem ter que procurar entre informações que você pode não precisar.

O Shell de Gerenciamento do Exchange oferece quatro exibições que apresentam exatamente as informações desejadas. Você pode também recuperar um parâmetro específico ou um conjunto de parâmetros similares. A Tabela 4 mostra as seções apresentadas em cada exibição.

Tabela 4 Exibições da ajuda do Shell de Gerenciamento do Exchange

Exibição da ajuda	Padrão	Detalhada	Inteira	Exemplos
Sinopse	X	X	X	X
Sintaxe	X	X	X
Descrição detalhada	X	X	X
Parâmetros sem metadados		X
Parâmetros com metadados			X
Tipo de entrada			X
Tipo de retorno			X
Erros			X
Notes			X
Exemplos		X	X	X
Links relacionados	X		X
Comentários	X	X

A Tabela 5 descreve cada exibição e fornece um exemplo de um comando que chama cada exibição.

Tabela 5 Exemplos de exibições da ajuda do Shell de Gerenciamento do Exchange

Exibição da ajuda	Exemplo	Descrição
`Default`	`Get-Help Set-Mailbox`	A exibição padrão é apresentada quando você usa o comando `Get-Help <`cmdlet`>`.
`Detailed`	`Get-Help Set-Mailbox -Detailed`	A exibição `Detailed` é apresentada quando você usa o comando `Get-Help <`cmdlet`> -Detailed`. Os parâmetros retornados na seção `Parameters` não incluem metadados de parâmetros. Para obter mais informações sobre parâmetros, consulte Parâmetros.
`Full`	`Get-Help Set-Mailbox - Full`	A exibição `Full` é apresentada quando você usa o comando `Get-Help <`cmdlet`> -Full`. Os parâmetros retornados na seção `Parameters` incluem os seguintes metadados de parâmetros: `Required?` `Position?` `Default value` `Accept pipeline input?` `Accept wildcard characters?` Para obter mais informações sobre parâmetros, consulte Parâmetros.
`Examples`	`Get-Help Set-Mailbox -Examples`	A exibição `Examples` é apresentada quando você usa o comando `Get-Help <`cmdlet`> -Examples`.

Além dessas quatro exibições da ajuda, o Shell de Gerenciamento do Exchange também permite acessar a descrição e os metadados de um parâmetro específico ou um conjunto de parâmetros semelhantes. Você pode especificar o parâmetro junto com o comando Get-Help <cmdlet>. O exemplo a seguir mostra como você pode exibir a descrição do parâmetro ForwardingAddress no cmdlet Set-Mailbox:

Get-Help Set-Mailbox -Parameter ForwardingAddress

Você pode também exibir um conjunto de parâmetros similares que existem em um cmdlet específico se determinar o nome parcial de um parâmetro junto com um caractere curinga (*). O exemplo a seguir mostra como você pode exibir todos os parâmetros do cmdlet Set-Mailbox que contêm a palavra "Quota":

Get-Help Set-Mailbox -Parameter *Quota*

Dica

Quando você usa o parâmetro Parameter com o cmdlet Get-Help para recuperar a ajuda de um cmdlet que tem apenas um parâmetro, o cmdlet Get-Help não retorna nenhum resultado, mesmo que você use o caractere curinga (*). Esse é um problema conhecido no Microsoft Windows PowerShell.

Parâmetros de Função, Componente e Funcionalidade

Quando chama o cmdlet Get-Help sem indicar um cmdlet específico, você recebe uma lista de todos os cmdlets disponíveis no Shell de Gerenciamento do Exchange. Entretanto, você pode desejar exibir uma lista de cmdlets que gerenciam uma função de servidor específica ou um recurso de componente ou que afetam objetos com determinado escopo de funcionalidade. O cmdlet Get-Help permite que você faça isso com três parâmetros: Função, Componente e Funcionalidade.

Quando usar o cmdlet Get-Help com os parâmetros de Função, Componente ou Funcionalidade, você deverá colocar os valores que especificar para esses parâmetros entre caracteres curinga (*). Seguem-se exemplos de como chamar Get-Help com cada parâmetro:

Get-Help -Role *Mailbox*
Get-Help -Component *Recipient*
Get-Help -Functionality *Server*

As tabelas a seguir listam todos os valores que podem ser usados com os parâmetros de Função, Componente e Funcionalidade no cmdlet Get-Help. A Tabela 6 lista os valores que podem ser usados com o parâmetro Função.

Tabela 6 Valores válidos para Get-Help -Role

Função	Valor	Valor alternativo
Caixa de Correio	`Mailbox`	`MB`
Transporte de Hub	`Hub`	`HT`
Acesso para Cliente	`ClientAccess`	`CA`
Unificação de Mensagens	`UnifiedMessaging`	`UM`
Transporte de Borda	`Edge`	`ET`
Administrador da Organização	`OrgAdmin`	`OA`
Administrador do Servidor	`SrvAdmin`	`SV`
Administrador de Destinatários	`RcptAdmin`	`RA`
Administrador do Windows	`WinAdmin`	`WA`
Somente Leitura	`ReadOnly`	`RO`

A Tabela 7 lista os valores que podem ser usados com o parâmetro Componente.

Tabela 7 Valores válidos para Get-Help -Component

Valor	Valor
`Addressing`	`Mailflow`
`Agent`	`ManagedFolder`
`Antispam`	`Mobility`
`AutoDiscover`	`OAB`
`Calendaring`	`Outlook`
`Certificate`	`OWA`
`Classification`	`Permission`
`Client`	`Pop`
`Cluster`	`PublicFolder`
`Compliance`	`Queuing`
`Delegate`	`Recipient`
`Diagnostic`	`Routing`
`Domain`	`Rule`
`Extensibility`	`Search`
`FreeBusy`	`Server`
`GAL`	`Statistics`
`Group`	`Storage`
`HighAvailability`	`UM`
`Imap`	`VirtualDirectory`
`Mailbox`

A Tabela 8 lista os valores que podem ser usados com o parâmetro Funcionalidade.

Tabela 8 Valores válidos para Get-Help -Functionality

Valor
`Global`
`Server`
`User`

Conclusão de Tabulação

A conclusão de tabulação permite reduzir a digitação necessária quando o Shell de Gerenciamento do Exchange é usado. Ao digitar o nome parcial de um cmdlet, pressione a tecla TAB para que o Shell de Gerenciamento do Exchange complete o nome do cmdlet, caso alguma correspondência seja encontrada. Se vários nomes de cmdlet correspondentes forem encontrados, cada um aparecerá quando você pressionar a tecla TAB. Ao usar a conclusão de tabulação com nomes de cmdlets, você deverá fornecer pelo menos o verbo e o hífen (-). Os exemplos a seguir mostram como você pode usar a conclusão de tabulação ao digitar o nome de um cmdlet:

Get-Transport<Tab>
Enable-<Tab>

Quando você pressiona a tecla TAB no primeiro exemplo, o Shell de Gerenciamento do Exchange pesquisa todos os nomes de cmdlets que começam com Get-Transport. No segundo exemplo, o Shell de Gerenciamento do Exchange pesquisa todos os cmdlets que contêm o verbo Enable.

Assim como ocorre com nomes de cmdlets, você também pode usar a conclusão de tabulação quando desejar que o Shell de Gerenciamento do Exchange complete o nome parcial de um parâmetro digitado. Ao usar a conclusão de tabulação com nomes de parâmetros, você deverá especificar o nome completo do cmdlet digitando-o ou usando a conclusão de tabulação. Os exemplos a seguir mostram como você pode usar a conclusão de tabulação ao digitar o nome de um parâmetro:

Set-Mailbox -Email<Tab>
New-TransportRule -Cond<Tab>

Quando você pressiona a tecla TAB no primeiro exemplo, o Shell de Gerenciamento do Exchange pesquisa todos os nomes de parâmetros que começam com Email no cmdlet Set-Mailbox. No segundo exemplo, quando você pressiona a tecla TAB, o Shell de Gerenciamento do Exchange completa o parâmetro Condition no cmdlet New-TransportRule.