Get-CmdletExtensionAgent

 

Applies to: Exchange Server 2016

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

Use the Get-CmdletExtensionAgent cmdlet to view cmdlet extension agents.

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

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

This example displays a summary list of all the cmdlet extension agents in the organization.

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

This example displays detailed information for the Exchange cmdlet extension agent named Mailbox Creation Time Agent.

Get-CmdletExtensionAgent "Mailbox Creation Time Agent"

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.

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

Assembly

Optional

System.String

The Assembly parameter filters the results by the specified Assembly property value. The value for the built-in Exchange cmdlet extension agents is Microsoft.Exchange.ProvisioningAgent.dll.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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, dc01.contoso.com.

Enabled

Optional

System.Boolean

The Enabled parameter filters the results by enabled or disabled cmdlet extension agents. Valid values are:

  • $true   Only enabled agents are included in the results.

  • $false   Only disabled agents are included in the results.

If you don't use this parameter, enabled and disabled agents are included in the results.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.CmdletExtensionAgentIdParameter

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

  • Name

  • Distinguished name (DN)

  • GUID

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.

 
Show: