manual/ucd-snmp/original/man1/snmptranslate.1

   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 "21 Jun 2001"
  23 .UC 4
  24 .SH NAME
  25 snmptranslate - translate SNMP objects into more useful information
  26 .SH SYNOPSIS
  27 snmptranslate [-h]
  28 [-V]
  29 [-D <TOKEN[,TOKEN,...]>]
  30 [-I <INOPTS>]
  31 [-O <OUTOPTS>]
  32 [-P <MIBOPTS>]
  33 [-T <TRANSOPTS>]
  34 [-m <mibs>]
  35 [-M <mibdirs>]
  36 objectID
  37 .SH DESCRIPTION
  38 Snmptranslate is an application that translates an SNMP object (SMI value or
  39 symbolic form) into another form of information.  With no other options, an
  40 SNMP object will be translated to its SMI value.
  41 .PP
  42 The options have the following meanings:
  43 .TP
  44 .B \-h
  45 Print help message
  46 .TP
  47 .B \-V
  48 Print version message and exit
  49 .TP
  50 .B \-D <TOKEN[,TOKEN,...]>
  51 Enable debugging output.  See the \fIsnmpcmd\fR man page for more information.
  52 .TP
  53 .B \-I <INOPTS>
  54 See the \fIsnmpcmd\fR man page for a description of the OID input options
  55 .TP
  56 .B \-O <OUTOPTS>
  57 See the \fIsnmpcmd\fR man page for a description of the OID output options
  58 .TP
  59 .B \-P <MIBOPTS>
  60 See the \fIsnmpcmd\fR man page for a description of the MIB parsing options
  61 .TP
  62 .B \-T <TRANSOPTS>
  63 Translate an SNMP object to its symbolic form. The following TRANSOPTS
  64 are available:
  65 .TP
  66 .B \-Td
  67 print full details of the specified OID
  68 .TP
  69 .B \-Tp
  70 print a graphical tree, rooted at the specified OID
  71 .TP
  72 .B \-Ta
  73 dump the loaded MIB in a trivial form
  74 .TP
  75 .B \-Tl
  76 dump a labeled form of all objects
  77 .TP
  78 .B \-To
  79 dump a numeric form of all objects
  80 .TP
  81 .B \-Ts
  82 dump a symbolic form of all objects
  83 .TP
  84 .B \-Tt
  85 dump a tree form of the loaded mibs (mostly useful for debugging)
  86 .TP
  87 .B \-w width
  88 specify width of -Tp and -Td output. Default is very large
  89 .SH EXAMPLES
  90 .PP
  91 .I snmptranslate -On -IR sysDescr
  92 .PP
  93 will translate "sysDescr" to a more qualified form:
  94 .PP
  95 .I system.sysDescr
  96 .PP
  97 .I snmptranslate -Onf -IR sysDescr
  98 .PP
  99 will translate "sysDecr" to
 100 .PP
 101  .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
 102 .PP
 103 .I snmptranslate -Td -OS system.sysDescr
 104 .PP
 105 will translate "sysDecr" into
 106 .PP
 107 .nf
 108 SNMPv2-MIB::sysDescr
 109 sysDescr OBJECT-TYPE
 110   -- FROM SNMPv2-MIB
 111   -- TEXTUAL CONVENTION DisplayString
 112   SYNTAX OCTET STRING
 113   DISPLAY-HINT "255a"
 114   MAX-ACCESS read-only
 115   STATUS current
 116   DESCRIPTION "A textual description of the entity. This value should
 117         include the full name and version identification of the
 118         system's hardware type, software operating-system, and
 119         networking software."
 120 ::= { iso(1) org(3) dod(6) internet(1) mgmt(2) mib-2(1) system(1) 1 }
 121 .fi
 122 .PP
 123 .I snmptranslate -Tp -OS system
 124 .PP
 125 will print the following tree:
 126 .PP
 127 .nf
 128 +--system(1)
 129    |
 130    +-- -R-- String    sysDescr(1)
 131    |        Textual Convention: DisplayString
 132    |        Size: 0..255
 133    +-- -R-- ObjID     sysObjectID(2)
 134    +-- -R-- TimeTicks sysUpTime(3)
 135    +-- -RW- String    sysContact(4)
 136    |        Textual Convention: DisplayString
 137    |        Size: 0..255
 138    +-- -RW- String    sysName(5)
 139    |        Textual Convention: DisplayString
 140    |        Size: 0..255
 141    +-- -RW- String    sysLocation(6)
 142    |        Textual Convention: DisplayString
 143    |        Size: 0..255
 144    +-- -R-- Integer   sysServices(7)
 145    +-- -R-- TimeTicks sysORLastChange(8)
 146    |        Textual Convention: TimeStamp
 147    |
 148    +--sysORTable(9)
 149       |
 150       +--sysOREntry(1)
 151          |
 152          +-- ---- Integer   sysORIndex(1)
 153          +-- -R-- ObjID     sysORID(2)
 154          +-- -R-- String    sysORDescr(3)
 155          |        Textual Convention: DisplayString
 156          |        Size: 0..255
 157          +-- -R-- TimeTicks sysORUpTime(4)
 158                   Textual Convention: TimeStamp
 159
 160 .fi
 161 .PP
 162 .I snmptranslate -Ta | head
 163 .PP
 164 will produce the following dump:
 165 .PP
 166 .nf
 167 dump DEFINITIONS ::= BEGIN
 168 org ::= { iso 3 }
 169 dod ::= { org 6 }
 170 internet ::= { dod 1 }
 171 directory ::= { internet 1 }
 172 mgmt ::= { internet 2 }
 173 experimental ::= { internet 3 }
 174 private ::= { internet 4 }
 175 security ::= { internet 5 }
 176 snmpV2 ::= { internet 6 }
 177 .fi
 178 .PP
 179 .I snmptranslate -Tl | head
 180 .PP
 181 will produce the following dump:
 182 .PP
 183 .nf
 184  .iso(1).org(3)
 185  .iso(1).org(3).dod(6)
 186  .iso(1).org(3).dod(6).internet(1)
 187  .iso(1).org(3).dod(6).internet(1).directory(1)
 188  .iso(1).org(3).dod(6).internet(1).mgmt(2)
 189  .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1)
 190  .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1)
 191  .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysDescr(1)
 192  .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysObjectID(2)
 193  .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysUpTime(3)
 194 .fi
 195 .PP
 196 .I snmptranslate -To | head
 197 .PP
 198 will produce the following dump
 199 .PP
 200 .nf
 201  .1.3
 202  .1.3.6
 203  .1.3.6.1
 204  .1.3.6.1.1
 205  .1.3.6.1.2
 206  .1.3.6.1.2.1
 207  .1.3.6.1.2.1.1
 208  .1.3.6.1.2.1.1.1
 209  .1.3.6.1.2.1.1.2
 210  .1.3.6.1.2.1.1.3
 211 .fi
 212 .PP
 213 .I snmptranslate -Ts | head
 214 .PP
 215 will produce the following dump
 216 .PP
 217 .nf
 218  .iso.org
 219  .iso.org.dod
 220  .iso.org.dod.internet
 221  .iso.org.dod.internet.directory
 222  .iso.org.dod.internet.mgmt
 223  .iso.org.dod.internet.mgmt.mib-2
 224  .iso.org.dod.internet.mgmt.mib-2.system
 225  .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
 226  .iso.org.dod.internet.mgmt.mib-2.system.sysObjectID
 227  .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime
 228 .fi
 229 .PP
 230 .I snmptranslate -Tt | head
 231 .PP
 232 will produce the following dump
 233 .PP
 234 .nf
 235   org(3) type=0
 236     dod(6) type=0
 237       internet(1) type=0
 238         directory(1) type=0
 239         mgmt(2) type=0
 240           mib-2(1) type=0
 241             system(1) type=0
 242               sysDescr(1) type=2 tc=0 hint=255a
 243               sysObjectID(2) type=1
 244               sysUpTime(3) type=8
 245 .fi
 246 .SH "SEE ALSO"
 247 snmpcmd(1), variables(5), RFC 2578-2580.