1unbound-control(8)              unbound 1.19.0              unbound-control(8)
2
3
4

NAME

6       unbound-control,  unbound-control-setup - Unbound remote server control
7       utility.
8

SYNOPSIS

10       unbound-control [-hq] [-c cfgfile] [-s server] command
11

DESCRIPTION

13       Unbound-control performs remote administration on  the  unbound(8)  DNS
14       server.   It  reads the configuration file, contacts the Unbound server
15       over SSL sends the command and displays the result.
16
17       The available options are:
18
19       -h     Show the version and commandline option help.
20
21       -c cfgfile
22              The config file to read with settings.  If not given the default
23              config file /etc/unbound/unbound.conf is used.
24
25       -s server[@port]
26              IPv4  or  IPv6  address of the server to contact.  If not given,
27              the address is read from the config file.
28
29       -q     quiet, if the option is given it does not print anything  if  it
30              works ok.
31

COMMANDS

33       There are several commands that the server understands.
34
35       start  Start  the  server.  Simply  execs unbound(8).  The Unbound exe‐
36              cutable is searched for in the PATH set in the environment.   It
37              is  started  with  the config file specified using -c or the de‐
38              fault config file.
39
40       stop   Stop the server. The server daemon exits.
41
42       reload Reload the server. This flushes the cache and reads  the  config
43              file fresh.
44
45       reload_keep_cache
46              Reload the server but try to keep the RRset and message cache if
47              (re)configuration allows for it.  That means  the  caches  sizes
48              and the number of threads must not change between reloads.
49
50       verbosity number
51              Change  verbosity  value  for  logging. Same values as verbosity
52              keyword in unbound.conf(5).  This new setting  lasts  until  the
53              server is issued a reload (taken from config file again), or the
54              next verbosity control command.
55
56       log_reopen
57              Reopen the logfile, close and open it.  Useful  for  logrotation
58              to  make  the  daemon release the file it is logging to.  If you
59              are using syslog it will attempt to close and  open  the  syslog
60              (which may not work if chrooted).
61
62       stats  Print statistics. Resets the internal counters to zero, this can
63              be controlled using the statistics-cumulative config  statement.
64              Statistics are printed with one [name]: [value] per line.
65
66       stats_noreset
67              Peek at statistics. Prints them like the stats command does, but
68              does not reset the internal counters to zero.
69
70       status Display server status. Exit code 3 if not running  (the  connec‐
71              tion to the port is refused), 1 on error, 0 if running.
72
73       local_zone name type
74              Add  new  local  zone with name and type. Like local-zone config
75              statement.  If the zone already exists, the type is  changed  to
76              the given argument.
77
78       local_zone_remove name
79              Remove  the  local  zone with the given name.  Removes all local
80              data inside it.  If the zone does not exist,  the  command  suc‐
81              ceeds.
82
83       local_data RR data...
84              Add  new  local data, the given resource record. Like local-data
85              config statement, except for when no covering zone  exists.   In
86              that case this remote control command creates a transparent zone
87              with the same name as this record.
88
89       local_data_remove name
90              Remove all RR data from local name.  If the name already has  no
91              items,  nothing happens.  Often results in NXDOMAIN for the name
92              (in a static zone), but if the name has become an empty  nonter‐
93              minal  (there  is  still  data in domain names below the removed
94              name), NOERROR nodata answers are the result for that name.
95
96       local_zones
97              Add local zones read from stdin  of  unbound-control.  Input  is
98              read  per  line,  with name space type on a line. For bulk addi‐
99              tions.
100
101       local_zones_remove
102              Remove local zones read from stdin of unbound-control. Input  is
103              one name per line. For bulk removals.
104
105       local_datas
106              Add  local data RRs read from stdin of unbound-control. Input is
107              one RR per line. For bulk additions.
108
109       local_datas_remove
110              Remove local data RRs read from stdin of unbound-control.  Input
111              is one name per line. For bulk removals.
112
113       dump_cache
114              The contents of the cache is printed in a text format to stdout.
115              You can redirect it to a file to store the cache in a file.
116
117       load_cache
118              The contents of the cache is loaded from stdin.  Uses  the  same
119              format as dump_cache uses.  Loading the cache with old, or wrong
120              data can result in old or wrong data returned to clients.  Load‐
121              ing data into the cache in this way is supported in order to aid
122              with debugging.
123
124       lookup name
125              Print to stdout the name servers that would be used to  look  up
126              the name specified.
127
128       flush name
129              Remove  the  name from the cache. Removes the types A, AAAA, NS,
130              SOA, CNAME, DNAME, MX, PTR, SRV, NAPTR, SVCB and HTTPS.  Because
131              that  is  fast  to  do.  Other record types can be removed using
132              flush_type or flush_zone.
133
134       flush_type name type
135              Remove the name, type information from the cache.
136
137       flush_zone name
138              Remove all information at or below the name from the cache.  The
139              rrsets  and  key entries are removed so that new lookups will be
140              performed.  This needs to walk and inspect the entire cache, and
141              is  a slow operation.  The entries are set to expired in the im‐
142              plementation of this command (so,  with  serve-expired  enabled,
143              it'll serve that information but schedule a prefetch for new in‐
144              formation).
145
146       flush_bogus
147              Remove all bogus data from the cache.
148
149       flush_negative
150              Remove all negative data from the cache.  This is  nxdomain  an‐
151              swers,  nodata  answers  and servfail answers.  Also removes bad
152              key entries (which could be due  to  failed  lookups)  from  the
153              dnssec  key cache, and iterator last-resort lookup failures from
154              the rrset cache.
155
156       flush_stats
157              Reset statistics to zero.
158
159       flush_requestlist
160              Drop the queries that are  worked  on.   Stops  working  on  the
161              queries  that  the server is working on now.  The cache is unaf‐
162              fected.  No reply is sent for  those  queries,  probably  making
163              those  users  request  again  later.   Useful to make the server
164              restart working on queries with new settings, such as  a  higher
165              verbosity level.
166
167       dump_requestlist
168              Show  what  is worked on.  Prints all queries that the server is
169              currently working on.  Prints the  time  that  users  have  been
170              waiting.   For  internal requests, no time is printed.  And then
171              prints out the module status.  This prints the queries from  the
172              first thread, and not queries that are being serviced from other
173              threads.
174
175       flush_infra all|IP
176              If all then entire infra cache is emptied.  If a specific IP ad‐
177              dress, the entry for that address is removed from the cache.  It
178              contains EDNS, ping and lameness data.
179
180       dump_infra
181              Show the contents of the infra cache.
182
183       set_option opt: val
184              Set the option to the given value without a reload.   The  cache
185              is  therefore  not  flushed.  The option must end with a ':' and
186              whitespace must be between the option and the value.  Some  val‐
187              ues  may  not have an effect if set this way, the new values are
188              not written to the config file, not all options  are  supported.
189              This  is different from the set_option call in libunbound, where
190              all values work because Unbound has not been initialized.
191
192              The values that work are: statistics-interval,  statistics-cumu‐
193              lative,       do-not-query-localhost,      harden-short-bufsize,
194              harden-large-queries,    harden-glue,    harden-dnssec-stripped,
195              harden-below-nxdomain,      harden-referral-path,      prefetch,
196              prefetch-key, log-queries,  hide-identity,  hide-version,  iden‐
197              tity,  version,  val-log-level, val-log-squelch, ignore-cd-flag,
198              add-holddown, del-holddown, keep-missing, tcp-upstream,  ssl-up‐
199              stream,  max-udp-size,  ratelimit,  ip-ratelimit, cache-max-ttl,
200              cache-min-ttl, cache-max-negative-ttl.
201
202       get_option opt
203              Get the value of the option.  Give the  option  name  without  a
204              trailing  ':'.  The value is printed.  If the value is "", noth‐
205              ing is printed and the connection closes.  On error 'error  ...'
206              is  printed  (it  gives  a syntax error on unknown option).  For
207              some options a list of values, one on  each  line,  is  printed.
208              The  options  are  shown  from  the config file as modified with
209              set_option.  For some options an override may  have  been  taken
210              that  does  not show up with this command, not results from e.g.
211              the verbosity and forward control  commands.   Not  all  options
212              work,   see   list_stubs,  list_forwards,  list_local_zones  and
213              list_local_data for those.
214
215       list_stubs
216              List the stub zones in use.  These are printed one by one to the
217              output.  This includes the root hints in use.
218
219       list_forwards
220              List  the  forward zones in use.  These are printed zone by zone
221              to the output.
222
223       list_insecure
224              List the zones with domain-insecure.
225
226       list_local_zones
227              List the local zones in use.  These are  printed  one  per  line
228              with zone type.
229
230       list_local_data
231              List  the  local  data  RRs  in  use.   The resource records are
232              printed.
233
234       insecure_add zone
235              Add a domain-insecure for the given zone, like the statement  in
236              unbound.conf.  Adds to the running Unbound without affecting the
237              cache contents (which may still be bogus, use flush_zone to  re‐
238              move it), does not affect the config file.
239
240       insecure_remove zone
241              Removes domain-insecure for the given zone.
242
243       forward_add [+i] zone addr ...
244              Add  a new forward zone to running Unbound.  With +i option also
245              adds a domain-insecure for the zone (so  it  can  resolve  inse‐
246              curely  if  you  have  a DNSSEC root trust anchor configured for
247              other names).  The addr can be IP4,  IP6  or  nameserver  names,
248              like forward-zone config in unbound.conf.
249
250       forward_remove [+i] zone
251              Remove a forward zone from running Unbound.  The +i also removes
252              a domain-insecure for the zone.
253
254       stub_add [+ip] zone addr ...
255              Add a new stub zone to running Unbound.   With  +i  option  also
256              adds  a  domain-insecure for the zone.  With +p the stub zone is
257              set to prime, without it it is set to notprime.  The addr can be
258              IP4,  IP6  or nameserver names, like the stub-zone config in un‐
259              bound.conf.
260
261       stub_remove [+i] zone
262              Remove a stub zone from running Unbound.  The +i also removes  a
263              domain-insecure for the zone.
264
265       forward [off | addr ... ]
266              Setup  forwarding  mode.   Configures  if  the server should ask
267              other upstream nameservers, should go to the internet root name‐
268              servers  itself, or show the current config.  You could pass the
269              nameservers after a DHCP update.
270
271              Without arguments the current list of addresses used to  forward
272              all  queries  to  is  printed.  On startup this is from the for‐
273              ward-zone "." configuration.  Afterwards it  shows  the  status.
274              It prints off when no forwarding is used.
275
276              If  off  is  passed,  forwarding  is disabled and the root name‐
277              servers are used.  This can be used to avoid to avoid  buggy  or
278              non-DNSSEC  supporting  nameservers returned from DHCP.  But may
279              not work in hotels or hotspots.
280
281              If one or more IPv4 or IPv6 addresses are given, those are  then
282              used  to  forward  queries  to.  The addresses must be separated
283              with spaces.  With '@port' the port number can be set explicitly
284              (default port is 53 (DNS)).
285
286              By  default  the  forwarder information from the config file for
287              the root "." is used.  The config file is not changed, so  after
288              a  reload  these changes are gone.  Other forward zones from the
289              config file are not affected by this command.
290
291       ratelimit_list [+a]
292              List the domains that are ratelimited.   Printed  one  per  line
293              with  current  estimated qps and qps limit from config.  With +a
294              it prints all domains, not just the  ratelimited  domains,  with
295              their  estimated  qps.   The ratelimited domains return an error
296              for uncached (new) queries, but cached queries work as normal.
297
298       ip_ratelimit_list [+a]
299              List the ip addresses that are  ratelimited.   Printed  one  per
300              line with current estimated qps and qps limit from config.  With
301              +a it prints all ips, not just the ratelimited ips,  with  their
302              estimated  qps.  The ratelimited ips are dropped before checking
303              the cache.
304
305       list_auth_zones
306              List the auth zones that are configured.  Printed one  per  line
307              with a status, indicating if the zone is expired and current se‐
308              rial number.  Configured RPZ zones are included.
309
310       auth_zone_reload zone
311              Reload the auth zone (or RPZ zone) from zonefile.  The  zonefile
312              is  read in overwriting the current contents of the zone in mem‐
313              ory.  This changes the auth zone contents itself, not the  cache
314              contents.  Such cache contents exists if you set Unbound to val‐
315              idate with  for-upstream  yes  and  that  can  be  cleared  with
316              flush_zone zone.
317
318       auth_zone_transfer zone
319              Transfer the auth zone (or RPZ zone) from master.  The auth zone
320              probe sequence is started, where the masters are probed  to  see
321              if  they  have an updated zone (with the SOA serial check).  And
322              then the zone is transferred for a newer zone version.
323
324       rpz_enable zone
325              Enable the RPZ zone if it had previously been disabled.
326
327       rpz_disable zone
328              Disable the RPZ zone.
329
330       view_list_local_zones view
331              list_local_zones for given view.
332
333       view_local_zone view name type
334              local_zone for given view.
335
336       view_local_zone_remove view name
337              local_zone_remove for given view.
338
339       view_list_local_data view
340              list_local_data for given view.
341
342       view_local_data view RR data...
343              local_data for given view.
344
345       view_local_data_remove view name
346              local_data_remove for given view.
347
348       view_local_datas_remove view
349              Remove a list of local_data for given view from stdin. Like  lo‐
350              cal_datas_remove.
351
352       view_local_datas view
353              Add  a  list  of local_data for given view from stdin.  Like lo‐
354              cal_datas.
355

