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

Class AMT_PETCapabilities

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_Capabilities
      extended by AMT_PETCapabilities


class AMT_PETCapabilities
 extends CIM_Capabilities


General Information:
describes the attributes associated with a 
single logical sensor which can cause to event alerting. The logical model 
classifies sensors according to type regardless of the physical devices that 
implement them. Thus, a single physical sensor device can implement logical 
sensors of different types, such as temperature and voltage 
sensors.

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









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user friendly name for this instance of Capabilities . . .

  

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

  

     boolean 
      
    IsLegacySensor 
      
The value in this field is TRUE if this is a legacy sensor 
      described in the ACPI 'ASF!' table or FALSE if this is an ASF sensor . . 
      .

  

     uint8 
      
    Index 
If this is a legacy 
      sensor, then this field contains the 0-based index of the ASF_ALERTDATA 
      structure in the Device Array of the ASF_ALRT structure in the ACPI 'ASF!' 
      structure . . .

  

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

  

     boolean 
      
    AssertionEvent 
      
True if the assertion event is sent internally to the event 
      handler . . .

  

     boolean 
      
    DeassertionEvent 
      
True if the de-assertion event is sent internally to the event 
      handler . . .

  

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




  
  

    Methods Summary

  

     
    Get(Instance) 
Gets the 
      representation of the 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 
  Capabilities. 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.)

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

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


  

  





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

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

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


  

  





IsLegacySensor 
public boolean IsLegacySensor



  
General Information:
The value in this field is TRUE if this is 
  a legacy sensor described in the ACPI 'ASF!' table or FALSE if this is an ASF 
  sensor. The value in this field is used in determining how to poll the status 
  of the device on the SMBus.Supported for backwards compatibility.

  

  





Index 
public uint8 Index



  
General Information:
If this is a legacy sensor, then this field 
  contains the 0-based index of the ASF_ALERTDATA structure in the Device Array 
  of the ASF_ALRT structure in the ACPI 'ASF!' structure. If this is an ASF 
  sensor, then this field contains the value of the Event Status Index required 
  for a Get Event Status cycle on the SMBus. The value in this field is used in 
  determining how to poll the status of the device on the SMBus. Supported for 
  backwards compatibility.

  

  





DeviceAddress 
public uint8 DeviceAddress



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

  

  





AssertionEvent 
public boolean AssertionEvent



  
General Information:
True if the assertion event is sent 
  internally to the event handler. The event handler manages policies regarding 
  whether the resulting event is sent in a PET frame and/or logged in the NV 
  event log.

  

  





DeassertionEvent 
public boolean DeassertionEvent



  
General Information:
True if the de-assertion event is sent 
  internally to the event handler. The event handler manages policies regarding 
  whether the resulting event is sent in a PET frame and/or logged in the NV 
  event log

  

  





EventSensorType 
public uint8 EventSensorType



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

  

  





EventType 
public uint8 EventType



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

  

  





EventOffset 
public uint8 EventOffset



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

  

  





EventSourceType 
public uint8 EventSourceType



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

  

  





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.

  

  





SensorNumber 
public uint8 SensorNumber



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

  

  





Entity 
public uint8 Entity



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

  

  





EntityInstance 
public uint8 EntityInstance



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

  

  






  
  

    Method 
Detail


Get
public  Get([OUT]AMT_PETCapabilities Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_EVENT_MANAGER_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the 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.