Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-CmdletExtensionAgent

 

Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-25

Use the Set-CmdletExtensionAgent cmdlet on a server running Microsoft Exchange Server 2013 to modify a cmdlet extension agent.

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

Set-CmdletExtensionAgent -Identity <CmdletExtensionAgentIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IsSystem <$true | $false>] [-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

The changes applied to an agent are applied to every Exchange 2013 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 and Shell Infrastructure Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.CmdletExtensionAgentIdParameter

The Identity parameter specifies the name of the cmdlet extension agent to modify. 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.

IsSystem

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

Name

Optional

System.String

The Name parameter specifies the 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 (").

Priority

Optional

System.Byte

The Priority parameter specifies where in the priority order of the cmdlet extension agent list the agent should be placed. The priority must be between 0 and the maximum number of agents. Agents with a priority closest to 0 have a higher priority and are run first.

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.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.