Export (0) Print
Expand All

Msvm_ReplicationSettingData class

Hyper-V

Represents the replication-specific settings for a virtual machine. The client passes an instance of this class to Msvm_ReplicationService.CreateReplicationRelationship to create a replication relationship. The client can't directly change the values of any of the properties for this class; it must call the Msvm_ReplicationService.ModifyReplicationSettings method to change the values. Each replication relationship has a single instance of settings.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

class Msvm_ReplicationSettingData : CIM_VirtualSystemSettingData
{
  string   InstanceID = "Microsoft:Virtual Machine GUID\HVR";
  string   Caption = "Replication Settings";
  string   Description = "Virtual Machine Replication Settings Data";
  string   ElementName;
  string   VirtualSystemIdentifier;
  string   VirtualSystemType = "Microsoft:Hyper-V:Replica";
  string   Notes[];
  datetime CreationTime;
  string   ConfigurationID;
  string   ConfigurationDataRoot;
  string   ConfigurationFile;
  string   SnapshotDataRoot;
  string   SuspendDataRoot;
  string   SwapFileDataRoot;
  string   LogDataRoot;
  uint16   AutomaticStartupAction;
  datetime AutomaticStartupActionDelay;
  uint16   AutomaticStartupActionSequenceNumber;
  uint16   AutomaticShutdownAction;
  uint16   AutomaticRecoveryAction;
  string   RecoveryFile;
  uint16   AuthenticationType;
  string   CertificateThumbPrint;
  string   RootCertificateThumbPrint;
  boolean  CompressionEnabled;
  boolean  BypassProxyServer;
  string   RecoveryConnectionPoint;
  string   RecoveryHostSystem;
  string   PrimaryConnectionPoint;
  string   PrimaryHostSystem;
  uint16   RecoveryServerPortNumber = 0;
  boolean  ReplicateHostKvpItems = True;
  uint16   ApplicationConsistentSnapshotInterval;
  uint16   RecoveryHistory = 0;
  string   IncludedDisks[];
  boolean  AutoResynchronizeEnabled = False;
  datetime AutoResynchronizeIntervalStart = 00000000183000.000000:000;
  datetime AutoResynchronizeIntervalEnd = 00000000060000.000000:000;
  boolean  EnableWriteOrderPreservationAcrossDisks;
  string   ReplicationProvider;
  string   AdditionalSettings;
  uint16   ReplicationInterval = 300;
};

Members

The Msvm_ReplicationSettingData class has these types of members:

Properties

The Msvm_ReplicationSettingData class has these properties.

AdditionalSettings
Data type: string
Access type: Read-only

Additional replication settings that the endpoint provider can use.

Windows 8.1:  This value is not supported until Windows 8.1 and Windows Server 2012 R2.

ApplicationConsistentSnapshotInterval
Data type: uint16
Access type: Read-only

The time interval between application consistent snapshots, specified in hours. Valid values are from 1 hour to 12 hours.

AuthenticationType
Data type: uint16
Access type: Read-only

Define authentication mode used to connect to recover server.

ValueMeaning
1

Kerberos authentication.

2

Certificate based authentication.

 

AutomaticRecoveryAction
Data type: uint16
Access type: Read-only

Not used.

This property is inherited from CIM_VirtualSystemSettingData.

AutomaticShutdownAction
Data type: uint16
Access type: Read-only

Not used.

This property is inherited from CIM_VirtualSystemSettingData.

AutomaticStartupAction
Data type: uint16
Access type: Read-only

Not used.

This property is inherited from CIM_VirtualSystemSettingData.

AutomaticStartupActionDelay
Data type: datetime
Access type: Read-only

The delay time before the virtual machine is automatically started up. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

AutomaticStartupActionSequenceNumber
Data type: uint16
Access type: Read-only

A number that indicates the relative sequence of virtual machine activation when the host system is started. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

AutoResynchronizeEnabled
Data type: boolean
Access type: Read/write

Specifies whether resynchronization operations are automatically triggered when a replication error occurs due to power and hardware failures. Resynchronization operations are only triggered when the failure occurs between the times specified by the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd properties.

The default value is False.

AutoResynchronizeIntervalEnd
Data type: datetime
Access type: Read-only

Specifies the end time for automatic resynchronization operations to be triggered. This value is in local time. The default value is 06:00 (6:00 A.M.).

Resynchronization operations are only triggered when the failure occurs between the times specified by the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd properties.

Resynchronization operations can also be scheduled so that they are triggered during the next interval.

AutoResynchronizeIntervalStart
Data type: datetime
Access type: Read-only

Specifies the start time for automatic resynchronization operations to be triggered. This value is in local time. The default value is 18:30 (6:30 P.M.).

Resynchronization operations are only triggered when the failure occurs between the times specified by the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd properties.

Resynchronization operations can also be scheduled so that they are triggered during the next interval.

BypassProxyServer
Data type: boolean
Access type: Read-only

Specifies whether the proxy server should be bypassed when connecting to a recovery server.

Caption
Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Replication Settings".

CertificateThumbPrint
Data type: string
Access type: Read-only

Certificate thumbprint to use when the AuthenticationType property is certificate based authentication.

CompressionEnabled
Data type: boolean
Access type: Read-only

Specifies whether replication data will be compressed while sending it to the recovery server.

ConfigurationDataRoot
Data type: string
Access type: Read-only

