CIM211 Class Declaration
CIM_ConfigurationData

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

Class Hierarchy

CIM_ConfigurationData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_ConfigurationData

Class Qualifiers

Class CIM_ConfigurationData Qualifiers
NameTypeValueFrom Class
Experimentalbooleantrue CIM_ConfigurationData
Versionstring2.10.0 CIM_ConfigurationData
DescriptionstringCaptures the configuration information of the element as an octet string (that is, a " blob " ). The configuration data is element-specific and generalizes (for any element) the semantically similar Save/RestoreProperties methods that are currently defined as part of the LogicalDevice class. Various types of configurations can be instantiated for an element, such as a currently running config, a startup config, or other possible configurations. The configuration type is specified in the association of the instance to a ManagedElement using the properties of the ElementSettingData association: - When the configuration is currently running, then the IsCurrent Boolean of the association is true. - When the configuration is the initial or startup config, then the IsDefault Boolean is true. - If the IsCurrent and IsDefault Booleans are false, then the configuration is assumed to be a " possible " config (configuration workspace) for the element. Note: This class has an " apply " method only with no corresponding " extract " . It has no extract because an application or client can query for and enumerate any existing configurations using existing CIM Operations. It is the responsibility of the client to reuse or reapply the configurations that are returned by such a request because the configuration data itself is opaque and element-specific. Only one " running " configuration can exist at any time. In addition, this configuration can be the only configuration reported by an element. However, elements can also have one " startup " configuration and can have multiple possible/workspace configurations. The configurations can be identical. For example, if a possible configuration is applied to an element (and therefore made the running/current configuration), then the two configs would be identical upon a subsequent query or enumerate instances request. CIM_ConfigurationData
DescriptionstringThe SettingData class represents configuration-related and operational parameters for one or more ManagedElements. A ManagedElement can have multiple SettingData objects associated with it. 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
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
ConfigurationInformationuint8[] Required
Description
OctetString
CIM_ConfigurationData
ConfigurationTimestampdatetime Required
Description
CIM_ConfigurationData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property ConfigurationInformation Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_ConfigurationData
DescriptionstringThe configuration information stored as an octet string. CIM_ConfigurationData
OctetStringbooleantrue CIM_ConfigurationData

Property ConfigurationTimestamp Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_ConfigurationData
DescriptionstringThe datetime when the configuration information was obtained. CIM_ConfigurationData

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_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
Requiredbooleantrue CIM_SettingData
OverridestringElementName CIM_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 Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_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

NameTypeValueQualifiersParametersClassOrigin
ApplyConfigurationuint32 Description
ValueMap
Values
ValidateOnly
TypeOfConfiguration
CIM_ConfigurationData

Method Qualifiers

Method ApplyConfiguration Qualifiers
NameTypeValueFrom Class
DescriptionstringThis method processes the configuration data for an element. In this case, the data in the ConfigurationInformation property of the instance is validated for the specified element (if the ValidateOnly parameter is true), or is actually set as a configuration on the element. If the method is successful, then the appropriate ElementSettingData associations are created or modified. Note: It is not necessary for the element to be associated with the ConfigurationData instance at the time that this method is called. CIM_ConfigurationData
ValueMapstring
[See below.]
CIM_ConfigurationData
ValuesstringSuccess
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
DMTF Reserved
Validate Only Request Not Supported
Configuration Data Would Not Validate
Element Does Not Support Initial/Default Configs
Element Does Not Support Possible Configs/Config Workspaces
Element Does Not Support Setting of the Running/Current Config
Element Would Not Accept Configuration
Method Reserved
Vendor Specific
CIM_ConfigurationData

Parameters

Method ApplyConfiguration Parameters
NameTypeQualifiers
ValidateOnlybooleanIN
Description
TypeOfConfigurationuint16IN
Description
ValueMap
Values

Parameter Qualifiers

Parameter ValidateOnly Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_ConfigurationData
DescriptionstringIndicates that the request is to validate the format and syntax of the configuration data but not apply it to the referenced ManagedElement. CIM_ConfigurationData

Parameter TypeOfConfiguration Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_ConfigurationData
DescriptionstringThe type of configuration information, indicating whether the ConfigurationInformation property holds an initial/default configuration, a running/current configuration, or a configuration for a temporary/ possible workspace. This information affects the values of the IsDefault and IsCurrent properties of the association, ElementSettingData. CIM_ConfigurationData
ValueMapstring
[See below.]
CIM_ConfigurationData
ValuesstringRunning/Current Configuration
Initial/Default Configuration
Possible Configuration/Config Workspace
CIM_ConfigurationData

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement