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

Get-CmdletExtensionAgent

 

Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-25

Use the Get-CmdletExtensionAgent cmdlet on a server running Microsoft Exchange Server 2013 to display a list of cmdlet extension agents in the organization.

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

Get-CmdletExtensionAgent [-Assembly <String>] [-Enabled <$true | $false>] <COMMON PARAMETERS>
Get-CmdletExtensionAgent [-Identity <CmdletExtensionAgentIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>]

This example displays the details about a specific cmdlet extension agent.

Get-CmdletExtensionAgent "Mailbox Permissions Agent"

This example displays a list of all the cmdlet extension agents in the organization. The Name, Enabled, and Priority properties of each agent are displayed in a table. This is done by piping the results of the Get-CmdletExtensionAgent cmdlet to the Format-Table cmdlet.

For more information about pipelining and the Format-Table cmdlet, see the following topics:

Get-CmdletExtensionAgent | Format-Table Name, Enabled, Priority

Run the Get-CmdletExtensionAgent cmdlet on an Exchange 2013 server to display a list of cmdlet extension agents 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

Assembly

Optional

System.String

The Assembly parameter specifies that only the agents that match the assembly name provided should be listed.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the cmdlet should return a list of enabled agents only, or a list of disabled agents only. Valid values are $true and $false.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.CmdletExtensionAgentIdParameter

The Identity parameter specifies the name of the cmdlet extension agent to view. If the name contains spaces, enclose the name in quotation marks (").

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.