1.\" Copyright (c) 1985, 1991, 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.\" @(#)ping.8 8.2 (Berkeley) 12/11/93 33.\" $FreeBSD$ 34.\" 35.Dd September 25, 2001 36.Dt PING 8 37.Os 38.Sh NAME 39.Nm ping 40.Nd send 41.Tn ICMP ECHO_REQUEST 42packets to network hosts 43.Sh SYNOPSIS 44.Nm 45.Op Fl AQRadfnqrv 46.Op Fl c Ar count 47.Op Fl i Ar wait 48.Op Fl l Ar preload 49.Op Fl m Ar ttl 50.Op Fl p Ar pattern 51.Op Fl P Ar policy 52.Op Fl s Ar packetsize 53.Op Fl S Ar src_addr 54.Op Fl t Ar timeout 55.Bo 56.Ar host | 57.Op Fl L 58.Op Fl I Ar interface 59.Op Fl T Ar ttl 60.Ar mcast-group 61.Bc 62.Sh DESCRIPTION 63.Nm Ping 64uses the 65.Tn ICMP 66.No protocol Ap s mandatory 67.Tn ECHO_REQUEST 68datagram to elicit an 69.Tn ICMP ECHO_RESPONSE 70from a host or gateway. 71.Tn ECHO_REQUEST 72datagrams 73.Pq Dq pings 74have an IP and 75.Tn ICMP 76header, followed by a 77.Dq struct timeval 78and then an arbitrary number of 79.Dq pad 80bytes used to fill out the packet. The options are as follows: 81.Bl -tag -width indent 82.It Fl A 83Audible. 84Output a bell 85.Tn ( ASCII 860x07) 87character when no packet is received before the next packet 88is transmitted. 89To cater for round-trip times that are longer than the interval 90between transmissions, further missing packets cause a bell only 91if the maximum number of unreceived packets has increased. 92.It Fl a 93Audible. 94Include a bell 95.Tn ( ASCII 960x07) 97character in the output when any packet is received. 98This option is ignored 99if other format options are present. 100.It Fl c Ar count 101Stop after sending 102(and receiving) 103.Ar count 104.Tn ECHO_RESPONSE 105packets. 106If this option is not specified, 107.Nm 108will operate until interrupted. 109.It Fl d 110Set the 111.Dv SO_DEBUG 112option on the socket being used. 113.It Fl f 114Flood ping. 115Outputs packets as fast as they come back or one hundred times per second, 116whichever is more. 117For every 118.Tn ECHO_REQUEST 119sent a period 120.Dq .\& 121is printed, while for every 122.Tn ECHO_REPLY 123received a backspace is printed. 124This provides a rapid display of how many packets are being dropped. 125Only the super-user may use this option. 126.Bf -emphasis 127This can be very hard on a network and should be used with caution. 128.Ef 129.It Fl i Ar wait 130Wait 131.Ar wait 132seconds 133.Em between sending each packet . 134The default is to wait for one second between each packet. 135The wait time may be fractional, but only the super-user may specify 136values less then 1 second. 137This option is incompatible with the 138.Fl f 139option. 140.It Fl I Ar interface 141Source multicast packets with the given interface address. 142This flag only applies if the ping destination is a multicast address. 143.It Fl l Ar preload 144If 145.Ar preload 146is specified, 147.Nm 148sends that many packets as fast as possible before falling into its normal 149mode of behavior. 150Only the super-user may use this option. 151.It Fl m Ar ttl 152Set the IP Time To Live for outgoing packets. 153If not specified, the kernel uses the value of the 154.Va net.inet.ip.ttl 155MIB variable. 156.It Fl L 157Suppress loopback of multicast packets. 158This flag only applies if the ping destination is a multicast address. 159.It Fl n 160Numeric output only. 161No attempt will be made to lookup symbolic names for host addresses. 162.It Fl p Ar pattern 163You may specify up to 16 164.Dq pad 165bytes to fill out the packet you send. 166This is useful for diagnosing data-dependent problems in a network. 167For example, 168.Dq Li \-p ff 169will cause the sent packet to be filled with all 170ones. 171.It Fl P Ar policy 172.Ar policy 173specifies IPsec policy for the ping session. 174For details please refer to 175.Xr ipsec 4 176and 177.Xr ipsec_set_policy 3 . 178.It Fl Q 179Somewhat quiet output. 180.No Don Ap t 181display ICMP error messages that are in response to our query messages. 182Originally, the 183.Fl v 184flag was required to display such errors, but 185.Fl v 186displays all ICMP error messages. On a busy machine, this output can 187be overbearing. Without the 188.Fl Q 189flag, 190.Nm 191prints out any ICMP error messages caused by its own ECHO_REQUEST 192messages. 193.It Fl q 194Quiet output. 195Nothing is displayed except the summary lines at startup time and 196when finished. 197.It Fl R 198Record route. 199Includes the 200.Tn RECORD_ROUTE 201option in the 202.Tn ECHO_REQUEST 203packet and displays 204the route buffer on returned packets. 205Note that the IP header is only large enough for nine such routes; 206the 207.Xr traceroute 8 208command is usually better at determining the route packets take to a 209particular destination. 210If more routes come back than should, such as due to an illegal spoofed 211packet, ping will print the route list and then truncate it at the correct 212spot. 213Many hosts ignore or discard the 214.Tn RECORD_ROUTE 215option. 216.It Fl r 217Bypass the normal routing tables and send directly to a host on an attached 218network. 219If the host is not on a directly-attached network, an error is returned. 220This option can be used to ping a local host through an interface 221that has no route through it 222(e.g., after the interface was dropped by 223.Xr routed 8 ) . 224.It Fl s Ar packetsize 225Specify the number of data bytes to be sent. 226The default is 56, which translates into 64 227.Tn ICMP 228data bytes when combined 229with the 8 bytes of 230.Tn ICMP 231header data. 232Only the super-user may use this option. 233.It Fl S Ar src_addr 234Use the following IP address as the source address in outgoing packets. 235On hosts with more than one IP address, this option can be used to 236force the source address to be something other than the IP address 237of the interface the probe packet is sent on. If the IP address 238is not one of this machine's interface addresses, an error is 239returned and nothing is sent. 240.It Fl t Ar timeout 241Specify a timeout, in seconds, before ping exits regardless of how 242many packets have been recieved. 243.It Fl T Ar ttl 244Set the IP Time To Live for multicasted packets. 245This flag only applies if the ping destination is a multicast address. 246.It Fl v 247Verbose output. 248.Tn ICMP 249packets other than 250.Tn ECHO_RESPONSE 251that are received are listed. 252.El 253.Pp 254When using 255.Nm 256for fault isolation, it should first be run on the local host, to verify 257that the local network interface is up and running. 258Then, hosts and gateways further and further away should be 259.Dq pinged . 260Round-trip times and packet loss statistics are computed. 261If duplicate packets are received, they are not included in the packet 262loss calculation, although the round trip time of these packets is used 263in calculating the round-trip time statistics. 264When the specified number of packets have been sent 265(and received) 266or if the program is terminated with a 267.Dv SIGINT , 268a brief summary is displayed, showing the number of packets sent and 269received, and the minimum, mean, maximum, and standard deviation of 270the round-trip times. 271.Pp 272If 273.Nm 274receives a 275.Dv SIGINFO 276(see the 277.Cm status 278argument for 279.Xr stty 1 ) 280signal, the current number of packets sent and received, and the 281minimum, mean, and maximum of the round-trip times will be written to 282the standard error output. 283.Pp 284This program is intended for use in network testing, measurement and 285management. 286Because of the load it can impose on the network, it is unwise to use 287.Nm 288during normal operations or from automated scripts. 289.Sh ICMP PACKET DETAILS 290An IP header without options is 20 bytes. 291An 292.Tn ICMP 293.Tn ECHO_REQUEST 294packet contains an additional 8 bytes worth of 295.Tn ICMP 296header followed by an arbitrary amount of data. 297When a 298.Ar packetsize 299is given, this indicated the size of this extra piece of data 300(the default is 56). 301Thus the amount of data received inside of an IP packet of type 302.Tn ICMP 303.Tn ECHO_REPLY 304will always be 8 bytes more than the requested data space 305(the 306.Tn ICMP 307header). 308.Pp 309If the data space is at least eight bytes large, 310.Nm 311uses the first eight bytes of this space to include a timestamp which 312it uses in the computation of round trip times. 313If less than eight bytes of pad are specified, no round trip times are 314given. 315.Sh DUPLICATE AND DAMAGED PACKETS 316.Nm Ping 317will report duplicate and damaged packets. 318Duplicate packets should never occur when pinging a unicast address, 319and seem to be caused by 320inappropriate link-level retransmissions. 321Duplicates may occur in many situations and are rarely 322(if ever) 323a good sign, although the presence of low levels of duplicates may not 324always be cause for alarm. 325Duplicates are expected when pinging a broadcast or multicast address, 326since they are not really duplicates but replies from different hosts 327to the same request. 328.Pp 329Damaged packets are obviously serious cause for alarm and often 330indicate broken hardware somewhere in the 331.Nm 332packet's path (in the network or in the hosts). 333.Sh TRYING DIFFERENT DATA PATTERNS 334The 335(inter)network 336layer should never treat packets differently depending on the data 337contained in the data portion. 338Unfortunately, data-dependent problems have been known to sneak into 339networks and remain undetected for long periods of time. 340In many cases the particular pattern that will have problems is something 341that does not have sufficient 342.Dq transitions , 343such as all ones or all zeros, or a pattern right at the edge, such as 344almost all zeros. 345It is not 346necessarily enough to specify a data pattern of all zeros (for example) 347on the command line because the pattern that is of interest is 348at the data link level, and the relationship between what you type and 349what the controllers transmit can be complicated. 350.Pp 351This means that if you have a data-dependent problem you will probably 352have to do a lot of testing to find it. 353If you are lucky, you may manage to find a file that either 354cannot 355be sent across your network or that takes much longer to transfer than 356other similar length files. 357You can then examine this file for repeated patterns that you can test 358using the 359.Fl p 360option of 361.Nm . 362.Sh TTL DETAILS 363The 364.Tn TTL 365value of an IP packet represents the maximum number of IP routers 366that the packet can go through before being thrown away. 367In current practice you can expect each router in the Internet to decrement 368the 369.Tn TTL 370field by exactly one. 371.Pp 372The 373.Tn TCP/IP 374specification states that the 375.Tn TTL 376field for 377.Tn TCP 378packets should be set to 60, but many systems use smaller values 379.No ( Bx 4.3 380uses 30, 381.Bx 4.2 382used 15). 383.Pp 384The maximum possible value of this field is 255, and most 385.Ux 386systems set 387the 388.Tn TTL 389field of 390.Tn ICMP ECHO_REQUEST 391packets to 255. 392This is why you will find you can 393.Dq ping 394some hosts, but not reach them with 395.Xr telnet 1 396or 397.Xr ftp 1 . 398.Pp 399In normal operation 400.Nm 401prints the ttl value from the packet it receives. 402When a remote system receives a ping packet, it can do one of three things 403with the 404.Tn TTL 405field in its response: 406.Bl -bullet 407.It 408Not change it; this is what 409.Bx 410systems did before the 411.Bx 4.3 tahoe 412release. 413In this case the 414.Tn TTL 415value in the received packet will be 255 minus the 416number of routers in the round-trip path. 417.It 418Set it to 255; this is what current 419.Bx 420systems do. 421In this case the 422.Tn TTL 423value in the received packet will be 255 minus the 424number of routers in the path 425.Em from 426the remote system 427.Em to 428the 429.Nm Ns Em ing 430host. 431.It 432Set it to some other value. 433Some machines use the same value for 434.Tn ICMP 435packets that they use for 436.Tn TCP 437packets, for example either 30 or 60. 438Others may use completely wild values. 439.El 440.Sh RETURN VALUES 441The 442.Nm 443command returns an exit status of zero if at least one response was 444heard from the specified 445.Ar host ; 446a status of two if the transmission was successful but no responses 447were received; or another value 448(from 449.Aq Pa sysexits.h ) 450if an error occurred. 451.Sh SEE ALSO 452.Xr netstat 1 , 453.Xr ifconfig 8 , 454.Xr routed 8 , 455.Xr traceroute 8 456.Sh HISTORY 457The 458.Nm 459command appeared in 460.Bx 4.3 . 461.Sh AUTHORS 462The original 463.Nm 464command was written by 465.An Mike Muuss 466while at the US Army Ballistics 467Research Laboratory. 468.Sh BUGS 469Many Hosts and Gateways ignore the 470.Tn RECORD_ROUTE 471option. 472.Pp 473The maximum IP header length is too small for options like 474.Tn RECORD_ROUTE 475to be completely useful. 476.No There Ap s 477not much that can be done about this, however. 478.Pp 479Flood pinging is not recommended in general, and flood pinging the 480broadcast address should only be done under very controlled conditions. 481.Pp 482The 483.Fl v 484option is not worth much on busy hosts. 485