CIM2.17.1 Class Declaration
CIM_VirtualSystemSettingData

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_VirtualSystemSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_VirtualSystemSettingData

Class Qualifiers

Class CIM_VirtualSystemSettingData Qualifiers
NameTypeValueFrom Class
ExperimentalbooleantrueCIM_VirtualSystemSettingData
Versionstring2.16.0CIM_VirtualSystemSettingData
UMLPackagePathstringCIM::System::SystemElementsCIM_VirtualSystemSettingData
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.CIM_VirtualSystemSettingData
UMLPackagePathstringCIM::Core::SettingsCIM_SettingData
DescriptionstringCIM_SettingData is used to represent configuration and and operational parameters for CIM_ManagedElement instances. There are a number of different uses of CIM_SettingData supported in the model today. Additional uses may be defined in the future.Instances of CIM_SettingData may represent Aspects of a CIM_ManagedElement instance. This is modeled using the CIM_SettingsDefineState association. CIM_SettingData may be used to define capabilities when associated to an instance of CIM_Capabilities through the CIM_SettingsDefineCapabilities association. Instances of CIM_SettingData may represent different types of configurations for a CIM_ManagedElement, including persistent configurations, in progress configuration changes, or requested configurations. The CIM_ElementSettingData association is used to model the relationship between a CIM_SettingData instance and the CIM_ManagedElement for which it is a configuration. When an instance of CIM_SettingData represents a configuration, the current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations.CIM_SettingData
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
VirtualSystemIdentifierstring Description CIM_VirtualSystemSettingData
VirtualSystemTypestring Description CIM_VirtualSystemSettingData
Notesstring[] Description CIM_VirtualSystemSettingData
CreationTimedatetime Description CIM_VirtualSystemSettingData
ConfigurationIDstring Description CIM_VirtualSystemSettingData
ConfigurationDataRootstring Description CIM_VirtualSystemSettingData
ConfigurationFilestring Description CIM_VirtualSystemSettingData
SnapshotDataRootstring Description CIM_VirtualSystemSettingData
SuspendDataRootstring Description CIM_VirtualSystemSettingData
SwapFileDataRootstring Description CIM_VirtualSystemSettingData
LogDataRootstring Description CIM_VirtualSystemSettingData
AutomaticStartupActionuint16 Description
ValueMap
Values
CIM_VirtualSystemSettingData
AutomaticStartupActionDelaydatetime Description CIM_VirtualSystemSettingData
AutomaticStartupActionSequenceNumberuint16 Description CIM_VirtualSystemSettingData
AutomaticShutdownActionuint16 Description
ValueMap
Values
CIM_VirtualSystemSettingData
AutomaticRecoveryActionuint16 Description
ValueMap
Values
CIM_VirtualSystemSettingData
RecoveryFilestring Description CIM_VirtualSystemSettingData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
ConfigurationNamestring Experimental
Description
CIM_SettingData
ChangeableTypeuint16 Experimental
Description
ValueMap
Values
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property VirtualSystemIdentifier Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property VirtualSystemType Qualifiers
NameTypeValueFrom Class
DescriptionstringVirtualSystemType 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.CIM_VirtualSystemSettingData

Property Notes Qualifiers
NameTypeValueFrom Class
DescriptionstringEnd-user supplied notes that are related to the virtual system.CIM_VirtualSystemSettingData

Property CreationTime Qualifiers
NameTypeValueFrom Class
DescriptionstringTime when the virtual system configuration was created.CIM_VirtualSystemSettingData

Property ConfigurationID Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property ConfigurationDataRoot Qualifiers
NameTypeValueFrom Class
DescriptionstringFilepath of a directory where information about the virtual system configuration is stored.Format shall be URI based on RFC 2079.CIM_VirtualSystemSettingData

Property ConfigurationFile Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property SnapshotDataRoot Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property SuspendDataRoot Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property SwapFileDataRoot Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property LogDataRoot Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property AutomaticStartupAction Qualifiers
NameTypeValueFrom Class
DescriptionstringAction to take for the virtual system when the host is started.CIM_VirtualSystemSettingData
ValueMapstring
[See below.]
CIM_VirtualSystemSettingData
ValuesstringNone
Restart if previously active
Always startup
DMTF Reserved
CIM_VirtualSystemSettingData

NameValue
2None
3Restart if previously active
4Always startup
..DMTF Reserved
Property AutomaticStartupActionDelay Qualifiers
NameTypeValueFrom Class
DescriptionstringDelay applicable to startup action. The value shall be in the interval variant of the datetime datatype.CIM_VirtualSystemSettingData

Property AutomaticStartupActionSequenceNumber Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData

Property AutomaticShutdownAction Qualifiers
NameTypeValueFrom Class
DescriptionstringAction to take for the virtual system when the host is shut down.CIM_VirtualSystemSettingData
ValueMapstring
[See below.]
CIM_VirtualSystemSettingData
ValuesstringTurn Off
Save state
Shutdown
DMTF Reserved
CIM_VirtualSystemSettingData

NameValue
2Turn Off
3Save state
4Shutdown
..DMTF Reserved
Property AutomaticRecoveryAction Qualifiers
NameTypeValueFrom Class
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.CIM_VirtualSystemSettingData
ValueMapstring
[See below.]
CIM_VirtualSystemSettingData
ValuesstringNone
Restart
Revert to snapshot
DMTF Reserved
CIM_VirtualSystemSettingData

NameValue
2None
3Restart
4Revert to snapshot
..DMTF Reserved
Property RecoveryFile Qualifiers
NameTypeValueFrom Class
DescriptionstringFilepath of a file where recovery relateded information of the virtual system is stored.Format shall be URI based on RFC 2079.CIM_VirtualSystemSettingData

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_SettingData
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.CIM_SettingData

Property ElementName Qualifiers
NameTypeValueFrom Class
RequiredbooleantrueCIM_SettingData
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.)CIM_SettingData

Property ConfigurationName Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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.CIM_SettingData

Property ChangeableType Qualifiers
NameTypeValueFrom Class
DescriptionstringEnumeration 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.CIM_SettingData
ValueMapstring
[See below.]
CIM_SettingData
ValuesstringNot Changeable - Persistent
Changeable - Transient
Changeable - Persistent
Not Changeable - Transient
CIM_SettingData

NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object.CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_VirtualSystemSettingDataComponentCIM_VirtualSystemSettingDataGroupComponent
CIM_LastAppliedSnapshotCIM_VirtualSystemSettingDataAntecedent
CIM_MostCurrentSnapshotInBranchCIM_VirtualSystemSettingDataDependent
CIM_SnapshotOfVirtualSystemCIM_VirtualSystemSettingDataDependent
CIM_SettingsDefineStateCIM_SettingDataSettingData
CIM_SettingsDefineCapabilitiesCIM_SettingDataPartComponent
CIM_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_SettingsAffectSettingsCIM_SettingDataAntecedent
CIM_SettingsAffectSettingsCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_SettingsDefineStateCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_OrderedComponentCIM_ManagedElementGroupComponent
CIM_OrderedComponentCIM_ManagedElementPartComponent
CIM_ProductElementComponentCIM_ManagedElementPartComponent
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_OrderedMemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_MemberOfStatusCollectionCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_AbstractIndicationSubscriptionCIM_ManagedElementFilter
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_AvailableDiagnosticServiceCIM_ManagedElementUserOfService
CIM_AssociatedPowerManagementServiceCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement