CIM_VirtualSystemSettingData class

  • [アーティクル]

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

[Abstract, Version("2.25.0"), UMLPackagePath("CIM::System::SystemElements"), AMENDMENT]
class CIM_VirtualSystemSettingData : CIM_SettingData
{
  string   Caption;
  string   Description;
  string   InstanceID;
  string   ElementName;
  string   VirtualSystemIdentifier;
  string   VirtualSystemType;
  string   Notes[];
  datetime CreationTime;
  string   ConfigurationID;
  string   ConfigurationDataRoot;
  string   ConfigurationFile;
  string   SnapshotDataRoot;
  string   SuspendDataRoot;
  string   SwapFileDataRoot;
  string   LogDataRoot;
  uint16   AutomaticStartupAction;
  datetime AutomaticStartupActionDelay;
  uint16   AutomaticStartupActionSequenceNumber;
  uint16   AutomaticShutdownAction;
  uint16   AutomaticRecoveryAction;
  string   RecoveryFile;
};

Members

The CIM_VirtualSystemSettingData class has these types of members:

Properties

The CIM_VirtualSystemSettingData class has these properties.

AutomaticRecoveryAction

Data type: uint16

Access type: Read-only

The action to take for the virtual system when the software executed by the virtual system fails. The failures addressed by this property only include those that are detectable by the host platform, such as a non-interruptible wait state condition.

The possible values are.

None (2)

Restart (3)

Revert to snapshot (4)

DMTF Reserved

5 = *value*

AutomaticShutdownAction

Data type: uint16

Access type: Read-only

The action to take for the virtual system when the host is shut down.

The possible values are.

Turn Off (2)

Save state (3)

Shutdown (4)

DMTF Reserved

5 = *value*

AutomaticStartupAction

Data type: uint16

Access type: Read-only

The action to take on the virtual system when the host is started.

The possible values are.

None (2)

Restart if previously active (3)

Always startup (4)

DMTF Reserved

5 65535

AutomaticStartupActionDelay

Data type: datetime

Access type: Read-only

The delay for the startup action. This value is an interval variant of the datetime data type.

AutomaticStartupActionSequenceNumber

Data type: uint16

Access type: Read-only

The sequence number for virtual system activation when the host system is started. A lower number indicates earlier activation. If one or more configurations show the same value, the sequence is implementation dependent. A value of "0" indicates that the sequence is implementation dependent.

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.

ConfigurationDataRoot

Data type: string

Access type: Read-only

The file path of the directory where information about the virtual system configuration is stored. The format of this property is a URI based on RFC 2079.

ConfigurationFile

Data type: string

Access type: Read-only

The relative path of the file where information about the virtual system configuration is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

ConfigurationID

Data type: string

Access type: Read-only

The unique id of the virtual system configuration.

Note

ConfigurationID is different from the InstanceID, and is assigned by the implementation to a virtual system or a virtual system configuration. ConfigurationID is not a key, and the same value may occur for more than one instance.

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

Qualifiers: Required

The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.

This property is inherited from CIM_SettingData.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

  • OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
  • OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
  • LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
  • If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
  • For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".

This property is inherited from CIM_SettingData.

LogDataRoot

Data type: string

Access type: Read-only

The relative file path of the directory where log information for the virtual system is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

Notes

Data type: string array

Access type: Read-only

An array that contains user supplied notes that are related to the virtual system.

RecoveryFile

Data type: string

Access type: Read-only

The path of the file where recovery related information of the virtual system is stored. The format of this property is a URI based on RFC 2079.

SnapshotDataRoot

Data type: string

Access type: Read-only

The relative path of the directory where information about virtual system snapshots is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

SuspendDataRoot

Data type: string

Access type: Read-only

The relative path of the directory where suspend related information about the virtual system is stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

SwapFileDataRoot

Data type: string

Access type: Read-only

The relative file path of the directory where swap files of the virtual system are stored. The relative path appends to the value of the ConfigurationDataRoot property. The format of this property is a URI based on RFC 2079.

VirtualSystemIdentifier

Data type: string

Access type: Read-only

The unique name for the system within the virtualization platform. VirtualSystemIdentifier is not 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.

The VirtualSystemIdentifier may contain implementation specific rules, like simple patterns or a regular expression that may be interpreted by the implementation when setting VirtualSystemIdentifier.

VirtualSystemType

Data type: string

Access type: Read-only

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.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2016
Namespace
 Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

CIM_SettingData

Failover Clustering Hyper-V WMI Provider