HawkEventService:onClear
Method
Purpose
Reports all clears generated by TIBCO Hawk Agents across the network
Type
Open, Asynchronous, IMPACT_INFO
Arguments
Name |
Type |
Description |
Agent Name |
String |
TIBCO Hawk Agent name. The | symbol can be used to perform an OR operation. For example, abc | xyz | def, will evaluate to true if Agent Name equals either abc or xyz or def. |
Rulebase |
String |
The name of the rulebase. The | symbol can be used to perform an OR operation. For example, abc | xyz | def, will evaluate to true if Rulebase Name equals either abc or xyz or def. |
Returns
Name |
Type |
Description |
Hawk Domain |
String |
Value of the command line option "hawk_domain" |
Agent Name |
String |
TIBCO Hawk Agent's name that generated this event |
Agent Domain |
String |
TIBCO Hawk Agent's domain name (dns) |
Agent IP Address |
String |
TIBCO Hawk Agent's IP address |
Rulebase |
String |
The rulebase that generated this clear |
AlertID |
Long |
The numeric ID assigned to this clear by the TIBCO Hawk Agent |
Time |
String |
Time at which this alert was cleared |
Clear Reason |
String |
Reason for the clear |