userapps/opensource/net-snmp/man/snmpwalk.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 SNMPWALK 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
  23 .UC 4
  24 .SH NAME
  25 snmpwalk - communicates with a network entity using SNMP GETNEXT requests.
  26 .SH SYNOPSIS
  27 .B snmpwalk
  28 [APPLICATION OPTIONS] [COMMON OPTIONS] [OID]
  29 .SH DESCRIPTION
  30 .B snmpwalk
  31 is an SNMP application that uses SNMP GETNEXT requests to query a
  32 network entity for a tree of information.
  33 .PP
  34 An object identifier (OID) may be given on the command line.  This OID
  35 specifies which portion of the object identifier space will be
  36 searched using GETNEXT requests.  All variables in the subtree
  37 below the given OID are queried and their values presented to the user.
  38 Each variable name is given in the format specified in
  39 .IR variables(5) .
  40 .PP
  41 If no OID argument is present,
  42 .B snmpwalk
  43 will search MIB-2.
  44 If the network entity has an error processing the request packet, an
  45 error packet will be returned and a message will be shown, helping to
  46 pinpoint why the request was malformed.
  47 .PP
  48 If the tree search causes attempts to search beyond the end of the
  49 MIB, the message "End of MIB" will be displayed.
  50 .SH OPTIONS
  51 .TP 8
  52 .B -Cc
  53 Do not check whether the returned OIDs are increasing.  Some agents
  54 (LaserJets are an example) return OIDs out of order, but can
  55 complete the walk anyway.  Other agents return OIDs that are out of
  56 order and can cause
  57 .B snmpwalk
  58 to loop indefinitely.  By default,
  59 .B snmpwalk
  60 tries to detect this behavior and warns you when it hits an agent
  61 acting illegally.  Use
  62 .B -Cc
  63 to turn off this behaviour.
  64 .TP
  65 .B -Ci
  66 Include the given OID in the search range.  Normally
  67 .B snmpwalk
  68 uses GETNEXT requests starting with the OID you specified and returns
  69 all results in the MIB tree after that OID.  Sometimes, you may wish
  70 to include the OID specified on the command line in the printed
  71 results if it is a valid OID in the tree itself.  This option lets you
  72 do this.
  73 .TP
  74 .B -Cp
  75 Upon completion of the walk, print the number of variables found.
  76 .PP
  77 In addition to these options,
  78 .B snmpwalk
  79 takes the common options described in the
  80 .I snmpcmd(1)
  81 manual page.
  82 .SH EXAMPLE
  83 The command:
  84 .PP
  85 snmpwalk -Os -c public -v 1 zeus system
  86 .PP
  87 will retrieve all of the variables under system:
  88 .PP
  89 sysDescr.0 = STRING: "SunOS zeus.net.cmu.edu 4.1.3_U1 1 sun4m"
  90 .br
  91 sysObjectID.0 = OID: enterprises.hp.nm.hpsystem.10.1.1
  92 .br
  93 sysUpTime.0 = Timeticks: (155274552) 17 days, 23:19:05
  94 .br
  95 sysContact.0 = STRING: ""
  96 .br
  97 sysName.0 = STRING: "zeus.net.cmu.edu"
  98 .br
  99 sysLocation.0 = STRING: ""
 100 .br
 101 sysServices.0 = INTEGER: 72
 102 .SH "SEE ALSO"
 103 snmpcmd(1), snmpbulkwalk(1), variables(5).