.\"	$OpenBSD: rad.conf.5,v 1.1 2018/07/10 16:39:54 florian Exp $
.\"
.\" Copyright (c) 2018 Florian Obser <florian@openbsd.org>
.\" Copyright (c) 2005 Esben Norby <norby@openbsd.org>
.\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org>
.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
.\" Copyright (c) 2002 Daniel Hartmeier <dhartmei@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: July 10 2018 $
.Dt RAD.CONF 5
.Os
.Sh NAME
.Nm rad.conf
.Nd router advertisement daemon configuration file
.Sh DESCRIPTION
The
.Xr rad 8
daemon is an IPv6 router advertisement daemon.
.Pp
The
.Nm
config file is divided into the following main sections:
.Bl -tag -width xxxx
.It Sy Macros
User-defined variables may be defined and used later, simplifying the
configuration file.
.It Sy Global Configuration
Global settings for
.Xr rad 8 .
These are used as default values for
.Ic interface
definitions and can be overwritten in an
.Ic interface
block.
.It Sy Interfaces
.Xr rad 8
sends IPv6 router advertisement messages.
This section defines on which interfaces to advertise prefix information
and their associated parameters.
.El
.Pp
Additional configuration files can be included with the
.Ic include
keyword.
.Sh MACROS
Macros can be defined that will later be expanded in context.
Macro names must start with a letter, digit, or underscore,
and may contain any of those characters.
Macro names may not be reserved words (for example,
.Ic interface )
Macros are not expanded inside quotes.
.Sh GLOBAL CONFIGURATION
The global configuration section sets defaults for router advertisement
messages.
These can be overwritten in interface blocks.
.Pp
.Bl -tag -width Ds -compact
.It Ic default router Pq Ic yes Ns | Ns Ic no
act as a default router or not.
Default is yes.
.It Ic hop limit Ar hops
specifies the diameter of the internet.
Default is 0 meaning unspecified by this router.
.It managed address configuration Pq Ic yes Ns | Ns Ic no
if set to yes indicates that stateless address configuration prefixes are
not available and hosts should consult DHCPv6.
Default is no.
.It other configuration Pq Ic yes Ns | Ns Ic no
if set to yes hosts should consult DHCPv6 for additional configuration
like NTP servers or DNS resolvers.
.It Ic router lifetime Ar seconds
number of seconds this router is a valid default router after receiving
a router advertisement message.
Default 1800 seconds.
.\" .It Ic reachable time Ar number
.\" XXX
.\" .It Ic retrans timer Ar number
.\" XXX
.El
.Sh INTERFACES
A list of interfaces to send advertisments on.
.Bl -tag -width interface
.It Ic interface Ar name Op { prefix list }
.El
.Pp
Options set in the global section can be overwritten inside an interface
block.
In addition an interface block can contain a list of prefixes:
.Bl -tag -width prefix
.It Oo Ic no Oc Ic auto prefix Op { prefix options }
.It Ic prefix Ar prefix Op { prefix options }
.El
.Pp
The default is to discover prefixes to announce by inspecting the IPv6
addresses configured on an interface.
This can be disabled with
.Ic no auto prefix .
.Pp
.Ic prefix
options are as follows:
.Pp
.Bl -tag -width Ds -compact
.It Ic autonomous address-configuration Pq Ic yes Ns | Ns Ic no
this prefix can be used to generate IPv6 addresses.
The default is yes.
.It Ic on-link Pq Ic yes Ns | Ns Ic no
this prefix shall be considered on-link.
The default is yes.
.It Ic preferred lifetime Ar seconds
preferred lifetime (pltime) in seconds for addresses generated from this
prefix.
The default is 604800.
.It Ic valid lifetime Ar seconds
valid lifetime (vltime) in seconds for addresses generated from this
prefix.
The default is 2592000.
.El
.Sh FILES
.Bl -tag -width "/etc/rad.conf" -compact
.It Pa /etc/rad.conf
.Xr rad 8
configuration file
.El
.Sh EXAMPLES
.Bd -literal -offset indent
interface ix1
.Ed
.Sh SEE ALSO
.Xr ractl 8 ,
.Xr rad 8 ,
.Xr rc.conf.local 8
.Sh HISTORY
The
.Nm
file format first appeared in
.Ox 6.4 .