Applies to: Exchange Server 2013
Topic Last Modified: 2012-06-26
Use the Disable-CmdletExtensionAgent cmdlet on a server running Microsoft Exchange Server 2013 to disable an existing cmdlet extension agent.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Disable-CmdletExtensionAgent -Identity
<CmdletExtensionAgentIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example disables a specific cmdlet extension agent.
 Copy Code |
|
|---|---|
Disable-CmdletExtensionAgent "Scripting Agent" |
|
Detailed Description
Run the Disable-CmdletExtensionAgent cmdlet on an Exchange 2013 server to disable an existing cmdlet extension agent. When you disable a cmdlet extension agent, the agent is disabled for the entire organization. When an agent is disabled, it's not made available to cmdlets. Cmdlets can no longer use the agent to perform additional operations.
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 disable. If the name contains spaces, enclose the name in quotation marks ("). |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
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.