Send Alert (QALSNDA) API
Required Parameter Group:
| 1 | Alert major vector | Input | Char(*) |
| 2 | Length of alert major vector | Input | Binary(4) |
| 3 | Local or received indicator | Input | Char(1) |
| 4 | Origin | Input | Char(10) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Send Alert (QALSNDA) API, an alert API, sends an alert to the IBM® i alert manager for processing. The alert is created by calling the Generate Alert (QALGENA) API. An alert may be received by your application from another system or it can be built by other means.
When the IBM i alert manager receives the alert, it handles it like any other alert on the system. The alert function is notified of the alert, and the alert can be logged and forwarded to a focal point or central site. The alert can be treated as either a locally generated alert or a received alert. The IBM i alert manager updates the hierarchical information of received alerts with the name of the control point that is handling the alert (that is, the LCLCPNAME network attribute value).
Authorities and Locks
None.
Required Parameter Group
- Alert major vector
- INPUT; CHAR(*)
The variable that contains the alert major vector.
- Length of alert major vector
- INPUT; BINARY(4)
The length of the alert, in bytes.
Valid values are 1 through 512.
- Local or received indicator
- INPUT; CHAR(1)
One of these values, indicating whether the alert is handled as locally generated or received:
L Locally generated alert. This alert is listed in the output from the Work with Alerts (WRKALR) command using the display option (DSPOPT) parameter with the *LOCAL special value. The alert hierarchy is not changed to add the current system's name. R Received alert. This alert is listed in the output from the Work with Alerts (WRKALR) command using the display options (DSPOPT) parameter with the *RCV special value. The system name is added to the processing node list. The current system's name, stored in the LCLCPNAME network attribute, is added to the alert hierarchy.
- Origin
- INPUT; CHAR(10)
The origin of the alert. This value is not included in the alert. It is used only in the substitution text for messages CPI7B62 (Alert received from &1) and CPI7B60 (Incorrect alert received from &1), which are sent to the QSYSOPR message queue. Thus, you could use it for the name of the program generating a locally generated alert, or the name of the system sending a received alert.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF7B07 E | Alert exceeds maximum size allowed. |
| CPF7B08 E | Alert is not valid. |
| CPF7B09 E | Value specified for parameter &1 not valid. |
| CPF7B10 E | Length parameter &1 is not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R1
[ Back to top | Network Management APIs | APIs by category ]