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.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)netstat.1 8.8 (Berkeley) 4/18/94 33.\" $FreeBSD$ 34.\" 35.Dd February 15, 2009 36.Dt NETSTAT 1 37.Os 38.Sh NAME 39.Nm netstat 40.Nd show network status 41.Sh DESCRIPTION 42The 43.Nm 44command symbolically displays the contents of various network-related 45data structures. 46There are a number of output formats, 47depending on the options for the information presented. 48.Bl -tag -width indent 49.It Xo 50.Bk -words 51.Nm 52.Op Fl AaLnSWx 53.Op Fl f Ar protocol_family | Fl p Ar protocol 54.Op Fl M Ar core 55.Op Fl N Ar system 56.Ek 57.Xc 58Display a list of active sockets 59(protocol control blocks) 60for each network protocol, 61for a particular 62.Ar protocol_family , 63or for a single 64.Ar protocol . 65If 66.Fl A 67is also present, 68show the address of a protocol control block (PCB) 69associated with a socket; used for debugging. 70If 71.Fl a 72is also present, 73show the state of all sockets; 74normally sockets used by server processes are not shown. 75If 76.Fl L 77is also present, 78show the size of the various listen queues. 79The first count shows the number of unaccepted connections, 80the second count shows the amount of unaccepted incomplete connections, 81and the third count is the maximum number of queued connections. 82If 83.Fl S 84is also present, 85show network addresses as numbers (as with 86.Fl n ) 87but show ports symbolically. 88If 89.Fl x 90is present display full socket buffer statistics for each internet socket. 91.It Xo 92.Bk -words 93.Nm 94.Fl i | I Ar interface 95.Op Fl abdhntW 96.Op Fl f Ar address_family 97.Op Fl M Ar core 98.Op Fl N Ar system 99.Ek 100.Xc 101Show the state of all network interfaces or a single 102.Ar interface 103which have been auto-configured 104(interfaces statically configured into a system, but not 105located at boot time are not shown). 106An asterisk 107.Pq Dq Li * 108after an interface name indicates that the interface is 109.Dq down . 110If 111.Fl a 112is also present, multicast addresses currently in use are shown 113for each Ethernet interface and for each IP interface address. 114Multicast addresses are shown on separate lines following the interface 115address with which they are associated. 116If 117.Fl b 118is also present, show the number of bytes in and out. 119If 120.Fl d 121is also present, show the number of dropped packets. 122If 123.Fl h 124is also present, print all counters in human readable form. 125If 126.Fl t 127is also present, show the contents of watchdog timers. 128If 129.Fl W 130is also present, print interface names using a wider field size. 131.It Xo 132.Bk -words 133.Nm 134.Fl w Ar wait 135.Op Fl I Ar interface 136.Op Fl d 137.Op Fl M Ar core 138.Op Fl N Ar system 139.Ek 140.Xc 141At intervals of 142.Ar wait 143seconds, 144display the information regarding packet 145traffic on all configured network interfaces 146or a single 147.Ar interface . 148If 149.Fl d 150is also present, show the number of dropped packets. 151.It Xo 152.Bk -words 153.Nm 154.Fl s Op Fl s 155.Op Fl z 156.Op Fl f Ar protocol_family | Fl p Ar protocol 157.Op Fl M Ar core 158.Op Fl N Ar system 159.Ek 160.Xc 161Display system-wide statistics for each network protocol, 162for a particular 163.Ar protocol_family , 164or for a single 165.Ar protocol . 166If 167.Fl s 168is repeated, counters with a value of zero are suppressed. 169If 170.Fl z 171is also present, reset statistic counters after displaying them. 172.It Xo 173.Bk -words 174.Nm 175.Fl i | I Ar interface Fl s 176.Op Fl f Ar protocol_family | Fl p Ar protocol 177.Op Fl M Ar core 178.Op Fl N Ar system 179.Ek 180.Xc 181Display per-interface statistics for each network protocol, 182for a particular 183.Ar protocol_family , 184or for a single 185.Ar protocol . 186.It Xo 187.Bk -words 188.Nm 189.Fl m 190.Op Fl M Ar core 191.Op Fl N Ar system 192.Ek 193.Xc 194Show statistics recorded by the memory management routines 195.Pq Xr mbuf 9 . 196The network manages a private pool of memory buffers. 197.It Xo 198.Bk -words 199.Nm 200.Fl B 201.Op Fl I Ar interface 202.Ek 203.Xc 204Show statistics about 205.Xr bpf 4 206peers. 207This includes information like 208how many packets have been matched, dropped and received by the 209bpf device, also information about current buffer sizes and device 210states. 211.It Xo 212.Bk -words 213.Nm 214.Fl r 215.Op Fl AanW 216.Op Fl f Ar address_family 217.Op Fl M Ar core 218.Op Fl N Ar system 219.Ek 220.Xc 221Display the contents of all routing tables, 222or a routing table for a particular 223.Ar address_family . 224If 225.Fl A 226is also present, 227show the contents of the internal Patricia tree 228structures; used for debugging. 229If 230.Fl a 231is also present, 232show protocol-cloned routes 233(routes generated by an 234.Dv RTF_PRCLONING 235parent route); 236normally these routes are not shown. 237When 238.Fl W 239is also present, 240show the path MTU 241for each route, 242and print interface 243names with a wider 244field size. 245.It Xo 246.Bk -words 247.Nm 248.Fl rs 249.Op Fl s 250.Op Fl M Ar core 251.Op Fl N Ar system 252.Ek 253.Xc 254Display routing statistics. 255If 256.Fl s 257is repeated, counters with a value of zero are suppressed. 258.It Xo 259.Bk -words 260.Nm 261.Fl g 262.Op Fl W 263.Op Fl f Ar address_family 264.Op Fl M Ar core 265.Op Fl N Ar system 266.Ek 267.Xc 268Display the contents of the multicast virtual interface tables, 269and multicast forwarding caches. 270Entries in these tables will appear only when the kernel is 271actively forwarding multicast sessions. 272This option is applicable only to the 273.Cm inet 274and 275.Cm inet6 276address families. 277.It Xo 278.Bk -words 279.Nm 280.Fl gs 281.Op Fl s 282.Op Fl f Ar address_family 283.Op Fl M Ar core 284.Op Fl N Ar system 285.Ek 286.Xc 287Show multicast routing statistics. 288If 289.Fl s 290is repeated, counters with a value of zero are suppressed. 291.El 292.Pp 293Some options have the general meaning: 294.Bl -tag -width flag 295.It Fl f Ar address_family , Fl p Ar protocol 296Limit display to those records 297of the specified 298.Ar address_family 299or a single 300.Ar protocol . 301The following address families and protocols are recognized: 302.Pp 303.Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact 304.It Em Family 305.Em Protocols 306.It Cm inet Pq Dv AF_INET 307.Cm divert , icmp , igmp , ip , ipsec , pim, sctp , tcp , udp 308.It Cm inet6 Pq Dv AF_INET6 309.Cm icmp6 , ip6 , ipsec6 , rip6 , tcp , udp 310.It Cm pfkey Pq Dv PF_KEY 311.Cm pfkey 312.It Cm atalk Pq Dv AF_APPLETALK 313.Cm ddp 314.It Cm netgraph , ng Pq Dv AF_NETGRAPH 315.Cm ctrl , data 316.It Cm ipx Pq Dv AF_IPX 317.Cm ipx , spx 318.\".It Cm ns Pq Dv AF_NS 319.\".Cm idp , ns_err , spp 320.\".It Cm iso Pq Dv AF_ISO 321.\".Cm clnp , cltp , esis , tp 322.It Cm unix Pq Dv AF_UNIX 323.It Cm link Pq Dv AF_LINK 324.El 325.Pp 326The program will complain if 327.Ar protocol 328is unknown or if there is no statistics routine for it. 329.It Fl M 330Extract values associated with the name list from the specified core 331instead of the default 332.Pa /dev/kmem . 333.It Fl N 334Extract the name list from the specified system instead of the default, 335which is the kernel image the system has booted from. 336.It Fl n 337Show network addresses and ports as numbers. 338Normally 339.Nm 340attempts to resolve addresses and ports, 341and display them symbolically. 342.It Fl W 343In certain displays, avoid truncating addresses even if this causes 344some fields to overflow. 345.El 346.Pp 347The default display, for active sockets, shows the local 348and remote addresses, send and receive queue sizes (in bytes), protocol, 349and the internal state of the protocol. 350Address formats are of the form 351.Dq host.port 352or 353.Dq network.port 354if a socket's address specifies a network but no specific host address. 355When known, the host and network addresses are displayed symbolically 356according to the databases 357.Xr hosts 5 358and 359.Xr networks 5 , 360respectively. 361If a symbolic name for an address is unknown, or if 362the 363.Fl n 364option is specified, the address is printed numerically, according 365to the address family. 366For more information regarding 367the Internet IPv4 368.Dq dot format , 369refer to 370.Xr inet 3 . 371Unspecified, 372or 373.Dq wildcard , 374addresses and ports appear as 375.Dq Li * . 376.Pp 377The interface display provides a table of cumulative 378statistics regarding packets transferred, errors, and collisions. 379The network addresses of the interface 380and the maximum transmission unit 381.Pq Dq mtu 382are also displayed. 383.Pp 384The routing table display indicates the available routes and their status. 385Each route consists of a destination host or network, and a gateway to use 386in forwarding packets. 387The flags field shows a collection of information about the route stored 388as binary choices. 389The individual flags are discussed in more detail in the 390.Xr route 8 391and 392.Xr route 4 393manual pages. 394The mapping between letters and flags is: 395.Bl -column ".Li W" ".Dv RTF_WASCLONED" 396.It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1" 397.It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2" 398.It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3" 399.It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)" 400.It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address" 401.It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use" 402.It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use" 403.It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)" 404.It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary" 405.It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)" 406.It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation" 407.It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)" 408.It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable" 409.It Li S Ta Dv RTF_STATIC Ta "Manually added" 410.It Li U Ta Dv RTF_UP Ta "Route usable" 411.It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning" 412.It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address" 413.El 414.Pp 415Direct routes are created for each 416interface attached to the local host; 417the gateway field for such entries shows the address of the outgoing interface. 418The refcnt field gives the 419current number of active uses of the route. 420Connection oriented 421protocols normally hold on to a single route for the duration of 422a connection while connectionless protocols obtain a route while sending 423to the same destination. 424The use field provides a count of the number of packets 425sent using that route. 426The interface entry indicates the network interface utilized for the route. 427.Pp 428When 429.Nm 430is invoked with the 431.Fl w 432option and a 433.Ar wait 434interval argument, it displays a running count of statistics related to 435network interfaces. 436An obsolescent version of this option used a numeric parameter 437with no option, and is currently supported for backward compatibility. 438By default, this display summarizes information for all interfaces. 439Information for a specific interface may be displayed with the 440.Fl I 441option. 442.Pp 443The 444.Xr bpf 4 445flags displayed when 446.Nm 447is invoked with the 448.Fl B 449option represent the underlying parameters of the bpf peer. 450Each flag is 451represented as a single lower case letter. 452The mapping between the letters and flags in order of appearance are: 453.Bl -column ".Li i" 454.It Li p Ta Set if listening promiscuously 455.It Li i Ta Dv BIOCIMMEDIATE No has been set on the device 456.It Li f Ta Dv BIOCGHDRCMPLT No status: source link addresses are being 457filled automatically 458.It Li s Ta Dv BIOCGSEESENT No status: see packets originating locally and 459remotely on the interface. 460.It Li a Ta Packet reception generates a signal 461.It Li l Ta Dv BIOCLOCK No status: descriptor has been locked 462.El 463.Pp 464For more information about these flags, please refer to 465.Xr bpf 4 . 466.Pp 467The 468.Fl x 469flag causes 470.Nm 471to output all the information recorded about data 472stored in the socket buffers. 473The fields are: 474.Bl -column ".Li R-MBUF" 475.It Li R-MBUF Ta Number of mbufs in the receive queue. 476.It Li S-MBUF Ta Number of mbufs in the send queue. 477.It Li R-CLUS Ta Number of clusters, of any type, in the receive 478queue. 479.It Li S-CLUS Ta Number of clusters, of any type, in the send queue. 480.It Li R-HIWA Ta Receive buffer high water mark, in bytes. 481.It Li S-HIWA Ta Send buffer high water mark, in bytes. 482.It Li R-LOWA Ta Receive buffer low water mark, in bytes. 483.It Li S-LOWA Ta Send buffer low water mark, in bytes. 484.It Li R-BCNT Ta Receive buffer byte count. 485.It Li S-BCNT Ta Send buffer byte count. 486.It Li R-BMAX Ta Maximum bytes that can be used in the receive buffer. 487.It Li S-BMAX Ta Maximum bytes that can be used in the send buffer. 488.El 489.Sh SEE ALSO 490.Xr fstat 1 , 491.Xr nfsstat 1 , 492.Xr ps 1 , 493.Xr sockstat 1 , 494.Xr bpf 4 , 495.Xr inet 4 , 496.Xr route 4 , 497.Xr unix 4 , 498.Xr hosts 5 , 499.Xr networks 5 , 500.Xr protocols 5 , 501.Xr services 5 , 502.Xr iostat 8 , 503.Xr route 8 , 504.Xr trpt 8 , 505.Xr vmstat 8 , 506.Xr mbuf 9 507.Sh HISTORY 508The 509.Nm 510command appeared in 511.Bx 4.2 . 512.Pp 513IPv6 support was added by WIDE/KAME project. 514.Sh BUGS 515The notion of errors is ill-defined. 516