AlertServiceClient::suppressAlerts()
Suppresses alert handler configurations on specified datapoint elements, preventing future alert generation.
Synopsis
int AlertServiceClient::suppressAlerts(dyn_string dpes, string reason = "");
Parameters
| Parameter | Description |
|---|---|
| dpes | List of datapoint element paths to suppress. |
| reason | Optional reason text for the suppression 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). Invalid datapoint element paths.
Details
The function suppresses the alert handler configuration (alertHandling attribute) on each specified datapoint element. Once suppressed, the alert handler does not generate new alerts. All pending unacknowledged alerts on the affected elements are automatically acknowledged.
Suppression remains active until explicitly removed via AlertServiceClient::unsuppressAlerts(). Unlike shelving, suppression operates at the configuration level and has no automatic timer.
Assignment
AlertService functions
Availability
CTRL