Gerenciar agentes de extensão de cmdlet

Aplica-se a: Exchange Server 2013

This topic shows you how to enable, disable, view, and change the priority of cmdlet extension agents in Microsoft Exchange Server 2013. For more information about cmdlet extension agents in Exchange 2013, see Agentes de extensão de cmdlet.

Do que você precisa saber para começar?

Dica

Está com problemas? Peça ajuda nos fóruns do Exchange. Visite os fóruns no Exchange Server.

Habilitar um agente de extensão de cmdlet

Quando você habilita um agente de extensão de cmdlet no Exchange 2013, o agente é executado em todos os servidores que executam o Exchange 2013 na organização. Quando um agente está habilitado, ele é disponibilizado para cmdlets, que podem usar o agente para executar operações adicionais.

Aviso

Antes de habilitar um agente, certifique-se de estar ciente de como o agente funciona e o impacto que o agente terá em sua organização.

Este exemplo habilita um agente de extensão de cmdlet usando o cmdlet Enable-CmdletExtensionAgent . Você deve especificar o nome do agente que deseja habilitar ao executar o cmdlet. Antes de habilitar o Scripting Agent, você precisa ter certeza de que implantou o ScriptingAgentConfig.xml arquivo de configuração em todos os servidores da sua organização. Se você não implantar o arquivo de configuração primeiro e habilitar os Scripting ``Agentcmdlets , todos os cmdlets não get falharão quando eles são executados. Este exemplo habilita o Scripting Agent.

Enable-CmdletExtensionAgent "Scripting Agent"

Para obter informações detalhadas sobre sintaxe e parâmetro, consulte Enable-CmdletExtensionAgent.

Desabilitar um agente de extensão de cmdlet

Quando você desabilitar um agente de extensão de cmdlet no Exchange 2013, o agente é desabilitado em todos os servidores que executam o Exchange 2013 na organização. Quando um agente é desabilitado, ele não é disponibilizado para cmdlets. Os cmdlets não podem mais usar o agente para executar operações adicionais.

Aviso

Antes de desabilitar um agente, certifique-se de saber como o agente funciona e que impacto a sua desativação terá na organização.

Para desabilitar um agente de extensão do cmdlet, use o cmdlet Disable-CmdletExtensionAgent. Especifique o nome do agente que você deseja desabilitar ao executar o cmdlet. Este exemplo desabilita o Scripting Agent.

Disable-CmdletExtensionAgent "Scripting Agent"

Para informações detalhadas de sintaxes e de parâmetros, consulte Disable-CmdletExtensionAgent.

Exibir agentes de extensão de cmdlet existentes

Exibir agentes de extensão de cmdlet permite ver quais agentes são executados primeiro e quais agentes estão habilitados em uma organização do Exchange 2013. Para obter mais informações sobre pipeline e o cmdlet Format-Table, consulte os seguintes tópicos:

Este exemplo obtém os detalhes de um agente de extensão de cmdlet específico usando o cmdlet Get-CmdletExtensionAgent. Neste exemplo, os detalhes do Mailbox Permissions Agent são retornados.

Get-CmdletExtensionAgent "Mailbox Permissions Agent"

Este exemplo obtém vários agentes de extensão de cmdlet usando o cmdlet Get-CmdletExtensionAgent e, em seguida, canaliza a saída para o cmdlet Format-Table . Este exemplo exibe uma lista de todos os agentes de extensão de cmdlet na organização, e ao usar o cmdlet Format-Table, as propriedades Nome, Habilitado e Prioridade de cada agente são exibidas em uma tabela.

Get-CmdletExtensionAgent | Format-Table Name, Enabled, Priority

Para informações detalhadas de sintaxes e de parâmetros, consulte Get-CmdletExtensionAgent.

Alterar a prioridade de um agente de extensão de cmdlet

A capacidade de alterar a prioridade de um agente de extensão de cmdlet no Exchange 2013 é útil quando você deseja que um determinado agente seja chamado por um cmdlet antes de outro agente. Isso é especialmente útil se você criar um script personalizado executado no Scripting Agent, e quiser que esse script tenha precedência sobre um agente interno. Para obter mais informações sobre os Scripting Agentagentes de extensão do cmdlet, consulte Agentes de extensão do Cmdlet.

Aviso

Alterar a prioridade ou substituir a funcionalidade de uma agente integrado é uma operação avançada. Certifique-se de ter entendido completamente as alterações que está realizando.

Os agentes são ordenados de zero para o número máximo de agentes. Quanto mais próximo do zero o agente estiver, maior será a sua prioridade. Agentes com uma prioridade mais alta são chamados primeiro. Para obter mais informações sobre as prioridades do agente, consulte Agentes de extensão cmdlet.

Este exemplo altera a prioridade de um agente de extensão do cmdlet que usa o cmdlet Set-CmdletExtensionAgent. Neste exemplo, a prioridade do Scripting Agent é alterada para 3.

Set-CmdletExtensionAgent "Scripting Agent" -Priority 3

Para informações detalhadas de sintaxes e de parâmetros, consulte Set-CmdletExtensionAgent.