Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-08
Use the Set-MigrationEndpoint cmdlet to edit settings for cutover or staged Exchange migrations, IMAP migrations, and remote moves.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-MigrationEndpoint -Identity
<MigrationEndpointIdParameter> [-Authentication <Basic |
Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic |
WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos |
Negotiate | LiveIdNegotiate | Misconfigured>] [-Confirm
[<SwitchParameter>]] [-Credentials <PSCredential>]
[-DomainController <Fqdn>] [-EmailAddress
<SmtpAddress>] [-ExchangeServer <String>]
[-MailboxPermission <Admin | FullAccess>]
[-MaxConcurrentIncrementalSyncs <Unlimited>]
[-MaxConcurrentMigrations <Unlimited>] [-NspiServer
<String>] [-Organization <OrganizationIdParameter>]
[-Port <Int32>] [-RemoteServer <Fqdn>] [-RpcProxyServer
<Fqdn>] [-Security <None | Ssl | Tls>]
[-SkipVerification <SwitchParameter>] [-SourceMailboxLegacyDN
<String>] [-TestMailbox <MailboxIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example changes the MaxConcurrentIncrementalSyncs setting to 50 on the CutoverExchangeEndpoint01 migration endpoint using the NSPI server Server01.
Copy Code | |
---|---|
Set-MigrationEndpoint -Identity CutoverExchangeEndpoint01 -MaxConcurrentIncrementalSyncs 50 -NspiServer Server01.contoso.com |
EXAMPLE 2
This example changes the MaxConcurrentMigrations setting to 10 on the Onboardingmigrationendpoint01 migration endpoint using the remote server, Server01.
Copy Code | |
---|---|
Set-MigrationEndpoint -Identity Onboardingmigrationendpoint01 -MaxConcurrentMigrations 10 -RemoteServer Server01.contoso.com |
Detailed Description
Use the Set-MigrationEndpoint cmdlet to configure 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 in Office 365, and uses a
RemoteMove endpoint as the source endpoint of the migration batch.
Offboarding moves mailboxes from Exchange Online in Office 365 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 in Office 365. 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 in Office 365. 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 in Office 365. 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 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 |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Management.Migration.MigrationEndpointIdParameter |
The Identity parameter specifies the name of the migration endpoint you want to configure. |
Authentication |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod |
The Authentication parameter specifies the authentication method used by the on-premises mail server. |
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. |
Credentials |
Optional |
System.Management.Automation.PSCredential |
The Credentials parameter specifies the credentials to use for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential. |
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. In the cloud-based service, this parameter is reserved for internal Microsoft use. |
EmailAddress |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The EmailAddress parameter specifies the email address of an administrator account that can access the remote server. |
ExchangeServer |
Optional |
System.String |
The ExchangeServer parameter specifies the on-premises source Exchange server for cutover and staged migrations. This parameter is applicable only to staged and cutover Exchange endpoints which don't use Autodiscovery. |
MailboxPermission |
Optional |
Microsoft.Exchange.Data.Storage.Management.MigrationMailboxPermission |
The MailboxPermission parameter specifies what permissions should be used to access the source mailbox during OutlookAnywhere onboarding (Staged Exchange Migration and Cutover Exchange Migration). This parameter is not for non-OutlookAnywhere migrations. The account specified must have the following permissions:
|
MaxConcurrentIncrementalSyncs |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxConcurrentIncrementalSyncs parameter specifies the maximum number of incremental syncs allowed for this endpoint at a specified time. This value must be less or equal to MaxConcurrentMigrations parameter. |
MaxConcurrentMigrations |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxConcurrentMigrations parameter specifies the maximum number of mailboxes that will be migrated for this endpoint at a specified time. This parameter is applicable for all migration types. |
NspiServer |
Optional |
System.String |
The NspiServer parameter specifies the FQDN of the remote Name Service Provider Interface (NSPI) server. This parameter is only applicable to staged and cutover Exchange endpoints that don't use Autodiscovery |
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is reserved for internal Microsoft use. |
Port |
Optional |
System.Int32 |
For an IMAP migration, the Port parameter specifies the TCP port number used by the migration process to connect to the remote server. |
RemoteServer |
Optional |
Microsoft.Exchange.Data.Fqdn |
The RemoteServer parameter specifies the remote server depending on the protocol type for moves.
|
RpcProxyServer |
Optional |
Microsoft.Exchange.Data.Fqdn |
For a staged Exchange migration, the RpcProxyServer parameter specifies the FQDN of the RPC proxy server for the on-premises Exchange server. This parameter is only applicable to staged and cutover Exchange endpoints that don't use Autodiscovery |
Security |
Optional |
Microsoft.Exchange.Data.IMAPSecurityMechanism |
This parameter is reserved for internal Microsoft use. |
SkipVerification |
Optional |
System.Management.Automation.SwitchParameter |
The SkipVerification switch specifies whether to skip
verifying that the remote server is reachable when creating a
migration endpoint. The default value is |
SourceMailboxLegacyDN |
Optional |
System.String |
The SourceMailboxLegacyDN parameter specifies a mailbox on the target server. Use the LegacyExchangeDN for the on-premises test mailbox as the value for this parameter. The cmdlet tries to access this mailbox using the credentials for the administrator account on the target server. |
TestMailbox |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet tries to access this mailbox using the credentials for the administrator account on the target server. |
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.