Applies to: Exchange Server 2013
Topic Last Modified: 2012-10-16
Use the Enable-CmdletExtensionAgent cmdlet on a server running Microsoft Exchange Server 2013 to enable a cmdlet extension agent.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Enable-CmdletExtensionAgent -Identity
<CmdletExtensionAgentIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example enables the Scripting Agent cmdlet extension agent. Before you enable the Scripting Agent, you need to make sure that you've first deployed the ScriptingAgentConfig.xml configuration file to all 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.
 Copy Code |
|
|---|---|
Enable-CmdletExtensionAgent "Scripting Agent" |
|
Detailed Description
When you enable a cmdlet extension agent, the agent is run on every Exchange 2013 server in the organization. When an agent is enabled, it's made available to cmdlets that can then use the agent to perform additional operations.
 Caution: |
|---|
| Before you enable agents, be sure that you're aware of how the agent works and what impact the agent will have on your organization. |
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Cmdlet extension agents" entry in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.CmdletExtensionAgentIdParameter |
The Identity parameter specifies the name of the cmdlet extension agent to enable. If the name contains spaces, enclose the name in quotation marks ("). |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.