A.2
Built-In Variables
Here is a catalog of
built-in variables which are automatically available and configured by AutoNOC.A.2.1.1 Record Variables
Record variables are
resolvable when an expression is evaluated at the scope of a record. These are typically
processed when evaluating alarms, calculating reports, computing graphs, and any kind of a
historical analysis.
Name
|
Description |
%V
|
The database value of the
record. |
%L
|
The computed integer
service level of the database record. |
%T
|
The computed service level
text for the database record. |
%S
|
The database timestamp for
the record. |
%C
|
The computed color of the
database record. |
A.2.1.2 Object Variables
Object variables are
resolvable when an expression is evaluated at the scope of any generic object.
Name
|
Description |
%V
|
The database value of the most
recent record when there is no record scope. |
%L
|
The computed integer
service level of the most recent record when there is no record scope. |
%T
|
The computed service level
text of the most recent record when there is no record scope. |
%S
|
The database timestamp of
the most recent record when there is no record scope. |
%C
|
The computed service level
color of the most recent record when there is no record scope. |
| %CURRENTLEVEL |
The same as %L
only will return the most recent record even when there is a current record scope. |
| %CURRENTTEXT |
The same as %T
only will return the most recent record even when there is a current record scope. |
| %CURRENTVALUE |
The same as %V
only will return the most recent record even when there is a current record scope. |
| %CURRENTSTAMP |
The same as %S
only will return the most recent record even when there is a current record scope. |
| %OBJNAME |
Returns the
relevant object name (e.g. for an e-mail generated by an alarm, it will return the name of
the probe causing the alarm). |
| %OBJDEVICE |
Returns the
name of the relevant device, if any. |
| %OBJCOMPONENT |
Returns the
name of the relevant component, if any. The component name would be the specific name of
the interface or other related object. |
| %OBJCATEGORY |
The name of
the relevant category, if any. |
| %OBJIP |
The relevant
IP address. |
A.2.1.3 Component Variables
Component variables are
specifically defined at the time of device discovery to provide generic information used
by AutoNOC probes.
Name
|
Description |
| %IFSPEEDIN |
The incoming
interface speed in bits per second. This variable is defined during device discovery. |
| %IFSPEEDOUT |
The outgoing
interface speed in bits per second. This variable is defined during device discovery. |
| %IFSPEEDTOTAL |
The sum of the
incoming and outgoing speeds on the interface in bits per second. This variable is defined
during device discovery. |
| %IFINDEX |
The SNMP
assigned reference index for the interface as determined at the time the device is
discovered. |
| %IFIP |
Defined during
discovery, the interface specific IP address for the interface. Note that this can be
different than the device variable %IP, which defines the top level IP address for a
device (usually the one used for discovery). |
| %IFMAC |
Defined during discovery,
the current local interface MAC address. |
%SNMPNAME
|
Some
components such as hard drives and interfaces have internal SNMP names assigned at
discovery. This variable will retrieve the internal SNMP name if one is available. |
| %SNMPROW |
Some
components such as hard drives and interfaces have an internal SNMP row assigned at
discovery. This variable will retrieve the row if one is available. |
| %CPULOW |
Returns the
value that is specified for the CPU component indicating processor usage is low. |
| %CPUMED |
Returns the
value that is specified for the CPU component indicating processor usage is medium. |
| %CPUHIGH |
Returns the
value that is specified for the CPU component indicating processor usage is high. |
| %CAPACITY |
Defined during
discovery, this variable specifies the capacity of the storage component. |
| %UNITSIZE |
Defined during
discovery, this variable specifies the unit size in bytes of the storage component. |
A.2.1.4 Device Variables
Device variables are
specifically defined at the time of device discovery to provide generic information about
the device.
Name
|
Description |
| %IP |
The relevant IP address.
This will be the primary / discovery IP address for the device in normal circumstances. If
an interface is setup to force children to use the specific interface, the IP address will
be the IP address for the interface. |
| %COMMUNITY |
Retrieve the currently
active SNMP read community. This is usually assigned at the top level device. |
| %DESCRIPTION |
The SNMP description as
stored by AutoNOC for the device. |
| %HOSTNAME |
The host name AutoNOC
looks up when discovering the device. |
| %POLLEVERY |
An expression indicating
the polling interval for AutoNOC. |
A.2.1.5 Alarm Variables
Alarm variables are defined
whenever processing an expression during the firing of an action.
Name
|
Description |
| %ALARMTYPE |
When firing an
action, this variable is defined as "Alarm On" or "Alarm Off"
depending on what caused the action to fire. |
A.2.1.5 Global Variables
Global variables return
information no matter what the current scope is.
Name
|
Description |
| %PORTALID |
Returns the
integer of the current portal ID. |
| %PORTALNAME |
Returns the
name assigned to the current portal. |
| %PORTALIP |
Returns the IP
address of the current portal. |
| %PORTALDEPT |
Returns the
text indicating the assigned department of the current portal. |
| %PORTALCOMPANY |
Returns the
company name assigned to the portal. |
|
