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

SNMP编程

开发平台:

Unix_Linux

  1. ." Portions of this file are subject to the following copyright.  See
  2. ." the Net-SNMP's COPYING file for more details and other copyrights
  3. ." that may apply:
  4. ." /***********************************************************
  5. ."  Copyright 1989 by Carnegie Mellon University
  6. ." 
  7. ."                       All Rights Reserved
  8. ." 
  9. ." Permission to use, copy, modify, and distribute this software and its 
  10. ." documentation for any purpose and without fee is hereby granted, 
  11. ." provided that the above copyright notice appear in all copies and that
  12. ." both that copyright notice and this permission notice appear in 
  13. ." supporting documentation, and that the name of CMU not be
  14. ." used in advertising or publicity pertaining to distribution of the
  15. ." software without specific, written prior permission.  
  16. ." 
  17. ." CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  18. ." ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  19. ." CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  20. ." ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21. ." WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  22. ." ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  23. ." SOFTWARE.
  24. ." ******************************************************************/
  25. ."
  26. ." Copyright (c) 1983, 1988, 1993
  27. ."      The Regents of the University of California.  All rights reserved.
  28. ."
  29. ." Redistribution and use in source and binary forms, with or without
  30. ." modification, are permitted provided that the following conditions
  31. ." are met:
  32. ." 1. Redistributions of source code must retain the above copyright
  33. ."    notice, this list of conditions and the following disclaimer.
  34. ." 2. Redistributions in binary form must reproduce the above copyright
  35. ."    notice, this list of conditions and the following disclaimer in the
  36. ."    documentation and/or other materials provided with the distribution.
  37. ." 3. Neither the name of the University nor the names of its contributors
  38. ."    may be used to endorse or promote products derived from this software
  39. ."    without specific prior written permission.
  40. ."
  41. ." THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  42. ." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. ." IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. ." ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  45. ." FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. ." DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. ." OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. ." HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. ." LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. ." OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. ." SUCH DAMAGE.
  52. ."
  53. ." @(#)netstat.1 6.8 (Berkeley) 9/20/88
  54. ."
  55. ." /***********************************************************
  56. ." Portions of this file are copyrighted by:
  57. ." Copyright Copyright 2003 Sun Microsystems, Inc. All rights reserved.
  58. ." Use is subject to license terms specified in the COPYING file
  59. ." distributed with the Net-SNMP package.
  60. ." ******************************************************************/
  61. .TH SNMPNETSTAT 1 "25 Oct 2003" VVERSIONINFO "Net-SNMP"
  62. .UC 5
  63. .SH NAME
  64. snmpnetstat - display networking status and configuration information from a network entity via SNMP
  65. .SH SYNOPSIS
  66. .B snmpnetstat
  67. [common options] [-a] [-n] AGENT
  68. .br
  69. .B snmpnetstat
  70. [common options] [-iorns] AGENT
  71. .br
  72. .B snmpnetstat
  73. [common options] [-in] [-I interface] AGENT [interval]
  74. .br
  75. .B snmpnetstat
  76. [common options] [-an] [-s] [-P protocol] AGENT
  77. .SH DESCRIPTION
  78. The
  79. .B snmpnetstat 
  80. command symbolically displays the values of various network-related
  81. information retrieved from a remote system using the SNMP protocol.
  82. There are a number of output formats,
  83. depending on the options for the information presented.
  84. The first form of the command displays a list of active sockets.
  85. The second form presents the values of other network-related
  86. information according to the option selected.
  87. Using the third form, with an 
  88. .I interval
  89. specified,
  90. .I snmpnetstat
  91. will continuously display the information regarding packet
  92. traffic on the configured network interfaces.
  93. The fourth form displays statistics about the named protocol.
  94. .PP
  95. AGENT identifies a target SNMP agent, which is
  96. instrumented to monitor the given objects.
  97. At its simplest, the AGENT specification will
  98. consist of a hostname or an IPv4 address. In this
  99. situation, the command will attempt communication
  100. with the agent, using UDP/IPv4 to port 161 of the
  101. given target host. See snmpcmd(1) for a full list of
  102. the possible formats for AGENT.
  103. .PP
  104. .SH OPTIONS
  105. The options have the following meaning:
  106. .PP
  107. .B common options
  108.  Please see
  109. .I snmpcmd(1)
  110. for a list of possible values for common options
  111. as well as their descriptions.
  112. .PP
  113. .B -a
  114. With the default display,
  115. show the state of all sockets; normally sockets used by
  116. server processes are not shown.
  117. .PP
  118. .B -i
  119. Show the state of all of the network interfaces.
  120. The  interface  display  provides  a  table  of cumulative
  121. statistics regarding packets transferred, errors, and collisions.
  122. The  network addresses of the interface and the maximum transmission 
  123. unit (``mtu'') are also displayed.
  124. .PP
  125. .B -o
  126. Show an abbreviated interface status, giving octets in place of packets.
  127. This is useful when enquiring virtual interfaces (such as Frame-Relay circuits)
  128. on a router.
  129. .PP
  130. .BI -I " interface"
  131. Show information only about this interface;
  132. used with an
  133. .I interval
  134. as described below.
  135. .PP
  136. .B -n
  137. Show network addresses as numbers (normally 
  138. .I snmpnetstat
  139. interprets addresses and attempts to display them
  140. symbolically).
  141. This option may be used with any of the display formats.
  142. .PP
  143. .BI -P " protocol"
  144. Show statistics about 
  145. .IR protocol,
  146. which is either a well-known name for a protocol or an alias for it.  Some
  147. protocol names and aliases are listed in the file 
  148. .IR /etc/protocols .
  149. A null response typically means that there are no interesting numbers to 
  150. report.
  151. The program will complain if
  152. .I protocol
  153. is unknown or if there is no statistics routine for it.
  154. .PP
  155. .B -s
  156. Show per-protocol statistics.  When used with the
  157. .B -r
  158. option, show routing statistics instead.
  159. .PP
  160. .B -r
  161. Show the routing tables.
  162. When
  163. .B -s
  164. is also present, show per-protocol routing statistics instead of 
  165. the routing tables.
  166. .PP
  167. When  snmpnetstat is invoked with an interval argument, it
  168. displays a running count of statistics related to  network
  169. interfaces.
  170. .I interval
  171. is the number of seconds between
  172. reporting of statistics.
  173. .PP
  174. .I The Active Sockets Display (default)
  175. .PP
  176. The default display, for active sockets, shows the local
  177. and remote addresses, protocol, and the internal state  of
  178. the   protocol.    Address   formats   are   of  the  form
  179. ``host.port'' or ``network.port'' if  a  socket's  address
  180. specifies  a  network  but no specific host address.  When
  181. known, the host and network addresses are displayed symbolically
  182. according   to  the  data  bases 
  183. .I /etc/hosts  and
  184. .IR /etc/networks,
  185. respectively.  If a symbolic  name  for  an
  186. address  is unknown, or if the
  187. .B -n
  188. option is specified, the
  189. address is printed numerically, according to  the  address
  190. family.  For more information regarding the Internet ``dot
  191. format,'' refer  to
  192. .IR inet(3N).
  193. Unspecified,  or  ``wildcard'', addresses and ports appear as ``*''.
  194. .PP
  195. .I The Interface Display
  196. .PP
  197. The  interface  display  provides  a  table  of cumulative
  198. statistics regarding packets transferred, errors, and col-
  199. lisions.   The  network addresses of the interface and the
  200. maximum transmission unit (``mtu'') are also displayed.
  201. .PP
  202. .I The Routing Table Display
  203. .PP
  204. The routing table display indicates the  available  routes
  205. and  their  status.   Each route consists of a destination
  206. host or network and a gateway to use in  forwarding  pack-
  207. ets.   The flags field shows the state of the route (``U''
  208. if ``up''), whether the route is  to  a  gateway  (``G''),
  209. whether  the  route  was created dynamically by a redirect
  210. (``D''), and whether the route  has  been  modified  by  a
  211. redirect  (``M'').   Direct  routes  are  created for each
  212. interface attached to the local host;  the  gateway  field
  213. for  such entries shows the address of the outgoing inter-
  214. face.  The interface entry indicates the network interface
  215. utilized for the route.
  216. .PP
  217. .I The Interface Display with an Interval
  218. .PP
  219. When
  220. .I snmpnetstat
  221. is invoked with an
  222. .I interval
  223. argument, it
  224. displays a running count of statistics related to  network
  225. interfaces.   This  display  consists  of a column for the
  226. primary interface and a column summarizing information for
  227. all  interfaces.   The  primary  interface may be replaced
  228. with another interface with the
  229. .B -I
  230. option.  The first line
  231. of each screen of information contains a summary since the
  232. system was last rebooted.  Subsequent lines of output show
  233. values accumulated over the preceding interval.
  234. .PP
  235. .I The Active Sockets Display for a 
  236. .I Single Protocol
  237. .PP
  238. When a protocol is specified with the
  239. .B -P
  240. option, the
  241. information displayed is similar to that in the
  242. default display for active sockets, except the
  243. display is limited to the given protocol.
  244. .SH EXAMPLES
  245. Example of using snmpnetstat to displaly active sockets (default):
  246. .PP
  247. % snmpnetstat -v 2c -c public -a testhost
  248. .PP
  249. .nf
  250. Active Internet (tcp) Connections (including servers)
  251. Proto Local Address                Foreign Address                 (state)
  252. tcp   *.echo                        *.*                            LISTEN
  253. tcp   *.discard                     *.*                            LISTEN
  254. tcp   *.daytime                     *.*                            LISTEN
  255. tcp   *.chargen                     *.*                            LISTEN
  256. tcp   *.ftp                         *.*                            LISTEN
  257. tcp   *.telnet                      *.*                            LISTEN
  258. tcp   *.smtp                        *.*                            LISTEN
  259. ...
  260. Active Internet (udp) Connections
  261. Proto Local Address
  262. udp    *.echo
  263. udp    *.discard
  264. udp    *.daytime
  265. udp    *.chargen
  266. udp    *.time
  267. ...
  268. .fi
  269. .PP
  270. % snmpnetstat -v 2c -c public -i testhost
  271. .PP
  272. .nf
  273. Name     Mtu Network    Address          Ipkts   Ierrs    Opkts Oerrs Queue
  274. eri0    1500 10.6.9/24  testhost     170548881  245601   687976     0    0
  275. lo0     8232 127        localhost      7530982       0  7530982     0    0
  276. .fi
  277. .PP
  278. Example of using snmpnetstat to show statistics about a specific protocol:
  279. .PP
  280. .nf
  281. % snmpnetstat -v 2c -c public -P tcp testhost
  282. Active Internet (tcp) Connections
  283. Proto Local Address                Foreign Address                 (state)
  284. tcp   *.echo                        *.*                            LISTEN
  285. tcp   *.discard                     *.*                            LISTEN
  286. tcp   *.daytime                     *.*                            LISTEN
  287. tcp   *.chargen                     *.*                            LISTEN
  288. tcp   *.ftp                         *.*                            LISTEN
  289. tcp   *.telnet                      *.*                            LISTEN
  290. tcp   *.smtp                        *.*                            LISTEN
  291. ...
  292. .fi
  293. .SH SEE ALSO
  294. snmpcmd(1),
  295. iostat(1),
  296. vmstat(1),
  297. hosts(5),
  298. networks(5),
  299. protocols(5),
  300. services(5).
  301. .SH BUGS
  302. The notion of errors is ill-defined.