AlertServiceClient::unshelveAlerts()
Unshelves previously shelved alert instances, restoring them to the active alert list before the automatic timer expires.
Synopsis
int AlertServiceClient::unshelveAlerts(dyn_atime alerts, string reason = "");
Parameters
| Parameter | Description |
|---|---|
| alerts | List of alert identifiers (datapoint element + alert time) to unshelve. |
| reason | Optional reason text for the unshelving action. Logged in the Security Event audit trail. |
Return value
Returns 0 on success, -1 on failure.
Errors
Missing or invalid arguments. Insufficient user permissions (bit 5 required). Alert not currently shelved.
Details
The function restores previously shelved alerts to the active alert list. The _add_value_5 attribute is cleared and _force_filtered is reset to its previous state.
Use this function to manually unshelve alerts before their automatic timer expires.
Assignment
AlertService functions
Availability
CTRL