Child pages
  • Alert Profile and Action Profile Variables
Skip to end of metadata
Go to start of metadata

Custom Alert Message Variables

The following variables can be used to create a custom alert message. You can add or remove variables to suit your needs when creating or modifying an Alert Profile.

These alert variables are also available as input parameter values when configuring an Action Profile to initiate a VMware vCenter Orchestrator workflow.

Service Outage Information
VariableDefinitionValues / Example
$TYPE$The type of notification.
  • Problem
  • Recovery
$NOTIFICATION_NUMBER$The number of alerts the outage has sent. 
$SERVICENAME$

The name of the service, along with the name of the host for which the alert was generated. By default, this variable appears in the subject line of the message.

For example, if the alert was generated by the ping check for the server MailHub, then PING-MailHub appears in the alert.
$SERVICE_DESCRIPTION$The Uptime Infrastructure Monitor description of the service monitor. 
$SERVICESTATE$

The current status of the service monitor generating the alert. By default, this variable appears in the subject line of the message.

  • OK
  • WARN
  • CRIT
  • MAINT
  • UNKNOWN
$OUTPUT$

The output of the monitor that generated the alert

Ping completed: 1 sent, 100.0% loss, 0.0ms average round trip time
$HOSTNAME$The name of the host (as saved in Uptime Infrastructure Monitor) for which this alert was generated.Systems can have a hostname that is different from its display name. For example, a hostname of 10.1.1.6 or exch-corp12 could have a display name of Mail Server.
$DISPLAYNAME$

The name of the host as it appears in the Uptime Infrastructure Monitor Web interface.

Systems can have a hostname that is different from its display name. For example, a hostname of 10.1.1.6 or exch-corp12 could have a display name of Mail Server.
$HOST_DESCRIPTION$The Uptime Infrastructure Monitor description of the host. 
$HOSTSTATE$The status of the service monitor's host.
  • OK
  • WARN
  • CRIT
  • MAINT
  • UNKNOWN
Date and Time
VariableDefinitionValues / Example
$12HOUR$The hour the outage started, using the 12-hour clock system.11
12
1 ...
$24HOUR$The hour the outage started, using the 24-hour clock system.11
12
13 ...
$MINUTE$The minute of the hour the outage started. 
$AMPM$The day period the outage started.
  • AM
  • PM
$DAY$The day of the month the outage started1
2
3
4 ...
$DAYNAME$The day of the week the outage started.Tue
Wed
Thu ...
$MM$The (numbered) month of the year the outage started.1
2
3
4 ...
$MON$The (abbreviated) month of the year the outage started.Jan
Feb
Mar
Apr ...
$MONTH$The month of the year the outage started.January
February
March
April ...
$YEAR$The year the outage started.2015
$DATE$The date the outage started.14/Feb/2015
$TIME$The time the outage started.16:59
$DATETIME$The date and time at which the alert was generated. By default, this appears in the subject line of the message.Sat Feb 14 16:59:59 EDT 2015
$DURATION$The duration of the outage so far.

30 minutes
3 hours, 30 minutes
2 days, 3 hours, 30 minutes

Uptime Infrastructure Monitor Associations and Hierarchies
VariableDefinition 
$SERVICE_GROUP$The service group the service monitor is a part of. 
$HOST_GROUP$The Element group that the service monitor's host is a member of. 
$NOTIFICATION_GROUPS$All notification groups that are contacted by this alert profile.<notificationGroup1>, <notificationGroup2>, <notificationGroup3>, ...
$NOTIFICATION_USERS$All users contacted by this alert.<user1>, <user2>, <user3>, ...
Custom Element Fields
VariableDefinition 
$CUSTOM_1$Custom fields that you are using to further describe your Elements.
$CUSTOM_2$
$CUSTOM_3$
$CUSTOM_4$
Outage Reference Information
VariableDefinition 
$INCIDENT_NUMBER$A unique identifier for the outage.0000000000000000000139282498000023
$URL_OUTPUT$A URL-encoded version of the SVCOUTPUT variable.A+MASTER%2FMEMBER+service+monitor+
            for+this+application+is+in+CRIT.
$URL_ENCODE_SERVICE_NAME$a URL-encoded version of the SVCNAME variable.
APPLICATION+-+Application+status+monitor

Script Alert Variables

The following variables can be used in a script alert, which can be included as part of an Alert Profile.

The platform on which the script runs determines how to denote the variable:

  • $UPTIME_VARNAME on Linux
  • %UPTIME_VARNAME% on Windows
