sbin/ping/ping.8

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