CIM_Setting, ROOT\Microsoft\IPAM

Class | Childs (1) | Methods (8) | Properties (5) | Qualifiers (5) | Instances | Namespaces (10)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The Setting class represents configuration-related and operational parameters for one or more ManagedSystemElements. An Element can have multiple Setting objects associated with it. The current operational values for the parameters of an 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 present in the Setting object. For example, a modem might have a Setting 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. Setting instances can be aggregated together into higher-level Setting objects using ConcreteComponent associations.

CIM_Setting - child subclasses in ROOT\Microsoft\IPAM

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_IPAM_ServerConfiguration0109----

CIM_Setting methods

CIM_Setting has 8 methods (8 Local)

NameOriginReturn
ApplyIncrementalChangeToCollectionCIM_Settinguint32 {'out':True}
ApplyIncrementalChangeToMSECIM_Settinguint32 {'out':True}
ApplyToCollectionCIM_Settinguint32 {'out':True}
ApplyToMSECIM_Settinguint32 {'out':True}
VerifyOKToApplyIncrementalChangeToCollectionCIM_Settinguint32 {'out':True}
VerifyOKToApplyIncrementalChangeToMSECIM_Settinguint32 {'out':True}
VerifyOKToApplyToCollectionCIM_Settinguint32 {'out':True}
VerifyOKToApplyToMSECIM_Settinguint32 {'out':True}

CIM_Setting properties

