sbin/ping6/ping6.8

   1 .\"     $KAME: ping6.8,v 1.58 2003/06/20 12:00:22 itojun Exp $
   2 .\"
   3 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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.
  17 .\"
  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
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd May 5, 2013
  33 .Dt PING6 8
  34 .Os
  35 .Sh NAME
  36 .Nm ping6
  37 .Nd send
  38 .Tn ICMPv6 ECHO_REQUEST
  39 packets to network hosts
  40 .Sh SYNOPSIS
  41 .Nm
  42 .\" without ipsec, or new ipsec
  43 .Op Fl DdfHmnNoqrRtvwW
  44 .\" old ipsec
  45 .\" .Op Fl ADdEfmnNqRtvwW
  46 .Bk -words
  47 .Op Fl a Ar addrtype
  48 .Ek
  49 .Bk -words
  50 .Op Fl b Ar bufsiz
  51 .Ek
  52 .Bk -words
  53 .Op Fl c Ar count
  54 .Ek
  55 .Bk -words
  56 .Op Fl g Ar gateway
  57 .Ek
  58 .Bk -words
  59 .Op Fl h Ar hoplimit
  60 .Ek
  61 .Bk -words
  62 .Op Fl I Ar interface
  63 .Ek
  64 .Bk -words
  65 .Op Fl i Ar wait
  66 .Ek
  67 .Bk -words
  68 .Op Fl l Ar preload
  69 .Ek
  70 .Bk -words
  71 .\" new ipsec
  72 .Op Fl P Ar policy
  73 .Ek
  74 .Bk -words
  75 .Op Fl p Ar pattern
  76 .Ek
  77 .Bk -words
  78 .Op Fl S Ar sourceaddr
  79 .Ek
  80 .Bk -words
  81 .Op Fl s Ar packetsize
  82 .Ek
  83 .Bk -words
  84 .Op Ar hops ...
  85 .Ek
  86 .Bk -words
  87 .Ar host
  88 .Ek
  89 .Sh DESCRIPTION
  90 The
  91 .Nm
  92 utility uses the
  93 .Tn ICMPv6
  94 protocol's mandatory
  95 .Tn ICMP6_ECHO_REQUEST
  96 datagram to elicit an
  97 .Tn ICMP6_ECHO_REPLY
  98 from a host or gateway.
  99 .Tn ICMP6_ECHO_REQUEST
 100 datagrams (``pings'') have an IPv6 header,
 101 and
 102 .Tn ICMPv6
 103 header formatted as documented in RFC2463.
 104 The options are as follows:
 105 .Bl -tag -width Ds
 106 .\" old ipsec
 107 .\" .It Fl A
 108 .\" Enables transport-mode IPsec authentication header
 109 .\" (experimental).
 110 .It Fl a Ar addrtype
 111 Generate ICMPv6 Node Information Node Addresses query, rather than echo-request.
 112 .Ar addrtype
 113 must be a string constructed of the following characters.
 114 .Bl -tag -width Ds -compact
 115 .It Ic a
 116 requests unicast addresses from all of the responder's interfaces.
 117 If the character is omitted,
 118 only those addresses which belong to the interface which has the
 119 responder's address are requests.
 120 .It Ic c
 121 requests responder's IPv4-compatible and IPv4-mapped addresses.
 122 .It Ic g
 123 requests responder's global-scope addresses.
 124 .It Ic s
 125 requests responder's site-local addresses.
 126 .It Ic l
 127 requests responder's link-local addresses.
 128 .It Ic A
 129 requests responder's anycast addresses.
 130 Without this character, the responder will return unicast addresses only.
 131 With this character, the responder will return anycast addresses only.
 132 Note that the specification does not specify how to get responder's
 133 anycast addresses.
 134 This is an experimental option.
 135 .El
 136 .It Fl b Ar bufsiz
 137 Set socket buffer size.
 138 .It Fl c Ar count
 139 Stop after sending
 140 (and receiving)
 141 .Ar count
 142 .Tn ECHO_RESPONSE
 143 packets.
 144 .It Fl D
 145 Disable IPv6 fragmentation.
 146 .It Fl d
 147 Set the
 148 .Dv SO_DEBUG
 149 option on the socket being used.
 150 .\" .It Fl E
 151 .\" Enables transport-mode IPsec encapsulated security payload
 152 .\" (experimental).
 153 .It Fl f
 154 Flood ping.
 155 Outputs packets as fast as they come back or one hundred times per second,
 156 whichever is more.
 157 For every
 158 .Tn ECHO_REQUEST
 159 sent a period
 160 .Dq \&.
 161 is printed, while for every
 162 .Tn ECHO_REPLY
 163 received a backspace is printed.
 164 This provides a rapid display of how many packets are being dropped.
 165 Only the super-user may use this option.
 166 .Bf -emphasis
 167 This can be very hard on a network and should be used with caution.
 168 .Ef
 169 .It Fl g Ar gateway
 170 Specifies to use
 171 .Ar gateway
 172 as the next hop to the destination.
 173 The gateway must be a neighbor of the sending node.
 174 .It Fl H
 175 Specifies to try reverse-lookup of IPv6 addresses.
 176 The
 177 .Nm
 178 utility does not try reverse-lookup unless the option is specified.
 179 .It Fl h Ar hoplimit
 180 Set the IPv6 hoplimit.
 181 .It Fl I Ar interface
 182 Source packets with the given interface address.
 183 This flag applies if the ping destination is a multicast address,
 184 or link-local/site-local unicast address.
 185 .It Fl i Ar wait
 186 Wait
 187 .Ar wait
 188 seconds
 189 .Em between sending each packet .
 190 The default is to wait for one second between each packet.
 191 This option is incompatible with the
 192 .Fl f
 193 option.
 194 .It Fl l Ar preload
 195 If
 196 .Ar preload
 197 is specified,
 198 .Nm
 199 sends that many packets as fast as possible before falling into its normal
 200 mode of behavior.
 201 Only the super-user may use this option.
 202 .It Fl m
 203 By default,
 204 .Nm
 205 asks the kernel to fragment packets to fit into the minimum IPv6 MTU.
 206 The
 207 .Fl m
 208 option
 209 will suppress the behavior in the following two levels:
 210 when the option is specified once, the behavior will be disabled for
 211 unicast packets.
 212 When the option is more than once, it will be disabled for both
 213 unicast and multicast packets.
 214 .It Fl n
 215 Numeric output only.
 216 No attempt will be made to lookup symbolic names from addresses in the reply.
 217 .It Fl N
 218 Probe node information multicast group address
 219 .Pq Li ff02::2:ffxx:xxxx .
 220 .Ar host
 221 must be string hostname of the target
 222 (must not be a numeric IPv6 address).
 223 Node information multicast group will be computed based on given
 224 .Ar host ,
 225 and will be used as the final destination.
 226 Since node information multicast group is a link-local multicast group,
 227 outgoing interface needs to be specified by
 228 .Fl I
 229 option.
 230 .Pp
 231 When specified twice, the address
 232 .Pq Li ff02::2:xxxx:xxxx
 233 is used instead.
 234 The former is in RFC 4620, the latter is in an old Internet Draft
 235 draft-ietf-ipngwg-icmp-name-lookup.
 236 Note that KAME-derived implementations including
 237 .Fx
 238 use the latter.
 239 .It Fl o
 240 Exit successfully after receiving one reply packet.
 241 .It Fl p Ar pattern
 242 You may specify up to 16
 243 .Dq pad
 244 bytes to fill out the packet you send.
 245 This is useful for diagnosing data-dependent problems in a network.
 246 For example,
 247 .Dq Li \-p ff
 248 will cause the sent packet to be filled with all
 249 ones.
 250 .\" new ipsec
 251 .It Fl P Ar policy
 252 .Ar policy
 253 specifies IPsec policy to be used for the probe.
 254 .It Fl q
 255 Quiet output.
 256 Nothing is displayed except the summary lines at startup time and
 257 when finished.
 258 .It Fl r
 259 Audible.
 260 Include a bell
 261 .Tn ( ASCII
 262 0x07)
 263 character in the output when any packet is received.
 264 .It Fl R
 265 Audible.
 266 Output a bell
 267 .Tn ( ASCII
 268 0x07)
 269 character when no packet is received before the next packet
 270 is transmitted.
 271 To cater for round-trip times that are longer than the interval
 272 between transmissions, further missing packets cause a bell only
 273 if the maximum number of unreceived packets has increased.
 274 .It Fl S Ar sourceaddr
 275 Specifies the source address of request packets.
 276 The source address must be one of the unicast addresses of the sending node,
 277 and must be numeric.
 278 .It Fl s Ar packetsize
 279 Specifies the number of data bytes to be sent.
 280 The default is 56, which translates into 64
 281 .Tn ICMP
 282 data bytes when combined
 283 with the 8 bytes of
 284 .Tn ICMP
 285 header data.
 286 You may need to specify
 287 .Fl b
 288 as well to extend socket buffer size.
 289 .It Fl t
 290 Generate ICMPv6 Node Information supported query types query,
 291 rather than echo-request.
 292 .Fl s
 293 has no effect if
 294 .Fl t
 295 is specified.
 296 .It Fl v
 297 Verbose output.
 298 .Tn ICMP
 299 packets other than
 300 .Tn ECHO_RESPONSE
 301 that are received are listed.
 302 .It Fl w
 303 Generate ICMPv6 Node Information DNS Name query, rather than echo-request.
 304 .Fl s
 305 has no effect if
 306 .Fl w
 307 is specified.
 308 .It Fl W
 309 Same as
 310 .Fl w ,
 311 but with old packet format based on 03 draft.
 312 This option is present for backward compatibility.
 313 .Fl s
 314 has no effect if
 315 .Fl w
 316 is specified.
 317 .It Ar hops
 318 IPv6 addresses for intermediate nodes,
 319 which will be put into type 0 routing header.
 320 .It Ar host
 321 IPv6 address of the final destination node.
 322 .El
 323 .Pp
 324 When using
 325 .Nm
 326 for fault isolation, it should first be run on the local host, to verify
 327 that the local network interface is up and running.
 328 Then, hosts and gateways further and further away should be
 329 .Dq pinged .
 330 Round-trip times and packet loss statistics are computed.
 331 If duplicate packets are received, they are not included in the packet
 332 loss calculation, although the round trip time of these packets is used
 333 in calculating the round-trip time statistics.
 334 When the specified number of packets have been sent
 335 (and received)
 336 or if the program is terminated with a
 337 .Dv SIGINT ,
 338 a brief summary is displayed, showing the number of packets sent and
 339 received, and the minimum, mean, maximum, and standard deviation of
 340 the round-trip times.
 341 .Pp
 342 If
 343 .Nm
 344 receives a
 345 .Dv SIGINFO
 346 (see the
 347 .Cm status
 348 argument for
 349 .Xr stty 1 )
 350 signal, the current number of packets sent and received, and the
 351 minimum, mean, maximum, and standard deviation of the round-trip times
 352 will be written to the standard output in the same format as the
 353 standard completion message.
 354 .Pp
 355 This program is intended for use in network testing, measurement and
 356 management.
 357 Because of the load it can impose on the network, it is unwise to use
 358 .Nm
 359 during normal operations or from automated scripts.
 360 .\" .Sh ICMP PACKET DETAILS
 361 .\" An IP header without options is 20 bytes.
 362 .\" An
 363 .\" .Tn ICMP
 364 .\" .Tn ECHO_REQUEST
 365 .\" packet contains an additional 8 bytes worth of
 366 .\" .Tn ICMP
 367 .\" header followed by an arbitrary amount of data.
 368 .\" When a
 369 .\" .Ar packetsize
 370 .\" is given, this indicated the size of this extra piece of data
 371 .\" (the default is 56).
 372 .\" Thus the amount of data received inside of an IP packet of type
 373 .\" .Tn ICMP
 374 .\" .Tn ECHO_REPLY
 375 .\" will always be 8 bytes more than the requested data space
 376 .\" (the
 377 .\" .Tn ICMP
 378 .\" header).
 379 .\" .Pp
 380 .\" If the data space is at least eight bytes large,
 381 .\" .Nm
 382 .\" uses the first eight bytes of this space to include a timestamp which
 383 .\" it uses in the computation of round trip times.
 384 .\" If less than eight bytes of pad are specified, no round trip times are
 385 .\" given.
 386 .Sh DUPLICATE AND DAMAGED PACKETS
 387 The
 388 .Nm
 389 utility will report duplicate and damaged packets.
 390 Duplicate packets should never occur when pinging a unicast address,
 391 and seem to be caused by
 392 inappropriate link-level retransmissions.
 393 Duplicates may occur in many situations and are rarely
 394 (if ever)
 395 a good sign, although the presence of low levels of duplicates may not
 396 always be cause for alarm.
 397 Duplicates are expected when pinging a broadcast or multicast address,
 398 since they are not really duplicates but replies from different hosts
 399 to the same request.
 400 .Pp
 401 Damaged packets are obviously serious cause for alarm and often
 402 indicate broken hardware somewhere in the
 403 .Nm
 404 packet's path
 405 (in the network or in the hosts).
 406 .Sh TRYING DIFFERENT DATA PATTERNS
 407 The
 408 (inter)network
 409 layer should never treat packets differently depending on the data
 410 contained in the data portion.
 411 Unfortunately, data-dependent problems have been known to sneak into
 412 networks and remain undetected for long periods of time.
 413 In many cases the particular pattern that will have problems is something
 414 that does not have sufficient
 415 .Dq transitions ,
 416 such as all ones or all zeros, or a pattern right at the edge, such as
 417 almost all zeros.
 418 It is not
 419 necessarily enough to specify a data pattern of all zeros (for example)
 420 on the command line because the pattern that is of interest is
 421 at the data link level, and the relationship between what you type and
 422 what the controllers transmit can be complicated.
 423 .Pp
 424 This means that if you have a data-dependent problem you will probably
 425 have to do a lot of testing to find it.
 426 If you are lucky, you may manage to find a file that either
 427 cannot
 428 be sent across your network or that takes much longer to transfer than
 429 other similar length files.
 430 You can then examine this file for repeated patterns that you can test
 431 using the
 432 .Fl p
 433 option of
 434 .Nm .
 435 .Sh EXIT STATUS
 436 The
 437 .Nm
 438 utility returns 0 on success (the host is alive),
 439 2 if the transmission was successful but no responses were received,
 440 any other non-zero value if the arguments are incorrect or
 441 another error has occurred.
 442 .Sh EXAMPLES
 443 Normally,
 444 .Nm
 445 works just like
 446 .Xr ping 8
 447 would work; the following will send ICMPv6 echo request to
 448 .Li dst.foo.com .
 449 .Bd -literal -offset indent
 450 ping6 -n dst.foo.com
 451 .Ed
 452 .Pp
 453 The following will probe hostnames for all nodes on the network link attached to
 454 .Li wi0
 455 interface.
 456 The address
 457 .Li ff02::1
 458 is named the link-local all-node multicast address, and the packet would
 459 reach every node on the network link.
 460 .Bd -literal -offset indent
 461 ping6 -w ff02::1%wi0
 462 .Ed
 463 .Pp
 464 The following will probe addresses assigned to the destination node,
 465 .Li dst.foo.com .
 466 .Bd -literal -offset indent
 467 ping6 -a agl dst.foo.com
 468 .Ed
 469 .Sh SEE ALSO
 470 .Xr netstat 1 ,
 471 .Xr icmp6 4 ,
 472 .Xr inet6 4 ,
 473 .Xr ip6 4 ,
 474 .Xr ifconfig 8 ,
 475 .Xr ping 8 ,
 476 .Xr routed 8 ,
 477 .Xr traceroute 8 ,
 478 .Xr traceroute6 8
 479 .Rs
 480 .%A A. Conta
 481 .%A S. Deering
 482 .%T "Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification"
 483 .%N RFC2463
 484 .%D December 1998
 485 .Re
 486 .Rs
 487 .%A Matt Crawford
 488 .%T "IPv6 Node Information Queries"
 489 .%N draft-ietf-ipngwg-icmp-name-lookups-09.txt
 490 .%D May 2002
 491 .%O work in progress material
 492 .Re
 493 .Sh HISTORY
 494 The
 495 .Xr ping 8
 496 utility appeared in
 497 .Bx 4.3 .
 498 The
 499 .Nm
 500 utility with IPv6 support first appeared in the WIDE Hydrangea IPv6
 501 protocol stack kit.
 502 .Pp
 503 IPv6 and IPsec support based on the KAME Project
 504 .Pq Pa http://www.kame.net/
 505 stack was initially integrated into
 506 .Fx 4.0 .
 507 .Sh BUGS
 508 The
 509 .Nm
 510 utility
 511 is intentionally separate from
 512 .Xr ping 8 .
 513 .Pp
 514 There have been many discussions on why we separate
 515 .Nm
 516 and
 517 .Xr ping 8 .
 518 Some people argued that it would be more convenient to uniform the
 519 ping command for both IPv4 and IPv6.
 520 The followings are an answer to the request.
 521 .Pp
 522 From a developer's point of view:
 523 since the underling raw sockets API is totally different between IPv4
 524 and IPv6, we would end up having two types of code base.
 525 There would actually be less benefit to uniform the two commands
 526 into a single command from the developer's standpoint.
 527 .Pp
 528 From an operator's point of view: unlike ordinary network applications
 529 like remote login tools, we are usually aware of address family when using
 530 network management tools.
 531 We do not just want to know the reachability to the host, but want to know the
 532 reachability to the host via a particular network protocol such as
 533 IPv6.
 534 Thus, even if we had a unified
 535 .Xr ping 8
 536 command for both IPv4 and IPv6, we would usually type a
 537 .Fl 6
 538 or
 539 .Fl 4
 540 option (or something like those) to specify the particular address family.
 541 This essentially means that we have two different commands.