NAME

snmpxmon2 − Network management tool using SNMP

SYNOPSIS

snmpxmon2 configfile [options]

DESCRIPTION

snmpxmon2 will determine the status of the network entities it is configured to monitor by querying the designated entities and the displaying information on the status of those entities.  snmpxmon2 views the world as a collection of managed networks, each with members consisting of manageable network entities (routers, hosts etc.).  The relationship between networks and primitive entities (manageable network entities) is many-many: a network has many primitive entities as members, and any given primitive entity may be a member of multiple networks.  Serial links in snmpxmon2 are represented as two half-links, each emanating from the primitive entity that is at that endpoint of the serial link.  Connections to LANs and RINGs consist of a single link from the primitive entity to the LAN/RING.  The snmpxmon2 application consists of three processes: a display process to manage the snmpxmon2 display, a poller process to gather information on primitive entities, and a trap-acceptor process to receive SNMP traps.  Each process will perform logging of internal activity to a separate log file (location configured by user).  The snmpxmon2 display process is responsible for managing the snmpxmon2 display(s), and accepting user input.  The snmpxmon2 poller process is responsible for gathering network management information by polling managed entities.  The poller process will start out polling managed entities at a predetermined (user-configurable) interval with the SNMP.  In the event that a response is not received from a managed entity, the poller process will decrease the polling interval for that managed entity, increasing the rate at which the non-responding entity is polled.  A (user-settable) minimum polling interval is used to limit the amount of system and network resources consumed by adjusting the polling interval downwards.  In the event that a (user-configurable) threshold is exceeded in the number of attempts made to contact a non-responding entity via SNMP, snmpxmon2 will back-down and attempt to contact the non-responding entity with the use of ICMP Echos.  Once it is established that an entity may be contacted via ICMP Echos, snmpxmon2 will revert to attempting to gather network management information via the SNMP.  The trap-acceptor process is responsible for accepting SNMP traps from managed entities. The trap-acceptor process will log all traps received to a (user-configurable) logfile in a format identical to that of the snmptrapd application.  In addition, the trap-acceptor process will update the status of primitive entities based on link status (LinkUp, LinkDown) traps received. 

configfile
Specifies a configuration file of which the contents are described later. Menu bar in the snmpxmon2 window permits the user to display the logfile or the online manual, etc.  The options available from the menu bar are as follows.  File

Control...
This item is used to pop up the control panel to confirm the settings for polling interval, minimum polling interval, maximum number of retries, logfile name, log level, trap logfile name, the settings in the snmpxrtmetric and ripxrtmetric configuration files and the toplevel network setting.  It is also possible to change the bell and status display settings. 

Close(X)
Closes the window. Note, however, that the toplevel network window cannot be closed.

Exit
Exits snmpxmon2. 

Execute

View traps
Displays the contents of the trap logfile.

View log
Displays the contents of the logfile.

MIB browser
Invokes snmpxtree. 

Help

Legend...
Displays the legends of primitive entities and networks.

Version...
Displays version information.

Manual...
Displays the online manual.

When the default settings are used, double clicking on a primitive entity with Button1 (normally the left mouse button) pops up a new window displaying information about the selected primitive entity.  The information displayed includes the name of the primitive entity, type, interface, connection interface, management protocol, community name and trap community name.  snmpxmon2 can be used to run specific applications for primitive entities from popup menus.  When the default settings are used, pressing Button3 (normally the right mouse button) when pointing to a primitive entity displays a popup menu.  The applications which can be run from popup menus are listed below. 

Ping
Invokes ping. 

Telnet
Invokes telnet. 

Traceroute
Invokes traceroute. 

Routing information
Invokes snmpsrc. 

Snmplookup
Invokes snmplookup. 

Interface monitor
Invokes snmpxperfmon. 

Route metric monitor
Invokes snmpxrtmetric. 

Route metric monitor (RIP)
Invokes ripxrtmetric. 

NFS monitor
Invokes nfsmon. This is valid only for NEWS systems. 

