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