Get-ExchangeDiagnosticInfo

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeDiagnosticInfo cmdlet to return information about processes that are running on Exchange servers.

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

Syntax

Get-ExchangeDiagnosticInfo
   [-Argument <String>]
   [-Component <String>]
   [-Process <String>]
   [-Server <ServerIdParameter>]
   [-Unlimited]
   [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-ExchangeDiagnosticInfo

This example returns a summary list of all Exchange processes that are running on the server.

Example 2

[xml]$edi = Get-ExchangeDiagnosticInfo

$edi.Diagnostics.Processlocator.Process | Format-Table -Auto Name,ID,Guid

This example display the XML output of the command in format that's easier to read.

Parameters

-Argument

The Argument parameter specifies a valid argument to use with the specified Component value.

Common Argument values that you can use with virtually Component value are Help and Verbose.

To see the Argument values that are available for a given Component value, run the command Get-ExchangeDiagnosticInfo -Process ProcessName -Component ComponentName -Argument Help.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Component

The Component parameter returns detailed information for the specified Component of the given Process value.

To see the Component values that are available for a given Process value, run the command Get-ExchangeDiagnosticInfo -Process ProcessName -Argument Help.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Process

The Process parameter provides details for the specified Exchange process. Valid values are the name of the process (for example, MSExchangeTransport or Microsoft.Exchange.Directory.TopologyService).

To see the list of available Exchange processes, run the command Get-ExchangeDiagnosticInfo.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Server

The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example:

Name
FQDN
Distinguished name (DN)
Exchange Legacy DN

If you don't use this parameter, the command is run on the local server.

Type:	ServerIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Unlimited

The Unlimited switch tells the command to return all available information. You don't need to specify a value with this switch.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2013, Exchange Server 2016, Exchange Server 2019