1 .TH "unbound-control" "8" "Mar 10, 2015" "NLnet Labs" "unbound 1.5.3"
3 .\" unbound-control.8 -- unbound remote control manual
5 .\" Copyright (c) 2008, NLnet Labs. All rights reserved.
7 .\" See LICENSE for the license.
12 .B unbound\-control\-setup
13 \- Unbound remote server control utility.
24 performs remote administration on the \fIunbound\fR(8) DNS server.
25 It reads the configuration file, contacts the unbound server over SSL
26 sends the command and displays the result.
28 The available options are:
31 Show the version and commandline option help.
34 The config file to read with settings. If not given the default
35 config file /var/unbound/unbound.conf is used.
37 .B \-s \fIserver[@port]
38 IPv4 or IPv6 address of the server to contact. If not given, the
39 address is read from the config file.
42 quiet, if the option is given it does not print anything if it works ok.
44 There are several commands that the server understands.
47 Start the server. Simply execs \fIunbound\fR(8). The unbound executable
48 is searched for in the \fBPATH\fR set in the environment. It is started
49 with the config file specified using \fI\-c\fR or the default config file.
52 Stop the server. The server daemon exits.
55 Reload the server. This flushes the cache and reads the config file fresh.
57 .B verbosity \fInumber
58 Change verbosity value for logging. Same values as \fBverbosity\fR keyword in
59 \fIunbound.conf\fR(5). This new setting lasts until the server is issued
60 a reload (taken from config file again), or the next verbosity control command.
63 Reopen the logfile, close and open it. Useful for logrotation to make the
64 daemon release the file it is logging to. If you are using syslog it will
65 attempt to close and open the syslog (which may not work if chrooted).
68 Print statistics. Resets the internal counters to zero, this can be
69 controlled using the \fBstatistics\-cumulative\fR config statement.
70 Statistics are printed with one [name]: [value] per line.
73 Peek at statistics. Prints them like the \fBstats\fR command does, but does not
74 reset the internal counters to zero.
77 Display server status. Exit code 3 if not running (the connection to the
78 port is refused), 1 on error, 0 if running.
80 .B local_zone \fIname\fR \fItype
81 Add new local zone with name and type. Like \fBlocal\-zone\fR config statement.
82 If the zone already exists, the type is changed to the given argument.
84 .B local_zone_remove \fIname
85 Remove the local zone with the given name. Removes all local data inside
86 it. If the zone does not exist, the command succeeds.
88 .B local_data \fIRR data...
89 Add new local data, the given resource record. Like \fBlocal\-data\fR
90 config statement, except for when no covering zone exists. In that case
91 this remote control command creates a transparent zone with the same
92 name as this record. This command is not good at returning detailed syntax
95 .B local_data_remove \fIname
96 Remove all RR data from local name. If the name already has no items,
97 nothing happens. Often results in NXDOMAIN for the name (in a static zone),
98 but if the name has become an empty nonterminal (there is still data in
99 domain names below the removed name), NOERROR nodata answers are the
100 result for that name.
103 The contents of the cache is printed in a text format to stdout. You can
104 redirect it to a file to store the cache in a file.
107 The contents of the cache is loaded from stdin. Uses the same format as
108 dump_cache uses. Loading the cache with old, or wrong data can result
109 in old or wrong data returned to clients. Loading data into the cache
110 in this way is supported in order to aid with debugging.
113 Print to stdout the name servers that would be used to look up the
117 Remove the name from the cache. Removes the types
118 A, AAAA, NS, SOA, CNAME, DNAME, MX, PTR, SRV and NAPTR.
119 Because that is fast to do. Other record types can be removed using
124 .B flush_type \fIname\fR \fItype
125 Remove the name, type information from the cache.
127 .B flush_zone \fIname
128 Remove all information at or below the name from the cache.
129 The rrsets and key entries are removed so that new lookups will be performed.
130 This needs to walk and inspect the entire cache, and is a slow operation.
133 Remove all bogus data from the cache.
136 Remove all negative data from the cache. This is nxdomain answers,
137 nodata answers and servfail answers. Also removes bad key entries
138 (which could be due to failed lookups) from the dnssec key cache, and
139 iterator last-resort lookup failures from the rrset cache.
142 Reset statistics to zero.
145 Drop the queries that are worked on. Stops working on the queries that the
146 server is working on now. The cache is unaffected. No reply is sent for
147 those queries, probably making those users request again later.
148 Useful to make the server restart working on queries with new settings,
149 such as a higher verbosity level.
152 Show what is worked on. Prints all queries that the server is currently
153 working on. Prints the time that users have been waiting. For internal
154 requests, no time is printed. And then prints out the module status.
155 This prints the queries from the first thread, and not queries that are
156 being serviced from other threads.
158 .B flush_infra \fIall|IP
159 If all then entire infra cache is emptied. If a specific IP address, the
160 entry for that address is removed from the cache. It contains EDNS, ping
164 Show the contents of the infra cache.
166 .B set_option \fIopt: val
167 Set the option to the given value without a reload. The cache is
168 therefore not flushed. The option must end with a ':' and whitespace
169 must be between the option and the value. Some values may not have an
170 effect if set this way, the new values are not written to the config file,
171 not all options are supported. This is different from the set_option call
172 in libunbound, where all values work because unbound has not been inited.
174 The values that work are: statistics\-interval, statistics\-cumulative,
175 do\-not\-query\-localhost, harden\-short\-bufsize, harden\-large\-queries,
176 harden\-glue, harden\-dnssec\-stripped, harden\-below\-nxdomain,
177 harden\-referral\-path, prefetch, prefetch\-key, log\-queries,
178 hide\-identity, hide\-version, identity, version, val\-log\-level,
179 val\-log\-squelch, ignore\-cd\-flag, add\-holddown, del\-holddown,
180 keep\-missing, tcp\-upstream, ssl\-upstream, max\-udp\-size.
183 Get the value of the option. Give the option name without a trailing ':'.
184 The value is printed. If the value is "", nothing is printed
185 and the connection closes. On error 'error ...' is printed (it gives
186 a syntax error on unknown option). For some options a list of values,
187 one on each line, is printed. The options are shown from the config file
188 as modified with set_option. For some options an override may have been
189 taken that does not show up with this command, not results from e.g. the
190 verbosity and forward control commands. Not all options work, see list_stubs,
191 list_forwards, list_local_zones and list_local_data for those.
194 List the stub zones in use. These are printed one by one to the output.
195 This includes the root hints in use.
198 List the forward zones in use. These are printed zone by zone to the output.
201 List the local zones in use. These are printed one per line with zone type.
204 List the local data RRs in use. The resource records are printed.
206 .B insecure_add \fIzone
207 Add a \fBdomain\-insecure\fR for the given zone, like the statement in unbound.conf.
208 Adds to the running unbound without affecting the cache contents (which may
209 still be bogus, use \fBflush_zone\fR to remove it), does not affect the config file.
211 .B insecure_remove \fIzone
212 Removes domain\-insecure for the given zone.
214 .B forward_add \fR[\fI+i\fR] \fIzone addr ...
215 Add a new forward zone to running unbound. With +i option also adds a
216 \fIdomain\-insecure\fR for the zone (so it can resolve insecurely if you have
217 a DNSSEC root trust anchor configured for other names).
218 The addr can be IP4, IP6 or nameserver names, like \fIforward-zone\fR config
221 .B forward_remove \fR[\fI+i\fR] \fIzone
222 Remove a forward zone from running unbound. The +i also removes a
223 \fIdomain\-insecure\fR for the zone.
225 .B stub_add \fR[\fI+ip\fR] \fIzone addr ...
226 Add a new stub zone to running unbound. With +i option also adds a
227 \fIdomain\-insecure\fR for the zone. With +p the stub zone is set to prime,
228 without it it is set to notprime. The addr can be IP4, IP6 or nameserver
229 names, like the \fIstub-zone\fR config in unbound.conf.
231 .B stub_remove \fR[\fI+i\fR] \fIzone
232 Remove a stub zone from running unbound. The +i also removes a
233 \fIdomain\-insecure\fR for the zone.
235 .B forward \fR[\fIoff\fR | \fIaddr ...\fR ]
236 Setup forwarding mode. Configures if the server should ask other upstream
237 nameservers, should go to the internet root nameservers itself, or show
238 the current config. You could pass the nameservers after a DHCP update.
240 Without arguments the current list of addresses used to forward all queries
241 to is printed. On startup this is from the forward\-zone "." configuration.
242 Afterwards it shows the status. It prints off when no forwarding is used.
244 If \fIoff\fR is passed, forwarding is disabled and the root nameservers
245 are used. This can be used to avoid to avoid buggy or non\-DNSSEC supporting
246 nameservers returned from DHCP. But may not work in hotels or hotspots.
248 If one or more IPv4 or IPv6 addresses are given, those are then used to forward
249 queries to. The addresses must be separated with spaces. With '@port' the
250 port number can be set explicitly (default port is 53 (DNS)).
252 By default the forwarder information from the config file for the root "." is
253 used. The config file is not changed, so after a reload these changes are
254 gone. Other forward zones from the config file are not affected by this command.
256 The unbound\-control program exits with status code 1 on error, 0 on success.
258 The setup requires a self\-signed certificate and private keys for both
259 the server and client. The script \fIunbound\-control\-setup\fR generates
260 these in the default run directory, or with \-d in another directory.
261 If you change the access control permissions on the key files you can decide
262 who can use unbound\-control, by default owner and group but not all users.
263 Run the script under the same username as you have configured in unbound.conf
264 or as root, so that the daemon is permitted to read the files, for example with:
266 sudo \-u unbound unbound\-control\-setup
268 If you have not configured
269 a username in unbound.conf, the keys need read permission for the user
270 credentials under which the daemon is started.
271 The script preserves private keys present in the directory.
272 After running the script as root, turn on \fBcontrol\-enable\fR in
274 .SH "STATISTIC COUNTERS"
275 The \fIstats\fR command shows a number of statistic counters.
277 .I threadX.num.queries
278 number of queries received by thread
280 .I threadX.num.cachehits
281 number of queries that were successfully answered using a cache lookup
283 .I threadX.num.cachemiss
284 number of queries that needed recursive processing
286 .I threadX.num.prefetch
287 number of cache prefetches performed. This number is included in
288 cachehits, as the original query had the unprefetched answer from cache,
289 and resulted in recursive processing, taking a slot in the requestlist.
290 Not part of the recursivereplies (or the histogram thereof) or cachemiss,
291 as a cache response was sent.
293 .I threadX.num.recursivereplies
294 The number of replies sent to queries that needed recursive processing. Could be smaller than threadX.num.cachemiss if due to timeouts no replies were sent for some queries.
296 .I threadX.requestlist.avg
297 The average number of requests in the internal recursive processing request list on insert of a new incoming recursive processing query.
299 .I threadX.requestlist.max
300 Maximum size attained by the internal recursive processing request list.
302 .I threadX.requestlist.overwritten
303 Number of requests in the request list that were overwritten by newer entries. This happens if there is a flood of queries that recursive processing and the server has a hard time.
305 .I threadX.requestlist.exceeded
306 Queries that were dropped because the request list was full. This happens if a flood of queries need recursive processing, and the server can not keep up.
308 .I threadX.requestlist.current.all
309 Current size of the request list, includes internally generated queries (such
310 as priming queries and glue lookups).
312 .I threadX.requestlist.current.user
313 Current size of the request list, only the requests from client queries.
315 .I threadX.recursion.time.avg
316 Average time it took to answer queries that needed recursive processing. Note that queries that were answered from the cache are not in this average.
318 .I threadX.recursion.time.median
319 The median of the time it took to answer queries that needed recursive
320 processing. The median means that 50% of the user queries were answered in
321 less than this time. Because of big outliers (usually queries to non
322 responsive servers), the average can be bigger than the median. This median
323 has been calculated by interpolation from a histogram.
328 .I total.num.cachehits
331 .I total.num.cachemiss
334 .I total.num.prefetch
337 .I total.num.recursivereplies
340 .I total.requestlist.avg
341 averaged over threads.
343 .I total.requestlist.max
344 the maximum of the thread requestlist.max values.
346 .I total.requestlist.overwritten
349 .I total.requestlist.exceeded
352 .I total.requestlist.current.all
355 .I total.recursion.time.median
356 averaged over threads.
359 current time in seconds since 1970.
362 uptime since server boot in seconds.
365 time since last statistics printout, in seconds.
366 .SH EXTENDED STATISTICS
369 If sbrk(2) is available, an estimate of the heap size of the program in number of bytes. Close to the total memory used by the program, as reported by top and ps. Could be wrong if the OS allocates memory non\-contiguously.
372 Memory in bytes in use by the RRset cache.
375 Memory in bytes in use by the message cache.
378 Memory in bytes in use by the iterator module.
381 Memory in bytes in use by the validator module. Includes the key cache and
384 .I histogram.<sec>.<usec>.to.<sec>.<usec>
385 Shows a histogram, summed over all threads. Every element counts the
386 recursive queries whose reply time fit between the lower and upper bound.
387 Times larger or equal to the lowerbound, and smaller than the upper bound.
388 There are 40 buckets, with bucket sizes doubling.
391 The total number of queries over all threads with query type A.
392 Printed for the other query types as well, but only for the types for which
393 queries were received, thus =0 entries are omitted for brevity.
395 .I num.query.type.other
396 Number of queries with query types 256\-65535.
398 .I num.query.class.IN
399 The total number of queries over all threads with query class IN (internet).
400 Also printed for other classes (such as CH (CHAOS) sometimes used for
401 debugging), or NONE, ANY, used by dynamic update.
402 num.query.class.other is printed for classes 256\-65535.
404 .I num.query.opcode.QUERY
405 The total number of queries over all threads with query opcode QUERY.
406 Also printed for other opcodes, UPDATE, ...
409 Number of queries that were made using TCP towards the unbound server.
412 Number of queries that the unbound server made using TCP outgoing towards
416 Number of queries that were made using IPv6 towards the unbound server.
418 .I num.query.flags.RD
419 The number of queries that had the RD flag set in the header.
420 Also printed for flags QR, AA, TC, RA, Z, AD, CD.
421 Note that queries with flags QR, AA or TC may have been rejected
424 .I num.query.edns.present
425 number of queries that had an EDNS OPT record present.
428 number of queries that had an EDNS OPT record with the DO (DNSSEC OK) bit set.
429 These queries are also included in the num.query.edns.present number.
431 .I num.answer.rcode.NXDOMAIN
432 The number of answers to queries, from cache or from recursion, that had the
433 return code NXDOMAIN. Also printed for the other return codes.
435 .I num.answer.rcode.nodata
436 The number of answers to queries that had the pseudo return code nodata.
437 This means the actual return code was NOERROR, but additionally, no data was
438 carried in the answer (making what is called a NOERROR/NODATA answer).
439 These queries are also included in the num.answer.rcode.NOERROR number.
440 Common for AAAA lookups when an A record exists, and no AAAA.
443 Number of answers that were secure. The answer validated correctly.
444 The AD bit might have been set in some of these answers, where the client
445 signalled (with DO or AD bit in the query) that they were ready to accept
446 the AD bit in the answer.
449 Number of answers that were bogus. These answers resulted in SERVFAIL
450 to the client because the answer failed validation.
453 The number of rrsets marked bogus by the validator. Increased for every
454 RRset inspection that fails.
457 Number of queries that were refused or dropped because they failed the
458 access control settings.
461 Replies that were unwanted or unsolicited. Could have been random traffic,
462 delayed duplicates, very late answers, or could be spoofing attempts.
463 Some low level of late answers and delayed duplicates are to be expected
464 with the UDP protocol. Very high values could indicate a threat (spoofing).
467 The number of items (DNS replies) in the message cache.
470 The number of RRsets in the rrset cache. This includes rrsets used by
471 the messages in the message cache, but also delegation information.
474 The number of items in the infra cache. These are IP addresses with their
475 timing and protocol support information.
478 The number of items in the key cache. These are DNSSEC keys, one item
479 per delegation point, and their validation status.
482 .I /var/unbound/unbound.conf
483 unbound configuration file.
486 directory with private keys (unbound_server.key and unbound_control.key) and
487 self\-signed certificates (unbound_server.pem and unbound_control.pem).
489 \fIunbound.conf\fR(5),
projects / FreeBSD / releng / 10.2.git / blob