Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2011-09-01
Use the Suspend-Queue cmdlet to stop processing for a queue on a computer that has the Hub Transport server role or the Edge Transport server role installed.
Syntax
Suspend-Queue -Identity <QueueIdentity> [-Confirm
[<SwitchParameter>]] [-WhatIf
[<SwitchParameter>]]
|
Suspend-Queue -Filter <String> [-Confirm
[<SwitchParameter>]] [-Server <ServerIdParameter>]
[-WhatIf [<SwitchParameter>]]
|
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 Transport 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. The delivery type must be one of the following values:
Identity The queue identity in the form of Server\destination, where destination is a remote domain, Mailbox server, or persistent queue name. 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 connector used to create the queue. NextHopDomain The next hop domain of the queue, specified as a remote SMTP domain, a server name, the name of an Active Directory site, or a message database (MDB) identifier. NextRetryTime The time when a connection will next be tried for this queue. Status The status of the queue. Queue
status options are 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 remote domain, Mailbox server, or persistent queue name. |
|
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
|
|
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the name of the server to connect to by using the remote procedure call (RPC) that contains the queues that hold the messages that you want to suspend. Enter the server name as a host name or a fully qualified domain name (FQDN). If this parameter isn't used, the local server is queried. |
|
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.
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 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}
|
|