KBI 311798 Variables Available In Argent Advanced Technology

Version

Argent Advanced Technology 5.1A-2001-A or above

Date

Wednesday, 4 March 2020

Summary

This note contains documentation for all variables that can be used within Argent Advanced Technologies.

Technical Background

%VARIABLES%

Sometimes you need to add a variable to an Alert for parameters, such as the name of the server being tested-hard-coding each server name would be a huge amount of needless work.

For Alerts that need variables, there is a %VARIABLE% button.

This help page is a master list of the variables and their meanings.

Printing this material is often useful.
%AGAliasName%

The Node’s alias name, if present.

If it is not present, a null string is returned.

%AGNetworkGroup%

The Node’s Network Group, if present.

If it is not present, a null string is returned.

%AGBrokenRuleName%

The name of the Rule causing the event to be fired to the main Argent Console screen.

%AGClusterName%

The name of cluster if this Node is a cluster object.

If it is not a cluster object, a null string is returned.

%AGClusterObject%

The name of cluster object if this Node is a cluster object.

If it is not a cluster object, a null string is returned.

%AGConsoleComment%

The console comment of the Rule causing the event to be fired to the main Argent Console screen.

%AGStatus%

The status of the event to be fired.

This will be “Alert” for an original event or “Corrected” for a correcting event.

%AGProductName%

The name of the Argent product that generated the Alert.

%AGEventDetail%

A summary of the event.

%AGHighDetail%

A detailed description of event.

%AGHighDetailAsString%

The long description of the event with new lines replaced with spaces.

This is useful for sending SMS messages and emails.

%AGLowDetail%

The event summary.

%AGShortDetail%

The short event summary.

%AGOriginalEventDetail%

The event summary of the original event.

%AGResolvedEventDetail%

The event summary of the resolving event.

%AGEventID%

Each event on Argent Console screens (A1X) is assigned an ID, which is incremented and reset to 1 when reaching 99,999.

%AGNodeDelayMS% (Milliseconds)

The Node’s TCP/IP timeout in milliseconds.

This value is specified in the node property of CMDB-X.

%AGNodeDelayS% (Seconds)

The Node’s TCP/IP timeout in seconds.

This value is specified in the node property of CMDB-X.

%AGNodeName%

The name of the Node causing the event to be fired to the main Argent Console screen.

%AGNodeTryCount%

The Node’s TCP/IP retry count.

This value is specified in the node property of CMDB-X.

%AGNodeType%

The Node type.

%AGRelatorName%

The name of the Relator causing the event to be fired to the main Argent Console screen.

%AGReportNamesAsString%

The names of the reports included in this Alert for automatic report distribution.

%AGRuleDesc%

The Rule’s description field.

%AGService%

The name of the service causing the event to be fired to the main Argent Console screen.

%AGUniqueID%

The internal unique ID of the event.

This value is the column ‘pckey’ of the AAC_Console table, which is the primary key of the SQL table.

The SQL Server backend maintains this field.

%Date%

The date when the Rule was broken, taken from the date on the local machine.

%Time%

The time when the Rule was broken, taken from the time on the local machine.

Contact Information

These variables are from the CMDB-X.

%ServerLocation%

The Location specified for the Node in the CMDB-X.