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
101 Show the state of all network interfaces or a single
103 which have been auto-configured
104 (interfaces statically configured into a system, but not
105 located at boot time are not shown).
108 after an interface name indicates that the interface is
112 is also present, multicast addresses currently in use are shown
113 for each Ethernet interface and for each IP interface address.
114 Multicast addresses are shown on separate lines following the interface
115 address with which they are associated.
118 is also present, show the number of bytes in and out.
121 is also present, show the number of dropped packets.
124 is also present, print all counters in human readable form.
127 is also present, print interface names using a wider field size.
132 .Op Fl I Ar interface
142 display the information regarding packet
143 traffic on all configured network interfaces
148 is also present, exit after
153 is also present, show the number of dropped packets.
159 .Op Fl f Ar protocol_family | Fl p Ar protocol
164 Display system-wide statistics for each network protocol,
166 .Ar protocol_family ,
171 is repeated, counters with a value of zero are suppressed.
174 is also present, reset statistic counters after displaying them.
178 .Fl i | I Ar interface Fl s
179 .Op Fl f Ar protocol_family | Fl p Ar protocol
184 Display per-interface statistics for each network protocol,
186 .Ar protocol_family ,
197 Show statistics recorded by the memory management routines
199 The network manages a private pool of memory buffers.
205 .Op Fl I Ar interface
208 Show statistics about
211 This includes information like
212 how many packets have been matched, dropped and received by the
213 bpf device, also information about current buffer sizes and device
221 .Op Fl f Ar address_family
226 Display the contents of routing tables.
229 is specified, a routing table for a particular
234 is specified, a routing table with the number
242 the default routing table is displayed.
246 show the contents of the internal Patricia tree
247 structures; used for debugging.
251 show protocol-cloned routes
252 (routes generated by an
255 normally these routes are not shown.
273 Display routing statistics.
276 is repeated, counters with a value of zero are suppressed.
282 .Op Fl f Ar address_family
287 Display the contents of the multicast virtual interface tables,
288 and multicast forwarding caches.
289 Entries in these tables will appear only when the kernel is
290 actively forwarding multicast sessions.
291 This option is applicable only to the
301 .Op Fl f Ar address_family
306 Show multicast routing statistics.
309 is repeated, counters with a value of zero are suppressed.
319 The flags field shows available ISR handlers:
320 .Bl -column ".Li W" ".Dv NETISR_SNP_FLAGS_DRAINEDCPU"
321 .It Li C Ta Dv NETISR_SNP_FLAGS_M2CPUID Ta "Able to map mbuf to cpu id"
322 .It Li D Ta Dv NETISR_SNP_FLAGS_DRAINEDCPU Ta "Has queue drain handler"
323 .It Li F Ta Dv NETISR_SNP_FLAGS_M2FLOW Ta "Able to map mbuf to flow id"
327 Some options have the general meaning:
329 .It Fl f Ar address_family , Fl p Ar protocol
330 Limit display to those records
335 The following address families and protocols are recognized:
337 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
340 .It Cm inet Pq Dv AF_INET
341 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
342 .It Cm inet6 Pq Dv AF_INET6
343 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
344 .It Cm pfkey Pq Dv PF_KEY
346 .It Cm atalk Pq Dv AF_APPLETALK
348 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
350 .It Cm ipx Pq Dv AF_IPX
352 .\".It Cm ns Pq Dv AF_NS
353 .\".Cm idp , ns_err , spp
354 .\".It Cm iso Pq Dv AF_ISO
355 .\".Cm clnp , cltp , esis , tp
356 .It Cm unix Pq Dv AF_UNIX
357 .It Cm link Pq Dv AF_LINK
360 The program will complain if
362 is unknown or if there is no statistics routine for it.
364 Extract values associated with the name list from the specified core
365 instead of the default
368 Extract the name list from the specified system instead of the default,
369 which is the kernel image the system has booted from.
371 Show network addresses and ports as numbers.
374 attempts to resolve addresses and ports,
375 and display them symbolically.
377 In certain displays, avoid truncating addresses even if this causes
378 some fields to overflow.
381 The default display, for active sockets, shows the local
382 and remote addresses, send and receive queue sizes (in bytes), protocol,
383 and the internal state of the protocol.
384 Address formats are of the form
388 if a socket's address specifies a network but no specific host address.
389 When known, the host and network addresses are displayed symbolically
390 according to the databases
395 If a symbolic name for an address is unknown, or if
398 option is specified, the address is printed numerically, according
399 to the address family.
400 For more information regarding
408 addresses and ports appear as
411 The interface display provides a table of cumulative
412 statistics regarding packets transferred, errors, and collisions.
413 The network addresses of the interface
414 and the maximum transmission unit
418 The routing table display indicates the available routes and their status.
419 Each route consists of a destination host or network, and a gateway to use
420 in forwarding packets.
421 The flags field shows a collection of information about the route stored
423 The individual flags are discussed in more detail in the
428 The mapping between letters and flags is:
429 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
430 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
431 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
432 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
433 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
434 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
435 .It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use"
436 .It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use"
437 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
438 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
439 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
440 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
441 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
442 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
443 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
444 .It Li U Ta Dv RTF_UP Ta "Route usable"
445 .It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning"
446 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
449 Direct routes are created for each
450 interface attached to the local host;
451 the gateway field for such entries shows the address of the outgoing interface.
452 The refcnt field gives the
453 current number of active uses of the route.
455 protocols normally hold on to a single route for the duration of
456 a connection while connectionless protocols obtain a route while sending
457 to the same destination.
458 The use field provides a count of the number of packets
459 sent using that route.
460 The interface entry indicates the network interface utilized for the route.
468 interval argument, it displays a running count of statistics related to
470 An obsolescent version of this option used a numeric parameter
471 with no option, and is currently supported for backward compatibility.
472 By default, this display summarizes information for all interfaces.
473 Information for a specific interface may be displayed with the
483 option represent the underlying parameters of the bpf peer.
485 represented as a single lower case letter.
486 The mapping between the letters and flags in order of appearance are:
488 .It Li p Ta Set if listening promiscuously
489 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
490 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
492 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
493 remotely on the interface.
494 .It Li a Ta Packet reception generates a signal
495 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
498 For more information about these flags, please refer to
505 to output all the information recorded about data
506 stored in the socket buffers.
508 .Bl -column ".Li R-MBUF"
509 .It Li R-MBUF Ta Number of mbufs in the receive queue.
510 .It Li S-MBUF Ta Number of mbufs in the send queue.
511 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
513 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
514 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
515 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
516 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
517 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
518 .It Li R-BCNT Ta Receive buffer byte count.
519 .It Li S-BCNT Ta Send buffer byte count.
520 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
521 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
548 IPv6 support was added by WIDE/KAME project.
550 The notion of errors is ill-defined.
projects / FreeBSD / releng / 10.0.git / blob