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