EXIT CODE

357       The unbound-control program exits with status code 1  on  error,  0  on
358       success.
359

SET UP

361       The  setup requires a self-signed certificate and private keys for both
362       the server and  client.   The  script  unbound-control-setup  generates
363       these  in  the  default run directory, or with -d in another directory.
364       If you change the access control permissions on the key files  you  can
365       decide  who can use unbound-control, by default owner and group but not
366       all users.  Run the script under the same username as you have  config‐
367       ured  in  unbound.conf  or  as root, so that the daemon is permitted to
368       read the files, for example with:
369           sudo -u unbound unbound-control-setup
370       If you have not configured a username in unbound.conf,  the  keys  need
371       read  permission  for  the  user  credentials under which the daemon is
372       started.  The script preserves private keys present in  the  directory.
373       After  running  the  script  as  root,  turn  on  control-enable in un‐
374       bound.conf.
375

STATISTIC COUNTERS

377       The stats command shows a number of statistic counters.
378
379       threadX.num.queries
380              number of queries received by thread
381
382       threadX.num.queries_ip_ratelimited
383              number of queries rate limited by thread
384
385       threadX.num.queries_cookie_valid
386              number of queries with a valid DNS Cookie by thread
387
388       threadX.num.queries_cookie_client
389              number of queries with a client part only DNS Cookie by thread
390
391       threadX.num.queries_cookie_invalid
392              number of queries with an invalid DNS Cookie by thread
393
394       threadX.num.cachehits
395              number of queries that were successfully answered using a  cache
396              lookup
397
398       threadX.num.cachemiss
399              number of queries that needed recursive processing
400
401       threadX.num.dnscrypt.crypted
402              number  of queries that were encrypted and successfully decapsu‐
403              lated by dnscrypt.
404
405       threadX.num.dnscrypt.cert
406              number of queries that were requesting dnscrypt certificates.
407
408       threadX.num.dnscrypt.cleartext
409              number of queries received on dnscrypt port that were  cleartext
410              and not a request for certificates.
411
412       threadX.num.dnscrypt.malformed
413              number  of  request  that  were  neither  cleartext,  not  valid
414              dnscrypt messages.
415
416       threadX.num.prefetch
417              number of cache prefetches performed.  This number  is  included
418              in  cachehits, as the original query had the unprefetched answer
419              from cache, and resulted in recursive processing, taking a  slot
420              in  the  requestlist.   Not part of the recursivereplies (or the
421              histogram thereof) or cachemiss, as a cache response was sent.
422
423       threadX.num.expired
424              number of replies that served an expired cache entry.
425
426       threadX.num.queries_timed_out
427              number of queries that are dropped because they  waited  in  the
428              UDP socket buffer for too long.
429
430       threadX.query.queue_time_us.max
431              The  maximum  wait time for packets in the socket buffer, in mi‐
432              croseconds. This is only reported when sock-queue-timeout is en‐
433              abled.
434
435       threadX.num.recursivereplies
436              The number of replies sent to queries that needed recursive pro‐
437              cessing. Could be smaller than threadX.num.cachemiss if  due  to
438              timeouts no replies were sent for some queries.
439
440       threadX.requestlist.avg
441              The  average  number  of requests in the internal recursive pro‐
442              cessing request list on insert of a new incoming recursive  pro‐
443              cessing query.
444
445       threadX.requestlist.max
446              Maximum  size  attained by the internal recursive processing re‐
447              quest list.
448
449       threadX.requestlist.overwritten
450              Number of requests in the request list that were overwritten  by
451              newer  entries. This happens if there is a flood of queries that
452              recursive processing and the server has a hard time.
453
454       threadX.requestlist.exceeded
455              Queries that were dropped because the  request  list  was  full.
456              This  happens  if  a flood of queries need recursive processing,
457              and the server can not keep up.
458
459       threadX.requestlist.current.all
460              Current size of the request list, includes internally  generated
461              queries (such as priming queries and glue lookups).
462
463       threadX.requestlist.current.user
464              Current  size of the request list, only the requests from client
465              queries.
466
467       threadX.recursion.time.avg
468              Average time it took to answer  queries  that  needed  recursive
469              processing.  Note that queries that were answered from the cache
470              are not in this average.
471
472       threadX.recursion.time.median
473              The median of the time it took to answer queries that needed re‐
474              cursive  processing.   The  median  means  that  50% of the user
475              queries were answered in less than this time.   Because  of  big
476              outliers  (usually queries to non responsive servers), the aver‐
477              age can be bigger than the median.  This median has been  calcu‐
478              lated by interpolation from a histogram.
479
480       threadX.tcpusage
481              The currently held tcp buffers for incoming connections.  A spot
482              value on the time of the request.  This helps you  spot  if  the
483              incoming-num-tcp buffers are full.
484
485       total.num.queries
486              summed over threads.
487
488       total.num.queries_ip_ratelimited
489              summed over threads.
490
491       total.num.queries_cookie_valid
492              summed over threads.
493
494       total.num.queries_cookie_client
495              summed over threads.
496
497       total.num.queries_cookie_invalid
498              summed over threads.
499
500       total.num.cachehits
501              summed over threads.
502
503       total.num.cachemiss
504              summed over threads.
505
506       total.num.dnscrypt.crypted
507              summed over threads.
508
509       total.num.dnscrypt.cert
510              summed over threads.
511
512       total.num.dnscrypt.cleartext
513              summed over threads.
514
515       total.num.dnscrypt.malformed
516              summed over threads.
517
518       total.num.prefetch
519              summed over threads.
520
521       total.num.expired
522              summed over threads.
523
524       total.num.queries_timed_out
525              summed over threads.
526
527       total.query.queue_time_us.max
528              the maximum of the thread values.
529
530       total.num.recursivereplies
531              summed over threads.
532
533       total.requestlist.avg
534              averaged over threads.
535
536       total.requestlist.max
537              the maximum of the thread requestlist.max values.
538
539       total.requestlist.overwritten
540              summed over threads.
541
542       total.requestlist.exceeded
543              summed over threads.
544
545       total.requestlist.current.all
546              summed over threads.
547
548       total.recursion.time.median
549              averaged over threads.
550
551       total.tcpusage
552              summed over threads.
553
554       time.now
555              current time in seconds since 1970.
556
557       time.up
558              uptime since server boot in seconds.
559
560       time.elapsed
561              time since last statistics printout, in seconds.
562

