Keyword

Short Key

Description

%IPS_NAME%

%MN%

The device name

%IPS_DESCRIPTION%

%MD%

The description

%IPS_NAME_NUM%

Only the numeric characters (0-9) found within the device name field.

%IPS_DESC_NUM%

Only the numeric characters (0-9) found within the device description field.

%IPS_ADDRESS%

%IA%

The IP Address

%IPS_PORT%

%PO%

The TCP Port

%IPS_SHARENAME%

%SN%

The network share or local drive being monitored

%IPS_DRIVEMAP%

%DM%

The drive mapping for the share of a drive monitor

%IPS_DRIVESPACE%
%IPS_DRIVESPACEKB%
%IPS_DRIVESPACEMB%

The amount of drive space reported during the last check on the Driver monitoring item. (not available for non Drive type monitoring entries)
Using the KB or MB versions displays the space in KBytes or MBytes.

%IPS_RESPONSETIME%

%RT%

This is the amount of time (in Milliseconds) from the start of
monitored entry to the point of triggering alerts.
IPSentry v 4.4 required for this keyword.

%IPS_ADDINTITLE%

%AT%

The title of a monitoring Add-In

%IPS_ADDINLOADNAME%

%AL%

The class / interface name of the monitoring Add-In

%IPS_ADDINARGS%

%AA%

The arguments passed to the monitoring Add-In

%IPS_NTMACHNAME%

The NT Service Machine Name

%IPS_NTSVCNAME%

%NN%

The NT Service Name

%IPS_NTSVCDESC%

%ND%

The NT Service Description

%IPS_M_STAT%

%MS%

Device Status ("UP" or "DOWN")

%IPS_S_DATE%

%SD%

The current date in short system format

%IPS_S_TIME%

%ST%

The current time in short system format

%IPS_L_DATE%

%LD%

The current date in long system format

%IPS_L_TIME%

%LT%

The current time in long system format

%IPS_CURFAILCOUNT%

Current number of concurrent failures up to this point.

%IPS_CONNATTEMPT%

Total Attempt to Connect to remote or initiate monitoring item.

%IPS_CONNFAILURE%

Total Failed attempts to connect to remote, or initiate the monitoring item.

%IPS_SENDATTEMPT%

Total attempts to send data to remote system.

%IPS_SENDFAILURE%

Total Failed attempt to send data to remote system.

%IPS_RECVATTEMPT%

Total attempts to receive data from remote item.

%IPS_RECVFAILURE%

Total Failed attempts to receive data from remote system.

%IPS_TOTALATTEMPT%

Total Attempt to Connect to remote or initiate monitoring item. (same as %IPS_CONNATTEMPT%)

%IPS_TOTALFAILURE%

Grand total of all failures CONN + SEND + RECV giving total failures on device.

%IPS_RATE%

IPSentry success rate ###.##%.
100% - (TOTALFAILURE/TOTALATTEMPT)

%IPS_SD_LASTCLEAR%

Last date (short format) of last statistics clearing.

%IPS_ST_LASTCLEAR%

Last time (short format) of last statistics clearing.

%IPS_LD_LASTCLEAR%

Last date (long format) of last statistics clearing.

%IPS_LT_LASTCLEAR%

Last time (long format) of last statistics clearing.

%IPS_SD_LASTATTEMPT%

Last date (short format) of last attempt to check device.

%IPS_ST_LASTATTEMPT%

Last time (short format) of last attempt to check device.

%IPS_LD_LASTATTEMPT%

Last date (long format) of last attempt to check device.

%IPS_LT_LASTATTEMPT%

Last time (long format) of last attempt to check device.

%IPS_SD_LASTSUCCESS%

Last date (short format) of last successful attempt to check device.

%IPS_ST_LASTSUCCESS%

Last time (short format) of last successful attempt to check device.

%IPS_LD_LASTSUCCESS%

Last date (long format) of last successful attempt to check device.

%IPS_LT_LASTSUCCESS%

Last time (long format) of last successful attempt to check device.

%IPS_SD_LASTFAILURE%

Last date (short format) of last failed attempt to check device.

%IPS_ST_LASTFAILURE%

Last time (short format) of last failed attempt to check device.

%IPS_LD_LASTFAILURE%

Last date (long format) of last failed attempt to check device.

%IPS_LT_LASTFAILURE%

Last time (long format) of last failed attempt to check device.

%IPS_ALERTSEQUENCE%

The number of times this specific alert has actually been fired since the last success (i.e. since the "First After" threshold was reached).  This is not valid for use in the .HTI files.

