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

Class AMT_AgentPresenceWatchdog

Used in features: Agent Presence
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_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_LogicalDevice
               extended by CIM_Watchdog
                  extended by AMT_AgentPresenceWatchdog


class AMT_AgentPresenceWatchdog
 extends CIM_Watchdog


General Information:
Represents the monitoring state associated 
with a single 
agent.

Qualifiers:
-------------
Version=6.0.0









  
  

    Supported Fields 
      Summary

  

     uint32 
      
    TimerResolution 
      
Resolution of the timer . . .

  

     uint16 
      
    MonitoredEntity 
      
The entity that is currently being monitored by the WatchDog . 
      . .

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states of an element . . .

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    SystemCreationClassName Key  
The scoping System's 
      CreationClassName.

  

     string 
      
    SystemName Key  
The scoping System's Name.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     uint16 
      
    CurrentState 
      
Describes the current state of the monitored application . . 
      .

  

     uint16 
      
    StartupInterval 
      
A seconds timer value which specifies the maximum time allowed 
      for an application to start up and start sending application heartbeat 
      calls (i.e., the time after system restart or after adding a new agent 
      watchdog).

  

     string 
      
    MonitoredEntityDescription 
      
Description of the application monitored by this watchdog 
      instance.

  

     string 
      
    DeviceID Key  
A GUID which is the AgentID for the monitored 
      application encoded as Base64.

  

     uint32 
      
    TimeoutInterval 
      
The timeout interval used by the 
  watchdog.




  
  

    Methods Summary

  

     uint32
    RegisterAgent(SessionSequenceNumber, 
      TimeoutInterval) 
This method is issued by applications that 
      wish to start reporting their running state.

  

     uint32
    AssertPresence(SequenceNumber) 
      
This method is issued periodically by applications to report their 
      running state.

  

     uint32
    AssertShutdown(SequenceNumber) 
      
This method is issued by applications to report their termination 
      state.

  

     uint32
    AddAction(OldState, NewState, 
      EventOnTransition, ActionSd, ActionEac) 
This method adds an 
      action to the application watchdog.

  

     uint32
    DeleteAllActions() 
      
This method removes all actions associated with the watchdog.

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    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


TimerResolution 
public uint32 TimerResolution



  
General Information:
Resolution of the timer. For example, if 
  this value is 100, then the timer can expire anytime between (TimeoutInterval- 
  100) microseconds or (TimeoutInterval+100) 
  microseconds.

Qualifiers:
-------------
Units=MicroSeconds
PUnit=second 
  * 10^-6


  

  





MonitoredEntity 
public uint16 MonitoredEntity



  
General Information:
The entity that is currently being 
  monitored by the WatchDog. This property is used to identify the module that 
  is responsible for re-arming, or whose information is used to re-arm, the 
  watchdog at periodic 
  intervals.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8}
Values={Unknown, Other, Operating System, Operating System 
  Boot Process, Operating System Shutdown Process, Firmware Boot Process, BIOS 
  Boot Process, Application, Service Processor}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
EnabledState is an integer enumeration that 
  indicates the enabled and disabled states of an element. It can also indicate 
  the transitions between these requested states. For example, shutting down 
  (value=4) and starting (value=10) are transient states between enabled and 
  disabled. The following text briefly summarizes the various enabled and 
  disabled states: 
Enabled (2) indicates that the element is or could be 
  executing commands, will process any queued commands, and queues new requests. 
  
Disabled (3) indicates that the element will not execute commands and will 
  drop any new requests. 
Shutting Down (4) indicates that the element is in 
  the process of going to a Disabled state. 
Not Applicable (5) indicates the 
  element does not support being enabled or disabled. 
Enabled but Offline 
  (6) indicates that the element might be completing commands, and will drop any 
  new requests. 
Test (7) indicates that the element is in a test state. 
  
Deferred (8) indicates that the element might be completing commands, but 
  will queue any new requests. 
Quiesce (9) indicates that the element is 
  enabled but in a restricted mode.
Starting (10) indicates that the element 
  is in the process of going to an Enabled state. New requests are 
  queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, 
  Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In 
  Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  





ElementName 
public string ElementName



  
General Information:
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.

