Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-11

Use the Suspend-Queue cmdlet to stop processing for a queue on a Mailbox server or an Edge Transport server.

Syntax


`Suspend-Queue -Identity <QueueIdentity> <COMMON PARAMETERS>`


`Suspend-Queue -Filter <String> [-Server <ServerIdParameter>] <COMMON PARAMETERS>`


`COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]`

Examples

EXAMPLE 1

This example suspends processing on all queues holding messages for delivery to the domain contoso.com and that currently have a status of Retry.

	Copy Code
Suspend-Queue -Filter {NextHopDomain -eq "contoso.com" -and Status -eq "Retry"}

EXAMPLE 2

This example suspends processing on all queues on the server Server1.contoso.com that have more than 100 messages in the queue.

	Copy Code
Suspend-Queue -Server Server1.contoso.com -Filter {MessageCount -gt 100}

Detailed Description

The Suspend-Queue cmdlet stops processing on a queue that has a status of Active or Retry. Messages being processed are delivered, but no additional messages leave the queue. When you use the Identity parameter, the queue is suspended only if the identity matches a single queue. If the identity matches more than one queue, you receive an error. To suspend more than one queue in a single operation, you must use the Filter parameter.

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.

Parameters

Parameter	Required	Type	Description
Filter	Required	System.String	The Filter parameter requires an expression that specifies the property value criteria for the queues that you want to suspend. The expression includes a property name followed by a comparison operator and value. The following queue properties are valid criteria for the Filter parameter: DeliveryType: The delivery type for this queue as defined by transport. Identity: The queue identity in the form of Server\destination, where destination is a delivery group or routing destination. LastError: A text string of the last error recorded for a queue. LastRetryTime: The time when a connection was last tried for this queue. MessageCount: The number of items in the queue. NextHopConnector: The GUID of the next hop delivery group. NextHopDomain: The next hop domain of the queue, specified as a delivery group or routing destination NextRetryTime: The time when a connection will next be tried for this queue. Status: The status of the queue. Queue status options are `Active`, `Ready`, `Retry`, or `Suspended`. 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	Required	Microsoft.Exchange.Data.QueueViewer.QueueIdentity	The Identity parameter specifies the identity of the queue that contains the messages that you want to suspend. Enter the queue identity in the form of Server\destination, where destination is a delivery group or routing destination.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax `-Confirm:$False`. You must include a colon ( `:` ) in the syntax.
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.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

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.

Return Types

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.