Set-VMReplicationServer

Set-VMReplicationServer

Configures a host as a Replica server.

Syntax

Parameter Set: AuthenticationPort
Set-VMReplicationServer [[-ReplicationEnabled] <Boolean]> ] [[-AllowedAuthenticationType] <RecoveryAuthenticationType> {Kerberos | Certificate | CertificateAndKerberos} ] [[-ReplicationAllowedFromAnyServer] <Boolean]> ] [-CertificateAuthenticationPort <Int32]> ] [-CertificateThumbprint <String> ] [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-DefaultStorageLocation <String> ] [-Force] [-KerberosAuthenticationPort <Int32]> ] [-MonitoringInterval <TimeSpan]> ] [-MonitoringStartTime <TimeSpan]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: AuthenticationPortMapping
Set-VMReplicationServer [[-ReplicationEnabled] <Boolean]> ] [[-AllowedAuthenticationType] <RecoveryAuthenticationType> {Kerberos | Certificate | CertificateAndKerberos} ] [[-ReplicationAllowedFromAnyServer] <Boolean]> ] [-CertificateAuthenticationPortMapping <Hashtable> ] [-CertificateThumbprint <String> ] [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-DefaultStorageLocation <String> ] [-Force] [-KerberosAuthenticationPortMapping <Hashtable> ] [-MonitoringInterval <TimeSpan]> ] [-MonitoringStartTime <TimeSpan]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detaillierte Beschreibung

The Set-VMReplicationServer cmdlet configures a host as a Replica server and enables you to specify the types of authentication and ports to use for incoming replication traffic.

To restrict the replication traffic that the Replica server will accept by allowing it only from specific servers, use the New-VMReplicationAuthorizationEntry cmdlet.

Parameter

-AllowedAuthenticationType<RecoveryAuthenticationType>

Specifies which authentication types the Replica server will use. Allowed values are Kerberos, Certificate, or CertificateAndKerberos.

Aliase

AuthType

Erforderlich?

false

Position?

2

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-CertificateAuthenticationPort<Int32]>

Specifies the port on which the Replica server will receive replication data using certificate-based authentication. This parameter can be set only when the value of the AllowedAuthType parameter is Certificate or CertificateAndKerberos.

Aliase

CertAuthPort

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-CertificateAuthenticationPortMapping<Hashtable>

When using Hyper-V Replica with failover clustering and certificate-based authorization, you can use this parameter to specify a different port for each node of the cluster to receive replication. We recommend that you specify a unique port for each node of the cluster, and one unique port for the Hyper-V Replica Broker. This parameter can be set only when the Replica server is configured with an authentication type of Certificate or CertificateAndKerberos.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-CertificateThumbprint<String>

Specifies the certificate to use for mutual authentication of the replication data. This parameter is required only when Certificate is 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.

     --It must meet the requirements for the subject common name (CN):

           -- For servers that are not clustered, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) should contain, the FQDN of the host.

           -- For servers that are clustered, each node must have two certificates – one in which the subject common name (CN) or subject alternative name (DNS Name) is the name of the node, and the other in which subject common name (CN) or subject alternative name (DNS Name) is FQDN of the Hyper-V Replica Broker.

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

PS C:\> cd cert:\LocalMachine\My
PS C:\> dir | format-list

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

Aliase

Thumbprint

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

True (ByPropertyName)

Platzhalterzeichen akzeptieren?

false

-CimSession<Microsoft.Management.Infrastructure.CimSession[]>

Das Cmdlet wird in einer Remotesitzung oder auf einem Remotecomputer ausgeführt. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, wie z. B. die Ausgabe eines New-CimSession oder Get-CimSession-Cmdlets. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-ComputerName<String[]>

Configures Replica server settings for one or more Hyper-V hosts. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Credential<System.Management.Automation.PSCredential[]>

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-DefaultStorageLocation<String>

Specifies the default location to store the virtual hard disk files when a Replica virtual machine is created. You must specify this parameter when ReplicationAllowedFromAnyServer is True.

Aliase

StorageLoc

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Force

Specifies whether the command runs without requiring confirmation.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-KerberosAuthenticationPort<Int32]>

Specifies the port that the HTTP listener uses on the Replica server host.

Aliase

KerbAuthPort

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-KerberosAuthenticationPortMapping<Hashtable>

When using Hyper-V Replica with failover clustering and Kerberos authorization, you can use this parameter to specify a different port for each node of the cluster to receive replication. We recommend that you specify a unique port for each node of the cluster, and one unique port for the Hyper-V Replica Broker. This parameter can be set only when the Replica server is configured with an authentication type of either Kerberos or CertificateAndKerberos.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-MonitoringInterval<TimeSpan]>

Specifies how often (the monitoring interval) replication statistics are computed. Valid values are: 1 hour, 2 hours, 3 hours, 4 hours, 6 hours, 8 hours, 12 hours, 24 hours, 2 days, 3 days, 4 days, 5 days, 6 days, 7 days. Specify in the format days:hours:minutes:seconds, such as 01:00:00 for 1 hour, or 1.00:00:00 for 1 day.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-MonitoringStartTime<TimeSpan]>

Specifies when the monitoring interval starts.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Passthru

Specifies that a VMReplicationServer object is to be passed through to the pipeline representing the replication settings of the Replica server.

Aliase

none

Erforderlich?

false

Position?

named

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-ReplicationAllowedFromAnyServer<Boolean]>

Specifies whether to accept replication requests from any server. When specified as true, DefaultStorageLocation must also be specified. The default storage location and DEFAULT trust group tag are used for virtual machine replicas.

Aliase

AllowAnyServer

Erforderlich?

false

Position?

3

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-ReplicationEnabled<Boolean]>

Specifies whether the host is enabled as a Replica server.

Aliase

RepEnabled

Erforderlich?

false

Position?

1

Standardwert

none

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-Confirm

Fordert Sie vor der Ausführung des Cmdlet zum Bestätigen auf.

Erforderlich?

false

Position?

named

Standardwert

false

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

-WhatIf

Zeit, was passieren würde, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?

false

Position?

named

Standardwert

false

Pipelineeingaben akzeptieren?

false

Platzhalterzeichen akzeptieren?

false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die Sie per Piping an das Cmdlet übergeben können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

  • None by default; VMRecoveryServer if –PassThru is specified.

Beispiele

Example 1

This example configures the local host as a Replica server and specifies Kerberos for authentication.

PS C:\>  Set-VMReplicationServer $true –AllowedAuthenticationType Kerberos 

Example 2

This example configures a Replica server that accepts replication from all authenticated servers and uses a default storage location of d:\DefaultReplicaStorage.

PS C:\>  Set-VMReplicationServer –ReplicationEnabled $true AllowedAuthenticationType Kerberos –ReplicationAllowedFromAnyServer $true –DefaultStorageLocation d:\DefaultReplicaStorage

Example 3

This example configures the Replica server with a monitoring interval of 12 hours starting at 17:00 hours.

PS C:\>  Set-VMReplicationServer –MonitoringInterval "12:00:00" –MonitoringStartTime "17:00:00"

Example 4

This example configures the nodes of the cluster to receive replication on different ports. The first command declares a variable named portmapping and uses it to store the server names of the nodes and the port to use on each node. The second command configures each node of the cluster to use port mapping for Kerberos authentication using the values stored in the portmapping variable.

PS C:\> $portmapping = @{"Server1.contoso.com" = 82; "Server2.contoso.com" = 81; "Broker.contoso.com" = 80}
PS C:\> Set-VMReplicationServer -KerberosAuthenticationPortMapping $portmapping