Passing Corrective Action Execution Status to an OS Command or Script
The notification system passes information to an OS script or executable via system environment variables. Conventions used to access environmental variables vary depending on the operating system:
-
UNIX: $ENV_VARIABLE
-
MS Windows: %ENV_VARIABLE%
The notification system sets the following environment variables before calling the script. The notification system will set the environment variable $NOTIF_TYPE = NOTIF_CA for Corrective Action Execution. The script can then use any or all of these variables within the logic of the script.
Following table lists the environment variables for corrective action, they are populated when a corrective action is completed for an event.
Table 6-13 Corrective Action Environment Variables
| Environment Variable | Description |
|---|---|
|
CA_JOB_STATUS |
Corrective action job execution status. |
|
CA_JOB_NAME |
Name of the corrective action. |
|
CA_JOB_OWNER |
Owner of corrective action. |
|
CA_JOB_STEP_OUTPUT |
The value will be the text output from the corrective action execution. |
|
CA_JOB_TYPE |
Corrective action job type |