Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_Setting --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_ManagedElement NAME CIM_Setting
Class CIM_Setting Qualifiers Name Type Value From Class Abstract boolean true CIM_Setting Version string 2.7.0 CIM_Setting Description string The Setting class represents configuration-related and operational parameters for one or more ManagedSystemElement(s). An Element may have multiple Setting objects associated with it. The current operational values for an Element ’ s parameters are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values present in the Setting object. For example, a modem may have a Setting baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note that the CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model. This is 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. CIM_Setting 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 SettingID string Description
MaxLenCIM_Setting Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement ElementName string Description CIM_ManagedElement Property Qualifiers
Property SettingID Qualifiers Name Type Value From Class Description string The identifier by which the Setting object is known. CIM_Setting MaxLen uint32 256 CIM_Setting
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 ManagedSystemElement ’ s Name property 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 MAY be present in both the Name and ElementName properties. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin VerifyOKToApplyToMSE uint32 Description TimeToApply
MustBeCompletedByCIM_Setting ApplyToMSE uint32 Description TimeToApply
MustBeCompletedByCIM_Setting VerifyOKToApplyToCollection uint32 Description TimeToApply
MustBeCompletedBy
CanNotApplyCIM_Setting ApplyToCollection uint32 Description TimeToApply
ContinueOnError
MustBeCompletedBy
CanNotApplyCIM_Setting VerifyOKToApplyIncrementalChangeToMSE uint32 Description TimeToApply
MustBeCompletedBy
PropertiesToApplyCIM_Setting ApplyIncrementalChangeToMSE uint32 Description TimeToApply
MustBeCompletedBy
PropertiesToApplyCIM_Setting VerifyOKToApplyIncrementalChangeToCollection uint32 Description TimeToApply
MustBeCompletedBy
PropertiesToApply
CanNotApplyCIM_Setting ApplyIncrementalChangeToCollection uint32 Description TimeToApply
ContinueOnError
MustBeCompletedBy
PropertiesToApply
CanNotApplyCIM_Setting Method Qualifiers
Method VerifyOKToApplyToMSE Qualifiers Name Type Value From Class Description string The VerifyOKToApplyToMSE method is used to verify that this Setting can be ’ applied ’ to the referenced Managed SystemElement, at the given time or time interval. This method takes three input parameters: MSE (the Managed SystemElement that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), and MustBeCompletedBy (which indicates the required completion time for the method). The return value should be 0 if it is OK to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_Setting
Method ApplyToMSE Qualifiers Name Type Value From Class Description string The ApplyToMSE method performs the actual application of the Setting to the referenced ManagedSystemElement. It takes three input parameters: MSE (the ManagedSystem Element to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), and MustBeCompletedBy (which indicates the required completion time for the method). Note that the semantics of this method are that individual Settings are either wholly applied or not applied at all to their target ManagedSystemElement. The return value should be 0 if the Setting is successfully applied to the referenced ManagedSystemElement, 1 if the method is not supported, 2 if the Setting was not applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. Note: If an error occurs in applying the Setting to a ManagedSystemElement, the Element must be configured as when the ’ Apply ’ attempt began. That is, the Element should NOT be left in an indeterminate state. CIM_Setting
Method VerifyOKToApplyToCollection Qualifiers Name Type Value From Class Description string The VerifyOKToApplyToCollection method is used to verify that this Setting can be ’ applied ’ to the referenced Collection of ManagedSystemElements, at the given time or time interval, without causing adverse effects to either the Collection itself or its surrounding environment. The net effect is to execute the VerifyOKToApply method against each of the Elements aggregated by the Collection. This method takes three input parameters: Collection (the Collection of Managed SystemElements that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), and MustBeCompletedBy (which indicates the required completion time for the method). The return value should be 0 if it is OK to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. One output parameter is defined - CanNotApply - which is a string array that lists the keys of the ManagedSystemElements to which the Setting can NOT be applied. This enables those Elements to be revisited and either fixed, or other corrective action taken. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_Setting
Method ApplyToCollection Qualifiers Name Type Value From Class Description string The ApplyToCollection method performs the application of the Setting to the referenced Collection of ManagedSystem Elements. The net effect is to execute the ApplyToMSE method against each of the Elements aggregated by the Collection. If the input value ContinueOnError is FALSE, this method applies the Setting to all Elements in the Collection until it encounters an error, in which case it stops execution, logs the key of the Element that caused the error in the CanNotApply array, and issues a return code of 2. If the input value ContinueOnError is TRUE, then this method applies the Setting to all the ManagedSystemElements in the Collection, and reports the failed Elements in the array, CanNotApply. For the latter, processing will continue until the method is applied to all Elements in the Collection, regardless of any errors encountered. The key of each ManagedSystemElement to which the Setting could not be applied is logged into the CanNotApply array. This method takes four input parameters: Collection (the Collection of Elements to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), ContinueOnError (TRUE means to continue processing on encountering an error), and MustBeCompletedBy (which indicates the required completion time for the method). The return value should be 0 if the Setting is successfully applied to the referenced Collection, 1 if the method is not supported, 2 if the Setting was not applied within the specified times, 3 if the Setting cannot be applied using the input value for ContinueOnError, and any other number if an error occurred. One output parameter is defined, CanNotApplystring, which is an array that lists the keys of the ManagedSystemElements to which the Setting was NOT able to be applied. This output parameter has meaning only when the ContinueOnError parameter is TRUE. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. Note: if an error occurs in applying the Setting to a ManagedSystemElement in the Collection, the Element must be configured as when the ’ Apply ’ attempt began. That is, the Element should NOT be left in an indeterminate state. CIM_Setting
Method VerifyOKToApplyIncrementalChangeToMSE Qualifiers Name Type Value From Class Description string The VerifyOKToApplyIncrementalChangeToMSE method is used to verify that a subset of the properties in this Setting can be ’ applied ’ to the referenced Managed SystemElement, at the given time or time interval. This method takes four input parameters: MSE (the Managed SystemElement that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be verified.) If the array is null, empty or contains the string " ALL " as a property name, then all Settings properties shall be verified. If it is set to " NONE " , then no Settings properties will be verified. The return value should be 0 if it is OK to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_Setting
Method ApplyIncrementalChangeToMSE Qualifiers Name Type Value From Class Description string The ApplyIncrementalChangeToMSE method performs the actual application of a subset of the properties in the Setting to the referenced ManagedSystemElement. It takes four input parameters: MSE (the ManagedSystem Element to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be applied.) If a property is not in this list, it will be ignored by the Apply. If the array is null, empty or contains the string " ALL " as a property name, then all Settings properties shall be applied. If it is set to " NONE " , then no Settings properties will be applied. Note that the semantics of this method are that individual Settings are either wholly applied or not applied at all to their target ManagedSystemElement. The return value should be 0 if the Setting is successfully applied to the referenced ManagedSystemElement, 1 if the method is not supported, 2 if the Setting was not applied within the specified times, and any other number if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. Note: If an error occurs in applying the Setting to a ManagedSystemElement, the Element must be configured as when the ’ Apply ’ attempt began. That is, the Element should NOT be left in an indeterminate state. CIM_Setting
Method VerifyOKToApplyIncrementalChangeToCollection Qualifiers Name Type Value From Class Description string The VerifyOKToApplyIncrementalChangeToCollection method is used to verify that a subset of the properties in this Setting can be ’ applied ’ to the referenced Collection of ManagedSystemElements, at the given time or time interval, without causing adverse effects to either the Collection itself or its surrounding environment. The net effect is to execute the VerifyOKToApplyIncrementalChangeToMSE method against each of the Elements aggregated by the Collection. This method takes three input parameters: Collection (the Collection of Managed SystemElements that is being verified), TimeToApply (which, being a datetime, can be either a specific time or a time interval), MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be verified. If they array is null or empty or constains the string " all " as a property name then all Settings properties shall be verified. If it is set to " none " then no Settings properties will be verified). The return value should be 0 if it is OK to apply the Setting, 1 if the method is not supported, 2 if the Setting cannot be applied within the specified times, and any other number if an error occurred. One output parameter is defined - CanNotApply - which is a string array that lists the keys of the ManagedSystemElements to which the Setting can NOT be applied. This enables those Elements to be revisited and either fixed, or other corrective action taken. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_Setting
Method ApplyIncrementalChangeToCollection Qualifiers Name Type Value From Class Description string The ApplyIncrementalChangeToCollection method performs the application of a subset of the properties in this Setting to the referenced Collection of ManagedSystem Elements. The net effect is to execute the ApplyIncrementalChangeToMSE method against each of the Elements aggregated by the Collection. If the input value ContinueOnError is FALSE, this method applies the Setting to all Elements in the Collection until it encounters an error, in which case it stops execution, logs the key of the Element that caused the error in the CanNotApply array, and issues a return code of 2. If the input value ContinueOnError is TRUE, then this method applies the Setting to all the ManagedSystemElements in the Collection, and reports the failed Elements in the array, CanNotApply. For the latter, processing will continue until the method is applied to all Elements in the Collection, regardless of any errors encountered. The key of each ManagedSystemElement to which the Setting could not be applied is logged into the CanNotApply array. This method takes four input parameters: Collection (the Collection of Elements to which the Setting is being applied), TimeToApply (which, being a datetime, can be either a specific time or a time interval), ContinueOnError (TRUE means to continue processing on encountering an error), and MustBeCompletedBy (which indicates the required completion time for the method), and a PropertiesToApply array (which contains a list of the property names whose values will be applied.) If a property is not in this list, it will be ignored by the Apply. If the array is null or empty or contains the string " ALL " as a property name, then all Settings properties shall be applied. If it is set to " NONE " , then no Settings properties will be applied. The return value should be 0 if the Setting is successfully applied to the referenced Collection, 1 if the method is not supported, 2 if the Setting was not applied within the specified time, 3 if the Setting cannot be applied using the input value for ContinueOnError, and any other number if an error occurred. One output parameter is defined, CanNotApplystring, which is an array that lists the keys of the ManagedSystemElements to which the Setting was NOT able to be applied. This output parameter has meaning only when the ContinueOnError parameter is TRUE. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. Note: if an error occurs in applying the Setting to a ManagedSystemElement in the Collection, the Element must be configured as when the ’ Apply ’ attempt began. That is, the Element should NOT be left in an indeterminate state. CIM_Setting Parameters
Method VerifyOKToApplyToMSE Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionMustBeCompletedBy datetime IN
Description
Method ApplyToMSE Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionMustBeCompletedBy datetime IN
Description
Method VerifyOKToApplyToCollection Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionMustBeCompletedBy datetime IN
DescriptionCanNotApply string IN
OUT
Description
Method ApplyToCollection Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionContinueOnError boolean IN
DescriptionMustBeCompletedBy datetime IN
DescriptionCanNotApply string IN
OUT
Description
Method VerifyOKToApplyIncrementalChangeToMSE Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionMustBeCompletedBy datetime IN
DescriptionPropertiesToApply string IN
Description
Method ApplyIncrementalChangeToMSE Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionMustBeCompletedBy datetime IN
DescriptionPropertiesToApply string IN
Description
Method VerifyOKToApplyIncrementalChangeToCollection Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionMustBeCompletedBy datetime IN
DescriptionPropertiesToApply string IN
DescriptionCanNotApply string IN
OUT
Description
Method ApplyIncrementalChangeToCollection Parameters Name Type Qualifiers TimeToApply datetime IN
DescriptionContinueOnError boolean IN
DescriptionMustBeCompletedBy datetime IN
DescriptionPropertiesToApply string IN
DescriptionCanNotApply string IN
OUT
DescriptionParameter Qualifiers
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter CanNotApply Qualifiers Name Type Value From Class IN boolean false CIM_Setting OUT boolean true CIM_Setting Description string A string array that lists the keys of the ManagedSystemElements to which the Setting can NOT be applied. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter ContinueOnError Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TRUE means to continue processing on encountering an error. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter CanNotApply Qualifiers Name Type Value From Class IN boolean false CIM_Setting OUT boolean true CIM_Setting Description string A string array that lists the keys of the ManagedSystemElements to which the Setting was NOT be applied. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter PropertiesToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string A list of the property names whose values will be verified. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter PropertiesToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string A list of the property names whose values will be applied. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TimeToApply can be either a specific time or a time interval. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string The required completion time for the method. CIM_Setting
Parameter PropertiesToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string A list of the property names whose values will be verified. CIM_Setting
Parameter CanNotApply Qualifiers Name Type Value From Class IN boolean false CIM_Setting OUT boolean true CIM_Setting Description string A string array that lists the keys of the ManagedSystemElements to which the Setting can NOT be applied. CIM_Setting
Parameter TimeToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string A specific time or a time interval. CIM_Setting
Parameter ContinueOnError Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string TRUE means to continue processing on encountering an error. CIM_Setting
Parameter MustBeCompletedBy Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string This parameter indicates the required completion time for the method. CIM_Setting
Parameter PropertiesToApply Qualifiers Name Type Value From Class IN boolean true CIM_Setting Description string A list of the property names whose values will be verified. CIM_Setting
Parameter CanNotApply Qualifiers Name Type Value From Class IN boolean false CIM_Setting OUT boolean true CIM_Setting Description string A string array that lists the keys of the ManagedSystemElements to which the Setting can NOT be applied. CIM_Setting