Service Outage Information
VariableDefinitionValues / Example
UPTIME_SUBJECTThe subject line that would normally appear in an emailed alert for this alert.Uptime Alert - UPTIME-oracle_server -> CRIT
UPTIME_MESSAGEThe name of the service monitor generating this alert.UPTIME-oracle_server
UPTIME_ALERTTYPEThe type of notification.
  • Problem
  • Recovery
UPTIME_NOTIFICATION_NUMBERThe number of alerts the outage has sent. 
UPTIME_SVCNAME

The name of the service, along with the name of the host for which the alert was generated. By default, this variable appears in the subject line of the message.

For example, if the alert was generated by the ping check for the server MailHub, then PING-MailHub appears in the alert.
UPTIME_SERVICE_DESCRIPTIONThe Uptime Infrastructure Monitor description of the service monitor. 
UPTIME_SVCSTATUS

The current status of the service monitor generating the alert. By default, this variable appears in the subject line of the message.

  • OK
  • WARN
  • CRIT
  • MAINT
  • UNKNOWN
UPTIME_SVCOUTPUT

The output of the monitor that generated the alert

Ping completed: 1 sent, 100.0% loss, 0.0ms average round trip time
UPTIME_HOSTNAMEThe name of the host (as saved in Uptime Infrastructure Monitor) for which this alert was generated.Systems can have a hostname that is different from its display name. For example, a hostname of 10.1.1.6 or exch-corp12 could have a display name of Mail Server.
UPTIME_DISPLAYNAME

The name of the host as it appears in the Uptime Infrastructure Monitor Web interface.

Systems can have a hostname that is different from its display name. For example, a hostname of 10.1.1.6 or exch-corp12 could have a display name of Mail Server.
UPTIME_HOST_DESCRIPTIONThe Uptime Infrastructure Monitor description of the host. 
UPTIME_HOSTSTATUSThe status of the service monitor's host.
  • OK
  • WARN
  • CRIT
  • MAINT
  • UNKNOWN
Date and Time
VariableDefinitionValues / Example
UPTIME_12HOURThe hour the outage started, using the 12-hour clock system.11
12
1 ...
UPTIME_24HOURThe hour the outage started, using the 24-hour clock system.11
12
13 ...
UPTIME_MINUTEThe minute of the hour the outage started. 
UPTIME_AMPMThe day period the outage started.
  • AM
  • PM
UPTIME_DAYThe day of the month the outage started1
2
3
4 ...
UPTIME_DAYNAMEThe day of the week the outage started.Tue, Wed, Thu, ...
UPTIME_MMThe (numbered) month of the year the outage started.1
2
3
4 ...
UPTIME_MONThe (abbreviated) month of the year the outage started.Jan
Feb
Mar
Apr ...
UPTIME_MONTHThe month of the year the outage started.January
February
March
April ...
UPTIME_YEARThe year the outage started.2015
UPTIME_DATETIMEThe date and time at which the alert was generated. By default, this appears in the subject line of the message.Sat Feb 14 16:59:59 EDT 2015
UPTIME_DURATIONThe duration of the outage so far.

30 minutes
3 hours, 30 minutes
2 days, 3 hours, 30 minutes

Uptime Infrastructure Monitor Associations and Hierarchies
VariableDefinition 
UPTIME_SERVICE_GROUPThe service group the service monitor is a part of. 
UPTIME_HOST_GROUPThe Element group that the service monitor's host is a member of. 
UPTIME_NOTIFICATION_GROUPSAll notification groups that are contacted by this alert profile.notificationGroup1, notificationGroup2, notificationGroup3, ...
UPTIME_NOTIFICATION_USERSAll users contacted by this alert.user1, user2, user3, ...
Custom Element Fields
VariableDefinition 
UPTIME_CUSTOM_1Custom fields that you are using to further describe your Elements.
UPTIME_CUSTOM_2
UPTIME_CUSTOM_3
UPTIME_CUSTOM_4
Outage Reference Information
VariableDefinition 
UPTIME_INCIDENT_NUMBERA unique identifier for the outage.0000000000000000000139282498000023
UPTIME_URL_OUTPUTA URL-encoded version of the SVCOUTPUT variable.

A+MASTER%2FMEMBER+service+monitor+
            for+this+application+is+in+CRIT.

