[ Main Index | IPSentry Help Index ]
 
KEYWORDS are Case Sensitive - use all lower case for keywords.

IPSentry utilizes a large set of key words to represent device, terminal, server, naming, statistics, states, and other information unique to a given event. These variables are useful for email messages, alpha pager messages, launching external commands, and SNMP trap descriptive, and some customization options within the detail reporting.

Here is a list of currently documented IPSentry keywords supported and a description of their translation.
Please note that version 4 keywords are currently supported - however, since they have been deprecated, they are no longer documented and may eventually become unsupported in future versions.

*Date / Time Formats: The date formats shown as long and short date / time format are based on your system date/time formatting configuration.

Example:
In the following example, the email message subject needs to contain the name of the system on which IPSentry running, the entry name, and the current state.

In the message text, we want to include date, time, name, descriptive, status, the verbose response information, and in this case, our NOTES on the device entries contain important information that should accompany alerts, so we also want to include the notes.

Email Subject: %%local.computer%%: %%mach.name%% is %%mach.state%%

Message Text:
%%date.short%% @ %%time.long%%
%%mach.name%% is %%mach.state%%
%%mach.desc%%

Returned: %%mach.trimres_f1024%%

--[IMPORTANT NOTES]--
%%mach.notes%%

 

Keyword Description
%%sys.lastpoll.date%% The date on which the last cycle was completed.
%%sys.lastpoll.time%% The time at which the last cycle was completed.
%%sys.state%% Reports the IPSentry current state as:
POLLING: A current polling cycle is being performed
IDLE: The system is in between cycles.
PAUSED: System polling has been paused.
CONFIG: The system configuration is being edited.
%%sys.resume.date%% The date on which system polling will resume.
%%sys.resume.time%% The time at which system polling will resume.
%%mach.name%% The name of the entry.
%%mach.desc%% The description of the entry.
%%mach.notes%% The notations on the current entry.
%%mach.state%% Current state of entry as OK, CRITICAL
%%mach.state.reverse%% Current state of entry as OK, CRITICAL reversed.
%%mach.typeinfo%% Basic information about the configuration for the specified machine type.
Value varies in structure, length, and content based on the type and configuration
of the currently processed machine.
%%mach.typeresponse%% Brief Information regarding the result of the last test.
%%mach.statechange.date%% Date of last state change.
%%mach.statechange.time%% Time of last state change.
%%mach.state.reverse%% Current state of entry as OK, CRITICAL reversed.
%%mach.remotecomputer%% The remote computer name being used for DRIVE and SERVICE type entries.
%%mach.remoteuser%% The remote access username name being used for DRIVE and SERVICE type entries.
%%mach.net.address%% The address field value for NETWORK type entries.
%%mach.net.port%% The port field value for NETWORK type entries.
%%mach.svc.name%% The service name value.
Returns only the first service name if multiple services are used.
Use mach.svc.names for all service names.
%%mach.pollcount%% The current poll count value of the device.
%%mach.pollfreq%% The poll frequency setting of the device.
%%mach.drive.map%% The drive map field value for DRIVE type entries.
%%mach.drive.share%% The share name field value for DRIVE type entries.
%%mach.addin.title%% The add in name for ADDIN type entries.
%%mach.addin.load%% The add in loader (class name) for ADDIN type entries.
%%mach.addin.args%% The (args) field for ADDIN type entries.
This is usually XML data.
%%date.short%% Current date in system short format.
%%date.long%% Current date in system long format.
%%time.short%% Current time in system short format.
%%time.long%% Current time in system long format.
%%mach.trimres_fxxxx%% Returns the machine response information truncated to the
maximum length specified by the xxxx value.
e.g. mach.trimeres_f80 would return up to 80 bytes of response data.
%%mach.trimres_lxxxx%% Response the last xxxx bytes of machine response information.
e.g. mach.trimeres_l80 would return up to the last 80 bytes of response data.
%%mach.type%% Type of entry. Possible values include:
DRIVE
NET
ADDIN
SERVICE
GROUP
REFERENCE
%%local.computer%% The name of computer on which IPSentry is running and this conversion is being made.
%%local.user%% The name of the user under which IPSentry is running.
%%mach.name_num%% Only the numeric data within the machine name (0-9.-)
Used for numeric beeper conversion.
%%mach.desc_num%% Only the numeric data within the machine description (0-9.-)
Used for numeric beeper conversion.
%%mach.svc.names%% Return the comma delimited list of service names for SERVICE type entries.
e.g. Service name, Service name, Service name, ...
%%mach.drive.minfree%% The minimum free space value specified for DRIVE type entries.
%%mach.drive.minfreekb%% The minimum free space value in KB specified for DRIVE type entries.
%%mach.drive.minfreemb%% The minimum free space value in MB specified for DRIVE type entries.
%%mach.drive.minfreegb%% The minimum free space value in GB specified for DRIVE type entries.
%%mach.drive.avail%% The free space value reported for DRIVE type entries.
%%mach.drive.availkb%% The free space value reported in KB for DRIVE type entries.
%%mach.drive.availmb%% The free space value reported in MB for DRIVE type entries.
%%mach.drive.availgb%% The free space value reported in GB for DRIVE type entries.
%%mach.state.ud%% The state of the machine reported as UP or DOWN
%%mach.state.ud.reverse%% The state of the machine - reversed - reported as UP or DOWN.
%%mach.alertseq%% The last alert sequence - calculated from fail count and the alert schedule.
Used ONLY during alerting process and is invalid for reporting.
%%mach.failcount%% The current failure count since the last time the counters were cleared.
%%mach.successcount%% The current success count as calculated from Attempts - Failures.
%%mach.attemptcount%% The total number of monitoring attempts since the last time the counters were cleared.
%%mach.curfailcount%% The current failure count since the last successful result.
e.g. The number of sequential failures thus far.
%%mach.cursuccesscount%% The current success count since the last failure.
e.g. The number of sequential successes thus far.
%%mach.connfailure%% The total number of attempts.
%%mach.sendattempt%% For NETWORK type entries, the total number of SEND attempts.
%%mach.sendfailure%% For NETWORK type entries, the total number of SEND failures.
%%mach.recvattempt%% For NETWORK type entries, the total number of attempts to receive data.
%%mach.recvfailure%% For NETWORK type entries, the total number of failures at receiving data.
%%mach.lastclear.sd%% Date quick stats were cleared in system short format.
%%mach.lastclear.ld%% Date quick stats were cleared in system long format.
%%mach.lastclear.st%% Time quick stats were cleared in system short format.
%%mach.lastclear.lt%% Time quick stats were cleared in system long format.
%%mach.lastsuccess.sd%% The last successful poll date in system short format.
%%mach.lastsuccess.ld%% The last successful poll date in system long format.
%%mach.lastsuccess.st%% The last successful poll time in system short format.
%%mach.lastsuccess.lt%% The last successful poll time in system long format.
%%mach.lastattempt.sd%% The last attempt poll date in system short format.
%%mach.lastattempt.ld%% The last attempt poll date in system long format.
%%mach.lastattempt.st%% The last attempt poll time in system short format.
%%mach.lastattempt.lt%% The last attempt poll time in system long format.
%%mach.lastfail.sd%% The last failure date in system short format.
%%mach.lastfail.ld%% The last failure date in system long format.
%%mach.lastfail.st%% The last failure time in system short format.
%%mach.lastfail.lt%% The last failure time in system long format.
%%mach.restime%% The last reported response time , in milliseconds, for PING checks.
Action total time, in milliseconds, is reported for other entries.
%%mach.actiontime%% Total time, in milliseconds, of the last processing of this entry.
%%mach.uprate%% The up time rate as calculated using the success count / attempt count.
Calculated to 4 decimal places.
%%mach.uprate4%% Identical to mach.uprate
%%mach.uprate2%% Same as mach.uprate except calculated to 2 decimal places.
%%mach.alrt.mail.attemptcount%% Total number of email alert attempts.
%%mach.alrt.mail.failcount%% Total number of email alert failures.
%%mach.alrt.page.attemptcount%% Total number of pager alert attempts.
%%mach.alrt.page.failcount%% Total number of pager alert failures.
%%mach.alrt.syslog.attemptcount%% Total number of Syslog alert attempts.
%%mach.alrt.syslog.failcount%% Total number of Syslog alert failures.
%%mach.alrt.exec.attemptcount%% Total number of launch app / command alert attempts.
%%mach.alrt.exec.failcount%% Total number of launch app / command alert failures.
%%mach.alrt.x10.attemptcount%% Total number of x10 alert attempts.
%%mach.alrt.x10.failcount%% Total number of x10 alert failures.
%%mach.alrt.audible.attemptcount%% Total number of audible alert attempts.
%%mach.alrt.audible.failcount%% Total number of audible alert failures.
%%mach.alrt.addin.attemptcount%% Total number of add in alert attempts.
%%mach.alrt.addin.failcount%% Total number of add in alert failures.
%%ca.0%% - %%ca.9%% Custom attribute fields for the device.
The %%ca.#%% keyword will be replaced with the attribute value (if any) that has been configured for the specified entry.
%%sys.runtime%% Total runtime of this instance of IPSentry in D, H, M, S
%%sys.runtimeraw%% The runtime of this instance of IPSentry in seconds.
%%date.yy%% Current date year formatted as 2 digit.
%%date.yyyy%% Current date year formatted as 4 digit.
%%date.mm%% Current date month formatted as 2 digit.
%%date.mmm%% Current date month formatted as 3 letter abbreviation.
%%date.mmmm%% Current date month formatted as full month name.
%%date.dd%% Current date day formatted as 2 digit.
%%date.ddd%% Current date day formatted as 3 letter abbreviation.
%%date.dddd%% Current date day formatted as full day name.
%%time.hh%% Current time hour in 24 hour format.
%%time.mm%% Current time minute.
%%time.ss%% current time seconds.
%%mach.infoformatted%% This key is obsolete and should not be used.
Currently, it will write machine name, new line, machine description.
Used only in v4 or less reporting.
%%mach.lastattempt.date%% The date of the last attempt made on this entry.
%%mach.lastattempt.time%% The time of the last attempt made on this entry.
%%mach.lastfail.date%% The date of the last failure of this entry.
%%mach.lastfail.time%% The time of the last failure of this entry.
%%mach.lastsuccess.date%% The date of the last success of this entry.
%%mach.lastsuccess.time%% The time of the last success of this entry.
%%mach.muid%% The internal unique ID of this entry.
%%mach.timeinstate%% The amount of time in D, H, S that this entry has been in it's current state of OK or CRITICAL.
%%mach.timeinstateraw%% The amount of time in seconds that this entry has been in it's current state of OK or CRITICAL.
%%mach.parent.name%% The name of this item's parent.
%%mach.parent.desc%% The description of this item's parent.
%%mach.parent.muid%% The internal unique IDF of this item's parent.
%%mach.resume.date%% The date on which a suspended entry will be resumed.
%%mach.resume.time%% The time at which a suspended entry will be resumed.
%%mach.resultinfo%% The result detail information for this entry.
%%mach.resultinfohtml%% The result detail information formatted for HTML output.


     If you require additional assistance, please visit our on-line support forum at http://forum.ipsentry.com.
 
©1997-2012 by RGE, Inc. - All Rights Reserved
IPSentry® is a registered trademark of RGE, Inc.

 
Support Forums: http://forum.ipsentry.com
Web Site: http://www.ipsentry.com
Support Email: support@ipsentry.com