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 | ||
|---|---|---|
| Variable | Definition | Values / Example |
$TYPE$ | The type of notification. |
|
| The number of alerts the outage has sent. | |
| 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. |
| The up.time description of the service monitor. | |
| The current status of the service monitor generating the alert. By default, this variable appears in the subject line of the message. |
|
| The output of the monitor that generated the alert | Ping completed: 1 sent, 100.0% loss, 0.0ms average round trip time |
| The name of the host (as saved in up.time) 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. |
| The name of the host as it appears in the up.time 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. |
| The up.time description of the host. | |
| The status of the service monitor's host. |
|
| Date and Time | ||
| Variable | Definition | Values / Example |
| The hour the outage started, using the 12-hour clock system. | 11 12 1 ... |
| The hour the outage started, using the 24-hour clock system. | 11 12 13 ... |
| The minute of the hour the outage started. | |
| The day period the outage started. |
|
| The day of the month the outage started | 1 2 3 4 ... |
| The day of the week the outage started. | Tue Wed Thu ... |
| The (numbered) month of the year the outage started. | 1 2 3 4 ... |
| The (abbreviated) month of the year the outage started. | Jan Feb Mar Apr ... |
| The month of the year the outage started. | January February March April ... |
| The year the outage started. | 2014 |
| The date the outage started. | 14/Feb/2014 |
| The time the outage started. | 16:59 |
| The date and time at which the alert was generated. By default, this appears in the subject line of the message. | Fri Feb 14 16:59:59 EDT 2014 |
| The duration of the outage so far. |
|
| up.time Associations and Hierarchies | ||
| Variable | Definition | |
| The service group the service monitor is a part of. | |
| The Element group that the service monitor's host is a member of. | |
| All notification groups that are contacted by this alert profile. | <notificationGroup1>, <notificationGroup2>, <notificationGroup3>, ... |
| All users contacted by this alert. | <user1>, <user2>, <user3>, ... |
| Custom Element Fields | ||
| Variable | Definition | |
| Custom fields that you are using to further describe your Elements. | |
| ||
| ||
| ||
| Outage Reference Information | ||
| Variable | Definition | |
| A unique identifier for the outage. | 0000000000000000000139282498000023 |
| A URL-encoded version of the SVCOUTPUT variable. | A+MASTER%2FMEMBER+service+monitor+ |
| 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 will run determines how to denote the variable:
$UPTIME_VARNAMEon Linux%UPTIME_VARNAME%on Windows
| Service Outage Information | ||
|---|---|---|
| Variable | Definition | Values / Example |
UPTIME_SUBJECT | The subject line that would normally appear in an emailed alert for this alert. | Uptime Alert - UPTIME-oracle_server -> CRIT |
| The name of the service monitor generating this alert. | UPTIME-oracle_server |
| The type of notification. |
|
| The number of alerts the outage has sent. | |
| 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. |
| The up.time description of the service monitor. | |
| The current status of the service monitor generating the alert. By default, this variable appears in the subject line of the message. |
|
| The output of the monitor that generated the alert | Ping completed: 1 sent, 100.0% loss, 0.0ms average round trip time |
| The name of the host (as saved in up.time) 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. |
| The name of the host as it appears in the up.time 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. |
| The up.time description of the host. | |
| The status of the service monitor's host. |
|
| Date and Time | ||
| Variable | Definition | Values / Example |
| The hour the outage started, using the 12-hour clock system. | 11 12 1 ... |
| The hour the outage started, using the 24-hour clock system. | 11 12 13 ... |
| The minute of the hour the outage started. | |
| The day period the outage started. |
|
| The day of the month the outage started | 1 2 3 4 ... |
| The day of the week the outage started. | Tue, Wed, Thu, ... |
| The (numbered) month of the year the outage started. | 1 2 3 4 ... |
| The (abbreviated) month of the year the outage started. | Jan Feb Mar Apr ... |
| The month of the year the outage started. | January February March April ... |
| The year the outage started. | 2014 |
| The date and time at which the alert was generated. By default, this appears in the subject line of the message. | Fri Feb 14 16:59:59 EDT 2014 |
| The duration of the outage so far. |
|
| up.time Associations and Hierarchies | ||
| Variable | Definition | |
| The service group the service monitor is a part of. | |
| The Element group that the service monitor's host is a member of. | |
| All notification groups that are contacted by this alert profile. | notificationGroup1, notificationGroup2, notificationGroup3, ... |
| All users contacted by this alert. | user1, user2, user3, ... |
| Custom Element Fields | ||
| Variable | Definition | |
| Custom fields that you are using to further describe your Elements. | |
| ||
| ||
| ||
| Outage Reference Information | ||
| Variable | Definition | |
| A unique identifier for the outage. | 0000000000000000000139282498000023 |
| A URL-encoded version of the SVCOUTPUT variable. |
|
| a URL-encoded version of the SVCNAME variable. | APPLICATION+-+Application+status+monitor |
| Alert Recipient Information | ||
| Variable | Definition | |
| The login name of the user who is being notified. | |
| The windows desktop hostname setting for the user being notified. | |
| The Windows workgroup for the desktop host. | |
| The email address associated with the user being notified. | |
| The pager or cellphone number associated with the user being notified. | |
| Alert Script Variables | ||
| Variable | Definition | |
| The name of the current script being executed. | C:/Program Files/uptime software/uptime/scripts/my_custom_alerter.bat |
| The HELO string used in your SMTP server configuration. | |
| The password used from authentication in your SMTP server configuration. | |
| The server port used in your SMTP server configuration. | |
| The sender address string used in your SMTP server configuration. | |
| The server hostname used in your SMTP server configuration. | |
| The 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 | ||
|---|---|---|
| Variable | Definition | Values / Example |
| The type of notification. |
|
| The number of alerts the outage has sent. | |
| 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. |
| The up.time description of the service monitor. | |
| The current status of the service monitor generating the alert. By default, this variable appears in the subject line of the message. |
|
| The output of the monitor that generated the alert | Ping completed: 1 sent, 100.0% loss, 0.0ms average round trip time |
| The name of the host (as saved in up.time) 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. |
| The up.time description of the host. | |
| The status of the service monitor's host. |
|
UPTIME_CONNECTIONTYPE | For Windows hosts, the method used to collect metrics for the service. |
|
| Date and Time | ||
| Variable | Definition | Values / Example |
| The hour the outage started, using the 12-hour clock system. | 11 12 1 ... |
| The hour the outage started, using the 24-hour clock system. | 11 12 13 ... |
| The minute of the hour the outage started. | |
| The day period the outage started. |
|
| The day of the month the outage started | 1 2 3 4 ... |
| The day of the week the outage started. | Tue, Wed, Thu, ... |
| The (numbered) month of the year the outage started. | 1 2 3 4 ... |
| The (abbreviated) month of the year the outage started. | Jan Feb Mar Apr ... |
| The month of the year the outage started. | January February March April ... |
| The year the outage started. | 2014 |
| The date and time at which the alert was generated. By default, this appears in the subject line of the message. | Fri Feb 14 16:59:59 EDT 2014 |
| The duration of the outage so far. |
|
| up.time Associations and Hierarchies | ||
| Variable | Definition | |
| The service group the service monitor is a part of. | |
| The Element group that the service monitor's host is a member of. | |
| Custom Element Fields | ||
| Variable | Definition | |
| Custom fields that you are using to further describe your Elements. | |
| ||
| ||
| ||
| Outage Reference Information | ||
| Variable | Definition | |
| A unique identifier for the outage. | 0000000000000000000139282498000023 |
| A URL-encoded version of the SVCOUTPUT variable. |
|
| a URL-encoded version of the SVCNAME variable. | APPLICATION+-+Application+status+monitor |