.png)
Set-MoveRequest
Topic Last Modified: 2011-03-19
Use the Set-MoveRequest cmdlet to change move request options after the move request has been created. You can use the Set-MoveRequest cmdlet to recover from failed move requests.
Set-MoveRequest -Identity <MoveRequestIdParameter> [-BadItemLimit <Nullable>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreRuleLimitErrors <Nullable>] [-Protect <Nullable>] [-RemoteCredential <PSCredential>] [-RemoteGlobalCatalog <Fqdn>] [-RemoteHostName <Fqdn>] [-SuspendWhenReadyToComplete <Nullable>] [-WhatIf [<SwitchParameter>]]
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Management.RecipientTasks.MoveRequestIdParameter |
The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values:
|
|
BadItemLimit |
Optional |
System.Nullable |
The BadItemLimit parameter specifies the number of bad items to skip if the move request encounters corruption in the mailbox. Use 0 not to skip bad items. Use -1 to skip an unlimited number of bad items. The valid input range for this parameter is from -1 through 2,147,483,647. The default value is 0. We recommend that you keep the default value of 0 and only change the BadItemLimit parameter value if the move request fails. |
|
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 |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
IgnoreRuleLimitErrors |
Optional |
System.Nullable |
The IgnoreRuleLimitErrors parameter specifies that the command won't move the user's rules to the target server running Microsoft Exchange. |
|
Protect |
Optional |
System.Nullable |
This parameter is reserved for internal Microsoft use. |
|
RemoteCredential |
Optional |
System.Management.Automation.PSCredential |
The RemoteCredential parameter specifies you as an administrator who has permission to perform the mailbox move, for example, Administrator@ humongousinsurance.com. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential. |
|
RemoteGlobalCatalog |
Optional |
Microsoft.Exchange.Data.Fqdn |
The RemoteGlobalCatalog parameter specifies the FQDN global catalog server for the remote forest. |
|
RemoteHostName |
Optional |
Microsoft.Exchange.Data.Fqdn |
The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. |
|
SuspendWhenReadyToComplete |
Optional |
System.Nullable |
The SuspendWhenReadyToComplete parameter specifies whether to suspend the move request before it reaches the status of CompletionInProgress. The move request then has a status of AutoSuspended. You can manually complete the move by using the Resume-MoveRequest command. |
|
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. |
You can pipeline the Set-MoveRequest cmdlet from the Get-MoveRequestStatistics, Get-MoveRequest, or Get-Mailbox cmdlets.
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 "Mailbox move" entry in the Mailbox Permissions topic.
| Error | Description |
|---|---|
|
|
|