Not used.

This property is inherited from CIM_VirtualSystemSettingData.

ConfigurationFile
Data type: string
Access type: Read-only

The relative path and file name of a file where information about the virtual machine configuration is stored. This path is relative to the ConfigurationDataRoot property. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

ConfigurationID
Data type: string
Access type: Read-only

The unique identifier of the virtual machine configuration. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

CreationTime
Data type: datetime
Access type: Read-only

The date and time at which the settings for the virtual machine were created. If this object represents the current settings for the virtual machine, this value would be the time at which the system was created. If this object represents the snapshot settings for the virtual machine, this value would be the time at which the snapshot was taken. This property is inherited from CIM_VirtualSystemSettingData.

This is a read-only property, but it can be changed by using the ModifySystemSettings method of the Msvm_VirtualSystemManagementService class.

This property is inherited from CIM_VirtualSystemSettingData.

Description
Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Virtual Machine Replication Settings Data".

ElementName
Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_VirtualSystemSettingData, and it is set to the display name for the virtual machine.

EnableWriteOrderPreservationAcrossDisks
Data type: boolean
Access type: Read/write

Specifies whether all replicating virtual hard disks for the virtual machine are replicated to the same point in time. This ensures replication honors the write-order of the applications in the virtual machine.

Windows 8.1:  Beginning with Windows 8.1 and Windows Server 2012 R2, this property is deprecated and always set to TRUE.

IncludedDisks
Data type: string array
Access type: Read-only

The list of virtual hard disks (VHDs) attached to the system that will be replicated by the replication engine. This is an array of strings, each containing the InstanceID of the Msvm_StorageAllocationSettingData that represents the VHD.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_SettingData. For Windows 8, it is always set to "Microsoft:Virtual Machine GUID\HVR". For Windows 8.1, it is set to "Microsoft:Virtual Machine GUID\HVR\<0/1>". In the Windows 8.1 value, 0 indicates primary and 1 indicates extended replication. For more info about extended replication, see Msvm_ReplicationRelationship.

LogDataRoot
Data type: string
Access type: Read-only

The path of a directory where log information for the virtual machine is stored. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

Notes
Data type: string array
Access type: Read-only

Not used and can't be set.

This property is inherited from CIM_VirtualSystemSettingData.

PrimaryConnectionPoint
Data type: string
Access type: Read-only

The name of the primary connection point. In the case of a primary cluster, this is the broker CAP name. In the case of a standalone primary server, this is the host system name.

PrimaryHostSystem
Data type: string
Access type: Read-only

The fully qualified domain name of the primary host system that is hosting the virtual machine.

RecoveryConnectionPoint
Data type: string
Access type: Read-only

The name of the recovery connection point. In the case of a recovery cluster, this is the broker CAP name. In the case of a standalone recovery server, this is the host system name.

RecoveryFile
Data type: string
Access type: Read-only

The full path of a file where recovery related information for the virtual machine is stored. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

RecoveryHistory
Data type: uint16
Access type: Read-only

The maximum number of recovery snapshots that will be stored on the recovery server. Valid values are from 0 to 24.

RecoveryHostSystem
Data type: string
Access type: Read-only

The fully qualified domain name of the recovery host system which is hosting the virtual machine.

RecoveryServerPortNumber
Data type: uint16
Access type: Read-only

The recovery server port number to use when making a secure connection for replication.

ReplicateHostKvpItems
Data type: boolean
Access type: Read-only

Specifies whether host-only Msvm_KvpExchangeDataItems should be replicated from the primary virtual machine to the recovery virtual machine.

ReplicationInterval
Data type: uint16
Access type: Read-only

Replication interval of a replication relationship in seconds. Valid values are:

30

300

900

Default value is 300 seconds.

Windows 8.1:  This value is not supported until Windows 8.1 and Windows Server 2012 R2.

ReplicationProvider
Data type: string
Access type: Read-only

The path to the instance of the Msvm_ReplicationProvider class that identifies the replication provider endpoint.

Windows 8.1:  This value is not supported until Windows 8.1 and Windows Server 2012 R2.

RootCertificateThumbPrint
Data type: string
Access type: Read-only

Root certificate thumbprint of the certificate in use when AuthenticationType is 2 (certificate based authorization).

SnapshotDataRoot
Data type: string
Access type: Read-only

The path of a directory where information about the virtual machine snapshots is stored. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

SuspendDataRoot
Data type: string
Access type: Read-only

The path of a directory where information about the virtual machine suspend-related information is stored. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

SwapFileDataRoot
Data type: string
Access type: Read-only

The path of a directory where swap files for the virtual machine are stored. This property is inherited from CIM_VirtualSystemSettingData, but it is not used.

VirtualSystemIdentifier
Data type: string
Access type: Read-only

The name of the CIM_ComputerSystem object to which this setting data belongs. This property is an override from CIM_VirtualSystemSettingData.

VirtualSystemType
Data type: string
Access type: Read-only

Specifies the type of virtual machine the setting data represents. This property is inherited from CIM_VirtualSystemSettingData, and it is always set to "Microsoft:Hyper-V:Replica".

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Namespace

Root\Virtualization\V2

MOF

WindowsVirtualization.V2.mof

See also

ModifyReplicationSettings

 

 

Community Additions

ADD
Show:
© 2015 Microsoft