blob: bd99b48e6970b2cd019c95a5c893a9c7c4e3d859 [file] [log] [blame]
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001.TH DNSMASQ 8
2.SH NAME
3dnsmasq \- A lightweight DHCP and caching DNS server.
4.SH SYNOPSIS
5.B dnsmasq
6.I [OPTION]...
7.SH "DESCRIPTION"
8.BR dnsmasq
Simon Kelley34d0a362013-01-02 11:40:56 +00009is a lightweight DNS, TFTP, PXE, router advertisement and DHCP server. It is intended to provide
Simon Kelley5aabfc72007-08-29 11:24:47 +010010coupled DNS and DHCP service to a LAN.
Simon Kelley9e4abcb2004-01-22 19:47:41 +000011.PP
12Dnsmasq accepts DNS queries and either answers them from a small, local,
13cache or forwards them to a real, recursive, DNS server. It loads the
14contents of /etc/hosts so that local hostnames
15which do not appear in the global DNS can be resolved and also answers
Simon Kelleyee415862014-02-11 11:07:22 +000016DNS queries for DHCP configured hosts. It can also act as the
17authoritative DNS server for one or more domains, allowing local names
18to appear in the global DNS. It can be configured to do DNSSEC
19validation.
Simon Kelley9e4abcb2004-01-22 19:47:41 +000020.PP
Simon Kelley73a08a22009-02-05 20:28:08 +000021The dnsmasq DHCP server supports static address assignments and multiple
22networks. It automatically
Simon Kelley3be34542004-09-11 19:12:13 +010023sends a sensible default set of DHCP options, and can be configured to
Simon Kelleyf2621c72007-04-29 19:47:21 +010024send any desired set of DHCP options, including vendor-encapsulated
Simon Kelley1b7ecd12007-02-05 14:57:57 +000025options. It includes a secure, read-only,
Simon Kelley34d0a362013-01-02 11:40:56 +000026TFTP server to allow net/PXE boot of DHCP hosts and also supports BOOTP. The PXE support is full featured, and includes a proxy mode which supplies PXE information to clients whilst DHCP address allocation is done by another server.
Simon Kelley9e4abcb2004-01-22 19:47:41 +000027.PP
Simon Kelley81925ab2013-04-10 11:43:58 +010028The dnsmasq DHCPv6 server provides the same set of features as the
29DHCPv4 server, and in addition, it includes router advertisements and
30a neat feature which allows nameing for clients which use DHCPv4 and
Simon Kelley834f36f2013-04-17 13:52:49 +010031stateless autoconfiguration only for IPv6 configuration. There is support for doing address allocation (both DHCPv6 and RA) from subnets which are dynamically delegated via DHCPv6 prefix delegation.
Simon Kelley34d0a362013-01-02 11:40:56 +000032.PP
Josh Soref730c6742017-02-06 16:14:04 +000033Dnsmasq is coded with small embedded systems in mind. It aims for the smallest possible memory footprint compatible with the supported functions, and allows unneeded functions to be omitted from the compiled binary.
Simon Kelley9e4abcb2004-01-22 19:47:41 +000034.SH OPTIONS
35Note that in general missing parameters are allowed and switch off
Simon Kelley832af0b2007-01-21 20:01:28 +000036functions, for instance "--pid-file" disables writing a PID file. On
Simon Kelley33820b72004-04-03 21:10:00 +010037BSD, unless the GNU getopt library is linked, the long form of the
38options does not work on the command line; it is still recognised in
39the configuration file.
Simon Kelley9e4abcb2004-01-22 19:47:41 +000040.TP
Simon Kelley7622fc02009-06-04 20:32:05 +010041.B --test
42Read and syntax check configuration file(s). Exit with code 0 if all
43is OK, or a non-zero code otherwise. Do not start up dnsmasq.
44.TP
Simon Kelley09217a12016-05-03 17:04:35 +010045.B \-w, --help
46Display all command-line options.
47.B --help dhcp
48will display known DHCPv4 configuration options, and
49.B --help dhcp6
50will display DHCPv6 options.
51.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +000052.B \-h, --no-hosts
53Don't read the hostnames in /etc/hosts.
54.TP
55.B \-H, --addn-hosts=<file>
56Additional hosts file. Read the specified file as well as /etc/hosts. If -h is given, read
Simon Kelleyfd9fa482004-10-21 20:24:00 +010057only the specified file. This option may be repeated for more than one
Simon Kelley7622fc02009-06-04 20:32:05 +010058additional hosts file. If a directory is given, then read all the files contained in that directory.
Simon Kelley9e4abcb2004-01-22 19:47:41 +000059.TP
Simon Kelley3d04f462015-01-31 21:59:13 +000060.B --hostsdir=<path>
61Read all the hosts files contained in the directory. New or changed files
62are read automatically. See --dhcp-hostsdir for details.
63.TP
Simon Kelley832af0b2007-01-21 20:01:28 +000064.B \-E, --expand-hosts
65Add the domain to simple names (without a period) in /etc/hosts
Simon Kelley1f15b812009-10-13 17:49:32 +010066in the same way as for DHCP-derived names. Note that this does not
67apply to domain names in cnames, PTR records, TXT records etc.
Simon Kelley832af0b2007-01-21 20:01:28 +000068.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +000069.B \-T, --local-ttl=<time>
Simon Kelley832e47b2016-02-24 21:24:45 +000070When replying with information from /etc/hosts or configuration or the DHCP leases
Simon Kelley9e4abcb2004-01-22 19:47:41 +000071file dnsmasq by default sets the time-to-live field to zero, meaning
Simon Kelleyc72daea2012-01-05 21:33:27 +000072that the requester should not itself cache the information. This is
Simon Kelley9e4abcb2004-01-22 19:47:41 +000073the correct thing to do in almost all situations. This option allows a
74time-to-live (in seconds) to be given for these replies. This will
75reduce the load on the server at the expense of clients using stale
76data under some circumstances.
77.TP
Simon Kelley832e47b2016-02-24 21:24:45 +000078.B --dhcp-ttl=<time>
79As for --local-ttl, but affects only replies with information from DHCP leases. If both are given, --dhcp-ttl applies for DHCP information, and --local-ttl for others. Setting this to zero eliminates the effect of --local-ttl for DHCP.
80.TP
Simon Kelley824af852008-02-12 20:43:05 +000081.B --neg-ttl=<time>
82Negative replies from upstream servers normally contain time-to-live
83information in SOA records which dnsmasq uses for caching. If the
84replies from upstream servers omit this information, dnsmasq does not
85cache the reply. This option gives a default value for time-to-live
86(in seconds) which dnsmasq uses to cache negative replies even in
87the absence of an SOA record.
88.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +010089.B --max-ttl=<time>
90Set a maximum TTL value that will be handed out to clients. The specified
91maximum TTL will be given to clients instead of the true TTL value if it is
92lower. The true TTL value is however kept in the cache to avoid flooding
93the upstream DNS servers.
94.TP
Simon Kelley1d860412012-09-20 20:48:04 +010095.B --max-cache-ttl=<time>
96Set a maximum TTL value for entries in the cache.
97.TP
RinSatsuki28de3872015-01-10 15:22:21 +000098.B --min-cache-ttl=<time>
99Extend short TTL values to the time given when caching them. Note that
100artificially extending TTL values is in general a bad idea, do not do it
101unless you have a good reason, and understand what you are doing.
102Dnsmasq limits the value of this option to one hour, unless recompiled.
103.TP
Simon Kelley333b2ce2013-01-07 21:46:03 +0000104.B --auth-ttl=<time>
105Set the TTL value returned in answers from the authoritative server.
106.TP
Simon Kelley3be34542004-09-11 19:12:13 +0100107.B \-k, --keep-in-foreground
108Do not go into the background at startup but otherwise run as
Simon Kelley3d8df262005-08-29 12:19:27 +0100109normal. This is intended for use when dnsmasq is run under daemontools
110or launchd.
Simon Kelley3be34542004-09-11 19:12:13 +0100111.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000112.B \-d, --no-daemon
113Debug mode: don't fork to the background, don't write a pid file,
114don't change user id, generate a complete cache dump on receipt on
Simon Kelley3be34542004-09-11 19:12:13 +0100115SIGUSR1, log to stderr as well as syslog, don't fork new processes
Simon Kelley83b21982012-11-12 21:07:44 +0000116to handle TCP queries. Note that this option is for use in debugging
117only, to stop dnsmasq daemonising in production, use
118.B -k.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000119.TP
120.B \-q, --log-queries
Simon Kelley25cf5e32015-01-09 15:53:03 +0000121Log the results of DNS queries handled by dnsmasq. Enable a full cache dump on receipt of SIGUSR1. If the argument "extra" is supplied, ie
122.B --log-queries=extra
123then the log has extra information at the start of each line.
124This consists of a serial number which ties together the log lines associated with an individual query, and the IP address of the requestor.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000125.TP
Simon Kelley849a8352006-06-09 21:02:31 +0100126.B \-8, --log-facility=<facility>
127Set the facility to which dnsmasq will send syslog entries, this
Simon Kelleyf2621c72007-04-29 19:47:21 +0100128defaults to DAEMON, and to LOCAL0 when debug mode is in operation. If
Simon Kelley9e038942008-05-30 20:06:34 +0100129the facility given contains at least one '/' character, it is taken to
Simon Kelleyf2621c72007-04-29 19:47:21 +0100130be a filename, and dnsmasq logs to the given file, instead of
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100131syslog. If the facility is '-' then dnsmasq logs to stderr.
132(Errors whilst reading configuration will still go to syslog,
Simon Kelleyf2621c72007-04-29 19:47:21 +0100133but all output from a successful startup, and all output whilst
Simon Kelley5aabfc72007-08-29 11:24:47 +0100134running, will go exclusively to the file.) When logging to a file,
135dnsmasq will close and reopen the file when it receives SIGUSR2. This
136allows the log file to be rotated without stopping dnsmasq.
Simon Kelleyf2621c72007-04-29 19:47:21 +0100137.TP
138.B --log-async[=<lines>]
139Enable asynchronous logging and optionally set the limit on the
140number of lines
141which will be queued by dnsmasq when writing to the syslog is slow.
142Dnsmasq can log asynchronously: this
143allows it to continue functioning without being blocked by syslog, and
144allows syslog to use dnsmasq for DNS queries without risking deadlock.
145If the queue of log-lines becomes full, dnsmasq will log the
146overflow, and the number of messages lost. The default queue length is
1475, a sane value would be 5-25, and a maximum limit of 100 is imposed.
Simon Kelley849a8352006-06-09 21:02:31 +0100148.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000149.B \-x, --pid-file=<path>
150Specify an alternate path for dnsmasq to record its process-id in. Normally /var/run/dnsmasq.pid.
151.TP
152.B \-u, --user=<username>
153Specify the userid to which dnsmasq will change after startup. Dnsmasq must normally be started as root, but it will drop root
Simon Kelleyb8187c82005-11-26 21:46:27 +0000154privileges after startup by changing id to another user. Normally this user is "nobody" but that
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000155can be over-ridden with this switch.
156.TP
157.B \-g, --group=<groupname>
158Specify the group which dnsmasq will run
159as. The defaults to "dip", if available, to facilitate access to
160/etc/ppp/resolv.conf which is not normally world readable.
161.TP
162.B \-v, --version
163Print the version number.
164.TP
165.B \-p, --port=<port>
Simon Kelley824af852008-02-12 20:43:05 +0000166Listen on <port> instead of the standard DNS port (53). Setting this
167to zero completely disables DNS function, leaving only DHCP and/or TFTP.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000168.TP
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100169.B \-P, --edns-packet-max=<size>
170Specify the largest EDNS.0 UDP packet which is supported by the DNS
Simon Kelley316e2732010-01-22 20:16:09 +0000171forwarder. Defaults to 4096, which is the RFC5625-recommended size.
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100172.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000173.B \-Q, --query-port=<query_port>
Simon Kelley1a6bca82008-07-11 11:11:42 +0100174Send outbound DNS queries from, and listen for their replies on, the
175specific UDP port <query_port> instead of using random ports. NOTE
176that using this option will make dnsmasq less secure against DNS
177spoofing attacks but it may be faster and use less resources. Setting this option
178to zero makes dnsmasq use a single port allocated to it by the
179OS: this was the default behaviour in versions prior to 2.43.
180.TP
181.B --min-port=<port>
182Do not use ports less than that given as source for outbound DNS
183queries. Dnsmasq picks random ports as source for outbound queries:
184when this option is given, the ports used will always to larger
Simon Kelleybaf553d2018-01-29 22:49:27 +0000185than that specified. Useful for systems behind firewalls. If not specified,
186defaults to 1024.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000187.TP
Hans Dedecker926332a2016-01-23 10:48:12 +0000188.B --max-port=<port>
189Use ports lower than that given as source for outbound DNS queries.
190Dnsmasq picks random ports as source for outbound queries:
191when this option is given, the ports used will always be lower
192than that specified. Useful for systems behind firewalls.
193.TP
194
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000195.B \-i, --interface=<interface name>
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100196Listen only on the specified interface(s). Dnsmasq automatically adds
197the loopback (local) interface to the list of interfaces to use when
198the
199.B \--interface
200option is used. If no
201.B \--interface
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000202or
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100203.B \--listen-address
204options are given dnsmasq listens on all available interfaces except any
205given in
206.B \--except-interface
Petr Menšíkad59f272017-03-17 17:22:19 +0000207options. On Linux, when
208.B \--bind-interfaces
Simon Kelley8a911cc2004-03-16 18:35:52 +0000209or
Petr Menšíkad59f272017-03-17 17:22:19 +0000210.B \--bind-dynamic
211are in effect, IP alias interface labels (eg "eth1:0") are checked, rather than
212interface names. In the degenerate case when an interface has one address, this amounts to the same thing but when an interface has multiple addresses it
213allows control over which of those addresses are accepted.
214The same effect is achievable in default mode by using
215.B \--listen-address.
216A simple wildcard, consisting of a trailing '*',
217can be used in
Simon Kelley49333cb2013-03-15 20:30:51 +0000218.B \--interface
219and
220.B \--except-interface
221options.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000222.TP
223.B \-I, --except-interface=<interface name>
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100224Do not listen on the specified interface. Note that the order of
225.B \--listen-address
226.B --interface
227and
228.B --except-interface
229options does not matter and that
230.B --except-interface
Petr Menšíkad59f272017-03-17 17:22:19 +0000231options always override the others. The comments about interface labels for
232.B --listen-address
233apply here.
Simon Kelley34d0a362013-01-02 11:40:56 +0000234.TP
235.B --auth-server=<domain>,<interface>|<ip-address>
Simon Kelley81925ab2013-04-10 11:43:58 +0100236Enable DNS authoritative mode for queries arriving at an interface or address. Note that the interface or address
Simon Kelley34d0a362013-01-02 11:40:56 +0000237need not be mentioned in
238.B --interface
239or
240.B --listen-address
241configuration, indeed
242.B --auth-server
Josh Soref730c6742017-02-06 16:14:04 +0000243will override these and provide a different DNS service on the
Simon Kelleyf25e6c62013-11-17 12:23:42 +0000244specified interface. The <domain> is the "glue record". It should
Ville Skyttäfaaf3062018-01-14 17:32:52 +0000245resolve in the global DNS to an A and/or AAAA record which points to
Simon Kelleyf25e6c62013-11-17 12:23:42 +0000246the address dnsmasq is listening on. When an interface is specified,
247it may be qualified with "/4" or "/6" to specify only the IPv4 or IPv6
248addresses associated with the interface.
Simon Kelleyc8a80482014-03-05 14:29:54 +0000249.TP
250.B --local-service
251Accept DNS queries only from hosts whose address is on a local subnet,
252ie a subnet for which an interface exists on the server. This option
Kristjan Onu907efeb2016-07-10 22:37:57 +0100253only has effect if there are no --interface --except-interface,
Simon Kelleyc8a80482014-03-05 14:29:54 +0000254--listen-address or --auth-server options. It is intended to be set as
255a default on installation, to allow unconfigured installations to be
256useful but also safe from being used for DNS amplification attacks.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000257.TP
Simon Kelley3d8df262005-08-29 12:19:27 +0100258.B \-2, --no-dhcp-interface=<interface name>
Simon Kelley832af0b2007-01-21 20:01:28 +0000259Do not provide DHCP or TFTP on the specified interface, but do provide DNS service.
Simon Kelley3d8df262005-08-29 12:19:27 +0100260.TP
Simon Kelley44a2a312004-03-10 20:04:35 +0000261.B \-a, --listen-address=<ipaddr>
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100262Listen on the given IP address(es). Both
263.B \--interface
264and
265.B \--listen-address
266options may be given, in which case the set of both interfaces and
267addresses is used. Note that if no
268.B \--interface
269option is given, but
270.B \--listen-address
271is, dnsmasq will not automatically listen on the loopback
272interface. To achieve this, its IP address, 127.0.0.1, must be
273explicitly given as a
274.B \--listen-address
275option.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000276.TP
Simon Kelley44a2a312004-03-10 20:04:35 +0000277.B \-z, --bind-interfaces
278On systems which support it, dnsmasq binds the wildcard address,
279even when it is listening on only some interfaces. It then discards
280requests that it shouldn't reply to. This has the advantage of
281working even when interfaces come and go and change address. This
282option forces dnsmasq to really bind only the interfaces it is
283listening on. About the only time when this is useful is when
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000284running another nameserver (or another instance of dnsmasq) on the
Simon Kelley309331f2006-04-22 15:05:01 +0100285same machine. Setting this option also enables multiple instances of
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000286dnsmasq which provide DHCP service to run in the same machine.
287.TP
Simon Kelley54dd3932012-06-20 11:23:38 +0100288.B --bind-dynamic
289Enable a network mode which is a hybrid between
290.B --bind-interfaces
Simon Kelleya2ce6fc2012-08-06 20:05:48 +0100291and the default. Dnsmasq binds the address of individual interfaces,
Simon Kelley54dd3932012-06-20 11:23:38 +0100292allowing multiple dnsmasq instances, but if new interfaces or
293addresses appear, it automatically listens on those (subject to any
294access-control configuration). This makes dynamically created
295interfaces work in the same way as the default. Implementing this
Simon Kelleya2ce6fc2012-08-06 20:05:48 +0100296option requires non-standard networking APIs and it is only available
Simon Kelley05ff1ed2012-06-26 16:58:12 +0100297under Linux. On other platforms it falls-back to --bind-interfaces mode.
Simon Kelley54dd3932012-06-20 11:23:38 +0100298.TP
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000299.B \-y, --localise-queries
Simon Kelleyd42d4702017-02-02 16:52:06 +0000300Return answers to DNS queries from /etc/hosts and --interface-name which depend on the interface over which the query was
301received. If a name has more than one address associated with
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000302it, and at least one of those addresses is on the same subnet as the
303interface to which the query was sent, then return only the
304address(es) on that subnet. This allows for a server to have multiple
305addresses in /etc/hosts corresponding to each of its interfaces, and
306hosts will get the correct address based on which network they are
307attached to. Currently this facility is limited to IPv4.
Simon Kelley44a2a312004-03-10 20:04:35 +0000308.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000309.B \-b, --bogus-priv
310Bogus private reverse lookups. All reverse lookups for private IP ranges (ie 192.168.x.x, etc)
Simon Kelleyfeba5c12004-07-27 20:28:58 +0100311which are not found in /etc/hosts or the DHCP leases file are answered
Simon Kelleyfca008d2017-02-19 18:50:41 +0000312with "no such domain" rather than being forwarded upstream. The
313set of prefixes affected is the list given in RFC6303, for IPv4 and IPv6.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000314.TP
Simon Kelley73a08a22009-02-05 20:28:08 +0000315.B \-V, --alias=[<old-ip>]|[<start-ip>-<end-ip>],<new-ip>[,<mask>]
Simon Kelley1cff1662004-03-12 08:12:58 +0000316Modify IPv4 addresses returned from upstream nameservers; old-ip is
317replaced by new-ip. If the optional mask is given then any address
318which matches the masked old-ip will be re-written. So, for instance
319.B --alias=1.2.3.0,6.7.8.0,255.255.255.0
320will map 1.2.3.56 to 6.7.8.56 and 1.2.3.67 to 6.7.8.67. This is what
Simon Kelley73a08a22009-02-05 20:28:08 +0000321Cisco PIX routers call "DNS doctoring". If the old IP is given as
322range, then only addresses in the range, rather than a whole subnet,
323are re-written. So
324.B --alias=192.168.0.10-192.168.0.40,10.0.0.0,255.255.255.0
325maps 192.168.0.10->192.168.0.40 to 10.0.0.10->10.0.0.40
Simon Kelley1cff1662004-03-12 08:12:58 +0000326.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000327.B \-B, --bogus-nxdomain=<ipaddr>
328Transform replies which contain the IP address given into "No such
329domain" replies. This is intended to counteract a devious move made by
Simon Kelleyb8187c82005-11-26 21:46:27 +0000330Verisign in September 2003 when they started returning the address of
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000331an advertising web page in response to queries for unregistered names,
332instead of the correct NXDOMAIN response. This option tells dnsmasq to
333fake the correct response when it sees this behaviour. As at Sept 2003
Simon Kelleyb8187c82005-11-26 21:46:27 +0000334the IP address being returned by Verisign is 64.94.110.11
Glen Huang32fc6db2014-12-27 15:28:12 +0000335.TP
Simon Kelley09217a12016-05-03 17:04:35 +0100336.B --ignore-address=<ipaddr>
Glen Huang32fc6db2014-12-27 15:28:12 +0000337Ignore replies to A-record queries which include the specified address.
338No error is generated, dnsmasq simply continues to listen for another reply.
339This is useful to defeat blocking strategies which rely on quickly supplying a
340forged answer to a DNS request for certain domain, before the correct answer can arrive.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000341.TP
342.B \-f, --filterwin2k
343Later versions of windows make periodic DNS requests which don't get sensible answers from
344the public DNS and can cause problems by triggering dial-on-demand links. This flag turns on an option
345to filter such requests. The requests blocked are for records of types SOA and SRV, and type ANY where the
346requested name has underscores, to catch LDAP requests.
347.TP
348.B \-r, --resolv-file=<file>
349Read the IP addresses of the upstream nameservers from <file>, instead of
350/etc/resolv.conf. For the format of this file see
Simon Kelley7de060b2011-08-26 17:24:52 +0100351.BR resolv.conf (5).
352The only lines relevant to dnsmasq are nameserver ones. Dnsmasq can
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000353be told to poll more than one resolv.conf file, the first file name specified
354overrides the default, subsequent ones add to the list. This is only
355allowed when polling; the file with the currently latest modification
356time is the one used.
357.TP
358.B \-R, --no-resolv
359Don't read /etc/resolv.conf. Get upstream servers only from the command
Simon Kelleyb49644f2004-01-30 21:36:24 +0000360line or the dnsmasq configuration file.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000361.TP
Simon Kelleyad094272012-08-10 17:10:54 +0100362.B \-1, --enable-dbus[=<service-name>]
Simon Kelley3d8df262005-08-29 12:19:27 +0100363Allow dnsmasq configuration to be updated via DBus method calls. The
364configuration which can be changed is upstream DNS servers (and
Simon Kelleyb8187c82005-11-26 21:46:27 +0000365corresponding domains) and cache clear. Requires that dnsmasq has
Simon Kelleyad094272012-08-10 17:10:54 +0100366been built with DBus support. If the service name is given, dnsmasq
367provides service at that name, rather than the default which is
368.B uk.org.thekelleys.dnsmasq
Simon Kelley3d8df262005-08-29 12:19:27 +0100369.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000370.B \-o, --strict-order
371By default, dnsmasq will send queries to any of the upstream servers
Simon Kelley824af852008-02-12 20:43:05 +0000372it knows about and tries to favour servers that are known to
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000373be up. Setting this flag forces dnsmasq to try each query with each
374server strictly in the order they appear in /etc/resolv.conf
375.TP
Simon Kelley824af852008-02-12 20:43:05 +0000376.B --all-servers
377By default, when dnsmasq has more than one upstream server available,
378it will send queries to just one server. Setting this flag forces
379dnsmasq to send all queries to all available servers. The reply from
Simon Kelleyc72daea2012-01-05 21:33:27 +0000380the server which answers first will be returned to the original requester.
Simon Kelley824af852008-02-12 20:43:05 +0000381.TP
Simon Kelleyb5ea1cc2014-07-29 16:34:14 +0100382.B --dns-loop-detect
383Enable code to detect DNS forwarding loops; ie the situation where a query sent to one
384of the upstream server eventually returns as a new query to the dnsmasq instance. The
385process works by generating TXT queries of the form <hex>.test and sending them to
386each upstream server. The hex is a UID which encodes the instance of dnsmasq sending the query
387and the upstream server to which it was sent. If the query returns to the server which sent it, then
388the upstream server through which it was sent is disabled and this event is logged. Each time the
389set of upstream servers changes, the test is re-run on all of them, including ones which
390were previously disabled.
391.TP
Simon Kelley824af852008-02-12 20:43:05 +0000392.B --stop-dns-rebind
393Reject (and log) addresses from upstream nameservers which are in the
394private IP ranges. This blocks an attack where a browser behind a
395firewall is used to probe machines on the local network.
396.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100397.B --rebind-localhost-ok
398Exempt 127.0.0.0/8 from rebinding checks. This address range is
399returned by realtime black hole servers, so blocking it may disable
400these services.
401.TP
402.B --rebind-domain-ok=[<domain>]|[[/<domain>/[<domain>/]
403Do not detect and block dns-rebind on queries to these domains. The
404argument may be either a single domain, or multiple domains surrounded
405by '/', like the --server syntax, eg.
406.B --rebind-domain-ok=/domain1/domain2/domain3/
407.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000408.B \-n, --no-poll
409Don't poll /etc/resolv.conf for changes.
410.TP
Simon Kelley16972692006-10-16 20:04:18 +0100411.B --clear-on-reload
Simon Kelleyd9fb0be2013-07-25 21:47:17 +0100412Whenever /etc/resolv.conf is re-read or the upstream servers are set
413via DBus, clear the DNS cache.
Simon Kelley16972692006-10-16 20:04:18 +0100414This is useful when new nameservers may have different
415data than that held in cache.
416.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000417.B \-D, --domain-needed
Simon Kelley7de060b2011-08-26 17:24:52 +0100418Tells dnsmasq to never forward A or AAAA queries for plain names, without dots
Simon Kelley3d8df262005-08-29 12:19:27 +0100419or domain parts, to upstream nameservers. If the name is not known
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000420from /etc/hosts or DHCP then a "not found" answer is returned.
421.TP
Simon Kelley824af852008-02-12 20:43:05 +0000422.B \-S, --local, --server=[/[<domain>]/[domain/]][<ipaddr>[#<port>][@<source-ip>|<interface>[#<port>]]
Simon Kelley5aabfc72007-08-29 11:24:47 +0100423Specify IP address of upstream servers directly. Setting this flag does
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000424not suppress reading of /etc/resolv.conf, use -R to do that. If one or
425more
426optional domains are given, that server is used only for those domains
427and they are queried only using the specified server. This is
428intended for private nameservers: if you have a nameserver on your
429network which deals with names of the form
430xxx.internal.thekelleys.org.uk at 192.168.1.1 then giving the flag
Simon Kelleyb8187c82005-11-26 21:46:27 +0000431.B -S /internal.thekelleys.org.uk/192.168.1.1
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000432will send all queries for
433internal machines to that nameserver, everything else will go to the
Simon Kelley92be34a2016-01-16 18:39:54 +0000434servers in /etc/resolv.conf. DNSSEC validation is turned off for such
435private nameservers, UNLESS a
436.B --trust-anchor
437is specified for the domain in question. An empty domain specification,
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000438.B //
439has the special meaning of "unqualified names only" ie names without any
440dots in them. A non-standard port may be specified as
441part of the IP
442address using a # character.
443More than one -S flag is allowed, with
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100444repeated domain or ipaddr parts as required.
445
Josh Soref730c6742017-02-06 16:14:04 +0000446More specific domains take precedence over less specific domains, so:
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100447.B --server=/google.com/1.2.3.4
448.B --server=/www.google.com/2.3.4.5
449will send queries for *.google.com to 1.2.3.4, except *www.google.com,
450which will go to 2.3.4.5
451
452The special server address '#' means, "use the standard servers", so
453.B --server=/google.com/1.2.3.4
454.B --server=/www.google.com/#
455will send queries for *.google.com to 1.2.3.4, except *www.google.com which will
456be forwarded as usual.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000457
458Also permitted is a -S
459flag which gives a domain but no IP address; this tells dnsmasq that
460a domain is local and it may answer queries from /etc/hosts or DHCP
461but should never forward queries on that domain to any upstream
462servers.
463.B local
464is a synonym for
465.B server
466to make configuration files clearer in this case.
467
Ville Skyttäfaaf3062018-01-14 17:32:52 +0000468IPv6 addresses may include an %interface scope-id, eg
Simon Kelley7de060b2011-08-26 17:24:52 +0100469fe80::202:a412:4512:7bbf%eth0.
470
Kristian Evensen4e7694d2017-03-22 21:32:50 +0000471The optional string after the @ character tells dnsmasq how to set the source of
472the queries to this nameserver. It can either be an ip-address, an interface
473name or both. The ip-address should belong to the machine on which dnsmasq is
474running, otherwise this server line will be logged and then ignored. If an
475interface name is given, then queries to the server will be forced via that
476interface; if an ip-address is given then the source address of the queries will
477be set to that address; and if both are given then a combination of ip-address
478and interface name will be used to steer requests to the server.
Simon Kelley824af852008-02-12 20:43:05 +0000479The query-port flag is ignored for any servers which have a
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000480source address specified but the port may be specified directly as
Simon Kelley824af852008-02-12 20:43:05 +0000481part of the source address. Forcing queries to an interface is not
482implemented on all platforms supported by dnsmasq.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000483.TP
Simon Kelleyde73a492014-02-17 21:43:27 +0000484.B --rev-server=<ip-address>/<prefix-len>,<ipaddr>[#<port>][@<source-ip>|<interface>[#<port>]]
485This is functionally the same as
486.B --server,
487but provides some syntactic sugar to make specifying address-to-name queries easier. For example
488.B --rev-server=1.2.3.0/24,192.168.0.1
489is exactly equivalent to
490.B --server=/3.2.1.in-addr.arpa/192.168.0.1
491.TP
Peter Wu3c0c1112016-08-28 20:53:09 +0100492.B \-A, --address=/<domain>[/<domain>...]/[<ipaddr>]
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000493Specify an IP address to return for any host in the given domains.
494Queries in the domains are never forwarded and always replied to
495with the specified IP address which may be IPv4 or IPv6. To give
Peter Wu3c0c1112016-08-28 20:53:09 +0100496both IPv4 and IPv6 addresses for a domain, use repeated \fB-A\fP flags.
497To include multiple IP addresses for a single query, use
498\fB--addn-hosts=<path>\fP instead.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000499Note that /etc/hosts and DHCP leases override this for individual
500names. A common use of this is to redirect the entire doubleclick.net
Simon Kelleya2226412004-05-13 20:27:08 +0100501domain to some friendly local web server to avoid banner ads. The
Peter Wu3c0c1112016-08-28 20:53:09 +0100502domain specification works in the same was as for \fB--server\fP, with
503the additional facility that \fB/#/\fP matches any domain. Thus
504\fB--address=/#/1.2.3.4\fP will always return \fB1.2.3.4\fP for any
505query not answered from \fB/etc/hosts\fP or DHCP and not sent to an
506upstream nameserver by a more specific \fB--server\fP directive. As for
507\fB--server\fP, one or more domains with no address returns a
508no-such-domain answer, so \fB--address=/example.com/\fP is equivalent to
509\fB--server=/example.com/\fP and returns NXDOMAIN for example.com and
510all its subdomains.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000511.TP
Peter Wu3c0c1112016-08-28 20:53:09 +0100512.B --ipset=/<domain>[/<domain>...]/<ipset>[,<ipset>...]
513Places the resolved IP addresses of queries for one or more domains in
514the specified Netfilter IP set. If multiple setnames are given, then the
515addresses are placed in each of them, subject to the limitations of an
516IP set (IPv4 addresses cannot be stored in an IPv6 IP set and vice
517versa). Domains and subdomains are matched in the same way as
518\fB--address\fP.
519These IP sets must already exist. See
520.BR ipset (8)
521for more details.
Jason A. Donenfeld13d86c72013-02-22 18:20:53 +0000522.TP
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000523.B \-m, --mx-host=<mx name>[[,<hostname>],<preference>]
Simon Kelleyde379512004-06-22 20:23:33 +0100524Return an MX record named <mx name> pointing to the given hostname (if
525given), or
526the host specified in the --mx-target switch
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000527or, if that switch is not given, the host on which dnsmasq
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000528is running. The default is useful for directing mail from systems on a LAN
529to a central server. The preference value is optional, and defaults to
5301 if not given. More than one MX record may be given for a host.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000531.TP
532.B \-t, --mx-target=<hostname>
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000533Specify the default target for the MX record returned by dnsmasq. See
534--mx-host. If --mx-target is given, but not --mx-host, then dnsmasq
535returns a MX record containing the MX target for MX queries on the
536hostname of the machine on which dnsmasq is running.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000537.TP
538.B \-e, --selfmx
539Return an MX record pointing to itself for each local
540machine. Local machines are those in /etc/hosts or with DHCP leases.
541.TP
542.B \-L, --localmx
543Return an MX record pointing to the host given by mx-target (or the
544machine on which dnsmasq is running) for each
545local machine. Local machines are those in /etc/hosts or with DHCP
546leases.
547.TP
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000548.B \-W, --srv-host=<_service>.<_prot>.[<domain>],[<target>[,<port>[,<priority>[,<weight>]]]]
549Return a SRV DNS record. See RFC2782 for details. If not supplied, the
550domain defaults to that given by
551.B --domain.
552The default for the target domain is empty, and the default for port
553is one and the defaults for
554weight and priority are zero. Be careful if transposing data from BIND
555zone files: the port, weight and priority numbers are in a different
556order. More than one SRV record for a given service/domain is allowed,
Simon Kelley3d8df262005-08-29 12:19:27 +0100557all that match are returned.
Simon Kelleyf6b7dc42005-01-23 12:06:08 +0000558.TP
Simon Kelleydf3d54f2016-02-24 21:03:38 +0000559.B --host-record=<name>[,<name>....],[<IPv4-address>],[<IPv6-address>][,<TTL>]
Simon Kelleye759d422012-03-16 13:18:57 +0000560Add A, AAAA and PTR records to the DNS. This adds one or more names to
561the DNS with associated IPv4 (A) and IPv6 (AAAA) records. A name may
562appear in more than one
563.B host-record
564and therefore be assigned more than one address. Only the first
565address creates a PTR record linking the address to the name. This is
566the same rule as is used reading hosts-files.
567.B host-record
568options are considered to be read before host-files, so a name
569appearing there inhibits PTR-record creation if it appears in
Simon Kelleye46164e2012-04-16 16:39:38 +0100570hosts-file also. Unlike hosts-files, names are not expanded, even when
Simon Kelleye759d422012-03-16 13:18:57 +0000571.B expand-hosts
572is in effect. Short and long names may appear in the same
Simon Kelleye46164e2012-04-16 16:39:38 +0100573.B host-record,
574eg.
575.B --host-record=laptop,laptop.thekelleys.org,192.168.0.1,1234::100
Simon Kelleydf3d54f2016-02-24 21:03:38 +0000576
577If the time-to-live is given, it overrides the default, which is zero
578or the value of --local-ttl. The value is a positive integer and gives
579the time-to-live in seconds.
Simon Kelleye759d422012-03-16 13:18:57 +0000580.TP
Simon Kelley0a852542005-03-23 20:28:59 +0000581.B \-Y, --txt-record=<name>[[,<text>],<text>]
582Return a TXT DNS record. The value of TXT record is a set of strings,
Simon Kelley28866e92011-02-14 20:19:14 +0000583so any number may be included, delimited by commas; use quotes to put
584commas into a string. Note that the maximum length of a single string
585is 255 characters, longer strings are split into 255 character chunks.
Simon Kelley0a852542005-03-23 20:28:59 +0000586.TP
Simon Kelley832af0b2007-01-21 20:01:28 +0000587.B --ptr-record=<name>[,<target>]
588Return a PTR DNS record.
589.TP
Simon Kelley1a6bca82008-07-11 11:11:42 +0100590.B --naptr-record=<name>,<order>,<preference>,<flags>,<service>,<regexp>[,<replacement>]
591Return an NAPTR DNS record, as specified in RFC3403.
592.TP
Simon Kelleya1d973f2016-12-22 22:09:50 +0000593.B --cname=<cname>,[<cname>,]<target>[,<TTL>]
Simon Kelley9009d742008-11-14 20:04:27 +0000594Return a CNAME record which indicates that <cname> is really
595<target>. There are significant limitations on the target; it must be a
596DNS name which is known to dnsmasq from /etc/hosts (or additional
Simon Kelleyd56a6042013-10-11 14:39:03 +0100597hosts files), from DHCP, from --interface-name or from another
Simon Kelley611ebc52012-07-16 16:23:46 +0100598.B --cname.
599If the target does not satisfy this
Simon Kelley9009d742008-11-14 20:04:27 +0000600criteria, the whole cname is ignored. The cname must be unique, but it
Ville Skyttäfaaf3062018-01-14 17:32:52 +0000601is permissible to have more than one cname pointing to the same target. Indeed
Simon Kelleya1d973f2016-12-22 22:09:50 +0000602it's possible to declare multiple cnames to a target in a single line, like so:
603.B --cname=cname1,cname2,target
Simon Kelleydf3d54f2016-02-24 21:03:38 +0000604
605If the time-to-live is given, it overrides the default, which is zero
606or the value of -local-ttl. The value is a positive integer and gives
607the time-to-live in seconds.
Simon Kelley9009d742008-11-14 20:04:27 +0000608.TP
Simon Kelley9f7f3b12012-05-28 21:39:57 +0100609.B --dns-rr=<name>,<RR-number>,[<hex data>]
610Return an arbitrary DNS Resource Record. The number is the type of the
611record (which is always in the C_IN class). The value of the record is
Simon Kelleya2ce6fc2012-08-06 20:05:48 +0100612given by the hex data, which may be of the form 01:23:45 or 01 23 45 or
Simon Kelley9f7f3b12012-05-28 21:39:57 +0100613012345 or any mixture of these.
614.TP
Simon Kelleyf7029f52013-11-21 15:09:09 +0000615.B --interface-name=<name>,<interface>[/4|/6]
Simon Kelleyd42d4702017-02-02 16:52:06 +0000616Return DNS records associating the name with the address(es) of
Simon Kelleyf7029f52013-11-21 15:09:09 +0000617the given interface. This flag specifies an A or AAAA record for the given
Simon Kelleyf2621c72007-04-29 19:47:21 +0100618name in the same way as an /etc/hosts line, except that the address is
Simon Kelleyf7029f52013-11-21 15:09:09 +0000619not constant, but taken from the given interface. The interface may be
620followed by "/4" or "/6" to specify that only IPv4 or IPv6 addresses
621of the interface should be used. If the interface is
Simon Kelley9e038942008-05-30 20:06:34 +0100622down, not configured or non-existent, an empty record is returned. The
Simon Kelleyf2621c72007-04-29 19:47:21 +0100623matching PTR record is also created, mapping the interface address to
624the name. More than one name may be associated with an interface
625address by repeating the flag; in that case the first instance is used
Simon Kelleyd42d4702017-02-02 16:52:06 +0000626for the reverse address-to-name mapping. Note that a name used in
627--interface-name may not appear in /etc/hosts.
Simon Kelleyf2621c72007-04-29 19:47:21 +0100628.TP
Simon Kelley6b2b5642018-03-10 18:12:04 +0000629.B --synth-domain=<domain>,<address range>[,<prefix>[*]]
Simon Kelley2bb73af2013-04-24 17:38:19 +0100630Create artificial A/AAAA and PTR records for an address range. The
Simon Kelley6b2b5642018-03-10 18:12:04 +0000631records either seqential numbers or the address, with periods (or colons for IPv6) replaced with dashes.
Simon Kelley2bb73af2013-04-24 17:38:19 +0100632
Simon Kelley6b2b5642018-03-10 18:12:04 +0000633An examples should make this clearer. First sequential numbers.
634.B --synth-domain=thekelleys.org.uk,192.168.0.50,192.168.0.70,internal-*
635results in the name internal-0.thekelleys.org.uk. returning 192.168.0.50, internal-1.thekelleys.org.uk returning 192.168.0.51 and so on. (note the *) The same principle applies to IPv6 addresses (where the numbers may be very large). Reverse lookups from address to name behave as expected.
636
637Second,
638.B --synth-domain=thekelleys.org.uk,192.168.0.0/24,internal- (no *)
Simon Kelley48fd1c42013-04-25 09:49:38 +0100639will result in a query for internal-192-168-0-56.thekelleys.org.uk returning
640192.168.0.56 and a reverse query vice versa. The same applies to IPv6,
641but IPv6 addresses may start with '::'
642but DNS labels may not start with '-' so in this case if no prefix is
643configured a zero is added in front of the label. ::1 becomes 0--1.
Simon Kelley2bb73af2013-04-24 17:38:19 +0100644
Simon Kelley6d950992016-08-11 23:38:54 +0100645V4 mapped IPv6 addresses, which have a representation like ::ffff:1.2.3.4 are handled specially, and become like 0--ffff-1-2-3-4
646
Simon Kelley2bb73af2013-04-24 17:38:19 +0100647The address range can be of the form
Simon Kelley6b2b5642018-03-10 18:12:04 +0000648<ip address>,<ip address> or <ip address>/<netmask> in both forms of the option.
Simon Kelley2bb73af2013-04-24 17:38:19 +0100649.TP
Simon Kelley9e4cf472016-02-17 20:26:32 +0000650.B --add-mac[=base64|text]
Simon Kelley28866e92011-02-14 20:19:14 +0000651Add the MAC address of the requestor to DNS queries which are
652forwarded upstream. This may be used to DNS filtering by the upstream
653server. The MAC address can only be added if the requestor is on the same
654subnet as the dnsmasq server. Note that the mechanism used to achieve this (an EDNS0 option)
655is not yet standardised, so this should be considered
656experimental. Also note that exposing MAC addresses in this way may
Simon Kelleyed4c0762013-10-08 20:46:34 +0100657have security and privacy implications. The warning about caching
Simon Kelley1e505122016-01-25 21:29:23 +0000658given for --add-subnet applies to --add-mac too. An alternative encoding of the
Simon Kelley9e4cf472016-02-17 20:26:32 +0000659MAC, as base64, is enabled by adding the "base64" parameter and a human-readable encoding of hex-and-colons is enabled by added the "text" parameter.
Simon Kelley1e505122016-01-25 21:29:23 +0000660.TP
661.B --add-cpe-id=<string>
Ville Skyttäfaaf3062018-01-14 17:32:52 +0000662Add an arbitrary identifying string to o DNS queries which are
Simon Kelley1e505122016-01-25 21:29:23 +0000663forwarded upstream.
Simon Kelleyed4c0762013-10-08 20:46:34 +0100664.TP
Ed Bardsleya7369be2015-08-05 21:17:18 +0100665.B --add-subnet[[=[<IPv4 address>/]<IPv4 prefix length>][,[<IPv6 address>/]<IPv6 prefix length>]]
666Add a subnet address to the DNS queries which are forwarded
667upstream. If an address is specified in the flag, it will be used,
668otherwise, the address of the requestor will be used. The amount of
669the address forwarded depends on the prefix length parameter: 32 (128
670for IPv6) forwards the whole address, zero forwards none of it but
671still marks the request so that no upstream nameserver will add client
672address information either. The default is zero for both IPv4 and
673IPv6. Note that upstream nameservers may be configured to return
674different results based on this information, but the dnsmasq cache
675does not take account. If a dnsmasq instance is configured such that
676different results may be encountered, caching should be disabled.
677
678For example,
679.B --add-subnet=24,96
680will add the /24 and /96 subnets of the requestor for IPv4 and IPv6 requestors, respectively.
681.B --add-subnet=1.2.3.4/24
682will add 1.2.3.0/24 for IPv4 requestors and ::/0 for IPv6 requestors.
683.B --add-subnet=1.2.3.4/24,1.2.3.4/24
684will add 1.2.3.0/24 for both IPv4 and IPv6 requestors.
685
Simon Kelley28866e92011-02-14 20:19:14 +0000686.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000687.B \-c, --cache-size=<cachesize>
688Set the size of dnsmasq's cache. The default is 150 names. Setting the cache size to zero disables caching.
689.TP
690.B \-N, --no-negcache
691Disable negative caching. Negative caching allows dnsmasq to remember
692"no such domain" answers from upstream nameservers and answer
Simon Kelley5aabfc72007-08-29 11:24:47 +0100693identical queries without forwarding them again.
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000694.TP
Simon Kelley16972692006-10-16 20:04:18 +0100695.B \-0, --dns-forward-max=<queries>
696Set the maximum number of concurrent DNS queries. The default value is
697150, which should be fine for most setups. The only known situation
698where this needs to be increased is when using web-server log file
699resolvers, which can generate large numbers of concurrent queries.
Simon Kelley208b65c2006-08-05 21:41:37 +0100700.TP
Simon Kelley70b4a812014-01-27 22:38:48 +0000701.B --dnssec
702Validate DNS replies and cache DNSSEC data. When forwarding DNS queries, dnsmasq requests the
703DNSSEC records needed to validate the replies. The replies are validated and the result returned as
704the Authenticated Data bit in the DNS packet. In addition the DNSSEC records are stored in the cache, making
705validation by clients more efficient. Note that validation by clients is the most secure DNSSEC mode, but for
706clients unable to do validation, use of the AD bit set by dnsmasq is useful, provided that the network between
707the dnsmasq server and the client is trusted. Dnsmasq must be compiled with HAVE_DNSSEC enabled, and DNSSEC
708trust anchors provided, see
Simon Kelleyee415862014-02-11 11:07:22 +0000709.B --trust-anchor.
Simon Kelleyd588ab52014-03-02 14:30:05 +0000710Because the DNSSEC validation process uses the cache, it is not
711permitted to reduce the cache size below the default when DNSSEC is
712enabled. The nameservers upstream of dnsmasq must be DNSSEC-capable,
713ie capable of returning DNSSEC records with data. If they are not,
714then dnsmasq will not be able to determine the trusted status of
Josh Soref730c6742017-02-06 16:14:04 +0000715answers. In the default mode, this means that all replies will be
Simon Kelleyd588ab52014-03-02 14:30:05 +0000716marked as untrusted. If
717.B --dnssec-check-unsigned
718is set and the upstream servers don't support DNSSEC, then DNS service will be entirely broken.
Simon Kelley70b4a812014-01-27 22:38:48 +0000719.TP
Simon Kelleyee415862014-02-11 11:07:22 +0000720.B --trust-anchor=[<class>],<domain>,<key-tag>,<algorithm>,<digest-type>,<digest>
721Provide DS records to act a trust anchors for DNSSEC
Simon Kelley3b0cb342017-10-27 22:53:52 +0100722validation. Typically these will be the DS record(s) for Key Signing
723key(s) (KSK) of the root zone,
Simon Kelleyee415862014-02-11 11:07:22 +0000724but trust anchors for limited domains are also possible. The current
Ján Sáreník85016322015-07-05 21:23:27 +0100725root-zone trust anchors may be downloaded from https://data.iana.org/root-anchors/root-anchors.xml
Simon Kelley70b4a812014-01-27 22:38:48 +0000726.TP
Simon Kelley00a5b5d2014-02-28 18:10:55 +0000727.B --dnssec-check-unsigned
728As a default, dnsmasq does not check that unsigned DNS replies are
729legitimate: they are assumed to be valid and passed on (without the
730"authentic data" bit set, of course). This does not protect against an
731attacker forging unsigned replies for signed DNS zones, but it is
732fast. If this flag is set, dnsmasq will check the zones of unsigned
733replies, to ensure that unsigned replies are allowed in those
Simon Kelleyd588ab52014-03-02 14:30:05 +0000734zones. The cost of this is more upstream queries and slower
735performance. See also the warning about upstream servers in the
736section on
737.B --dnssec
Simon Kelley00a5b5d2014-02-28 18:10:55 +0000738.TP
Simon Kelleye98bd522014-03-28 20:41:23 +0000739.B --dnssec-no-timecheck
740DNSSEC signatures are only valid for specified time windows, and should be rejected outside those windows. This generates an
741interesting chicken-and-egg problem for machines which don't have a hardware real time clock. For these machines to determine the correct
742time typically requires use of NTP and therefore DNS, but validating DNS requires that the correct time is already known. Setting this flag
Simon Kelley3c973ad2018-01-14 21:05:37 +0000743removes the time-window checks (but not other DNSSEC validation.) only until the dnsmasq process receives SIGINT. The intention is
Simon Kelleye98bd522014-03-28 20:41:23 +0000744that dnsmasq should be started with this flag when the platform determines that reliable time is not currently available. As soon as
Simon Kelley3c973ad2018-01-14 21:05:37 +0000745reliable time is established, a SIGINT should be sent to dnsmasq, which enables time checking, and purges the cache of DNS records
Ville Skyttäfaaf3062018-01-14 17:32:52 +0000746which have not been thoroughly checked.
Simon Kelley3c973ad2018-01-14 21:05:37 +0000747
748Earlier versions of dnsmasq overloaded SIGHUP (which re-reads much configuration) to also enable time validation.
749
750If dnsmasq is run in debug mode (-d flag) then SIGINT retains its usual meaning of terminating the dnsmasq process.
Simon Kelleye98bd522014-03-28 20:41:23 +0000751.TP
Simon Kelleyf6e62e22015-03-01 18:17:54 +0000752.B --dnssec-timestamp=<path>
753Enables an alternative way of checking the validity of the system time for DNSSEC (see --dnssec-no-timecheck). In this case, the
754system time is considered to be valid once it becomes later than the timestamp on the specified file. The file is created and
755its timestamp set automatically by dnsmasq. The file must be stored on a persistent filesystem, so that it and its mtime are carried
Simon Kelley360f2512015-03-07 18:28:06 +0000756over system restarts. The timestamp file is created after dnsmasq has dropped root, so it must be in a location writable by the
757unprivileged user that dnsmasq runs as.
Simon Kelleyf6e62e22015-03-01 18:17:54 +0000758.TP
Simon Kelley28866e92011-02-14 20:19:14 +0000759.B --proxy-dnssec
Simon Kelley70b4a812014-01-27 22:38:48 +0000760Copy the DNSSEC Authenticated Data bit from upstream servers to downstream clients and cache it. This is an
761alternative to having dnsmasq validate DNSSEC, but it depends on the security of the network between
762dnsmasq and the upstream servers, and the trustworthiness of the upstream servers.
763.TP
764.B --dnssec-debug
765Set debugging mode for the DNSSEC validation, set the Checking Disabled bit on upstream queries,
Simon Kelleyee415862014-02-11 11:07:22 +0000766and don't convert replies which do not validate to responses with
767a return code of SERVFAIL. Note that
768setting this may affect DNS behaviour in bad ways, it is not an
769extra-logging flag and should not be set in production.
Simon Kelley28866e92011-02-14 20:19:14 +0000770.TP
Mathias Kresin094bfae2016-07-24 14:15:22 +0100771.B --auth-zone=<domain>[,<subnet>[/<prefix length>][,<subnet>[/<prefix length>].....][,exclude:<subnet>[/<prefix length>]].....]
Simon Kelley34d0a362013-01-02 11:40:56 +0000772Define a DNS zone for which dnsmasq acts as authoritative server. Locally defined DNS records which are in the domain
Simon Kelleyc50f25a2013-11-21 11:29:27 +0000773will be served. If subnet(s) are given, A and AAAA records must be in one of the
774specified subnets.
775
776As alternative to directly specifying the subnets, it's possible to
Simon Kelley376d48c2013-11-13 13:04:30 +0000777give the name of an interface, in which case the subnets implied by
778that interface's configured addresses and netmask/prefix-length are
779used; this is useful when using constructed DHCP ranges as the actual
780address is dynamic and not known when configuring dnsmasq. The
781interface addresses may be confined to only IPv6 addresses using
782<interface>/6 or to only IPv4 using <interface>/4. This is useful when
783an interface has dynamically determined global IPv6 addresses which should
784appear in the zone, but RFC1918 IPv4 addresses which should not.
785Interface-name and address-literal subnet specifications may be used
786freely in the same --auth-zone declaration.
787
Mathias Kresin094bfae2016-07-24 14:15:22 +0100788It's possible to exclude certain IP addresses from responses. It can be
789used, to make sure that answers contain only global routeable IP
790addresses (by excluding loopback, RFC1918 and ULA addresses).
791
Simon Kelley376d48c2013-11-13 13:04:30 +0000792The subnet(s) are also used to define in-addr.arpa and
Lutz Preßler1d7e0a32014-04-07 22:06:23 +0100793ip6.arpa domains which are served for reverse-DNS queries. If not
Simon Kelleybaa80ae2013-05-29 16:32:07 +0100794specified, the prefix length defaults to 24 for IPv4 and 64 for IPv6.
795For IPv4 subnets, the prefix length should be have the value 8, 16 or 24
796unless you are familiar with RFC 2317 and have arranged the
Simon Kelleyc50f25a2013-11-21 11:29:27 +0000797in-addr.arpa delegation accordingly. Note that if no subnets are
798specified, then no reverse queries are answered.
Simon Kelley333b2ce2013-01-07 21:46:03 +0000799.TP
800.B --auth-soa=<serial>[,<hostmaster>[,<refresh>[,<retry>[,<expiry>]]]]
801Specify fields in the SOA record associated with authoritative
802zones. Note that this is optional, all the values are set to sane defaults.
803.TP
804.B --auth-sec-servers=<domain>[,<domain>[,<domain>...]]
805Specify any secondary servers for a zone for which dnsmasq is
806authoritative. These servers must be configured to get zone data from
807dnsmasq by zone transfer, and answer queries for the same
Simon Kelley6f130de2013-04-15 14:47:14 +0100808authoritative zones as dnsmasq.
Simon Kelley333b2ce2013-01-07 21:46:03 +0000809.TP
810.B --auth-peer=<ip-address>[,<ip-address>[,<ip-address>...]]
811Specify the addresses of secondary servers which are allowed to
812initiate zone transfer (AXFR) requests for zones for which dnsmasq is
Simon Kelley6f130de2013-04-15 14:47:14 +0100813authoritative. If this option is not given, then AXFR requests will be
Simon Kelley333b2ce2013-01-07 21:46:03 +0000814accepted from any secondary.
815.TP
Simon Kelley7de060b2011-08-26 17:24:52 +0100816.B --conntrack
817Read the Linux connection track mark associated with incoming DNS
818queries and set the same mark value on upstream traffic used to answer
819those queries. This allows traffic generated by dnsmasq to be
820associated with the queries which cause it, useful for bandwidth
821accounting and firewalling. Dnsmasq must have conntrack support
822compiled in and the kernel must have conntrack support
823included and configured. This option cannot be combined with
824--query-port.
825.TP
Simon Kelleyfa794662016-03-03 20:33:54 +0000826.B \-F, --dhcp-range=[tag:<tag>[,tag:<tag>],][set:<tag>,]<start-addr>[,<end-addr>|<mode>][,<netmask>[,<broadcast>]][,<lease time>]
Simon Kelley1adadf52012-02-13 22:15:58 +0000827.TP
Simon Kelley83f28be2013-04-03 14:46:46 +0100828.B \-F, --dhcp-range=[tag:<tag>[,tag:<tag>],][set:<tag>,]<start-IPv6addr>[,<end-IPv6addr>|constructor:<interface>][,<mode>][,<prefix-len>][,<lease time>]
Simon Kelley1adadf52012-02-13 22:15:58 +0000829
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000830Enable the DHCP server. Addresses will be given out from the range
Simon Kelley44a2a312004-03-10 20:04:35 +0000831<start-addr> to <end-addr> and from statically defined addresses given
832in
833.B dhcp-host
834options. If the lease time is given, then leases
Simon Kelleyb8187c82005-11-26 21:46:27 +0000835will be given for that length of time. The lease time is in seconds,
Simon Kelley7622fc02009-06-04 20:32:05 +0100836or minutes (eg 45m) or hours (eg 1h) or "infinite". If not given,
837the default lease time is one hour. The
Simon Kelleyc8257542012-03-28 21:15:41 +0100838minimum lease time is two minutes. For IPv6 ranges, the lease time
839maybe "deprecated"; this sets the preferred lifetime sent in a DHCP
840lease or router advertisement to zero, which causes clients to use
841other addresses, if available, for new connections as a prelude to renumbering.
842
843This option may be repeated, with different addresses, to enable DHCP
Simon Kelley44a2a312004-03-10 20:04:35 +0000844service to more than one network. For directly connected networks (ie,
845networks on which the machine running dnsmasq has an interface) the
Simon Kelley7de060b2011-08-26 17:24:52 +0100846netmask is optional: dnsmasq will determine it from the interface
847configuration. For networks which receive DHCP service via a relay
848agent, dnsmasq cannot determine the netmask itself, so it should be
849specified, otherwise dnsmasq will have to guess, based on the class (A, B or
850C) of the network address. The broadcast address is
Simon Kelley7622fc02009-06-04 20:32:05 +0100851always optional. It is always
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100852allowed to have more than one dhcp-range in a single subnet.
853
Simon Kelley1adadf52012-02-13 22:15:58 +0000854For IPv6, the parameters are slightly different: instead of netmask
Vladislav Grishenko4c82efc2013-12-03 16:05:30 +0000855and broadcast address, there is an optional prefix length which must
856be equal to or larger then the prefix length on the local interface. If not
Simon Kelley1adadf52012-02-13 22:15:58 +0000857given, this defaults to 64. Unlike the IPv4 case, the prefix length is not
Josh Soref730c6742017-02-06 16:14:04 +0000858automatically derived from the interface configuration. The minimum
Simon Kelley1adadf52012-02-13 22:15:58 +0000859size of the prefix length is 64.
860
Simon Kelley34d0a362013-01-02 11:40:56 +0000861IPv6 (only) supports another type of range. In this, the start address and optional end address contain only the network part (ie ::1) and they are followed by
862.B constructor:<interface>.
863This forms a template which describes how to create ranges, based on the addresses assigned to the interface. For instance
864
Simon Kelley83f28be2013-04-03 14:46:46 +0100865.B --dhcp-range=::1,::400,constructor:eth0
Simon Kelley34d0a362013-01-02 11:40:56 +0000866
Simon Kelley861c8912013-09-25 15:30:30 +0100867will look for addresses on
Simon Kelley429805d2013-05-31 13:47:26 +0100868eth0 and then create a range from <network>::1 to <network>::400. If
869the interface is assigned more than one network, then the
870corresponding ranges will be automatically created, and then
871deprecated and finally removed again as the address is deprecated and
872then deleted. The interface name may have a final "*" wildcard. Note
Simon Kelley861c8912013-09-25 15:30:30 +0100873that just any address on eth0 will not do: it must not be an
874autoconfigured or privacy address, or be deprecated.
Simon Kelley34d0a362013-01-02 11:40:56 +0000875
Vladislav Grishenkoe4cdbbf2013-08-19 16:20:31 +0100876If a dhcp-range is only being used for stateless DHCP and/or SLAAC,
877then the address can be simply ::
878
879.B --dhcp-range=::,constructor:eth0
880
Vladislav Grishenkoe4cdbbf2013-08-19 16:20:31 +0100881
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100882The optional
883.B set:<tag>
884sets an alphanumeric label which marks this network so that
Simon Kelley0a852542005-03-23 20:28:59 +0000885dhcp options may be specified on a per-network basis.
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100886When it is prefixed with 'tag:' instead, then its meaning changes from setting
Simon Kelleyc5ad4e72012-02-24 16:06:20 +0000887a tag to matching it. Only one tag may be set, but more than one tag
888may be matched.
889
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100890The optional <mode> keyword may be
Simon Kelley33820b72004-04-03 21:10:00 +0100891.B static
892which tells dnsmasq to enable DHCP for the network specified, but not
Simon Kelley7622fc02009-06-04 20:32:05 +0100893to dynamically allocate IP addresses: only hosts which have static
Simon Kelley33820b72004-04-03 21:10:00 +0100894addresses given via
895.B dhcp-host
Simon Kelley52002052012-10-26 11:39:02 +0100896or from /etc/ethers will be served. A static-only subnet with address
897all zeros may be used as a "catch-all" address to enable replies to all
898Information-request packets on a subnet which is provided with
899stateless DHCPv6, ie
Moritz Warninge62e9b62014-03-20 15:32:22 +0000900.B --dhcp-range=::,static
Simon Kelleyc5ad4e72012-02-24 16:06:20 +0000901
Simon Kelleye46164e2012-04-16 16:39:38 +0100902For IPv4, the <mode> may be
Simon Kelley7622fc02009-06-04 20:32:05 +0100903.B proxy
904in which case dnsmasq will provide proxy-DHCP on the specified
905subnet. (See
906.B pxe-prompt
907and
908.B pxe-service
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100909for details.)
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100910
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100911For IPv6, the mode may be some combination of
Neil Jerram4918bd52015-06-10 22:23:20 +0100912.B ra-only, slaac, ra-names, ra-stateless, ra-advrouter, off-link.
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100913
Simon Kelleyc5ad4e72012-02-24 16:06:20 +0000914.B ra-only
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100915tells dnsmasq to offer Router Advertisement only on this subnet,
916and not DHCP.
917
918.B slaac
919tells dnsmasq to offer Router Advertisement on this subnet and to set
920the A bit in the router advertisement, so that the client will use
921SLAAC addresses. When used with a DHCP range or static DHCP address
922this results in the client having both a DHCP-assigned and a SLAAC
923address.
924
925.B ra-stateless
926sends router advertisements with the O and A bits set, and provides a
927stateless DHCP service. The client will use a SLAAC address, and use
928DHCP for other configuration information.
929
Simon Kelley7023e382012-03-09 12:05:49 +0000930.B ra-names
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100931enables a mode
Simon Kelley7023e382012-03-09 12:05:49 +0000932which gives DNS names to dual-stack hosts which do SLAAC for
Simon Kelley884a6df2012-03-20 16:20:22 +0000933IPv6. Dnsmasq uses the host's IPv4 lease to derive the name, network
Simon Kelley7023e382012-03-09 12:05:49 +0000934segment and MAC address and assumes that the host will also have an
Simon Kelleye46164e2012-04-16 16:39:38 +0100935IPv6 address calculated using the SLAAC algorithm, on the same network
Simon Kelley884a6df2012-03-20 16:20:22 +0000936segment. The address is pinged, and if a reply is received, an AAAA
937record is added to the DNS for this IPv6
Simon Kelley7023e382012-03-09 12:05:49 +0000938address. Note that this is only happens for directly-connected
Simon Kelley884a6df2012-03-20 16:20:22 +0000939networks, (not one doing DHCP via a relay) and it will not work
940if a host is using privacy extensions.
Simon Kelleye8ca69e2012-03-26 21:23:26 +0100941.B ra-names
942can be combined with
943.B ra-stateless
944and
945.B slaac.
Simon Kelleyc5ad4e72012-02-24 16:06:20 +0000946
Simon Kelley7ea3d3f2014-04-25 22:04:05 +0100947.B ra-advrouter
948enables a mode where router address(es) rather than prefix(es) are included in the advertisements.
949This is described in RFC-3775 section 7.2 and is used in mobile IPv6. In this mode the interval option
950is also included, as described in RFC-3775 section 7.3.
951
Neil Jerram4918bd52015-06-10 22:23:20 +0100952.B off-link
953tells dnsmasq to advertise the prefix without the on-link (aka L) bit set.
954
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000955.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100956.B \-G, --dhcp-host=[<hwaddr>][,id:<client_id>|*][,set:<tag>][,<ipaddr>][,<hostname>][,<lease_time>][,ignore]
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000957Specify per host parameters for the DHCP server. This allows a machine
958with a particular hardware address to be always allocated the same
959hostname, IP address and lease time. A hostname specified like this
960overrides any supplied by the DHCP client on the machine. It is also
Simon Kelleyc72daea2012-01-05 21:33:27 +0000961allowable to omit the hardware address and include the hostname, in
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000962which case the IP address and lease times will apply to any machine
963claiming that name. For example
964.B --dhcp-host=00:20:e0:3b:13:af,wap,infinite
965tells dnsmasq to give
Simon Kelleycdeda282006-03-16 20:16:06 +0000966the machine with hardware address 00:20:e0:3b:13:af the name wap, and
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000967an infinite DHCP lease.
968.B --dhcp-host=lap,192.168.0.199
969tells
970dnsmasq to always allocate the machine lap the IP address
Simon Kelley8ef5ada2010-06-03 19:42:45 +0100971192.168.0.199.
972
973Addresses allocated like this are not constrained to be
974in the range given by the --dhcp-range option, but they must be in
975the same subnet as some valid dhcp-range. For
976subnets which don't need a pool of dynamically allocated addresses,
977use the "static" keyword in the dhcp-range declaration.
978
Simon Kelley89500e32013-09-20 16:29:20 +0100979It is allowed to use client identifiers (called client
Simon Kelley864913c2017-02-28 18:07:18 +0000980DUID in IPv6-land) rather than
Simon Kelley9e4abcb2004-01-22 19:47:41 +0000981hardware addresses to identify hosts by prefixing with 'id:'. Thus:
982.B --dhcp-host=id:01:02:03:04,.....
983refers to the host with client identifier 01:02:03:04. It is also
984allowed to specify the client ID as text, like this:
Simon Kelleya84fa1d2004-04-23 22:21:21 +0100985.B --dhcp-host=id:clientidastext,.....
Simon Kelley9009d742008-11-14 20:04:27 +0000986
Simon Kelley1adadf52012-02-13 22:15:58 +0000987A single
988.B dhcp-host
989may contain an IPv4 address or an IPv6 address, or both. IPv6 addresses must be bracketed by square brackets thus:
990.B --dhcp-host=laptop,[1234::56]
Simon Kelley30393102013-01-17 16:34:16 +0000991IPv6 addresses may contain only the host-identifier part:
992.B --dhcp-host=laptop,[::56]
Simon Kelley6f130de2013-04-15 14:47:14 +0100993in which case they act as wildcards in constructed dhcp ranges, with
Simon Kelley30393102013-01-17 16:34:16 +0000994the appropriate network part inserted.
Simon Kelley89500e32013-09-20 16:29:20 +0100995Note that in IPv6 DHCP, the hardware address may not be
996available, though it normally is for direct-connected clients, or
997clients using DHCP relays which support RFC 6939.
Simon Kelley1adadf52012-02-13 22:15:58 +0000998
Simon Kelley89500e32013-09-20 16:29:20 +0100999
1000For DHCPv4, the special option id:* means "ignore any client-id
Simon Kelleya84fa1d2004-04-23 22:21:21 +01001001and use MAC addresses only." This is useful when a client presents a client-id sometimes
1002but not others.
Simon Kelley9009d742008-11-14 20:04:27 +00001003
Simon Kelley1ab84e22004-01-29 16:48:35 +00001004If a name appears in /etc/hosts, the associated address can be
1005allocated to a DHCP lease, but only if a
1006.B --dhcp-host
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001007option specifying the name also exists. Only one hostname can be
1008given in a
1009.B dhcp-host
1010option, but aliases are possible by using CNAMEs. (See
1011.B --cname
1012).
1013
1014The special keyword "ignore"
Simon Kelley33820b72004-04-03 21:10:00 +01001015tells dnsmasq to never offer a DHCP lease to a machine. The machine
1016can be specified by hardware address, client ID or hostname, for
1017instance
1018.B --dhcp-host=00:20:e0:3b:13:af,ignore
1019This is
1020useful when there is another DHCP server on the network which should
Simon Kelley9009d742008-11-14 20:04:27 +00001021be used by some machines.
1022
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001023The set:<tag> construct sets the tag
Simon Kelley9009d742008-11-14 20:04:27 +00001024whenever this dhcp-host directive is in use. This can be used to
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001025selectively send DHCP options just for this host. More than one tag
1026can be set in a dhcp-host directive (but not in other places where
1027"set:<tag>" is allowed). When a host matches any
Simon Kelley5aabfc72007-08-29 11:24:47 +01001028dhcp-host directive (or one implied by /etc/ethers) then the special
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001029tag "known" is set. This allows dnsmasq to be configured to
Simon Kelley5aabfc72007-08-29 11:24:47 +01001030ignore requests from unknown machines using
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001031.B --dhcp-ignore=tag:!known
Simon Kelleyb2a9c572017-04-30 18:21:31 +01001032If the host matches only a dhcp-host directive which cannot
1033be used because it specifies an address on different subnet, the tag "known-othernet" is set.
Simon Kelley0a852542005-03-23 20:28:59 +00001034Ethernet addresses (but not client-ids) may have
1035wildcard bytes, so for example
1036.B --dhcp-host=00:20:e0:3b:13:*,ignore
Simon Kelleycdeda282006-03-16 20:16:06 +00001037will cause dnsmasq to ignore a range of hardware addresses. Note that
Simon Kelley0a852542005-03-23 20:28:59 +00001038the "*" will need to be escaped or quoted on a command line, but not
Simon Kelley9009d742008-11-14 20:04:27 +00001039in the configuration file.
1040
1041Hardware addresses normally match any
Simon Kelleycdeda282006-03-16 20:16:06 +00001042network (ARP) type, but it is possible to restrict them to a single
1043ARP type by preceding them with the ARP-type (in HEX) and "-". so
1044.B --dhcp-host=06-00:20:e0:3b:13:af,1.2.3.4
1045will only match a
1046Token-Ring hardware address, since the ARP-address type for token ring
Simon Kelley9009d742008-11-14 20:04:27 +00001047is 6.
1048
Simon Kelley1adadf52012-02-13 22:15:58 +00001049As a special case, in DHCPv4, it is possible to include more than one
Simon Kelley73a08a22009-02-05 20:28:08 +00001050hardware address. eg:
1051.B --dhcp-host=11:22:33:44:55:66,12:34:56:78:90:12,192.168.0.2
1052This allows an IP address to be associated with
Simon Kelley9009d742008-11-14 20:04:27 +00001053multiple hardware addresses, and gives dnsmasq permission to abandon a
1054DHCP lease to one of the hardware addresses when another one asks for
1055a lease. Beware that this is a dangerous thing to do, it will only
1056work reliably if only one of the hardware addresses is active at any
Simon Kelley73a08a22009-02-05 20:28:08 +00001057time and there is no way for dnsmasq to enforce this. It is, for instance,
1058useful to allocate a stable IP address to a laptop which
Simon Kelley9009d742008-11-14 20:04:27 +00001059has both wired and wireless interfaces.
Simon Kelley5aabfc72007-08-29 11:24:47 +01001060.TP
Simon Kelley28866e92011-02-14 20:19:14 +00001061.B --dhcp-hostsfile=<path>
1062Read DHCP host information from the specified file. If a directory
1063is given, then read all the files contained in that directory. The file contains
Simon Kelley5aabfc72007-08-29 11:24:47 +01001064information about one host per line. The format of a line is the same
1065as text to the right of '=' in --dhcp-host. The advantage of storing DHCP host information
1066in this file is that it can be changed without re-starting dnsmasq:
1067the file will be re-read when dnsmasq receives SIGHUP.
Simon Kelley824af852008-02-12 20:43:05 +00001068.TP
Simon Kelley28866e92011-02-14 20:19:14 +00001069.B --dhcp-optsfile=<path>
1070Read DHCP option information from the specified file. If a directory
1071is given, then read all the files contained in that directory. The advantage of
Simon Kelley824af852008-02-12 20:43:05 +00001072using this option is the same as for --dhcp-hostsfile: the
Simon Kelley1f15b812009-10-13 17:49:32 +01001073dhcp-optsfile will be re-read when dnsmasq receives SIGHUP. Note that
1074it is possible to encode the information in a
Simon Kelley5874f3e2016-07-10 22:12:08 +01001075.B --dhcp-boot
1076flag as DHCP options, using the options names bootfile-name,
1077server-ip-address and tftp-server. This allows these to be included
1078in a dhcp-optsfile.
Simon Kelley5f4dc5c2015-01-20 20:51:02 +00001079.TP
1080.B --dhcp-hostsdir=<path>
Simon Kelley3d04f462015-01-31 21:59:13 +00001081This is equivalent to dhcp-hostsfile, except for the following. The path MUST be a
Simon Kelley5f4dc5c2015-01-20 20:51:02 +00001082directory, and not an individual file. Changed or new files within
1083the directory are read automatically, without the need to send SIGHUP.
Ville Skyttä773af302018-02-16 21:47:55 +00001084If a file is deleted or changed after it has been read by dnsmasq, then the
Josh Soref730c6742017-02-06 16:14:04 +00001085host record it contained will remain until dnsmasq receives a SIGHUP, or
Simon Kelley5f4dc5c2015-01-20 20:51:02 +00001086is restarted; ie host records are only added dynamically.
Simon Kelleyefb8b552015-02-07 22:36:34 +00001087.TP
Simon Kelley3d04f462015-01-31 21:59:13 +00001088.B --dhcp-optsdir=<path>
1089This is equivalent to dhcp-optsfile, with the differences noted for --dhcp-hostsdir.
Simon Kelley44a2a312004-03-10 20:04:35 +00001090.TP
1091.B \-Z, --read-ethers
1092Read /etc/ethers for information about hosts for the DHCP server. The
1093format of /etc/ethers is a hardware address, followed by either a
1094hostname or dotted-quad IP address. When read by dnsmasq these lines
1095have exactly the same effect as
1096.B --dhcp-host
Simon Kelley5aabfc72007-08-29 11:24:47 +01001097options containing the same information. /etc/ethers is re-read when
Simon Kelley1adadf52012-02-13 22:15:58 +00001098dnsmasq receives SIGHUP. IPv6 addresses are NOT read from /etc/ethers.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001099.TP
Simon Kelley1adadf52012-02-13 22:15:58 +00001100.B \-O, --dhcp-option=[tag:<tag>,[tag:<tag>,]][encap:<opt>,][vi-encap:<enterprise>,][vendor:[<vendor-class>],][<opt>|option:<opt-name>|option6:<opt>|option6:<opt-name>],[<value>[,<value>]]
Simon Kelleyb8187c82005-11-26 21:46:27 +00001101Specify different or extra options to DHCP clients. By default,
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001102dnsmasq sends some standard options to DHCP clients, the netmask and
1103broadcast address are set to the same as the host running dnsmasq, and
1104the DNS server and default route are set to the address of the machine
Simon Kelley1adadf52012-02-13 22:15:58 +00001105running dnsmasq. (Equivalent rules apply for IPv6.) If the domain name option has been set, that is sent.
Simon Kelleyf2621c72007-04-29 19:47:21 +01001106This configuration allows these defaults to be overridden,
1107or other options specified. The option, to be sent may be given as a
1108decimal number or as "option:<option-name>" The option numbers are
1109specified in RFC2132 and subsequent RFCs. The set of option-names
1110known by dnsmasq can be discovered by running "dnsmasq --help dhcp".
1111For example, to set the default route option to
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001112192.168.4.4, do
Simon Kelleyf2621c72007-04-29 19:47:21 +01001113.B --dhcp-option=3,192.168.4.4
1114or
1115.B --dhcp-option = option:router, 192.168.4.4
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001116and to set the time-server address to 192.168.0.4, do
Simon Kelleyf2621c72007-04-29 19:47:21 +01001117.B --dhcp-option = 42,192.168.0.4
1118or
1119.B --dhcp-option = option:ntp-server, 192.168.0.4
Simon Kelleyc3a04082014-01-11 22:18:19 +00001120The special address 0.0.0.0 is taken to mean "the address of the
1121machine running dnsmasq".
1122
1123Data types allowed are comma separated
1124dotted-quad IPv4 addresses, []-wrapped IPv6 addresses, a decimal number, colon-separated hex digits
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001125and a text string. If the optional tags are given then
1126this option is only sent when all the tags are matched.
Simon Kelley91dccd02005-03-31 17:48:32 +01001127
Simon Kelleycdeda282006-03-16 20:16:06 +00001128Special processing is done on a text argument for option 119, to
Simon Kelley832af0b2007-01-21 20:01:28 +00001129conform with RFC 3397. Text or dotted-quad IP addresses as arguments
1130to option 120 are handled as per RFC 3361. Dotted-quad IP addresses
1131which are followed by a slash and then a netmask size are encoded as
1132described in RFC 3442.
Simon Kelleycdeda282006-03-16 20:16:06 +00001133
Simon Kelley1adadf52012-02-13 22:15:58 +00001134IPv6 options are specified using the
1135.B option6:
1136keyword, followed by the option number or option name. The IPv6 option
1137name space is disjoint from the IPv4 option name space. IPv6 addresses
1138in options must be bracketed with square brackets, eg.
1139.B --dhcp-option=option6:ntp-server,[1234::56]
Simon Kelleyc3a04082014-01-11 22:18:19 +00001140For IPv6, [::] means "the global address of
1141the machine running dnsmasq", whilst [fd00::] is replaced with the
1142ULA, if it exists, and [fe80::] with the link-local address.
Simon Kelley1adadf52012-02-13 22:15:58 +00001143
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001144Be careful: no checking is done that the correct type of data for the
Simon Kelley26128d22004-11-14 16:43:54 +00001145option number is sent, it is quite possible to
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001146persuade dnsmasq to generate illegal DHCP packets with injudicious use
Simon Kelley91dccd02005-03-31 17:48:32 +01001147of this flag. When the value is a decimal number, dnsmasq must determine how
1148large the data item is. It does this by examining the option number and/or the
Simon Kelleyb8187c82005-11-26 21:46:27 +00001149value, but can be overridden by appending a single letter flag as follows:
Simon Kelley91dccd02005-03-31 17:48:32 +01001150b = one byte, s = two bytes, i = four bytes. This is mainly useful with
Simon Kelley3d8df262005-08-29 12:19:27 +01001151encapsulated vendor class options (see below) where dnsmasq cannot
1152determine data size from the option number. Option data which
1153consists solely of periods and digits will be interpreted by dnsmasq
1154as an IP address, and inserted into an option as such. To force a
1155literal string, use quotes. For instance when using option 66 to send
1156a literal IP address as TFTP server name, it is necessary to do
1157.B --dhcp-option=66,"1.2.3.4"
Simon Kelley91dccd02005-03-31 17:48:32 +01001158
Simon Kelley1adadf52012-02-13 22:15:58 +00001159Encapsulated Vendor-class options may also be specified (IPv4 only) using
Simon Kelley91dccd02005-03-31 17:48:32 +01001160--dhcp-option: for instance
Simon Kelley1b7ecd12007-02-05 14:57:57 +00001161.B --dhcp-option=vendor:PXEClient,1,0.0.0.0
1162sends the encapsulated vendor
1163class-specific option "mftp-address=0.0.0.0" to any client whose
1164vendor-class matches "PXEClient". The vendor-class matching is
Simon Kelley6b010842007-02-12 20:32:07 +00001165substring based (see --dhcp-vendorclass for details). If a
1166vendor-class option (number 60) is sent by dnsmasq, then that is used
1167for selecting encapsulated options in preference to any sent by the
1168client. It is
Simon Kelley1b7ecd12007-02-05 14:57:57 +00001169possible to omit the vendorclass completely;
1170.B --dhcp-option=vendor:,1,0.0.0.0
Simon Kelley1adadf52012-02-13 22:15:58 +00001171in which case the encapsulated option is always sent.
Simon Kelley73a08a22009-02-05 20:28:08 +00001172
Simon Kelley1adadf52012-02-13 22:15:58 +00001173Options may be encapsulated (IPv4 only) within other options: for instance
Simon Kelley73a08a22009-02-05 20:28:08 +00001174.B --dhcp-option=encap:175, 190, "iscsi-client0"
1175will send option 175, within which is the option 190. If multiple
1176options are given which are encapsulated with the same option number
1177then they will be correctly combined into one encapsulated option.
1178encap: and vendor: are may not both be set in the same dhcp-option.
1179
Simon Kelley316e2732010-01-22 20:16:09 +00001180The final variant on encapsulated options is "Vendor-Identifying
1181Vendor Options" as specified by RFC3925. These are denoted like this:
1182.B --dhcp-option=vi-encap:2, 10, "text"
1183The number in the vi-encap: section is the IANA enterprise number
Simon Kelley1adadf52012-02-13 22:15:58 +00001184used to identify this option. This form of encapsulation is supported
1185in IPv6.
1186
Simon Kelley1b7ecd12007-02-05 14:57:57 +00001187The address 0.0.0.0 is not treated specially in
Simon Kelley73a08a22009-02-05 20:28:08 +00001188encapsulated options.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001189.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001190.B --dhcp-option-force=[tag:<tag>,[tag:<tag>,]][encap:<opt>,][vi-encap:<enterprise>,][vendor:[<vendor-class>],]<opt>,[<value>[,<value>]]
Simon Kelley6b010842007-02-12 20:32:07 +00001191This works in exactly the same way as
Simon Kelleyf2621c72007-04-29 19:47:21 +01001192.B --dhcp-option
1193except that the option will always be sent, even if the client does
Simon Kelley6b010842007-02-12 20:32:07 +00001194not ask for it in the parameter request list. This is sometimes
1195needed, for example when sending options to PXELinux.
1196.TP
Simon Kelley824af852008-02-12 20:43:05 +00001197.B --dhcp-no-override
Simon Kelley1adadf52012-02-13 22:15:58 +00001198(IPv4 only) Disable re-use of the DHCP servername and filename fields as extra
Simon Kelley824af852008-02-12 20:43:05 +00001199option space. If it can, dnsmasq moves the boot server and filename
1200information (from dhcp-boot) out of their dedicated fields into
1201DHCP options. This make extra space available in the DHCP packet for
1202options but can, rarely, confuse old or broken clients. This flag
1203forces "simple and safe" behaviour to avoid problems in such a case.
1204.TP
Simon Kelleyff7eea22013-09-04 18:01:38 +01001205.B --dhcp-relay=<local address>,<server address>[,<interface]
1206Configure dnsmasq to do DHCP relay. The local address is an address
1207allocated to an interface on the host running dnsmasq. All DHCP
1208requests arriving on that interface will we relayed to a remote DHCP
1209server at the server address. It is possible to relay from a single local
1210address to multiple remote servers by using multiple dhcp-relay
1211configs with the same local address and different server
1212addresses. A server address must be an IP literal address, not a
1213domain name. In the case of DHCPv6, the server address may be the
1214ALL_SERVERS multicast address, ff05::1:3. In this case the interface
1215must be given, not be wildcard, and is used to direct the multicast to the
1216correct interface to reach the DHCP server.
1217
1218Access control for DHCP clients has the same rules as for the DHCP
1219server, see --interface, --except-interface, etc. The optional
1220interface name in the dhcp-relay config has a different function: it
1221controls on which interface DHCP replies from the server will be
1222accepted. This is intended for configurations which have three
1223interfaces: one being relayed from, a second connecting the DHCP
1224server, and a third untrusted network, typically the wider
1225internet. It avoids the possibility of spoof replies arriving via this
1226third interface.
1227
1228It is allowed to have dnsmasq act as a DHCP server on one set of
1229interfaces and relay from a disjoint set of interfaces. Note that
1230whilst it is quite possible to write configurations which appear to
1231act as a server and a relay on the same interface, this is not
1232supported: the relay function will take precedence.
1233
1234Both DHCPv4 and DHCPv6 relay is supported. It's not possible to relay
1235DHCPv4 to a DHCPv6 server or vice-versa.
1236.TP
Simon Kelley1adadf52012-02-13 22:15:58 +00001237.B \-U, --dhcp-vendorclass=set:<tag>,[enterprise:<IANA-enterprise number>,]<vendor-class>
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001238Map from a vendor-class string to a tag. Most DHCP clients provide a
Simon Kelleya2226412004-05-13 20:27:08 +01001239"vendor class" which represents, in some sense, the type of host. This option
Simon Kelleyf2621c72007-04-29 19:47:21 +01001240maps vendor classes to tags, so that DHCP options may be selectively delivered
Simon Kelleya84fa1d2004-04-23 22:21:21 +01001241to different classes of hosts. For example
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001242.B dhcp-vendorclass=set:printers,Hewlett-Packard JetDirect
Simon Kelleya84fa1d2004-04-23 22:21:21 +01001243will allow options to be set only for HP printers like so:
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001244.B --dhcp-option=tag:printers,3,192.168.4.4
Simon Kelleya2226412004-05-13 20:27:08 +01001245The vendor-class string is
1246substring matched against the vendor-class supplied by the client, to
Simon Kelley1adadf52012-02-13 22:15:58 +00001247allow fuzzy matching. The set: prefix is optional but allowed for
1248consistency.
1249
1250Note that in IPv6 only, vendorclasses are namespaced with an
1251IANA-allocated enterprise number. This is given with enterprise:
1252keyword and specifies that only vendorclasses matching the specified
1253number should be searched.
Simon Kelleya2226412004-05-13 20:27:08 +01001254.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001255.B \-j, --dhcp-userclass=set:<tag>,<user-class>
1256Map from a user-class string to a tag (with substring
Simon Kelleya2226412004-05-13 20:27:08 +01001257matching, like vendor classes). Most DHCP clients provide a
1258"user class" which is configurable. This option
Simon Kelleyf2621c72007-04-29 19:47:21 +01001259maps user classes to tags, so that DHCP options may be selectively delivered
Simon Kelleya2226412004-05-13 20:27:08 +01001260to different classes of hosts. It is possible, for instance to use
1261this to set a different printer server for hosts in the class
1262"accounts" than for hosts in the class "engineering".
Simon Kelleya84fa1d2004-04-23 22:21:21 +01001263.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001264.B \-4, --dhcp-mac=set:<tag>,<MAC address>
Simon Kelley89500e32013-09-20 16:29:20 +01001265Map from a MAC address to a tag. The MAC address may include
Simon Kelleycdeda282006-03-16 20:16:06 +00001266wildcards. For example
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001267.B --dhcp-mac=set:3com,01:34:23:*:*:*
Simon Kelleycdeda282006-03-16 20:16:06 +00001268will set the tag "3com" for any host whose MAC address matches the pattern.
1269.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001270.B --dhcp-circuitid=set:<tag>,<circuit-id>, --dhcp-remoteid=set:<tag>,<remote-id>
1271Map from RFC3046 relay agent options to tags. This data may
Simon Kelleyf2621c72007-04-29 19:47:21 +01001272be provided by DHCP relay agents. The circuit-id or remote-id is
1273normally given as colon-separated hex, but is also allowed to be a
1274simple string. If an exact match is achieved between the circuit or
Simon Kelley1adadf52012-02-13 22:15:58 +00001275agent ID and one provided by a relay agent, the tag is set.
1276
1277.B dhcp-remoteid
1278(but not dhcp-circuitid) is supported in IPv6.
Simon Kelleyf2621c72007-04-29 19:47:21 +01001279.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001280.B --dhcp-subscrid=set:<tag>,<subscriber-id>
Simon Kelley1adadf52012-02-13 22:15:58 +00001281(IPv4 and IPv6) Map from RFC3993 subscriber-id relay agent options to tags.
Simon Kelley824af852008-02-12 20:43:05 +00001282.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001283.B --dhcp-proxy[=<ip addr>]......
Simon Kelley07933802012-02-14 20:55:25 +00001284(IPv4 only) A normal DHCP relay agent is only used to forward the initial parts of
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001285a DHCP interaction to the DHCP server. Once a client is configured, it
1286communicates directly with the server. This is undesirable if the
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001287relay agent is adding extra information to the DHCP packets, such as
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001288that used by
1289.B dhcp-circuitid
1290and
1291.B dhcp-remoteid.
1292A full relay implementation can use the RFC 5107 serverid-override
1293option to force the DHCP server to use the relay as a full proxy, with all
1294packets passing through it. This flag provides an alternative method
1295of doing the same thing, for relays which don't support RFC
12965107. Given alone, it manipulates the server-id for all interactions
1297via relays. If a list of IP addresses is given, only interactions via
1298relays at those addresses are affected.
1299.TP
1300.B --dhcp-match=set:<tag>,<option number>|option:<option name>|vi-encap:<enterprise>[,<value>]
1301Without a value, set the tag if the client sends a DHCP
Simon Kelley73a08a22009-02-05 20:28:08 +00001302option of the given number or name. When a value is given, set the tag only if
1303the option is sent and matches the value. The value may be of the form
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001304"01:ff:*:02" in which case the value must match (apart from wildcards)
Simon Kelley73a08a22009-02-05 20:28:08 +00001305but the option sent may have unmatched data past the end of the
1306value. The value may also be of the same form as in
1307.B dhcp-option
1308in which case the option sent is treated as an array, and one element
1309must match, so
1310
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001311--dhcp-match=set:efi-ia32,option:client-arch,6
Simon Kelley73a08a22009-02-05 20:28:08 +00001312
1313will set the tag "efi-ia32" if the the number 6 appears in the list of
1314architectures sent by the client in option 93. (See RFC 4578 for
Simon Kelley316e2732010-01-22 20:16:09 +00001315details.) If the value is a string, substring matching is used.
1316
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001317The special form with vi-encap:<enterprise number> matches against
Simon Kelley316e2732010-01-22 20:16:09 +00001318vendor-identifying vendor classes for the specified enterprise. Please
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001319see RFC 3925 for more details of these rare and interesting beasts.
Simon Kelleyf2621c72007-04-29 19:47:21 +01001320.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001321.B --tag-if=set:<tag>[,set:<tag>[,tag:<tag>[,tag:<tag>]]]
1322Perform boolean operations on tags. Any tag appearing as set:<tag> is set if
1323all the tags which appear as tag:<tag> are set, (or unset when tag:!<tag> is used)
1324If no tag:<tag> appears set:<tag> tags are set unconditionally.
1325Any number of set: and tag: forms may appear, in any order.
李三0159ed6bdb02017-11-30 16:47:01 +00001326Tag-if lines are executed in order, so if the tag in tag:<tag> is a
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001327tag set by another
1328.B tag-if,
1329the line which sets the tag must precede the one which tests it.
1330.TP
1331.B \-J, --dhcp-ignore=tag:<tag>[,tag:<tag>]
1332When all the given tags appear in the tag set ignore the host and do
Simon Kelley26128d22004-11-14 16:43:54 +00001333not allocate it a DHCP lease.
1334.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001335.B --dhcp-ignore-names[=tag:<tag>[,tag:<tag>]]
1336When all the given tags appear in the tag set, ignore any hostname
Simon Kelley9e038942008-05-30 20:06:34 +01001337provided by the host. Note that, unlike dhcp-ignore, it is permissible
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001338to supply no tags, in which case DHCP-client supplied hostnames
Simon Kelley832af0b2007-01-21 20:01:28 +00001339are always ignored, and DHCP hosts are added to the DNS using only
1340dhcp-host configuration in dnsmasq and the contents of /etc/hosts and
1341/etc/ethers.
1342.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001343.B --dhcp-generate-names=tag:<tag>[,tag:<tag>]
Simon Kelley1adadf52012-02-13 22:15:58 +00001344(IPv4 only) Generate a name for DHCP clients which do not otherwise have one,
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001345using the MAC address expressed in hex, separated by dashes. Note that
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001346if a host provides a name, it will be used by preference to this,
1347unless
1348.B --dhcp-ignore-names
1349is set.
1350.TP
1351.B --dhcp-broadcast[=tag:<tag>[,tag:<tag>]]
Simon Kelley1adadf52012-02-13 22:15:58 +00001352(IPv4 only) When all the given tags appear in the tag set, always use broadcast to
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001353communicate with the host when it is unconfigured. It is permissible
1354to supply no tags, in which case this is unconditional. Most DHCP clients which
Simon Kelley824af852008-02-12 20:43:05 +00001355need broadcast replies set a flag in their requests so that this
1356happens automatically, some old BOOTP clients do not.
1357.TP
Simon Kelley7de060b2011-08-26 17:24:52 +01001358.B \-M, --dhcp-boot=[tag:<tag>,]<filename>,[<servername>[,<server address>|<tftp_servername>]]
Simon Kelley1adadf52012-02-13 22:15:58 +00001359(IPv4 only) Set BOOTP options to be returned by the DHCP server. Server name and
Simon Kelley832af0b2007-01-21 20:01:28 +00001360address are optional: if not provided, the name is left empty, and the
1361address set to the address of the machine running dnsmasq. If dnsmasq
1362is providing a TFTP service (see
1363.B --enable-tftp
1364) then only the filename is required here to enable network booting.
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001365If the optional tag(s) are given,
1366they must match for this configuration to be sent.
Simon Kelley7de060b2011-08-26 17:24:52 +01001367Instead of an IP address, the TFTP server address can be given as a domain
1368name which is looked up in /etc/hosts. This name can be associated in
1369/etc/hosts with multiple IP addresses, which are used round-robin.
1370This facility can be used to load balance the tftp load among a set of servers.
1371.TP
1372.B --dhcp-sequential-ip
1373Dnsmasq is designed to choose IP addresses for DHCP clients using a
1374hash of the client's MAC address. This normally allows a client's
1375address to remain stable long-term, even if the client sometimes allows its DHCP
1376lease to expire. In this default mode IP addresses are distributed
1377pseudo-randomly over the entire available address range. There are
1378sometimes circumstances (typically server deployment) where it is more
1379convenient to have IP
1380addresses allocated sequentially, starting from the lowest available
1381address, and setting this flag enables this mode. Note that in the
1382sequential mode, clients which allow a lease to expire are much more
1383likely to move IP address; for this reason it should not be generally used.
Simon Kelley7622fc02009-06-04 20:32:05 +01001384.TP
Simon Kelley751d6f42012-02-10 15:24:51 +00001385.B --pxe-service=[tag:<tag>,]<CSA>,<menu text>[,<basename>|<bootservicetype>][,<server address>|<server_name>]
Simon Kelley7622fc02009-06-04 20:32:05 +01001386Most uses of PXE boot-ROMS simply allow the PXE
1387system to obtain an IP address and then download the file specified by
1388.B dhcp-boot
1389and execute it. However the PXE system is capable of more complex
1390functions when supported by a suitable DHCP server.
1391
1392This specifies a boot option which may appear in a PXE boot menu. <CSA> is
1393client system type, only services of the correct type will appear in a
1394menu. The known types are x86PC, PC98, IA64_EFI, Alpha, Arc_x86,
Simon Kelley68bea102016-05-11 22:15:06 +01001395Intel_Lean_Client, IA32_EFI, X86-64_EFI, Xscale_EFI, BC_EFI, ARM32_EFI and ARM64_EFI; an
Simon Kelley7622fc02009-06-04 20:32:05 +01001396integer may be used for other types. The
1397parameter after the menu text may be a file name, in which case dnsmasq acts as a
1398boot server and directs the PXE client to download the file by TFTP,
1399either from itself (
1400.B enable-tftp
Simon Kelley751d6f42012-02-10 15:24:51 +00001401must be set for this to work) or another TFTP server if the final server
1402address/name is given.
Simon Kelley7622fc02009-06-04 20:32:05 +01001403Note that the "layer"
Simon Kelleyfe71bba2016-05-14 20:50:45 +01001404suffix (normally ".0") is supplied by PXE, and need not be added to
1405the basename. Alternatively, the basename may be a filename, complete with suffix, in which case
1406no layer suffix is added. If an integer boot service type, rather than a basename
Simon Kelley7622fc02009-06-04 20:32:05 +01001407is given, then the PXE client will search for a
1408suitable boot service for that type on the network. This search may be done
Simon Kelley751d6f42012-02-10 15:24:51 +00001409by broadcast, or direct to a server if its IP address/name is provided.
Simon Kelley316e2732010-01-22 20:16:09 +00001410If no boot service type or filename is provided (or a boot service type of 0 is specified)
1411then the menu entry will abort the net boot procedure and
Simon Kelley751d6f42012-02-10 15:24:51 +00001412continue booting from local media. The server address can be given as a domain
1413name which is looked up in /etc/hosts. This name can be associated in
1414/etc/hosts with multiple IP addresses, which are used round-robin.
Simon Kelley7622fc02009-06-04 20:32:05 +01001415.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001416.B --pxe-prompt=[tag:<tag>,]<prompt>[,<timeout>]
Simon Kelley7622fc02009-06-04 20:32:05 +01001417Setting this provides a prompt to be displayed after PXE boot. If the
1418timeout is given then after the
1419timeout has elapsed with no keyboard input, the first available menu
1420option will be automatically executed. If the timeout is zero then the first available menu
1421item will be executed immediately. If
1422.B pxe-prompt
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001423is omitted the system will wait for user input if there are multiple
Simon Kelley7622fc02009-06-04 20:32:05 +01001424items in the menu, but boot immediately if
1425there is only one. See
1426.B pxe-service
1427for details of menu items.
1428
1429Dnsmasq supports PXE "proxy-DHCP", in this case another DHCP server on
1430the network is responsible for allocating IP addresses, and dnsmasq
1431simply provides the information given in
1432.B pxe-prompt
1433and
1434.B pxe-service
1435to allow netbooting. This mode is enabled using the
1436.B proxy
1437keyword in
1438.B dhcp-range.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001439.TP
Simon Kelley44a2a312004-03-10 20:04:35 +00001440.B \-X, --dhcp-lease-max=<number>
1441Limits dnsmasq to the specified maximum number of DHCP leases. The
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001442default is 1000. This limit is to prevent DoS attacks from hosts which
Simon Kelley44a2a312004-03-10 20:04:35 +00001443create thousands of leases and use lots of memory in the dnsmasq
1444process.
1445.TP
Simon Kelleyfd9fa482004-10-21 20:24:00 +01001446.B \-K, --dhcp-authoritative
Simon Kelley095f6252013-01-30 11:31:02 +00001447Should be set when dnsmasq is definitely the only DHCP server on a network.
1448For DHCPv4, it changes the behaviour from strict RFC compliance so that DHCP requests on
Simon Kelleyfd9fa482004-10-21 20:24:00 +01001449unknown leases from unknown hosts are not ignored. This allows new hosts
Simon Kelleycdeda282006-03-16 20:16:06 +00001450to get a lease without a tedious timeout under all circumstances. It also
1451allows dnsmasq to rebuild its lease database without each client needing to
Simon Kelley095f6252013-01-30 11:31:02 +00001452reacquire a lease, if the database is lost. For DHCPv6 it sets the
1453priority in replies to 255 (the maximum) instead of 0 (the minimum).
Simon Kelley9e038942008-05-30 20:06:34 +01001454.TP
1455.B --dhcp-alternate-port[=<server port>[,<client port>]]
Simon Kelley1adadf52012-02-13 22:15:58 +00001456(IPv4 only) Change the ports used for DHCP from the default. If this option is
Simon Kelley9e038942008-05-30 20:06:34 +01001457given alone, without arguments, it changes the ports used for DHCP
1458from 67 and 68 to 1067 and 1068. If a single argument is given, that
1459port number is used for the server and the port number plus one used
1460for the client. Finally, two port numbers allows arbitrary
1461specification of both server and client ports for DHCP.
Simon Kelleyfd9fa482004-10-21 20:24:00 +01001462.TP
Simon Kelley9009d742008-11-14 20:04:27 +00001463.B \-3, --bootp-dynamic[=<network-id>[,<network-id>]]
Simon Kelley1adadf52012-02-13 22:15:58 +00001464(IPv4 only) Enable dynamic allocation of IP addresses to BOOTP clients. Use this
Simon Kelley3d8df262005-08-29 12:19:27 +01001465with care, since each address allocated to a BOOTP client is leased
1466forever, and therefore becomes permanently unavailable for re-use by
Simon Kelley9009d742008-11-14 20:04:27 +00001467other hosts. if this is given without tags, then it unconditionally
1468enables dynamic allocation. With tags, only when the tags are all
1469set. It may be repeated with different tag sets.
Simon Kelley3d8df262005-08-29 12:19:27 +01001470.TP
Simon Kelley5e9e0ef2006-04-17 14:24:29 +01001471.B \-5, --no-ping
Christian Demsar23facf02015-05-20 20:26:23 +01001472(IPv4 only) By default, the DHCP server will attempt to ensure that an address is
Simon Kelley5e9e0ef2006-04-17 14:24:29 +01001473not in use before allocating it to a host. It does this by sending an
1474ICMP echo request (aka "ping") to the address in question. If it gets
1475a reply, then the address must already be in use, and another is
1476tried. This flag disables this check. Use with caution.
1477.TP
Simon Kelleyf2621c72007-04-29 19:47:21 +01001478.B --log-dhcp
1479Extra logging for DHCP: log all the options sent to DHCP clients and
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001480the tags used to determine them.
Simon Kelleyf2621c72007-04-29 19:47:21 +01001481.TP
Kevin Darbyshire-Bryant8c0b73d2013-10-11 11:56:33 +01001482.B --quiet-dhcp, --quiet-dhcp6, --quiet-ra
1483Suppress logging of the routine operation of these protocols. Errors and
1484problems will still be logged. --quiet-dhcp and quiet-dhcp6 are
1485over-ridden by --log-dhcp.
1486.TP
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001487.B \-l, --dhcp-leasefile=<path>
Simon Kelley73a08a22009-02-05 20:28:08 +00001488Use the specified file to store DHCP lease information.
Simon Kelley208b65c2006-08-05 21:41:37 +01001489.TP
Simon Kelley8b372702012-03-09 17:45:10 +00001490.B --dhcp-duid=<enterprise-id>,<uid>
1491(IPv6 only) Specify the server persistent UID which the DHCPv6 server
1492will use. This option is not normally required as dnsmasq creates a
1493DUID automatically when it is first needed. When given, this option
1494provides dnsmasq the data required to create a DUID-EN type DUID. Note
1495that once set, the DUID is stored in the lease database, so to change between DUID-EN and
1496automatically created DUIDs or vice-versa, the lease database must be
klemens43517fc2017-02-19 15:53:37 +00001497re-initialised. The enterprise-id is assigned by IANA, and the uid is a
Simon Kelley8b372702012-03-09 17:45:10 +00001498string of hex octets unique to a particular device.
1499.TP
Simon Kelley7cebd202006-05-06 14:13:33 +01001500.B \-6 --dhcp-script=<path>
Simon Kelleya9530962012-03-20 22:07:35 +00001501Whenever a new DHCP lease is created, or an old one destroyed, or a
1502TFTP file transfer completes, the
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001503executable specified by this option is run. <path>
1504must be an absolute pathname, no PATH search occurs.
1505The arguments to the process
Simon Kelley7cebd202006-05-06 14:13:33 +01001506are "add", "old" or "del", the MAC
Simon Kelley1adadf52012-02-13 22:15:58 +00001507address of the host (or DUID for IPv6) , the IP address, and the hostname,
Simon Kelley7cebd202006-05-06 14:13:33 +01001508if known. "add" means a lease has been created, "del" means it has
1509been destroyed, "old" is a notification of an existing lease when
Simon Kelley208b65c2006-08-05 21:41:37 +01001510dnsmasq starts or a change to MAC address or hostname of an existing
1511lease (also, lease length or expiry and client-id, if leasefile-ro is set).
Simon Kelley9009d742008-11-14 20:04:27 +00001512If the MAC address is from a network type other than ethernet,
1513it will have the network type prepended, eg "06-01:23:45:67:89:ab" for
1514token ring. The process is run as root (assuming that dnsmasq was originally run as
Simon Kelley16972692006-10-16 20:04:18 +01001515root) even if dnsmasq is configured to change UID to an unprivileged user.
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001516
1517The environment is inherited from the invoker of dnsmasq, with some or
Simon Kelley1adadf52012-02-13 22:15:58 +00001518all of the following variables added
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001519
Simon Kelley1adadf52012-02-13 22:15:58 +00001520For both IPv4 and IPv6:
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001521
1522DNSMASQ_DOMAIN if the fully-qualified domain name of the host is
Simon Kelley28866e92011-02-14 20:19:14 +00001523known, this is set to the domain part. (Note that the hostname passed
1524to the script as an argument is never fully-qualified.)
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001525
Simon Kelley1adadf52012-02-13 22:15:58 +00001526If the client provides a hostname, DNSMASQ_SUPPLIED_HOSTNAME
1527
1528If the client provides user-classes, DNSMASQ_USER_CLASS0..DNSMASQ_USER_CLASSn
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001529
1530If dnsmasq was compiled with HAVE_BROKEN_RTC, then
Simon Kelley208b65c2006-08-05 21:41:37 +01001531the length of the lease (in seconds) is stored in
Simon Kelley16972692006-10-16 20:04:18 +01001532DNSMASQ_LEASE_LENGTH, otherwise the time of lease expiry is stored in
Simon Kelley5aabfc72007-08-29 11:24:47 +01001533DNSMASQ_LEASE_EXPIRES. The number of seconds until lease expiry is
1534always stored in DNSMASQ_TIME_REMAINING.
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001535
Simon Kelley5aabfc72007-08-29 11:24:47 +01001536If a lease used to have a hostname, which is
Simon Kelley16972692006-10-16 20:04:18 +01001537removed, an "old" event is generated with the new state of the lease,
1538ie no name, and the former name is provided in the environment
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001539variable DNSMASQ_OLD_HOSTNAME.
1540
1541DNSMASQ_INTERFACE stores the name of
Simon Kelley9e038942008-05-30 20:06:34 +01001542the interface on which the request arrived; this is not set for "old"
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001543actions when dnsmasq restarts.
1544
1545DNSMASQ_RELAY_ADDRESS is set if the client
Simon Kelley316e2732010-01-22 20:16:09 +00001546used a DHCP relay to contact dnsmasq and the IP address of the relay
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001547is known.
1548
1549DNSMASQ_TAGS contains all the tags set during the
Simon Kelley316e2732010-01-22 20:16:09 +00001550DHCP transaction, separated by spaces.
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001551
Simon Kelleye46164e2012-04-16 16:39:38 +01001552DNSMASQ_LOG_DHCP is set if
1553.B --log-dhcp
1554is in effect.
Simon Kelleya9530962012-03-20 22:07:35 +00001555
Simon Kelley1adadf52012-02-13 22:15:58 +00001556For IPv4 only:
1557
1558DNSMASQ_CLIENT_ID if the host provided a client-id.
1559
Simon Kelleydd1721c2013-02-18 21:04:04 +00001560DNSMASQ_CIRCUIT_ID, DNSMASQ_SUBSCRIBER_ID, DNSMASQ_REMOTE_ID if a
1561DHCP relay-agent added any of these options.
1562
Simon Kelley1adadf52012-02-13 22:15:58 +00001563If the client provides vendor-class, DNSMASQ_VENDOR_CLASS.
1564
ZHAO Yuf89cae32016-12-22 22:32:31 +00001565DNSMASQ_REQUESTED_OPTIONS a string containing the decimal values in the Parameter Request List option, comma separated, if the parameter request list option is provided by the client.
1566
Simon Kelley1adadf52012-02-13 22:15:58 +00001567For IPv6 only:
1568
1569If the client provides vendor-class, DNSMASQ_VENDOR_CLASS_ID,
1570containing the IANA enterprise id for the class, and
1571DNSMASQ_VENDOR_CLASS0..DNSMASQ_VENDOR_CLASSn for the data.
1572
Simon Kelley57f460d2012-02-16 20:00:32 +00001573DNSMASQ_SERVER_DUID containing the DUID of the server: this is the same for
Simon Kelley1adadf52012-02-13 22:15:58 +00001574every call to the script.
1575
1576DNSMASQ_IAID containing the IAID for the lease. If the lease is a
1577temporary allocation, this is prefixed to 'T'.
1578
Simon Kelley89500e32013-09-20 16:29:20 +01001579DNSMASQ_MAC containing the MAC address of the client, if known.
Simon Kelley1adadf52012-02-13 22:15:58 +00001580
1581Note that the supplied hostname, vendorclass and userclass data is
1582only supplied for
1583"add" actions or "old" actions when a host resumes an existing lease,
1584since these data are not held in dnsmasq's lease
1585database.
1586
Simon Kelleya9530962012-03-20 22:07:35 +00001587
1588
Simon Kelley9e038942008-05-30 20:06:34 +01001589All file descriptors are
Petr Menšíkc77fb9d2017-04-16 20:20:08 +01001590closed except stdin, which is open to /dev/null, and stdout and stderr which capture output for logging by dnsmasq.
1591(In debug mode, stdio, stdout and stderr file are left as those inherited from the invoker of dnsmasq).
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001592
1593The script is not invoked concurrently: at most one instance
1594of the script is ever running (dnsmasq waits for an instance of script to exit
1595before running the next). Changes to the lease database are which
1596require the script to be invoked are queued awaiting exit of a running instance.
1597If this queueing allows multiple state changes occur to a single
1598lease before the script can be run then
1599earlier states are discarded and the current state of that lease is
1600reflected when the script finally runs.
1601
1602At dnsmasq startup, the script will be invoked for
Simon Kelley7cebd202006-05-06 14:13:33 +01001603all existing leases as they are read from the lease file. Expired
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001604leases will be called with "del" and others with "old". When dnsmasq
Simon Kelley5aabfc72007-08-29 11:24:47 +01001605receives a HUP signal, the script will be invoked for existing leases
Simon Kelley1e505122016-01-25 21:29:23 +00001606with an "old" event.
Simon Kelleya9530962012-03-20 22:07:35 +00001607
1608
Simon Kelley1e505122016-01-25 21:29:23 +00001609There are four further actions which may appear as the first argument
Simon Kelleye6e751b2016-02-01 17:59:07 +00001610to the script, "init", "arp-add", "arp-del" and "tftp". More may be added in the future, so
Simon Kelleya9530962012-03-20 22:07:35 +00001611scripts should be written to ignore unknown actions. "init" is
Simon Kelleye46164e2012-04-16 16:39:38 +01001612described below in
Simon Kelleya9530962012-03-20 22:07:35 +00001613.B --leasefile-ro
1614The "tftp" action is invoked when a TFTP file transfer completes: the
1615arguments are the file size in bytes, the address to which the file
1616was sent, and the complete pathname of the file.
1617
Simon Kelleye6e751b2016-02-01 17:59:07 +00001618The "arp-add" and "arp-del" actions are only called if enabled with
Simon Kelley1e505122016-01-25 21:29:23 +00001619.B --script-arp
Simon Kelleye6e751b2016-02-01 17:59:07 +00001620They are are supplied with a MAC address and IP address as arguments. "arp-add" indicates
1621the arrival of a new entry in the ARP or neighbour table, and "arp-del" indicates the deletion of same.
Simon Kelley1e505122016-01-25 21:29:23 +00001622
Simon Kelley9e038942008-05-30 20:06:34 +01001623.TP
Simon Kelley57f460d2012-02-16 20:00:32 +00001624.B --dhcp-luascript=<path>
1625Specify a script written in Lua, to be run when leases are created,
1626destroyed or changed. To use this option, dnsmasq must be compiled
klemens43517fc2017-02-19 15:53:37 +00001627with the correct support. The Lua interpreter is initialised once, when
Simon Kelley57f460d2012-02-16 20:00:32 +00001628dnsmasq starts, so that global variables persist between lease
1629events. The Lua code must define a
1630.B lease
1631function, and may provide
1632.B init
1633and
1634.B shutdown
1635functions, which are called, without arguments when dnsmasq starts up
Simon Kelleya9530962012-03-20 22:07:35 +00001636and terminates. It may also provide a
1637.B tftp
1638function.
Simon Kelley57f460d2012-02-16 20:00:32 +00001639
1640The
1641.B lease
Simon Kelleya9530962012-03-20 22:07:35 +00001642function receives the information detailed in
Simon Kelley57f460d2012-02-16 20:00:32 +00001643.B --dhcp-script.
1644It gets two arguments, firstly the action, which is a string
1645containing, "add", "old" or "del", and secondly a table of tag value
1646pairs. The tags mostly correspond to the environment variables
1647detailed above, for instance the tag "domain" holds the same data as
1648the environment variable DNSMASQ_DOMAIN. There are a few extra tags
1649which hold the data supplied as arguments to
1650.B --dhcp-script.
1651These are
1652.B mac_address, ip_address
1653and
1654.B hostname
1655for IPv4, and
1656.B client_duid, ip_address
1657and
1658.B hostname
Simon Kelleya9530962012-03-20 22:07:35 +00001659for IPv6.
1660
1661The
1662.B tftp
1663function is called in the same way as the lease function, and the
1664table holds the tags
1665.B destination_address,
1666.B file_name
1667and
1668.B file_size.
Simon Kelley1e505122016-01-25 21:29:23 +00001669
1670The
1671.B arp
1672and
1673.B arp-old
1674functions are called only when enabled with
1675.B --script-arp
1676and have a table which holds the tags
Josh Soref730c6742017-02-06 16:14:04 +00001677.B mac_address
Simon Kelley1e505122016-01-25 21:29:23 +00001678and
1679.B client_address.
Simon Kelley57f460d2012-02-16 20:00:32 +00001680.TP
Simon Kelley9e038942008-05-30 20:06:34 +01001681.B --dhcp-scriptuser
Simon Kelley57f460d2012-02-16 20:00:32 +00001682Specify the user as which to run the lease-change script or Lua script. This defaults to root, but can be changed to another user using this flag.
Simon Kelley1e505122016-01-25 21:29:23 +00001683.TP
1684.B --script-arp
1685Enable the "arp" and "arp-old" functions in the dhcp-script and dhcp-luascript.
1686.TP
Simon Kelley208b65c2006-08-05 21:41:37 +01001687.B \-9, --leasefile-ro
1688Completely suppress use of the lease database file. The file will not
1689be created, read, or written. Change the way the lease-change
1690script (if one is provided) is called, so that the lease database may
1691be maintained in external storage by the script. In addition to the
Simon Kelleyf2621c72007-04-29 19:47:21 +01001692invocations given in
Simon Kelley208b65c2006-08-05 21:41:37 +01001693.B --dhcp-script
1694the lease-change script is called once, at dnsmasq startup, with the
1695single argument "init". When called like this the script should write
1696the saved state of the lease database, in dnsmasq leasefile format, to
1697stdout and exit with zero exit code. Setting this
1698option also forces the leasechange script to be called on changes
1699to the client-id and lease length and expiry time.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001700.TP
Simon Kelley832af0b2007-01-21 20:01:28 +00001701.B --bridge-interface=<interface>,<alias>[,<alias>]
Simon Kelley22cd8602018-01-14 22:57:14 +00001702Treat DHCP (v4 and v6) requests and IPv6 Router Solicit packets
Neil Jerram4918bd52015-06-10 22:23:20 +01001703arriving at any of the <alias> interfaces as if they had arrived at
1704<interface>. This option allows dnsmasq to provide DHCP and RA
1705service over unaddressed and unbridged Ethernet interfaces, e.g. on an
1706OpenStack compute host where each such interface is a TAP interface to
1707a VM, or as in "old style bridging" on BSD platforms. A trailing '*'
1708wildcard can be used in each <alias>.
Simon Kelley22cd8602018-01-14 22:57:14 +00001709
1710It is permissible to add more than one alias using more than one --bridge-interface option since
1711--bridge-interface=int1,alias1,alias2 is exactly equivalent to
1712--bridge-interface=int1,alias1 --bridge-interface=int1,alias2
Simon Kelley832af0b2007-01-21 20:01:28 +00001713.TP
Simon Kelley28866e92011-02-14 20:19:14 +00001714.B \-s, --domain=<domain>[,<address range>[,local]]
Simon Kelley9009d742008-11-14 20:04:27 +00001715Specifies DNS domains for the DHCP server. Domains may be be given
1716unconditionally (without the IP range) or for limited IP ranges. This has two effects;
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001717firstly it causes the DHCP server to return the domain to any hosts
1718which request it, and secondly it sets the domain which it is legal
Simon Kelley1b7ecd12007-02-05 14:57:57 +00001719for DHCP-configured hosts to claim. The intention is to constrain
1720hostnames so that an untrusted host on the LAN cannot advertise
1721its name via dhcp as e.g. "microsoft.com" and capture traffic not
1722meant for it. If no domain suffix is specified, then any DHCP
1723hostname with a domain part (ie with a period) will be disallowed
1724and logged. If suffix is specified, then hostnames with a domain
1725part are allowed, provided the domain part matches the suffix. In
1726addition, when a suffix is set then hostnames without a domain
1727part have the suffix added as an optional domain part. Eg on my network I can set
Simon Kelley3d8df262005-08-29 12:19:27 +01001728.B --domain=thekelleys.org.uk
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001729and have a machine whose DHCP hostname is "laptop". The IP address for that machine is available from
1730.B dnsmasq
Simon Kelleyde379512004-06-22 20:23:33 +01001731both as "laptop" and "laptop.thekelleys.org.uk". If the domain is
1732given as "#" then the domain is read from the first "search" directive
Simon Kelley28866e92011-02-14 20:19:14 +00001733in /etc/resolv.conf (or equivalent).
1734
1735The address range can be of the form
Simon Kelley9009d742008-11-14 20:04:27 +00001736<ip address>,<ip address> or <ip address>/<netmask> or just a single
1737<ip address>. See
1738.B --dhcp-fqdn
1739which can change the behaviour of dnsmasq with domains.
Simon Kelley28866e92011-02-14 20:19:14 +00001740
1741If the address range is given as ip-address/network-size, then a
1742additional flag "local" may be supplied which has the effect of adding
1743--local declarations for forward and reverse DNS queries. Eg.
1744.B --domain=thekelleys.org.uk,192.168.0.0/24,local
1745is identical to
1746.B --domain=thekelleys.org.uk,192.168.0.0/24
1747--local=/thekelleys.org.uk/ --local=/0.168.192.in-addr.arpa/
1748The network size must be 8, 16 or 24 for this to be legal.
Simon Kelley9009d742008-11-14 20:04:27 +00001749.TP
1750.B --dhcp-fqdn
1751In the default mode, dnsmasq inserts the unqualified names of
1752DHCP clients into the DNS. For this reason, the names must be unique,
1753even if two clients which have the same name are in different
1754domains. If a second DHCP client appears which has the same name as an
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01001755existing client, the name is transferred to the new client. If
Simon Kelley9009d742008-11-14 20:04:27 +00001756.B --dhcp-fqdn
1757is set, this behaviour changes: the unqualified name is no longer
1758put in the DNS, only the qualified name. Two DHCP clients with the
1759same name may both keep the name, provided that the domain part is
1760different (ie the fully qualified names differ.) To ensure that all
1761names have a domain part, there must be at least
1762.B --domain
1763without an address specified when
1764.B --dhcp-fqdn
1765is set.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001766.TP
Simon Kelleyc72daea2012-01-05 21:33:27 +00001767.B --dhcp-client-update
1768Normally, when giving a DHCP lease, dnsmasq sets flags in the FQDN
1769option to tell the client not to attempt a DDNS update with its name
1770and IP address. This is because the name-IP pair is automatically
1771added into dnsmasq's DNS view. This flag suppresses that behaviour,
1772this is useful, for instance, to allow Windows clients to update
1773Active Directory servers. See RFC 4702 for details.
1774.TP
Simon Kelleyc5ad4e72012-02-24 16:06:20 +00001775.B --enable-ra
1776Enable dnsmasq's IPv6 Router Advertisement feature. DHCPv6 doesn't
1777handle complete network configuration in the same way as DHCPv4. Router
1778discovery and (possibly) prefix discovery for autonomous address
1779creation are handled by a different protocol. When DHCP is in use,
1780only a subset of this is needed, and dnsmasq can handle it, using
1781existing DHCP configuration to provide most data. When RA is enabled,
1782dnsmasq will advertise a prefix for each dhcp-range, with default
Simon Kelley20fd11e2015-08-26 22:48:13 +01001783router as the relevant link-local address on
1784the machine running dnsmasq. By default, the "managed address" bits are set, and
Simon Kelleye8ca69e2012-03-26 21:23:26 +01001785the "use SLAAC" bit is reset. This can be changed for individual
1786subnets with the mode keywords described in
1787.B --dhcp-range.
Simon Kelley18f0fb02012-03-31 21:18:55 +01001788RFC6106 DNS parameters are included in the advertisements. By default,
1789the relevant link-local address of the machine running dnsmasq is sent
1790as recursive DNS server. If provided, the DHCPv6 options dns-server and
Josh Soref730c6742017-02-06 16:14:04 +00001791domain-search are used for the DNS server (RDNSS) and the domain search list (DNSSL).
Simon Kelleyc5ad4e72012-02-24 16:06:20 +00001792.TP
Vladislav Grishenko6ec5f5c2017-04-24 22:34:45 +01001793.B --ra-param=<interface>,[mtu:<integer>|<interface>|off,][high,|low,]<ra-interval>[,<router lifetime>]
Simon Kelleyc4cd95d2013-10-10 20:58:11 +01001794Set non-default values for router advertisements sent via an
1795interface. The priority field for the router may be altered from the
1796default of medium with eg
1797.B --ra-param=eth0,high.
1798The interval between router advertisements may be set (in seconds) with
1799.B --ra-param=eth0,60.
1800The lifetime of the route may be changed or set to zero, which allows
1801a router to advertise prefixes but not a route via itself.
1802.B --ra-parm=eth0,0,0
David Flamand005c46d2017-04-11 11:49:54 +01001803(A value of zero for the interval means the default value.) All four parameters may be set at once.
1804.B --ra-param=eth0,mtu:1280,low,60,1200
Vladislav Grishenko6ec5f5c2017-04-24 22:34:45 +01001805
Simon Kelleyc4cd95d2013-10-10 20:58:11 +01001806The interface field may include a wildcard.
Vladislav Grishenko6ec5f5c2017-04-24 22:34:45 +01001807
1808The mtu: parameter may be an arbitrary interface name, in which case the MTU value for that interface is used. This is useful
1809for (eg) advertising the MTU of a WAN interface on the other interfaces of a router.
Simon Kelley8d030462013-07-29 15:41:26 +01001810.TP
Floris Bos503c6092017-04-09 23:07:13 +01001811.B --dhcp-reply-delay=[tag:<tag>,]<integer>
1812Delays sending DHCPOFFER and proxydhcp replies for at least the specified number of seconds.
1813This can be used as workaround for bugs in PXE boot firmware that does not function properly when
1814receiving an instant reply.
1815This option takes into account the time already spent waiting (e.g. performing ping check) if any.
1816.TP
Simon Kelley2937f8a2013-07-29 19:49:07 +01001817.B --enable-tftp[=<interface>[,<interface>]]
Simon Kelley832af0b2007-01-21 20:01:28 +00001818Enable the TFTP server function. This is deliberately limited to that
Simon Kelley9e038942008-05-30 20:06:34 +01001819needed to net-boot a client. Only reading is allowed; the tsize and
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001820blksize extensions are supported (tsize is only supported in octet
Simon Kelley2937f8a2013-07-29 19:49:07 +01001821mode). Without an argument, the TFTP service is provided to the same set of interfaces as DHCP service.
Josh Soref730c6742017-02-06 16:14:04 +00001822If the list of interfaces is provided, that defines which interfaces receive TFTP service.
Simon Kelleyb8187c82005-11-26 21:46:27 +00001823.TP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001824.B --tftp-root=<directory>[,<interface>]
Simon Kelley832af0b2007-01-21 20:01:28 +00001825Look for files to transfer using TFTP relative to the given
1826directory. When this is set, TFTP paths which include ".." are
1827rejected, to stop clients getting outside the specified root.
Simon Kelleyf2621c72007-04-29 19:47:21 +01001828Absolute paths (starting with /) are allowed, but they must be within
Simon Kelley8ef5ada2010-06-03 19:42:45 +01001829the tftp-root. If the optional interface argument is given, the
1830directory is only used for TFTP requests via that interface.
Simon Kelley832af0b2007-01-21 20:01:28 +00001831.TP
Stefan Tomanek30d08792015-03-31 22:32:11 +01001832.B --tftp-no-fail
1833Do not abort startup if specified tftp root directories are inaccessible.
1834.TP
Floris Bos60704f52017-04-09 22:22:49 +01001835.B --tftp-unique-root[=ip|mac]
1836Add the IP or hardware address of the TFTP client as a path component on the end
1837of the TFTP-root. Only valid if a tftp-root is set and the directory exists.
1838Defaults to adding IP address (in standard dotted-quad format).
1839For instance, if tftp-root is "/tftp" and client 1.2.3.4 requests file "myfile"
1840then the effective path will be "/tftp/1.2.3.4/myfile" if /tftp/1.2.3.4 exists or /tftp/myfile otherwise.
1841When "=mac" is specified it will append the MAC address instead, using lowercase zero padded digits
1842separated by dashes, e.g.: 01-02-03-04-aa-bb
1843Note that resolving MAC addresses is only possible if the client is in the local network or obtained
1844a DHCP lease from us.
Simon Kelley5aabfc72007-08-29 11:24:47 +01001845.TP
Simon Kelley832af0b2007-01-21 20:01:28 +00001846.B --tftp-secure
Simon Kelley5aabfc72007-08-29 11:24:47 +01001847Enable TFTP secure mode: without this, any file which is readable by
Simon Kelley832af0b2007-01-21 20:01:28 +00001848the dnsmasq process under normal unix access-control rules is
1849available via TFTP. When the --tftp-secure flag is given, only files
1850owned by the user running the dnsmasq process are accessible. If
1851dnsmasq is being run as root, different rules apply: --tftp-secure
Simon Kelley1b7ecd12007-02-05 14:57:57 +00001852has no effect, but only files which have the world-readable bit set
Simon Kelley832af0b2007-01-21 20:01:28 +00001853are accessible. It is not recommended to run dnsmasq as root with TFTP
1854enabled, and certainly not without specifying --tftp-root. Doing so
1855can expose any world-readable file on the server to any host on the net.
1856.TP
Simon Kelley61ce6002012-04-20 21:28:49 +01001857.B --tftp-lowercase
1858Convert filenames in TFTP requests to all lowercase. This is useful
1859for requests from Windows machines, which have case-insensitive
1860filesystems and tend to play fast-and-loose with case in filenames.
1861Note that dnsmasq's tftp server always converts "\\" to "/" in filenames.
1862.TP
Simon Kelley832af0b2007-01-21 20:01:28 +00001863.B --tftp-max=<connections>
1864Set the maximum number of concurrent TFTP connections allowed. This
1865defaults to 50. When serving a large number of TFTP connections,
1866per-process file descriptor limits may be encountered. Dnsmasq needs
1867one file descriptor for each concurrent TFTP connection and one
1868file descriptor per unique file (plus a few others). So serving the
1869same file simultaneously to n clients will use require about n + 10 file
1870descriptors, serving different files simultaneously to n clients will
Simon Kelley824af852008-02-12 20:43:05 +00001871require about (2*n) + 10 descriptors. If
1872.B --tftp-port-range
1873is given, that can affect the number of concurrent connections.
Simon Kelley6b010842007-02-12 20:32:07 +00001874.TP
Simon Kelleybec366b2016-02-24 22:03:26 +00001875.B --tftp-mtu=<mtu size>
1876Use size as the ceiling of the MTU supported by the intervening network when
1877negotiating TFTP blocksize, overriding the MTU setting of the local interface if it is larger.
1878.TP
Simon Kelley6b010842007-02-12 20:32:07 +00001879.B --tftp-no-blocksize
1880Stop the TFTP server from negotiating the "blocksize" option with a
1881client. Some buggy clients request this option but then behave badly
1882when it is granted.
Simon Kelley824af852008-02-12 20:43:05 +00001883.TP
1884.B --tftp-port-range=<start>,<end>
1885A TFTP server listens on a well-known port (69) for connection initiation,
1886but it also uses a dynamically-allocated port for each
1887connection. Normally these are allocated by the OS, but this option
1888specifies a range of ports for use by TFTP transfers. This can be
1889useful when TFTP has to traverse a firewall. The start of the range
1890cannot be lower than 1025 unless dnsmasq is running as root. The number
1891of concurrent TFTP connections is limited by the size of the port range.
Simon Kelley832af0b2007-01-21 20:01:28 +00001892.TP
Simon Kelleyb8187c82005-11-26 21:46:27 +00001893.B \-C, --conf-file=<file>
1894Specify a different configuration file. The conf-file option is also allowed in
Simon Kelley28866e92011-02-14 20:19:14 +00001895configuration files, to include multiple configuration files. A
1896filename of "-" causes dnsmasq to read configuration from stdin.
Simon Kelley849a8352006-06-09 21:02:31 +01001897.TP
Simon Kelley3e1551a2014-09-09 21:46:07 +01001898.B \-7, --conf-dir=<directory>[,<file-extension>......],
Simon Kelley849a8352006-06-09 21:02:31 +01001899Read all the files in the given directory as configuration
Simon Kelley1f15b812009-10-13 17:49:32 +01001900files. If extension(s) are given, any files which end in those
1901extensions are skipped. Any files whose names end in ~ or start with . or start and end
Simon Kelley3e1551a2014-09-09 21:46:07 +01001902with # are always skipped. If the extension starts with * then only files
1903which have that extension are loaded. So
1904.B --conf-dir=/path/to/dir,*.conf
1905loads all files with the suffix .conf in /path/to/dir. This flag may be given on the command
1906line or in a configuration file. If giving it on the command line, be sure to
1907escape * characters.
Simon Kelley7b1eae42014-02-20 13:43:28 +00001908.TP
1909.B --servers-file=<file>
1910A special case of
1911.B --conf-file
1912which differs in two respects. Firstly, only --server and --rev-server are allowed
1913in the configuration file included. Secondly, the file is re-read and the configuration
Josh Soref730c6742017-02-06 16:14:04 +00001914therein is updated when dnsmasq receives SIGHUP.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001915.SH CONFIG FILE
Simon Kelley3be34542004-09-11 19:12:13 +01001916At startup, dnsmasq reads
1917.I /etc/dnsmasq.conf,
1918if it exists. (On
1919FreeBSD, the file is
1920.I /usr/local/etc/dnsmasq.conf
Simon Kelleyb8187c82005-11-26 21:46:27 +00001921) (but see the
1922.B \-C
Simon Kelley849a8352006-06-09 21:02:31 +01001923and
1924.B \-7
1925options.) The format of this
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001926file consists of one option per line, exactly as the long options detailed
1927in the OPTIONS section but without the leading "--". Lines starting with # are comments and ignored. For
Simon Kelleyb49644f2004-01-30 21:36:24 +00001928options which may only be specified once, the configuration file overrides
Simon Kelleyb8187c82005-11-26 21:46:27 +00001929the command line. Quoting is allowed in a config file:
Simon Kelley3d8df262005-08-29 12:19:27 +01001930between " quotes the special meanings of ,:. and # are removed and the
Simon Kelley824af852008-02-12 20:43:05 +00001931following escapes are allowed: \\\\ \\" \\t \\e \\b \\r and \\n. The later
1932corresponding to tab, escape, backspace, return and newline.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001933.SH NOTES
1934When it receives a SIGHUP,
1935.B dnsmasq
Simon Kelley3be34542004-09-11 19:12:13 +01001936clears its cache and then re-loads
Simon Kelley5aabfc72007-08-29 11:24:47 +01001937.I /etc/hosts
1938and
1939.I /etc/ethers
Simon Kelley3d04f462015-01-31 21:59:13 +00001940and any file given by --dhcp-hostsfile, --dhcp-hostsdir, --dhcp-optsfile,
1941--dhcp-optsdir, --addn-hosts or --hostsdir.
Simon Kelley5aabfc72007-08-29 11:24:47 +01001942The dhcp lease change script is called for all
1943existing DHCP leases. If
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001944.B
1945--no-poll
Simon Kelley3be34542004-09-11 19:12:13 +01001946is set SIGHUP also re-reads
1947.I /etc/resolv.conf.
1948SIGHUP
Simon Kelleyb49644f2004-01-30 21:36:24 +00001949does NOT re-read the configuration file.
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001950.PP
1951When it receives a SIGUSR1,
1952.B dnsmasq
Simon Kelley824af852008-02-12 20:43:05 +00001953writes statistics to the system log. It writes the cache size,
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001954the number of names which have had to removed from the cache before
1955they expired in order to make room for new names and the total number
Simon Kelleyfec216d2014-03-27 20:54:34 +00001956of names that have been inserted into the cache. The number of cache hits and
1957misses and the number of authoritative queries answered are also given. For each upstream
Simon Kelley824af852008-02-12 20:43:05 +00001958server it gives the number of queries sent, and the number which
1959resulted in an error. In
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001960.B --no-daemon
Simon Kelley5aabfc72007-08-29 11:24:47 +01001961mode or when full logging is enabled (-q), a complete dump of the
Simon Kelleyfec216d2014-03-27 20:54:34 +00001962contents of the cache is made.
1963
1964The cache statistics are also available in the DNS as answers to
1965queries of class CHAOS and type TXT in domain bind. The domain names are cachesize.bind, insertions.bind, evictions.bind,
1966misses.bind, hits.bind, auth.bind and servers.bind. An example command to query this, using the
1967.B dig
1968utility would be
1969
1970dig +short chaos txt cachesize.bind
1971
Simon Kelley5aabfc72007-08-29 11:24:47 +01001972.PP
1973When it receives SIGUSR2 and it is logging direct to a file (see
1974.B --log-facility
1975)
1976.B dnsmasq
1977will close and reopen the log file. Note that during this operation,
1978dnsmasq will not be running as root. When it first creates the logfile
1979dnsmasq changes the ownership of the file to the non-root user it will run
1980as. Logrotate should be configured to create a new log file with
Simon Kelley9e038942008-05-30 20:06:34 +01001981the ownership which matches the existing one before sending SIGUSR2.
Simon Kelley5aabfc72007-08-29 11:24:47 +01001982If TCP DNS queries are in progress, the old logfile will remain open in
1983child processes which are handling TCP queries and may continue to be
1984written. There is a limit of 150 seconds, after which all existing TCP
1985processes will have expired: for this reason, it is not wise to
1986configure logfile compression for logfiles which have just been
1987rotated. Using logrotate, the required options are
1988.B create
1989and
1990.B delaycompress.
1991
1992
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001993.PP
李三0159ed6bdb02017-11-30 16:47:01 +00001994Dnsmasq is a DNS query forwarder: it is not capable of recursively
Simon Kelley9e4abcb2004-01-22 19:47:41 +00001995answering arbitrary queries starting from the root servers but
1996forwards such queries to a fully recursive upstream DNS server which is
1997typically provided by an ISP. By default, dnsmasq reads
Simon Kelley3be34542004-09-11 19:12:13 +01001998.I /etc/resolv.conf
1999to discover the IP
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002000addresses of the upstream nameservers it should use, since the
2001information is typically stored there. Unless
2002.B --no-poll
2003is used,
2004.B dnsmasq
Simon Kelley3be34542004-09-11 19:12:13 +01002005checks the modification time of
2006.I /etc/resolv.conf
2007(or equivalent if
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002008.B \--resolv-file
2009is used) and re-reads it if it changes. This allows the DNS servers to
2010be set dynamically by PPP or DHCP since both protocols provide the
2011information.
Simon Kelley3be34542004-09-11 19:12:13 +01002012Absence of
2013.I /etc/resolv.conf
2014is not an error
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002015since it may not have been created before a PPP connection exists. Dnsmasq
Simon Kelley3be34542004-09-11 19:12:13 +01002016simply keeps checking in case
2017.I /etc/resolv.conf
2018is created at any
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002019time. Dnsmasq can be told to parse more than one resolv.conf
2020file. This is useful on a laptop, where both PPP and DHCP may be used:
Simon Kelley3be34542004-09-11 19:12:13 +01002021dnsmasq can be set to poll both
2022.I /etc/ppp/resolv.conf
2023and
2024.I /etc/dhcpc/resolv.conf
2025and will use the contents of whichever changed
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002026last, giving automatic switching between DNS servers.
2027.PP
2028Upstream servers may also be specified on the command line or in
Simon Kelleyb49644f2004-01-30 21:36:24 +00002029the configuration file. These server specifications optionally take a
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002030domain name which tells dnsmasq to use that server only to find names
2031in that particular domain.
2032.PP
2033In order to configure dnsmasq to act as cache for the host on which it is running, put "nameserver 127.0.0.1" in
2034.I /etc/resolv.conf
2035to force local processes to send queries to
2036dnsmasq. Then either specify the upstream servers directly to dnsmasq
2037using
2038.B \--server
2039options or put their addresses real in another file, say
2040.I /etc/resolv.dnsmasq
2041and run dnsmasq with the
2042.B \-r /etc/resolv.dnsmasq
2043option. This second technique allows for dynamic update of the server
2044addresses by PPP or DHCP.
Simon Kelley3be34542004-09-11 19:12:13 +01002045.PP
Simon Kelleyf6b7dc42005-01-23 12:06:08 +00002046Addresses in /etc/hosts will "shadow" different addresses for the same
2047names in the upstream DNS, so "mycompany.com 1.2.3.4" in /etc/hosts will ensure that
2048queries for "mycompany.com" always return 1.2.3.4 even if queries in
2049the upstream DNS would otherwise return a different address. There is
2050one exception to this: if the upstream DNS contains a CNAME which
2051points to a shadowed name, then looking up the CNAME through dnsmasq
2052will result in the unshadowed address associated with the target of
2053the CNAME. To work around this, add the CNAME to /etc/hosts so that
2054the CNAME is shadowed too.
2055
2056.PP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002057The tag system works as follows: For each DHCP request, dnsmasq
2058collects a set of valid tags from active configuration lines which
2059include set:<tag>, including one from the
Simon Kelley26128d22004-11-14 16:43:54 +00002060.B dhcp-range
2061used to allocate the address, one from any matching
2062.B dhcp-host
Simon Kelley391f7082017-07-08 20:48:51 +01002063(and "known" or "known-othernet" if a dhcp-host matches)
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002064The tag "bootp" is set for BOOTP requests, and a tag whose name is the
2065name of the interface on which the request arrived is also set.
2066
Tomas Hozzaa66d36e2013-04-22 15:08:07 +01002067Any configuration lines which include one or more tag:<tag> constructs
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002068will only be valid if all that tags are matched in the set derived
2069above. Typically this is dhcp-option.
Simon Kelley26128d22004-11-14 16:43:54 +00002070.B dhcp-option
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002071which has tags will be used in preference to an untagged
Simon Kelley26128d22004-11-14 16:43:54 +00002072.B dhcp-option,
2073provided that _all_ the tags match somewhere in the
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002074set collected as described above. The prefix '!' on a tag means 'not'
Moritz Warninge62e9b62014-03-20 15:32:22 +00002075so --dhcp-option=tag:!purple,3,1.2.3.4 sends the option when the
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002076tag purple is not in the set of valid tags. (If using this in a
2077command line rather than a configuration file, be sure to escape !,
2078which is a shell metacharacter)
Simon Kelley7de060b2011-08-26 17:24:52 +01002079
2080When selecting dhcp-options, a tag from dhcp-range is second class
2081relative to other tags, to make it easy to override options for
2082individual hosts, so
2083.B dhcp-range=set:interface1,......
2084.B dhcp-host=set:myhost,.....
2085.B dhcp-option=tag:interface1,option:nis-domain,"domain1"
2086.B dhcp-option=tag:myhost,option:nis-domain,"domain2"
2087will set the NIS-domain to domain1 for hosts in the range, but
2088override that to domain2 for a particular host.
2089
Simon Kelley26128d22004-11-14 16:43:54 +00002090.PP
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002091Note that for
Simon Kelleyf6b7dc42005-01-23 12:06:08 +00002092.B dhcp-range
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002093both tag:<tag> and set:<tag> are allowed, to both select the range in
2094use based on (eg) dhcp-host, and to affect the options sent, based on
2095the range selected.
2096
2097This system evolved from an earlier, more limited one and for backward
2098compatibility "net:" may be used instead of "tag:" and "set:" may be
2099omitted. (Except in
2100.B dhcp-host,
2101where "net:" may be used instead of "set:".) For the same reason, '#'
2102may be used instead of '!' to indicate NOT.
Simon Kelleyf6b7dc42005-01-23 12:06:08 +00002103.PP
Simon Kelley3be34542004-09-11 19:12:13 +01002104The DHCP server in dnsmasq will function as a BOOTP server also,
2105provided that the MAC address and IP address for clients are given,
2106either using
2107.B dhcp-host
2108configurations or in
2109.I /etc/ethers
2110, and a
2111.B dhcp-range
2112configuration option is present to activate the DHCP server
Simon Kelleyb8187c82005-11-26 21:46:27 +00002113on a particular network. (Setting --bootp-dynamic removes the need for
2114static address mappings.) The filename
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002115parameter in a BOOTP request is used as a tag,
2116as is the tag "bootp", allowing some control over the options returned to
Simon Kelley3be34542004-09-11 19:12:13 +01002117different classes of hosts.
2118
Simon Kelley333b2ce2013-01-07 21:46:03 +00002119.SH AUTHORITATIVE CONFIGURATION
2120.PP
2121Configuring dnsmasq to act as an authoritative DNS server is
2122complicated by the fact that it involves configuration of external DNS
2123servers to provide delegation. We will walk through three scenarios of
2124increasing complexity. Prerequisites for all of these scenarios
Simon Kelley81925ab2013-04-10 11:43:58 +01002125are a globally accessible IP address, an A or AAAA record pointing to that address,
Simon Kelley333b2ce2013-01-07 21:46:03 +00002126and an external DNS server capable of doing delegation of the zone in
2127question. For the first part of this explanation, we will call the A (or AAAA) record
2128for the globally accessible address server.example.com, and the zone
2129for which dnsmasq is authoritative our.zone.com.
2130
2131The simplest configuration consists of two lines of dnsmasq configuration; something like
2132
2133.nf
2134.B auth-server=server.example.com,eth0
Simon Kelley79cb46c2013-01-23 19:49:21 +00002135.B auth-zone=our.zone.com,1.2.3.0/24
Simon Kelley333b2ce2013-01-07 21:46:03 +00002136.fi
2137
2138and two records in the external DNS
2139
2140.nf
2141server.example.com A 192.0.43.10
2142our.zone.com NS server.example.com
2143.fi
2144
2145eth0 is the external network interface on which dnsmasq is listening,
2146and has (globally accessible) address 192.0.43.10.
2147
2148Note that the external IP address may well be dynamic (ie assigned
2149from an ISP by DHCP or PPP) If so, the A record must be linked to this
2150dynamic assignment by one of the usual dynamic-DNS systems.
2151
2152A more complex, but practically useful configuration has the address
2153record for the globally accessible IP address residing in the
2154authoritative zone which dnsmasq is serving, typically at the root. Now
2155we have
2156
2157.nf
2158.B auth-server=our.zone.com,eth0
Simon Kelley79cb46c2013-01-23 19:49:21 +00002159.B auth-zone=our.zone.com,1.2.3.0/24
Simon Kelley333b2ce2013-01-07 21:46:03 +00002160.fi
2161
2162.nf
Simon Kelley0f128eb2013-03-11 21:21:35 +00002163our.zone.com A 1.2.3.4
Simon Kelley333b2ce2013-01-07 21:46:03 +00002164our.zone.com NS our.zone.com
2165.fi
2166
2167The A record for our.zone.com has now become a glue record, it solves
2168the chicken-and-egg problem of finding the IP address of the
2169nameserver for our.zone.com when the A record is within that
2170zone. Note that this is the only role of this record: as dnsmasq is
2171now authoritative from our.zone.com it too must provide this
2172record. If the external address is static, this can be done with an
2173.B /etc/hosts
2174entry or
2175.B --host-record.
Simon Kelley333b2ce2013-01-07 21:46:03 +00002176
2177.nf
Simon Kelley0f128eb2013-03-11 21:21:35 +00002178.B auth-server=our.zone.com,eth0
2179.B host-record=our.zone.com,1.2.3.4
2180.B auth-zone=our.zone.com,1.2.3.0/24
2181.fi
2182
2183If the external address is dynamic, the address
2184associated with our.zone.com must be derived from the address of the
Simon Kelley6f130de2013-04-15 14:47:14 +01002185relevant interface. This is done using
Simon Kelley0f128eb2013-03-11 21:21:35 +00002186.B interface-name
2187Something like:
2188
2189.nf
2190.B auth-server=our.zone.com,eth0
2191.B interface-name=our.zone.com,eth0
Simon Kelley32b4e4c2013-11-14 10:36:55 +00002192.B auth-zone=our.zone.com,1.2.3.0/24,eth0
Simon Kelley333b2ce2013-01-07 21:46:03 +00002193.fi
2194
Simon Kelley32b4e4c2013-11-14 10:36:55 +00002195(The "eth0" argument in auth-zone adds the subnet containing eth0's
2196dynamic address to the zone, so that the interface-name returns the
2197address in outside queries.)
2198
Simon Kelley333b2ce2013-01-07 21:46:03 +00002199Our final configuration builds on that above, but also adds a
2200secondary DNS server. This is another DNS server which learns the DNS data
2201for the zone by doing zones transfer, and acts as a backup should
2202the primary server become inaccessible. The configuration of the
2203secondary is beyond the scope of this man-page, but the extra
2204configuration of dnsmasq is simple:
2205
2206.nf
2207.B auth-sec-servers=secondary.myisp.com
2208.fi
2209
2210and
2211
2212.nf
2213our.zone.com NS secondary.myisp.com
2214.fi
2215
2216Adding auth-sec-servers enables zone transfer in dnsmasq, to allow the
2217secondary to collect the DNS data. If you wish to restrict this data
2218to particular hosts then
2219
2220.nf
2221.B auth-peer=<IP address of secondary>
2222.fi
2223
2224will do so.
2225
2226Dnsmasq acts as an authoritative server for in-addr.arpa and
Lutz Preßler1d7e0a32014-04-07 22:06:23 +01002227ip6.arpa domains associated with the subnets given in auth-zone
Simon Kelley333b2ce2013-01-07 21:46:03 +00002228declarations, so reverse (address to name) lookups can be simply
2229configured with a suitable NS record, for instance in this example,
2230where we allow 1.2.3.0/24 addresses.
2231
2232.nf
2233 3.2.1.in-addr.arpa NS our.zone.com
2234.fi
2235
2236Note that at present, reverse (in-addr.arpa and ip6.arpa) zones are
2237not available in zone transfers, so there is no point arranging
2238secondary servers for reverse lookups.
2239
2240.PP
2241When dnsmasq is configured to act as an authoritative server, the
2242following data is used to populate the authoritative zone.
2243.PP
2244.B --mx-host, --srv-host, --dns-rr, --txt-record, --naptr-record
2245, as long as the record names are in the authoritative domain.
2246.PP
2247.B --cname
2248as long as the record name is in the authoritative domain. If the
2249target of the CNAME is unqualified, then it is qualified with the
Simon Kelleyb637d782016-12-13 16:44:11 +00002250authoritative zone name. CNAME used in this way (only) may be wildcards, as in
2251
2252.nf
2253.B cname=*.example.com,default.example.com
2254.fi
2255
Simon Kelley333b2ce2013-01-07 21:46:03 +00002256.PP
2257IPv4 and IPv6 addresses from /etc/hosts (and
2258.B --addn-hosts
2259) and
2260.B --host-record
Simon Kelley376d48c2013-11-13 13:04:30 +00002261and
2262.B --interface-name
Simon Kelley333b2ce2013-01-07 21:46:03 +00002263provided the address falls into one of the subnets specified in the
2264.B --auth-zone.
2265.PP
Simon Kelley333b2ce2013-01-07 21:46:03 +00002266Addresses of DHCP leases, provided the address falls into one of the subnets specified in the
Simon Kelley376d48c2013-11-13 13:04:30 +00002267.B --auth-zone.
Josh Soref730c6742017-02-06 16:14:04 +00002268(If constructed DHCP ranges are is use, which depend on the address dynamically
Simon Kelley376d48c2013-11-13 13:04:30 +00002269assigned to an interface, then the form of
Simon Kelley333b2ce2013-01-07 21:46:03 +00002270.B --auth-zone
Simon Kelley376d48c2013-11-13 13:04:30 +00002271which defines subnets by the dynamic address of an interface should
2272be used to ensure this condition is met.)
2273.PP
2274In the default mode, where a DHCP lease
Simon Kelley333b2ce2013-01-07 21:46:03 +00002275has an unqualified name, and possibly a qualified name constructed
2276using
2277.B --domain
2278then the name in the authoritative zone is constructed from the
2279unqualified name and the zone's domain. This may or may not equal
2280that specified by
2281.B --domain.
2282If
2283.B --dhcp-fqdn
2284is set, then the fully qualified names associated with DHCP leases are
2285used, and must match the zone's domain.
2286
2287
2288
Simon Kelley5aabfc72007-08-29 11:24:47 +01002289.SH EXIT CODES
2290.PP
22910 - Dnsmasq successfully forked into the background, or terminated
2292normally if backgrounding is not enabled.
2293.PP
22941 - A problem with configuration was detected.
2295.PP
22962 - A problem with network access occurred (address in use, attempt
2297to use privileged ports without permission).
2298.PP
Simon Kelley9e038942008-05-30 20:06:34 +010022993 - A problem occurred with a filesystem operation (missing
Simon Kelley5aabfc72007-08-29 11:24:47 +01002300file/directory, permissions).
2301.PP
23024 - Memory allocation failure.
2303.PP
23045 - Other miscellaneous problem.
2305.PP
230611 or greater - a non zero return code was received from the
2307lease-script process "init" call. The exit code from dnsmasq is the
2308script's exit code with 10 added.
2309
Simon Kelley1b7ecd12007-02-05 14:57:57 +00002310.SH LIMITS
2311The default values for resource limits in dnsmasq are generally
2312conservative, and appropriate for embedded router type devices with
2313slow processors and limited memory. On more capable hardware, it is
2314possible to increase the limits, and handle many more clients. The
2315following applies to dnsmasq-2.37: earlier versions did not scale as well.
2316
2317.PP
2318Dnsmasq is capable of handling DNS and DHCP for at least a thousand
Simon Kelley8ef5ada2010-06-03 19:42:45 +01002319clients. The DHCP lease times should not be very short (less than one hour). The
Simon Kelley1b7ecd12007-02-05 14:57:57 +00002320value of
2321.B --dns-forward-max
2322can be increased: start with it equal to
2323the number of clients and increase if DNS seems slow. Note that DNS
2324performance depends too on the performance of the upstream
2325nameservers. The size of the DNS cache may be increased: the hard
2326limit is 10000 names and the default (150) is very low. Sending
2327SIGUSR1 to dnsmasq makes it log information which is useful for tuning
2328the cache size. See the
2329.B NOTES
2330section for details.
2331
2332.PP
2333The built-in TFTP server is capable of many simultaneous file
2334transfers: the absolute limit is related to the number of file-handles
2335allowed to a process and the ability of the select() system call to
2336cope with large numbers of file handles. If the limit is set too high
2337using
2338.B --tftp-max
2339it will be scaled down and the actual limit logged at
2340start-up. Note that more transfers are possible when the same file is
2341being sent than when each transfer sends a different file.
2342
2343.PP
2344It is possible to use dnsmasq to block Web advertising by using a list
2345of known banner-ad servers, all resolving to 127.0.0.1 or 0.0.0.0, in
2346.B /etc/hosts
2347or an additional hosts file. The list can be very long,
2348dnsmasq has been tested successfully with one million names. That size
2349file needs a 1GHz processor and about 60Mb of RAM.
2350
Simon Kelley1f15b812009-10-13 17:49:32 +01002351.SH INTERNATIONALISATION
2352Dnsmasq can be compiled to support internationalisation. To do this,
2353the make targets "all-i18n" and "install-i18n" should be used instead of
2354the standard targets "all" and "install". When internationalisation
2355is compiled in, dnsmasq will produce log messages in the local
2356language and support internationalised domain names (IDN). Domain
2357names in /etc/hosts, /etc/ethers and /etc/dnsmasq.conf which contain
2358non-ASCII characters will be translated to the DNS-internal punycode
2359representation. Note that
2360dnsmasq determines both the language for messages and the assumed
2361charset for configuration
2362files from the LANG environment variable. This should be set to the system
2363default value by the script which is responsible for starting
2364dnsmasq. When editing the configuration files, be careful to do so
2365using only the system-default locale and not user-specific one, since
2366dnsmasq has no direct way of determining the charset in use, and must
2367assume that it is the system default.
2368
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002369.SH FILES
Simon Kelleyb49644f2004-01-30 21:36:24 +00002370.IR /etc/dnsmasq.conf
2371
2372.IR /usr/local/etc/dnsmasq.conf
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002373
2374.IR /etc/resolv.conf
Simon Kelley28866e92011-02-14 20:19:14 +00002375.IR /var/run/dnsmasq/resolv.conf
2376.IR /etc/ppp/resolv.conf
2377.IR /etc/dhcpc/resolv.conf
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002378
2379.IR /etc/hosts
2380
Simon Kelley3be34542004-09-11 19:12:13 +01002381.IR /etc/ethers
2382
Simon Kelleyb49644f2004-01-30 21:36:24 +00002383.IR /var/lib/misc/dnsmasq.leases
2384
2385.IR /var/db/dnsmasq.leases
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002386
2387.IR /var/run/dnsmasq.pid
2388.SH SEE ALSO
Simon Kelley9e4abcb2004-01-22 19:47:41 +00002389.BR hosts (5),
2390.BR resolver (5)
2391.SH AUTHOR
2392This manual page was written by Simon Kelley <simon@thekelleys.org.uk>.
2393
2394