ModifyVirtualSystem method of the CIM_VirtualSystemManagementService class

  • Article

General method for modifying settings associated with a virtual system.

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 ModifyVirtualSystem(
  [in]  CIM_ComputerSystem REF                ComputerSystem,
  [in]  string                                ModifySystemSettingData,
  [in]  string                                NewResourceSettingData[],
  [in]  string                                ModifyResourceSettingData[],
  [in]  CIM_ResourceAllocationSettingData REF DeleteResourceSettings[],
  [out] CIM_ConcreteJob REF                   Job
);

Parameters

  • ComputerSystem [in]
    A reference to an instance of the CIM_ComputerSystem class that represents a virtual computer system to be modified.

  • ModifySystemSettingData [in]
    A string that contains an instance of the CIM_VirtualSystemSettingData class that is used to modify attributes of the Virtual System. The instance must have a valid InstanceID that identifies the instance of the CIM_VirtualSystemSettingData class to be modified. That instance must be associated to the Virtual System by using the CIM_ElementSettingData association.

  • NewResourceSettingData [in]
    An array of strings that contain an embedded instance of the CIM_ResourceAllocationSettingData class and that describe virtual aspects of new virtual resources to be created in the scope of the Virtual System.

  • ModifyResourceSettingData [in]
    An array of strings that contain an embedded instance of the CIM_ResourceAllocationSettingData class and that describe modifications to virtual aspects of existing virtual resources of the Virtual System. All instances must have a valid InstanceID to correctly identify the virtual resource to be modified.

  • DeleteResourceSettings [in]
    An array of references to instances of the CIM_ResourceAllocationSettingData class that identify virtual resources in the scope of the addressed Virtual System that are to be removed from the Virtual System.

  • 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)

Invalid State (5)

Incompatible Parameters (6)

DMTF Reserved (..)

Method Parameters Checked - Job Started (4096)

Method Reserved (4097..32767)

Vendor Specific (32768..65535)

Requirements

Namespace

Root\CIMV2

See also

CIM_VirtualSystemManagementService