Test-MigrationServerAvailability
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
Use the Test-MigrationServerAvailability cmdlet to test the availability of the target server in preparation to perform cross-forest mailbox moves, migration of on-premises mailboxes to Exchange Online, or to migrate on-premises mailbox data from an IMAP server to Exchange Online mailboxes. For all migration types, the cmdlet attempts to verify the connection settings used to connect to the target server.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Test-MigrationServerAvailability
-Credentials <PSCredential>
-EmailAddress <SmtpAddress>
[-Autodiscover]
[-ExchangeRemoteMove]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-EmailAddress <SmtpAddress>
[-Autodiscover]
[-ExchangeOutlookAnywhere]
[-AcceptUntrustedCertificates]
[-Confirm]
[-MailboxPermission <MigrationMailboxPermission>]
[-Partition <MailboxIdParameter>]
[-SourceMailboxLegacyDN <String>]
[-TestMailbox <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-RemoteServer <Fqdn>
[-FilePath <String>]
[-PSTImport]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-ExchangeServer <String>
-RPCProxyServer <Fqdn>
[-ExchangeOutlookAnywhere]
[-AcceptUntrustedCertificates]
[-Authentication <AuthenticationMethod>]
[-EmailAddress <SmtpAddress>]
[-MailboxPermission <MigrationMailboxPermission>]
[-TestMailbox <MailboxIdParameter>]
[-SourceMailboxLegacyDN <String>]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-PublicFolderDatabaseServerLegacyDN <String>
-RPCProxyServer <Fqdn>
-SourceMailboxLegacyDN <String>
[-PublicFolder]
[-Authentication <AuthenticationMethod>]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-TestMailbox <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-RemoteServer <Fqdn>
[-Credentials <PSCredential>]
[-ExchangeRemoteMove]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Endpoint <MigrationEndpointIdParameter>
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-RemoteServer <Fqdn>
-Port <Int32>
[-Imap]
[-AcceptUntrustedCertificates]
[-Authentication <AuthenticationMethod>]
[-Security <NIMAPSecurityMechanism]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-ServiceAccountKeyFileData <Byte[]>
[-Gmail]
[-EmailAddress <SmtpAddress>]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-TestMailbox <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-EmailAddress <SmtpAddress>
[-Compliance]
[-RemoteServer <Fqdn>]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-RemoteServer <Fqdn>
[-PublicFolderToUnifiedGroup]
[-TestMailbox <MailboxIdParameter>]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-PublicFolderDatabaseServerLegacyDN <String>
-RPCProxyServer <Fqdn>
-SourceMailboxLegacyDN <String>
[-PublicFolderToUnifiedGroup]
[-Authentication <AuthenticationMethod>]
[-TestMailbox <MailboxIdParameter>]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Test-MigrationServerAvailability
-Credentials <PSCredential>
-RemoteServer <Fqdn>
[-PublicFolder]
[-Confirm]
[-Partition <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>] Description
The Test-MigrationServerAvailability cmdlet verifies that you can communicate with the on-premises mail server that houses the mailbox data that you want to migrate to cloud-based mailboxes. When you run this cmdlet, you must specify the migration type. You can specify whether to communicate with an IMAP server or with an Exchange server.
For an IMAP migration, this cmdlet uses the server's fully qualified domain name (FQDN) and a port number to verify the connection. If the verification is successful, use the same connection settings when you create a migration request with the New-MigrationBatch cmdlet.
For an Exchange migration, this cmdlet uses one of the following settings to communicate with the on-premises server:
- For Exchange 2003, it uses the server's FQDN and credentials for an administrator account that can access the server.
- For Exchange Server 2007 and later versions, you can connect using the Autodiscover service and the email address of an administrator account that can access the server.
If the verification is successful, you can use the same settings to create a migration endpoint. For more information, see:
- New-MigrationEndpoint
- New-MigrationBatch
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not 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
Test-MigrationServerAvailability -Imap -RemoteServer imap.contoso.com -Port 143For IMAP migrations, this example verifies the connection to the IMAP mail server imap.contoso.com.
Example 2
$Credentials = Get-Credential
Test-MigrationServerAvailability -ExchangeOutlookAnywhere -Autodiscover -EmailAddress administrator@contoso.com -Credentials $CredentialsThis example uses the Autodiscover and ExchangeOutlookAnywhere parameters to verify the connection to an on-premises Exchange server in preparation for migrating on-premises mailboxes to Exchange Online. You can use a similar example to test the connection settings for a staged Exchange migration or a cutover Exchange migration.
Example 3
$Credentials = Get-Credential
Test-MigrationServerAvailability -ExchangeOutlookAnywhere -ExchangeServer exch2k3.contoso.com -Credentials $Credentials -RPCProxyServer mail.contoso.com -Authentication NTLMThis example verifies the connection to a server running Microsoft Exchange Server 2003 named exch2k3.contoso.com and uses NTLM for the authentication method.
Example 4
Test-MigrationServerAvailability -Endpoint endpoint.contoso.comThis example verifies the connection settings to a remote server using the settings stored in an existing migration endpoint in Exchange Online.
Example 5
$MRSEndpoints = (Get-MigrationEndpoint).Identity
Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP}This example tests multiple existing endpoints.
Parameters
-AcceptUntrustedCertificates
This parameter is available only in the cloud-based service.
{{ Fill AcceptUntrustedCertificates Description }}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Authentication
This parameter is available only in the cloud-based service.
The Authentication parameter specifies the authentication method used by the on-premises mail server. Use Basic or NTLM. If you don't include this parameter, Basic authentication is used.
The parameter is only used for cutover Exchange migrations and staged Exchange migrations.
| Type: | AuthenticationMethod |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Autodiscover
The Autodiscover switch specifies that the command should use the Autodiscover service to obtain the connection settings for the target server. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Compliance
The Compliance switch specifies that the endpoint type is compliance. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Confirm
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
- Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax:
-Confirm:$false. - Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Credentials
The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\username format or the user principal name (UPN) (user@example.com) format.
A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value (Get-Credential). Or, before you run this command, store the credentials in a variable (for example, $cred = Get-Credential) and then use the variable name ($cred) for this parameter. For more information, see Get-Credential.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-EmailAddress
The EmailAddress parameter specifies the email address of an administrator account that can access the remote server. This parameter is required when you use the Autodiscover parameter.
| Type: | SmtpAddress |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Endpoint
The Endpoint parameter specifies the name of the migration endpoint to connect to. A migration endpoint contains the connection settings and other migration configuration settings. If you include this parameter, the Test-MigrationServerAvailability cmdlet attempts to verify the ability to connect to the remote server using the settings in the migration endpoint.
| Type: | MigrationEndpointIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ExchangeOutlookAnywhere
This parameter is available only in the cloud-based service.
The ExchangeOutlookAnywhere switch specifies a migration type for migrating on-premises mailboxes to Exchange Online. You don't need to specify a value with this switch.
Use this switch if you plan to migrate mailboxes to Exchange Online using a staged Exchange migration or a cutover Exchange migration.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ExchangeRemoteMove
The ExchangeRemoteMove switch specifies a migration type where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. You don't need to specify a value with this switch.
Use this switch if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ExchangeServer
This parameter is available only in the cloud-based service.
The ExchangeServer parameter specifies the FQDN of the on-premises Exchange server. Use this parameter when you plan to perform a staged Exchange migration or a cutover Exchange migration. This parameter is required if you don't use the Autodiscover parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-FilePath
The FilePath parameter specifies the path containing the PST files when testing a PST Import migration endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Gmail
This parameter is available only in the cloud-based service.
The Gmail parameter specifies Gmail as the migration type. You don't need to specify a value with this switch.
This switch is required when you want to migrate data from a Google Workspace (formerly G Suite) tenant to Exchange Online mailboxes.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Imap
This parameter is available only in the cloud-based service.
The Imap parameter specifies an IMAP migration type. You don't need to specify a value with this switch.
This switch is required when you want to migrate data from an IMAP mail server to Exchange Online mailboxes.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-MailboxPermission
This parameter is available only in the cloud-based service.
The MailboxPermission parameter specifies what permissions are assigned to the migration administrator account defined by the Credentials parameter. You make the permissions assignment to test the connectivity to a user mailbox on the source mail server when you're testing the connection settings in preparation for a staged or cutover Exchange migration or for creating an Exchange Outlook Anywhere migration endpoint.
Specify one of the following values for the account defined by the Credentials parameter:
- FullAccess: The account has been assigned the Full-Access permission to the mailboxes that will be migrated.
- Admin: The account is a member of the Domain Admins group in the organization that hosts the mailboxes that will be migrated.
This parameter isn't used for testing the connection to the remote server for a remote move migration or an IMAP migration.
| Type: | MigrationMailboxPermission |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Partition
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Port
This parameter is available only in the cloud-based service.
The Port parameter specifies the TCP port number used by the IMAP migration process to connect to the target server. This parameter is required only for IMAP migrations.
The standard is to use port 143 for unencrypted connections, port 143 for Transport Layer Security (TLS), and port 993 for Secure Sockets Layer (SSL).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PSTImport
This parameter is available only in on-premises Exchange.
This parameter is reserved for internal Microsoft use.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-PublicFolder
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PublicFolderDatabaseServerLegacyDN
This parameter is available only in the cloud-based service.
This parameter is reserved for internal Microsoft use.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PublicFolderToUnifiedGroup
The PublicFolderToUnifiedGroup switch specifies that the endpoint type is public folders to Microsoft 365 Groups. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RemoteServer
The RemoteServer parameter specifies the FQDN of the on-premises mail server. This parameter is required when you want to perform one of the following migration types:
- Cross-forest move
- Remote move (hybrid deployments)
- IMAP migration
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-RPCProxyServer
This parameter is available only in the cloud-based service.
The RPCProxyServer parameter specifies the FQDN of the RPC proxy server for the on-premises Exchange server. This parameter is required when you don't use the Autodiscover parameter. Use this parameter if you plan to perform a staged Exchange migration or a cutover Exchange migration to migrate mailboxes to Exchange Online.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Security
This parameter is available only in the cloud-based service.
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
| Type: | IMAPSecurityMechanism |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ServiceAccountKeyFileData
This parameter is available only in the cloud-based service.
The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created.
A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: ([System.IO.File]::ReadAllBytes('<Path>\<FileName>')). You can use this command as the parameter value, or you can write the output to a variable ($data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')) and use the variable as the parameter value ($data).
| Type: | Byte[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-SourceMailboxLegacyDN
This parameter is available only in the cloud-based service.
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 will attempt to access this mailbox using the credentials for the administrator account on the target server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-TestMailbox
This parameter is available only in the cloud-based service.
The TestMailbox parameter specifies a mailbox on the target server. Use the primary SMTP address as the value for this parameter. The cmdlet will attempt to access this mailbox using the credentials for the administrator account on the target server.
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-WhatIf
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
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.