Share via


DefineSystem method of the CIM_VirtualSystemManagementService class

Defines a virtual system.

Syntax

uint32 DefineSystem(
  [in]  string                           SystemSettings,
  [in]  string                           ResourceSettings[],
  [in]  CIM_VirtualSystemSettingData REF ReferenceConfiguration,
  [out] CIM_ComputerSystem           REF ResultingSystem,
  [out] CIM_ConcreteJob              REF Job
);

Parameters

SystemSettings [in]

An embedded instance of the CIM_VirtualSystemSettingData class that is used to define the attributes of the virtual system to create.

ResourceSettings [in]

An array that contains embedded instances of the CIM_ResourceAllocationSettingData class that represent resource settings for the virtual system.

ReferenceConfiguration [in]

A reference to an instance of the CIM_VirtualSystemSettingData class that is the top level object of a reference virtual system configuration. The reference configuration is used to complement the configuration of the new virtual system if the SystemSettings and ResourceSettings parameters do not provide the necessary information.

ResultingSystem [out]

A reference to the CIM_ComputerSystem instance that represents defined virtual computer system.

Job [out]

If the operation is to run asynchronously, this parameter will return a job for the operation.

Return value

The possible return values are:

Completed with No Error (0)

Not Supported (1)

Failed (2)

Timeout (3)

Invalid Parameter (4)

DMTF Reserved (5 4095)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097 32767)

Vendor Specific (32768 65535)

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

CIM_VirtualSystemManagementService