Export (0) Print
Expand All
Expand Minimize

Test-VMReplicationConnection

Windows Server 2012 R2 and Windows 8.1

Updated: June 10, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Test-VMReplicationConnection

Tests the connection between a primary server and a Replica server.

Syntax

Parameter Set: Default
Test-VMReplicationConnection [-ReplicaServerName] <String> [-ReplicaServerPort] <Int32> [-AuthenticationType] <ReplicationAuthenticationType> [[-CertificateThumbprint] <String> ] [-BypassProxyServer <Boolean> ] [-ComputerName <String[]> ] [ <CommonParameters>]




Detailed Description

The Test-VMReplicationConnection cmdlet tests the connection between a primary server and a Replica server to determine whether replication can be enabled for virtual machines on the primary server to the specified Replica server.

Parameters

-AuthenticationType<ReplicationAuthenticationType>

Specifies the authentication type to use to test the connection, either “Kerberos” or “Certificate”. The specified Replica server must support the chosen authentication type. Run the Get-VMReplicationServer cmdlet to verify the authentication configured for the specified Replica server, or contact the administrator of the specified Replica server.


Aliases

AuthType

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BypassProxyServer<Boolean>

Specifies whether to bypass a proxy server when testing the connectivity.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CertificateThumbprint<String>

Specifies the certificate to use for mutual authentication of the replication data. This parameter is required only when “Certificate” is the specified as the type of authentication. Specify the thumbprint of a valid computer certificate from the Personal store.

The certificate must have all of the following properties to be valid:

It must not be expired.

It must include both client and server authentication extensions for extended key usage (EKU), and an associated private key.

It must terminate at a valid root certificate.

The requirement for the subject common name (CN) differs depending on whether the virtual machine belongs to a cluster. For virtual machines that do not belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) should contain, the FQDN of the host. For virtual machines that belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) must contain, the FQDN of the Hyper-V Replica Broker.

To display a list certificates in the computer’s My store and the thumbprint of each certificate, type the following:

PS C:\> cd cert:\LocalMachine\My

PS C:\> dir | format-list

For more information about certificate stores, see http://technet.microsoft.com//library/cc757138.aspx.


Aliases

Thumbprint

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts that have the virtual machines for which you want to test the connection for replication. NetBIOS names, IP addresses, and fully-qualified domain names (FQDN) are allowed. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReplicaServerName<String>

Specifies the name of the Replica server to test for connectivity with the virtual machine to be replicated.


Aliases

ReplicaServer

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReplicaServerPort<Int32>

Specifies the port on the Replica server to use to test connectivity. Make sure you specify a port that is configured on the Replica server to support the same authentication type you specify using the AuthenticationType parameter in this cmdlet. Run the Get-VMReplicationServer cmdlet on the Replica server to check the configuration of the port, or contact the administrator of the specified Replica server.


Aliases

ReplicaPort

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None.


Examples

Example 1

This example tests the connection between the local host and a Replica server named server01.domain01.contoso.com, using port 80 and Kerberos authentication.


PS C:\>  Test-VMReplicationConnection server01.domain01.contoso.com 80 Kerberos

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft