Msvm_ReplicationService::InitiateFailback method

Article
01/07/2021

Initiates the failback for a recovery virtual machine.

Syntax

uint32 InitiateFailback(
  [in]  CIM_ComputerSystem ComputerSystem,
  [in]  string                 ReplicationSettingData,
  [in]  string                 RecoveryPointIdentifier,
  [out] CIM_ConcreteJob    Job
);

Parameters

ComputerSystem [in]: A reference to a CIM_ComputerSystem instance that represents the virtual machine for which to initiate a failback.
ReplicationSettingData [in]: A string representation of an embedded instance of the Msvm_ReplicationSettingData class that defines the replication settings for the failback.
RecoveryPointIdentifier [in]: Optional input that identifies the recovery point to which failback is requested.
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. This reference can be used to monitor progress and to obtain the result of the method.

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

InitiateFailback works on a recovery virtual machine and takes the virtual machine to WaitingForFailback state. InitiateFailback forwards the failback request to the corresponding provider, which reverse-resyncs the recovery point from new-primary side. After failback of the requested recovery point completes, the replication state moves to FailbackCompleted state.

Requirements

Requirement	Value
Minimum supported client	Windows 8.1 [desktop apps only]
Minimum supported server	Windows Server 2012 R2 [desktop apps only]
Namespace	\\Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe