Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2013-01-11

Use the Complete-MigrationBatch cmdlet to finalize a migration batch for a local move, cross-forest move, or remote move migration that has successfully finished initial synchronization.

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

Syntax

Complete-MigrationBatch [-Identity <MigrationBatchIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-NotificationEmails <MultiValuedProperty>] [-Organization <OrganizationIdParameter>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example completes the migration batch LocalMove1 and sends a notification email message to the specified users.

Copy Code
Complete-MigrationBatch -Identity LocalMove1 -NotificationEmails admin@contoso.com,lucio@contoso.com

Detailed Description

After a migration batch for a local or cross-forest move has successfully run and has a status state of Synced, use the Complete-MigrationBatch cmdlet to finalize the migration batch. Finalization is the last phase performed during a local or cross-forest move. When you finalize a migration batch, the cmdlet does the following for each mailbox in the migration batch:

  • Runs a final incremental synchronization.

  • Configures the user's Microsoft Outlook profile to point to the new target domain.

  • Converts the source mailbox to a mail-enabled user in the source domain.

When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet.

If a migration batch has a status of Completed with Errors, you can rerun the Complete-MigrationBatch cmdlet. The cmdlet will attempt to finalize the failed users.

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.

Parameters

Parameter Required Type Description

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.

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.

Identity

Optional

Microsoft.Exchange.Management.Migration.MigrationBatchIdParameter

The Identity parameter identifies the name of the migration batch. The value for this parameter is specified by the Name parameter for the New-MigrationBatch cmdlet. Use the Get-MigrationBatch cmdlet to determine the value of this parameter for the migration batch.

NotificationEmails

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

If you don't use this parameter, the final status report is sent to the administrator who runs the Complete-MigrationBatch cmdlet.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization 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.

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.