xref: /openbsd-src/usr.sbin/rad/rad.conf.5 (revision 99fd087599a8791921855f21bd7e36130f39aadc)
1.\"	$OpenBSD: rad.conf.5,v 1.16 2020/02/10 13:18:21 schwarze Exp $
2.\"
3.\" Copyright (c) 2018 Florian Obser <florian@openbsd.org>
4.\" Copyright (c) 2005 Esben Norby <norby@openbsd.org>
5.\" Copyright (c) 2004 Claudio Jeker <claudio@openbsd.org>
6.\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
7.\" Copyright (c) 2002 Daniel Hartmeier <dhartmei@openbsd.org>
8.\"
9.\" Permission to use, copy, modify, and distribute this software for any
10.\" purpose with or without fee is hereby granted, provided that the above
11.\" copyright notice and this permission notice appear in all copies.
12.\"
13.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20.\"
21.Dd $Mdocdate: February 10 2020 $
22.Dt RAD.CONF 5
23.Os
24.Sh NAME
25.Nm rad.conf
26.Nd router advertisement daemon configuration file
27.Sh DESCRIPTION
28The
29.Xr rad 8
30daemon is an IPv6 router advertisement daemon.
31.Pp
32The
33.Nm
34config file is divided into the following main sections:
35.Bl -tag -width xxxx
36.It Sy Macros
37User-defined variables may be defined and used later, simplifying the
38configuration file.
39.It Sy Global Configuration
40Global settings for
41.Xr rad 8 .
42These are used as default values for
43.Ic interface
44definitions and can be overwritten in an
45.Ic interface
46block.
47.It Sy Interfaces
48.Xr rad 8
49sends IPv6 router advertisement messages.
50This section defines on which interfaces to advertise prefix information
51and their associated parameters.
52.El
53.Pp
54Additional configuration files can be included with the
55.Ic include
56keyword.
57.Sh MACROS
58Macros can be defined that will later be expanded in context.
59Macro names must start with a letter, digit, or underscore,
60and may contain any of those characters.
61Macro names may not be reserved words (for example,
62.Ic interface )
63Macros are not expanded inside quotes.
64.Sh GLOBAL CONFIGURATION
65The global configuration section sets defaults for router advertisement
66messages.
67These can be overwritten in interface blocks.
68.Bl -tag -width Ds
69.It Ic default router Pq Ic yes Ns | Ns Ic no
70Act as a default router or not.
71The default is yes.
72.It Ic dns Brq dns options
73.Ic dns
74options are as follows:
75.Bl -tag -width Ds
76.It Ic lifetime Ar seconds
77The number of seconds the dns options are valid after receiving a router
78advertisement message.
79The default is 900 seconds.
80.It Ic nameserver Pq Ar IP Ns | Ns { nameserver list }
81IPv6 address or list of IPv6 addresses of DNS name servers.
82.It Ic search Pq Ar domain Ns | Ns { domain list }
83Domain or list of domains for the
84.Xr resolv.conf 5
85search list.
86.El
87.It Ic hop limit Ar hops
88Specify the diameter of the internet.
89The default is 0, meaning unspecified by this router.
90.It Ic managed address configuration Pq Ic yes Ns | Ns Ic no
91If set to yes, indicate that stateless address configuration prefixes are
92not available and hosts should consult DHCPv6.
93The default is no.
94.It Ic mtu Ar bytes
95The MTU option is used in Router Advertisement messages to ensure that all
96nodes on a link use the same MTU value in those cases where the link MTU
97is not well known.
98The default is 0, meaning unspecified by this router.
99.It Ic other configuration Pq Ic yes Ns | Ns Ic no
100If set to yes, hosts should consult DHCPv6 for additional configuration
101like NTP servers or DNS name servers.
102.It Ic router lifetime Ar seconds
103The number of seconds this router is a valid default router after receiving
104a router advertisement message.
105The default is 1800 seconds.
106.\" .It Ic reachable time Ar number
107.\" XXX
108.\" .It Ic retrans timer Ar number
109.\" XXX
110.El
111.Sh INTERFACES
112A list of interfaces or interface groups to send advertisements on:
113.Bd -unfilled -offset indent
114.Ic interface Ar name Op { prefix list }
115.Ed
116.Pp
117Options set in the global section can be overwritten inside an interface
118block.
119In addition an interface block can contain a list of prefixes:
120.Bd -unfilled -offset indent
121.Oo Ic no Oc Ic auto prefix Op { prefix options }
122.Ic prefix Ar prefix Op { prefix options }
123.Ed
124.Pp
125The default is to discover prefixes to announce by inspecting the IPv6
126addresses configured on an interface.
127This can be disabled with
128.Ic no auto prefix .
129If
130.Ar prefix
131is specified without prefixlen, its default is 64.
132.Pp
133.Ic prefix
134options are as follows:
135.Bl -tag -width Ds
136.It Ic autonomous address-configuration Pq Ic yes Ns | Ns Ic no
137This prefix can be used to generate IPv6 addresses.
138The default is yes.
139.It Ic on-link Pq Ic yes Ns | Ns Ic no
140This prefix is considered on-link.
141The default is yes.
142.It Ic preferred lifetime Ar seconds
143The preferred lifetime (pltime) in seconds for addresses generated from this
144prefix.
145The default is 604800.
146.It Ic valid lifetime Ar seconds
147The valid lifetime (vltime) in seconds for addresses generated from this
148prefix.
149The default is 2592000.
150.El
151.Sh FILES
152.Bl -tag -width /etc/examples/rad.conf -compact
153.It Pa /etc/rad.conf
154.Xr rad 8
155configuration file
156.It Pa /etc/examples/rad.conf
157example configuration file
158.El
159.Sh EXAMPLES
160With the following example configuration,
161.Nm
162will pick a prefix from the ix1 interface and send router advertisements on it:
163.Pp
164.Dl interface ix1
165.Sh SEE ALSO
166.Xr ractl 8 ,
167.Xr rad 8 ,
168.Xr rc.conf.local 8
169.Sh HISTORY
170The
171.Nm
172file format first appeared in
173.Ox 6.4 .
174