%IPA_MAIL_ATTEMPT%

Total attempts processing alert.

%IPA_MAIL_FAILURE%

Total failed attempts processing alert.

%IPA_PAGE_ATTEMPT%

Total attempts processing alert.

%IPA_PAGE_FAILURE%

Total failed attempts processing alert.

%IPA_EXEC_ATTEMPT%

Total attempts processing alert.

%IPA_EXEC_FAILURE%

Total failed attempts processing alert.

%IPA_AUDIBLE_ATTEMPT%

Total attempts processing alert.

%IPA_AUDIBLE_FAILURE%

Total failed attempts processing alert.

%IPA_SYSLOG_ATTEMPT%

Total attempts processing alert.

%IPA_SYSLOG_FAILURE%

Total failed attempts processing alert.

%IPA_X10_ATTEMPT%

Total attempts processing alert.

%IPA_X10_FAILURE%

Total failed attempts processing alert.

%IPA_ADDIN_ATTEMPT%

Total attempts processing alert.

%IPA_ADDIN_FAILURE%

Total failed attempts processing alert.

%YY%

Year ##

%YYYY%

Year ####

%MM%

Month Number ##

%MMM%

Month Abbreviation (i.e. Jan )

%MMMM%

Month Full (i.e. January)

%DD%

Day Of Month ##

%DDD%

Day of Week Abbreviation (i.e. Mon)

%DDDD%

Day of Week Full (i.e. Monday)

%h%

Hour of day ##

%m%

Minute of Hour ##

%s%

Second of Minute ##

%IPS_RECV_Fnnn%

Specifies the "FIRST" (n) characters of the data received - or other monitoring information.
NETWORK: First (n) characters of the data received.
DRIVE: The Drive Space Available
SVC: Service Status (Running or Not Active)
ADD-IN: Portion of the Add-In Monitoring Result information provided by the Add-In.  Add-In components provide additional detail through this keyword such as event log entry details from the event log monitoring add-in.

ie: %IPS_RECV_F20% would return the first 20 characters of the data receive buffer. The maximum buffer is 2k so on large HTML output, this may not be the first 20 characters received.

%IPS_RECV_Lnnn%

Specifies the "LAST" (n) characters of the data received - or other monitoring information.
NETWORK: Last (n) characters of the data received.
DRIVE: The Drive Space Available
SVC: Service Status (Running or Not Active)
ADD-IN: Portion of the Add-In Monitoring Result information provided by the Add-In.  Add-In components provide additional detail through this keyword such as event log entry details from the event log monitoring add-in.

ie: %IPS_RECV_L20% would return the last 20 characters of the data received from the remote host.

Keys specific to the .HTI report files.

Keyword

File

Description

%STAT_RUNDATE%

(STAT_S.HTI)

Date (long format) of report run.

%STAT_RUNTIME%

(STAT_S.HTI)

Time (short format) of report run.

%STAT_LIST%

(STAT_S.HTI)

This is an internal variable used in this file only which is converted to one insertion of the (STATLINE.HTI) for each machine.

%STAT_IMAGE_STATUS%

(STATLINE.HTI)

Converted to up.gif or down.gif based on state of monitored device.

%STAT_STATUS%

(STATLINE.HTI)

Textual Up, Down, or Suspended

%STAT_COLOR%

(STATLINE.HTI)

For down machines, this will be "red", for up machines, this will be "green"

%STAT_IMAGE_MTYPE%

(STATLINE.HTI)

Each entry has a TYPE image and a TYPE_DOWN image associated to the monitored device type (Network, Drive, Service, Add-In)  This variable will be set to the respective .gif
(i.e. networkdown.gif or network.gif)

%STAT_MACHINFO%

(STATLINE.HTI)

Converted to formated Machine Name and associated specifics based on type (i.e. Drive, ShareName, DriveMap for Drive Space monitoring)

%STAT_LADATE%

(STATLINE.HTI)

Last Attempt Date

%STAT_LATIME%

(STATLINE.HTI)

Last Attempt Time

%STAT_LFDATE%

(STATLINE.HTI)

Last Failure Date

%STAT_LFTIME%

(STATLINE.HTI)

Last Failure Time

%STAT_UPRATE%

(STATLINE.HTI)

Preformatted to
Attempts:Failures UpRate
(ie 1:1 100%)

%STAT_UPRATE4%

(STATLINE.HTI)

Preformatted to 4 decimal places.
(ie 1:1 100.0000%)