SetFailoverNetworkAdapterSettings method of the Msvm_ReplicationService class

Configures the network adapter's IP settings to be applied to a virtual machine after a failover. These configuration parameters are applied after a failover operation, immediately upon establishing communication with the KVP Exchange integration component running within the guest operating system.

Syntax

uint32 SetFailoverNetworkAdapterSettings(
  [in]  CIM_ComputerSystem REF ComputerSystem,
  [in]  string                 NetworkSettings[],
  [out] CIM_ConcreteJob    REF Job
);

Parameters

ComputerSystem [in]

A reference to a CIM_ComputerSystem instance that represents the virtual machine whose network adapters are to be configured.

NetworkSettings [in]

An array of embedded instances of Msvm_FailoverNetworkAdapterSettingData objects. Each instance describes the configuration parameters for one of the network adapters within the virtual machine. The IPAddresses and DHCPEnabled properties must be specified on each instance.

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)

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

InitiateFailover

Msvm_ReplicationService

RevertFailover