 | ||
| About the monitor entry point | ||
|---|---|---|
| Prev | Agent entry point overview | Next |
The monitor entry point typically contains the logic to determine the status of a resource. For example, the monitor entry point of the IP agent checks whether or not an IP address is configured, and returns the state online, offline, or unknown.
Note This entry point is mandatory.
The agent framework calls the monitor entry point after completing the online and offline entry points to determine if bringing the resource online or taking it offline was effective. The agent framework also calls this entry point periodically to detect if the resource was brought online or taken offline unexpectedly.
By default, the monitor entry point runs every sixty seconds (the default value of the MonitorInterval attribute) when a resource is online.
When a resource is expected to be offline, the entry point runs every 300 seconds (the default value for the OfflineMonitorInterval attribute).
The monitor entry point receives a resource name and ArgList attribute values as input (see ArgList reference attributes).
It returns the resource status (online, offline, or unknown), and the confidence level 0-100. The entry point returns confidence level only when the resource status is online. The confidence level is informative only and is not used by the engine. It can be referenced by examining the value of ConfidenceLevel attribute.
A C++ entry point can return a confidence level of 0-100. A script entry point combines the status and the confidence level in a single number.
See Return values for entry points