Applies to: Exchange Server 2013
Topic Last Modified: 2012-08-08
Use the Redirect-Message cmdlet to drain the active messages from all the delivery queues on a Mailbox server, and transfer those messages to another Mailbox server.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Redirect-Message -Server <ServerIdParameter>
-Target <MultiValuedProperty> [-Confirm
[<SwitchParameter>]] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example drains the active messages from the delivery queues on the Mailbox server named Mailbox01, and transfers the messages to the server named Mailbox02.
 Copy Code |
|
|---|---|
Redirect-Message -Server Mailbox01 -Target Mailbox02 |
|
Detailed Description
When a message queue is drained, the active messages in the queues on the source Mailbox server are routed to the target Mailbox server. After the messages are received and queued by the target Mailbox server, the messages are made redundant. Other considerations include the following:
- Only active messages are drained. Shadow queues aren't
drained.
- Messages in the poison message queue aren't drained.
- The source server won't accept new messages while the queues
are drained.
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 |
|---|---|---|---|
|
Server |
Required |
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:
If you don't use the Server parameter, the command is run on the local server. |
|
Target |
Required |
Microsoft.Exchange.Data.MultiValuedProperty |
The Target parameter specifies the target Mailbox server where you want to transfer the messages from the drained delivery queues. Enter the server name as a fully qualified domain name (FQDN). |
|
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. |
|
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.