System\CIM_VirtualSystemSettingData.mof.mof (HTML version)

Return to index
CIM_VirtualSystemSettingData Superclass: 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.
Qualifiers:Version ( "2.14.0" ) Experimental UMLPackagePath ( "CIM::System::SystemElements" )
Parameters (local in grey)
string VirtualSystemType ;
VirtualSystemType shall reflect a particular type of virtual system. Implementations are commonly capable to support various implementation defined virtual system types.
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.
string VirtualSystemIdentifier ;
VirtualSystemIdentifier 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.
ValueMap { "0" , "1" , "2" , "3" }
Values { "Not Changeable - Persistent" , "Changeable - Transient" , "Changeable - Persistent" , "Not Changeable - Transient" }
Experimental
uint16 ChangeableType ;
Enumeration indicating the type of setting.
0 'Not Changeable - Persistent' indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 'Changeable - Transient' indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported.
2 'Changeable - Persistent' indicates the SettingData represents a persistent configuration that may be modified.
3 'Not Changeable - Transient' indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent.
Required
Override ( "ElementName" )
string ElementName ;
The 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.)
Experimental
string ConfigurationName ;
An instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown.
Key
string InstanceID ;
Within 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.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.