Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The environment variables passed to the alert script and their meanings are included in the following table but for the latest documentation please refer to the Alert profile and Action profile variables topics in the main UIM Help documentation.

VariableDescriptionExample Contents

Service Message Fields

These fields remain constant for each execution of your script associated with a single service outage.

UPTIME_ALERTTYPEType of alert message.One of: Problem, Recovery
UPTIME_HOSTNAMEName of the host associated with the service outage.oracle_server
UPTIME_HOSTSTATUSStatus of the host associated with the service outage.One of: OK, WARN, CRIT, MAINT, UNKNOWN
UPTIME_MESSAGEOutput selection of the alert.

Type: Problem

Service: db_status (CRIT/threshold error)

Host: orale_db (OK)

UPTIME_SUBJECTSubject line that normally appears in the email message for this alert.Uptime Alert: UPTIME-oracle_server -> CRIT
UPTIME_SVCNAMEName of the service monitor generating this alert.UPTIME-oracle_server
UPTIME_SVCOUTPUTOutput of the service monitor generating this alert.processoccurrences: 0 is less than 1
UPTIME_SVCSTATUSCurrent status of the service monitor generating this alert.One of: OK, WARN, CRIT, MAINT, UNKNOWN
UPTIME_DATETIMEDate and time of the alert.Mon May 15 11:12:22 CDT 2024

User-Related Fields

These fields change for each user passed to your script. The script is executed once for each user that you want notified.

UPTIME_CONTACTLOGINNAMELogin name of the notified user account.testuser
UPTIME_DESKTOPHOSTWindows desktop homename setting of the notified user account.testuser-pc
UPTIME_DESKTOPWORKGROUPWindows workgroup for the desktop host specified above.WORKGROUP
UPTIME_EMAILEmail address of the notified user account.testuser@yourcompany.com
UPTIME_MOBILEPager number of the notified user account.1234123@sms.mynetwork.com
General Fields
UPTIME_SCRIPTName of the script being executed.C:/Program Files/uptime software/uptime710/scripts/my_custom_alerter.bat
UPTIME_SMTPHELOSTRINGHELO string used in your SMTP server configuration.
UPTIME_SMTPPASSWORDPassword used from authentication in your SMTP server configuration.
UPTIME_SMTPPORTServer port used in your SMTP server configuration.
UPTIME_SMTPSENDERSender address string used in your SMTP server configuration.
UPTIME_SMTPSERVERServer hostname used in your SMTP server configuration.
UPTIME_SMTPUSERUser name used for authentication in your SMTP server configuration.

Environment variable examples

...