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
33 .\" $FreeBSD: src/usr.bin/netstat/netstat.1,v 1.22.2.13 2003/05/03 22:10:02 keramida Exp $
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
54 .Op Fl f Ar protocol_family | Fl p Ar protocol
59 Display a list of active sockets
60 (protocol control blocks)
61 for each network protocol,
69 show the address of a protocol control block (PCB)
70 associated with a socket; used for debugging.
74 show the state of all sockets;
75 normally sockets used by server processes are not shown.
79 show the size of the various listen queues.
80 The first count shows the number of unaccepted connections,
81 the second count shows the amount of unaccepted incomplete connections,
82 and the third count is the maximum number of queued connections.
86 show network addresses as numbers (as with
88 but show ports symbolically.
92 .Fl i | I Ar interface
94 .Op Fl f Ar address_family
99 Show the state of all network interfaces or a single
101 which have been auto-configured
102 (interfaces statically configured into a system, but not
103 located at boot time are not shown).
106 after an interface name indicates that the interface is
110 is also present, multicast addresses currently in use are shown
111 for each Ethernet interface and for each IP interface address.
112 Multicast addresses are shown on separate lines following the interface
113 address with which they are associated.
116 is also present, show the number of bytes in and out.
119 is also present, show the number of dropped packets.
122 is also present, show the contents of watchdog timers.
125 is also present, the maximum buffer sizes are displayed instead
126 of current buffer usage.
131 .Op Fl I Ar interface
140 display the information regarding packet
141 traffic on all configured network interfaces
146 is also present, show the number of dropped packets.
152 .Op Fl f Ar protocol_family | Fl p Ar protocol
157 Display system-wide statistics for each network protocol,
159 .Ar protocol_family ,
164 is repeated, counters with a value of zero are suppressed.
167 is also present, reset statistic counters after displaying them.
171 .Fl i | I Ar interface Fl s
172 .Op Fl f Ar protocol_family | Fl p Ar protocol
177 Display per-interface statistics for each network protocol,
179 .Ar protocol_family ,
190 Show statistics recorded by the memory management routines
192 The network manages a private pool of memory buffers.
198 .Op Fl f Ar address_family
203 Display the contents of all routing tables,
204 or a routing table for a particular
209 show the contents of the internal Patricia tree
210 structures; used for debugging.
214 show protocol-cloned routes
215 (routes generated by an
218 normally these routes are not shown.
225 and MPLS label operations
236 Display routing statistics.
239 is repeated, counters with a value of zero are suppressed.
245 .Op Fl f Ar address_family
250 Show information related to multicast (group address) routing.
251 By default, show the IP Multicast virtual-interface and routing tables.
257 .Op Fl f Ar address_family
262 Show multicast routing statistics.
265 is repeated, counters with a value of zero are suppressed.
268 Some options have the general meaning:
271 On SMP systems the route table is replicated. This option allows
272 the route table for a specific cpu to be accessed and exists
273 primarily for debugging purposes.
274 .It Fl f Ar address_family , Fl f Ar protocol_family , Fl p Ar protocol
275 Limit display to those records
281 The following address families, protocol families and protocols are recognized:
283 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
286 .It Cm inet Pq Dv AF_INET PF_INET
287 .Cm carp , divert , icmp , igmp , ip , ipsec , pim , tcp , udp
288 .It Cm inet6 Pq Dv AF_INET6 PF_INET6
289 .Cm carp , icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
290 .It Cm pfkey Pq Dv AF_KEY PF_KEY
292 .It Cm netgraph , ng Pq Dv AF_NETGRAPH PF_NETGRAPH
294 .It Cm ipx Pq Dv AF_IPX PF_IPX
296 .\".It Cm ns Pq Dv AF_NS PF_NS
297 .\".Cm idp , ns_err , spp
298 .\".It Cm iso Pq Dv AF_ISO PF_ISO
299 .\".Cm clnp , cltp , esis , tp
300 .It Cm unix Pq Dv AF_UNIX PF_UNIX
301 .It Cm link Pq Dv AF_LINK PF_LINK
302 .It Cm mpls Pq Dv AF_MPLS PF_MPLS
305 The program will complain if
307 is unknown or if there is no statistics routine for it.
311 option is equivalent to
314 Extract values associated with the name list from the specified core
315 instead of the default
318 Extract the name list from the specified system instead of the default,
319 which is the kernel image the system has booted from.
321 Show network addresses and ports as numbers.
324 attempts to resolve addresses and ports,
325 and display them symbolically.
327 Display additional protocol-specific information. For TCP the current
328 transmit window, unacked sequence space, and RTT is displayed.
331 In certain displays, add columns and avoid truncating
332 addresses even if this causes some fields to overflow.
335 The default display, for active sockets, shows the local
336 and remote addresses, send and receive queue sizes (in bytes), protocol,
337 and the internal state of the protocol.
338 Address formats are of the form
342 if a socket's address specifies a network but no specific host address.
343 When known, the host and network addresses are displayed symbolically
344 according to the databases
349 If a symbolic name for an address is unknown, or if
352 option is specified, the address is printed numerically, according
353 to the address family.
354 For more information regarding
362 addresses and ports appear as
365 The interface display provides a table of cumulative
366 statistics regarding packets transferred, errors, and collisions.
367 The network addresses of the interface
368 and the maximum transmission unit
372 The routing table display indicates the available routes and their status.
373 Each route consists of a destination host or network, and a gateway to use
374 in forwarding packets.
375 The flags field shows a collection of information about the route stored
377 The individual flags are discussed in more detail in the
382 The mapping between letters and flags is:
383 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
384 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
385 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
386 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
387 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
388 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
389 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
390 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
391 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
392 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
393 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
394 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
395 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
396 .It Li m Ta Dv RTF_MPLSOPS Ta "MPLS label operations"
397 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
398 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
399 .It Li U Ta Dv RTF_UP Ta "Route usable"
400 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
401 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
404 Direct routes are created for each
405 interface attached to the local host;
406 the gateway field for such entries shows the address of the outgoing interface.
407 The refcnt field gives the
408 current number of active uses of the route.
410 protocols normally hold on to a single route for the duration of
411 a connection while connectionless protocols obtain a route while sending
412 to the same destination.
413 The use field provides a count of the number of packets
414 sent using that route.
415 The interface entry indicates the network interface utilized for the route.
423 interval argument, it displays a running count of statistics related to
425 An obsolescent version of this option used a numeric parameter
426 with no option, and is currently supported for backward compatibility.
427 By default, this display summarizes information for all interfaces.
428 Information for a specific interface may be displayed with the
456 IPv6 support was added by WIDE/KAME project.
458 The notion of errors is ill-defined.