Search
Download PDF Manual

Custom Actions Definition Placeholders

This part of the guide describes the placeholders that can be used in custom actions definitions. You can use these placeholders for forming both the path to the action to be executed and the command line parameters of the action. Do not forget to quote the placeholder or the combination of placeholders used as a command line parameter. The following placeholders can be used for the custom actions definition:

%REMOTE_HOST%

the remote host being monitored, including the host label, if defined;

%REMOTE_HOST_ADDRESS%

the address of the remote host being monitored;

%REMOTE_HOST_LABEL%

the label of the remote host being monitored;

%REMOTE_HOST_IP%

the resolved IP address of the remote host;

%REMOTE_HOST_GROUP%

the group the remote host belongs to;

%REMOTE_HOST_DESCRIPTION%

the description of the remote host being monitored;

%CHANGE_TIME%

the date and time the notification is triggered at;

%OCCURRENCE%

the number of action called for this event (useful for recurring notifications);

%LOCAL_HOST%

the name of the machine on which the product is running;

%RUNNING_PRODUCT%

the running product name;

%PRODUCT_VERSION%

the current version of the running product;

%TIME%

the current time in a long format;

%DATE%

the current date in a short format;

%DATETIME%

the current date with the current time;

%UTC_OFFSET%

the current UTC offset;

%YEAR%

the current year.

For the actions handling host state changes, you can also use the following placeholders:

%STATE%

the current host state, either Up or Down;

%CONNECTION_STATUS%

the current connection status. It can be either 'lost', or 'restored'. For the 'lost' status, the reason for ping failure is added. If you do not want to see the reason, use the '%SHORT_CONNECTION_STATUS%' placeholder;

%SHORT_CONNECTION_STATUS%

the current connection status. It can be either 'lost', or 'restored'. The reason for ping failure is never added.

In case of the On Connection Restore action, you can use the following additional placeholders:

%OUTAGE_DURATION%

the duration of the outage that has ended;

%OUTAGE_START_TIME%

the start time of the outage that has ended;

%OUTAGE_END_TIME%

the end time of the outage that has ended.

And for the actions handling connection quality changes, the following placeholder can be used:

%QUALITY%

the current connection quality, one of the following: Good, Warning, Bad or Critical.