Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-CmdletExtensionAgent cmdlet to modify cmdlet extension agents. To enable or disable cmdlet extension agents, use the Enable-CmdletExtensionAgent and Disable-CmdletExtensionAgent cmdlets.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CmdletExtensionAgent -Identity <CmdletExtensionAgentIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Name <String>] [-Priority <Byte>] [-WhatIf [<SwitchParameter>]]

This example changes the priority of the fictitious "Validation Agent" cmdlet extension agent to 9.

Set-CmdletExtensionAgent "Validation Agent" -Priority 9

Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents.

The changes that you make by using the Set-CmdletExtensionAgent cmdlet are applied to every Exchange server in the 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 infrastructure and PowerShell permissions topic.


Parameter Required Type Description




The Identity parameter specifies the cmdlet extension agent that you want to modify. You can use any value that uniquely identifies the agent. For example:

  • Name

  • Distinguished name (DN)

  • GUID




The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.




The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example,




The Name parameter specifies the unique name of the cmdlet extension agent. The maximum length of the agent name is 64 characters. If the name contains spaces, enclose the name in quotation marks (").




The Priority parameter specifies the priority of the cmdlet extension agent. Higher priority agents are applied before lower priority agents. A valid value is an integer from 0 to 255. Lower integer values indicate higher priority.




The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.