← Back to branch summary

~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/snmptranslate.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:
man/snmptranslate.1.def
 
1
.\" Portions of this file are subject to the following copyright.  See
 
2
.\" the Net-SNMP's COPYING file for more details and other copyrights
 
3
.\" that may apply:
 
4
.\" /***********************************************************
 
5
.\"     Copyright 1988, 1989 by Carnegie Mellon University
 
6
.\" 
 
7
.\"                       All Rights Reserved
 
8
.\" 
 
9
.\" Permission to use, copy, modify, and distribute this software and its 
 
10
.\" documentation for any purpose and without fee is hereby granted, 
 
11
.\" provided that the above copyright notice appear in all copies and that
 
12
.\" both that copyright notice and this permission notice appear in 
 
13
.\" supporting documentation, and that the name of CMU not be
 
14
.\" used in advertising or publicity pertaining to distribution of the
 
15
.\" software without specific, written prior permission.  
 
16
.\" 
 
17
.\" CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
 
18
.\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
 
19
.\" CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
 
20
.\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 
21
.\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
 
22
.\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 
23
.\" SOFTWARE.
 
24
.\" ******************************************************************/
 
25
.\" Portions of this file are copyrighted by:
 
26
.\" Copyright Copyright 2003 Sun Microsystems, Inc. All rights reserved.
 
27
.\" Use is subject to license terms specified in the COPYING file
 
28
.\" distributed with the Net-SNMP package.
 
29
.\" ******************************************************************/
 
30
.TH SNMPTRANSLATE 1 "25 Jul 2003" VVERSIONINFO "Net-SNMP"
 
31
.UC 4
 
32
.SH NAME
 
33
snmptranslate - translate SNMP OID values into more useful information
 
34
.SH SYNOPSIS
 
35
.B snmptranslate
 
36
[OPTIONS] OID [OID]...
 
37
.SH DESCRIPTION
 
38
.B snmptranslate
 
39
is an application that translates one or more SNMP object identifier
 
40
values from their symbolic (textual) forms into their numerical forms
 
41
(or vice versa).  
 
42
.PP
 
43
OID is either a numeric or textual object identifier.
 
44
.SH OPTIONS
 
45
.TP 8
 
46
.B -D \fITOKEN[,...]
 
47
Turn on debugging output for the given
 
48
.IR "TOKEN" "(s)."
 
49
Try
 
50
.IR ALL
 
51
for extremely verbose output.
 
52
.TP
 
53
.B -h
 
54
Display a brief usage message and then exit.
 
55
.TP
 
56
.BI -m " MIBLIST"
 
57
Specifies a colon separated list of MIB modules to load for this
 
58
application.  This overrides the environment variable MIBS.
 
59
.IP
 
60
The special keyword
 
61
.I ALL
 
62
is used to specify all modules in all directories when searching for MIB
 
63
files.  Every file whose name does not begin with "." will be parsed as
 
64
if it were a MIB file.
 
65
.TP
 
66
.BI -M " DIRLIST"
 
67
Specifies a colon separated list of directories to search for MIBs.
 
68
This overrides the environment variable MIBDIRS.
 
69
.TP
 
70
.BI -T " TRANSOPTS"
 
71
Provides control over the translation of the OID values.  The
 
72
following
 
73
.I TRANSOPTS
 
74
are available:
 
75
.RS
 
76
.TP 6
 
77
.B \-Td
 
78
Print full details of the specified OID.
 
79
.TP
 
80
.B \-Tp
 
81
Print a graphical tree, rooted at the specified OID.
 
82
.TP
 
83
.B \-Ta
 
84
Dump the loaded MIB in a trivial form.
 
85
.TP
 
86
.B \-Tl
 
87
Dump a labeled form of all objects.
 
88
.TP
 
89
.B \-To
 
90
Dump a numeric form of all objects.
 
91
.TP
 
92
.B \-Ts
 
93
Dump a symbolic form of all objects.
 
94
.TP
 
95
.B \-Tt
 
96
Dump a tree form of the loaded MIBs (mostly useful for debugging).
 
97
.RE
 
98
.TP
 
99
.B -V
 
100
Display version information for the application and then exit.
 
101
.TP
 
102
.BI -w " WIDTH"
 
103
Specifies the width of
 
104
.B -Tp
 
105
and
 
106
.B -Td
 
107
output. The default is very large.
 
108
.PP
 
109
In addition to the above options, 
 
110
.B snmptranslate
 
111
takes the OID input 
 
112
.RB ( -I ),
 
113
MIB parsing
 
114
.RB ( -M )
 
115
and OID output
 
116
.RB ( -O )
 
117
options described in the 
 
118
.BR "INPUT OPTIONS" ", " "MIB PARSING OPTIONS" " and " "OUTPUT OPTIONS"
 
119
sections of the
 
120
.I snmpcmd(1) 
 
121
manual page.
 
122
.SH EXAMPLES
 
