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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)netstat.1 8.8 (Berkeley) 4/18/94
29 .\" $FreeBSD: src/usr.bin/netstat/netstat.1,v 1.22.2.13 2003/05/03 22:10:02 keramida Exp $
36 .Nd show network status
40 command symbolically displays the contents of various network-related
42 There are a number of output formats,
43 depending on the options for the information presented.
44 .Bl -tag -width indent
50 .Op Fl f Ar protocol_family | Fl p Ar protocol
55 Display a list of active sockets
56 (protocol control blocks)
57 for each network protocol,
65 show the address of a protocol control block (PCB)
66 associated with a socket; used for debugging.
70 show the state of all sockets;
71 normally sockets used by server processes are not shown.
75 show the size of the various listen queues.
76 The first count shows the number of unaccepted connections,
77 the second count shows the amount of unaccepted incomplete connections,
78 and the third count is the maximum number of queued connections.
82 show network addresses as numbers (as with
84 but show ports symbolically.
88 .Fl i | I Ar interface
90 .Op Fl f Ar address_family
95 Show the state of all network interfaces or a single
97 which have been auto-configured
98 (interfaces statically configured into a system, but not
99 located at boot time are not shown).
102 after an interface name indicates that the interface is
106 is also present, multicast addresses currently in use are shown
107 for each Ethernet interface and for each IP interface address.
108 Multicast addresses are shown on separate lines following the interface
109 address with which they are associated.
112 is also present, show the number of bytes in and out.
115 is also present, show the number of dropped packets.
118 is also present, show the contents of watchdog timers.
121 is also present, the maximum buffer sizes are displayed instead
122 of current buffer usage.
127 .Op Fl I Ar interface
136 display the information regarding packet
137 traffic on all configured network interfaces
142 is also present, show the number of dropped packets.
148 .Op Fl f Ar protocol_family | Fl p Ar protocol
153 Display system-wide statistics for each network protocol,
155 .Ar protocol_family ,
160 is repeated, counters with a value of zero are suppressed.
163 is also present, reset statistic counters after displaying them.
167 .Fl i | I Ar interface Fl s
168 .Op Fl f Ar protocol_family | Fl p Ar protocol
173 Display per-interface statistics for each network protocol,
175 .Ar protocol_family ,
186 Show statistics recorded by the memory management routines
188 The network manages a private pool of memory buffers.
194 .Op Fl f Ar address_family
199 Display the contents of all routing tables,
200 or a routing table for a particular
205 show the contents of the internal Patricia tree
206 structures; used for debugging.
210 show protocol-cloned routes
211 (routes generated by an
214 normally these routes are not shown.
223 and MPLS label operations
234 Display routing statistics.
237 is repeated, counters with a value of zero are suppressed.
243 .Op Fl f Ar address_family
248 Show information related to multicast (group address) routing.
249 By default, show the IP Multicast virtual-interface and routing tables.
255 .Op Fl f Ar address_family
260 Show multicast routing statistics.
263 is repeated, counters with a value of zero are suppressed.
266 Some options have the general meaning:
269 On SMP systems the route table is replicated. This option allows
270 the route table for a specific cpu to be accessed and exists
271 primarily for debugging purposes.
272 .It Fl f Ar address_family , Fl f Ar protocol_family , Fl p Ar protocol
273 Limit display to those records
279 The following address families, protocol families and protocols are recognized:
281 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
284 .It Cm inet Pq Dv AF_INET PF_INET
285 .Cm carp , divert , icmp , igmp , ip , ipsec , pim , tcp , udp
286 .It Cm inet6 Pq Dv AF_INET6 PF_INET6
287 .Cm carp , icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
288 .It Cm pfkey Pq Dv AF_KEY PF_KEY
290 .It Cm netgraph , ng Pq Dv AF_NETGRAPH PF_NETGRAPH
292 .\".It Cm iso Pq Dv AF_ISO PF_ISO
293 .\".Cm clnp , cltp , esis , tp
294 .It Cm unix Pq Dv AF_UNIX PF_UNIX
295 .It Cm link Pq Dv AF_LINK PF_LINK
296 .It Cm mpls Pq Dv AF_MPLS PF_MPLS
299 The program will complain if
301 is unknown or if there is no statistics routine for it.
305 option is equivalent to
308 Extract values associated with the name list from the specified core
309 instead of the default
312 Extract the name list from the specified system instead of the default,
313 which is the kernel image the system has booted from.
315 Show network addresses and ports as numbers.
318 attempts to resolve addresses and ports,
319 and display them symbolically.
321 Display additional protocol-specific information. For TCP the current
322 transmit window, unacked sequence space, and RTT is displayed.
325 In certain displays, add columns and avoid truncating
326 addresses even if this causes some fields to overflow.
329 The default display, for active sockets, shows the local
330 and remote addresses, send and receive queue sizes (in bytes), protocol,
331 and the internal state of the protocol.
332 Address formats are of the form
336 if a socket's address specifies a network but no specific host address.
337 When known, the host and network addresses are displayed symbolically
338 according to the databases
343 If a symbolic name for an address is unknown, or if
346 option is specified, the address is printed numerically, according
347 to the address family.
348 For more information regarding
356 addresses and ports appear as
359 The interface display provides a table of cumulative
360 statistics regarding packets transferred, errors, and collisions.
361 The network addresses of the interface
362 and the maximum transmission unit
366 The routing table display indicates the available routes and their status.
367 Each route consists of a destination host or network, and a gateway to use
368 in forwarding packets.
369 The flags field shows a collection of information about the route stored
371 The individual flags are discussed in more detail in the
376 The mapping between letters and flags is:
377 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
378 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
379 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
380 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
381 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
382 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
383 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
384 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
385 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
386 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
387 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
388 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
389 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
390 .It Li m Ta Dv RTF_MPLSOPS Ta "MPLS label operations"
391 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
392 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
393 .It Li U Ta Dv RTF_UP Ta "Route usable"
394 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
395 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
398 Direct routes are created for each
399 interface attached to the local host;
400 the gateway field for such entries shows the address of the outgoing interface.
401 The refcnt field gives the
402 current number of active uses of the route.
404 protocols normally hold on to a single route for the duration of
405 a connection while connectionless protocols obtain a route while sending
406 to the same destination.
407 The use field provides a count of the number of packets
408 sent using that route.
409 The interface entry indicates the network interface utilized for the route.
417 interval argument, it displays a running count of statistics related to
419 An obsolescent version of this option used a numeric parameter
420 with no option, and is currently supported for backward compatibility.
421 By default, this display summarizes information for all interfaces.
422 Information for a specific interface may be displayed with the
450 IPv6 support was added by WIDE/KAME project.
452 The notion of errors is ill-defined.