UPTIME_URL_ENCODE_SERVICE_NAMEa URL-encoded version of the SVCNAME variable.
APPLICATION+-+Application+status+monitor
Alert Recipient Information
VariableDefinition 
UPTIME_CONTACTLOGINNAMEThe login name of the user who is notified. 
UPTIME_DESKTOPHOSTThe windows desktop hostname setting for the user notified. 
UPTIME_DESKTOPWORKGROUPThe Windows workgroup for the desktop host. 
UPTIME_EMAILThe email address associated with the user notified. 
UPTIME_MOBILEThe pager or cellphone number associated with the user notified. 
Alert Script Variables
VariableDefinition 
UPTIME_SCRIPTThe name of the current script executed.C:/Program Files/uptime software/uptime/scripts/my_custom_alerter.bat
UPTIME_SMTPHELOSTRINGThe HELO string used in your SMTP server configuration. 
UPTIME_SMTPPASSWORDThe password used from authentication in your SMTP server configuration. 
UPTIME_SMTPPORTThe server port used in your SMTP server configuration. 
UPTIME_SMTPSENDERThe sender address string used in your SMTP server configuration. 
UPTIME_SMTPSERVERThe server hostname used in your SMTP server configuration. 
UPTIME_SMTPUSERThe user name used for authentication in your SMTP server configuration. 

Recovery Script Variables

The following variables can be used in a recovery script as part of an Action Profile.

Service Outage Information
VariableDefinitionValues / Example
UPTIME_NOTIFICATIONTYPEThe type of notification.
  • Problem
  • Recovery
UPTIME_NOTIFICATION_NUMBERThe number of alerts the outage has sent. 
UPTIME_SERVICENAME

The name of the service, along with the name of the host for which the alert was generated. By default, this variable appears in the subject line of the message.

For example, if the alert was generated by the ping check for the server MailHub, then PING-MailHub appears in the alert.
UPTIME_SERVICE_DESCRIPTIONThe Uptime Infrastructure Monitor description of the service monitor. 
UPTIME_SERVICESTATE

The current status of the service monitor generating the alert. By default, this variable appears in the subject line of the message.

  • OK
  • WARN
  • CRIT
  • MAINT
  • UNKNOWN
UPTIME_OUTPUT

The output of the monitor that generated the alert

Ping completed: 1 sent, 100.0% loss, 0.0ms average round trip time
UPTIME_HOSTNAMEThe name of the host (as saved in Uptime Infrastructure Monitor) for which this alert was generated.Systems can have a hostname that is different from its display name. For example, a hostname of 10.1.1.6 or exch-corp12 could have a display name of Mail Server.
UPTIME_HOST_DESCRIPTIONThe Uptime Infrastructure Monitor description of the host. 
UPTIME_HOSTSTATEThe status of the service monitor's host.
  • OK
  • WARN
  • CRIT
  • MAINT
  • UNKNOWN
UPTIME_CONNECTIONTYPEFor Windows hosts, the method used to collect metrics for the service.
  • agent
  • wmi
Date and Time
VariableDefinitionValues / Example
UPTIME_12HOURThe hour the outage started, using the 12-hour clock system.11
12
1 ...
UPTIME_24HOURThe hour the outage started, using the 24-hour clock system.11
12
13 ...
UPTIME_MINUTEThe minute of the hour the outage started. 
UPTIME_AMPMThe day period the outage started.
  • AM
  • PM
UPTIME_DAYThe day of the month the outage started1
2
3
4 ...
UPTIME_DAYNAMEThe day of the week the outage started.Tue, Wed, Thu, ...
UPTIME_MMThe (numbered) month of the year the outage started.1
2
3
4 ...
UPTIME_MONThe (abbreviated) month of the year the outage started.Jan
Feb
Mar
Apr ...
UPTIME_MONTHThe month of the year the outage started.January
February
March
April ...
UPTIME_YEARThe year the outage started.2015
UPTIME_DATETIMEThe date and time at which the alert was generated. By default, this appears in the subject line of the message.Sat Feb 14 16:59:59 EDT 2015
UPTIME_DURATIONThe duration of the outage so far.

30 minutes
3 hours, 30 minutes
2 days, 3 hours, 30 minutes

Uptime Infrastructure Monitor Associations and Hierarchies
VariableDefinition 
UPTIME_SERVICE_GROUPThe service group the service monitor is a part of. 
UPTIME_HOST_GROUPThe Element group that the service monitor's host is a member of. 
Custom Element Fields
VariableDefinition 
UPTIME_CUSTOM_1Custom fields that you are using to further describe your Elements.
UPTIME_CUSTOM_2
UPTIME_CUSTOM_3
UPTIME_CUSTOM_4
Outage Reference Information
VariableDefinition 
UPTIME_INCIDENT_NUMBERA unique identifier for the outage.0000000000000000000139282498000023
UPTIME_URL_OUTPUTA URL-encoded version of the SVCOUTPUT variable.

A+MASTER%2FMEMBER+service+monitor+
            for+this+application+is+in+CRIT.

UPTIME_URL_ENCODE_SERVICE_NAMEa URL-encoded version of the SVCNAME variable.
APPLICATION+-+Application+status+monitor

 

 

 

 

 

  • No labels