userapps/opensource/net-snmp/man/snmptranslate.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 SNMPTRANSLATE 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
  23 .UC 4
  24 .SH NAME
  25 snmptranslate - translate SNMP OID values into more useful information
  26 .SH SYNOPSIS
  27 .B snmptranslate
  28 [OPTIONS] OID [OID]...
  29 .SH DESCRIPTION
  30 .B snmptranslate
  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.
  35 .SH OPTIONS
  36 .TP 8
  37 .B -D \fITOKEN[,...]
  38 Turn on debugging output for the given
  39 .IR "TOKEN" "(s)."
  40 Try
  41 .IR ALL
  42 for extremely verbose output.
  43 .TP
  44 .B -h
  45 Display a brief usage message and then exit.
  46 .TP
  47 .BI -m " MIBLIST"
  48 Specifies a colon separated list of MIB modules to load for this
  49 application.  This overrides the environment variable MIBS.
  50 .IP
  51 The special keyword
  52 .I ALL
  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.
  56 .TP
  57 .BI -M " DIRLIST"
  58 Specifies a colon separated list of directories to search for MIBs.
  59 This overrides the environment variable MIBDIRS.
  60 .TP
  61 .BI -T " TRANSOPTS"
  62 Provides control over the translation of the OID values.  The
  63 following
  64 .I TRANSOPTS
  65 are available:
  66 .RS
  67 .TP 6
  68 .B \-Td
  69 Print full details of the specified OID.
  70 .TP
  71 .B \-Tp
  72 Print a graphical tree, rooted at the specified OID.
  73 .TP
  74 .B \-Ta
  75 Dump the loaded MIB in a trivial form.
  76 .TP
  77 .B \-Tl
  78 Dump a labeled form of all objects.
  79 .TP
  80 .B \-To
  81 Dump a numeric form of all objects.
  82 .TP
  83 .B \-Ts
  84 Dump a symbolic form of all objects.
  85 .TP
  86 .B \-Tt
  87 Dump a tree form of the loaded MIBs (mostly useful for debugging).
  88 .RE
  89 .TP
  90 .B -V
  91 Display version information for the application and then exit.
  92 .TP
  93 .BI -w " WIDTH"
  94 Specifies the width of
  95 .B -Tp
  96 and
  97 .B -Td
  98 output. The default is very large.
  99 .PP
 100 In addition to the above options,
 101 .B snmptranslate
 102 takes the OID input
 103 .RB ( -I ),
 104 MIB parsing
 105 .RB ( -M )
 106 and OID output
 107 .RB ( -O )
 108 options described in the
 109 .BR "INPUT OPTIONS" ", " "MIB PARSING OPTIONS" " and " "OUTPUT OPTIONS"
 110 sections of the
 111 .I snmpcmd(1)
 112 manual page.
 113 .SH EXAMPLES
 114 .IP \(bu 4
 115 snmptranslate -On -IR sysDescr
 116 .br
 117 will translate "sysDescr" to a more qualified form:
 118 .IP
 119 system.sysDescr
 120 .IP \(bu 4
 121 snmptranslate -Onf -IR sysDescr
 122 .br
 123 will translate "sysDecr" to:
 124 .IP
 125 .RI .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
 126 .IP \(bu 4
 127 snmptranslate -Td -OS system.sysDescr
 128 .br
 129 will translate "sysDecr" into:
 130 .IP
 131 .nf
 132 SNMPv2-MIB::sysDescr
 133 sysDescr OBJECT-TYPE
 134   -- FROM SNMPv2-MIB
 135   -- TEXTUAL CONVENTION DisplayString
 136   SYNTAX OCTET STRING (0..255)
 137   DISPLAY-HINT "255a"
 138   MAX-ACCESS read-only
 139   STATUS current
 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 }
 146 .fi
 147 .IP \(bu 4
 148 snmptranslate -Tp -OS system
 149 .br
 150 will print the following tree:
 151 .IP
 152 .nf
 153 +--system(1)
 154    |
 155    +-- -R-- String    sysDescr(1)
 156    |        Textual Convention: DisplayString
 157    |        Size: 0..255
 158    +-- -R-- ObjID     sysObjectID(2)
 159    +-- -R-- TimeTicks sysUpTime(3)
 160    +-- -RW- String    sysContact(4)
 161    |        Textual Convention: DisplayString
 162    |        Size: 0..255
 163    +-- -RW- String    sysName(5)
 164    |        Textual Convention: DisplayString
 165    |        Size: 0..255
 166    +-- -RW- String    sysLocation(6)
 167    |        Textual Convention: DisplayString
 168    |        Size: 0..255
 169    +-- -R-- Integer   sysServices(7)
 170    +-- -R-- TimeTicks sysORLastChange(8)
 171    |        Textual Convention: TimeStamp
 172    |
 173    +--sysORTable(9)
 174       |
 175       +--sysOREntry(1)
 176          |
 177          +-- ---- Integer   sysORIndex(1)
 178          +-- -R-- ObjID     sysORID(2)
 179          +-- -R-- String    sysORDescr(3)
 180          |        Textual Convention: DisplayString
 181          |        Size: 0..255
 182          +-- -R-- TimeTicks sysORUpTime(4)
 183                   Textual Convention: TimeStamp
 184
 185 .fi
 186 .PP
 187 .IP \(bu 4
 188 snmptranslate -Ta | head
 189 .br
 190 will produce the following dump:
 191 .IP
 192 .nf
 193 dump DEFINITIONS ::= BEGIN
 194 org ::= { iso 3 }
 195 dod ::= { org 6 }
 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 }
 203 .fi
 204 .PP
 205 .IP \(bu 4
 206 snmptranslate -Tl | head
 207 .br
 208 will produce the following dump:
 209 .IP
 210 .nf
 211 .RI .iso(1).org(3)
 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)
 221 .fi
 222 .PP
 223 .IP \(bu 4
 224 snmptranslate -To | head
 225 .br
 226 will produce the following dump
 227 .IP
 228 .nf
 229 .RI .1.3
 230 .RI .1.3.6
 231 .RI .1.3.6.1
 232 .RI .1.3.6.1.1
 233 .RI .1.3.6.1.2
 234 .RI .1.3.6.1.2.1
 235 .RI .1.3.6.1.2.1.1
 236 .RI .1.3.6.1.2.1.1.1
 237 .RI .1.3.6.1.2.1.1.2
 238 .RI .1.3.6.1.2.1.1.3
 239 .fi
 240 .PP
 241 .IP \(bu 4
 242 snmptranslate -Ts | head
 243 .br
 244 will produce the following dump
 245 .IP
 246 .nf
 247 .RI .iso.org
 248 .RI .iso.org.dod
 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
 257 .fi
 258 .PP
 259 .IP \(bu 4
 260 snmptranslate -Tt | head
 261 .br
 262 will produce the following dump
 263 .IP
 264 .nf
 265   org(3) type=0
 266     dod(6) type=0
 267       internet(1) type=0
 268         directory(1) type=0
 269         mgmt(2) type=0
 270           mib-2(1) type=0
 271             system(1) type=0
 272               sysDescr(1) type=2 tc=4 hint=255a
 273               sysObjectID(2) type=1
 274               sysUpTime(3) type=8
 275 .fi
 276 .SH "SEE ALSO"
 277 snmpcmd(1), variables(5), RFC 2578-2580.