Product Specific Usage:
In Intel AMT Release 
  6.0 and later releases value is 'Intel(r) Agent Presence Policy 
  Timer'

Qualifiers:
-------------
MaxLen=40


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The scoping System's 
  CreationClassName.

Product Specific Usage:
In Intel AMT 
  Release 6.0 and later releases value is 
  'CIM_ComputerSystem'

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.CreationClassName


  

  





SystemName Key 
public string SystemName



  
General Information:
The scoping System's 
  Name.

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

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
CreationClassName indicates the name of the 
  class or the subclass used in the creation of an instance. When used with the 
  other key properties of this class, this property allows all instances of this 
  class and its subclasses to be uniquely identified.

Product Specific 
  Usage:
In Intel AMT Release 6.0 and later releases value is 
  'AMT_AgentPresenceWatchdog'

Qualifiers:
-------------
Key
MaxLen=30


  

  





CurrentState 
public uint16 CurrentState



  
General Information:
Describes the current state of the 
  monitored application. The possible states are: 1 - NotStarted, 2 - Stopped, 4 
  - Running, 8 - Expired, 16 - Suspended.

  

  





StartupInterval 
public uint16 StartupInterval



  
General Information:
A seconds timer value which specifies the 
  maximum time allowed for an application to start up and start sending 
  application heartbeat calls (i.e., the time after system restart or after 
  adding a new agent 
  watchdog).

Qualifiers:
-------------
Required
Units=Seconds


  

  





MonitoredEntityDescription 
public string MonitoredEntityDescription



  
General Information:
Description of the application monitored by 
  this watchdog 
  instance.

Qualifiers:
-------------
Override=MonitoredEntityDescription
MaxLen=16


  

  





DeviceID Key 
public string DeviceID



  
General Information:
A GUID which is the AgentID for the 
  monitored application encoded as Base64.

Product Specific 
  Usage:
DeviceID must be exactly 16 bytes 
  long.

Qualifiers:
-------------
Key
Override=DeviceID
MaxLen=16
EOBase64


  

  





TimeoutInterval 
public uint32 TimeoutInterval



  
General Information:
The timeout interval used by the 
  watchdog.

Qualifiers:
-------------
Required
Override=TimeoutInterval
Units=Seconds
MaxValue=65535


  

  






  
  

    Method 
Detail


RegisterAgent
public uint32 RegisterAgent([OUT]uint32 SessionSequenceNumber, [OUT]uint16 TimeoutInterval)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_LOCAL_REALM

General 
  Information:
This method is issued by applications that wish to start 
  reporting their running 
  state.

Qualifiers:
-------------
ValueMap={0, 
  1}
Values={PT_STATUS_SUCCESS, 
  PT_STATUS_INTERNAL_ERROR}


Parameters:
--------------

  

    
SessionSequenceNumber 
    
General Information:
A random sequence number returned by the 
    Intel(R) AMT device. This number should be incremented by one in subsequent 
    calls (when provided). After the counter reaches its highest possible value, 
    it is rolled to zero. The sequence number is used to enforce detection of 
    crashed applications which may have lost their handles. The sequence number 
    is not intended to provide any form of security for this 
    flow.

Qualifiers:
-------------
OUT


    
TimeoutInterval 
    
General Information:
A seconds timer value which specifies the 
    maximum time allowed between application heartbeat 
    calls.

Qualifiers:
-------------
OUT







AssertPresence
public uint32 AssertPresence([IN]uint32 SequenceNumber)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_LOCAL_REALM

General 
  Information:
This method is issued periodically by applications to 
  report their running 
  state.

Qualifiers:
-------------
ValueMap={0, 1, 
  36}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_INVALID_PARAMETER}


Parameters:
--------------

  

    
SequenceNumber 
    
General Information:
A random sequence number returned by the 
    Intel(R) AMT device when the agent last called RegisterAgent. This number 
    should be incremented by 
    one.

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







AssertShutdown
public uint32 AssertShutdown([IN]uint32 SequenceNumber)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_LOCAL_REALM

General 
  Information:
This method is issued by applications to report their 
  termination state.

Qualifiers:
-------------
ValueMap={0, 
  1, 36}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_INVALID_PARAMETER}


Parameters:
--------------

  

    
SequenceNumber 
    
