snmptable.1.def
上传用户:wxp200602
上传日期:2007-10-30
资源大小:4028k
文件大小:5k
源码类别:

SNMP编程

开发平台:

Unix_Linux

  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 - retrieve an SNMP table and display it in tabular form
  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. AGENT identifies a target SNMP agent, which is instrumented
  44. to monitor the gievn objects.  At its simplest, the AGENT
  45. specification will consist of a hostname or an IPv4
  46. address.  In this situation, the command will attempt
  47. communication with the agent, using UDP/IPv4 to port 161
  48. of the given target host. See
  49. .I  snmpcmd(1)
  50. for a full list of
  51. the possible formats for AGENT.
  52. .SH OPTIONS
  53. .TP 8
  54. .B COMMON OPTIONS
  55. Please see
  56. .I snmpcmd(1)
  57. for a list of possible values for COMMON OPTIONS
  58. as well as their descriptions.
  59. .TP
  60. .B -Cb
  61. Display only a brief heading. Any common prefix of the table field
  62. names will be deleted.
  63. .TP 
  64. .B -CB
  65. Do not use GETBULK requests to retrieve data, only GETNEXT.
  66. .TP 
  67. .BI -Cc " CHARS"
  68. Print table in columns of
  69. .I CHARS
  70. characters width.
  71. .TP
  72. .BI -Cf " STRING"
  73. The string
  74. .I STRING
  75. is used to separate table columns.  With this option, each table entry
  76. will be printed in compact form, just with the string given to
  77. separate the columns (useful if you want to import it into a
  78. database).  Otherwise it is printed in nicely aligned columns.
  79. .TP
  80. .B -Ch
  81. Display
  82. .I only
  83. the column headings.
  84. .TP
  85. .B -CH
  86. Do not display the column headings.
  87. .TP
  88. .B -Ci
  89. This option prepends the index of the entry to all printed lines.
  90. .TP
  91. .B -Cl
  92. Left justify the data in each column.
  93. .TP 
  94. .BI -Cr " REPEATERS"
  95. For GETBULK requests, 
  96. .I REPEATERS
  97. specifies the max-repeaters value to use.  For GETNEXT requests,
  98. .I REPEATERS
  99. specifies the number of entries to retrieve at a time.
  100. .TP 
  101. .BI -Cw " WIDTH"
  102. Specifies the width of the lines when the table is printed.
  103. If the lines will be longer, the table will be printed in sections of
  104. at most 
  105. .I WIDTH 
  106. characters.  If
  107. .I WIDTH
  108. is less than the length of the contents of
  109. a single column, then that single column will still be printed.
  110. .PP
  111. .SH EXAMPLES
  112. $ snmptable -v 2c -c public localhost at.atTable
  113. SNMP table: at.atTable RFC1213-MIB::atTable
  114. atIfIndex   atPhysAddress   atNetAddress
  115.         1  8:0:20:20:0:ab 130.225.243.33
  116. .PP
  117. $ snmptable -v 2c -c public -Cf + localhost at.atTable
  118. SNMP table: at.atTable
  119. atIfIndex+atPhysAddress+atNetAddress
  120. 1+8:0:20:20:0:ab+130.225.243.33
  121. .PP
  122. .nf
  123. $ snmptable localhost -Cl -CB -Ci -OX -Cb -Cc 16 -Cw 64 ifTable
  124. SNMP table: ifTable
  125. Index           Descr           Type            Mtu             
  126. Speed           PhysAddress     AdminStatus     OperStatus      
  127. LastChange      InOctets        InUcastPkts     InNUcastPkts    
  128. InDiscards      InErrors        InUnknownProtos OutOctets       
  129. OutUcastPkts    OutNUcastPkts   OutDiscards     OutErrors       
  130. OutQLen         Specific        
  131. index: [1]
  132. 1               lo              softwareLoopbac 16436           
  133. 10000000                        up              up              
  134. ?               2837283786      3052466         ?               
  135. 0               0               ?               2837283786      
  136. 3052466         ?               0               0               
  137. 0               zeroDotZero     
  138. index: [2]
  139. 2               eth0            ethernetCsmacd  1500            
  140. 10000000        0:5:5d:d1:f7:cf up              up              
  141. ?               2052604234      44252973        ?               
  142. 0               0               ?               149778187       
  143. 65897282        ?               0               0               
  144. 0               zeroDotZero     
  145. .PP
  146. .SH "BUGS"
  147. The test for
  148. .I TABLE-OID
  149. actually specifying a table is rather heuristic.  Note also that the
  150. test requires the defining MIB file to be loaded.
  151. .PP
  152. .SH "SEE ALSO"
  153. snmpcmd(1), variables(5).