man pages section 1: User Commands

snmpstatus(1)

Name

snmpstatus– retrieve important information from a network entity

Synopsis

/usr/sfw/bin/snmpstatus [common options] [-Cf] agent

Description

The snmpstatus command is an SNMP application that retrieves several important statistics from a network entity.

The agent operand identifies a target SNMP agent, which is instrumented to monitor specified objects. At its simplest, the agent specification consists of a host name or an IPv4 address. In this situation, the command attempts communication with the agent using UDP/IPv4 to port 161 of the target host.

See the snmpcmd(1M) manual page for a full list of the possible formats for agent.

snmpstatus returns the following information:

the IP address of the entity
a textual description of the entity (sysDescr.0)
the uptime of the entity's SNMP agent (sysUpTime.0)
the sum of received packets on all interfaces (ifInUCastPkts.* + ifInNUCastPkts.*)
the sum of transmitted packets on all interfaces (ifOutUCastPkts.* + ifOutNUCastPkts.*)
the number of IP input packets (ipInReceives.0)
the number of IP output packets (ipOutRequests.0)

For example, the command:

% snmpstatus -c public -v 1 netdev-kbox.cc.cmu.edu

produces output similar to the following:

[128.2.56.220]=>[Kinetics FastPath2] Up: 1 day, 4:43:31
Interfaces: 1, Recv/Trans packets: 262874/39867 | IP: 31603/15805

snmpstatus also checks the operational status of all interfaces (ifOperStatus.*). If it finds any that are not running, it reports themin a manner similar to this:

2 interfaces are down!

If the network entity has an error processing the request packet, an error packet is returned and a message is displayed, helping to pinpoint the way in which the request was malformed. snmpstatus will attempt to reform its request to eliminate the malformed variable (unless the -Cf option is given, see below), but this variable will then be missing from the displayed data.

Options

The following options are supported:

common options: See snmpcmd(1M) for a list of possible values for common options, as well as their descriptions.
-Cf: By default, snmpstatus will try to fix errors returned by the agent and retry a request. With this option, the command will display the data that it can. snmpstatus will not try to fix errors and an error will cause the command to terminate.

Exit Status

0: Successful completion.
1: A usage syntax error. A usage message is displayed. Also used for timeout errors.
2: An error occurred while executing the command. An error message is displayed.

Attributes

See attributes(5) for descriptions of the following attributes:

`ATTRIBUTE TYPE`	`ATTRIBUTE VALUE`
Availability	SUNWsmcmd
Interface Stability	External