Get-MigrationEndpoint
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-MigrationEndpoint cmdlet to retrieve migration endpoint settings for source or destination servers for cutover or staged Exchange migrations, IMAP migrations, and remote moves.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
ConnectionSettingsFilter
Get-MigrationEndpoint
-ConnectionSettings <ExchangeConnectionSettings>
[-Diagnostic]
[-DiagnosticArgument <String>]
[-DomainController <Fqdn>]
[<CommonParameters>]
TypeFilter
Get-MigrationEndpoint
-Type <MigrationType>
[-Diagnostic]
[-DiagnosticArgument <String>]
[-DomainController <Fqdn>]
[-Partition <MailboxIdParameter>]
[-DiagnosticInfo <String>]
[<CommonParameters>]
Identity
Get-MigrationEndpoint
[[-Identity] <MigrationEndpointIdParameter>]
[-Diagnostic]
[-DiagnosticArgument <String>]
[-DomainController <Fqdn>]
[-Partition <MailboxIdParameter>]
[-DiagnosticInfo <String>]
[<CommonParameters>]
Description
The Get-MigrationEndpoint cmdlet retrieves settings for different types of migration:
- Cross-forest move: Move mailboxes between two different on-premises Exchange forests. Cross-forest moves require the use of a RemoteMove endpoint.
- Remote move: In a hybrid deployment, a remote move involves onboarding or offboarding migrations. Remote moves require the use of a RemoteMove endpoint. Onboarding moves mailboxes from an on-premises Exchange organization to Exchange Online, and uses a RemoteMove endpoint as the source endpoint of the migration batch. Offboarding moves mailboxes from Exchange Online to an on-premises Exchange organization and uses a RemoteMove endpoint as the target endpoint of the migration batch.
- Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online. Cutover Exchange migration requires the use of an Exchange endpoint.
- Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online. Staged Exchange migration requires the use of an Exchange endpoint.
- IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint.
- Local: Move mailboxes between different servers or databases within a single on-premises Exchange forest. Local moves don't require the use of an endpoint.
For more information about the different move and migration scenarios, see:
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.
Examples
Example 1
Get-MigrationEndpoint -Identity OnboardingME01
This example retrieves the settings for the migration endpoint, OnboardingME01.
Parameters
-ConnectionSettings
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
This parameter is available only in on-premises Exchange.
The ConnectionSettings parameter specifies the configuration settings of source or target servers for which you want to find a matching endpoint.
Parameter properties
| Type: | ExchangeConnectionSettings |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ConnectionSettingsFilter
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
(All)
| 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
(All)
| 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
(All)
| 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
(All)
| 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 specifies the name of the migration endpoint you want to retrieve settings for.
Parameter properties
| Type: | MigrationEndpointIdParameter |
| 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 |
-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
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
The Type parameter filters the results by the type of migration. Valid values for this parameter are:
- ExchangeOutlookAnywhere: Cutover or staged Exchange migrations
- ExchangeRemoteMove: Remote moves and migrations
- IMAP: IMAP migrations
- PublicFolder: Public folder migrations
Parameter properties
| Type: | MigrationType |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TypeFilter
| Position: | Named |
| Mandatory: | True |
| 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.