1 .\" /***********************************************************
2 .\" Copyright 1988, 1989 by Carnegie Mellon University
4 .\" All Rights Reserved
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.
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
21 .\" ******************************************************************/
22 .TH SNMPTRANSLATE 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
25 snmptranslate - translate SNMP OID values into more useful information
28 [OPTIONS] OID [OID]...
31 is an application that translates one or more SNMP object identifier
32 values from their symbolic (textual) forms into their numerical forms
33 (or vice versa). With no options, an SNMP OID value will be
34 translated from its symbolic form to its numerical form.
38 Turn on debugging output for the given
42 for extremely verbose output.
45 Display a brief usage message and then exit.
48 Specifies a colon separated list of MIB modules to load for this
49 application. This overrides the environment variable MIBS.
53 is used to specify all modules in all directories when searching for MIB
54 files. Every file whose name does not begin with "." will be parsed as
55 if it were a MIB file.
58 Specifies a colon separated list of directories to search for MIBs.
59 This overrides the environment variable MIBDIRS.
62 Provides control over the translation of the OID values. The
69 Print full details of the specified OID.
72 Print a graphical tree, rooted at the specified OID.
75 Dump the loaded MIB in a trivial form.
78 Dump a labeled form of all objects.
81 Dump a numeric form of all objects.
84 Dump a symbolic form of all objects.
87 Dump a tree form of the loaded MIBs (mostly useful for debugging).
91 Display version information for the application and then exit.
94 Specifies the width of
98 output. The default is very large.
100 In addition to the above options,
108 options described in the
109 .BR "INPUT OPTIONS" ", " "MIB PARSING OPTIONS" " and " "OUTPUT OPTIONS"
115 snmptranslate -On -IR sysDescr
117 will translate "sysDescr" to a more qualified form:
121 snmptranslate -Onf -IR sysDescr
123 will translate "sysDecr" to:
125 .RI .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
127 snmptranslate -Td -OS system.sysDescr
129 will translate "sysDecr" into:
135 -- TEXTUAL CONVENTION DisplayString
136 SYNTAX OCTET STRING (0..255)
140 DESCRIPTION "A textual description of the entity. This
141 value should include the full name and
142 version identification of the system's
143 hardware type, software operating-system,
144 and networking software."
145 ::= { iso(1) org(3) dod(6) internet(1) mgmt(2) mib-2(1) system(1) 1 }
148 snmptranslate -Tp -OS system
150 will print the following tree:
155 +-- -R-- String sysDescr(1)
156 | Textual Convention: DisplayString
158 +-- -R-- ObjID sysObjectID(2)
159 +-- -R-- TimeTicks sysUpTime(3)
160 +-- -RW- String sysContact(4)
161 | Textual Convention: DisplayString
163 +-- -RW- String sysName(5)
164 | Textual Convention: DisplayString
166 +-- -RW- String sysLocation(6)
167 | Textual Convention: DisplayString
169 +-- -R-- Integer sysServices(7)
170 +-- -R-- TimeTicks sysORLastChange(8)
171 | Textual Convention: TimeStamp
177 +-- ---- Integer sysORIndex(1)
178 +-- -R-- ObjID sysORID(2)
179 +-- -R-- String sysORDescr(3)
180 | Textual Convention: DisplayString
182 +-- -R-- TimeTicks sysORUpTime(4)
183 Textual Convention: TimeStamp
188 snmptranslate -Ta | head
190 will produce the following dump:
193 dump DEFINITIONS ::= BEGIN
196 internet ::= { dod 1 }
197 directory ::= { internet 1 }
198 mgmt ::= { internet 2 }
199 experimental ::= { internet 3 }
200 private ::= { internet 4 }
201 security ::= { internet 5 }
202 snmpV2 ::= { internet 6 }
206 snmptranslate -Tl | head
208 will produce the following dump:
212 .RI .iso(1).org(3).dod(6)
213 .RI .iso(1).org(3).dod(6).internet(1)
214 .RI .iso(1).org(3).dod(6).internet(1).directory(1)
215 .RI .iso(1).org(3).dod(6).internet(1).mgmt(2)
216 .RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1)
217 .RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1)
218 .RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysDescr(1)
219 .RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysObjectID(2)
220 .RI .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysUpTime(3)
224 snmptranslate -To | head
226 will produce the following dump
242 snmptranslate -Ts | head
244 will produce the following dump
249 .RI .iso.org.dod.internet
250 .RI .iso.org.dod.internet.directory
251 .RI .iso.org.dod.internet.mgmt
252 .RI .iso.org.dod.internet.mgmt.mib-2
253 .RI .iso.org.dod.internet.mgmt.mib-2.system
254 .RI .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
255 .RI .iso.org.dod.internet.mgmt.mib-2.system.sysObjectID
256 .RI .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime
260 snmptranslate -Tt | head
262 will produce the following dump
272 sysDescr(1) type=2 tc=4 hint=255a
273 sysObjectID(2) type=1
277 snmpcmd(1), variables(5), RFC 2578-2580.