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: src/usr.bin/netstat/netstat.1,v 1.22.2.13 2003/05/03 22:10:02 keramida Exp $ 34.\" $DragonFly: src/usr.bin/netstat/netstat.1,v 1.5 2004/12/24 02:23:50 dillon Exp $ 35.\" 36.Dd September 7, 2001 37.Dt NETSTAT 1 38.Os 39.Sh NAME 40.Nm netstat 41.Nd show network status 42.Sh DESCRIPTION 43The 44.Nm 45command symbolically displays the contents of various network-related 46data structures. 47There are a number of output formats, 48depending on the options for the information presented. 49.Bl -tag -width indent 50.It Xo 51.Bk -words 52.Nm 53.Op Fl AaLlnPSW 54.Op Fl f Ar protocol_family | Fl p Ar protocol 55.Op Fl M Ar core 56.Op Fl N Ar system 57.Ek 58.Xc 59Display a list of active sockets 60(protocol control blocks) 61for each network protocol, 62for a particular 63.Ar protocol_family , 64or for a single 65.Ar protocol . 66If 67.Fl A 68is also present, 69show the address of a protocol control block (PCB) 70associated with a socket; used for debugging. 71If 72.Fl a 73is also present, 74show the state of all sockets; 75normally sockets used by server processes are not shown. 76If 77.Fl L 78is also present, 79show the size of the various listen queues. 80The first count shows the number of unaccepted connections, 81the second count shows the amount of unaccepted incomplete connections, 82and the third count is the maximum number of queued connections. 83If 84.Fl S 85is also present, 86show network addresses as numbers (as with 87.Fl n ) 88but show ports symbolically. 89.It Xo 90.Bk -words 91.Nm 92.Fl i | I Ar interface 93.Op Fl aBbdnt 94.Op Fl f Ar address_family 95.Op Fl M Ar core 96.Op Fl N Ar system 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 t 122is also present, show the contents of watchdog timers. 123If 124.Fl B 125is also present, the maximum buffer sizes are displayed instead 126of current buffer usage. 127.It Xo 128.Bk -words 129.Nm 130.Fl w Ar wait 131.Op Fl I Ar interface 132.Op Fl d 133.Op Fl M Ar core 134.Op Fl N Ar system 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 d 146is also present, show the number of dropped packets. 147.It Xo 148.Bk -words 149.Nm 150.Fl s Op Fl s 151.Op Fl z 152.Op Fl f Ar protocol_family | Fl p Ar protocol 153.Op Fl M Ar core 154.Op Fl N Ar system 155.Ek 156.Xc 157Display system-wide statistics for each network protocol, 158for a particular 159.Ar protocol_family , 160or for a single 161.Ar protocol . 162If 163.Fl s 164is repeated, counters with a value of zero are suppressed. 165If 166.Fl z 167is also present, reset statistic counters after displaying them. 168.It Xo 169.Bk -words 170.Nm 171.Fl i | I Ar interface Fl s 172.Op Fl f Ar protocol_family | Fl p Ar protocol 173.Op Fl M Ar core 174.Op Fl N Ar system 175.Ek 176.Xc 177Display per-interface statistics for each network protocol, 178for a particular 179.Ar protocol_family , 180or for a single 181.Ar protocol . 182.It Xo 183.Bk -words 184.Nm 185.Fl m 186.Op Fl M Ar core 187.Op Fl N Ar system 188.Ek 189.Xc 190Show statistics recorded by the memory management routines 191.Pq Xr mbuf 9 . 192The network manages a private pool of memory buffers. 193.It Xo 194.Bk -words 195.Nm 196.Fl r 197.Op Fl AalnW 198.Op Fl f Ar address_family 199.Op Fl M Ar core 200.Op Fl N Ar system 201.Ek 202.Xc 203Display the contents of all routing tables, 204or a routing table for a particular 205.Ar address_family . 206If 207.Fl A 208is also present, 209show the contents of the internal Patricia tree 210structures; used for debugging. 211If 212.Fl a 213is also present, 214show protocol-cloned routes 215(routes generated by an 216.Dv RTF_PRCLONING 217parent route); 218normally these routes are not shown. 219When 220.Fl W 221or 222.Fl l 223is also present, 224show the path MTU 225for each route. 226.It Xo 227.Bk -words 228.Nm 229.Fl rs 230.Op Fl s 231.Op Fl M Ar core 232.Op Fl N Ar system 233.Ek 234.Xc 235Display routing statistics. 236If 237.Fl s 238is repeated, counters with a value of zero are suppressed. 239.It Xo 240.Bk -words 241.Nm 242.Fl g 243.Op Fl lW 244.Op Fl f Ar address_family 245.Op Fl M Ar core 246.Op Fl N Ar system 247.Ek 248.Xc 249Show information related to multicast (group address) routing. 250By default, show the IP Multicast virtual-interface and routing tables. 251.It Xo 252.Bk -words 253.Nm 254.Fl gs 255.Op Fl s 256.Op Fl f Ar address_family 257.Op Fl M Ar core 258.Op Fl N Ar system 259.Ek 260.Xc 261Show multicast routing statistics. 262If 263.Fl s 264is repeated, counters with a value of zero are suppressed. 265.El 266.Pp 267Some options have the general meaning: 268.Bl -tag -width flag 269.It Fl f Ar address_family , Fl p Ar protocol 270Limit display to those records 271of the specified 272.Ar address_family 273or a single 274.Ar protocol . 275The following address families and protocols are recognized: 276.Pp 277.Bl -tag -width ".Cm netgraph , ng Pq Dv AF_NETGRAPH" -compact 278.It Em Family 279.Em Protocols 280.It Cm inet Pq Dv AF_INET 281.Cm bdg , divert , icmp , igmp , ip , ipsec , pim , tcp , udp 282.It Cm inet6 Pq Dv AF_INET6 283.Cm bdg , icmp6 , ip6 , ipsec6 , rip6 , tcp , udp 284.It Cm pfkey Pq Dv PF_KEY 285.Cm pfkey 286.It Cm atalk Pq Dv AF_APPLETALK 287.Cm ddp 288.It Cm netgraph , ng Pq Dv AF_NETGRAPH 289.Cm ctrl , data 290.It Cm ipx Pq Dv AF_IPX 291.Cm ipx , spx 292.\".It Cm ns Pq Dv AF_NS 293.\".Cm idp , ns_err , spp 294.\".It Cm iso Pq Dv AF_ISO 295.\".Cm clnp , cltp , esis , tp 296.It Cm unix Pq Dv AF_UNIX 297.It Cm link Pq Dv AF_LINK 298.El 299.Pp 300The program will complain if 301.Ar protocol 302is unknown or if there is no statistics routine for it. 303.It Fl l 304The 305.Fl l 306option is equivalent to 307.Fl W . 308.It Fl M 309Extract values associated with the name list from the specified core 310instead of the default 311.Pa /dev/kmem . 312.It Fl N 313Extract the name list from the specified system instead of the default, 314which is the kernel image the system has booted from. 315.It Fl n 316Show network addresses and ports as numbers. 317Normally 318.Nm 319attempts to resolve addresses and ports, 320and display them symbolically. 321.It Fl P 322Display additional protocol-specific information. For TCP the current 323transmit window, unacked sequence space, and RTT is displayed. 324.It Fl W 325In certain displays, avoid truncating addresses even if this causes 326some fields to overflow. 327.El 328.Pp 329The default display, for active sockets, shows the local 330and remote addresses, send and receive queue sizes (in bytes), protocol, 331and the internal state of the protocol. 332Address formats are of the form 333.Dq host.port 334or 335.Dq network.port 336if a socket's address specifies a network but no specific host address. 337When known, the host and network addresses are displayed symbolically 338according to the databases 339.Xr hosts 5 340and 341.Xr networks 5 , 342respectively. 343If a symbolic name for an address is unknown, or if 344the 345.Fl n 346option is specified, the address is printed numerically, according 347to the address family. 348For more information regarding 349the Internet IPv4 350.Dq dot format , 351refer to 352.Xr inet 3 . 353Unspecified, 354or 355.Dq wildcard , 356addresses and ports appear as 357.Dq Li * . 358.Pp 359The interface display provides a table of cumulative 360statistics regarding packets transferred, errors, and collisions. 361The network addresses of the interface 362and the maximum transmission unit 363.Pq Dq mtu 364are also displayed. 365.Pp 366The routing table display indicates the available routes and their status. 367Each route consists of a destination host or network, and a gateway to use 368in forwarding packets. 369The flags field shows a collection of information about the route stored 370as binary choices. 371The individual flags are discussed in more detail in the 372.Xr route 8 373and 374.Xr route 4 375manual pages. 376The mapping between letters and flags is: 377.Bl -column ".Li W" ".Dv RTF_WASCLONED" 378.It Li 1 Ta Dv RTF_PROTO1 Ta "Protocol specific routing flag #1" 379.It Li 2 Ta Dv RTF_PROTO2 Ta "Protocol specific routing flag #2" 380.It Li 3 Ta Dv RTF_PROTO3 Ta "Protocol specific routing flag #3" 381.It Li B Ta Dv RTF_BLACKHOLE Ta "Just discard pkts (during updates)" 382.It Li b Ta Dv RTF_BROADCAST Ta "The route represents a broadcast address" 383.It Li C Ta Dv RTF_CLONING Ta "Generate new routes on use" 384.It Li c Ta Dv RTF_PRCLONING Ta "Protocol-specified generate new routes on use" 385.It Li D Ta Dv RTF_DYNAMIC Ta "Created dynamically (by redirect)" 386.It Li G Ta Dv RTF_GATEWAY Ta "Destination requires forwarding by intermediary" 387.It Li H Ta Dv RTF_HOST Ta "Host entry (net otherwise)" 388.It Li L Ta Dv RTF_LLINFO Ta "Valid protocol to link address translation" 389.It Li M Ta Dv RTF_MODIFIED Ta "Modified dynamically (by redirect)" 390.It Li R Ta Dv RTF_REJECT Ta "Host or net unreachable" 391.It Li S Ta Dv RTF_STATIC Ta "Manually added" 392.It Li U Ta Dv RTF_UP Ta "Route usable" 393.It Li W Ta Dv RTF_WASCLONED Ta "Route was generated as a result of cloning" 394.It Li X Ta Dv RTF_XRESOLVE Ta "External daemon translates proto to link address" 395.El 396.Pp 397Direct routes are created for each 398interface attached to the local host; 399the gateway field for such entries shows the address of the outgoing interface. 400The refcnt field gives the 401current number of active uses of the route. 402Connection oriented 403protocols normally hold on to a single route for the duration of 404a connection while connectionless protocols obtain a route while sending 405to the same destination. 406The use field provides a count of the number of packets 407sent using that route. 408The interface entry indicates the network interface utilized for the route. 409.Pp 410When 411.Nm 412is invoked with the 413.Fl w 414option and a 415.Ar wait 416interval argument, it displays a running count of statistics related to 417network interfaces. 418An obsolescent version of this option used a numeric parameter 419with no option, and is currently supported for backward compatibility. 420By default, this display summarizes information for all interfaces. 421Information for a specific interface may be displayed with the 422.Fl I 423option. 424.Sh SEE ALSO 425.Xr fstat 1 , 426.Xr nfsstat 1 , 427.Xr ps 1 , 428.Xr sockstat 1 , 429.Xr inet 4 , 430.Xr route 4 , 431.Xr unix 4 , 432.Xr hosts 5 , 433.Xr networks 5 , 434.Xr protocols 5 , 435.Xr services 5 , 436.Xr iostat 8 , 437.Xr route 8 , 438.Xr trpt 8 , 439.Xr vmstat 8 , 440.Xr mbuf 9 441.Sh HISTORY 442The 443.Nm 444command appeared in 445.Bx 4.2 . 446.Pp 447IPv6 support was added by WIDE/KAME project. 448.Sh BUGS 449The notion of errors is ill-defined. 450