CIM_Setting has 5 properties (1 Local, 4 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
InstanceIDCIM_ManagedElement8 [string]
SettingIDCIM_Setting8 [string]

Detailed description of CIM_Setting methods

Local methods (8) of CIM_Setting class

ApplyIncrementalChangeToCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Collectionref:CIM_CollectionOfMSEs0-{'Description':'The Collection of Elements to which the Setting is being applied.','In':True}
TimeToApplydatetime1-{'Description':'A specific time or a time interval.','In':True}
ContinueOnErrorboolean2-{'Description':'True indicates to continue processing when an error is encountered.','In':True}
MustBeCompletedBydatetime3-{'Description':'This parameter indicates the required completion time for the method.','In':True}
PropertiesToApplystring4-{'Description':'A list of the property names whose values will be verified.','In':True}
CanNotApplystring5-{'Description':'A string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied.','Out':True}
Description'The ApplyIncrementalChangeToCollection method performs the application of a subset of the properties in this Setting to the referenced Collection of ManagedSystemElements. The net effect is to execute the ApplyIncrementalChangeToMSE method against each of the Elements that are 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 of 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 indicates to continue processing when an error is encountered), 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 will 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, CanNotApplystring, is defined, which is an array that lists the keys of the ManagedSystemElements to which the Setting could not 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" can also be specified in the subclass as a Values array qualifier.
Note: If an error occurs when applying the Setting to a ManagedSystemElement in the Collection, the Element must be configured as it was when the "Apply" attempt began. That is, the Element should not be left in an indeterminate state.'
ApplyIncrementalChangeToCollection method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
ApplyIncrementalChangeToMSE method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
MSEref:CIM_ManagedSystemElement0-{'Description':'The ManagedSystemElement to which the Setting is being applied.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
MustBeCompletedBydatetime2-{'Description':'The required completion time for the method.','In':True}
PropertiesToApplystring3-{'Description':'A list of the property names whose values will be applied.','In':True}
Description'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 will 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" can also be specified in the subclass as a Values array qualifier.
Note: If an error occurs when applying the Setting to a ManagedSystemElement, the Element must be configured as it was when the "Apply" attempt began. That is, the Element should not be left in an indeterminate state.'
ApplyIncrementalChangeToMSE method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
ApplyToCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Collectionref:CIM_CollectionOfMSEs0-{'Description':'The Collection of ManagedSystemElements to be applied.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
ContinueOnErrorboolean2-{'Description':'True means to continue processing when an error is encountered.','In':True}
MustBeCompletedBydatetime3-{'Description':'The required completion time for the method.','In':True}
CanNotApplystring4-{'Description':'A string array that lists the keys of the ManagedSystemElements to which the Setting could not be applied.','Out':True}
Description'The ApplyToCollection method performs the application of the Setting to the referenced Collection of ManagedSystemElements. The net effect is to execute the ApplyToMSE method against each of the Elements that are 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 the case of an error, the method 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 of 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 indicates to continue processing when an error is encountered), 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, CanNotApplystring, is defined, which is an array that lists the keys of the ManagedSystemElements to which the Setting could not 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" can also be specified in the subclass as a Values array qualifier.
Note: If an error occurs when applying the Setting to a ManagedSystemElement in the Collection, the Element must be configured as it was when the "Apply" attempt began. That is, the Element should not be left in an indeterminate state.'
ApplyToCollection method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
ApplyToMSE method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
MSEref:CIM_ManagedSystemElement0-{'Description':'The ManagedSystemElement to which the Setting is being applied.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
MustBeCompletedBydatetime2-{'Description':'The required completion time for the method.','In':True}
Description'The ApplyToMSE method performs the actual application of the Setting to the referenced ManagedSystemElement. It takes three input parameters: MSE (the ManagedSystemElement 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" can also be specified in the subclass as a Values array qualifier.
Note: If an error occurs when applying the Setting to a ManagedSystemElement, the Element must be configured as it was when the "Apply" attempt began. That is, the Element should not be left in an indeterminate state.'
ApplyToMSE method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
VerifyOKToApplyIncrementalChangeToCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Collectionref:CIM_CollectionOfMSEs0-{'Description':'The Collection of ManagedSystemElements for which the setting is being verified.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
MustBeCompletedBydatetime2-{'Description':'The required completion time for the method.','In':True}
PropertiesToApplystring3-{'Description':'A list of the property names whose values will be verified.','In':True}
CanNotApplystring4-{'Description':'A string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied.','Out':True}
Description'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 that are aggregated by the Collection. This method takes four input parameters: Collection (the Collection of ManagedSystemElements 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 or empty or contains the string "all" as a property name, all Settings properties will be verified. If it is set to "none" then no Settings properties will be verified. The return value should be 0 if it is okay 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, CanNotApply, is defined, which is a string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. This parameter enables those Elements to be revisited and either fixed or have other corrective action taken on them.
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" can also be specified in the subclass as a Values array qualifier.'
VerifyOKToApplyIncrementalChangeToCollection method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
VerifyOKToApplyIncrementalChangeToMSE method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
MSEref:CIM_ManagedSystemElement0-{'Description':'The ManagedSystemElement for which the Setting is being verified.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
MustBeCompletedBydatetime2-{'Description':'The required completion time for the method.','In':True}
PropertiesToApplystring3-{'Description':'A list of the property names whose values will be verified.','In':True}
Description'The VerifyOKToApplyIncrementalChangeToMSE method is used to verify that a subset of the properties in this Setting can be applied to the referenced ManagedSystemElement at the given time or time interval. This method takes four input parameters: MSE (the ManagedSystemElement 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 or empty or contains the string "ALL" as a property name, then all Settings properties will be verified. If it is set to "NONE", then no Settings properties will be verified. The return value should be 0 if it is okay 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" can also be specified in the subclass as a Values array qualifier.'
VerifyOKToApplyIncrementalChangeToMSE method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
VerifyOKToApplyToCollection method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Collectionref:CIM_CollectionOfMSEs0-{'Description':'The Collection of ManagedSystemElements that is being verified.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
MustBeCompletedBydatetime2-{'Description':'The required completion time for the method.','In':True}
CanNotApplystring3-{'Description':'A string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied.','Out':True}
Description'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 that are aggregated by the Collection. This method takes three input parameters: Collection (the Collection of ManagedSystemElements 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 okay 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, CanNotApply, is defined, which is a string array that lists the keys of the ManagedSystemElements to which the Setting cannot be applied. This parameter enables those Elements to be revisited and either fixed or have other corrective action taken on them.
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" can also be specified in the subclass as a Values array qualifier.'
VerifyOKToApplyToCollection method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces
VerifyOKToApplyToMSE method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
MSEref:CIM_ManagedSystemElement0-{'Description':'The ManagedSystemElement that is being verified.','In':True}
TimeToApplydatetime1-{'Description':'TimeToApply can be either a specific time or a time interval.','In':True}
MustBeCompletedBydatetime2-{'Description':'The required completion time for the method.','In':True}
Description'The VerifyOKToApplyToMSE method is used to verify that this Setting can be applied to the referenced ManagedSystemElement 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 okay 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" can also be specified in the subclass as a Values array qualifier.'
VerifyOKToApplyToMSE method is in 2 classes of ROOT\Microsoft\IPAM and in 2 namespaces

Detailed description of CIM_Setting properties

Local properties (1) of CIM_Setting class

SettingID property
CIMTYPE'string'
Description'The identifier by which the Setting object is known.'
MaxLen256
SettingID property is in 2 classes of ROOT\Microsoft\IPAM and in 10 namespaces

Derived properties (4) of CIM_Setting class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
MaxLen64
Caption property is in 45 classes of ROOT\Microsoft\IPAM and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 46 classes of ROOT\Microsoft\IPAM and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces
InstanceID property
CIMTYPE'string'
Description'InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
:
Where and are separated by a colon (:), and where 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 _ structure of Schema class names.) In addition, to ensure uniqueness, must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and 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.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.'
InstanceID property is in 45 classes of ROOT\Microsoft\IPAM and in 21 namespaces

CIM_Setting Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'The Setting class represents configuration-related and operational parameters for one or more ManagedSystemElements. An Element can have multiple Setting objects associated with it. The current operational values for the parameters of an 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 present in the Setting object. For example, a modem might have a Setting 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. Setting instances can be aggregated together into higher-level Setting objects using ConcreteComponent associations.'
locale'MS_409'
UMLPackagePath'CIM::Core::Settings'
Version'2.8.1000'

CIM_Setting System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\IPAM:CIM_Setting'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\IPAM'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT5___SYSTEM3
__RELPATH'CIM_Setting'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ManagedElement'___SYSTEM8
__CLASS'CIM_Setting'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_Setting

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ScopedSettingData140---
CIM_SettingData140---
comments powered by Disqus
WUtils.com