Get-MigrationBatch
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might 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.
Syntax
Identity
Get-MigrationBatch
[[-Identity] <MigrationBatchIdParameter>]
[-Diagnostic]
[-DiagnosticArgument <String>]
[-DiagnosticInfo <String>]
[-DomainController <Fqdn>]
[-IncludeReport]
[-Partition <MailboxIdParameter>]
[-ResultSize <Unlimited>]
[-Status <MigrationBatchStatus>]
[<CommonParameters>]
BatchesFromEndpoint
Get-MigrationBatch
[-Diagnostic]
[-DiagnosticArgument <String>]
[-DomainController <Fqdn>]
[-Endpoint <MigrationEndpointIdParameter>]
[-IncludeReport]
[-Status <MigrationBatchStatus>]
[<CommonParameters>]
BatchesByEndpoint
Get-MigrationBatch
[-DiagnosticInfo <String>]
[-Endpoint <MigrationEndpointIdParameter>]
[-IncludeReport]
[-Partition <MailboxIdParameter>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
BatchesByStatus
Get-MigrationBatch
[-DiagnosticInfo <String>]
[-IncludeReport]
[-Partition <MailboxIdParameter>]
[-ResultSize <Unlimited>]
[-Status <MigrationBatchStatus>]
[<CommonParameters>]
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 and completed.
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Note: In the cloud-based service, if you don't use the TimeZone parameter in the New-MigrationBatch command, the default time zone for the migration batch is UTC. The CompleteAfter and CompleteAfterUTC properties contain the same value (and also the StartAfter and StartAfterUTC properties). When you create the migration batch in the Exchange admin center (EAC), the time zone that's used is based on your regional configuration.
Examples
Example 1
Get-MigrationBatch -Identity LocalMove2
This example displays status information for the migration batch LocalMove2.
Example 2
Get-MigrationBatch -Endpoint exsrv1.contoso.com
This example displays information about all migration batches associated with the migration endpoint exsrv1.contoso.com.
Parameters
-Diagnostic
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
This parameter is available only in on-premises Exchange.
The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch.
Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesFromEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DiagnosticArgument
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
This parameter is available only in on-premises Exchange.
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesFromEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DiagnosticInfo
Applicable: Exchange Online
This parameter is available only in the cloud-based service.
Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are:
- attachmentid=String
- batch=String
- confirm
- duration=String
- endpoints
- endtime=DateTime
- maxsize=Int32
- organization=String
- partition=String
- reportid=String
- reports
- showtimeline
- showtimeslots=String
- starttime=DateTime
- status=String
- storage
- type=String
- user=String
- verbose
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByStatus
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainController
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
This parameter is available only in on-premises Exchange.
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.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesFromEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Endpoint
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Parameter properties
| Type: | MigrationEndpointIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
BatchesFromEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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.
Parameter properties
| Type: | MigrationBatchIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-IncludeReport
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
The IncludeReport switch returns additional information about the specified migration batch. You don't need to specify a value with this switch.
This information is displayed in the Report field.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Partition
Applicable: Exchange Online
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | MailboxIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByStatus
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResultSize
Applicable: Exchange Online
This parameter is available only in the cloud-based service.
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
Parameter properties
| Type: | Unlimited |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByStatus
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Status
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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
Parameter properties
| Type: | MMigrationBatchStatus |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesFromEndpoint
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
BatchesByStatus
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
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.
Outputs
Output 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.