Class CIM_ConfigurationData

extends CIM_SettingData
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.
Details...
This class is not implemented.

Class Qualifiers

Name	Data Type	Value	Scope	Flavors
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.	None	TRANSLATABLE= true
Experimental	boolean	true	TOSUBCLASS= false	None
UMLPackagePath	string	CIM::Core::Settings	None	None
Version	string	2.10.0	TOSUBCLASS= false	TRANSLATABLE= true

Local Class Properties

Name	Data Type	Qualifiers
Name	Data Type	Name	Data Type	Value	Scope	Flavors
Caption	string
		Description	string	The Caption property is a short textual description (one- line string) of the object.	None	TRANSLATABLE= true
		MaxLen	uint32	64	None	None
ChangeableType	uint16
		Description	string	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.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
		ValueMap	string	0, 1, 2, 3	None	None
		Values	string	Not Changeable - Persistent, Changeable - Transient, Changeable - Persistent, Not Changeable - Transient	None	TRANSLATABLE= true
ConfigurationInformation	uint8
		Description	string	The configuration information stored as an octet string.	None	TRANSLATABLE= true
		OctetString	boolean	true	None	OVERRIDABLE= false
		Required	boolean	true	None	OVERRIDABLE= false
ConfigurationName	string
		Description	string	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.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
ConfigurationTimestamp	datetime
		Description	string	The datetime when the configuration information was obtained.	None	TRANSLATABLE= true
		Required	boolean	true	None	OVERRIDABLE= false
Description	string
Description	string	Description	string	The Description property provides a textual description of the object.	None	TRANSLATABLE= true
ElementName	string
		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.)	None	TRANSLATABLE= true
		Override	string	ElementName	TOSUBCLASS= false	None
		Required	boolean	true	None	OVERRIDABLE= false
Generation	uint64
		Description	string	Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class. If Generation is supported by the implementation, its value shall not be null. Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation. After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification. Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update. Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance. Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated. Subclasses may define additional requirements for updates on some or all of related instances. For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years. This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail. The usage of this property is intended to be further specified by applicable management profiles. Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation. For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
InstanceID	string
		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.	None	TRANSLATABLE= true
		Key	boolean	true	None	OVERRIDABLE= false
		Override	string	InstanceID	TOSUBCLASS= false	None

Local Class Methods

Name	Return Type	Qualifiers
Name	Return Type	Name	Data Type	Value	Scope	Flavors
ApplyConfiguration()	uint32
		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.	None	TRANSLATABLE= true
		ValueMap	string	0, 1, 2, 3, 4, 5, 6..15999, 16000, 16001, 16002, 16003, 16004, 16005, 16006..32767, 32768..65535	None	None
		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 Specific	None	TRANSLATABLE= true