Export (0) Print
Expand All

Set-MigrationBatch

Exchange Online
 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-04-11

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

Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see New-MigrationBatch.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-MigrationBatch -Identity <MigrationBatchIdParameter> [-AllowIncrementalSyncs <$true | $false>] [-AutoRetryCount <Int32>] [-BadItemLimit <Unlimited>] [-CompleteAfter <DateTime>] [-Confirm [<SwitchParameter>]] [-CSVData <Byte[]>] [-DomainController <Fqdn>] [-LargeItemLimit <Unlimited>] [-NotificationEmails <MultiValuedProperty>] [-Organization <OrganizationIdParameter>] [-ReportInterval <TimeSpan>] [-StartAfter <DateTime>] [-WhatIf [<SwitchParameter>]]

This example updates MigrationBatch01 with new AutoRetryCount and AllowIncrementalSyncs parameter settings.

Set-MigrationBatch -Identity MigrationBatch01 -AutoRetryCount 5 -AllowIncrementalSyncs $true

The Set-MigrationBatch cmdlet configures your existing migration batches to migrate mailboxes and mailbox data in one of the following scenarios:

  • Local move

  • Cross-forest move

  • Remote move

  • Cutover Exchange migration

  • Staged Exchange migration

  • IMAP migration

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 and Migration Permissions" section in the Recipients permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Management.Migration.MigrationBatchIdParameter

The Identity parameter specifies the name of the migration batch that you want to update configuration settings for.

AllowIncrementalSyncs

Optional

System.Boolean

The AllowIncrementalSyncs parameter specifies whether to enable or disable incremental syncs on mailbox moves and migrations.

AutoRetryCount

Optional

System.Int32

The AutoRetryCount parameter specifies the number of attempts to restart the migration batch to migrate mailboxes that encountered errors.

BadItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The BadItemLimit parameter specifies the number of bad items to skip if the request encounters corruption in the mailbox. Use 0 to not skip bad items. The valid input range for this parameter is from 0 through 2147483647. The default value is 0. We recommend that you keep the default value 0 and only change the BadItemLimit parameter value if the request fails.

CompleteAfter

Optional

System.DateTime

This parameter is reserved for internal Microsoft use.

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.

CSVData

Optional

System.Byte[]

The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. Use the following format for the value of this parameter: ([System.IO.File]::ReadAllBytes(<path of the CSV migration file>)). The following is an example: CSVData:([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\MigrationBatch_1.csv"))

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

LargeItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The LargeItemLimit parameter specifies the size of large items to skip if the request encounters such items in the mailbox. Use 0 to not skip large items. The valid input range for this parameter is from 0 through 2147483647. The default value is 50. We recommend that you keep the default value 0 and only change the LargeItemLimit parameter value if the request fails.

NotificationEmails

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The NotificationEmails parameter specifies one or more email addresses that migration status reports are sent to. Specify the value as a string array, and separate multiple email addresses with commas.

If you don't use this parameter, the status report isn't sent.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

ReportInterval

Optional

System.TimeSpan

This parameter is reserved for internal Microsoft use.

StartAfter

Optional

System.DateTime

This parameter is reserved for internal Microsoft use.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft