Get-Queue

This cmdlet is available only in on-premises Exchange. Use the Get-Queue cmdlet to view configuration information for queues on Mailbox servers or Edge Transport servers. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-Queue
   [[-Identity] <QueueIdentity>]
   [-BookmarkIndex <Int32>]
   [-BookmarkObject <ExtensibleQueueInfo>]
   [-IncludeBookmark <$true | $false>]
   [-ResultSize <Unlimited>]
   [-ReturnPageInfo <$true | $false>]
   [-SearchForward <$true | $false>]
   [-SortOrder <QueueViewerSortOrderEntry[]>]
   [-Exclude <QueueViewerIncludesAndExcludes>]
   [-Include <QueueViewerIncludesAndExcludes>]
   [<CommonParameters>]
Get-Queue
   [-BookmarkIndex <Int32>]
   [-BookmarkObject <ExtensibleQueueInfo>]
   [-Filter <String>]
   [-IncludeBookmark <$true | $false>]
   [-ResultSize <Unlimited>]
   [-ReturnPageInfo <$true | $false>]
   [-SearchForward <$true | $false>]
   [-Server <ServerIdParameter>]
   [-SortOrder <QueueViewerSortOrderEntry[]>]
   [-Exclude <QueueViewerIncludesAndExcludes>]
   [-Include <QueueViewerIncludesAndExcludes>]
   [<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-Queue | Format-List

This example displays detailed information for all queues on the Mailbox server on which the command is run.

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

Get-Queue -Filter {MessageCount -gt 100}

This example lists the queues that contain more than 100 messages.

-------------------------- Example 3 --------------------------

Get-Queue Server1\contoso.com | Format-List

This example displays detailed information for a specific queue that exists on the Mailbox server named Server1.

-------------------------- Example 4 --------------------------

Get-Queue -Exclude Internal

This example lists only the external queues.

Optional Parameters

-BookmarkIndex

The BookmarkIndex parameter specifies the position in the result set where the displayed results start. The value of this parameter is a 1-based index in the total result set. The BookmarkIndex parameter can't be used with the BookmarkObject parameter.

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

The BookmarkObject parameter specifies the object in the result set where the displayed results start. The BookmarkObject parameter can't be used with the BookmarkIndex parameter.

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

The Exclude parameter specifies the types of queues you want to exclude from the results. Valid values for this parameter are:

  • Internal

  • External

  • A valid queue DeliveryType value. For details, see the NextHopSolutionKey section in Queues and messages in queues.

Type:QueueViewerIncludesAndExcludes
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 2010, Exchange Server 2013, Exchange Server 2016
-Identity

The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\Queue or Queue, for example, Mailbox01\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in Find queues and messages in queues in the Exchange Management Shell (https://technet.microsoft.com/library/aa998047.aspx).

Type:QueueIdentity
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-Include

The Include parameter specifies the types of queues you want to include the results. Valid values for this parameter are:

  • Internal

  • External

  • A valid queue DeliveryType value. For details, see the NextHopSolutionKey section in Queues and messages in queues.

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

The IncludeBookmark parameter specifies whether to include the bookmark object when the query results are displayed. The IncludeBookmark parameter is valid when it's used with the BookmarkObject or BookmarkIndex parameters. If you don't specify a value for the IncludeBookmark parameter, the default value of $true is used.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-ResultSize

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

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

The ReturnPageInfo parameter is a hidden parameter. Use it to return information about the total number of results and the index of the first object of the current page. The default value is $false.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-SearchForward

The SearchForward parameter specifies whether to search forward or backward in the result set. The default value is $true. This value causes the result page to be calculated forward from either the start of the result set or forward from a bookmark if specified.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
-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.

You can use the Server parameter and the Filter parameter in the same command. You can't use the Server parameter and the Identity parameter in the same command.

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

The SortOrder parameter specifies an array of message properties used to control the sort order of the result set. Separate each property by using a comma. Prepend a plus sign (+) symbol to the beginning of the property name to display the results in ascending order. Prepend a minus sign (-) symbol to the beginning of the property name to display the results in descending order.

If you don't specify a sort order, the result set is displayed in ascending order by QueueIdentity.

Type:QueueViewerSortOrderEntry[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, 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.