Netmond V2. Internal variables and constants

This is consolidated table of Netmond internal variables. Variable can have some "type" and can be bound to parent object or subobject.
Variables classification is in separate document.


Global variables and constants

This is global context Netmond variables:

ROOTDIR = "String"
Path to Netmond working directory.
TIMEFMT = "String"
Netmond system time output format.
TIME = Unsigned
Netmond current system time.

Object variables

NAME = "String"
The name of the object.
DESCRIPTION = "String"
Object's one-line short description.
ADDRESS = "String"
Object's network address: IP or FQDN.
POLLING = Integer
Object's polling interval, seconds.
SAVING = Integer
Object's saving interval, seconds.
DATADIR = "String"
Object's data saving directory full path starting with "/".
STATE = "String" 1
Object's current state string: UP, DOWN or NONE.
QUERYTIME = Unsigned 1
Last object's query time in seconds from Epoch, UCT.
REPLYTIME = Unsigned 1
Last object's reply time in seconds from Epoch, UCT.
LASTCHANGE = Unsigned
Last object's change time in seconds from Epoch, UCT.
NETPATH = "String"
Topological path from the point of view to object. Consist of ordered comma separated string pairs. Each string pair is a name of hop router and a name of their outgoing interface, separated with exclamation mark "!".
HOPCOUNT = Integer
Net path hop count from the point of view to object.
sysObjID = ObjID
SNMP variable : system model identifier.
sysName = "String"
SNMP variable : object's system name.
sysUpTime = Unsigned 1
SNMP variable : time since last reload, in 100ms ticks.
sysContact = "String"
SNMP variable : This object's sysadmin contact requisites.
Available if Netmond compiled with USE_VAR_sysContact option.
sysLocation = "String"
SNMP variable : Location of this system.
Available if Netmond compiled with USE_VAR_sysLocation option.
ifNumber = Integer 1
SNMP variable: Total object's interfaces number.
ciscoWhyReload = "String" 1
SNMP variable: Cisco router last reload reason.
ciscoFreeMem = Unsigned 1
SNMP variable: Cisco router free memory in bytes.
ciscoAvgBusy = Unsigned 1
SNMP variable: total average Cisco router processor load in percents.

Service variables

NAME = "String"
The name of the service.
DESCRIPTION = "String"
Service one-line short description.
DATADIR = "String"
Service saving directory full path.
STATE = "String" 1
Service current state string: UP, DOWN or NONE.
QUERYTIME = Unsigned 1
Last service query time in seconds from Epoch, UCT.
REPLYTIME = Unsigned 1
Last service reply time in seconds from Epoch, UCT.
LASTCHANGE = Unsigned
Last service state change time in seconds from Epoch, UCT.

Interface variables

NAME = "String"
The name of the interface or their index.
DESCRIPTION = "String"
Interface one-line short description.
BANDWIDTH = Unsigned
Assigned interface speed, bytes per second.
DATADIR = "String"
Interface saving directory full path.
STATE = "String" 1
Interface current state string: UP, DOWN, TESTING or NONE.
QUERYTIME = Unsigned 1
Last interface query time in seconds from Epoch, UCT.
REPLYTIME = Unsigned 1
Last interface reply time in seconds from Epoch, UCT.
LASTCHANGE = Unsigned
Last interface state change time in seconds from Epoch, UCT.
IFIDNEX = Integer
Interface SNMP index.
ADDRESS = "String"
Interface IP addresses, comma separated.
ifDescr = "String" 1
SNMP variable: Interface system description.
ifType = Integer 1
SNMP variable: interface system type, see IANA ifType MIB.
ifSpeed = Unsigned 1
SNMP variable: Interface system speed, bits per second.
ifAdminStatus = Integer 1 2
SNMP variable: Current interface administrative state.
Available if Netmond compiled with USE_VAR_ifAdminStatus option.
ifOperStatus = Integer 1 2
SNMP variable: Current interface operational status.
ifLastChange = Unsigned 1
SNMP variable: Time since last operational state change in 100ms ticks.
ifInOctets, ifOutOctets = Unsigned 1 3
SNMP variables: The total number of incoming and outgoing octets on the interface.
ifInUcastPkts, ifOutUcastPkts = Unsigned 1 3
SNMP variables: The total number of incoming and outgoing unicast packets on the interface.
ifInNUcastPkts, ifOutNUcastPkts = Unsigned 1 3
SNMP variables: The total number of incoming and outgoing broadcast and multicast packets on the interface.
ifInDrops, ifOutDrops = Unsigned 1 3
SNMP variables: The total number of incoming and outgoing packets lost or dropped on the interface.
ifInErrors, ifOutErrors = Unsigned 1 3
SNMP variables: The total number of packets received or sent with errors on the interface.
ciscoIfReason = "String"
SNMP variable: Last Cisco router interface operational status change diagnostic.
ciscoIfDescr = "String"
SNMP variable: Cisco router interface user-specified description

