Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-08-17
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 Syntax.
Syntax
Get-MigrationBatch [-Identity
<MigrationBatchIdParameter>] <COMMON PARAMETERS>
|
Get-MigrationBatch [-Endpoint
<MigrationEndpointIdParameter>] <COMMON
PARAMETERS>
|
COMMON PARAMETERS: [-Diagnostic <SwitchParameter>]
[-DiagnosticArgument <String>] [-DomainController
<Fqdn>] [-IncludeReport <SwitchParameter>]
[-Organization <OrganizationIdParameter>] [-Status
<Created | Syncing | Stopping | Stopped | Completed | Failed |
Removing | Synced | IncrementalSyncing | Completing |
CompletedWithErrors | SyncedWithErrors | Corrupted>]
|
Examples
EXAMPLE 1
This example displays status information for the migration batch LocalMove2.
 Copy Code |
|
|---|---|
Get-MigrationBatch -Identity LocalMove2 |
|
EXAMPLE 2
This example displays information about all migration batches associated with the migration endpoint exsrv1.contoso.com.
| Copy Code |
|
|---|---|
Get-MigrationBatch -Endpoint exsrv1.contoso.com |
|
Detailed Description
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Diagnostic |
Optional |
System.Management.Automation.SwitchParameter |
The Diagnostic parameter returns additional information that you can use to troubleshoot migration errors or send to Microsoft Customer Service and Support. |
|
DiagnosticArgument |
Optional |
System.String |
This parameter is reserved for internal Microsoft use. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter is reserved for internal Microsoft use. |
|
Endpoint |
Optional |
Microsoft.Exchange.Management.Migration.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.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. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization 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:
|
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.