Edit

Share via

DefineSystem method of the CIM_VirtualSystemManagementService class

  • Article

Defines a virtual system.

Input that is not completely specified may be filled out with default values.

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]

String containing an embedded instance of class CIM_VirtualSystemSettingData that is used to define attributes of the virtual system to be created.

ResourceSettings [in]

Array of strings each containing an embedded instance of class CIM_ResourceAllocationSettingData that describes the virtual aspects of a virtual resource to be created in the scope of the new virtual system.

ReferenceConfiguration [in]

Reference to a CIM_VirtualSystemSettingDat object instance 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 did not provide respective information.

ResultingSystem [out]

If a virtual computer system is successfully defined, a reference to an instance of class CIM_ComputerSystem that represents the newly defined virtual computer system is returned.

Job [out]

If the operation is long running, then optionally a job may be returned. In this case, the instance of class CIM_ComputerSystem representing the new virtual system is presented via association CIM_AffectedJobElement with the property AffectedElement referring to the new instance of class CIM_ComputerSystem and property ElementEffects set to 5 (Create).

Return value

Returns a 0 on success; otherwise, returns an error.

Completed with No Error (0)

Not Supported (1)

Failed (2)

Timeout (3)

Invalid Parameter (4)

DMTF Reserved (..)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097..32767)

Vendor Specific (32768..65535)

Requirements

Requirement Value
Minimum supported client
 Windows 8.1
Minimum supported server
 Windows Server 2012 R2
Namespace
 Root\virtualization\v2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

CIM_VirtualSystemManagementService