userapps/opensource/net-snmp/man/snmpstatus.1.def

   1 .\" /***********************************************************
   2 .\"     Copyright 1988, 1989 by Carnegie Mellon University
   3 .\"
   4 .\"                       All Rights Reserved
   5 .\"
   6 .\" Permission to use, copy, modify, and distribute this software and its
   7 .\" documentation for any purpose and without fee is hereby granted,
   8 .\" provided that the above copyright notice appear in all copies and that
   9 .\" both that copyright notice and this permission notice appear in
  10 .\" supporting documentation, and that the name of CMU not be
  11 .\" used in advertising or publicity pertaining to distribution of the
  12 .\" software without specific, written prior permission.
  13 .\"
  14 .\" CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  15 .\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  16 .\" CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  17 .\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  18 .\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  19 .\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  20 .\" SOFTWARE.
  21 .\" ******************************************************************/
  22 .TH SNMPSTATUS 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
  23 .UC 4
  24 .SH NAME
  25 snmpstatus - Retrieves important information from a network entity.
  26 .SH SYNOPSIS
  27 .B snmpstatus
  28 [COMMON OPTIONS]
  29 .SH DESCRIPTION
  30 .B snmpstatus
  31 is an SNMP application that retrieves several important statistics
  32 from a network entity.
  33 .PP
  34 The information returned is:
  35 .IP
  36 The IP address of the entity.
  37 .br
  38 A textual description of the entity (sysDescr.0)
  39 .br
  40 The uptime of the entity's SNMP agent (sysUpTime.0)
  41 .br
  42 The sum of received packets on all interfaces
  43 (ifInUCastPkts.* + ifInNUCastPkts.*)
  44 .br
  45 The sum of transmitted packets on all interfaces
  46 (ifOutUCastPkts.* + ifOutNUCastPkts.*)
  47 .br
  48 The number of IP input packets (ipInReceives.0)
  49 .br
  50 The number of IP output packets (ipOutRequests.0)
  51 .PP
  52 For example:
  53 .PP
  54 snmpstatus -c public -v 1 netdev-kbox.cc.cmu.edu
  55 .PP
  56 will produce output similar to the following:
  57 .PP
  58 [128.2.56.220]=>[Kinetics FastPath2] Up: 1 day, 4:43:31
  59 .br
  60 Interfaces: 1,  Recv/Trans packets: 262874/39867 |
  61 IP: 31603/15805
  62 .PP
  63 .B snmpstatus
  64 also checks the operational status of all interfaces (ifOperStatus.*),
  65 and if it finds any that are not running, it will report in a manner
  66 similar to this:
  67 .PP
  68 2 interfaces are down!
  69 .PP
  70 If the network entity has an error processing the request packet, an
  71 error packet will be returned and a message will be shown, helping to
  72 pinpoint in what way the request was malformed.
  73 .B snmpstatus
  74 will attempt to reform its request to eliminate the malformed
  75 variable (unless the
  76 .B -Cf
  77 option is given, see below), but this variable will then be missing
  78 from the displayed data.
  79 .PP
  80 .SH OPTIONS
  81 .B snmpstatus
  82 takes the common options described in the
  83 .I snmpcmd(1)
  84 manual page and
  85 also the
  86 .B -Cf
  87 option described in the
  88 .I snmpget(1)
  89 manual page.
  90 .SH "SEE ALSO"
  91 snmpcmd(1), snmpget(1)