release/src/router/snmp/man/snmptable.1.def

   1 .\" /************************************************************
   2 .\"     Copyright 1997 Niels Baggesen
   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.
   9 .\"
  10 .\" I DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  11 .\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  12 .\" I BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  13 .\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  14 .\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  15 .\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  16 .\" SOFTWARE.
  17 .\" ******************************************************************/
  18 .\" Portions of this file are copyrighted by:
  19 .\" Copyright Copyright 2003 Sun Microsystems, Inc. All rights reserved.
  20 .\" Use is subject to license terms specified in the COPYING file
  21 .\" distributed with the Net-SNMP package.
  22 .\" ******************************************************************/
  23 .TH SNMPTABLE 1 "25 Jul 2003" VVERSIONINFO "Net-SNMP"
  24 .UC 4
  25 .SH NAME
  26 snmptable - obtain and print an SNMP table
  27 .SH SYNOPSIS
  28 .B snmptable
  29 [COMMON OPTIONS] [-Cb] [-CB] [-Ch] [-CH] [-Ci] [-Cf STRING] [-Cw WIDTH]
  30 AGENT TABLE-OID
  31 .SH DESCRIPTION
  32 .B snmptable
  33 is an SNMP application that repeatedly uses the SNMP GETNEXT or
  34 GETBULK requests to query for information on a network entity.  The
  35 parameter
  36 .I TABLE-OID
  37 must specify an SNMP table.
  38 .PP
  39 snmptable is an SNMP application that repeatedly uses the
  40 SNMP GETNEXT or GETBULK requests to query for  information
  41 on a network entity.  The parameter TABLE-OID must specify
  42 an SNMP table.
  43
  44 AGENT identifies a target SNMP agent, which is instrumented
  45 to monitor the gievn objects.  At its simplest, the AGENT
  46 specification will consist of a hostname or an IPv4
  47 address.  In this situation, the command will attempt
  48 communication with the agent, using UDP/IPv4 to port 161
  49 of the given target host. See
  50 .I  snmpcmd(1)
  51 for a full list of
  52 the possible formats for AGENT.
  53 .SH OPTIONS
  54 .TP 8
  55 .B COMMON OPTIONS
  56 Please see
  57 .I snmpcmd(1)
  58 for a list of possible values for COMMON OPTIONS
  59 as well as their descriptions.
  60 .TP
  61 .B -Cb
  62 Display only a brief heading. Any common prefix of the table field
  63 names will be deleted.
  64 .TP
  65 .B -CB
  66 Do not use GETBULK requests to retrieve data, only GETNEXT.
  67 .TP
  68 .BI -Cf " STRING"
  69 The string
  70 .I STRING
  71 is used to separate table columns.  With this option, each table entry
  72 will be printed in compact form, just with the string given to
  73 separate the columns (useful if you want to import it into a
  74 database).  Otherwise it is printed in nicely aligned columns.
  75 .TP
  76 .B -Ch
  77 Display
  78 .I only
  79 the column headings.
  80 .TP
  81 .B -CH
  82 Do not display the column headings.
  83 .TP
  84 .B -Ci
  85 This option prepends the index of the entry to all printed lines.
  86 .TP
  87 .BI -Cw " WIDTH"
  88 Specifies the width of the lines when the table is printed.
  89 If the lines will be longer, the table will be printed in sections of
  90 at most
  91 .I WIDTH
  92 characters.  If
  93 .I WIDTH
  94 is less than the length of the contents of
  95 a single column, then that single column will still be printed.
  96 .PP
  97 .SH EXAMPLES
  98 $ snmptable -v 2c -c public localhost at.atTable
  99
 100 SNMP table: at.atTable RFC1213-MIB::atTable
 101
 102 atIfIndex   atPhysAddress   atNetAddress
 103         1  8:0:20:20:0:ab 130.225.243.33
 104 .PP
 105 $ snmptable -v 2c -c public -Cf + localhost at.atTable
 106
 107 SNMP table: at.atTable
 108
 109 atIfIndex+atPhysAddress+atNetAddress
 110 1+8:0:20:20:0:ab+130.225.243.33
 111 .PP
 112 .SH "BUGS"
 113 The test for
 114 .I TABLE-OID
 115 actually specifying a table is rather heuristic.  Note also that the
 116 test requires the defining MIB file to be loaded.
 117 .PP
 118 .SH "SEE ALSO"
 119 snmpcmd(1), variables(5).