snmptable (1)
Leading comments
/************************************************************
Copyright 1997 Niels Baggesen
All Rights Reserved
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies.
I DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
I BE LIABLE FOR ANY S...
NAME
snmptable - retrieve an SNMP table and display it in tabular formSYNOPSIS
snmptable [COMMON OPTIONS] [-Cb] [-CB] [-Ch] [-CH] [-Ci] [-Cf STRING] [-Cw WIDTH] AGENT TABLE-OIDDESCRIPTION
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 consist 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 possible formats for AGENT.
OPTIONS
- COMMON OPTIONS
- 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 lines.
- -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.
EXAMPLES
$ snmptable -v 2c -c public localhost at.atTableSNMP table: at.atTable RFC1213-MIB::atTable
atIfIndex atPhysAddress atNetAddress
1 8:0:20:20:0:ab 130.225.243.33
$ snmptable -v 2c -c public -Cf + localhost at.atTable
SNMP table: at.atTable
atIfIndex+atPhysAddress+atNetAddress
1+8:0:20:20:0:ab+130.225.243.33
$ 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
BUGS
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.