Set-VMReplication

Set-VMReplication

Modifies the replication settings of a virtual machine.

Syntax

Parameter Set: VMName
Set-VMReplication [-VMName] <String[]> [[-ReplicaServerName] <String> ] [[-ReplicaServerPort] <Int32> ] [[-AuthenticationType] <ReplicationAuthenticationType> ] [-AllowedPrimaryServer <String> ] [-AsJob] [-AsReplica] [-AutoResynchronizeEnabled <Boolean> ] [-AutoResynchronizeIntervalEnd <TimeSpan> ] [-AutoResynchronizeIntervalStart <TimeSpan> ] [-BypassProxyServer <Boolean> ] [-CertificateThumbprint <String> ] [-CompressionEnabled <Boolean> ] [-ComputerName <String[]> ] [-DisableVSSSnapshotReplication] [-EnableWriteOrderPreservationAcrossDisks <Boolean> ] [-InitialReplicationStartTime <DateTime> ] [-PassThru] [-RecoveryHistory <Int32> ] [-ReplicateHostKvpItems <Boolean> ] [-Reverse] [-UseBackup] [-VSSSnapshotFrequency <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Set-VMReplication [-VM] <VirtualMachine[]> [[-ReplicaServerName] <String> ] [[-ReplicaServerPort] <Int32> ] [[-AuthenticationType] <ReplicationAuthenticationType> ] [-AllowedPrimaryServer <String> ] [-AsJob] [-AsReplica] [-AutoResynchronizeEnabled <Boolean> ] [-AutoResynchronizeIntervalEnd <TimeSpan> ] [-AutoResynchronizeIntervalStart <TimeSpan> ] [-BypassProxyServer <Boolean> ] [-CertificateThumbprint <String> ] [-CompressionEnabled <Boolean> ] [-DisableVSSSnapshotReplication] [-EnableWriteOrderPreservationAcrossDisks <Boolean> ] [-InitialReplicationStartTime <DateTime> ] [-PassThru] [-RecoveryHistory <Int32> ] [-ReplicateHostKvpItems <Boolean> ] [-Reverse] [-UseBackup] [-VSSSnapshotFrequency <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMReplication
Set-VMReplication [-VMReplication] <VMReplication[]> [[-ReplicaServerName] <String> ] [[-ReplicaServerPort] <Int32> ] [[-AuthenticationType] <ReplicationAuthenticationType> ] [-AllowedPrimaryServer <String> ] [-AsJob] [-AsReplica] [-AutoResynchronizeEnabled <Boolean> ] [-AutoResynchronizeIntervalEnd <TimeSpan> ] [-AutoResynchronizeIntervalStart <TimeSpan> ] [-BypassProxyServer <Boolean> ] [-CertificateThumbprint <String> ] [-CompressionEnabled <Boolean> ] [-DisableVSSSnapshotReplication] [-EnableWriteOrderPreservationAcrossDisks <Boolean> ] [-InitialReplicationStartTime <DateTime> ] [-PassThru] [-RecoveryHistory <Int32> ] [-ReplicateHostKvpItems <Boolean> ] [-Reverse] [-UseBackup] [-VSSSnapshotFrequency <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-VMReplication cmdlet modifies the replication settings of a virtual machine.

Parameters

-AsJob

Runs the cmdlet as a background job.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AuthenticationType<ReplicationAuthenticationType>

Specifies the authentication type to use for virtual machine replication, 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?	false
Position?	4
Default Value	Integrated
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AutoResynchronizeEnabled<Boolean>

Enables replicating virtual machines that require resynchronization to be resynchronized automatically. (For example, a virtual machine requires resynchronization if the primary server shuts down abruptly). Resynchronization requires significant storage and processing resources. We recommended scheduling resynchronization during off-peak hours to reduce the impact to the host and other virtual machines running on the host. Use the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd parameters to specify an off-peak time to start the automatic resynchronization.

Aliases	AutoResync
Required?	false
Position?	named
Default Value	False
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AutoResynchronizeIntervalEnd<TimeSpan>

Specifies the end of the time period in which you want resynchronization to start automatically.

Aliases	AutoResyncEnd
Required?	false
Position?	named
Default Value	06:00AM
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AutoResynchronizeIntervalStart<TimeSpan>

Specifies the start of the time period in which you want resynchronization to start automatically.

Aliases	AutoResyncStart
Required?	false
Position?	named
Default Value	06:30PM
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-BypassProxyServer<Boolean>

Specifies whether to bypass a proxy server while replicating data to the Replica server.

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 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 and fully-qualified domain name (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, type the following:

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.

Aliases	Thumbprint,Cert
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CompressionEnabled<Boolean>

Specifies whether replication data sent over the network is to be compressed.

Aliases	none
Required?	false
Position?	named
Default Value	False
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which replication is to be enabled. 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.

Aliases	none
Required?	false
Position?	named
Default Value	.
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-InitialReplicationStartTime<DateTime>

Specifies the time to start the initial replication, when scheduling initial replication to occur later. You can specify a time up to 7 days later. When this parameter is not specified, initial replication occurs immediately.

Aliases	IRTime
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PassThru

Specifies that a VMReplication object is to be passed through to the pipeline representing the replication configuration to be set.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RecoveryHistory<Int32>

Specifies whether to store additional recovery points on the Replica virtual machine. Storing more than the most recent recovery point of the primary virtual machine allows you to recover to an earlier point in time. However, storing additional recovery points requires more storage and processing resources. You can configure as many as 15 recovery points to be stored.

Aliases	RecHist
Required?	false
Position?	named
Default Value	0
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Reverse

Reverses the replication of the virtual machine, switching it from a primary virtual machine to a Replica virtual machine, or from a Replica virtual machine to a primary virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies the virtual machine for which the replication configuration is to be set.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMName<String[]>

Specifies the name of the virtual machine for which the replication configuration is to be set.

Aliases	Name
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-VMReplication<VMReplication[]>

Specifies a virtual machine replication object for which the configuration is to be set.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-AsReplica

Specifies that the virtual machine is a replica virtual machine, enabling it to be used as the source for the initial replication of the primary virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisableVSSSnapshotReplication

Specifies whether to replicate volume shadow copy service (VSS) snapshots.

Aliases	DisableVSS
Required?	false
Position?	named
Default Value	True
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableWriteOrderPreservationAcrossDisks<Boolean>

Determines whether all virtual hard disks selected for replication are replicated to the same point in time. This is useful if the virtual machine runs an application that saves data across virtual hard disks (for example, one virtual hard disk dedicated for application data, and another virtual hard disk dedicated for application log files).

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 which this virtual machine will be replicated.

Aliases	ReplicaServer
Required?	false
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ReplicaServerPort<Int32>

Specifies the port on the Replica server to use for replication traffic. 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?	false
Position?	3
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ReplicateHostKvpItems<Boolean>

Specifies whether to replicate host-only key value pairs (KVP) for this virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-UseBackup

Specifies that a restored copy of the virtual machine on the Replica server is to be used as the source of the initial replication.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VSSSnapshotFrequency<Int32>

Specifies how often to replicate volume shadow copy service (VSS) copies of the virtual machine, which are called application-consistent recovery points. Valid values are in increments of one hour. You can specify from 1 through 12 hours. Use of this parameter requires that you also use the “Recovery History” parameter to specify at least one additional recovery point. Using application-consistent recovery points impacts the performance of applications running in the primary virtual machine when these snapshots are taken.

Aliases	VSSFreq
Required?	false
Position?	named
Default Value	4
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-AllowedPrimaryServer<String>

When you use the AsReplica parameter to specify a virtual machine as a Replica virtual machine, this parameter determines which primary servers can send replication to the Replica virtual machine. Replication is accepted only from the server specified in the chosen authentication entry, or any other authentication entry that has the same trust group.

Aliases	AllowedPS
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

Outputs

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

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

Examples

Example 1

This example configures the auto-resynchronization of virtual machine VM01.

PS C:\>  Set-VMReplication VM01 –AutoResynchronizedDisabled $true –AutoResynchronizeIntervalStart “18:30:00” –AutoResynchronizeIntervalEnd “06:00:00”

Example 2

This example configures virtual machine VM01 as a Replica virtual machine, allowing replication from primary server server01 from domain domain01.contoso.com.

PS C:\>  Set-VMReplication VM01 –AsReplica –AllowedPrimaryServer server01.domain01.contoso.com

Example 3

This example configures the recovery history and application-consistent recovery points of the virtual machine VM01.

PS C:\>  Set-VMReplication VM01 –RecoveryHistory 4 –VSSSnapshotFrequency 4

Example 4

This example reverses the replication of virtual machine VM01.

PS C:\>  Set-VMReplication VM01 -Reverse

Example 5

This example configures replication for all virtual machines on the local Hyper-V host to Replica server server01.domain01.contoso.com and port 80.

PS C:\>  Set-VMReplication * server01.domain01.contoso.com 80