~ubuntu-branches/ubuntu/gutsy/net-snmp/gutsy-security

« back to all changes in this revision

Viewing changes to man/snmpbulkwalk.1.def

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2004-09-13 12:06:21 UTC
  • Revision ID: james.westby@ubuntu.com-20040913120621-g952ntonlleihcvm
Tags: upstream-5.1.1
ImportĀ upstreamĀ versionĀ 5.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 SNMPBULKWALK 1 "17 Jun 1998" "" "Net-SNMP"
 
23
.UC 4
 
24
.SH NAME
 
25
snmpbulkwalk - communicates with a network entity using SNMP BULK Requests.
 
26
.SH SYNOPSIS
 
27
.B snmpbulkwalk
 
28
[APPLICATION OPTIONS] [COMMON OPTIONS] [OID]
 
29
.SH DESCRIPTION
 
30
.B snmpbulkwalk
 
31
is an SNMP application that uses SNMP GETBULK requests to query a
 
32
network entity efficiently 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 GETBULK requests.  All variables in the subtree below
 
37
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
If no OID argument is present,
 
41
.B snmpbulkwalk
 
42
will search MIB-2.
 
43
.PP
 
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 snmpbulkwalk
 
58
to loop indefinitely.  By default,
 
59
.B snmpbulkwalk
 
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 snmpbulkwalk
 
68
uses GETBULK 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
.BI -Cn <NUM>
 
75
Set the
 
76
.I non-repeaters
 
77
field in the GETBULK PDUs.  This specifies the number of supplied
 
78
variables that should not be iterated over.  The default is 0.
 
79
.TP
 
80
.B -Cp
 
81
Upon completion of the walk, print the number of variables found.
 
82
.TP
 
83
.BI -Cr <NUM>
 
84
Set the
 
85
.I max-repetitions
 
86
field in the GETBULK PDUs.  This specifies the maximum number of
 
87
iterations over the repeating variables.  The default is 10.
 
88
.PP
 
89
In addition to these options,
 
90
.B snmpbulkwalk
 
91
takes the common options described in the 
 
92
.I snmpcmd(1)
 
93
manual page.
 
94
.SH EXAMPLE
 
95
The command:
 
96
.PP
 
97
snmpbulkwalk -v2c -Os -c public zeus system
 
98
.PP
 
99
will retrieve all of the variables under system:
 
100
.PP
 
101
sysDescr.0 = STRING: "SunOS zeus.net.cmu.edu 4.1.3_U1 1 sun4m"
 
102
.br
 
103
sysObjectID.0 = OID: enterprises.hp.nm.hpsystem.10.1.1
 
104
.br
 
105
sysUpTime.0 = Timeticks: (155274552) 17 days, 23:19:05
 
106
.br
 
107
sysContact.0 = STRING: ""
 
108
.br
 
109
sysName.0 = STRING: "zeus.net.cmu.edu"
 
110
.br
 
111
sysLocation.0 = STRING: ""
 
112
.br
 
113
sysServices.0 = INTEGER: 72
 
114
.PP
 
115
In contrast to
 
116
.BR snmpwalk ,
 
117
this information will typically be gathered in a single transaction
 
118
with the agent, rather than one transaction per variable found.
 
119
.B snmpbulkwalk
 
120
is thus more efficient in terms of network utilisation, which may be
 
121
especially important when retrieving large tables.
 
122
.SH NOTE
 
123
As the name implies,
 
124
.B snmpbulkwalk
 
125
utilizes the SNMP GETBULK message, which is not available in SNMP v1.
 
126
.SH "SEE ALSO"
 
127
snmpcmd(1), variables(5).