In computing, netstat (network statistics) is a command-line tool that displays network connections for the Transmission Control Protocol (both incoming and outgoing), routing tables, and a number of network interface (network interface controller or software-defined network interface) and network protocol statistics. It is available on Unix-like operating systems including OS X, Linux, Solaris, and BSD, and is available on Windows NT-based operating systems including Windows XP, Windows Vista, Windows 7, Windows 8 and Windows 10.
It is used for finding problems in the network and to determine the amount of traffic on the network as a performance measurement.
On Linux, netstat (part of "net-tools") is deprecated; ss (part of iproute2) should be used instead.
Parameters
Parameters used with this command must be prefixed with a hyphen (-) rather than a slash (/). If a parameter is supported only on some platform or platforms, the platform or platforms is listed in parentheses after the parameter.
| -a | Displays all active connections and the TCP and UDP ports on which the computer is listening. |
| -b (Windows) | Displays the binary (executable) program's name involved in creating each connection or listening port. (Windows XP, 2003 Server and newer Windows operating systems; not Microsoft Windows 2000 or older). |
| -b (OS X, NetBSD) | Causes -i to report the total number of bytes of traffic. |
| -e | Displays ethernet statistics, such as the number of bytes and packets sent and received. This parameter can be combined with -s. |
| -f (Windows) | Displays fully qualified domain names <FQDN> for foreign addresses (only available on Windows Vista and newer operating systems). |
| -f Address Family (FreeBSD) | Limits display to a particular socket address family, unix, inet, inet6 |
| -g | Displays multicast group membership information for both IPv4 and IPv6 (may only be available on newer operating systems) |
| -i | Displays network interfaces and their statistics (not available under Windows) |
| -m | Displays the memory statistics for the networking code (STREAMS statistics on Solaris). |
| -n | Displays active TCP connections, however, addresses and port numbers are expressed numerically and no attempt is made to determine names. |
| -o (Windows) | Displays active TCP connections and includes the process ID (PID) for each connection. You can find the application based on the PID on the Processes tab in Windows Task Manager. This parameter can be combined with -a, -n, and -p. This parameter is available on Microsoft Windows XP, 2003 Server (and Windows 2000 if a hotfix is applied). |
| -p protocol (Windows and BSD) | Shows connections for the protocol specified by protocol. In this case, protocol can be tcp, udp, tcpv6, or udpv6. If this parameter is used with -s to display statistics by protocol, protocol can be tcp, udp, icmp, ip, tcpv6, udpv6, icmpv6, or ipv6. |
| -p (Linux) | Show which processes are using which sockets (similar to -b under Windows) (you must be root to do this) |
| -P protocol (Solaris) | Shows connections for the protocol specified by protocol. In this case, protocol can be ip, ipv6, icmp, icmpv6, igmp, udp, tcp, or rawip. |
| -r | Displays the contents of the IP routing table. (This is equivalent to the route print command under Windows.) |
| -s | Displays statistics by protocol. By default, statistics are shown for the TCP, UDP, ICMP, and IP protocols. If the IPv6 protocol for Windows XP is installed, statistics are shown for the TCP over IPv6, UDP over IPv6, ICMPv6, and IPv6 protocols. The -p parameter can be used to specify a set of protocols. |
| -t (Linux) | Display only TCP connections. |
| -W (FreeBSD) | Display wide output - doesn't truncate hostnames or IPv6 addresses |
| -v (Windows) | When used in conjunction with -b it will display the sequence of components involved in creating the connection or listening port for all executables. |
| Interval | Redisplays the selected information every Interval seconds. Press CTRL+C to stop the redisplay. If this parameter is omitted, netstat prints the selected information only once. |
| -h (unix) /? (windows) | Displays help at the command prompt. |
Statistics provided
Netstat provides statistics for the following:
- Proto - The name of the protocol (TCP or UDP).
- Local Address - The IP address of the local computer and the port number being used. The name of the local computer that corresponds to the IP address and the name of the port is shown unless the -n parameter is specified. An asterisk (*) is shown for the host if the server is listening on all interfaces. If the port is not yet established, the port number is shown as an asterisk.
- Foreign Address - The IP address and port number of the remote computer to which the socket is connected. The names that corresponds to the IP address and the port are shown unless the -n parameter is specified. If the port is not yet established, the port number is shown as an asterisk (*).
- State - Indicates the state of a TCP connection. The possible states are as follows: CLOSE_WAIT, CLOSED, ESTABLISHED, FIN_WAIT_1, FIN_WAIT_2, LAST_ACK, LISTEN, SYN_RECEIVED, SYN_SEND, and TIME_WAIT. For more information about the states of a TCP connection, see RFC 793.
Examples
To display the statistics for only the TCP or UDP protocols, type one of the following commands:
netstat -sp tcp
netstat -sp udp
On Microsoft Windows:
To display active TCP connections and the process IDs every 5 seconds, type the following command (works on XP and 2003 only, or Windows 2000 with hotfix):
netstat -o 5
To display active TCP connections and the process IDs using numerical form, type the following command (works on XP and 2003 only, or Windows 2000 with hotfix):
netstat -no
To display all ports open by a process with id pid:
netstat -aop | grep "pid"
Caveats
Some versions of netstat lack explicit field delimiters in their printf-generated output, leading to numeric fields running together and thus corrupting the output data.
Platform specific remarks
Under Linux, raw data can often be obtained from the /proc/net/dev to work around the printf output corruption arising in netstat's network interface statistics summary, netstat -i, until such time as the problem is corrected.
On the Windows platform, netstat information can be retrieved by calling the GetTcpTable and GetUdpTable functions in the IP Helper API, or IPHLPAPI.DLL. Information returned includes local and remote IP addresses, local and remote ports, and (for GetTcpTable) TCP status codes. In addition to the command-line netstat.exe tool that ships with Windows, GUI-based netstat programs are available.
On the Windows platform, this command is available only if the Internet Protocol (TCP/IP) protocol is installed as a component in the properties of a network adapter in Network Connections.
On the Windows platform running Remote Desktop Services (formerly Terminal Services) it will only show connections for the current user, not for the whole computer.
On OS X, the /Applications/Utilities folder contains a network GUI utility called Network Utility, the Netstat tab of which runs the netstat command and displays its output in the tab.
