Share via


InitiatePlannedFailover method of the Msvm_CollectionReplicationService class

Initiates planned failover (synced replication) for a group of virtual machines.

Syntax

uint32 InitiatePlannedFailover(
  [in]  CIM_CollectionOfMSEs REF Collection,
  [out] CIM_ConcreteJob      REF Job
);

Parameters

Collection [in]

A reference to the CIM_CollectionOfMSEs instance for which to initiate planned failover.

Job [out]

An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.

Return value

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

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Namespace
Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.Mof
DLL
VMMS.exe

See also

Msvm_CollectionReplicationService