manual/ucd-snmp/original/man1/snmpwalk.1

   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 SNMPWALK 1 "21 Jun 2001"
  23 .UC 4
  24 .SH NAME
  25 snmpwalk - communicates with a network entity using SNMP GET Next Requests.
  26 .SH SYNOPSIS
  27 snmpwalk [common arguments] [-C APPOPTS] [objectID]
  28 .SH DESCRIPTION
  29 Snmpwalk is an SNMP application that uses GET NEXT Requests to query for a tree
  30 of information about a network entity.
  31 .PP
  32 A variable may also be given on the
  33 command line.  This variable specifies which portion of the object identifier
  34 space will be searched using GET NEXT Requests.  All variables in the subtree
  35 below the given variable are queried and their values presented to the user.
  36 Each variable name is given in the format specified in
  37 .IR variables (5).
  38 .PP
  39 If the "objectID" argument is not present, snmpwalk will search MIB-2.
  40 .PP
  41 For example
  42 .PP
  43 .I snmpwalk zeus public system
  44 .PP
  45 will retrieve all of the variables under system:
  46 .PP
  47 .I system.sysDescr.0 =
  48 "SunOS zeus.net.cmu.edu 4.1.3_U1 1 sun4m"
  49 .br
  50 .I system.sysObjectID.0 = OID: enterprises.hp.nm.hpsystem.10.1.1
  51 .br
  52 .I "system.sysUpTime.0 = Timeticks: (155274552) 17 days, 23:19:05"
  53 .br
  54 .I system.sysContact.0 =
  55 ""
  56 .br
  57 .I system.sysName.0 =
  58 "zeus.net.cmu.edu"
  59 .br
  60 .I system.sysLocation.0 =
  61 ""
  62 .br
  63 .I system.sysServices.0 = 72
  64 .PP
  65 If the network entity has an error processing the request packet, an error
  66 packet will be returned and a message will be shown, helping to pinpoint why
  67 the request was malformed.
  68 .PP
  69 If the tree search causes attempts to search beyond the end of the MIB,
  70 a message will be displayed:
  71 .PP
  72 .I End of MIB.
  73 .PP
  74 .SH "OPTIONS"
  75 In addition to the arguments defined in the snmpcmd(1) manual page,
  76 the following options are supported as well:
  77 .IP "-Ci"
  78 Includes the requested oid in the search range.  Normally snmpwalk
  79 uses getnexts starting with the oid you request and returns all
  80 results in the MIB tree below the one you requested.  Sometimes, you
  81 may wish to include the OID specified on the command line in the
  82 printed results if it is a valid OID in the tree itself.  This option
  83 lets you do this.
  84 .IP "-Cp"
  85 Upon completion, snmpwalk will print the number of variables found
  86 during the walk.
  87 .IP "-Cc"
  88 Don't Check whether the returned OID's are increasing.  Some agents
  89 (LaserJets are an example) returns OID's out of order, but can
  90 complete the walk anyway.  Other agent's return OIDs that are out of
  91 order and can cause snmpwalk to loop infinitely until stopped.  By
  92 default, snmpwalk tries to detect this behavior and warns you when it
  93 hits an agent acting illegally.  Use -Cc to turn off this behavior.
  94 .SH "SEE ALSO"
  95 snmpcmd(1), variables(5).