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.
91 .Fl i | I Ar interface
93 .Op Fl f Ar address_family
98 Show the state of all network interfaces or a single
100 which have been auto-configured
101 (interfaces statically configured into a system, but not
102 located at boot time are not shown).
105 after an interface name indicates that the interface is
109 is also present, multicast addresses currently in use are shown
110 for each Ethernet interface and for each IP interface address.
111 Multicast addresses are shown on separate lines following the interface
112 address with which they are associated.
115 is also present, show the number of bytes in and out.
118 is also present, show the number of dropped packets.
121 is also present, print all counters in human readable form.
124 is also present, show the contents of watchdog timers.
127 is also present, print interface names using a wider field size.
132 .Op Fl I Ar interface
141 display the information regarding packet
142 traffic on all configured network interfaces
147 is also present, show the number of dropped packets.
153 .Op Fl f Ar protocol_family | Fl p Ar protocol
158 Display system-wide statistics for each network protocol,
160 .Ar protocol_family ,
165 is repeated, counters with a value of zero are suppressed.
168 is also present, reset statistic counters after displaying them.
172 .Fl i | I Ar interface Fl s
173 .Op Fl f Ar protocol_family | Fl p Ar protocol
178 Display per-interface statistics for each network protocol,
180 .Ar protocol_family ,
191 Show statistics recorded by the memory management routines
193 The network manages a private pool of memory buffers.
198 .Op Fl I Ar interface
201 Show statistics about
204 This includes information like
205 how many packets have been matched, dropped and received by the
206 bpf device, also information about current buffer sizes and device
213 .Op Fl f Ar address_family
218 Display the contents of all routing tables,
219 or a routing table for a particular
224 show the contents of the internal Patricia tree
225 structures; used for debugging.
229 show protocol-cloned routes
230 (routes generated by an
233 normally these routes are not shown.
251 Display routing statistics.
254 is repeated, counters with a value of zero are suppressed.
260 .Op Fl f Ar address_family
265 Show information related to multicast (group address) routing.
266 By default, show the IP Multicast virtual-interface and routing tables,
267 and multicast group memberships.
273 .Op Fl f Ar address_family
278 Show multicast routing statistics.
281 is repeated, counters with a value of zero are suppressed.
284 Some options have the general meaning:
286 .It Fl f Ar address_family , Fl p Ar protocol
287 Limit display to those records
292 The following address families and protocols are recognized:
294 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
297 .It Cm inet Pq Dv AF_INET
298 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
299 .It Cm inet6 Pq Dv AF_INET6
300 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
301 .It Cm pfkey Pq Dv PF_KEY
303 .It Cm atalk Pq Dv AF_APPLETALK
305 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
307 .It Cm ipx Pq Dv AF_IPX
309 .\".It Cm ns Pq Dv AF_NS
310 .\".Cm idp , ns_err , spp
311 .\".It Cm iso Pq Dv AF_ISO
312 .\".Cm clnp , cltp , esis , tp
313 .It Cm unix Pq Dv AF_UNIX
314 .It Cm link Pq Dv AF_LINK
317 The program will complain if
319 is unknown or if there is no statistics routine for it.
321 Extract values associated with the name list from the specified core
322 instead of the default
325 Extract the name list from the specified system instead of the default,
326 which is the kernel image the system has booted from.
328 Show network addresses and ports as numbers.
331 attempts to resolve addresses and ports,
332 and display them symbolically.
334 In certain displays, avoid truncating addresses even if this causes
335 some fields to overflow.
338 The default display, for active sockets, shows the local
339 and remote addresses, send and receive queue sizes (in bytes), protocol,
340 and the internal state of the protocol.
341 Address formats are of the form
345 if a socket's address specifies a network but no specific host address.
346 When known, the host and network addresses are displayed symbolically
347 according to the databases
352 If a symbolic name for an address is unknown, or if
355 option is specified, the address is printed numerically, according
356 to the address family.
357 For more information regarding
365 addresses and ports appear as
368 The interface display provides a table of cumulative
369 statistics regarding packets transferred, errors, and collisions.
370 The network addresses of the interface
371 and the maximum transmission unit
375 The routing table display indicates the available routes and their status.
376 Each route consists of a destination host or network, and a gateway to use
377 in forwarding packets.
378 The flags field shows a collection of information about the route stored
380 The individual flags are discussed in more detail in the
385 The mapping between letters and flags is:
386 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
387 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
388 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
389 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
390 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
391 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
392 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
393 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
394 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
395 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
396 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
397 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
398 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
399 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
400 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
401 .It Li U Ta Dv RTF_UP Ta "Route usable"
402 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
403 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
406 Direct routes are created for each
407 interface attached to the local host;
408 the gateway field for such entries shows the address of the outgoing interface.
409 The refcnt field gives the
410 current number of active uses of the route.
412 protocols normally hold on to a single route for the duration of
413 a connection while connectionless protocols obtain a route while sending
414 to the same destination.
415 The use field provides a count of the number of packets
416 sent using that route.
417 The interface entry indicates the network interface utilized for the route.
425 interval argument, it displays a running count of statistics related to
427 An obsolescent version of this option used a numeric parameter
428 with no option, and is currently supported for backward compatibility.
429 By default, this display summarizes information for all interfaces.
430 Information for a specific interface may be displayed with the
440 option represent the underlying parameters of the bpf peer.
442 represented as a single lower case letter.
443 The mapping between the letters and flags in order of appearance are:
445 .It Li p Ta Set if listening promiscuously
446 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
447 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
449 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
450 remotely on the interface.
451 .It Li a Ta Packet reception generates a signal
452 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
455 For more information about these flags, please refer to
481 IPv6 support was added by WIDE/KAME project.
483 The notion of errors is ill-defined.