Class CIM_VirtualSystemSettingData


  extends CIM_SettingData
CIM_VirtualSystemSettingData defines 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 instance of class CIM_VirtualSystemSettingData that aggregates a number of instances of class CIM_ResourceAllocationSettingData, using association CIM_ConcreteComponent. Virtual system configurations may for example be used to reflect configurations of - virtual systems that are defined at a virtualization platform, - virtual systems that are currently active, - input requests to create new virtual systems, - input requests to modify existing virtual systems, or - snapshots of virtual systems.
Details...
This class is not implemented.

Subclasses

 CIM_VirtualEthernetSwitchSettingData

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringCIM_VirtualSystemSettingData defines 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 instance of class CIM_VirtualSystemSettingData that aggregates a number of instances of class CIM_ResourceAllocationSettingData, using association CIM_ConcreteComponent. Virtual system configurations may for example be used to reflect configurations of - virtual systems that are defined at a virtualization platform, - virtual systems that are currently active, - input requests to create new virtual systems, - input requests to modify existing virtual systems, or - snapshots of virtual systems.None TRANSLATABLE= true
UMLPackagePathstringCIM::System::SystemElementsNone None
Versionstring2.25.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
AutomaticRecoveryActionuint16
DescriptionstringAction to take for the virtual system when the software executed by the virtual system fails. Failures in this case means a failure that is detectable by the host platform, such as a non-interuptable wait state condition.None TRANSLATABLE= true
ValueMapstring2, 3, 4, ..None None
ValuesstringNone, Restart, Revert to snapshot, DMTF ReservedNone TRANSLATABLE= true
AutomaticShutdownActionuint16
DescriptionstringAction to take for the virtual system when the host is shut down.None TRANSLATABLE= true
ValueMapstring2, 3, 4, ..None None
ValuesstringTurn Off, Save state, Shutdown, DMTF ReservedNone TRANSLATABLE= true
AutomaticStartupActionuint16
DescriptionstringAction to take for the virtual system when the host is started.None TRANSLATABLE= true
ValueMapstring2, 3, 4, ..None None
ValuesstringNone, Restart if previously active, Always startup, DMTF ReservedNone TRANSLATABLE= true
AutomaticStartupActionDelaydatetime
DescriptionstringDelay applicable to startup action. The value shall be in the interval variant of the datetime datatype.None TRANSLATABLE= true
AutomaticStartupActionSequenceNumberuint16
DescriptionstringNumber indicating the relative sequence of 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.None TRANSLATABLE= true
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
ConfigurationDataRootstring
DescriptionstringFilepath of a directory where information about the virtual system configuration is stored.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
ConfigurationFilestring
DescriptionstringFilepath of a file where information about the virtual system configuration is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
ConfigurationIDstring
DescriptionstringUnique id of the virtual system configuration. Note that the ConfigurationID is different from the InstanceID as it is assigned by the implementation to a virtual system or a virtual system configuration. It is not a key, and the same value may occur within more than one instance.None TRANSLATABLE= true
CreationTimedatetime
DescriptionstringTime when the virtual system configuration was created.None TRANSLATABLE= true
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
DescriptionstringThe user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)None TRANSLATABLE= true
OverridestringElementNameTOSUBCLASS= falseNone
RequiredbooleantrueNone OVERRIDABLE= false
InstanceIDstring
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
OverridestringInstanceIDTOSUBCLASS= falseNone
LogDataRootstring
DescriptionstringFilepath of a directory where log information about the virtual system is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
Notesstring
DescriptionstringEnd-user supplied notes that are related to the virtual system.None TRANSLATABLE= true
RecoveryFilestring
DescriptionstringFilepath of a file where recovery relateded information of the virtual system is stored.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
SnapshotDataRootstring
DescriptionstringFilepath of a directory where information about virtual system snapshots is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
SuspendDataRootstring
DescriptionstringFilepath of a directory where suspend related information about the virtual system is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
SwapFileDataRootstring
DescriptionstringFilepath of a directory where swapfiles of the virtual system are stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.None TRANSLATABLE= true
VirtualSystemIdentifierstring
DescriptionstringVirtualSystemIdentifier shall reflect a unique name for the system as it is used within the virtualization platform. Note that the 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. On create requests VirtualSystemIdentifier may contain implementation specific rules (like simple patterns or regular expresssion) that may be interpreted by the implementation when assigning a VirtualSystemIdentifier.None TRANSLATABLE= true
VirtualSystemTypestring
DescriptionstringVirtualSystemType shall reflect a particular type of virtual system. The property value shall conform to this format (in ABNF): 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; Where: dmtf-value: is 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: is 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: is an identifier for the business entity that defines the virtual system type. It shall include a copyrighted, trademarked, or otherwise unique name that is owned by that business entity. It shall not be "DMTF" and shall not contain a colon (:). org-vs-type: is an identifier for the virtual system type within the defining business entity. It shall be unique within the defining-org. It may use any character allowed for CIM strings, except for the following: U0000-U001F (Unicode C0 controls) U0020 (space), note that the reason is that OVF allows for multiple space-separated vs-type values in this property. U007F (Unicode C0 controls) 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 shall be processed case sensitively. They are intended to be processed programmatically (instead of being a display name) and should be short. As stated in the class description, instances of this class may be used for various purposes. A management application intending to use an instance of this class as input parameter to an operation that creates or modifies a virtual system should first determine the set of valid virtual system types that are supported by the virtualization platform hosting the virtual system by inspecting values of array property VirtualSystemTypesSupported of the instance of class CIM_VirtualSystemManagementCapabilities that describes the capabilities of the virtualization platform. The following DMTF values are defined: DMTF:unknown - the virtual system type is unknown or cannot be determinedNone TRANSLATABLE= true

Copyright © 2008-2009 VMware, Inc. All rights reserved.