Get-MigrationBatch

 

Applies to: Exchange Online, Exchange Server 2016

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 Get-MigrationBatch cmdlet to retrieve status information about the current migration batch.

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

Get-MigrationBatch [-Identity <MigrationBatchIdParameter>] <COMMON PARAMETERS>

Get-MigrationBatch [-Endpoint <MigrationEndpointIdParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Diagnostic <SwitchParameter>] [-DiagnosticArgument <String>] [-DomainController <Fqdn>] [-IncludeReport <SwitchParameter>] [-Partition <MailboxIdParameter>] [-Status <Created | Syncing | Stopping | Stopped | Completed | Failed | Removing | Synced | IncrementalSyncing | Completing | CompletedWithErrors | SyncedWithErrors | Corrupted | Waiting | Starting>]

This example displays status information for the migration batch LocalMove2.

Get-MigrationBatch -Identity LocalMove2

This example displays information about all migration batches associated with the migration endpoint exsrv1.contoso.com.

Get-MigrationBatch -Endpoint exsrv1.contoso.com

The Get-MigrationBatch cmdlet displays status information about the current migration batch. This information includes the following information:

  • Status of the migration batch

  • Total number of mailboxes being migrated

  • Number of successfully completed migrations

  • Migration errors

  • Date and time when the migration was started

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

Diagnostic

Optional

System.Management.Automation.SwitchParameter

The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems.

DiagnosticArgument

Optional

System.String

The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems.

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.

Endpoint

Optional

Microsoft.Exchange.Management.Migration.MigrationService.Endpoint.MigrationEndpointIdParameter

The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint.

If you use this parameter, you can't include the Identity parameter.

Identity

Optional

Microsoft.Exchange.Management.Migration.MigrationService.Batch.MigrationBatchIdParameter

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

If you use this parameter, you can't include the Endpoint parameter.

IncludeReport

Optional

System.Management.Automation.SwitchParameter

The IncludeReport parameter returns additional information about the specified migration batch. This information is displayed in the Report field.

Partition

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter is reserved for internal Microsoft use.

Status

Optional

Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus

The Status parameter returns a list of migration batches that have the specified status state. Use one of the following values:

  • Completed

  • CompletedWithErrors

  • Completing

  • Corrupted

  • Created

  • Failed

  • IncrementalSyncing

  • Removing

  • Starting

  • Stopped

  • Syncing

  • Stopping

  • Synced

  • SyncedwithErrors

  • Waiting

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: