xref: /netbsd-src/usr.sbin/traceroute6/traceroute6.8 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: traceroute6.8,v 1.19 2018/04/23 07:13:50 wiz Exp $
2.\"	$KAME: traceroute6.8,v 1.8 2000/06/12 16:29:18 itojun Exp $
3.\"
4.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the project nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd April 23, 2018
32.Dt TRACEROUTE6 8
33.Os
34.\"
35.Sh NAME
36.Nm traceroute6
37.Nd print the route IPv6 packets will take to the destination
38.\"
39.Sh SYNOPSIS
40.Nm traceroute6
41.Op Fl adIlnrv
42.Op Fl A Ar as_server
43.Op Fl f Ar firsthop
44.Op Fl m Ar hoplimit
45.Op Fl p Ar port
46.Op Fl q Ar probes
47.Op Fl s Ar src
48.Op Fl w Ar waittime
49.Ar target
50.Op Ar datalen
51.\"
52.Sh DESCRIPTION
53.Nm
54uses the IPv6 protocol hop limit field to elicit an ICMPv6
55.Dv TIME_EXCEEDED
56response from each gateway along the path to some host.
57.Pp
58The only mandatory parameter is the destination host name or IPv6 address.
59The default probe datagram carries 12 bytes of payload,
60in addition to the IPv6 header.
61The size of the payload can be specified by giving a length
62.Po in bytes
63.Pc
64after the destination host name.
65.Pp
66Other options are:
67.Bl -tag -width Ds
68.It Fl A
69Turn on AS# lookups and use the given server instead of the default.
70.It Fl a
71Turn on AS# lookups for each hop encountered.
72.It Fl d
73Turn on socket-level debugging.
74.It Fl f Ar firsthop
75Specify how many hops to skip in trace.
76.It Fl I
77Use ICMP6 ECHO instead of UDP datagrams.
78.It Fl l
79Print both host hostnames and numeric addresses.
80Normally
81.Nm
82prints only hostnames if
83.Fl n
84is not specified, and only numeric addresses if
85.Fl n
86is specified.
87.It Fl m Ar hoplimit
88Specify maximum
89.Ar hoplimit ,
90up to 255.
91The default is 30 hops.
92.It Fl n
93Do not resolve numeric address to hostname.
94.It Fl p Ar port
95Set the base UDP port number use in probes to
96.Ar port .
97The default is 33434.
98.Nm
99hopes that nothing is listening on UDP ports
100.Va base
101to
102.Va base + nhops - 1
103at the destination host (so an ICMPv6
104.Dv PORT_UNREACHABLE
105message will be returned to terminate the route tracing).
106If something is listening on a port in the default range,
107this option can be used to pick an unused port range.
108.It Fl q Ar probes
109Set the number of probe packets sent per hop count to
110.Ar probes .
111By default,
112.Nm
113sends three probe packets.
114.It Fl r
115Bypass the normal routing tables and send directly to
116a host on an attached network.
117If the host is not on a directly-attached network,
118an error is returned.
119This option can be used to send probes to a local host
120through an interface that has no route through it
121(e.g., after the interface was dropped by
122.Xr route6d 8 ) .
123.It Fl s Ar src
124Use the IPv6 address,
125.Ar src ,
126as the source address in outgoing probe packets.
127.It Fl v
128Be verbose.
129Received ICMPv6 packets other than
130.Dv TIME_EXCEEDED
131and
132.Dv UNREACHABLEs
133are listed.
134.It Fl w Ar waittime
135Use
136.Ar waittime
137as the delay in seconds, between probes.
138The default is 5 seconds.
139.El
140.Pp
141This program prints the route to the given destination
142and the round-trip time to each gateway,
143in the same manner as traceroute.
144.Pp
145Here is a list of possible annotations after the
146round-trip time for each gateway:
147.Bl -hang -offset indent
148.It  !N
149Destination Unreachable - No Route to Host.
150.It  !X
151Destination Unreachable - Administratively Prohibited.
152.It  !S
153Destination Unreachable - Not a Neighbour.
154.It  !H
155Destination Unreachable - Address Unreachable.
156.It  !
157This is printed if the hop limit is <= 1 on a port unreachable message.
158This means that the packet got to the destination,
159but that the reply had a hop limit that was just
160large enough to allow it to get back to the source of the
161.Nm .
162This was more interesting in the IPv4 case,
163where some IP stack bugs could be identified by this behaviour.
164.El
165.\"
166.Sh EXIT STATUS
167.Ex -std traceroute6
168.\"
169.Sh SEE ALSO
170.Xr ping 8 ,
171.Xr ping6 8 ,
172.Xr traceroute 8
173.\"
174.Sh HISTORY
175The
176.Nm
177command first appeared in WIDE hydrangea IPv6 protocol stack kit.
178