EXTENDED STATISTICS

564       mem.cache.rrset
565              Memory in bytes in use by the RRset cache.
566
567       mem.cache.message
568              Memory in bytes in use by the message cache.
569
570       mem.cache.dnscrypt_shared_secret
571              Memory in bytes in use by the dnscrypt shared secrets cache.
572
573       mem.cache.dnscrypt_nonce
574              Memory in bytes in use by the dnscrypt nonce cache.
575
576       mem.mod.iterator
577              Memory in bytes in use by the iterator module.
578
579       mem.mod.validator
580              Memory in bytes in use by the validator module. Includes the key
581              cache and negative cache.
582
583       mem.streamwait
584              Memory in bytes in used by the TCP and TLS stream wait  buffers.
585              These are answers waiting to be written back to the clients.
586
587       mem.http.query_buffer
588              Memory  in  bytes  used  by the HTTP/2 query buffers. Containing
589              (partial) DNS queries waiting for request stream completion.
590
591       mem.http.response_buffer
592              Memory in bytes used by the HTTP/2 response buffers.  Containing
593              DNS responses waiting to be written back to the clients.
594
595       histogram.<sec>.<usec>.to.<sec>.<usec>
596              Shows a histogram, summed over all threads. Every element counts
597              the recursive queries whose reply time fit between the lower and
598              upper  bound.   Times  larger  or  equal  to the lowerbound, and
599              smaller than the upper bound.  There are 40 buckets, with bucket
600              sizes doubling.
601
602       num.query.type.A
603              The  total number of queries over all threads with query type A.
604              Printed for the other query types as  well,  but  only  for  the
605              types for which queries were received, thus =0 entries are omit‐
606              ted for brevity.
607
608       num.query.type.other
609              Number of queries with query types 256-65535.
610
611       num.query.class.IN
612              The total number of queries over all threads with query class IN
613              (internet).   Also printed for other classes (such as CH (CHAOS)
614              sometimes used for debugging), or NONE, ANY, used by dynamic up‐
615              date.  num.query.class.other is printed for classes 256-65535.
616
617       num.query.opcode.QUERY
618              The  total  number of queries over all threads with query opcode
619              QUERY.  Also printed for other opcodes, UPDATE, ...
620
621       num.query.tcp
622              Number of queries that were made using TCP towards  the  Unbound
623              server.
624
625       num.query.tcpout
626              Number  of queries that the Unbound server made using TCP outgo‐
627              ing towards other servers.
628
629       num.query.udpout
630              Number of queries that the Unbound server made using UDP  outgo‐
631              ing towards other servers.
632
633       num.query.tls
634              Number  of  queries that were made using TLS towards the Unbound
635              server.  These are also counted in  num.query.tcp,  because  TLS
636              uses TCP.
637
638       num.query.tls.resume
639              Number  of  TLS  session resumptions, these are queries over TLS
640              towards the Unbound server where the  client  negotiated  a  TLS
641              session resumption key.
642
643       num.query.https
644              Number of queries that were made using HTTPS towards the Unbound
645              server.   These  are   also   counted   in   num.query.tcp   and
646              num.query.tls, because HTTPS uses TLS and TCP.
647
648       num.query.ipv6
649              Number  of queries that were made using IPv6 towards the Unbound
650              server.
651
652       num.query.flags.RD
653              The number of queries that had the RD flag set  in  the  header.
654              Also  printed  for  flags  QR, AA, TC, RA, Z, AD, CD.  Note that
655              queries with flags QR, AA or TC may have been  rejected  because
656              of that.
657
658       num.query.edns.present
659              number of queries that had an EDNS OPT record present.
660
661       num.query.edns.DO
662              number  of  queries  that  had  an  EDNS  OPT record with the DO
663              (DNSSEC OK) bit set.  These queries are  also  included  in  the
664              num.query.edns.present number.
665
666       num.query.ratelimited
667              The  number  of  queries that are turned away from being send to
668              nameserver due to ratelimiting.
669
670       num.query.dnscrypt.shared_secret.cachemiss
671              The number of dnscrypt queries that did not find a shared secret
672              in the cache.  This can be used to compute the shared secret hi‐
673              trate.
674
675       num.query.dnscrypt.replay
676              The number of dnscrypt queries that found a  nonce  hit  in  the
677              nonce cache and hence are considered a query replay.
678
679       num.answer.rcode.NXDOMAIN
680              The  number of answers to queries, from cache or from recursion,
681              that had the return code NXDOMAIN. Also printed  for  the  other
682              return codes.
683
684       num.answer.rcode.nodata
685              The number of answers to queries that had the pseudo return code
686              nodata.  This means the actual return code was NOERROR, but  ad‐
687              ditionally,  no  data  was carried in the answer (making what is
688              called a NOERROR/NODATA answer).  These  queries  are  also  in‐
689              cluded  in the num.answer.rcode.NOERROR number.  Common for AAAA
690              lookups when an A record exists, and no AAAA.
691
692       num.answer.secure
693              Number of answers that were secure.  The answer  validated  cor‐
694              rectly.   The  AD  bit  might have been set in some of these an‐
695              swers, where the client signalled (with DO  or  AD  bit  in  the
696              query) that they were ready to accept the AD bit in the answer.
697
698       num.answer.bogus
699              Number  of  answers  that were bogus.  These answers resulted in
700              SERVFAIL to the client because the answer failed validation.
701
702       num.rrset.bogus
703              The number of rrsets marked bogus by the  validator.   Increased
704              for every RRset inspection that fails.
705
706       unwanted.queries
707              Number  of  queries  that  were  refused or dropped because they
708              failed the access control settings.
709
710       unwanted.replies
711              Replies that were unwanted or unsolicited.  Could have been ran‐
712              dom  traffic, delayed duplicates, very late answers, or could be
713              spoofing attempts.  Some low level of late answers  and  delayed
714              duplicates  are to be expected with the UDP protocol.  Very high
715              values could indicate a threat (spoofing).
716
717       msg.cache.count
718              The number of items (DNS replies) in the message cache.
719
720       rrset.cache.count
721              The number of RRsets in the rrset cache.  This  includes  rrsets
722              used  by  the messages in the message cache, but also delegation
723              information.
724
725       infra.cache.count
726              The number of items in the infra cache.  These are IP  addresses
727              with their timing and protocol support information.
728
729       key.cache.count
730              The  number  of  items in the key cache.  These are DNSSEC keys,
731              one item per delegation point, and their validation status.
732
733       msg.cache.max_collisions
734              The maximum number of hash table collisions in  the  msg  cache.
735              This  is the number of hashes that are identical when a new ele‐
736              ment is inserted in the hash table. If the value is very  large,
737              like  hundreds,  something  is wrong with the performance of the
738              hash table, hash values are incorrect or malicious.
739
740       rrset.cache.max_collisions
741              The maximum number of hash table collisions in the rrset  cache.
742              This  is the number of hashes that are identical when a new ele‐
743              ment is inserted in the hash table. If the value is very  large,
744              like  hundreds,  something  is wrong with the performance of the
745              hash table, hash values are incorrect or malicious.
746
747       dnscrypt_shared_secret.cache.count
748              The number of items in the shared secret cache. These  are  pre‐
749              computed shared secrets for a given client public key/server se‐
750              cret key pair. Shared secrets are CPU intensive and  this  cache
751              allows  Unbound to avoid recomputing the shared secret when mul‐
752              tiple dnscrypt queries are sent from the same client.
753
754       dnscrypt_nonce.cache.count
755              The number of items in the client nonce  cache.  This  cache  is
756              used  to  prevent dnscrypt queries replay. The client nonce must
757              be unique for each client public  key/server  secret  key  pair.
758              This cache should be able to host QPS * `replay window` interval
759              keys to prevent replay of a query during  `replay  window`  sec‐
760              onds.
761
762       num.query.authzone.up
763              The  number  of  queries  answered from auth-zone data, upstream
764              queries.  These queries would otherwise  have  been  sent  (with
765              fallback enabled) to the internet, but are now answered from the
766              auth zone.
767
768       num.query.authzone.down
769              The number of queries for  downstream  answered  from  auth-zone
770              data.   These  queries are from downstream clients, and have had
771              an answer from the data in the auth zone.
772
773       num.query.aggressive.NOERROR
774              The number of queries answered using cached  NSEC  records  with
775              NODATA  RCODE.   These queries would otherwise have been sent to
776              the internet, but are now answered using cached data.
777
778       num.query.aggressive.NXDOMAIN
779              The number of queries answered using cached  NSEC  records  with
780              NXDOMAIN RCODE.  These queries would otherwise have been sent to
781              the internet, but are now answered using cached data.
782
783       num.query.subnet
784              Number of queries that got an answer that contained EDNS  client
785              subnet data.
786
787       num.query.subnet_cache
788              Number  of  queries  answered from the edns client subnet cache.
789              These are counted as cachemiss by the main counters, but hit the
790              client subnet specific cache after getting processed by the edns
791              client subnet module.
792
793       num.query.cachedb
794              Number of queries answered from the external cache  of  cachedb.
795              These are counted as cachemiss by the main counters, but hit the
796              cachedb external cache after getting processed  by  the  cachedb
797              module.
798
799       num.rpz.action.<rpz_action>
800              Number  of queries answered using configured RPZ policy, per RPZ
801              action type.  Possible actions are: nxdomain, nodata,  passthru,
802              drop, tcp-only, local-data, disabled, and cname-override.
803

FILES

805       /etc/unbound/unbound.conf
806              Unbound configuration file.
807
808       /etc/unbound
809              directory with private keys (unbound_server.key and unbound_con‐
810              trol.key) and self-signed certificates  (unbound_server.pem  and
811              unbound_control.pem).
812

SEE ALSO

814       unbound.conf(5), unbound(8).
815
816
817
818NLnet Labs                       Nov  8, 2023               unbound-control(8)
Impressum