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

Class AMT_PETFilterSetting

Used in features: Event Manager & User Notification
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_SettingData
      extended by AMT_PETFilterSetting


class AMT_PETFilterSetting
 extends CIM_SettingData


General Information:
This class represents a PET filter in the 
Intel(R) AMT 
system.

Qualifiers:
-------------
Version=3.0.0









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user-friendly name for this instance of SettingData . . .

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .

  

     boolean 
      
    EnableFilter 
      
Specifies whether this filter is currently being applied to 
      platform events.

  

     boolean 
      
    OEMFilter 
Specifies 
      whether this fitler is a manufacturer pre-configured filter (The filter 
      entry has been configured by the system integrator and cannot be altered 
      by software - updated, enabled, disabled or removed).

  

     boolean 
      
    LogOnEvent 
Specifies 
      whether the system should log events that match the criteria established 
      via this filter

  

     uint8 
      
    DeviceAddress 
The 
      SMBus address of the physical sensor device that implements the logical 
      sensor.

  

     uint8 
      
    EventSensorType 
      
The value of the alert's Event Sensor Type field (see PET 
      specification for definitions.)

  

     uint8 
      
    EventType 
The value 
      of the alert's Event Type field (see PET specification for 
      definitions.)

  

     uint8 
      
    EventOffset 
The 
      value of the alert's Event Offset field (see PET specification for 
      definitions.)

  

     uint8 
      
    EventSourceType 
      
The value of the alert's Event Source Type field (see PET 
      specification for definitions.)

  

     uint8 
      
    EventSeverity 
The 
      value of the alert's Event Severity field . . .

  

     uint8 
      
    SensorNumber 
The 
      value of the alert's Sensor Number field (see PET specification for 
      definitions.)

  

     uint8 
      
    Entity 
The value to be 
      set into the alert's Entity field (see PET specification for 
      definitions.)

  

     uint8 
      
    EntityInstance 
      
The value to be set into the alert's Entity Instance field (see 
      PET specification for definitions.)

  

     uint8 
      
    PolicyID 
Associates a 
      filter to its Subscription.

  

     boolean 
      
    SendAlert 
Indicates 
      whether the service should send an event 
alert.




  
  

    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




  
  

    Field 
Detail


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

Product Specific Usage:
In Intel AMT 
  Release 6.0 and later releases value is "Intel(r) AMT PET 
  Filter"

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


  

  





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.

Product Specific Usage:
In 
  Intel AMT Release 6.0 and later releases value is "Intel(r) AMT PET Filter %d" 
  where %d is the filter 
  number

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=256


  

  





EnableFilter 
public boolean EnableFilter



  
General Information:
Specifies whether this filter is currently 
  being applied to platform 
  events.

Qualifiers:
-------------
Required


  

  





OEMFilter 
public boolean OEMFilter



  
General Information:
Specifies whether this fitler is a 
  manufacturer pre-configured filter (The filter entry has been configured by 
  the system integrator and cannot be altered by software - updated, enabled, 
  disabled or 
  removed).

Qualifiers:
-------------
Required


  

  





LogOnEvent 
public boolean LogOnEvent



  
General Information:
Specifies whether the system should log 
  events that match the criteria established via this 
  filter

Qualifiers:
-------------
Required


  

  





DeviceAddress 
public uint8 DeviceAddress



  
General Information:
The SMBus address of the physical sensor 
  device that implements the logical 
  sensor.

Qualifiers:
-------------
Required


  

  





EventSensorType 
public uint8 EventSensorType



  
General Information:
The value of the alert's Event Sensor Type 
  field (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





EventType 
public uint8 EventType



  
General Information:
The value of the alert's Event Type field 
  (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





EventOffset 
public uint8 EventOffset



  
General Information:
The value of the alert's Event Offset field 
  (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





EventSourceType 
public uint8 EventSourceType



  
General Information:
The value of the alert's Event Source Type 
  field (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





EventSeverity 
public uint8 EventSeverity



  
General Information:
The value of the alert's Event Severity 
  field. The severity values are based on the 'DMI' severity values used for the 
  generic sensor event/reading type 
  code.

Qualifiers:
-------------
Required


  

  





SensorNumber 
public uint8 SensorNumber



  
General Information:
The value of the alert's Sensor Number 
  field (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





Entity 
public uint8 Entity



  
General Information:
The value to be set into the alert's Entity 
  field (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





EntityInstance 
public uint8 EntityInstance



  
General Information:
The value to be set into the alert's Entity 
  Instance field (see PET specification for 
  definitions.)

Qualifiers:
-------------
Required


  

  





PolicyID 
public uint8 PolicyID



  
General Information:
Associates a filter to its 
  Subscription.

Qualifiers:
-------------
Required


  

  





SendAlert 
public boolean SendAlert



  
General Information:
Indicates whether the service should send 
  an event alert.

Qualifiers:
-------------
Required


  

  






  
  

    Method 
Detail


Create
public  Create([IN]AMT_PETFilterSetting Instance, [OUT] REF AMT_PETFilterSetting ResourceCreated)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM

General 
  Information:
Creates a new instance of this class

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

ElementName 
InstanceID 
  
EnableFilter 
OEMFilter 
LogOnEvent 
DeviceAddress 
  
EventSensorType 
EventType 
EventOffset 
EventSourceType 
  
EventSeverity 
SensorNumber 
Entity 
EntityInstance 
PolicyID 
  
SendAlert 






Put
public  Put([IN]AMT_PETFilterSetting Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM

General 
  Information:
Changes properties of the selected 
  instance

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

ElementName 
InstanceID 
EnableFilter 
OEMFilter 
  
LogOnEvent 
DeviceAddress 
EventSensorType 
EventType 
  
EventOffset 
EventSourceType 
EventSeverity 
SensorNumber 
  
Entity 
EntityInstance 
PolicyID 
SendAlert 






Get
public  Get([OUT]AMT_PETFilterSetting Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM

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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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