If the definition of a primitive entity specifies “icmponly”, the only items that can be run from a popup window are “Ping”, “Telnet”, “Traceroute” and “Route metric monitor (RIP)”. 

OPTIONS

In addition to the standard X Toolkit options, snmpxmon2 also supports the following.  −bell on/off
−b on/off

Specifies whether or not a bell should sound when the status of a primitive entity changes.  The bell default setting is “on”. 

−upColor color

Specifies the label color for primitive entities that respond correctly to queries using SNMP.  The default setting is “Green”. 

−downColor color

Specifies the label color for primitive entities in the initial state of snmpxmon2 immediately after it is started (before polling has been attempted using SNMP or ICMP).  The default setting is “Red”. 

−unknownColor color

Specifies the label color for primitive entities that do not respond to queries using SNMP or ICMP.  The default setting is “Yellow”. 

−icmpColor color

Specifies the label color for primitive entities that respond correctly to queries using ICMP.  The default setting is “Gray”. 

−lanColor color

Specifies the color for lines in local area networks.  The default setting is “Orange”. 

−ringColor color

Specifies the color for lines in local area networks with a ring configuration.  The default setting is “SkyBlue”. 

−linkLineWidth width

Specifies the line width for serial links.  The default setting is 2. 

−lanLineWidth width

Specifies the width for lines in local area networks.  The default setting is 3. 

−ringLineWidth width

Specifies the width for lines in local area networks with a ring configuration.  The default setting is 1. 

−noPrimIcon

Specifies that primitive entities should be represented as labels only, with no bitmap displayed. 

−noPeerIcon

Specifies that networks should be represented as labels only, with no bitmap displayed. 

−help

Displays a description of the options unique to snmpxmon2. 

RESOURCES

snmpxmon2 supports all of the standard resource names and class names included in X Toolkit.  In addition, the following application resources may be used.  The default values are shown below. 

Snmpxmon2.interval: 60
Snmpxmon2.maxInterval: 600
Snmpxmon2.minpoll: 5
Snmpxmon2.maxsnmppoll: 3
Snmpxmon2.maxMaxsnmppoll: 10
Snmpxmon2.bell: on
Snmpxmon2.upColor: Green
Snmpxmon2.downColor: Red
Snmpxmon2.unknownColor: Yellow
Snmpxmon2.icmpColor: Gray
Snmpxmon2.linkColor: Yellow
Snmpxmon2.lanColor: Orange
Snmpxmon2.ringColor: SkyBlue
Snmpxmon2.peerIcon: on
Snmpxmon2.primIcon: on
Snmpxmon2.doGrid: False
Snmpxmon2.showGrid: False
Snmpxmon2.gridSpacing: 10
Snmpxmon2.gridColor: White
Snmpxmon2.linkLineWidth: 2
Snmpxmon2.lanLineWidth: 3
Snmpxmon2.ringLineWidth: 1

CONFIGURATION FILE

The snmpxmon2 configuration file contains statements specifying things such as the display positions for primitive entities, the relationships between networks and primitive entities, etc.  The contents of the configuration file are described below.  To modify the contents of the configuration, the use of, xmon2cfg, a special editing tool created for that purpose, is recommended.  snmpxmon2 makes no distinction between upper and lower case letters when it interprets the keywords in the configuration file.  The distinction between upper and lower case is significant, however, in the parameters that follow the keywords.  Lines beginning with the # character, followed immediately by a space or tab and then other characters, are interpreted as comments.  In addition, if a line contains a space or tab followed by the character # and another space or tab, any characters that follow the # are considered comments.  (These special rules are necessary because some parameters begin with the # character.)  Note that lines simply beginning with the # character are not interpreted as comments. All names (network names, primitive entity names, community names, etc.)  must begin with a letter of the alphabet.  Names may not include space characters.  IP addresses must be listed completely and in dot notation.  Specifying only the network address or the locally allocated address is incorrect.  The configuration file may contain the following items. 

