SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_SettingData

CIM_ManagedElement
   extended by CIM_SettingData
Known Subclasses:
AMT_8021XProfile AMT_CRL AMT_EnvironmentDetectionSettingData IPS_IPv6PortSettings CIM_IEEE8021xSettings IPS_IEEE8021xSettings CIM_BootSourceSetting IPS_HostIPSettings IPS_ScreenSettingData AMT_GeneralSettings IPS_KVMRedirectionSettingData AMT_TLSSettingData CIM_WiFiEndpointSettings CIM_BootConfigSetting AMT_KerberosSettingData AMT_SystemPowerScheme AMT_EthernetPortSettings CIM_BootSettingData AMT_BootSettingData AMT_PETFilterSetting 
Abstract class CIM_SettingData
 extends CIM_ManagedElement


General Information:
CIM_SettingData is used to represent 
configuration and and operational parameters for CIM_ManagedElement instances. 
There are a number of different uses of CIM_SettingData supported in the model 
today. Additional uses may be defined in the future.
Instances of 
CIM_SettingData may represent Aspects of a CIM_ManagedElement instance. This is 
modeled using the CIM_SettingsDefineState association. CIM_SettingData may be 
used to define capabilities when associated to an instance of CIM_Capabilities 
through the CIM_SettingsDefineCapabilities association. 
Instances of 
CIM_SettingData may represent different types of configurations for a 
CIM_ManagedElement, including persistent configurations, in progress 
configuration changes, or requested configurations. The CIM_ElementSettingData 
association is used to model the relationship between a CIM_SettingData instance 
and the CIM_ManagedElement for which it is a configuration. 
When an instance 
of CIM_SettingData represents a configuration, the current operational values 
for the parameters of the 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 that are present in the SettingData object. For example, a modem 
might have a SettingData 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. SettingData instances can be aggregated together into higher- level 
SettingData objects using ConcreteComponent 
associations.

Qualifiers:
-------------
Abstract
Version=2.19.0
UMLPackagePath=CIM::Core::Settings









  
  

    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. 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.

Qualifiers:
-------------
Key
Override=InstanceID
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 an index 
  property for a search or query. (Note: The 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

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_SettingData: 

InstanceID 
ElementName 
  






Put
public  Put([IN]CIM_SettingData Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_SettingData: 

InstanceID 
  
ElementName 






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)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.