DefineVirtualSystem method of the CIM_VirtualSystemManagementService class

Define a Virtual System. Input that is not completely specified will be filled out with default values.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

Syntax

uint32 DefineVirtualSystem(
  [in]  string                           SystemSettingData,
  [in]  string                           ResourceSettingData[],
  [in]  CIM_VirtualSystemSettingData REF SourceSetting,
  [out] CIM_ComputerSystem REF           DefinedSystem,
  [out] CIM_ConcreteJob REF              Job
);

Parameters

  • SystemSettingData [in]
    String containing a instance of CIM_VirtualSystemSettingData that is used to define attributes of the Virtual System to be created.

  • ResourceSettingData [in]
    Array of strings containing instance of CIM_ResourceAllocationSettingData that describe virtual aspects of virtual resources to be created in the scope of the new Virtual System.

  • SourceSetting [in]
    Reference to VirtualSystemSettingData object that is top level object representing a Template. SourceSetting definitions are merged with input settings definitions (input settings take precedence) to create definition of Virtual System.

  • DefinedSystem [out]
    Reference to ComputerSystem (if one is created)

  • Job [out]
    If operation is long running then optionally a job may be returned

Return value

This method returns one of the following values.

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

Namespace

Root\CIMV2

See also

CIM_VirtualSystemManagementService