userapps/opensource/net-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 .TH SNMPTABLE 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
  19 .UC 4
  20 .SH NAME
  21 snmptable - obtain and print an SNMP table
  22 .SH SYNOPSIS
  23 .B snmptable
  24 [COMMON OPTIONS] TABLE-OID
  25 .SH DESCRIPTION
  26 .B snmptable
  27 is an SNMP application that repeatedly uses the SNMP GETNEXT or
  28 GETBULK requests to query for information on a network entity.  The
  29 parameter
  30 .I TABLE-OID
  31 must specify an SNMP table.
  32 .SH OPTIONS
  33 .TP 8
  34 .B -Cb
  35 Display only a brief heading. Any common prefix of the table field
  36 names will be deleted.
  37 .TP
  38 .B -CB
  39 Do not use GETBULK requests to retrieve data, only GETNEXT.
  40 .TP
  41 .BI -Cf " STRING"
  42 The string
  43 .I STRING
  44 is used to separate table columns.  With this option, each table entry
  45 will be printed in compact form, just with the string given to
  46 separate the columns (useful if you want to import it into a
  47 database).  Otherwise it is printed in nicely aligned columns.
  48 .TP
  49 .B -Ch
  50 Display
  51 .I only
  52 the column headings.
  53 .TP
  54 .B -CH
  55 Do not display the column headings.
  56 .TP
  57 .B -Ci
  58 This option prepends the index of the entry to all printed lines.
  59 .TP
  60 .BI -Cw " WIDTH"
  61 Specifies the width of the lines when the table is printed.
  62 If the lines will be longer, the table will be printed in sections of
  63 at most
  64 .I WIDTH
  65 characters.
  66 .PP
  67 In addition to these options,
  68 .B snmptable
  69 takes the common options described in the
  70 .I snmpcmd(1)
  71 manual page.
  72 .SH EXAMPLES
  73 $ snmptable localhost public at.attable
  74
  75 SNMP table: at.atTable
  76
  77 atIfIndex   atPhysAddress   atNetAddress
  78         1  8:0:20:20:0:ab 130.225.243.33
  79 .PP
  80 $ snmptable localhost public -Cf + at.attable
  81
  82 SNMP table: at.atTable
  83
  84 atIfIndex+atPhysAddress+atNetAddress
  85 1+8:0:20:20:0:ab+130.225.243.33
  86 .PP
  87 .SH "BUGS"
  88 The test for
  89 .I TABLE-OID
  90 actually specifying a table is rather heuristic.  Note also that the
  91 test requires the defining MIB file to be loaded.
  92 .PP
  93 .SH "SEE ALSO"
  94 snmpcmd(1), variables(5).