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, print all counters in human readable form.
121 is also present, show the contents of watchdog timers.
124 is also present, the maximum buffer sizes are displayed instead
125 of current buffer usage.
130 .Op Fl I Ar interface
139 display the information regarding packet
140 traffic on all configured network interfaces
145 is also present, show the number of dropped packets.
148 is also present, print counters in human readable form.
154 .Op Fl f Ar protocol_family | Fl p Ar protocol
159 Display system-wide statistics for each network protocol,
161 .Ar protocol_family ,
166 is repeated, counters with a value of zero are suppressed.
169 is also present, reset statistic counters after displaying them.
173 .Fl i | I Ar interface Fl s
174 .Op Fl f Ar protocol_family | Fl p Ar protocol
179 Display per-interface statistics for each network protocol,
181 .Ar protocol_family ,
192 Show statistics recorded by the memory management routines
194 The network manages a private pool of memory buffers.
200 .Op Fl f Ar address_family
205 Display the contents of all routing tables,
206 or a routing table for a particular
211 show the contents of the internal Patricia tree
212 structures; used for debugging.
216 show protocol-cloned routes
217 (routes generated by an
220 normally these routes are not shown.
229 and MPLS label operations
240 Display routing statistics.
243 is repeated, counters with a value of zero are suppressed.
249 .Op Fl f Ar address_family
254 Show information related to multicast (group address) routing.
255 By default, show the IP Multicast virtual-interface and routing tables.
261 .Op Fl f Ar address_family
266 Show multicast routing statistics.
269 is repeated, counters with a value of zero are suppressed.
272 Some options have the general meaning:
275 On SMP systems the route table is replicated. This option allows
276 the route table for a specific cpu to be accessed and exists
277 primarily for debugging purposes.
278 .It Fl f Ar address_family , Fl f Ar protocol_family , Fl p Ar protocol
279 Limit display to those records
285 The following address families, protocol families and protocols are recognized:
287 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
290 .It Cm inet Pq Dv AF_INET PF_INET
291 .Cm carp , divert , icmp , igmp , ip , pim , tcp , udp
292 .It Cm inet6 Pq Dv AF_INET6 PF_INET6
293 .Cm carp , icmp6 , ip6 , rip6 , tcp , udp
294 .It Cm netgraph , ng Pq Dv AF_NETGRAPH PF_NETGRAPH
296 .It Cm unix Pq Dv AF_UNIX PF_UNIX
297 .It Cm link Pq Dv AF_LINK PF_LINK
298 .It Cm mpls Pq Dv AF_MPLS PF_MPLS
301 The program will complain if
303 is unknown or if there is no statistics routine for it.
307 option is equivalent to
310 Extract values associated with the name list from the specified core
311 instead of the default
314 Extract the name list from the specified system instead of the default,
315 which is the kernel image the system has booted from.
317 Show network addresses and ports as numbers.
320 attempts to resolve addresses and ports,
321 and display them symbolically.
323 Display additional protocol-specific information. For TCP the current
324 transmit window, unacked sequence space, and RTT is displayed.
327 In certain displays, add columns and avoid truncating
328 addresses even if this causes some fields to overflow.
331 The default display, for active sockets, shows the local
332 and remote addresses, send and receive queue sizes (in bytes), protocol,
333 and the internal state of the protocol.
334 Address formats are of the form
338 if a socket's address specifies a network but no specific host address.
339 When known, the host and network addresses are displayed symbolically
340 according to the databases
345 If a symbolic name for an address is unknown, or if
348 option is specified, the address is printed numerically, according
349 to the address family.
350 For more information regarding
358 addresses and ports appear as
361 The interface display provides a table of cumulative
362 statistics regarding packets transferred, errors, and collisions.
363 The network addresses of the interface
364 and the maximum transmission unit
368 The routing table display indicates the available routes and their status.
369 Each route consists of a destination host or network, and a gateway to use
370 in forwarding packets.
371 The flags field shows a collection of information about the route stored
373 The individual flags are discussed in more detail in the
378 The mapping between letters and flags is:
379 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
380 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
381 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
382 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
383 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
384 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
385 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
386 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
387 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
388 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
389 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
390 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
391 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
392 .It Li m Ta Dv RTF_MPLSOPS Ta "MPLS label operations"
393 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
394 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
395 .It Li U Ta Dv RTF_UP Ta "Route usable"
396 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
397 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
400 Direct routes are created for each
401 interface attached to the local host;
402 the gateway field for such entries shows the address of the outgoing interface.
403 The refcnt field gives the
404 current number of active uses of the route.
406 protocols normally hold on to a single route for the duration of
407 a connection while connectionless protocols obtain a route while sending
408 to the same destination.
409 The use field provides a count of the number of packets
410 sent using that route.
411 The interface entry indicates the network interface utilized for the route.
419 interval argument, it displays a running count of statistics related to
421 An obsolescent version of this option used a numeric parameter
422 with no option, and is currently supported for backward compatibility.
423 By default, this display summarizes information for all interfaces.
424 Information for a specific interface may be displayed with the
452 IPv6 support was added by WIDE/KAME project.
454 The notion of errors is ill-defined.