Export (0) Print
Expand All
Expand Minimize

Get-Queue

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-05-07

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

Use the Get-Queue cmdlet to view configuration information for queues on Mailbox servers or Edge Transport servers.

Get-Queue [-Filter <String>] [-Server <ServerIdParameter>] <COMMON PARAMETERS>
Get-Queue [-Identity <QueueIdentity>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-BookmarkIndex <Int32>] [-BookmarkObject <ExtensibleQueueInfo>] [-Exclude <QueueViewerIncludesAndExcludes>] [-Include <QueueViewerIncludesAndExcludes>] [-IncludeBookmark <$true | $false>] [-ResultSize <Unlimited>] [-ReturnPageInfo <$true | $false>] [-SearchForward <$true | $false>] [-SortOrder <QueueViewerSortOrderEntry[]>]

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

Get-Queue | Format-List

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

Get-Queue -Filter {MessageCount -gt 100}

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

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

This example lists only the external queues.

Get-Queue -Exclude Internal

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

BookmarkIndex

Optional

System.Int32

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.

BookmarkObject

Optional

Microsoft.Exchange.Data.QueueViewer.ExtensibleQueueInfo

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.

Exclude

Optional

Microsoft.Exchange.Data.QueueViewerIncludesAndExcludes

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.

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, {NextHopDomain -eq "contoso.com"}. For details about filterable queue properties and comparison operators, see Queue filters and Use the Exchange Management Shell to manage queues.

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 (").

Identity

Optional

Microsoft.Exchange.Data.QueueViewer.QueueIdentity

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 Use the Exchange Management Shell to manage queues.

Include

Optional

Microsoft.Exchange.Data.QueueViewerIncludesAndExcludes

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.

IncludeBookmark

Optional

System.Boolean

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.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

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.

ReturnPageInfo

Optional

System.Boolean

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.

SearchForward

Optional

System.Boolean

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.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the Exchange server on which 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 the Server 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.

SortOrder

Optional

Microsoft.Exchange.Data.QueueViewerSortOrderEntry[]

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft