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
36 .Nd show network status and statistics
39 .Bl -tag -width "netstat"
43 .Op Fl f Ar protocol_family | Fl p Ar protocol
44 .It Nm Fl i | I Ar interface
47 .Op Fl f Ar address_family
60 .Op Fl f Ar protocol_family | Fl p Ar protocol
63 .It Nm Fl i | I Ar interface Fl s
66 .Op Fl f Ar protocol_family | Fl p Ar protocol
81 .Op Fl f Ar address_family
90 .Op Fl f Ar address_family
94 .Op Fl f Ar address_family
104 command shows the contents of various network-related
106 The arguments passed determine which of the below output formats the
108 .Bl -tag -width indent
113 .Op Fl f Ar protocol_family | Fl p Ar protocol
116 Display a list of active sockets
117 (protocol control blocks)
118 for each network protocol.
120 The default display for active sockets shows the local
121 and remote addresses, send and receive queue sizes (in bytes), protocol,
122 and the internal state of the protocol.
123 Address formats are of the form
127 if a socket's address specifies a network but no specific host address.
128 When known, the host and network addresses are displayed symbolically
129 according to the databases
134 If a symbolic name for an address is unknown, or if
137 option is specified, the address is printed numerically, according
138 to the address family.
139 For more information regarding
147 addresses and ports appear as
149 .Bl -tag -width indent
153 in a selection of different human and machine readable formats.
156 for details on command line arguments.
160 .Sx GENERAL OPTIONS .
164 .Sx GENERAL OPTIONS .
166 Show the address of a protocol control block (PCB)
167 associated with a socket; used for debugging.
169 Show the state of all sockets;
170 normally sockets used by server processes are not shown.
172 Show the used TCP stack for each session.
174 Show the congestion control algorithm and diagnostic information of TCP sockets.
176 Show the size of the various listen queues.
177 The first count shows the number of unaccepted connections,
178 the second count shows the amount of unaccepted incomplete connections,
179 and the third count is the maximum number of queued connections.
181 Do not resolve numeric addresses and port numbers to names.
183 .Sx GENERAL OPTIONS .
185 Display the log ID for each socket.
187 Display the flowid and flowtype for each socket.
188 flowid is a 32 bit hardware specific identifier for each flow.
189 flowtype defines which protocol fields are hashed to produce the id.
190 A complete listing is available in
195 Show network addresses as numbers (as with
197 but show ports symbolically.
199 Display diagnostic information from the TCP control block.
200 Fields include the number of packets requiring retransmission,
201 received out-of-order, and those advertising a zero-sized window.
203 Avoid truncating addresses even if this causes some fields to overflow.
205 Display socket buffer and TCP timer statistics for each
212 to output all the information recorded about data
213 stored in the socket buffers.
215 .Bl -column ".Li R-HIWA"
216 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
217 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
218 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
219 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
220 .It Li R-BCNT Ta Receive buffer byte count.
221 .It Li S-BCNT Ta Send buffer byte count.
222 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
223 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
224 .It Li rexmt Ta Time, in seconds, to fire Retransmit Timer, or 0 if not armed.
225 .It Li persist Ta Time, in seconds, to fire Retransmit Persistence, or 0 if not armed.
226 .It Li keep Ta Time, in seconds, to fire Keep Alive, or 0 if not armed.
227 .It Li 2msl Ta Time, in seconds, to fire 2*msl TIME_WAIT Timer, or 0 if not armed.
228 .It Li delack Ta Time, in seconds, to fire Delayed ACK Timer, or 0 if not armed.
229 .It Li rcvtime Ta Time, in seconds, since last packet received.
231 .It Fl f Ar protocol_family
233 .Ar protocol_family .
235 .Sx GENERAL OPTIONS .
240 .Sx GENERAL OPTIONS .
245 .Fl i | I Ar interface
247 .Op Fl f Ar address_family
252 Show the state of all network interfaces or a single
254 which have been auto-configured
255 (interfaces statically configured into a system, but not
256 located at boot time are not shown).
259 after an interface name indicates that the interface is
269 it provides a table of cumulative
270 statistics regarding packets transferred, errors, and collisions.
271 The network addresses of the interface
272 and the maximum transmission unit
281 overrides any instances of
283 .Bl -tag -width indent
287 .Sx GENERAL OPTIONS .
291 .Sx GENERAL OPTIONS .
293 Multicast addresses currently in use are shown
294 for each Ethernet interface and for each IP interface address.
295 Multicast addresses are shown on separate lines following the interface
296 address with which they are associated.
298 Show the number of bytes in and out.
300 Show the number of dropped packets.
302 Print all counters in human readable form.
304 Do not resolve numeric addresses and port numbers to names.
306 .Sx GENERAL OPTIONS .
308 Avoid truncating addresses even if this causes some fields to overflow.
310 .Sx GENERAL OPTIONS .
311 However, in most cases field widths are determined automatically with the
313 option, and this option has little effect.
314 .It Fl f Ar protocol_family
316 .Ar protocol_family .
318 .Sx GENERAL OPTIONS .
324 .Op Fl I Ar interface
333 seconds, display the information regarding packet traffic on all
334 configured network interfaces or a single
343 interval argument, it displays a running count of statistics related to
345 An obsolescent version of this option used a numeric parameter
346 with no option, and is currently supported for backward compatibility.
347 By default, this display summarizes information for all interfaces.
348 Information for a specific interface may be displayed with the
351 .Bl -tag -width indent
352 .It Fl I Ar interface
353 Only show information regarding
358 .Sx GENERAL OPTIONS .
362 .Sx GENERAL OPTIONS .
364 Show the number of dropped packets.
366 Use an alternative core.
368 .Sx GENERAL OPTIONS .
370 Use an alternative kernel image.
372 .Sx GENERAL OPTIONS .
383 .Op Fl f Ar protocol_family | Fl p Ar protocol
388 Display system-wide statistics for each network protocol.
389 .Bl -tag -width indent
393 .Sx GENERAL OPTIONS .
397 .Sx GENERAL OPTIONS .
401 is repeated, counters with a value of zero are suppressed.
403 Reset statistic counters after displaying them.
404 .It Fl f Ar protocol_family
406 .Ar protocol_family .
408 .Sx GENERAL OPTIONS .
413 .Sx GENERAL OPTIONS .
415 Use an alternative core.
417 .Sx GENERAL OPTIONS .
419 Use an alternative kernel image
421 .Sx GENERAL OPTIONS .
426 .Fl i | I Ar interface Fl s
428 .Op Fl f Ar protocol_family | Fl p Ar protocol
433 Display per-interface statistics for each network protocol.
440 overrides any instances of
442 .Bl -tag -width indent
446 .Sx GENERAL OPTIONS .
450 .Sx GENERAL OPTIONS .
454 is repeated, counters with a value of zero are suppressed.
455 .It Fl f Ar protocol_family
457 .Ar protocol_family .
459 .Sx GENERAL OPTIONS .
464 .Sx GENERAL OPTIONS .
466 Use an alternative core
468 .Sx GENERAL OPTIONS .
470 Use an alternative kernel image
472 .Sx GENERAL OPTIONS .
482 Show statistics recorded by the memory management routines
484 The network manages a private pool of memory buffers.
485 .Bl -tag -width indent
487 Use an alternative core
489 .Sx GENERAL OPTIONS .
491 Use an alternative kernel image
493 .Sx GENERAL OPTIONS .
500 .Op Fl I Ar interface
503 Show statistics about
506 This includes information like
507 how many packets have been matched, dropped and received by the
508 bpf device, also information about current buffer sizes and device
517 option represent the underlying parameters of the bpf peer.
519 represented as a single lower case letter.
520 The mapping between the letters and flags in order of appearance are:
522 .It Li p Ta Set if listening promiscuously
523 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
524 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
526 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
527 remotely on the interface.
528 .It Li a Ta Packet reception generates a signal
529 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
532 For more information about these flags, please refer to
534 .Bl -tag -width indent
536 Reset statistic counters after displaying them.
544 .Op Fl f Ar address_family
549 Display the contents of routing tables.
553 is invoked with the routing table option
555 it lists the available routes and their status.
556 Each route consists of a destination host or network, and a gateway to use
557 in forwarding packets.
558 The flags field shows a collection of information about the route stored
560 The individual flags are discussed in more detail in the
565 The mapping between letters and flags is:
566 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
567 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
568 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
569 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
570 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
571 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
572 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
573 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
574 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
575 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
576 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
577 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
578 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
579 .It Li U Ta Dv RTF_UP Ta "Route usable"
580 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
583 Direct routes are created for each
584 interface attached to the local host;
585 the gateway field for such entries shows the address of the outgoing interface.
586 The refcnt field gives the
587 current number of active uses of the route.
589 protocols normally hold on to a single route for the duration of
590 a connection while connectionless protocols obtain a route while sending
591 to the same destination.
592 The use field provides a count of the number of packets
593 sent using that route.
594 The interface entry indicates the network interface utilized for the route.
595 .Bl -tag -width indent
599 .Sx GENERAL OPTIONS .
603 .Sx GENERAL OPTIONS .
605 Do not resolve numeric addresses and port numbers to names.
607 .Sx GENERAL OPTIONS .
609 Show the path MTU for each route, and print interface names with a
612 Display the routing table with the number
619 the default routing table is displayed.
621 Display the routing table for a particular
624 Use an alternative core
626 .Sx GENERAL OPTIONS .
628 Use an alternative kernel image
630 .Sx GENERAL OPTIONS .
641 Display routing statistics.
642 .Bl -tag -width indent
646 is repeated, counters with a value of zero are suppressed.
648 Use an alternative core
650 .Sx GENERAL OPTIONS .
652 Use an alternative kernel image
654 .Sx GENERAL OPTIONS .
661 .Op Fl f Ar address_family
666 Display the contents of the multicast virtual interface tables,
667 and multicast forwarding caches.
668 Entries in these tables will appear only when the kernel is
669 actively forwarding multicast sessions.
670 This option is applicable only to the
675 .Bl -tag -width indent
679 .Sx GENERAL OPTIONS .
683 .Sx GENERAL OPTIONS .
685 Avoid truncating addresses even if this causes some fields to overflow.
686 .It Fl f Ar protocol_family
688 .Ar protocol_family .
690 .Sx GENERAL OPTIONS .
692 Use an alternative core
694 .Sx GENERAL OPTIONS .
696 Use an alternative kernel image
698 .Sx GENERAL OPTIONS .
705 .Op Fl f Ar address_family
710 Show multicast routing statistics.
711 .Bl -tag -width indent
715 .Sx GENERAL OPTIONS .
719 .Sx GENERAL OPTIONS .
723 is repeated, counters with a value of zero are suppressed.
724 .It Fl f Ar protocol_family
726 .Ar protocol_family .
728 .Sx GENERAL OPTIONS .
730 Use an alternative core
732 .Sx GENERAL OPTIONS .
734 Use an alternative kernel image
736 .Sx GENERAL OPTIONS .
747 The flags field shows available ISR handlers:
748 .Bl -column ".Li W" ".Dv NETISR_SNP_FLAGS_DRAINEDCPU"
749 .It Li C Ta Dv NETISR_SNP_FLAGS_M2CPUID Ta "Able to map mbuf to cpu id"
750 .It Li D Ta Dv NETISR_SNP_FLAGS_DRAINEDCPU Ta "Has queue drain handler"
751 .It Li F Ta Dv NETISR_SNP_FLAGS_M2FLOW Ta "Able to map mbuf to flow id"
755 Some options have the general meaning:
767 .It Fl f Ar address_family , Fl p Ar protocol
768 Limit display to those records
773 The following address families and protocols are recognized:
775 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
778 .It Cm inet Pq Dv AF_INET
779 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
780 .It Cm inet6 Pq Dv AF_INET6
781 .Cm icmp6 , ip6 , ipsec6 , rip6 , sctp , tcp , udp
782 .It Cm pfkey Pq Dv PF_KEY
784 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
786 .It Cm unix Pq Dv AF_UNIX
787 .It Cm link Pq Dv AF_LINK
790 The program will complain if
792 is unknown or if there is no statistics routine for it.
794 Extract values associated with the name list from the specified core
795 instead of the default
798 Extract the name list from the specified system instead of the default,
799 which is the kernel image the system has booted from.
801 Show network addresses and ports as numbers.
804 attempts to resolve addresses and ports,
805 and display them symbolically.
807 Wider output; expand address fields, etc, to avoid truncation.
808 Non-numeric values such as domain names may still be truncated; use the
810 option if necessary to avoid ambiguity.
813 Show packet traffic information (packets, bytes, errors, packet drops, etc) for
814 interface re0 updated every 2 seconds and exit after 5 outputs:
815 .Bd -literal -offset indent
816 $ netstat -w 2 -q 5 -I re0
819 Show statistics for ICMP on any interface:
820 .Bd -literal -offset indent
825 .Bd -literal -offset indent
829 Same as above, but without resolving numeric addresses and port numbers to
831 .Bd -literal -offset indent
841 .Xr xo_parse_args 3 ,
860 IPv6 support was added by WIDE/KAME project.
862 The notion of errors is ill-defined.
projects / FreeBSD / FreeBSD.git / blob