CIM_VirtualSystemSettingData class

Defines the virtual aspects of a virtual system. Instances may be used for example to reflect the definition of a virtual system, to reflect the configuration of a running instance of virtual system, to reflect the requested configuration for a new virtual system, to reflect the configuration of a suspended or snapshot virtual system or to reflect a requested configuration change for a virtual system. An instance of CIM_VirtualSystemSettingData representing the virtual aspects of a computer system serves as the anchor point for instances of CIM_ResourceAllocationSettingData representing the virtual aspects of virtual resources in the scope of the 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.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class CIM_VirtualSystemSettingData : CIM_SettingData
{
  string   ElementName;
  string   InstanceID;
  string   SystemName;
  uint16   SettingType;
  uint16   VirtualSystemType;
  string   OtherVirtualSystemType;
  boolean  AutoActivate;
  datetime CreationTime;
};

Members

The CIM_VirtualSystemSettingData class has these types of members:

• Properties

Properties

The CIM_VirtualSystemSettingData class has these properties.

AutoActivate

Data type: boolean

Access type: Write-only

Flag that indicates whether the virtual system is automatically started when the virtualization platform is started.

CreationTime

Data type: datetime

Access type: Write-only

The date or time when the virtual system setting data was created. For snapshots, this value corresponds to the time at which the snapshot was taken. For non-snapshots, this value corresponds to the time at which the virtual system was created.

ElementName

Data type: string

Access type: Write-only

The display name of the virtual system. A associated instance of CIM_EnabledLogicalELementCapabilities indicates whether ElementName is modifiable or not.

InstanceID

Data type: string

Access type: Write-only

Key. For more information about the format, see the base class. Be aware that when used as an input element InstanceID must not be set by the client; instead, the implementation assigns a name, using implementation dependent rules.

OtherVirtualSystemType

Data type: string

Access type: Write-only

Designates the type of the virtual system if VirtualSystemType is set to 1 - Other.

SettingType

Data type: uint16

Access type: Write-only

SettingType describes a usage context of the instance. A value of 1 - Input designates an instance reflecting the virtual aspects of a input virtual system configuration, a value of 2 - Recorded designates an instance reflecting the virtual aspects of a virtual system definition, a value of 3 - Current designates an instance reflecting a virtual aspects of a currently active virtual, a value of 4 - Capability designates an instance reflecting virtual system capabilities, and a value of 5 - Snapshot designates an instance reflecting virtual aspects of a snapshot of a virtual system.

SystemName

Data type: string

Access type: Write-only

SystemName shall reflect a unique name for the system as it is used within the virtualization platform. Be aware that the SystemName is neither the hostname assigned to the operating system instance running within the virtual system, nor is it an IP address or MAC address assigned to any of its network ports.

VirtualSystemType

Data type: uint16

Access type: Write-only

Virtualization platforms may provide various types of virtual systems, some of which may be specifically designed for use by a particular operating system. A management application may learn about the set of types supported by a virtualization platform by analyzing class information provided by the virtualization platform specific subclass of this class. During virtual system creation a management application may request a particular virtual system type by setting this property accordingly.

Requirements

Namespace

Root\virtualization