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 the flowid and flowtype for each internet socket.
92 is present, display information from the TCP control block, including
93 retransmits, out-of-order packets received, and zero-sized windows advertised.
97 .Fl i | I Ar interface
99 .Op Fl f Ar address_family
102 Show the state of all network interfaces or a single
104 which have been auto-configured
105 (interfaces statically configured into a system, but not
106 located at boot time are not shown).
109 after an interface name indicates that the interface is
113 is also present, multicast addresses currently in use are shown
114 for each Ethernet interface and for each IP interface address.
115 Multicast addresses are shown on separate lines following the interface
116 address with which they are associated.
119 is also present, show the number of bytes in and out.
122 is also present, show the number of dropped packets.
125 is also present, print all counters in human readable form.
128 is also present, print interface names using a wider field size.
133 .Op Fl I Ar interface
143 display the information regarding packet
144 traffic on all configured network interfaces
149 is also present, exit after
154 is also present, show the number of dropped packets.
160 .Op Fl f Ar protocol_family | Fl p Ar protocol
165 Display system-wide statistics for each network protocol,
167 .Ar protocol_family ,
172 is repeated, counters with a value of zero are suppressed.
175 is also present, reset statistic counters after displaying them.
179 .Fl i | I Ar interface Fl s
181 .Op Fl f Ar protocol_family | Fl p Ar protocol
186 Display per-interface statistics for each network protocol,
188 .Ar protocol_family ,
199 Show statistics recorded by the memory management routines
201 The network manages a private pool of memory buffers.
207 .Op Fl I Ar interface
210 Show statistics about
213 This includes information like
214 how many packets have been matched, dropped and received by the
215 bpf device, also information about current buffer sizes and device
223 .Op Fl f Ar address_family
228 Display the contents of routing tables.
231 is specified, a routing table for a particular
236 is specified, a routing table with the number
244 the default routing table is displayed.
248 show the contents of the internal Patricia tree
249 structures; used for debugging.
267 Display routing statistics.
270 is repeated, counters with a value of zero are suppressed.
276 .Op Fl f Ar address_family
281 Display the contents of the multicast virtual interface tables,
282 and multicast forwarding caches.
283 Entries in these tables will appear only when the kernel is
284 actively forwarding multicast sessions.
285 This option is applicable only to the
295 .Op Fl f Ar address_family
300 Show multicast routing statistics.
303 is repeated, counters with a value of zero are suppressed.
313 The flags field shows available ISR handlers:
314 .Bl -column ".Li W" ".Dv NETISR_SNP_FLAGS_DRAINEDCPU"
315 .It Li C Ta Dv NETISR_SNP_FLAGS_M2CPUID Ta "Able to map mbuf to cpu id"
316 .It Li D Ta Dv NETISR_SNP_FLAGS_DRAINEDCPU Ta "Has queue drain handler"
317 .It Li F Ta Dv NETISR_SNP_FLAGS_M2FLOW Ta "Able to map mbuf to flow id"
321 Some options have the general meaning:
331 .It Fl f Ar address_family , Fl p Ar protocol
332 Limit display to those records
337 The following address families and protocols are recognized:
339 .Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact
342 .It Cm inet Pq Dv AF_INET
343 .Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp
344 .It Cm inet6 Pq Dv AF_INET6
345 .Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp
346 .It Cm pfkey Pq Dv PF_KEY
348 .It Cm netgraph , ng Pq Dv AF_NETGRAPH
350 .It Cm unix Pq Dv AF_UNIX
351 .It Cm link Pq Dv AF_LINK
354 The program will complain if
356 is unknown or if there is no statistics routine for it.
358 Extract values associated with the name list from the specified core
359 instead of the default
362 Extract the name list from the specified system instead of the default,
363 which is the kernel image the system has booted from.
365 Show network addresses and ports as numbers.
368 attempts to resolve addresses and ports,
369 and display them symbolically.
371 In certain displays, avoid truncating addresses even if this causes
372 some fields to overflow.
374 Display the flowid and flowtype for each socket.
375 flowid is a 32 bit hardware specific identifier for each flow.
376 flowtype defines which protocol fields are hashed to produce the id.
377 A complete listing is available in sys/mbuf.h under M_HASHTYPE_*
380 The default display, for active sockets, shows the local
381 and remote addresses, send and receive queue sizes (in bytes), protocol,
382 and the internal state of the protocol.
383 Address formats are of the form
387 if a socket's address specifies a network but no specific host address.
388 When known, the host and network addresses are displayed symbolically
389 according to the databases
394 If a symbolic name for an address is unknown, or if
397 option is specified, the address is printed numerically, according
398 to the address family.
399 For more information regarding
407 addresses and ports appear as
410 The interface display provides a table of cumulative
411 statistics regarding packets transferred, errors, and collisions.
412 The network addresses of the interface
413 and the maximum transmission unit
417 The routing table display indicates the available routes and their status.
418 Each route consists of a destination host or network, and a gateway to use
419 in forwarding packets.
420 The flags field shows a collection of information about the route stored
422 The individual flags are discussed in more detail in the
427 The mapping between letters and flags is:
428 .Bl -column ".Li W" ".Dv RTF_WASCLONED"
429 .It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1"
430 .It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2"
431 .It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3"
432 .It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)"
433 .It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address"
434 .It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)"
435 .It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary"
436 .It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)"
437 .It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation"
438 .It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)"
439 .It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable"
440 .It Li S Ta Dv RTF_STATIC Ta "Manually added"
441 .It Li U Ta Dv RTF_UP Ta "Route usable"
442 .It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address"
445 Direct routes are created for each
446 interface attached to the local host;
447 the gateway field for such entries shows the address of the outgoing interface.
448 The refcnt field gives the
449 current number of active uses of the route.
451 protocols normally hold on to a single route for the duration of
452 a connection while connectionless protocols obtain a route while sending
453 to the same destination.
454 The use field provides a count of the number of packets
455 sent using that route.
456 The interface entry indicates the network interface utilized for the route.
464 interval argument, it displays a running count of statistics related to
466 An obsolescent version of this option used a numeric parameter
467 with no option, and is currently supported for backward compatibility.
468 By default, this display summarizes information for all interfaces.
469 Information for a specific interface may be displayed with the
479 option represent the underlying parameters of the bpf peer.
481 represented as a single lower case letter.
482 The mapping between the letters and flags in order of appearance are:
484 .It Li p Ta Set if listening promiscuously
485 .It Li i Ta Dv BIOCIMMEDIATE No has been set on the device
486 .It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being
488 .It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and
489 remotely on the interface.
490 .It Li a Ta Packet reception generates a signal
491 .It Li l Ta Dv BIOCLOCK No status: descriptor has been locked
494 For more information about these flags, please refer to
501 to output all the information recorded about data
502 stored in the socket buffers.
504 .Bl -column ".Li R-MBUF"
505 .It Li R-MBUF Ta Number of mbufs in the receive queue.
506 .It Li S-MBUF Ta Number of mbufs in the send queue.
507 .It Li R-CLUS Ta Number of clusters, of any type, in the receive
509 .It Li S-CLUS Ta Number of clusters, of any type, in the send queue.
510 .It Li R-HIWA Ta Receive buffer high water mark, in bytes.
511 .It Li S-HIWA Ta Send buffer high water mark, in bytes.
512 .It Li R-LOWA Ta Receive buffer low water mark, in bytes.
513 .It Li S-LOWA Ta Send buffer low water mark, in bytes.
514 .It Li R-BCNT Ta Receive buffer byte count.
515 .It Li S-BCNT Ta Send buffer byte count.
516 .It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer.
517 .It Li S-BMAX Ta Maximum bytes that can be used in the send buffer.
544 IPv6 support was added by WIDE/KAME project.
546 The notion of errors is ill-defined.
projects / FreeBSD / FreeBSD.git / blob