InitiateFailover method of the Msvm_ReplicationService class

Initiates a failover for a virtual machine to an application or standard replication point image.

Syntax

uint32 InitiateFailover(
  [in]  CIM_ComputerSystem           REF ComputerSystem,
  [in]  CIM_VirtualSystemSettingData REF SnapshotSettingData,
  [out] CIM_ConcreteJob              REF Job
);

Parameters

ComputerSystem [in]

A reference to a CIM_ComputerSystem instance that represents the virtual machine for which to initiate a failover.

SnapshotSettingData [in]

A reference to a CIM_VirtualSystemSettingData instance that represents the snapshot used for the failover. If this parameter is Null, the failover is to be performed to the latest point in time.

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)

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	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

Msvm_ReplicationService

RevertFailover

SetFailoverNetworkAdapterSettings