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. | Qualifiers:Version ( "2.10.0" ) Experimental UMLPackagePath ( "CIM::Core::Settings" ) | Parameters (local in grey) | | Required datetime ConfigurationTimestamp ; The datetime when the configuration information was obtained. | OctetString Required uint8 ConfigurationInformation [ ] ; The configuration information stored as an octet string. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6..15999" , "16000" , "16001" , "16002" , "16003" , "16004" , "16005" , "16006..32767" , "32768..65535" } Values { "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" } uint32ApplyConfiguration( | | Indicates that the request is to validate the format and syntax of the configuration data but not apply it to the referenced ManagedElement. Qualifiers:IN
| | boolean ValidateOnly | | | 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. Qualifiers:ValueMap { "2" , "3" , "4" }
Values { "Running/Current Configuration" , "Initial/Default Configuration" , "Possible Configuration/Config Workspace" }
IN
| | uint16 TypeOfConfiguration | | | A reference to the ManagedElement whose configuration data is validated or applied. This reference is necessary because a configuration could apply to multiple elements simultaneously, but this processing request is more restrictive. Qualifiers:Required
IN
| | CIM_ManagedElement REF ManagedElement | ) 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. | 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. |
| | | | |
|