Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-11

Use the Retry-Queue cmdlet to force a connection attempt for a queue on a Mailbox server or an Edge Transport server.

Syntax

Retry-Queue -Identity <QueueIdentity> <COMMON PARAMETERS>
Retry-Queue -Filter <String> [-Server <ServerIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Resubmit <$true | $false>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example forces a connection attempt for all queues that meet the following criteria:

  • The queues are holding messages for the domain contoso.com.

  • The queues have a status of Retry.

  • The queues are located on the server on which the command is executed.

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

Detailed Description

The Retry-Queue cmdlet forces a connection attempt for a queue that has a status of Retry. The cmdlet establishes a connection to the next hop if possible. If a connection isn't established, a new retry time is set. To use this command to retry delivery of messages in the Unreachable queue, you must include the Resubmit 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 retry. 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: Delivery type for this queue as defined by transport.

Identity: Queue identity in the form of Server\destination, where destination is a delivery group or routing destination.

LastError: Text string of the last error recorded for a queue.

LastRetryTime: Time when a connection was last tried for this queue.

MessageCount: Number of items in the queue.

NextHopConnector: GUID of a delivery group.

NextHopDomain: Next hop domain of the queue, specified as a delivery group or routing destination.

NextRetryTime: Time when a connection will next be tried for this queue.

Status: 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 retry. 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 causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

Resubmit

Optional

System.Boolean

The Resubmit parameter specifies whether the queue contents should be resubmitted to the categorizer before a connection is established. Valid input for this parameter is $true or $false.

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.