Class CIM_SettingData


CIM_ManagedElement
   extended by CIM_SettingData

Known Subclasses:
AMT_EthernetPortSettings


Abstract class CIM_SettingData
extends CIM_ManagedElement

General Information:
The SettingData class represents configuration-related and operational parameters for one or more ManagedElement(s). A ManagedElement may have multiple SettingData 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 SettingData object. For example, a modem may have a SettingData 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. SettingData instances may be aggregated together into higher level SettingData objects using ConcreteComponent associations.

Qualifiers:
-------------
Abstract
Version=2.8.1000


Supported Fields Summary
 string Description
The Description property provides a textual description of the object.
 string Caption
The Caption property is a short textual description (one- line string) of the object.
 string InstanceID Key
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class . . .
 string ElementName
The user friendly name for this instance of SettingData . . .

Methods Summary
  Create(Instance, ResourceCreated)
Creates a new instance of this class
  Put(Instance)
Changes properties of the selected instance
  Get(Instance)
Gets the representation of the instance
  Delete()
Deletes an instance
  Pull(EnumerationContext, MaxElements)
Pulls instances of this class, following an Enumerate operation
  Enumerate()
Enumerates the instances of this class
  Release(EnumerationContext)
Releases an enumeration context
  Subscribe()
Subscribes to this resource (WS-Eventing)
  Unsubscribe()
Remove subscription to this resource (WS-Eventing)

Field Detail

Description

public string Description
General Information:
The Description property provides a textual description of the object.

Qualifiers:
-------------
MaxLen=256


Caption

public string Caption
General Information:
The Caption property is a short textual description (one- line string) of the object.

Qualifiers:
-------------
MaxLen=64


InstanceID Key

public string InstanceID
General Information:
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.

Qualifiers:
-------------
Key
MaxLen=256


ElementName

public string ElementName
General Information:
The user friendly name for this instance of SettingData. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=256


Method Detail

Create

public  Create([IN]CIM_SettingData Instance, [OUT] REF CIM_SettingData ResourceCreated)
Permission Information:
No permissions defined

General Information:
Creates a new instance of this class

Put

public  Put([IN]CIM_SettingData Instance)
Permission Information:
No permissions defined

General Information:
Changes properties of the selected instance

Get

public  Get([OUT]CIM_SettingData Instance)
Permission Information:
No permissions defined

General Information:
Gets the representation of the instance

Delete

public  Delete()
Permission Information:
No permissions defined

General Information:
Deletes an instance

Pull

public  Pull([IN]String EnumerationContext, [IN]String MaxElements)
Permission Information:
All users permitted to use method, only instances to whom the user has permissions will be returned

General Information:
Pulls instances of this class, following an Enumerate operation

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

Release

public  Release([IN]String EnumerationContext)
Permission Information:
All users permitted to use method

General Information:
Releases an enumeration context

Subscribe

public  Subscribe()
Permission Information:
No permissions defined

General Information:
Subscribes to this resource (WS-Eventing)

Unsubscribe

public  Unsubscribe()
Permission Information:
No permissions defined

General Information:
Remove subscription to this resource (WS-Eventing)