1.\" Copyright (c) 1983, 1990, 1992, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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. 15.\" 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 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)netstat.1 8.8 (Berkeley) 4/18/94 29.\" $FreeBSD$ 30.\" 31.Dd January 11, 2014 32.Dt NETSTAT 1 33.Os 34.Sh NAME 35.Nm netstat 36.Nd show network status 37.Sh DESCRIPTION 38The 39.Nm 40command symbolically displays the contents of various network-related 41data structures. 42There are a number of output formats, 43depending on the options for the information presented. 44.Bl -tag -width indent 45.It Xo 46.Bk -words 47.Nm 48.Op Fl 46AaLnSTWx 49.Op Fl f Ar protocol_family | Fl p Ar protocol 50.Op Fl M Ar core 51.Op Fl N Ar system 52.Ek 53.Xc 54Display a list of active sockets 55(protocol control blocks) 56for each network protocol, 57for a particular 58.Ar protocol_family , 59or for a single 60.Ar protocol . 61If 62.Fl A 63is also present, 64show the address of a protocol control block (PCB) 65associated with a socket; used for debugging. 66If 67.Fl a 68is also present, 69show the state of all sockets; 70normally sockets used by server processes are not shown. 71If 72.Fl L 73is also present, 74show the size of the various listen queues. 75The first count shows the number of unaccepted connections, 76the second count shows the amount of unaccepted incomplete connections, 77and the third count is the maximum number of queued connections. 78If 79.Fl S 80is also present, 81show network addresses as numbers (as with 82.Fl n ) 83but show ports symbolically. 84If 85.Fl x 86is present, display socket buffer and tcp timer statistics for each internet socket. 87When 88.Fl T 89is present, display information from the TCP control block, including 90retransmits, out-of-order packets received, and zero-sized windows advertised. 91.It Xo 92.Bk -words 93.Nm 94.Fl i | I Ar interface 95.Op Fl 46abdhnW 96.Op Fl f Ar address_family 97.Ek 98.Xc 99Show the state of all network interfaces or a single 100.Ar interface 101which have been auto-configured 102(interfaces statically configured into a system, but not 103located at boot time are not shown). 104An asterisk 105.Pq Dq Li * 106after an interface name indicates that the interface is 107.Dq down . 108If 109.Fl a 110is also present, multicast addresses currently in use are shown 111for each Ethernet interface and for each IP interface address. 112Multicast addresses are shown on separate lines following the interface 113address with which they are associated. 114If 115.Fl b 116is also present, show the number of bytes in and out. 117If 118.Fl d 119is also present, show the number of dropped packets. 120If 121.Fl h 122is also present, print all counters in human readable form. 123If 124.Fl W 125is also present, print interface names using a wider field size. 126.It Xo 127.Bk -words 128.Nm 129.Fl w Ar wait 130.Op Fl I Ar interface 131.Op Fl d 132.Op Fl M Ar core 133.Op Fl N Ar system 134.Op Fl q Ar howmany 135.Ek 136.Xc 137At intervals of 138.Ar wait 139seconds, 140display the information regarding packet 141traffic on all configured network interfaces 142or a single 143.Ar interface . 144If 145.Fl q 146is also present, exit after 147.Ar howmany 148outputs. 149If 150.Fl d 151is also present, show the number of dropped packets. 152.It Xo 153.Bk -words 154.Nm 155.Fl s Op Fl s 156.Op Fl 46z 157.Op Fl f Ar protocol_family | Fl p Ar protocol 158.Op Fl M Ar core 159.Op Fl N Ar system 160.Ek 161.Xc 162Display system-wide statistics for each network protocol, 163for a particular 164.Ar protocol_family , 165or for a single 166.Ar protocol . 167If 168.Fl s 169is repeated, counters with a value of zero are suppressed. 170If 171.Fl z 172is also present, reset statistic counters after displaying them. 173.It Xo 174.Bk -words 175.Nm 176.Fl i | I Ar interface Fl s 177.Op Fl 46 178.Op Fl f Ar protocol_family | Fl p Ar protocol 179.Op Fl M Ar core 180.Op Fl N Ar system 181.Ek 182.Xc 183Display per-interface statistics for each network protocol, 184for a particular 185.Ar protocol_family , 186or for a single 187.Ar protocol . 188.It Xo 189.Bk -words 190.Nm 191.Fl m 192.Op Fl M Ar core 193.Op Fl N Ar system 194.Ek 195.Xc 196Show statistics recorded by the memory management routines 197.Pq Xr mbuf 9 . 198The network manages a private pool of memory buffers. 199.It Xo 200.Bk -words 201.Nm 202.Fl B 203.Op Fl z 204.Op Fl I Ar interface 205.Ek 206.Xc 207Show statistics about 208.Xr bpf 4 209peers. 210This includes information like 211how many packets have been matched, dropped and received by the 212bpf device, also information about current buffer sizes and device 213states. 214.It Xo 215.Bk -words 216.Nm 217.Fl r 218.Op Fl 46AanW 219.Op Fl F Ar fibnum 220.Op Fl f Ar address_family 221.Op Fl M Ar core 222.Op Fl N Ar system 223.Ek 224.Xc 225Display the contents of routing tables. 226When 227.Fl f 228is specified, a routing table for a particular 229.Ar address_family 230is displayed. 231When 232.Fl F 233is specified, a routing table with the number 234.Ar fibnum 235is displayed. 236If the specified 237.Ar fibnum 238is -1 or 239.Fl F 240is not specified, 241the default routing table is displayed. 242If 243.Fl A 244is also present, 245show the contents of the internal Patricia tree 246structures; used for debugging. 247When 248.Fl W 249is also present, 250show the path MTU 251for each route, 252and print interface 253names with a wider 254field size. 255.It Xo 256.Bk -words 257.Nm 258.Fl rs 259.Op Fl s 260.Op Fl M Ar core 261.Op Fl N Ar system 262.Ek 263.Xc 264Display routing statistics. 265If 266.Fl s 267is repeated, counters with a value of zero are suppressed. 268.It Xo 269.Bk -words 270.Nm 271.Fl g 272.Op Fl 46W 273.Op Fl f Ar address_family 274.Op Fl M Ar core 275.Op Fl N Ar system 276.Ek 277.Xc 278Display the contents of the multicast virtual interface tables, 279and multicast forwarding caches. 280Entries in these tables will appear only when the kernel is 281actively forwarding multicast sessions. 282This option is applicable only to the 283.Cm inet 284and 285.Cm inet6 286address families. 287.It Xo 288.Bk -words 289.Nm 290.Fl gs 291.Op Fl 46s 292.Op Fl f Ar address_family 293.Op Fl M Ar core 294.Op Fl N Ar system 295.Ek 296.Xc 297Show multicast routing statistics. 298If 299.Fl s 300is repeated, counters with a value of zero are suppressed. 301.It Xo 302.Bk -words 303.Nm 304.Fl Q 305.Ek 306.Xc 307Show 308.Xr netisr 9 309statistics. 310The 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" 315.El 316.El 317.Pp 318Some options have the general meaning: 319.Bl -tag -width flag 320.It Fl 4 321Is shorthand for 322.Fl f 323.Ar inet 324.It Fl 6 325Is shorthand for 326.Fl f 327.Ar inet6 328.It Fl f Ar address_family , Fl p Ar protocol 329Limit display to those records 330of the specified 331.Ar address_family 332or a single 333.Ar protocol . 334The following address families and protocols are recognized: 335.Pp 336.Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact 337.It Em Family 338.Em Protocols 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 344.Cm pfkey 345.It Cm netgraph , ng Pq Dv AF_NETGRAPH 346.Cm ctrl , data 347.It Cm unix Pq Dv AF_UNIX 348.It Cm link Pq Dv AF_LINK 349.El 350.Pp 351The program will complain if 352.Ar protocol 353is unknown or if there is no statistics routine for it. 354.It Fl M 355Extract values associated with the name list from the specified core 356instead of the default 357.Pa /dev/kmem . 358.It Fl N 359Extract the name list from the specified system instead of the default, 360which is the kernel image the system has booted from. 361.It Fl n 362Show network addresses and ports as numbers. 363Normally 364.Nm 365attempts to resolve addresses and ports, 366and display them symbolically. 367.It Fl W 368In certain displays, avoid truncating addresses even if this causes 369some fields to overflow. 370.El 371.Pp 372The default display, for active sockets, shows the local 373and remote addresses, send and receive queue sizes (in bytes), protocol, 374and the internal state of the protocol. 375Address formats are of the form 376.Dq host.port 377or 378.Dq network.port 379if a socket's address specifies a network but no specific host address. 380When known, the host and network addresses are displayed symbolically 381according to the databases 382.Xr hosts 5 383and 384.Xr networks 5 , 385respectively. 386If a symbolic name for an address is unknown, or if 387the 388.Fl n 389option is specified, the address is printed numerically, according 390to the address family. 391For more information regarding 392the Internet IPv4 393.Dq dot format , 394refer to 395.Xr inet 3 . 396Unspecified, 397or 398.Dq wildcard , 399addresses and ports appear as 400.Dq Li * . 401.Pp 402The interface display provides a table of cumulative 403statistics regarding packets transferred, errors, and collisions. 404The network addresses of the interface 405and the maximum transmission unit 406.Pq Dq mtu 407are also displayed. 408.Pp 409The routing table display indicates the available routes and their status. 410Each route consists of a destination host or network, and a gateway to use 411in forwarding packets. 412The flags field shows a collection of information about the route stored 413as binary choices. 414The individual flags are discussed in more detail in the 415.Xr route 8 416and 417.Xr route 4 418manual pages. 419The 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" 435.El 436.Pp 437Direct routes are created for each 438interface attached to the local host; 439the gateway field for such entries shows the address of the outgoing interface. 440The refcnt field gives the 441current number of active uses of the route. 442Connection oriented 443protocols normally hold on to a single route for the duration of 444a connection while connectionless protocols obtain a route while sending 445to the same destination. 446The use field provides a count of the number of packets 447sent using that route. 448The interface entry indicates the network interface utilized for the route. 449.Pp 450When 451.Nm 452is invoked with the 453.Fl w 454option and a 455.Ar wait 456interval argument, it displays a running count of statistics related to 457network interfaces. 458An obsolescent version of this option used a numeric parameter 459with no option, and is currently supported for backward compatibility. 460By default, this display summarizes information for all interfaces. 461Information for a specific interface may be displayed with the 462.Fl I 463option. 464.Pp 465The 466.Xr bpf 4 467flags displayed when 468.Nm 469is invoked with the 470.Fl B 471option represent the underlying parameters of the bpf peer. 472Each flag is 473represented as a single lower case letter. 474The mapping between the letters and flags in order of appearance are: 475.Bl -column ".Li i" 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 479filled automatically 480.It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and 481remotely 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 484.El 485.Pp 486For more information about these flags, please refer to 487.Xr bpf 4 . 488.Pp 489The 490.Fl x 491flag causes 492.Nm 493to output all the information recorded about data 494stored in the socket buffers. 495The fields are: 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 500queue. 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. 510.El 511.Sh SEE ALSO 512.Xr fstat 1 , 513.Xr nfsstat 1 , 514.Xr procstat 1 , 515.Xr ps 1 , 516.Xr sockstat 1 , 517.Xr bpf 4 , 518.Xr inet 4 , 519.Xr route 4 , 520.Xr unix 4 , 521.Xr hosts 5 , 522.Xr networks 5 , 523.Xr protocols 5 , 524.Xr services 5 , 525.Xr iostat 8 , 526.Xr route 8 , 527.Xr trpt 8 , 528.Xr vmstat 8 , 529.Xr mbuf 9 530.Sh HISTORY 531The 532.Nm 533command appeared in 534.Bx 4.2 . 535.Pp 536IPv6 support was added by WIDE/KAME project. 537.Sh BUGS 538The notion of errors is ill-defined. 539