Purpose

Format and send an acknowledgement alert event to the Event Server. Acknowledging an alert causes any pending external actions for the alert to be terminated, and initiates any external actions associated with alert acknowledgement.

Syntax

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

Description

This function formats and sends an acknowledgement alert event to the Event Server. Acknowledging an alert causes pending external actions to be terminated.

objectClass

identifies the object that is the source of the alert (for example, a system or application).

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 acknowledged. 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.

acknowledgeText

is an optional explanation of why the alert is being acknowledged. Specify NULL if no text is supplied.

externalActionList

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

application

identifies the application that raised the alert. The value must match the application name that was specified when the alert was raised. Specify NULL if the application is the same as the application that was 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 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 acknowledging of the alert. Specify NULL if no time is to be associated with the alert acknowledgement.

Return Value

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

See Also

See also the following functions: