Msvm_CollectionReplicationSettingData class
The class that represents configured settings for a Msvm_VirtualSystemCollection object.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_CollectionReplicationSettingData : Msvm_CollectionSettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint16 AuthenticationType;
string CertificateThumbPrint;
string RootCertificateThumbPrint;
boolean CompressionEnabled;
boolean BypassProxyServer;
string RecoveryConnectionPoint;
string PrimaryConnectionPoint;
uint16 RecoveryServerPortNumber;
boolean ReplicateHostKvpItems;
uint16 ApplicationConsistentSnapshotInterval;
uint16 RecoveryHistory;
boolean AutoResynchronizeEnabled = TRUE;
datetime AutoResynchronizeIntervalStart;
datetime AutoResynchronizeIntervalEnd;
uint16 ReplicationInterval;
string IncludedDisks[];
string RecoveryServerHosts[];
string PrimaryReplicationEntityIDs[];
};
Members
The Msvm_CollectionReplicationSettingData class has these types of members:
Properties
The Msvm_CollectionReplicationSettingData class has these properties.
-
ApplicationConsistentSnapshotInterval
-
-
Data type: uint16
-
Access type: Read-only
The time interval, in hours, between application consistent snapshots. This property can contain values from 1 hour to 12 hours.
-
-
AuthenticationType
-
-
Data type: uint16
-
Access type: Read-only
The authentication mode used to connect to the recovery server.
-
-
Kerberos authentication (1)
-
Certificate based authentication (2)
AutoResynchronizeEnabled
-
Data type: boolean
-
Access type: Read-only
true to automatically perform a synchronization operation for replication errors due to power and hardware failures; otherwise, false.
AutoResynchronizeIntervalEnd
-
Data type: datetime
-
Access type: Read-only
The end time to use for auto synchronization when AutoResynchronizeEnabled is true. The default value is 0600 hours local time.
AutoResynchronizeIntervalStart
-
Data type: datetime
-
Access type: Read-only
The start time to use for auto synchronization when AutoResynchronizeEnabled is true. The default value is 1830 hours local time.
BypassProxyServer
-
Data type: boolean
-
Access type: Read-only
true to bypass the proxy server when connected to the recovery server; otherwise, false.
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
CertificateThumbPrint
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Maxlen (128)
The certificate thumb print to use when AuthenticationType is set to "2" (certificate based authorization).
CompressionEnabled
-
Data type: boolean
-
Access type: Read-only
true if compression is enabled when sending data to the recovery server; otherwise, false.
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
ElementName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.
This property is inherited from CIM_SettingData.
IncludedDisks
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: HyperVEmbeddedInstance ("CIM_StorageAllocationSettingData"), ArrayType ("Indexed")
The list of VHDs attached to any of the ComputerSystem of the collection that will be included for replication. This is an array of strings each containing the InstanceID of the resource allocation setting data (RASD) of the VHD present in the group.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
- OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
- If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
- For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
This property is inherited from CIM_SettingData.
PrimaryConnectionPoint
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Maxlen (256)
The name of the primary connection point. For a primary cluster, this is the broker CAP name. For a standalone primary server, this is the host system name.
PrimaryReplicationEntityIDs
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed")
The list of replication entities in a primary group i.e., the group ID and the virtual machine IDs. These are required when there is no broker present in the cluster.
For example: GroupId,Vm1Id,Vm2Id.
RecoveryConnectionPoint
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Maxlen (256)
The name of the connection point on the recovery server. For a recovery cluster, this is the broker CAP name. For a standalone recovery server, this is the host system name. If an external provider is used, this represents the connection point specific to the provider.
RecoveryHistory
-
Data type: uint16
-
Access type: Read-only
The maximum number of recovery snapshots stored on the recovery server. This property can contain values from "0" to "16".
RecoveryServerHosts
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed")
The list of recovery servers corresponding to the primary entity IDs, where the entity has to be placed on recovery side.
For example: RecoveryServer1forGroupId,RecoveryServer2forVm1Id,RecoveryServer1forVm2Id.
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
true to enable a host-only Msvm_KvpExchangeDataItem object from a primary virtual machine to a recovery virtual machine; otherwise, false. true is the default value.
ReplicationInterval
-
Data type: uint16
-
Access type: Read-only
The replication interval to use for replication relationships, in seconds. Valid values fpr this property are "30", "300", "900".
RootCertificateThumbPrint
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Maxlen (128)
The root certificate thumb print of the certificate to use when AuthenticationType is set to "2" (certificate based authorization).
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|