ModifyReplicationSettings method of the Msvm_ReplicationService class
Modifies the replication settings for a virtual machine. When a client calls this method for a replica virtual machine, it modifies the replication settings of the replication relationship with the extended replica.
Syntax
uint32 ModifyReplicationSettings(
[in] CIM_ComputerSystem REF ComputerSystem,
[in] string ReplicationSettingData,
[out] CIM_ConcreteJob REF Job
);
Parameters
-
ComputerSystem [in]
-
A reference to a CIM_ComputerSystem instance that represents the virtual machine for which the replication settings should be modified.
-
ReplicationSettingData [in]
-
A string representation of the Msvm_ReplicationSettingData class that defines the new replication settings.
-
Job [out]
-
If the operation is performed asynchronously, this method will return 4096, and this parameter will contain a reference to an object derived from CIM_ConcreteJob.
Return value
This method returns one of the following values.
-
Completed with No Error (0)
-
Method Parameters Checked - Job Started (4096)
-
Failed (32768)
-
Access Denied (32769)
-
Not Supported (32770)
-
Status is unknown (32771)
-
Timeout (32772)
-
Invalid parameter (32773)
-
System is in use (32774)
-
Invalid state for this operation (32775)
-
Incorrect data type (32776)
-
System is not available (32777)
-
Out of memory (32778)
-
File not found (32779)
Remarks
ModifyReplicationSettings takes an Msvm_ReplicationSettingData instance (FRSD) as input. The associated FRSD for the virtual machine as host-to-host provider is the default choice. Input FRSD is validated for valid settings for each property for the default provider. This table summarizes the validation differences with respect to the external provider.
| Property | External providers |
|---|---|
| ReplicationProvider | Same as default provider |
| AuthenticationType | Ignored |
| CertificateThumbPrint | Ignored |
| RootCertificateThumbPrint (RO) | Ignored |
| CompressionEnabled | Same as default provider |
| BypassProxyServer | Same as default provider |
| RecoveryConnectionPoint | Ignored* (may change if provider has requirement) |
| RecoveryHostSystem (RO) | Ignored |
| PrimaryConnectionPoint (RO) | Same as default provider |
| PrimaryHostSystem (RO) | Same as default provider |
| RecoveryServerPortNumber | Ignored* (may change if provider has requirement) |
| ReplicateHostKvpItems | Ignored |
| ApplicationConsistentSnapshotInterval | Same as default provider |
| RecoveryHistory | Same as default provider |
| IncludedDisks[] | Same as default provider |
| AutoResynchronizeEnabled | Same as default provider |
| AutoResynchronizeIntervalStart | Same as default provider |
| AutoResynchronizeIntervalEnd | Same as default provider |
| EnableWriteOrderPreservationAcrossDisks (Deprecated) | Same as default provider |
| ReplicationInterval | Same as default provider |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 [desktop apps only] |
| Namespace |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|