Enable a Cmdlet Extension Agent
Applies to: Exchange Server 2010 SP2, Exchange Server 2010 SP3
When you enable a cmdlet extension agent in Microsoft Exchange Server 2010, the agent is run on every server running Exchange 2010 in the organization. When an agent is enabled, it's made available to cmdlets, which can then use the agent to perform additional operations.
Warning
Before you enable an agent, be sure that you're aware of how the agent works and what impact the agent will have on your organization.
Looking for other management tasks related to managing cmdlet extension agents? Check out Managing Cmdlet Extension Agents.
Prerequisites
Before you enable the Scripting Agent, you must verify that it's configured correctly. For more information about the Scripting Agent, see Understanding the Scripting Agent.
Use the Shell to enable a cmdlet extension agent
You need to be assigned permissions before you can perform this procedure. To see what permissions you need, see the "Cmdlet extension agents" entry in the Exchange and Shell Infrastructure Permissions topic.
Note
You can't use the EMC to enable a cmdlet extension agent.
This example enables a cmdlet extension agent by using the Enable-CmdletExtensionAgent cmdlet. You must specify the name of the agent you want to enable when you run the cmdlet. Before you enable the Scripting Agent, you need to make sure that you've deployed the ScriptingAgentConfig.xml configuration file to all of the servers in your organization. If you don't deploy the configuration file first and you enable the Scripting ``Agent, all non-Get cmdlets fail when they're run. This example enables the Scripting Agent.
Enable-CmdletExtensionAgent "Scripting Agent"
For detailed syntax and parameter information, see Enable-CmdletExtensionAgent.
Other Tasks
After you enable a cmdlet extension agent, you may also want to:
© 2010 Microsoft Corporation. All rights reserved.