Detailed Description

The Agent Presence HLAPI feature contains two interfaces – one interface provides API functions performed from the remote computer (Console Management), and the second interface provides an API invoked by local agents from the local host on the Intel AMT-supported platform.

The following steps summarize how to use the Agent Presence feature working with both interfaces:

The management console connects to Intel AMT over the network and creates an agent by invoking AgentPresence.Remote.CreateOrUpdateAgent (Agent agent). Creating an Agent informs Intel AMT that there may be an agent application running on the local host that will identify itself with the Agent parameter.

1.  Create Agent causes Intel AMT to provide a watchdog that waits for the local application to register itself using the local interface method AgentPresence.Local.StartPresence .

2.  When the application registers itself, it also starts sending heartbeat messages to inform Intel AMT that the application is still alive.

3.  If the application stops sending heartbeats the watchdog will time out and the agent state moves to “expired”. This can happen when the agent cancels its registration (AgentPresence.Local.ShutdownPresence (string applicationName)) or if the application fails unexpectedly.

4.  The application can create a situation that causes the agent to behave as if it failed by invoking AgentPresence.Local.ExpirePresence (string applicationName).

5.  When the Console Management decides that it no longer supports this agent, it can invoke AgentPresence.Remote.DeleteAgent (string applicationName) .

6.  Beginning in version 11.0, an agent watchdog can set an expiration action  to be triggered when the agent enters the expired state. This action will take place after a user-defined interval.

For more details, see AgentPresenceRemoteSample, AgentPresenceLocalSample1 (demonstrates an agent that registers and then sends heartbeats) and AgentPresenceLocalSample2 (demonstrates an agent that registers and then times out).

The thread sending the heartbeats is in an endless loop started by invoking AgentPresence.Local.StartPresence. This thread is blocked to other actions. Invoke either AgentPresence.Local.ShutdownPresence or AgentPresence.Local.ExpirePresence functions in another thread to stop generating heartbeats.

 Note:

•   All AgentPresence.Local functions must be performed on the local host communicating with the local Intel AMT instance, otherwise the function will throw a ManageabilityException.

•   Only one application running on the local host can register as a particular agent. If an additional agent attempts to register as the same agent, Intel AMT will throw a ManageabilityException.

•   AgentPresence.Local.StartPresence function causes the agent application to send heartbeats according to the Agent.TimeoutInterval defined when invoking AgentPresence.Remote.CreateOrUpdateAgent . The application will send heartbeats slightly faster than the defined interval to avoid problems that might arise from propagation delays.

 

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