xref: /openbsd/sbin/dhcpleased/dhcpleased.conf.5 (revision 3f1d4014)
1.\"	$OpenBSD: dhcpleased.conf.5,v 1.8 2021/09/21 17:23:24 florian Exp $
2.\"
3.\" Copyright (c) 2018, 2021 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: September 21 2021 $
22.Dt DHCPLEASED.CONF 5
23.Os
24.Sh NAME
25.Nm dhcpleased.conf
26.Nd dynamic host configuration protocol client daemon configuration file
27.Sh DESCRIPTION
28The
29.Xr dhcpleased 8
30daemon is a dynamic host configuration protocol client 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 Interfaces
40If an interface requires non-default options, they can be defined in
41this section.
42Most configurations do not require this.
43.El
44.Sh MACROS
45Macros can be defined that will later be expanded in context.
46Macro names must start with a letter, digit, or underscore,
47and may contain any of those characters.
48Macro names may not be reserved words (for example,
49.Ic interface )
50Macros are not expanded inside quotes.
51.Sh INTERFACES
52A list of interfaces to overwrite defaults:
53.Bd -unfilled -offset indent
54.Ic interface Ar name Brq Op Ar option ...
55.Ed
56.Pp
57.Ic interface
58options are as follows:
59.Bl -tag -width Ds
60.It Ic ignore dns
61Ignore nameservers from leases on this interface.
62The default is to not ignore nameservers.
63.It Ic ignore routes
64Ignore routes from leases on this interface.
65The default is to not ignore routes.
66.It Ic ignore Ar server-ip
67Ignore leases from
68.Ar server-ip .
69This option can be listed multiple times.
70The default is to not ignore servers.
71.It Ic send client id Ar client-id
72Send the DHCP client identifier option with a value of
73.Ar client-id .
74If
75.Ar client-id
76consists of a series of octets of two-digit hexadecimal numbers separated by
77colons, the first octet is used as the type and the rest as value.
78The MAC address 00:53:FF:AA:BB:CC would be configured as:
79.Bd -literal -offset indent
80send client id "01:00:53:FF:AA:BB:CC"
81.Ed
82.Pp
83Otherwise the string
84.Ar client-id
85is sent verbatim.
86The default is to send the interface's MAC address as client identifier.
87.Pp
88When
89.Ar client-id
90is not a hardware address it is supposed to be sent as hardware type 0 but
91the majority of DHCP clients and servers do not implement this and neither
92does
93.Nm .
94If a server is encountered that requires this, a 0 byte can be encoded as \e0.
95The client identifier
96.Dq foobar
97with hardware type 0 would be configured as:
98.Bd -literal -offset indent
99send client id "\e0foobar"
100.Ed
101.It Ic send vendor class id Ar vendor-class-id
102Send the DHCP vendor class identifier option with a value of
103.Ar vendor-class-id .
104The default is to not send a vendor class identifier.
105.El
106.Sh FILES
107.Bl -tag -width /etc/dhcpleased.conf -compact
108.It Pa /etc/dhcpleased.conf
109.Xr dhcpleased 8
110configuration file.
111.El
112.Sh SEE ALSO
113.Xr dhcpleasectl 8 ,
114.Xr dhcpleased 8
115