TechNet
Export (0) Print
Expand All

Set-MoveRequest

 

Applies to: Exchange Online, Exchange Server 2016

Topic Last Modified: 2016-07-14

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

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> [-AcceptLargeDataLoss <SwitchParameter>] [-ArchiveTargetDatabase <DatabaseIdParameter>] [-BadItemLimit <Unlimited>] [-BatchName <String>] [-CompleteAfter <DateTime>] [-CompletedRequestAgeLimit <Unlimited>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IncrementalSyncInterval <TimeSpan>] [-InternalFlags <InternalMrsFlag[]>] [-LargeItemLimit <Unlimited>] [-MoveOptions <MultiValuedProperty>] [-PreventCompletion <$true | $false>] [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] [-Protect <$true | $false>] [-ProxyToMailbox <MailboxIdParameter>] [-RemoteCredential <PSCredential>] [-RemoteGlobalCatalog <Fqdn>] [-RemoteHostName <Fqdn>] [-RequestExpiryInterval <Unlimited>] [-SkipMoving <SkippableMoveComponent[]>] [-StartAfter <DateTime>] [-SuspendWhenReadyToComplete <$true | $false>] [-TargetDatabase <DatabaseIdParameter>] [-WhatIf [<SwitchParameter>]]

This example changes the move request for Ayla to accept up to five corrupt mailbox items.

Set-MoveRequest -Identity Ayla@humongousinsurance.com -BadItemLimit 5

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 moves" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MailboxReplicationService.MoveRequestIdParameter

The Identity parameter specifies the identity of the mailbox or mail user. You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SMTP address

  • Alias

AcceptLargeDataLoss

Optional

System.Management.Automation.SwitchParameter

The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail.

ArchiveTargetDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

This parameter is available only in on-premises Exchange 2016.

The ArchiveTargetDatabase parameter specifies the Exchange target database to which you're moving the personal archive. You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued.

You can use the following values to specify the target database:

  • GUID of the database

  • Database name

BadItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete.

Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again.

noteNote:
If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail.

BatchName

Optional

System.String

The BatchName parameter specifies a different name for a batch.

CompleteAfter

Optional

System.DateTime

The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".

In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter in Exchange Online, use either of the following options:

  • Specify the date/time value in UTC   For example, "2016-05-06 14:30:00z".

  • Specify the date/time value as a formula that converts the date/time in your local time zone to UTC   For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date.

CompletedRequestAgeLimit

Optional

Microsoft.Exchange.Data.Unlimited

The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

IncrementalSyncInterval

Optional

System.TimeSpan

The IncrementalSyncInterval parameter specifies the wait time between incremental syncs. This parameter is used together with the CompleteAfter parameter to create a move request that will do periodic incremental syncs after the initial sync is complete.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

Valid values are from 00:00:00 to 120.00:00:00 (120 days). The default value is 24 hours.

InternalFlags

Optional

Microsoft.Exchange.Management.Migration.MailboxReplication.RequestBase.InternalMrsFlag[]

This parameter is available only in on-premises Exchange 2016.

The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes.

LargeItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used.

For more information about maximum message size values, see the following topics:

Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed.

noteNote:
If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail.

MoveOptions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

PARAMVALUE: MultiValuedProperty

PreventCompletion

Optional

System.Boolean

The PreventCompletion parameter specifies whether to run the move request, but not allow it to complete. Valid values are:

  • $true   The move request is run, but is not allowed to complete. Instead of this value, we recommend using the CompleteAfter parameter.

  • $false   This is the default value. The move request is run and allowed to complete. If you created the move request with the SuspendWhenReadyToComplete or PreventCompletion switches, set this parameter to $false before you run the Resume-MoveRequest cmdlet to complete the move request.

Priority

Optional

Microsoft.Exchange.MailboxReplicationService.RequestPriority

This parameter is available only in on-premises Exchange 2016.

The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are:

  • Lowest

  • Lower

  • Low

  • Normal   This is the default value.

  • High

  • Higher

  • Highest

  • Emergency

Protect

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ProxyToMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

PARAMVALUE: MailboxIdParameter

RemoteCredential

Optional

System.Management.Automation.PSCredential

The RemoteCredential parameter specifies an administrator who has permission to perform the mailbox move, for example, Administrator@ humongousinsurance.com.

This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential.

RemoteGlobalCatalog

Optional

Microsoft.Exchange.Data.Fqdn

The RemoteGlobalCatalog parameter specifies the FQDN of the 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.

RequestExpiryInterval

Optional

Microsoft.Exchange.Data.Unlimited

The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter:

  • The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value.

  • If the request fails, you need to manually remove it by using the corresponding Remove-*Request cmdlet.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

When you use the value Unlimited, the completed request isn't automatically removed.

SkipMoving

Optional

Microsoft.Exchange.Management.Migration.MailboxReplication.MoveRequest.SkippableMoveComponent[]

The SkipMoving parameter allows certain stages of a mailbox move to be skipped for debugging purposes. Do not use this parameter unless directed to do so by a support professional or specific documentation.

StartAfter

Optional

System.DateTime

The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".

In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter in Exchange Online, use either of the following options:

  • Specify the date/time value in UTC   For example, "2016-05-06 14:30:00z".

  • Specify the date/time value as a formula that converts the date/time in your local time zone to UTC   For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date.

SuspendWhenReadyToComplete

Optional

System.Boolean

The SuspendWhenReadyToComplete parameter specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this parameter, we recommend using CompleteAfter parameter.

TargetDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

This parameter is available only in on-premises Exchange 2016.

The TargetDatabase parameter specifies the identity of the database that you're moving the mailbox to. You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued.

You can use the following values:

  • GUID of the database

  • Database name

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show:
© 2016 Microsoft