Get-QueueDigest
Applies to: Exchange Server 2013
Topic Last Modified: 2013-03-21
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.
For information about the parameter sets in the Syntax section below, see Syntax.
Get-QueueDigest -Dag <MultiValuedProperty> <COMMON PARAMETERS>
Get-QueueDigest -Server <MultiValuedProperty> <COMMON PARAMETERS>
Get-QueueDigest -Site <MultiValuedProperty> <COMMON PARAMETERS>
Get-QueueDigest -Forest <SwitchParameter> <COMMON PARAMETERS>
COMMON PARAMETERS: [-DetailsLevel <None | Normal | Verbose>] [-Filter <String>] [-GroupBy <NextHopDomain | NextHopCategory | NextHopKey | DeliveryType | Status | RiskLevel | LastError | ServerName | OutboundIPPool>] [-IncludeE14Servers <SwitchParameter>] [-Mtrt <SwitchParameter>] [-ResultSize <Unlimited>] [-Timeout <EnhancedTimeSpan>]
This example returns information about all queues in the DAG named DAG01.
Get-QueueDigest DAG01
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 "Queues" entry in the Mail Flow Permissions topic.
| Parameter | Required | Type | Description |
|---|---|---|---|
| Dag | Required | Microsoft.Exchange.Data.MultiValuedProperty | 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. |
| Forest | Required | System.Management.Automation.SwitchParameter | 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. |
| Server | Required | Microsoft.Exchange.Data.MultiValuedProperty | 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. |
| Site | Required | Microsoft.Exchange.Data.MultiValuedProperty | 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. |
| DetailsLevel | Optional | Microsoft.Exchange.Net.DiagnosticsAggregation.DetailsLevel | The DetailsLevel parameter specifies the level of detail to display in the results. Valid values for this parameter are |
| Filter | Optional | System.String | 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, 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 ("). |
| GroupBy | Optional | Microsoft.Exchange.Net.DiagnosticsAggregation.QueueDigestGroupBy | The GroupedBy parameter sorts the messages in the delivery queue results. Valid values for this parameter are:
The default value is |
| IncludeE14Servers | Optional | System.Management.Automation.SwitchParameter | This parameter is reserved for internal Microsoft use. |
| Mtrt | Optional | System.Management.Automation.SwitchParameter | This parameter is reserved for internal Microsoft use. |
| ResultSize | Optional | Microsoft.Exchange.Data.Unlimited | 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. |
| Timeout | Optional | Microsoft.Exchange.Data.EnhancedTimeSpan | 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 d = days, h = hours, m = minutes, and s = seconds. |
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.