General Information:
A random sequence number returned by the 
    Intel(R) AMT device on the former RegisterAgent call. If a call is made with 
    a bad sequence number, it will be ignored so that an invalid agent trying to 
    'scan' for the current sequence number receives a minimum amount of 
    information. After this call succeeds (in such a way that the command is not 
    ignored), the SequenceNumber is no longer valid and subsequent calls cannot 
    be issued until re-registering. This number should be incremented by 
    one.

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







AddAction
public uint32 AddAction([IN]uint16 OldState, [IN]uint16 NewState, [IN]boolean EventOnTransition, [IN]uint16 ActionSd, [IN]boolean ActionEac)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General 
  Information:
This method adds an action to the application 
  watchdog.

Product Specific Usage:
Calling this function 
  creates the appropriate instances of AMT_StateTranstionCondition, which 
  represents 
the agent state transition, and 
  AMT_AgentPresenceWatchdogAction, which represents the action that will be 
  
taken upon the transition. 

Additional Notes: 
1) Argument 
  'ActionEac' is expected only in Intel AMT Release 4.0 and later 
  releases.

Qualifiers:
-------------
ValueMap={0, 1, 23, 
  36, 38, 2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_MAX_LIMIT_REACHED, PT_STATUS_INVALID_PARAMETER, 
  PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED, 
  PT_STATUS_AUDIT_FAIL}


Parameters:
--------------

  

    
OldState 
    
General Information:
The last state of the application 
    watchdog. This state may be set to a value containing a logical OR of 
    watchdog states. The possible states are: 1 - NotStarted, 2 - Stopped, 4 - 
    Running, 8 - Expired, 16 - 
    Suspended.

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


    
NewState 
    
General Information:
The current state of the application 
    watchdog. This state may be set to a value containing a logical OR of 
    watchdog states. The possible states are: 1 - NotStarted, 2 - Stopped, 4 - 
    Running, 8 - Expired, 16 - 
    Suspended.

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


    
EventOnTransition 
    
General Information:
Specifies whether an Event should be 
    created in the Event Manager when the application watchdog transitions from 
    OldState to 
    NewState.

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


    
ActionSd 
    
General Information:
A System Defense Action which may be 
    applied, when the application watchdog transitions from OldState to 
    NewState. If the caller did not create any policy through 
    AMT_AgentPresenceInterfacePolicy (or ConsoleWatchdogSetCbPolicy() PTNI 
    operation), no policy will be activated, however if the caller created an 
    AMT_AgentPresenceInterfacePolicy to specify a policy at later time, the 
    policy may be activated immediatly according to the logical state which is 
    currently maintained by the Agent Presence feature. This action is 
    optional.

Qualifiers:
-------------
IN
ValueMap={0, 
    1}
Values={ActivatePolicy, DeactivatePolicy}


    
ActionEac 
    
General Information:
When this field is TRUE it enables two 
    actions: 1. Information about this agent is included in an Intel(R) AMT EAC 
    posture. This happens if at least one transition is defined as TRUE for this 
    agent. Posture information includes current state and state counters showing 
    how many times each state was entered. 2. When this specific state 
    transition occurs, an avent is generated to indicate that Intel(R) AMT 
    posture has 
    changed.

Qualifiers:
-------------
IN







DeleteAllActions
public uint32 DeleteAllActions()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General 
  Information:
This method removes all actions associated with the 
  watchdog.

Product Specific Usage:
Calling this function will 
  remove all instances of AMT_StateTransitionCondition and 
  
AMT_AgentPresenceWatchdogAction associated with this agent. 
  

PT_STATUS_AUDIT_FAIL return status can be expected in AMT 5.1 and 
  above.

Qualifiers:
-------------
ValueMap={0, 1, 
  2075}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_AUDIT_FAIL}






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



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General 
  Information:
Creates a new instance of this class

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

SystemCreationClassName 
  
SystemName 
CreationClassName 
StartupInterval 
DeviceID 
  
TimeoutInterval 






Get
public  Get([OUT]AMT_AgentPresenceWatchdog Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General 
  Information:
Deletes an instance

Product Specific 
  Usage:
Removes the watchdog instance and also all 
  AMT_StateTransitionCondition and AMT_AgentPresenceWatchdogAction instances 
  associated with this watchdog.





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.