Get-QueueDigest

This cmdlet is available only in on-premises Exchange. Use the Get-QueueDigest cmdlet to view information about message delivery queues across database availability groups (DAGs) Active Directory sites, or Active Directory forests in your organization. By default, the Get-QueueDigest cmdlet displays delivery queues that contain ten or more messages, and the results are between one and two minutes old. For instructions on how to change these default values, see Configure Get-QueueDigest. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-QueueDigest
   -Dag <MultiValuedProperty>
   [-DetailsLevel <None | Normal | Verbose>]
   [-Filter <String>]
   [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>]
   [-IncludeE14Servers]
   [-ResultSize <Unlimited>]
   [-Timeout <EnhancedTimeSpan>]
   [<CommonParameters>]
Get-QueueDigest
   [-Forest]
   [-DetailsLevel <None | Normal | Verbose>]
   [-Filter <String>]
   [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>]
   [-IncludeE14Servers]
   [-ResultSize <Unlimited>]
   [-Timeout <EnhancedTimeSpan>]
   [<CommonParameters>]
Get-QueueDigest
   -Server <MultiValuedProperty>
   [-DetailsLevel <None | Normal | Verbose>]
   [-Filter <String>]
   [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>]
   [-IncludeE14Servers]
   [-ResultSize <Unlimited>]
   [-Timeout <EnhancedTimeSpan>]
   [<CommonParameters>]
Get-QueueDigest
   -Site <MultiValuedProperty>
   [-DetailsLevel <None | Normal | Verbose>]
   [-Filter <String>]
   [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>]
   [-IncludeE14Servers]
   [-ResultSize <Unlimited>]
   [-Timeout <EnhancedTimeSpan>]
   [<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 (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

Get-QueueDigest -Forest

This example returns information about all queues in the Active Directory forest.

-------------------------- Example 2 --------------------------

Get-QueueDigest -Dag DAG01

This example returns information about all queues in the DAG named DAG01.

Required Parameters

-Dag

The Dag parameter filters the delivery queue results by DAG. You can specify any value that uniquely identifies the DAG. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks (").

You can't use the Dag parameter with the Server, Site or Forest parameters.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Forest

The Forest switch filters the delivery queue results by Active Directory forest. You don't need to specify a value with the Forest switch.

You can't use the Forest switch with the Server, Site or Dag parameters.

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

The Server parameter filters the delivery queue results by Exchange server. You can specify any value that uniquely identifies the server. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks (").

You can't use the Server parameter with the Dag, Site or Forest parameters.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Site

The Site parameter filters the delivery queue results by Active Directory site. You can specify any value that uniquely identifies the site. You can specify multiple sites separated by commas.

You can't use the Site parameter with the Server, Dag or Forest parameters.

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

Optional Parameters

-DetailsLevel

The DetailsLevel parameter specifies the level of detail to display in the results. Valid values for this parameter are None, Normal and Verbose. The default value is Normal.

Type:None | Normal | Verbose
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Filter

The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value, for example, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue properties (https://technet.microsoft.com/library/bb125237.aspx) and Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx).

You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks (").

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

The GroupedBy parameter sorts the messages in the delivery queue results. Valid values for this parameter are:

  • DeliveryType

  • LastError

  • NextHopCategory

  • NextHopDomain

  • NextHopKey

  • RiskLevel

  • Status

  • ServerName

  • OutboundIPPool

The default value is NextHopDomain.

Type:NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-IncludeE14Servers

This parameter is reserved for internal Microsoft use.

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

The ResultSize parameter filters the delivery queue results by the number of messages in the queue. Valid input for this parameter is an integer. The default value is 1000. For example, if you specify the value 50, the command displays the 50 queues that contain the most messages.

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-Timeout

The Timeout parameter specifies the number of seconds before the operation times out. The default value is 10 seconds.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes and ss = seconds.

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

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.