home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / RockRidge / ip / manage / snmp / cmu-snmp1.0 / man / snmpnetstat.1 < prev    next >
Encoding:
Text File  |  1989-09-19  |  6.5 KB  |  207 lines
  1. .\* /***********************************************************
  2. .\"     Copyright 1989 by Carnegie Mellon University
  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 and that
  9. .\" both that copyright notice and this permission notice appear in 
  10. .\" supporting documentation, and that the name of CMU not be
  11. .\" used in advertising or publicity pertaining to distribution of the
  12. .\" software without specific, written prior permission.  
  13. .\" 
  14. .\" CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  15. .\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  16. .\" CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  17. .\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  18. .\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  19. .\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  20. .\" SOFTWARE.
  21. .\" ******************************************************************/
  22. .\" Copyright (c) 1983 The Regents of the University of California.
  23. .\" All rights reserved.
  24. .\"
  25. .\" Redistribution and use in source and binary forms are permitted
  26. .\" provided that the above copyright notice and this paragraph are
  27. .\" duplicated in all such forms and that any documentation,
  28. .\" advertising materials, and other materials related to such
  29. .\" distribution and use acknowledge that the software was developed
  30. .\" by the University of California, Berkeley.  The name of the
  31. .\" University may not be used to endorse or promote products derived
  32. .\" from this software without specific prior written permission.
  33. .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  34. .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  35. .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  36. .\"
  37. .\"    @(#)netstat.1    6.8 (Berkeley) 9/20/88
  38. .\"
  39. .TH SNMPNETSTAT 1 "September 17, 1989"
  40. .UC 5
  41. .SH NAME
  42. snmpnetstat \- show network status using SNMP
  43. .SH SYNOPSIS
  44. .B snmpnetstat
  45. .I host community
  46. [ 
  47. .B \-an
  48. ]
  49. .br
  50. .B snmpnetstat
  51. .I host community
  52. [ 
  53. .B \-inrs
  54. ]
  55. .br
  56. .B snmpnetstat
  57. .I host community
  58. [ 
  59. .B \-n
  60. ] [
  61. .B \-I
  62. .I interface
  63. ]
  64. .I interval
  65. .br
  66. .B snmpnetstat
  67. .I host community
  68. [ 
  69. .B \-p
  70. .I protocol
  71. ]
  72. .SH DESCRIPTION
  73. The
  74. .I snmpnetstat 
  75. command symbolically displays the values of various network-related
  76. information retrieved from a remote system using the SNMP protocol.
  77. There are a number of output formats,
  78. depending on the options for the information presented.
  79. The first form of the command displays a list of active sockets.
  80. The second form presents the values of other network-related
  81. information according to the option selected.
  82. Using the third form, with an 
  83. .I interval
  84. specified,
  85. .I snmpnetstat
  86. will continuously display the information regarding packet
  87. traffic on the configured network interfaces.
  88. The fourth form displays statistics about the named protocol.
  89. .PP
  90. The
  91. .I host
  92. specification may be either a host name or an internet address
  93. specified in "dot notation"
  94. .PP
  95. The
  96. .I community
  97. specifies the community name for the transaction with the remote system.
  98. .PP
  99. The options have the following meaning:
  100. .TP
  101. .B \-a
  102. With the default display,
  103. show the state of all sockets; normally sockets used by
  104. server processes are not shown.
  105. .TP
  106. .B \-i
  107. Show the state of all of the interfaces.
  108. .TP
  109. .BI \-I " interface"
  110. Show information only about this interface;
  111. used with an
  112. .I interval
  113. as described below.
  114. .TP
  115. .B \-n
  116. Show network addresses as numbers (normally 
  117. .I snmpnetstat
  118. interprets addresses and attempts to display them
  119. symbolically).
  120. This option may be used with any of the display formats.
  121. .TP
  122. .BI \-p " protocol"
  123. Show statistics about 
  124. .IR protocol ,
  125. which is either a well-known name for a protocol or an alias for it.  Some
  126. protocol names and aliases are listed in the file 
  127. .IR /etc/protocols .
  128. A null response typically means that there are no interesting numbers to 
  129. report.
  130. The program will complain if
  131. .I protocol
  132. is unknown or if there is no statistics routine for it.
  133. .TP
  134. .B \-s
  135. Show per-protocol statistics.
  136. .TP
  137. .B \-r
  138. Show the routing tables.
  139. When
  140. .B \-s
  141. is also present, show routing statistics instead.
  142. .PP
  143. The default display, for active sockets, shows the local
  144. and remote addresses, protocol,
  145. and the internal state of the protocol.
  146. Address formats are of the form ``host.port'' or ``network.port''
  147. if a socket's address specifies a network but no specific host address.
  148. When known the host and network addresses are displayed symbolically
  149. according to the data bases
  150. .I /etc/hosts
  151. and
  152. .IR /etc/networks ,
  153. respectively.  If a symbolic name for an address is unknown, or if
  154. the 
  155. .B \-n
  156. option is specified, the address is printed numerically, according
  157. to the address family.
  158. For more information regarding 
  159. the Internet ``dot format,''
  160. refer to 
  161. .IR inet (3N).
  162. Unspecified,
  163. or ``wildcard'', addresses and ports appear as ``*''.  
  164. .PP
  165. The interface display provides a table of cumulative
  166. statistics regarding packets transferred, errors, and collisions.
  167. The network addresses of the interface
  168. and the maximum transmission unit (``mtu'') are also displayed.
  169. .PP
  170. The routing table display indicates the available routes and
  171. their status.  Each route consists of a destination host or network
  172. and a gateway to use in forwarding packets.  The flags field shows
  173. the state of the route (``U'' if ``up''), whether the route
  174. is to a gateway (``G''), whether the route was created dynamically
  175. by a redirect (``D''), and whether the route has been modified
  176. by a redirect (``M'').  Direct routes are created for each
  177. interface attached to the local host;
  178. the gateway field for such entries shows the address of the outgoing interface.
  179. The interface entry indicates the network
  180. interface utilized for the route.
  181. .PP
  182. When 
  183. .I snmpnetstat
  184. is invoked with an
  185. .I interval
  186. argument, it displays a running count of statistics related to
  187. network interfaces.  This display consists of a
  188. column for the primary interface
  189. and a column summarizing
  190. information for all interfaces.
  191. The primary interface may be replaced with another interface with the
  192. .I \-I
  193. option.
  194. The first line of each screen of information contains a summary since the
  195. system was last rebooted.  Subsequent lines of output show values
  196. accumulated over the preceding interval.
  197. .SH SEE ALSO
  198. iostat(1),
  199. vmstat(1),
  200. hosts(5),
  201. networks(5),
  202. protocols(5),
  203. services(5),
  204. RFC1067
  205. .SH BUGS
  206. The notion of errors is ill-defined.
  207.