123
.IP \(bu 4
 
124
snmptranslate -On -IR sysDescr
 
125
.br
 
126
will translate "sysDescr" to a more qualified form:
 
127
.IP
 
128
system.sysDescr
 
129
.IP \(bu 4
 
130
snmptranslate -Onf -IR sysDescr
 
131
.br
 
132
will translate "sysDecr" to:
 
133
.IP
 
134
.RI .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
 
135
.IP \(bu 4 
 
136
snmptranslate -Td -OS system.sysDescr
 
137
.br
 
138
will translate "sysDecr" into:
 
139
.IP
 
140
.nf
 
141
SNMPv2-MIB::sysDescr
 
142
sysDescr OBJECT-TYPE
 
143
  -- FROM SNMPv2-MIB
 
144
  -- TEXTUAL CONVENTION DisplayString
 
145
  SYNTAX OCTET STRING (0..255)
 
146
  DISPLAY-HINT "255a"
 
147
  MAX-ACCESS read-only
 
148
  STATUS current
 
149
  DESCRIPTION "A textual description of the entity. This
 
150
               value should include the full name and
 
151
               version identification of the system's
 
152
               hardware type, software operating-system,
 
153
               and networking software."
 
154
::= { iso(1) org(3) dod(6) internet(1) mgmt(2) mib-2(1) system(1) 1 }
 
155
.fi
 
156
.IP \(bu 4 
 
157
snmptranslate -Tp -OS system
 
158
.br
 
159
will print the following tree:
 
160
.IP
 
161
.nf
 
162
+--system(1)
 
163
   |
 
164
   +-- -R-- String    sysDescr(1)
 
165
   |        Textual Convention: DisplayString
 
166
   |        Size: 0..255
 
167
   +-- -R-- ObjID     sysObjectID(2)
 
168
   +-- -R-- TimeTicks sysUpTime(3)
 
169
   +-- -RW- String    sysContact(4)
 
170
   |        Textual Convention: DisplayString
 
171
   |        Size: 0..255
 
172
   +-- -RW- String    sysName(5)
 
173
   |        Textual Convention: DisplayString
 
174
   |        Size: 0..255
 
175
   +-- -RW- String    sysLocation(6)
 
176
   |        Textual Convention: DisplayString
 
177
   |        Size: 0..255
 
178
   +-- -R-- Integer   sysServices(7)
 
179
   +-- -R-- TimeTicks sysORLastChange(8)
 
180
   |        Textual Convention: TimeStamp
 
181
   |
 
182
   +--sysORTable(9)
 
183
      |
 
184
      +--sysOREntry(1)
 
185
         |
 
186
         +-- ---- Integer   sysORIndex(1)
 
187
         +-- -R-- ObjID     sysORID(2)
 
188
         +-- -R-- String    sysORDescr(3)
 
189
         |        Textual Convention: DisplayString
 
190
         |        Size: 0..255
 
191
         +-- -R-- TimeTicks sysORUpTime(4)
 
192
                  Textual Convention: TimeStamp
 
193
 
 
194
.fi
 
195
.PP
 
196
.IP \(bu 4
 
197
snmptranslate -Ta | head
 
198
.br
 
199
will produce the following dump:
 
200
.IP
 
201
.nf
 
202
dump DEFINITIONS ::= BEGIN
 
203
org ::= { iso 3 }
 
204
dod ::= { org 6 }
 
205
internet ::= { dod 1 }
 
206
directory ::= { internet 1 }
 
207
mgmt ::= { internet 2 }
 
208
experimental ::= { internet 3 }
 
209
private ::= { internet 4 }
 
210
security ::= { internet 5 }
 
211
snmpV2 ::= { internet 6 }
 
212
.fi
 
213
.PP
 
214
.IP \(bu 4
 
215
snmptranslate -Tl | head
 
216
.br
 
217
will produce the following dump:
 
218
.IP
 
219
.nf
 
220
.RI .iso(1).org(3)
 
221
.RI .iso(1).org(3).dod(6)
 
222
.RI .iso(1).org(3).dod(6).internet(1)
 
223
.RI .iso(1).org(3).dod(6).internet(1).directory(1)
 
224
.RI .iso(1).org(3).dod(6).internet(1).mgmt(2)
 
225
.RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1)
 
226
.RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1)
 
227
.RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysDescr(1)
 
228
.RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysObjectID(2)
 
229
.RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysUpTime(3)
 
230
.fi
 
231
.PP
 
232
.IP \(bu 4
 
233
snmptranslate -To | head
 
234
.br
 
235
will produce the following dump
 
236
.IP
 
237
.nf
 
238
.RI .1.3
 
239
.RI .1.3.6
 
240
.RI .1.3.6.1
 
241
.RI .1.3.6.1.1
 
242
.RI .1.3.6.1.2
 
243
.RI .1.3.6.1.2.1
 
244
.RI .1.3.6.1.2.1.1
 
245
.RI .1.3.6.1.2.1.1.1
 
246
.RI .1.3.6.1.2.1.1.2
 
247
.RI .1.3.6.1.2.1.1.3
 
248
.fi
 
249
.PP
 
250
.IP \(bu 4
 
251
snmptranslate -Ts | head
 
252
.br
 
253
will produce the following dump
 
254
.IP
 
255
.nf
 
256
.RI .iso.org
 
257
.RI .iso.org.dod
 
258
.RI .iso.org.dod.internet
 
259
.RI .iso.org.dod.internet.directory
 
260
.RI .iso.org.dod.internet.mgmt
 
261
.RI .iso.org.dod.internet.mgmt.mib-2
 
262
.RI .iso.org.dod.internet.mgmt.mib-2.system
 
263
.RI .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
 
264
.RI .iso.org.dod.internet.mgmt.mib-2.system.sysObjectID
 
265
.RI .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime
 
266
.fi
 
267
.PP
 
268
.IP \(bu 4
 
269
snmptranslate -Tt | head
 
270
.br
 
271
will produce the following dump
 
272
.IP
 
273
.nf
 
274
  org(3) type=0
 
275
    dod(6) type=0
 
276
      internet(1) type=0
 
277
        directory(1) type=0
 
278
        mgmt(2) type=0
 
279
          mib-2(1) type=0
 
280
            system(1) type=0
 
281
              sysDescr(1) type=2 tc=4 hint=255a
 
282
              sysObjectID(2) type=1
 
283
              sysUpTime(3) type=8
 
284
.fi
 
285
.SH "SEE ALSO"
 
286
snmpcmd(1), variables(5), RFC 2578-2580.