usr.sbin/rtadvd/rtadvd.8

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