1 .\" Copyright (c) 1983, 1990, 1992, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)netstat.1 8.8 (Berkeley) 4/18/94
40 .Nd show network status
44 command symbolically displays the contents of various network-related
46 There are a number of output formats,
47 depending on the options for the information presented.
48 .Bl -tag -width indent
53 .Op Fl f Ar protocol_family | Fl p Ar protocol
58 Display a list of active sockets
59 (protocol control blocks)
60 for each network protocol,
68 show the address of a protocol control block (PCB)
69 associated with a socket; used for debugging.
73 show the state of all sockets;
74 normally sockets used by server processes are not shown.
78 show the size of the various listen queues.
79 The first count shows the number of unaccepted connections,
80 the second count shows the amount of unaccepted incomplete connections,
81 and the third count is the maximum number of queued connections.
85 show network addresses as numbers (as with
87 but show ports symbolically.
90 is present display full socket buffer statistics for each internet socket.
93 is present, display information from the TCP control block, including
94 retransmits, out-of-order packets received, and zero-sized windows advertised.
98 .Fl i | I Ar interface
100 .Op Fl f Ar address_family
105 Show the state of all network interfaces or a single
107 which have been auto-configured
108 (interfaces statically configured into a system, but not
109 located at boot time are not shown).
112 after an interface name indicates that the interface is
116 is also present, multicast addresses currently in use are shown
117 for each Ethernet interface and for each IP interface address.
118 Multicast addresses are shown on separate lines following the interface
119 address with which they are associated.
122 is also present, show the number of bytes in and out.
125 is also present, show the number of dropped packets.
128 is also present, print all counters in human readable form.
131 is also present, show the contents of watchdog timers.
134 is also present, print interface names using a wider field size.
139 .Op Fl I Ar interface
149 display the information regarding packet
150 traffic on all configured network interfaces
155 is also present, exit after
160 is also present, show the number of dropped packets.
166 .Op Fl f Ar protocol_family | Fl p Ar protocol
171 Display system-wide statistics for each network protocol,
173 .Ar protocol_family ,
178 is repeated, counters with a value of zero are suppressed.
181 is also present, reset statistic counters after displaying them.
185 .Fl i | I Ar interface Fl s
186 .Op Fl f Ar protocol_family | Fl p Ar protocol
191 Display per-interface statistics for each network protocol,
193 .Ar protocol_family ,
204 Show statistics recorded by the memory management routines
206 The network manages a private pool of memory buffers.
212 .Op Fl I Ar interface
215 Show statistics about
218 This includes information like
219 how many packets have been matched, dropped and received by the
220 bpf device, also information about current buffer sizes and device
227 .Op Fl f Ar address_family
232 Display the contents of all routing tables,
233 or a routing table for a particular
238 show the contents of the internal Patricia tree
239 structures; used for debugging.
243 show protocol-cloned routes
244 (routes generated by an
247 normally these routes are not shown.
265 Display routing statistics.
268 is repeated, counters with a value of zero are suppressed.
274 .Op Fl f Ar address_family
279 Display the contents of the multicast virtual interface tables,
280 and multicast forwarding caches.
281 Entries in these tables will appear only when the kernel is
282 actively forwarding multicast sessions.
283 This option is applicable only to the
293 .Op Fl f Ar address_family
298 Show multicast routing statistics.
301 is repeated, counters with a value of zero are suppressed.
313 Some options have the general meaning:
315 .It Fl f Ar address_family , Fl p Ar protocol
316 Limit display to those records
321 The following address families and protocols are recognized:
323 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
326 .It Cm inet Pq Dv AF_INET
327 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
328 .It Cm inet6 Pq Dv AF_INET6
329 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
330 .It Cm pfkey Pq Dv PF_KEY
332 .It Cm atalk Pq Dv AF_APPLETALK
334 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
336 .It Cm ipx Pq Dv AF_IPX
338 .\".It Cm ns Pq Dv AF_NS
339 .\".Cm idp , ns_err , spp
340 .\".It Cm iso Pq Dv AF_ISO
341 .\".Cm clnp , cltp , esis , tp
342 .It Cm unix Pq Dv AF_UNIX
343 .It Cm link Pq Dv AF_LINK
346 The program will complain if
348 is unknown or if there is no statistics routine for it.
350 Extract values associated with the name list from the specified core
351 instead of the default
354 Extract the name list from the specified system instead of the default,
355 which is the kernel image the system has booted from.
357 Show network addresses and ports as numbers.
360 attempts to resolve addresses and ports,
361 and display them symbolically.
363 In certain displays, avoid truncating addresses even if this causes
364 some fields to overflow.
367 The default display, for active sockets, shows the local
368 and remote addresses, send and receive queue sizes (in bytes), protocol,
369 and the internal state of the protocol.
370 Address formats are of the form
374 if a socket's address specifies a network but no specific host address.
375 When known, the host and network addresses are displayed symbolically
376 according to the databases
381 If a symbolic name for an address is unknown, or if
384 option is specified, the address is printed numerically, according
385 to the address family.
386 For more information regarding
394 addresses and ports appear as
397 The interface display provides a table of cumulative
398 statistics regarding packets transferred, errors, and collisions.
399 The network addresses of the interface
400 and the maximum transmission unit
404 The routing table display indicates the available routes and their status.
405 Each route consists of a destination host or network, and a gateway to use
406 in forwarding packets.
407 The flags field shows a collection of information about the route stored
409 The individual flags are discussed in more detail in the
414 The mapping between letters and flags is:
415 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
416 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
417 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
418 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
419 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
420 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
421 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
422 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
423 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
424 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
425 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
426 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
427 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
428 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
429 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
430 .It Li U Ta Dv RTF_UP Ta "Route usable"
431 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
432 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
435 Direct routes are created for each
436 interface attached to the local host;
437 the gateway field for such entries shows the address of the outgoing interface.
438 The refcnt field gives the
439 current number of active uses of the route.
441 protocols normally hold on to a single route for the duration of
442 a connection while connectionless protocols obtain a route while sending
443 to the same destination.
444 The use field provides a count of the number of packets
445 sent using that route.
446 The interface entry indicates the network interface utilized for the route.
454 interval argument, it displays a running count of statistics related to
456 An obsolescent version of this option used a numeric parameter
457 with no option, and is currently supported for backward compatibility.
458 By default, this display summarizes information for all interfaces.
459 Information for a specific interface may be displayed with the
469 option represent the underlying parameters of the bpf peer.
471 represented as a single lower case letter.
472 The mapping between the letters and flags in order of appearance are:
474 .It Li p Ta Set if listening promiscuously
475 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
476 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
478 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
479 remotely on the interface.
480 .It Li a Ta Packet reception generates a signal
481 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
484 For more information about these flags, please refer to
491 to output all the information recorded about data
492 stored in the socket buffers.
494 .Bl -column ".Li R-MBUF"
495 .It Li R-MBUF Ta Number of mbufs in the receive queue.
496 .It Li S-MBUF Ta Number of mbufs in the send queue.
497 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
499 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
500 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
501 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
502 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
503 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
504 .It Li R-BCNT Ta Receive buffer byte count.
505 .It Li S-BCNT Ta Send buffer byte count.
506 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
507 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
534 IPv6 support was added by WIDE/KAME project.
536 The notion of errors is ill-defined.