home *** CD-ROM | disk | FTP | other *** search
/ OpenStep 4.2 / Openstep-4.2-Intel-User.iso / NextLibrary / Documentation / ManPages / man1 / snmpnetstat.1c < prev    next >
Encoding:
Text File  |  1994-09-08  |  6.7 KB  |  227 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. .\"    @(#)snmpnetstat.1    6.8 (Berkeley) 9/20/88; rev LL and JJ, 6/10/92
  38. .\"
  39. .TH SNMPNETSTAT 1C "September 17, 1989"
  40. .UC 5
  41. .SH NAME
  42. snmpnetstat \- show network status using SNMP
  43. .SH SYNOPSIS
  44. .B snmpnetstat
  45. .RB [\| \-an \|]
  46. .RB [\| \-c
  47. .IR community \|]
  48. .I host
  49. .br
  50. .B snmpnetstat
  51. .RB [\| \-inrs \|]
  52. .RB [\| \-c
  53. .IR community \|]
  54. .I host
  55. .br
  56. .B snmpnetstat
  57. .RB [\| \-n \|]
  58. .RB [\| \-I
  59. .IR interface \|]
  60. .RB [\| \-c
  61. .IR community \|]
  62. .I host
  63. .RI [\| interval \|]
  64. .br
  65. .B snmpnetstat
  66. .RB [\| \-p
  67. .IR protocol \|]
  68. .RB [\| \-c
  69. .IR community \|]
  70. .I host
  71. .RI [\| interval \|]
  72. .SH DESCRIPTION
  73. The
  74. .I snmpnetstat 
  75. command displays the values
  76. of various network-related information
  77. retrieved from a remote system using the SNMP protocol.
  78. There are a number of output formats,
  79. depending upon the options for the information to be presented.
  80. The first form of the command displays a list of active sockets.
  81. The second form presents the values of other network-related
  82. information according to the option selected.
  83. Using the third form, with an 
  84. .I interval
  85. specified,
  86. .I snmpnetstat
  87. will continuously display the information regarding packet
  88. traffic on the configured network interfaces.
  89. The fourth form displays statistics about the named protocol.
  90. .PP
  91. The
  92. .I host
  93. specification may be either a host name or an internet address
  94. specified in ``dot notation''.
  95. .PP
  96. The options have the following meaning:
  97. .TP
  98. .B \-a
  99. With the default display,
  100. show the state of all sockets; normally sockets used by
  101. server processes are not shown.
  102. .TP
  103. .BI \-c "\0community"
  104. Set the community name to use in the SNMP transactions.
  105. If no community is specified, ``public'' is used.
  106. .TP
  107. .B \-i
  108. Show the state of all of the interfaces.
  109. .TP
  110. .BI \-I " interface"
  111. Show information only about this interface;
  112. used with an
  113. .I interval
  114. as described below.
  115. .TP
  116. .B \-n
  117. Show network addresses as numbers (normally 
  118. .I snmpnetstat
  119. interprets addresses
  120. and attempts to display them symbolically).
  121. This option may be used with any of the display formats.
  122. .TP
  123. .BI \-p " protocol"
  124. Show statistics about 
  125. .IR protocol ,
  126. which is either a well-known name for a protocol
  127. or an alias for it.
  128. Some protocol names and aliases are listed in the file 
  129. .IR /etc/protocols .
  130. A null response typically means
  131. there are no interesting numbers to report.
  132. The program will complain if
  133. .I protocol
  134. is unknown
  135. or if there is no statistics routine for it.
  136. .TP
  137. .B \-s
  138. Show per-protocol statistics.
  139. .TP
  140. .B \-r
  141. Show the routing tables.
  142. When
  143. .B \-s
  144. is also present,
  145. show routing statistics instead.
  146. .PP
  147. The default display
  148. for active sockets
  149. shows the local and remote addresses, protocol,
  150. and the internal state of the protocol.
  151. Address formats are of the form ``host.port'' or ``network.port''
  152. if a socket's address specifies a network but no specific host address.
  153. When known,
  154. the host and network addresses are displayed symbolically
  155. according to the data bases
  156. .I /etc/hosts
  157. and
  158. .IR /etc/networks ,
  159. respectively.
  160. If a symbolic name for an address is unknown,
  161. or if the 
  162. .B \-n
  163. option is specified,
  164. the address is printed numerically,
  165. according to the address family.
  166. For more information regarding the Internet ``dot format,''
  167. refer to 
  168. .IR inet (3N).
  169. Unspecified
  170. (or ``wildcard'') addresses and ports appear as ``*''.
  171. .PP
  172. The interface display provides a table of cumulative statistics
  173. regarding packets transferred, errors, and collisions.
  174. The network addresses of the interface
  175. and the maximum transmission unit (``mtu'') are also displayed.
  176. .PP
  177. The routing table display indicates
  178. the available routes and their status.
  179. Each route consists of a destination host or network
  180. and a gateway to use in forwarding packets.
  181. The flags field shows
  182. the state of the route (``U'' if ``up''),
  183. whether the route
  184. is to a gateway (``G''),
  185. whether the route was created dynamically
  186. by a redirect (``D''),
  187. and whether the route has been modified
  188. by a redirect (``M'').
  189. Direct routes are created
  190. for each interface attached to the local host;
  191. the gateway field for such entries
  192. shows the address of the outgoing interface.
  193. The interface entry indicates
  194. the network interface utilized for the route.
  195. .PP
  196. When 
  197. .I snmpnetstat
  198. is invoked with an
  199. .I interval
  200. argument,
  201. it displays a running count of statistics
  202. related to network interfaces.
  203. This display consists of a column
  204. for the primary interface
  205. and a column summarizing
  206. information for all interfaces.
  207. The primary interface may be replaced
  208. with another interface by specifying the
  209. .I \-I
  210. option.
  211. The first line of each screen of information
  212. contains a summary since the system was last rebooted.
  213. Subsequent lines of output show values accumulated
  214. over the preceding interval.
  215. .SH SEE ALSO
  216. hosts(5),
  217. iostat(1),
  218. networks(5),
  219. protocols(5),
  220. services(5),
  221. snmp(1),
  222. snmpd(8),
  223. vm_stat(1),
  224. RFC1067
  225. .SH BUGS
  226. The notion of errors is ill-defined.
  227.