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 .\" 4. 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
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
49 .Op Fl f Ar protocol_family | Fl p Ar protocol
54 Display a list of active sockets
55 (protocol control blocks)
56 for each network protocol,
64 show the address of a protocol control block (PCB)
65 associated with a socket; used for debugging.
69 show the state of all sockets;
70 normally sockets used by server processes are not shown.
74 show the size of the various listen queues.
75 The first count shows the number of unaccepted connections,
76 the second count shows the amount of unaccepted incomplete connections,
77 and the third count is the maximum number of queued connections.
81 show network addresses as numbers (as with
83 but show ports symbolically.
86 is present, display socket buffer and tcp timer statistics for each internet socket.
89 is present, display information from the TCP control block, including
90 retransmits, out-of-order packets received, and zero-sized windows advertised.
94 .Fl i | I Ar interface
96 .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, print all counters in human readable form.
125 is also present, print interface names using a wider field size.
130 .Op Fl I Ar interface
140 display the information regarding packet
141 traffic on all configured network interfaces
146 is also present, exit after
151 is also present, show the number of dropped packets.
157 .Op Fl f Ar protocol_family | Fl p Ar protocol
162 Display system-wide statistics for each network protocol,
164 .Ar protocol_family ,
169 is repeated, counters with a value of zero are suppressed.
172 is also present, reset statistic counters after displaying them.
176 .Fl i | I Ar interface Fl s
178 .Op Fl f Ar protocol_family | Fl p Ar protocol
183 Display per-interface statistics for each network protocol,
185 .Ar protocol_family ,
196 Show statistics recorded by the memory management routines
198 The network manages a private pool of memory buffers.
204 .Op Fl I Ar interface
207 Show statistics about
210 This includes information like
211 how many packets have been matched, dropped and received by the
212 bpf device, also information about current buffer sizes and device
220 .Op Fl f Ar address_family
225 Display the contents of routing tables.
228 is specified, a routing table for a particular
233 is specified, a routing table with the number
241 the default routing table is displayed.
245 show the contents of the internal Patricia tree
246 structures; used for debugging.
264 Display routing statistics.
267 is repeated, counters with a value of zero are suppressed.
273 .Op Fl f Ar address_family
278 Display the contents of the multicast virtual interface tables,
279 and multicast forwarding caches.
280 Entries in these tables will appear only when the kernel is
281 actively forwarding multicast sessions.
282 This option is applicable only to the
292 .Op Fl f Ar address_family
297 Show multicast routing statistics.
300 is repeated, counters with a value of zero are suppressed.
310 The flags field shows available ISR handlers:
311 .Bl -column ".Li W" ".Dv NETISR_SNP_FLAGS_DRAINEDCPU"
312 .It Li C Ta Dv NETISR_SNP_FLAGS_M2CPUID Ta "Able to map mbuf to cpu id"
313 .It Li D Ta Dv NETISR_SNP_FLAGS_DRAINEDCPU Ta "Has queue drain handler"
314 .It Li F Ta Dv NETISR_SNP_FLAGS_M2FLOW Ta "Able to map mbuf to flow id"
318 Some options have the general meaning:
328 .It Fl f Ar address_family , Fl p Ar protocol
329 Limit display to those records
334 The following address families and protocols are recognized:
336 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
339 .It Cm inet Pq Dv AF_INET
340 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
341 .It Cm inet6 Pq Dv AF_INET6
342 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
343 .It Cm pfkey Pq Dv PF_KEY
345 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
347 .It Cm unix Pq Dv AF_UNIX
348 .It Cm link Pq Dv AF_LINK
351 The program will complain if
353 is unknown or if there is no statistics routine for it.
355 Extract values associated with the name list from the specified core
356 instead of the default
359 Extract the name list from the specified system instead of the default,
360 which is the kernel image the system has booted from.
362 Show network addresses and ports as numbers.
365 attempts to resolve addresses and ports,
366 and display them symbolically.
368 In certain displays, avoid truncating addresses even if this causes
369 some fields to overflow.
372 The default display, for active sockets, shows the local
373 and remote addresses, send and receive queue sizes (in bytes), protocol,
374 and the internal state of the protocol.
375 Address formats are of the form
379 if a socket's address specifies a network but no specific host address.
380 When known, the host and network addresses are displayed symbolically
381 according to the databases
386 If a symbolic name for an address is unknown, or if
389 option is specified, the address is printed numerically, according
390 to the address family.
391 For more information regarding
399 addresses and ports appear as
402 The interface display provides a table of cumulative
403 statistics regarding packets transferred, errors, and collisions.
404 The network addresses of the interface
405 and the maximum transmission unit
409 The routing table display indicates the available routes and their status.
410 Each route consists of a destination host or network, and a gateway to use
411 in forwarding packets.
412 The flags field shows a collection of information about the route stored
414 The individual flags are discussed in more detail in the
419 The mapping between letters and flags is:
420 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
421 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
422 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
423 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
424 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
425 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
426 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
427 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
428 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
429 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
430 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
431 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
432 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
433 .It Li U Ta Dv RTF_UP Ta "Route usable"
434 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
437 Direct routes are created for each
438 interface attached to the local host;
439 the gateway field for such entries shows the address of the outgoing interface.
440 The refcnt field gives the
441 current number of active uses of the route.
443 protocols normally hold on to a single route for the duration of
444 a connection while connectionless protocols obtain a route while sending
445 to the same destination.
446 The use field provides a count of the number of packets
447 sent using that route.
448 The interface entry indicates the network interface utilized for the route.
456 interval argument, it displays a running count of statistics related to
458 An obsolescent version of this option used a numeric parameter
459 with no option, and is currently supported for backward compatibility.
460 By default, this display summarizes information for all interfaces.
461 Information for a specific interface may be displayed with the
471 option represent the underlying parameters of the bpf peer.
473 represented as a single lower case letter.
474 The mapping between the letters and flags in order of appearance are:
476 .It Li p Ta Set if listening promiscuously
477 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
478 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
480 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
481 remotely on the interface.
482 .It Li a Ta Packet reception generates a signal
483 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
486 For more information about these flags, please refer to
493 to output all the information recorded about data
494 stored in the socket buffers.
496 .Bl -column ".Li R-MBUF"
497 .It Li R-MBUF Ta Number of mbufs in the receive queue.
498 .It Li S-MBUF Ta Number of mbufs in the send queue.
499 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
501 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
502 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
503 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
504 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
505 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
506 .It Li R-BCNT Ta Receive buffer byte count.
507 .It Li S-BCNT Ta Send buffer byte count.
508 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
509 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
536 IPv6 support was added by WIDE/KAME project.
538 The notion of errors is ill-defined.
projects / FreeBSD / FreeBSD.git / blob