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