BGPAS variables

ASN = Integer
The autonomous system number 1..65535.
NAME = "String"
AS name, for example "AS8691".
DESCRIPTION = "String"
AS one-line short description.
DATADIR = "String"
AS saving directory full path.
MEMBERS = "String"
List of BGP peers NAME s for this AS, comma separated.
STATE = "String" 1
List of BGP peers STATE s for this AS, comma separated.
LASTCHANGE = "String"
List of BGP peers LASTCHANGE times, comma separated.

BGPPeer variables

NAME = "String"
Name or IP address of remote BGP peer. Address converted to name string if Netmond monitors such an object.
ASN = Integer
Inherited from parent BGPAS.
DESCRIPTION = "String"
Inherited from parent BGPAS.
DATADIR = "String"
Inherited from parent BGPAS.
STATE = "String" 1
Current BGP peer session state:IDLE, CONNECT, ACTIVE, OPENSENT, OPENCONFIRM, ESTABLISHED or ERROR.
QUERYTIME = Unsigned 1
Last BGP peer query time in seconds from Epoch, UCT.
REPLYTIME = Unsigned 1
Last BGP peer reply time in seconds from Epoch, UCT.
LASTCHANGE = Unsigned
Last BGP peer state change time in seconds from Epoch, UCT.
bgpPeerState = Integer 1 2
SNMP variable: Current BGP peer session state.
bgpPeerInUpdates, bgpPeerOutUpdates = Unsigned 1 3
SNMP variables: The number of BGP UPDATE messages received from and sent to BGP peer in current session.
Available if Netmond compiled with USE_BGP_COUNTERS option.
bgpPeerInTotalMessages, bgpPeerOutTotalMessages = Unsigned 1 3
SNMP variables: The TOTAL number of BGP UPDATE messages received from and sent to BGP peer.
Available if Netmond compiled with USE_BGP_COUNTERS option.
bgpPeerLastError = "String" (binary)
SNMP variable: Last BGP peer session error diagnostic, first two bytes - error code and subcode.
bgpPeerFsmEstablishedTime = Unsigned
SNMP variable: Time since last BGP peer session state change, seconds.

EnvMon variables

Applicable only for Cisco devices.

NAME = "String"
The name of Cisco monitoring entity, for example "ENVTEMP" - thermal entity.
DESCRIPTION = "String"
This probes set one-line short description.
DATADIR = "String"
Data saving directory full path.
MEMBERS = "String"
List of members NAME s, comma separated.
STATE = "String" 1
List of members STATE s, comma separated.
LASTCHANGE = "String"
List of members state LASTCHANGE, comma separated.

EnvTemp variables

Applicable only for Cisco devices.

NAME = "String"
Thermal probe name.
DESCRIPTION = "String"
Inherited from parent EnvMon.
DATADIR = "String"
Inherited from parent EnvMon.
STATE = "String" 1
Thermal probe current state: NORMAL, WARNING, CRITICAL, SHUTDOWN, NOTPRESENT or ERROR.
QUERYTIME = Unsigned 1
Last probe query time in seconds from Epoch, UCT.
REPLYTIME = Unsigned 1
Last probe reply time in seconds from Epoch, UCT.
LASTCHANGE = Unsigned
Last probe state change time in seconds from Epoch, UCT.
ciscoEnvTempState = Integer 1 2
SNMP variable: Thermal probe current state.
ciscoEnvTempValue = Integer 1 3
SNMP variable: current probe temperature value, centigrade degrees.

Footnotes:
1: Previous value available by old suffix.
2: String state value available by state suffix.
3: Extended values available by ave min max delta suffixes.


See also:
Configuration statements
NetState service
Configuration examples

© 1998-2002, Rinet Software