usr.sbin/rtadvd/rtadvd.8

   1 .\"     $FreeBSD: src/usr.sbin/rtadvd/rtadvd.8,v 1.3.2.8 2003/03/11 22:31:32 trhodes Exp $
   2 .\"     $DragonFly: src/usr.sbin/rtadvd/rtadvd.8,v 1.4 2007/11/23 23:16:37 swildner Exp $
   3 .\"     $KAME: rtadvd.8,v 1.17 2001/02/04 05:34:38 jinmei Exp $
   4 .\"
   5 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
   6 .\" All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the project 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 PROJECT 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 PROJECT 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 .Dd May 17, 1998
  33 .Dt RTADVD 8
  34 .Os
  35 .Sh NAME
  36 .Nm rtadvd
  37 .Nd router advertisement daemon
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl dDfMRs
  41 .Op Fl c Ar configfile
  42 .Ar interface ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility sends router advertisement packets to the specified
  47 .Ar interfaces .
  48 .Pp
  49 The program will daemonize itself on invocation.
  50 It will then send router advertisement packets periodically, as well
  51 as in response to router solicitation messages sent by end hosts.
  52 .Pp
  53 Router advertisements can be configured on a per-interface basis, as
  54 described in
  55 .Xr rtadvd.conf 5 .
  56 .Pp
  57 If there is no configuration file entry for an interface,
  58 or if the configuration file does not exist altogether,
  59 .Nm
  60 sets all the parameters to their default values.
  61 In particular,
  62 .Nm
  63 reads all the interface routes from the routing table and advertises
  64 them as on-link prefixes.
  65 .Pp
  66 The
  67 .Nm
  68 utility also watches the routing table.
  69 If an interface direct route is
  70 added on an advertising interface and no static prefixes are
  71 specified by the configuration file,
  72 .Nm
  73 adds the corresponding prefix to its advertising list.
  74 .Pp
  75 Similarly, when an interface direct route is deleted,
  76 .Nm
  77 will start advertising the prefixes with zero valid and preferred
  78 lifetimes to help the receiving hosts switch to a new prefix when
  79 renumbering.
  80 Note, however, that the zero valid lifetime cannot invalidate the
  81 autoconfigured addresses at a receiving host immediately.
  82 According to the specification, the host will retain the address
  83 for a certain period, which will typically be two hours.
  84 The zero lifetimes rather intend to make the address deprecated,
  85 indicating that a new non-deprecated address should be used as the
  86 source address of a new connection.
  87 This behavior will last for two hours.
  88 Then
  89 .Nm
  90 will completely remove the prefix from the advertising list,
  91 and succeeding advertisements will not contain the prefix information.
  92 .Pp
  93 Moreover, if the status of an advertising interface changes,
  94 .Nm
  95 will start or stop sending router advertisements according
  96 to the latest status.
  97 .Pp
  98 The
  99 .Fl s
 100 option may be used to disable this behavior;
 101 .Nm
 102 will not watch the routing table and the whole functionality described
 103 above will be suppressed.
 104 .Pp
 105 Basically, hosts MUST NOT send Router Advertisement messages at any
 106 time (RFC 2461, Section 6.2.3).
 107 However, it would sometimes be useful to allow hosts to advertise some
 108 parameters such as prefix information and link MTU.
 109 Thus,
 110 .Nm
 111 can be invoked if router lifetime is explicitly set zero on every
 112 advertising interface.
 113 .Pp
 114 The command line options are:
 115 .Bl -tag -width indent
 116 .\"
 117 .It Fl c
 118 Specify an alternate location,
 119 .Ar configfile ,
 120 for the configuration file.
 121 By default,
 122 .Pa /etc/rtadvd.conf
 123 is used.
 124 .It Fl d
 125 Print debugging information.
 126 .It Fl D
 127 Even more debugging information is printed.
 128 .It Fl f
 129 Foreground mode (useful when debugging).
 130 .It Fl M
 131 Specify an interface to join the all-routers site-local multicast group.
 132 By default,
 133 .Nm
 134 tries to join the first advertising interface appeared in the command
 135 line.
 136 This option has meaning only with the
 137 .Fl R
 138 option, which enables routing renumbering protocol support.
 139 .\".It Fl m
 140 .\"Enables mobile IPv6 support.
 141 .\"This changes the content of router advertisement option, as well as
 142 .\"permitted configuration directives.
 143 .It Fl R
 144 Accept router renumbering requests.
 145 If you enable it, certain IPsec setup is suggested for security reasons.
 146 On KAME-based systems,
 147 .Xr rrenumd 8
 148 generates router renumbering request packets.
 149 This option is currently disabled, and is ignored by
 150 .Nm
 151 with a warning message.
 152 .It Fl s
 153 Do not add or delete prefixes dynamically.
 154 Only statically configured prefixes, if any, will be advertised.
 155 .El
 156 .Pp
 157 Upon receipt of signal
 158 .Dv SIGUSR1 ,
 159 .Nm
 160 will dump the current internal state into
 161 .Pa /var/run/rtadvd.dump .
 162 .Pp
 163 Use
 164 .Dv SIGTERM
 165 to kill
 166 .Nm
 167 gracefully.
 168 In this case,
 169 .Nm
 170 will transmit router advertisement with router lifetime 0
 171 to all the interfaces
 172 (in accordance with RFC 2461 6.2.5).
 173 .Sh FILES
 174 .Bl -tag -width Pa -compact
 175 .It Pa /etc/rtadvd.conf
 176 The default configuration file.
 177 .It Pa /var/run/rtadvd.pid
 178 contains the pid of the currently running
 179 .Nm .
 180 .It Pa /var/run/rtadvd.dump
 181 in which
 182 .Nm
 183 dumps its internal state.
 184 .El
 185 .Sh DIAGNOSTICS
 186 .Ex -std
 187 .Sh SEE ALSO
 188 .Xr rtadvd.conf 5 ,
 189 .Xr rrenumd 8 ,
 190 .Xr rtsol 8
 191 .Sh HISTORY
 192 The
 193 .Nm
 194 utility first appeared in WIDE Hydrangea IPv6 protocol stack kit.
 195 .Sh CAVEAT
 196 There used to be some text that recommended users not to let
 197 .Nm
 198 advertise Router Advertisement messages on an upstream link to avoid
 199 undesirable
 200 .Xr icmp6 4
 201 redirect messages.
 202 However, based on the later discussion in the IETF ipng working group,
 203 all routers should rather advertise the messages regardless of
 204 the network topology, in order to ensure reachability.