userapps/opensource/net-snmp/man/snmpbulkget.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 SNMPBULKGET 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
  23 .UC 4
  24 .SH NAME
  25 snmpbulkget - communicates with a network entity using SNMP GETBULK Requests.
  26 .SH SYNOPSIS
  27 .B snmpbulkget
  28 [APPLICATION OPTIONS] [COMMON OPTIONS] OID [OID]...
  29 .SH DESCRIPTION
  30 .B snmpbulkget
  31 is an SNMP application that uses the SNMP GETBULK request to query a
  32 network entity efficiently for information.  One or more object
  33 identifiers (OIDs) may be given as arguments on the command line.
  34 Each variable name is given in the format specified in
  35 .IR variables(5) .
  36 .PP
  37 If the network entity has an error processing the request packet, an
  38 error packet will be returned and a message will be shown, helping to
  39 pinpoint why the request was malformed.
  40 .SH OPTIONS
  41 .TP 8
  42 .BI -Cn <NUM>
  43 Set the
  44 .I non-repeaters
  45 field in the GETBULK PDU.  This specifies the number of supplied
  46 variables that should not be iterated over.  The default is 0.
  47 .TP
  48 .BI -Cr <NUM>
  49 Set the
  50 .I max-repetitions
  51 field in the GETBULK PDU.  This specifies the maximum number of
  52 iterations over the repeating variables.  The default is 10.
  53 .PP
  54 In addition to these options,
  55 .B snmpbulkget
  56 takes the common options described in the
  57 .I snmpcmd(1)
  58 manual page.
  59 .SH EXAMPLE
  60 The command:
  61 .PP
  62 snmpbulkget -v2c -Cn1 -Cr5 -Os -c public zeus system ifTable
  63 .PP
  64 will retrieve the variable system.sysDescr.0 (which is the
  65 lexicographically next object to system) and the first 5 objects in
  66 the ifTable:
  67 .PP
  68 sysDescr.0 = STRING: "SunOS zeus.net.cmu.edu 4.1.3_U1 1 sun4m"
  69 .br
  70 ifIndex.1 = INTEGER: 1
  71 .br
  72 ifIndex.2 = INTEGER: 2
  73 .br
  74 ifDescr.1 = STRING: "lo0"
  75 .br
  76 et cetera.
  77 .SH NOTE
  78 As the name implies,
  79 .B snmpbulkget
  80 utilizes the SNMP GETBULK message, which is not available in SNMPv1.
  81 .SH "SEE ALSO"
  82 snmpcmd(1), variables(5), RFC 1905.