usr.sbin/rtadvd/rtadvd.8

   1 .\"     $KAME: rtadvd.8,v 1.24 2002/05/31 16:16:08 jinmei 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 July 14, 2011
  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 dDfRs
  41 .Op Fl c Ar configfile
  42 .Op Fl M Ar ifname
  43 .Op Fl p Ar pidfile
  44 .Ar interface ...
  45 .Sh DESCRIPTION
  46 .Nm
  47 sends router advertisement packets to the specified
  48 .Ar interfaces .
  49 .Pp
  50 The program will daemonize itself on invocation.
  51 It will then send router advertisement packets periodically, as well
  52 as in response to router solicitation messages sent by end hosts.
  53 .Pp
  54 Router advertisements can be configured on a per-interface basis, as
  55 described in
  56 .Xr rtadvd.conf 5 .
  57 .Pp
  58 If there is no configuration file entry for an interface,
  59 or if the configuration file does not exist altogether,
  60 .Nm
  61 sets all the parameters to their default values.
  62 In particular,
  63 .Nm
  64 reads all the interface routes from the routing table and advertises
  65 them as on-link prefixes.
  66 .Pp
  67 .Nm
  68 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 4861, 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 Log messages will be dumped to stderr when this option is specified.
 131 .It Fl M
 132 Specify an interface to join the all-routers site-local multicast group.
 133 By default,
 134 .Nm
 135 tries to join the first advertising interface appearing on the command
 136 line.
 137 This option has meaning only with the
 138 .Fl R
 139 option, which enables routing renumbering protocol support.
 140 .It Fl p
 141 Specify an alternative file in which to store the process ID.
 142 The default is
 143 .Pa /var/run/rtadvd.pid.
 144 .It Fl R
 145 Accept router renumbering requests.
 146 If you enable it, certain IPsec setup is suggested for security reasons.
 147 This option is currently disabled, and is ignored by
 148 .Nm
 149 with a warning message.
 150 .It Fl s
 151 Do not add or delete prefixes dynamically.
 152 Only statically configured prefixes, if any, will be advertised.
 153 .El
 154 .Pp
 155 Use
 156 .Dv SIGHUP
 157 to reload the configuration file
 158 .Pa /etc/rtadvd.conf .
 159 If an invalid parameter is found in the configuration file upon the reload,
 160 the entry will be ignored and the old configuration will be used.
 161 When parameters in an existing entry are updated,
 162 .Nm
 163 will send Router Advertisement messages with the old configuration but
 164 zero router lifetime to the interface first, and then start to send a new
 165 message.
 166 .Pp
 167 Use
 168 .Dv SIGTERM
 169 to kill
 170 .Nm
 171 gracefully.
 172 In this case,
 173 .Nm
 174 will transmit router advertisement with router lifetime 0
 175 to all the interfaces
 176 .Pq in accordance with RFC 4861 6.2.5 .
 177 .Sh FILES
 178 .Bl -tag -width Pa -compact
 179 .It Pa /etc/rtadvd.conf
 180 The default configuration file.
 181 .It Pa /var/run/rtadvd.pid
 182 The default process ID file.
 183 .El
 184 .Sh EXIT STATUS
 185 .Ex -std
 186 .Sh SEE ALSO
 187 .Xr rtadvd.conf 5 ,
 188 .Xr rtsol 8
 189 .Rs
 190 .%A Thomas Narten
 191 .%A Erik Nordmark
 192 .%A W. A. Simpson
 193 .%A Hesham Soliman
 194 .%T Neighbor Discovery for IP version 6 (IPv6)
 195 .%R RFC 4861
 196 .Re
 197 .Rs
 198 .%A Thomas Narten
 199 .%A Erik Nordmark
 200 .%A W. A. Simpson
 201 .%T Neighbor Discovery for IP version 6 (IPv6)
 202 .%R RFC 2461 (obsoleted by RFC 4861)
 203 .Re
 204 .Rs
 205 .%A Richard Draves
 206 .%T Default Router Preferences and More-Specific Routes
 207 .%R draft-ietf-ipngwg-router-selection-xx.txt
 208 .Re
 209 .Rs
 210 .%A J. Jeong
 211 .%A S. Park
 212 .%A L. Beloeil
 213 .%A S. Madanapalli
 214 .%T IPv6 Router Advertisement Options for DNS Configuration
 215 .%R RFC 6106
 216 .Re
 217 .Sh HISTORY
 218 The
 219 .Nm
 220 command first appeared in the WIDE Hydrangea IPv6 protocol stack kit.
 221 .Sh BUGS
 222 There used to be some text that recommended users not to let
 223 .Nm
 224 advertise Router Advertisement messages on an upstream link to avoid
 225 undesirable
 226 .Xr icmp6 4
 227 redirect messages.
 228 However, based on the later discussion in the IETF ipng working group,
 229 all routers should rather advertise the messages regardless of
 230 the network topology, in order to ensure reachability.