Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_ConfigurationData --> CIM_SettingData --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_SettingData NAME CIM_ConfigurationData
Class CIM_ConfigurationData Qualifiers Name Type Value From Class Experimental boolean true CIM_ConfigurationData Version string 2.10.0 CIM_ConfigurationData Description string Captures 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 Description string The 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 Description string ManagedElement 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 Name Type Value Qualifiers ClassOrigin ConfigurationInformation uint8[] Required
Description
OctetStringCIM_ConfigurationData ConfigurationTimestamp datetime Required
DescriptionCIM_ConfigurationData InstanceID string Key
DescriptionCIM_SettingData ElementName string Required
Override
DescriptionCIM_SettingData Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement Property Qualifiers
Property ConfigurationInformation Qualifiers Name Type Value From Class Required boolean true CIM_ConfigurationData Description string The configuration information stored as an octet string. CIM_ConfigurationData OctetString boolean true CIM_ConfigurationData
Property ConfigurationTimestamp Qualifiers Name Type Value From Class Required boolean true CIM_ConfigurationData Description string The datetime when the configuration information was obtained. CIM_ConfigurationData
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_SettingData Description string 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. CIM_SettingData
Property ElementName Qualifiers Name Type Value From Class Required boolean true CIM_SettingData Override string ElementName CIM_SettingData Description string 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.) CIM_SettingData
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A 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
Name Type Value Qualifiers Parameters ClassOrigin ApplyConfiguration uint32 Description
ValueMap
ValuesValidateOnly
TypeOfConfigurationCIM_ConfigurationData Method Qualifiers
Method ApplyConfiguration Qualifiers Name Type Value From Class Description string This 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 ValueMap string [See below.] CIM_ConfigurationData Values string Success
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 SpecificCIM_ConfigurationData Parameters
Method ApplyConfiguration Parameters Name Type Qualifiers ValidateOnly boolean IN
DescriptionTypeOfConfiguration uint16 IN
Description
ValueMap
ValuesParameter Qualifiers
Parameter ValidateOnly Qualifiers Name Type Value From Class IN boolean true CIM_ConfigurationData Description string Indicates 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 Name Type Value From Class IN boolean true CIM_ConfigurationData Description string The 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 ValueMap string [See below.] CIM_ConfigurationData Values string Running/Current Configuration
Initial/Default Configuration
Possible Configuration/Config WorkspaceCIM_ConfigurationData