Purpose

Format and send an event to the Event Server that clears an alert. Clearing an alert causes any pending external actions to be terminated, initiates any external actions associated with clearing the alert, and removes the alert from the Event Server.

Syntax

#using Spo.SPDlib
SPD_errorType SPDClearAlarm
(
   string objectClass,
   string objectName,
   string alarmIdentifier,
   string alarmQualifier,
   string clearText,
   string externalActionList,
   string application,
   string applicationQualifier,
   string timeValue
);

Description

This function formats and sends a clear alert event to the Event Server. Clearing an alert causes pending external actions to be terminated, clear external actions to be initiated, and the alert to be removed from the Event Server.

objectClass

identifies the type of object that is the source of the alert (for example, a system or application). objectClass must match the objectClass specified when the alert was raised.

objectName

identifies the instance of the object class that is the source of the alert (for example, a system or application name). objectName must match the objectName specified when the alert was raised.

alarmIdentifier

identifies the type of alert being cleared. alarmIdentifier must match the alarmIdentifier specified when the alert was raised.

alarmQualifier

further qualifies the type of alert when multiple instances of the alert are raised and must be kept distinct from one another. alarmQualifier must match the alarmQualifier specified when the alert was raised. This parameter is optional. Specify NULL if the alert is not further qualified.

clearText

is an optional string that explains why the alert is being cleared. Specify NULL if no text is supplied.

externalActionList

is the identifier of the external action list that is associated with clearing this alert. External action lists are defined in Operations Sentinel Console. If no external action list is associated with clearing this alert, specify NULL.

application

identifies the application that raised the alert. application must match the application specified when the alert was raised for the alert to be cleared. Specify NULL if the application is the same as the application that you specified on the call to SPDInitClient.

applicationQualifier

further qualifies the application in the case where more than one instance of the application may be present. Specify NULL if the application qualifier is the same as the application qualifier that you specified on the call to SPDInitClient or if the application does not need to be further qualified.

timeValue

is the time to be associated with the clearing of the alert. Specify NULL if no time is to be associated with clearing of the alert.

Return Value

The return value indicates whether an error occurred, as follows.

See Also

See also the following client functions: