Go to main content

man pages section 1: User Commands

Exit Print View

Updated: July 2017
 
 

snmptranslate (1)

Name

snmptranslate - translate MIB OID names between numeric and textual forms

Synopsis

snmptranslate [OPTIONS] OID [OID]...

Description

SNMPTRANSLATE(1)                   Net-SNMP                   SNMPTRANSLATE(1)



NAME
       snmptranslate  -  translate  MIB  OID names between numeric and textual
       forms

SYNOPSIS
       snmptranslate [OPTIONS] OID [OID]...

DESCRIPTION
       snmptranslate is an application that translates one or more SNMP object
       identifier values from their symbolic (textual) forms into their numer-
       ical forms (or vice versa).

       OID is either a numeric or textual object identifier.

OPTIONS
       -D TOKEN[,...]
               Turn on debugging output for the given TOKEN(s).  Try  ALL  for
               extremely verbose output.

       -h      Display a brief usage message and then exit.

       -m MIBLIST
               Specifies  a  colon  separated  list of MIB modules to load for
               this application.   This  overrides  the  environment  variable
               MIBS.

               The  special  keyword ALL is used to specify all modules in all
               directories when searching for MIB  files.   Every  file  whose
               name does not begin with "." will be parsed as if it were a MIB
               file.

       -M DIRLIST
               Specifies a colon separated list of directories to  search  for
               MIBs.  This overrides the environment variable MIBDIRS.

       -T TRANSOPTS
               Provides  control  over the translation of the OID values.  The
               following TRANSOPTS are available:

               -Td   Print full details of the specified OID.

               -Tp   Print a graphical tree, rooted at the specified OID.

               -Ta   Dump the loaded MIB in a trivial form.

               -Tl   Dump a labeled form of all objects.

               -To   Dump a numeric form of all objects.

               -Ts   Dump a symbolic form of all objects.

               -Tt   Dump a tree form of the loaded MIBs  (mostly  useful  for
                     debugging).

               -Tz   Dump  a numeric and labeled form of all objects (compati-
                     ble with MIB2SCHEMA format).

       -V      Display version information for the application and then exit.

       -w WIDTH
               Specifies the width of -Tp and -Td output. The default is  very
               large.

       In  addition  to  the  above options, snmptranslate takes the OID input
       (-I), MIB parsing (-M) and OID output (-O)  options  described  in  the
       INPUT  OPTIONS,  MIB PARSING OPTIONS and OUTPUT OPTIONS sections of the
       snmpcmd(1) manual page.

