1 .\" $KAME: ping6.8,v 1.58 2003/06/20 12:00:22 itojun Exp $
3 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the project nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" $FreeBSD: src/sbin/ping6/ping6.8,v 1.24 2007/11/20 01:58:34 dd Exp $
38 .Tn ICMPv6 ECHO_REQUEST
39 packets to network hosts
42 .\" without ipsec, or new ipsec
45 .\" .Op Fl AdEfmnNqRtvwW
81 .Op Fl S Ar sourceaddr
84 .Op Fl s Ar packetsize
101 .Tn ICMP6_ECHO_REQUEST
102 datagram to elicit an
104 from a host or gateway.
105 .Tn ICMP6_ECHO_REQUEST
106 datagrams (``pings'') have an IPv6 header,
109 header formatted as documented in RFC2463.
110 The options are as follows:
114 .\" Enables transport-mode IPsec authentication header
117 Generate ICMPv6 Node Information Node Addresses query, rather than echo-request.
119 must be a string constructed of the following characters.
120 .Bl -tag -width Ds -compact
122 requests unicast addresses from all of the responder's interfaces.
123 If the character is omitted,
124 only those addresses which belong to the interface which has the
125 responder's address are requests.
127 requests responder's IPv4-compatible and IPv4-mapped addresses.
129 requests responder's global-scope addresses.
131 requests responder's site-local addresses.
133 requests responder's link-local addresses.
135 requests responder's anycast addresses.
136 Without this character, the responder will return unicast addresses only.
137 With this character, the responder will return anycast addresses only.
138 Note that the specification does not specify how to get responder's
140 This is an experimental option.
143 Set socket buffer size.
145 Bind the socket to interface
149 Prohibit the socket from using the cellular network interface.
159 option on the socket being used.
161 .\" Enables transport-mode IPsec encapsulated security payload
165 Outputs packets as fast as they come back or one hundred times per second,
171 is printed, while for every
173 received a backspace is printed.
174 This provides a rapid display of how many packets are being dropped.
175 Only the super-user may use this option.
177 This can be very hard on a network and should be used with caution.
182 as the next hop to the destination.
183 The gateway must be a neighbor of the sending node.
185 Specifies to try reverse-lookup of IPv6 addresses.
188 utility does not try reverse-lookup unless the option is specified.
190 Set the IPv6 hoplimit.
191 .It Fl I Ar interface
192 Source packets with the given interface address.
193 This flag applies if the ping destination is a multicast address,
194 or link-local/site-local unicast address.
199 .Em between sending each packet .
200 The default is to wait for one second between each packet.
201 This option is incompatible with the
209 sends that many packets as fast as possible before falling into its normal
211 Only the super-user may use this option.
215 asks the kernel to fragment packets to fit into the minimum IPv6 MTU.
219 will suppress the behavior in the following two levels:
220 when the option is specified once, the behavior will be disabled for
222 When the option is more than once, it will be disabled for both
223 unicast and multicast packets.
226 No attempt will be made to lookup symbolic names from addresses in the reply.
228 Probe node information multicast group
229 .Pq Li ff02::2:xxxx:xxxx .
231 must be string hostname of the target
232 (must not be a numeric IPv6 address).
233 Node information multicast group will be computed based on given
235 and will be used as the final destination.
236 Since node information multicast group is a link-local multicast group,
237 outgoing interface needs to be specified by
241 Exit successfully after receiving one reply packet.
243 You may specify up to 16
245 bytes to fill out the packet you send.
246 This is useful for diagnosing data-dependent problems in a network.
249 will cause the sent packet to be filled with all
254 specifies IPsec policy to be used for the probe.
257 Nothing is displayed except the summary lines at startup time and
264 character in the output when any packet is received.
270 character when no packet is received before the next packet
272 To cater for round-trip times that are longer than the interval
273 between transmissions, further missing packets cause a bell only
274 if the maximum number of unreceived packets has increased.
275 .It Fl S Ar sourceaddr
276 Specifies the source address of request packets.
277 The source address must be one of the unicast addresses of the sending node,
279 .It Fl s Ar packetsize
280 Specifies the number of data bytes to be sent.
281 The default is 56, which translates into 64
283 data bytes when combined
287 You may need to specify
289 as well to extend socket buffer size.
291 Generate ICMPv6 Node Information supported query types query,
292 rather than echo-request.
302 that are received are listed.
304 Generate ICMPv6 Node Information DNS Name query, rather than echo-request.
312 but with old packet format based on 03 draft.
313 This option is present for backward compatibility.
319 Use the specified traffic class.
321 IPv6 addresses for intermediate nodes,
322 which will be put into type 0 routing header.
324 IPv6 address of the final destination node.
329 for fault isolation, it should first be run on the local host, to verify
330 that the local network interface is up and running.
331 Then, hosts and gateways further and further away should be
333 Round-trip times and packet loss statistics are computed.
334 If duplicate packets are received, they are not included in the packet
335 loss calculation, although the round trip time of these packets is used
336 in calculating the round-trip time statistics.
337 When the specified number of packets have been sent
339 or if the program is terminated with a
341 a brief summary is displayed, showing the number of packets sent and
342 received, and the minimum, mean, maximum, and standard deviation of
343 the round-trip times.
353 signal, the current number of packets sent and received, and the
354 minimum, mean, maximum, and standard deviation of the round-trip times
355 will be written to the standard output in the same format as the
356 standard completion message.
358 This program is intended for use in network testing, measurement and
360 Because of the load it can impose on the network, it is unwise to use
362 during normal operations or from automated scripts.
363 .\" .Sh ICMP PACKET DETAILS
364 .\" An IP header without options is 20 bytes.
368 .\" packet contains an additional 8 bytes worth of
370 .\" header followed by an arbitrary amount of data.
373 .\" is given, this indicated the size of this extra piece of data
374 .\" (the default is 56).
375 .\" Thus the amount of data received inside of an IP packet of type
378 .\" will always be 8 bytes more than the requested data space
383 .\" If the data space is at least eight bytes large,
385 .\" uses the first eight bytes of this space to include a timestamp which
386 .\" it uses in the computation of round trip times.
387 .\" If less than eight bytes of pad are specified, no round trip times are
389 .Sh DUPLICATE AND DAMAGED PACKETS
392 utility will report duplicate and damaged packets.
393 Duplicate packets should never occur when pinging a unicast address,
394 and seem to be caused by
395 inappropriate link-level retransmissions.
396 Duplicates may occur in many situations and are rarely
398 a good sign, although the presence of low levels of duplicates may not
399 always be cause for alarm.
400 Duplicates are expected when pinging a broadcast or multicast address,
401 since they are not really duplicates but replies from different hosts
404 Damaged packets are obviously serious cause for alarm and often
405 indicate broken hardware somewhere in the
408 (in the network or in the hosts).
409 .Sh TRYING DIFFERENT DATA PATTERNS
412 layer should never treat packets differently depending on the data
413 contained in the data portion.
414 Unfortunately, data-dependent problems have been known to sneak into
415 networks and remain undetected for long periods of time.
416 In many cases the particular pattern that will have problems is something
417 that does not have sufficient
419 such as all ones or all zeros, or a pattern right at the edge, such as
422 necessarily enough to specify a data pattern of all zeros (for example)
423 on the command line because the pattern that is of interest is
424 at the data link level, and the relationship between what you type and
425 what the controllers transmit can be complicated.
427 This means that if you have a data-dependent problem you will probably
428 have to do a lot of testing to find it.
429 If you are lucky, you may manage to find a file that either
431 be sent across your network or that takes much longer to transfer than
432 other similar length files.
433 You can then examine this file for repeated patterns that you can test
441 utility returns 0 on success (the host is alive),
442 2 if the transmission was successful but no responses were received,
443 any other non-zero value if the arguments are incorrect or
444 another error has occured.
450 would work; the following will send ICMPv6 echo request to
452 .Bd -literal -offset indent
456 The following will probe hostnames for all nodes on the network link attached to
461 is named the link-local all-node multicast address, and the packet would
462 reach every node on the network link.
463 .Bd -literal -offset indent
467 The following will probe addresses assigned to the destination node,
469 .Bd -literal -offset indent
470 ping6 -a agl dst.foo.com
485 .%T "Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification"
491 .%T "IPv6 Node Information Queries"
492 .%N draft-ietf-ipngwg-icmp-name-lookups-09.txt
494 .%O work in progress material
503 utility with IPv6 support first appeared in the WIDE Hydrangea IPv6
506 IPv6 and IPsec support based on the KAME Project
507 .Pq Pa http://www.kame.net/
508 stack was initially integrated into
514 is intentionally separate from
517 There have been many discussions on why we separate
521 Some people argued that it would be more convenient to uniform the
522 ping command for both IPv4 and IPv6.
523 The followings are an answer to the request.
525 From a developer's point of view:
526 since the underling raw sockets API is totally different between IPv4
527 and IPv6, we would end up having two types of code base.
528 There would actually be less benefit to uniform the two commands
529 into a single command from the developer's standpoint.
531 From an operator's point of view: unlike ordinary network applications
532 like remote login tools, we are usually aware of address family when using
533 network management tools.
534 We do not just want to know the reachability to the host, but want to know the
535 reachability to the host via a particular network protocol such as
537 Thus, even if we had a unified
539 command for both IPv4 and IPv6, we would usually type a
543 option (or something like those) to specify the particular address family.
544 This essentially means that we have two different commands.
projects / apple / network_cmds.git / blob