Condividi tramite

CIM_VirtualSystemSettingData class

  • Articolo

Describes the virtual aspects of a virtual system through a set of virtualization specific properties. CIM_VirtualSystemSettingData is also used as the top level class of virtual system configurations.

Virtual system configurations model configuration information about virtual systems and their components. A virtual system configuration consists of one top-level CIM_VirtualSystemSettingData instance that aggregates a number of CIM_ResourceAllocationSettingData instances that are associated using the CIM_ConcreteComponent class.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Experimental, Abstract, Version("2.13.0"), AMENDMENT]
class CIM_VirtualSystemSettingData : CIM_SettingData
{
  string   Caption;
  string   Description;
  uint16   SettingType;
  string   SystemName;
  string   InstanceID;
  string   ElementName;
  uint16   VirtualSystemType;
  boolean  AutoActivate;
  string   OtherVirtualSystemType;
  datetime CreationTime;
};

Members

The CIM_VirtualSystemSettingData class has these types of members:

Properties

The CIM_VirtualSystemSettingData class has these properties.

AutoActivate

Data type: boolean

Access type: Read-only

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

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

CreationTime

Data type: datetime

Access type: Read-only

The date and time when the virtual system configuration was created.

Description

Data type: string

Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read/write

Qualifiers: Override ("ElementName")

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: Read-only

Qualifiers: Override ("InstanceID")

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: Read-only

Qualifiers: ModelCorrespondence ("CIM_VirtualSystemSettingData.VirtualSystemType")

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

SettingType

Data type: uint16

Access type: Read-only

Describes a usage context of the instance.

Input (1)

Input designates an instance reflecting the virtual aspects of a input virtual system configuration

Recorded (2)

Recorded designates an instance reflecting the virtual aspects of a virtual system definition

Current (3)

Current designates an instance reflecting a virtual aspects of a currently active virtual

Capability (4)

Capability designates an instance reflecting virtual system capabilities.

Snapshot (5)

Snapshot designates an instance reflecting virtual aspects of a snapshot of a virtual system.

SystemName

Data type: string

Access type: Read/write

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: Read-only

Qualifiers: ModelCorrespondence ("CIM_VirtualSystemSettingData.OtherVirtualSystemType")

The type of the virtual system.

Note

If the virtual system type is unknown, this value must be set to "DMTF:unknown".

This property is formatted using the following Augmented Backus Naur Form (ABNF) format:

vs-type = dmtf-value / other-org-value / legacy-value; dmtf-value = "DMTF:" defining-org ":" org-vs-type; other-org-value = defining-org ":" org-vs-type;

The value of the above ABNF format are:

  • dmtf-value a property value defined by DMTF and is defined in the description of this property.
  • other-org-value is a property value defined by a business entity other than DMTF and is not defined in the description of this property.
  • legacy-value a property value defined by a business entity other than DMTF and is not defined in the description of this property. These values are permitted but recommended to be deprecated over time.
  • defining-org an identifier for the business entity that defines the virtual system type. It should include a copyrighted, trademarked, or a unique name that is owned by the business entity. It should not be "DMTF" and shall not contain a colon.
  • org-vs-type an identifier for the virtual system type within the defining business entity. It should be unique within defining-org. org-vs-type may use any character allowed for CIM strings, except the following: U0000-U001F (Unicode C0 controls), U0020 (space), U007F (Unicode C0 controls), or U0080-U009F (Unicode C1 controls).
  • If there is a need to structure the value into segments, the segments should be separated with a single colon.
  • The values of this property should be processed case sensitively. They are intended to be processed programmatically, instead of being a display name, and should be short.

Unknown (0)

Other (1)

Reserved General (2..100)

EMC vmWare (101)

Reserved EMC (102..199)

IBM Power - IVM (201)

IBM Power - VIOS (202)

IBM Power - i5/OS (203)

IBM System z - LPAR ESA/390 (204)

IBM System z - LPAR ESA/390 TPF (205)

IBM System z - LPAR CF (206)

IBM System z - LPAR Linux (207)

IBM System z - z/VM ESA (208)

IBM System z - z/VM XA (209)

IBM SYstem z - z/VM XC (210)

Reserved IBM (211..299)

Microsoft VirtualServer (301)

Reserved Microsoft (301..399)

XenSoft - Xen (401)

Reserved XenSoft (401-499)

Reserved Other Vendors (501..65535)

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
End of client support
 None supported
End of server support
 Windows Server 2012 R2
Namespace
 Root\virtualization
MOF
WindowsVirtualization.mof

See also

CIM_SettingData