EXAMPLES
       o   snmptranslate -On -IR sysDescr
           will translate "sysDescr" to a more qualified form:

           system.sysDescr

       o   snmptranslate -Onf -IR sysDescr
           will translate "sysDecr" to:

           .iso.org.dod.internet.mgmt.mib-2.system.sysDescr

       o   snmptranslate -Td -OS system.sysDescr
           will translate "sysDecr" into:

           SNMPv2-MIB::sysDescr
           sysDescr OBJECT-TYPE
             -- FROM SNMPv2-MIB
             -- TEXTUAL CONVENTION DisplayString
             SYNTAX OCTET STRING (0..255)
             DISPLAY-HINT "255a"
             MAX-ACCESS read-only
             STATUS current
             DESCRIPTION "A textual description of the entity. This
                          value should include the full name and
                          version identification of the system's
                          hardware type, software operating-system,
                          and networking software."
           ::= { iso(1) org(3) dod(6) internet(1) mgmt(2) mib-2(1) system(1) 1 }

       o   snmptranslate -Tp -OS system
           will print the following tree:

           +--system(1)
              |
              +-- -R-- String    sysDescr(1)
              |        Textual Convention: DisplayString
              |        Size: 0..255
              +-- -R-- ObjID     sysObjectID(2)
              +-- -R-- TimeTicks sysUpTime(3)
              +-- -RW- String    sysContact(4)
              |        Textual Convention: DisplayString
              |        Size: 0..255
              +-- -RW- String    sysName(5)
              |        Textual Convention: DisplayString
              |        Size: 0..255
              +-- -RW- String    sysLocation(6)
              |        Textual Convention: DisplayString
              |        Size: 0..255
              +-- -R-- Integer   sysServices(7)
              +-- -R-- TimeTicks sysORLastChange(8)
              |        Textual Convention: TimeStamp
              |
              +--sysORTable(9)
                 |
                 +--sysOREntry(1)
                    |
                    +-- ---- Integer   sysORIndex(1)
                    +-- -R-- ObjID     sysORID(2)
                    +-- -R-- String    sysORDescr(3)
                    |        Textual Convention: DisplayString
                    |        Size: 0..255
                    +-- -R-- TimeTicks sysORUpTime(4)
                             Textual Convention: TimeStamp


       o   snmptranslate -Ta | head
           will produce the following dump:

           dump DEFINITIONS ::= BEGIN
           org ::= { iso 3 }
           dod ::= { org 6 }
           internet ::= { dod 1 }
           directory ::= { internet 1 }
           mgmt ::= { internet 2 }
           experimental ::= { internet 3 }
           private ::= { internet 4 }
           security ::= { internet 5 }
           snmpV2 ::= { internet 6 }

       o   snmptranslate -Tl | head
           will produce the following dump:

           .iso(1).org(3)
           .iso(1).org(3).dod(6)
           .iso(1).org(3).dod(6).internet(1)
           .iso(1).org(3).dod(6).internet(1).directory(1)
           .iso(1).org(3).dod(6).internet(1).mgmt(2)
           .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1)
           .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1)
           .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysDescr(1)
           .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysObjectID(2)
           .iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).system(1).sysUpTime(3)

       o   snmptranslate -To | head
           will produce the following dump

           .1.3
           .1.3.6
           .1.3.6.1
           .1.3.6.1.1
           .1.3.6.1.2
           .1.3.6.1.2.1
           .1.3.6.1.2.1.1
           .1.3.6.1.2.1.1.1
           .1.3.6.1.2.1.1.2
           .1.3.6.1.2.1.1.3

       o   snmptranslate -Ts | head
           will produce the following dump

           .iso.org
           .iso.org.dod
           .iso.org.dod.internet
           .iso.org.dod.internet.directory
           .iso.org.dod.internet.mgmt
           .iso.org.dod.internet.mgmt.mib-2
           .iso.org.dod.internet.mgmt.mib-2.system
           .iso.org.dod.internet.mgmt.mib-2.system.sysDescr
           .iso.org.dod.internet.mgmt.mib-2.system.sysObjectID
           .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime

       o   snmptranslate -Tt | head
           will produce the following dump

             org(3) type=0
               dod(6) type=0
                 internet(1) type=0
                   directory(1) type=0
                   mgmt(2) type=0
                     mib-2(1) type=0
                       system(1) type=0
                         sysDescr(1) type=2 tc=4 hint=255a
                         sysObjectID(2) type=1
                         sysUpTime(3) type=8


ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:


       +---------------+-----------------------------------------------+
       |ATTRIBUTE TYPE |               ATTRIBUTE VALUE                 |
       +---------------+-----------------------------------------------+
       |Availability   | system/management/snmp/net-snmp/documentation |
       +---------------+-----------------------------------------------+
       |Stability      | Volatile                                      |
       +---------------+-----------------------------------------------+
SEE ALSO
       snmpcmd(1), variables(5), RFC 2578-2580.



NOTES
       This    software    was    built    from    source     available     at
       https://java.net/projects/solaris-userland.    The  original  community
       source  was  downloaded  from   http://ftp.ntua.gr/mirror/net-snmp/Old-
       Files/net-snmp-5.4.x/5.4.1/net-snmp-5.4.1.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.net-snmp.org/.



4th Berkeley Distribution         25 Jul 2003                 SNMPTRANSLATE(1)