(1) Primitive entity definitions
RIMENT name { icmponly | pcomm [ tcomm ] } if1 if2 if3 ...  The keyword PRIMENT defines a primitive entity. There is no distinction between end systems and intermediate systems regarding primitive entities. name specifies the name of the primitive entity.  pcomm specifies the name of the community.  Immediately following the community name pcomm, a trap community name may be specified as tcomm.  If no trap community name is specified, snmpxmon2 will ignore all trap messages from the primitive entity.  Specifying icmponly ensures that all polling of the primitive entity use ICMP.  The interfaces of the primitive entity name are specified as if1 if2 if3 ... Interface names should be specified either as IP addresses or as interface numbers.  (Interface numbers are specified by the character # followed by the number.  For example, “#1” indicates interface 1.)  IP addresses and interface numbers may be mixed on the same line. 
snmpxmon2 uses the IP addresses specified for ICMP polling and for receiving trap messages.  It is recommended that interfaces be listed as IP addresses rather than interface numbers. 
The interfaces defined in this manner are used to display the network connection status. If an interface which is not used for displaying the network connection status is listed, snmpxmon2 will ignore it. All primitive entities (PRIMENT, ISENT, ESENT) must be defined before networks (WAN, LAN, RING) and real links (SLINK).

(2) Intermediate system definitions
ISENT name { icmponly | pcomm [ tcomm ] } if1 if2 if3 ...  The keyword ISENT defines an intermediate system. In the present version, there is no difference between ISENT and PRIMENT. The parameters are also identical to those described for (1) above.

(3) End system definitions
ESENT name { icmponly | pcomm [ tcomm ] } if1 if2 if3 ...  The keyword ESENT defines an intermediate system. ESENT produces a display different from ESENT and PRIMENT. The parameters are identical to those described for (1) above.

(4) Wide area network definitions
WAN name { priment1 x1 y1 | netent2 x2 } [ entities ...  ] The keyword WAN defines a wide area network. After the listing of the name of the wide area network (name), the primitive entities and networks belonging to it (connected to it) are specified. 

(a) Primitive entity listings
The name of the primitive entity, priment1, is followed by its display coordinates (x1 y1). 

(b) Network listings
The name of the network, netent2, is followed by its display coordinates (x2 y2).  After this, the name of the gateway (priment2) to the network (netent2) and the interface (if2) from the gateway to the wide area network must be specified. 

The keyword WAN may be followed by multiple entities entries, whether primitive entities or networks.  Each is listed as another entry in the form of (a) or (b) above.  Before defining gateways between wade area networks and other networks, the networks in question must be defined as belonging to the networks to which they are connected.

(5) Local area network definitions
LAN name xl1 yl1 xl2 yl2 { priment1 x1 y1 if1 | netent2 } [ entities ...  ] The keyword LAN defines a local area network. Following the name of the local area network (name) come coordinates specifying
 where the straight lines of the LAN are to be displayed (xl1 yl1 xl2 yl2) and listings of primitive entities or other networks belonging to (connected to) the LAN.  Primitive entities and networks are listed as described in (4) above. 

(6) Ring type local area network definitions
RING name xr yr r { priment1 x1 y1 if1 | netent2 } [ entities ...  ] The keyword RING defines a ring type local area network. Following the name of the local area network (name) come coordinates specifying the where the center of the ring representing the LAN are to be displayed (xr yr) and its radius (r), as well as r.  Listings of primitive entities or other networks belonging to (connected to) the LAN.  Primitive entities and networks are listed as described in (4) above. 

(7) Serial link definitions
SLINK priment1 if1 priment2 if2 This type of entry defines a serial link between two primitive entities, priment1 and priment2.  The interfaces of the connected primitive entities are listed as if1 and if2.  Serial link definitions (SLINK) must be made after all of the primitive entity definitions (PRIMENT, ISENT, ESENT) and before the network definitions (WAN, LAN, RING).

(8) Polling interval definition
INTERVAL interval The polling interval is specified as a number of seconds (interval). 

(9) Logfile definition
LOG logfile loglevel The name of the logfile is defined by logfile and the log level by loglevel.  There are four possible log levels: (1) states are recorded whenever there is a change in the state of a primitive entity; (2) states are recorded regardless of whether or not there is a change in the state of a primitive entity; (3) polling processes and SNMP packets sent and received are recorded; and, (4) ICMP packets sent and received are recorded.  loglevel should be specified as a number enclosed in parentheses.  Note that loglevel n includes log levels 1, 2 ... n.  Also, the logfile owner is “root”. 

(10) Trapfile definition
TRAPFILE logfile The name of the trapfile is defined by logfile.  The trap logfile is recorded in the same format as snmptrapd.  Also, the trap logfile owner is “root”. 

(11) Route metric monitor configuration file definition
ROUTECF configfile The snmpxrtmetric and ripxrtmetric configuration files are defined by configfile. 

(12) Option definitions
OPTIONS opt1 [ opt2 ] The following two options can be set in the configuration file. If an option begins with the character − it is not valid.  If an option is specified more than once, the last listing is the one that is followed. 

bell/−bellA bell sounds when the status of a primitive entity changes. 

status/−statusThe status of each primitive entity is displayed on a status line (below the network name). 

(13) Minimum polling interval definition
MINPOLL interval This definition sets the minimum polling interval in seconds (interval). 

(14) Maximum number of polling attempts
MAXSNMPPOLL times This definition sets the maximum number of polling attempts (times).  If no response is received from a primitive device after times number of polling attempts using SNMP, a query is attempted using ICMP.  Up to a maximum of polling attempts can be attempted using ICMP. 

(15) Top level network definition
TOPLEVEL netent The first network displayed after snmpxmon2 is started (the toplevel network) is specified using netent.  netent should be the name of a network which has been defined using the keyword WAN, LAN or RING.  If more than one TOPLEVEL definition is made, only the last one will valid.  TOPLEVEL must be defined after all of the network definitions (WAN, LAN, RING).

BUGS

If the polling interval or minimum polling interval value is very small, attempts by snmpxmon2 to poll primitive entities may end up switching to ICMP before the previous SNMP query is complete.  This will result in repeated cycles of the status being reported, alternately, as “no response to SNMP or ICMP” and “response to ICMP only”.  Therefore, a good rule of thumb is to allot a polling interval of approximately one second for each primitive entity.  As a specific example, if there are 50 primitive entities, the polling interval and minimum polling interval should both be set no lower than 50 seconds.  snmpxmon2 and snmptrapd may not both be run simultaneously on a single machine.  The logfile and trap logfile owner is “root”. There may be cases in which changes to the display may not be clear on monochrome displays. The use of a color display is recommended.

FILES

/etc/snmp.variables
/usr/sony/doc/SNMP
/usr/lib/X11/app-defaults/Snmpxmon2
/usr/lib/X11/ja_JP.SJIS/app-defaults/Snmpxmon2
/usr/lib/X11/ja_JP.EUC/app-defaults/Snmpxmon2

SEE ALSO

nfsmon(1), ripxrtmetric(1), telnet(1), snmpsrc(1), snmplookup(1), snmpxbar(1), snmpxperf(1), snmpxperfmon(1), traceroute(1), xmon2cfg(1), ping(8). 

REFERENCES

J.D. Case, J.R. Davin, M.S. Fedor, M.L. Schoffstall, Simple Network Management Protocol, Request for Comments 1157, Network Information Center, SRI International, Menlo Park, California, May, 1990.  M.T. Rose, K. McCloghrie, Structure of Management Information, Request for Comments 1155, Network Information Center, SRI International, Menlo Park, California, May, 1990.  K. McCloghrie, M.T. Rose, Management Information Base, Request for Comments 1156, Network Information Center, SRI International, Menlo Park, California, May, 1990.  M.T. Rose, Editor Management Information Base: MIB-II, Request for Comments 1158, Network Information Center, SRI International, Menlo Park, California, May, 1990. 

NEWS-OSRelease 4.2.1R