Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022

snmptable (1)


snmptable - retrieve an SNMP table and display it in tabular form


snmptable  [COMMON  OPTIONS] [-Cb] [-CB] [-Ch] [-CH] [-Ci] [-Cf STRING]


SNMPTABLE(1)                       Net-SNMP                       SNMPTABLE(1)

       snmptable - retrieve an SNMP table and display it in tabular form

       snmptable  [COMMON  OPTIONS] [-Cb] [-CB] [-Ch] [-CH] [-Ci] [-Cf STRING]

       snmptable is an SNMP application that repeatedly uses the SNMP  GETNEXT
       or  GETBULK requests to query for information on a network entity.  The
       parameter TABLE-OID must specify an SNMP table.

       AGENT identifies a target SNMP agent, which is instrumented to  monitor
       the  given objects.  At its simplest, the AGENT specification will con-
       sist of a hostname or an IPv4 address.  In this situation, the  command
       will  attempt  communication with the agent, using UDP/IPv4 to port 161
       of the given target host. See snmpcmd(1) for a full list of the  possi-
       ble formats for AGENT.

               Please  see snmpcmd(1) for a list of possible values for COMMON
               OPTIONS as well as their descriptions.

       -Cb     Display only a brief heading. Any common prefix  of  the  table
               field names will be deleted.

       -CB     Do not use GETBULK requests to retrieve data, only GETNEXT.

       -Cc CHARS
               Print table in columns of CHARS characters width.

       -Cf STRING
               The string STRING is used to separate table columns.  With this
               option, each table entry will be printed in compact form,  just
               with  the  string  given to separate the columns (useful if you
               want to import it into a database).  Otherwise it is printed in
               nicely aligned columns.

       -Ch     Display only the column headings.

       -CH     Do not display the column headings.

       -Ci     This  option  prepends  the  index  of the entry to all printed

       -Cl     Left justify the data in each column.

       -Cr REPEATERS
               For GETBULK requests,  REPEATERS  specifies  the  max-repeaters
               value  to  use.   For GETNEXT requests, REPEATERS specifies the
               number of entries to retrieve at a time.

       -Cw WIDTH
               Specifies the width of the lines when the table is printed.  If
               the lines will be longer, the table will be printed in sections
               of at most WIDTH characters.  If WIDTH is less than the  length
               of  the  contents  of  a single column, then that single column
               will still be printed.

       Note that snmptable REQUIRES  an argument specifying the agent to query
       and  exactly  one  OID  argument, as described in the snmpcmd(1) manual
       page.  This OID must be that of a MIB table object.

       $ snmptable -v 2c -c public localhost at.atTable

       SNMP table: at.atTable RFC1213-MIB::atTable

       atIfIndex   atPhysAddress   atNetAddress
               1  8:0:20:20:0:ab

       $ snmptable -v 2c -c public -Cf + localhost at.atTable

       SNMP table: at.atTable

       atIfIndex+atPhysAddress+atNetAddress 1+8:0:20:20:0:ab+

       $ snmptable localhost -Cl -CB -Ci -OX -Cb -Cc 16 -Cw 64 ifTable

       SNMP table: ifTable

       Index           Descr           Type            Mtu
       Speed           PhysAddress     AdminStatus     OperStatus
       LastChange      InOctets        InUcastPkts     InNUcastPkts
       InDiscards      InErrors        InUnknownProtos OutOctets
       OutUcastPkts    OutNUcastPkts   OutDiscards     OutErrors
       OutQLen         Specific

       index: [1]
       1               lo              softwareLoopbac 16436
       10000000                        up              up
       ?               2837283786      3052466         ?
       0               0               ?               2837283786
       3052466         ?               0               0
       0               zeroDotZero

       index: [2]
       2               eth0            ethernetCsmacd  1500
       10000000        0:5:5d:d1:f7:cf up              up
       ?               2052604234      44252973        ?
       0               0               ?               149778187
       65897282        ?               0               0
       0               zeroDotZero

       The test for TABLE-OID actually specifying a table is rather heuristic.
       Note also that the test requires the defining MIB file to be loaded.

       See attributes(7) for descriptions of the following attributes:

       |ATTRIBUTE TYPE |        ATTRIBUTE VALUE          |
       |Availability   | system/management/snmp/net-snmp |
       |Stability      | Volatile                        |

       snmpcmd(1), variables(5).

       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://sourceforge.net/projects/net-

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

V5.8                              25 Jul 2003                     SNMPTABLE(1)