contrib/unbound/doc/unbound-control.8.in

   1 .TH "unbound-control" "8" "Dec 10, 2015" "NLnet Labs" "unbound 1.5.7"
   2 .\"
   3 .\" unbound-control.8 -- unbound remote control manual
   4 .\"
   5 .\" Copyright (c) 2008, NLnet Labs. All rights reserved.
   6 .\"
   7 .\" See LICENSE for the license.
   8 .\"
   9 .\"
  10 .SH "NAME"
  11 .B unbound\-control,
  12 .B unbound\-control\-setup
  13 \- Unbound remote server control utility.
  14 .SH "SYNOPSIS"
  15 .B unbound\-control
  16 .RB [ \-hq ]
  17 .RB [ \-c
  18 .IR cfgfile ]
  19 .RB [ \-s
  20 .IR server ]
  21 .IR command
  22 .SH "DESCRIPTION"
  23 .B Unbound\-control
  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.
  27 .P
  28 The available options are:
  29 .TP
  30 .B \-h
  31 Show the version and commandline option help.
  32 .TP
  33 .B \-c \fIcfgfile
  34 The config file to read with settings.  If not given the default
  35 config file @ub_conf_file@ is used.
  36 .TP
  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.
  40 .TP
  41 .B \-q
  42 quiet, if the option is given it does not print anything if it works ok.
  43 .SH "COMMANDS"
  44 There are several commands that the server understands.
  45 .TP
  46 .B start
  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.
  50 .TP
  51 .B stop
  52 Stop the server. The server daemon exits.
  53 .TP
  54 .B reload
  55 Reload the server. This flushes the cache and reads the config file fresh.
  56 .TP
  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.
  61 .TP
  62 .B log_reopen
  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).
  66 .TP
  67 .B stats
  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.
  71 .TP
  72 .B stats_noreset
  73 Peek at statistics. Prints them like the \fBstats\fR command does, but does not
  74 reset the internal counters to zero.
  75 .TP
  76 .B status
  77 Display server status. Exit code 3 if not running (the connection to the
  78 port is refused), 1 on error, 0 if running.
  79 .TP
  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.
  83 .TP
  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.
  87 .TP
  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
  93 errors.
  94 .TP
  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.
 101 .TP
 102 .B dump_cache
 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.
 105 .TP
 106 .B load_cache
 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.
 111 .TP
 112 .B lookup \fIname
 113 Print to stdout the name servers that would be used to look up the
 114 name specified.
 115 .TP
 116 .B flush \fIname
 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
 120 .B flush_type
 121 or
 122 .B flush_zone\fR.
 123 .TP
 124 .B flush_type \fIname\fR \fItype
 125 Remove the name, type information from the cache.
 126 .TP
 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.
 131 .TP
 132 .B flush_bogus
 133 Remove all bogus data from the cache.
 134 .TP
 135 .B flush_negative
 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.
 140 .TP
 141 .B flush_stats
 142 Reset statistics to zero.
 143 .TP
 144 .B flush_requestlist
 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.
 150 .TP
 151 .B dump_requestlist
 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.
 157 .TP
 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
 161 and lameness data.
 162 .TP
 163 .B dump_infra
 164 Show the contents of the infra cache.
 165 .TP
 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 initialized.
 173 .IP
 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, ratelimit,
 181 cache\-max\-ttl, cache\-min\-ttl, cache\-max\-negative\-ttl.
 182 .TP
 183 .B get_option \fIopt
 184 Get the value of the option.  Give the option name without a trailing ':'.
 185 The value is printed.  If the value is "", nothing is printed
 186 and the connection closes.  On error 'error ...' is printed (it gives
 187 a syntax error on unknown option).  For some options a list of values,
 188 one on each line, is printed.  The options are shown from the config file
 189 as modified with set_option.  For some options an override may have been
 190 taken that does not show up with this command, not results from e.g. the
 191 verbosity and forward control commands.  Not all options work, see list_stubs,
 192 list_forwards, list_local_zones and list_local_data for those.
 193 .TP
 194 .B list_stubs
 195 List the stub zones in use.  These are printed one by one to the output.
 196 This includes the root hints in use.
 197 .TP
 198 .B list_forwards
 199 List the forward zones in use.  These are printed zone by zone to the output.
 200 .TP
 201 .B list_insecure
 202 List the zones with domain\-insecure.
 203 .TP
 204 .B list_local_zones
 205 List the local zones in use.  These are printed one per line with zone type.
 206 .TP
 207 .B list_local_data
 208 List the local data RRs in use.  The resource records are printed.
 209 .TP
 210 .B insecure_add \fIzone
 211 Add a \fBdomain\-insecure\fR for the given zone, like the statement in unbound.conf.
 212 Adds to the running unbound without affecting the cache contents (which may
 213 still be bogus, use \fBflush_zone\fR to remove it), does not affect the config file.
 214 .TP
 215 .B insecure_remove \fIzone
 216 Removes domain\-insecure for the given zone.
 217 .TP
 218 .B forward_add \fR[\fI+i\fR] \fIzone addr ...
 219 Add a new forward zone to running unbound.  With +i option also adds a
 220 \fIdomain\-insecure\fR for the zone (so it can resolve insecurely if you have
 221 a DNSSEC root trust anchor configured for other names).
 222 The addr can be IP4, IP6 or nameserver names, like \fIforward-zone\fR config
 223 in unbound.conf.
 224 .TP
 225 .B forward_remove \fR[\fI+i\fR] \fIzone
 226 Remove a forward zone from running unbound.  The +i also removes a
 227 \fIdomain\-insecure\fR for the zone.
 228 .TP
 229 .B stub_add \fR[\fI+ip\fR] \fIzone addr ...
 230 Add a new stub zone to running unbound.  With +i option also adds a
 231 \fIdomain\-insecure\fR for the zone.  With +p the stub zone is set to prime,
 232 without it it is set to notprime.  The addr can be IP4, IP6 or nameserver
 233 names, like the \fIstub-zone\fR config in unbound.conf.
 234 .TP
 235 .B stub_remove \fR[\fI+i\fR] \fIzone
 236 Remove a stub zone from running unbound.  The +i also removes a
 237 \fIdomain\-insecure\fR for the zone.
 238 .TP
 239 .B forward \fR[\fIoff\fR | \fIaddr ...\fR ]
 240 Setup forwarding mode.  Configures if the server should ask other upstream
 241 nameservers, should go to the internet root nameservers itself, or show
 242 the current config.  You could pass the nameservers after a DHCP update.
 243 .IP
 244 Without arguments the current list of addresses used to forward all queries
 245 to is printed.  On startup this is from the forward\-zone "." configuration.
 246 Afterwards it shows the status.  It prints off when no forwarding is used.
 247 .IP
 248 If \fIoff\fR is passed, forwarding is disabled and the root nameservers
 249 are used.  This can be used to avoid to avoid buggy or non\-DNSSEC supporting
 250 nameservers returned from DHCP.  But may not work in hotels or hotspots.
 251 .IP
 252 If one or more IPv4 or IPv6 addresses are given, those are then used to forward
 253 queries to.  The addresses must be separated with spaces.  With '@port' the
 254 port number can be set explicitly (default port is 53 (DNS)).
 255 .IP
 256 By default the forwarder information from the config file for the root "." is
 257 used.  The config file is not changed, so after a reload these changes are
 258 gone.  Other forward zones from the config file are not affected by this command.
 259 .TP
 260 .B ratelimit_list \fR[\fI+a\fR]
 261 List the domains that are ratelimited.  Printed one per line with current
 262 estimated qps and qps limit from config.  With +a it prints all domains, not
 263 just the ratelimited domains, with their estimated qps.  The ratelimited
 264 domains return an error for uncached (new) queries, but cached queries work
 265 as normal.
 266 .SH "EXIT CODE"
 267 The unbound\-control program exits with status code 1 on error, 0 on success.
 268 .SH "SET UP"
 269 The setup requires a self\-signed certificate and private keys for both
 270 the server and client.  The script \fIunbound\-control\-setup\fR generates
 271 these in the default run directory, or with \-d in another directory.
 272 If you change the access control permissions on the key files you can decide
 273 who can use unbound\-control, by default owner and group but not all users.
 274 Run the script under the same username as you have configured in unbound.conf
 275 or as root, so that the daemon is permitted to read the files, for example with:
 276 .nf
 277     sudo \-u unbound unbound\-control\-setup
 278 .fi
 279 If you have not configured
 280 a username in unbound.conf, the keys need read permission for the user
 281 credentials under which the daemon is started.
 282 The script preserves private keys present in the directory.
 283 After running the script as root, turn on \fBcontrol\-enable\fR in
 284 \fIunbound.conf\fR.
 285 .SH "STATISTIC COUNTERS"
 286 The \fIstats\fR command shows a number of statistic counters.
 287 .TP
 288 .I threadX.num.queries
 289 number of queries received by thread
 290 .TP
 291 .I threadX.num.cachehits
 292 number of queries that were successfully answered using a cache lookup
 293 .TP
 294 .I threadX.num.cachemiss
 295 number of queries that needed recursive processing
 296 .TP
 297 .I threadX.num.prefetch
 298 number of cache prefetches performed.  This number is included in
 299 cachehits, as the original query had the unprefetched answer from cache,
 300 and resulted in recursive processing, taking a slot in the requestlist.
 301 Not part of the recursivereplies (or the histogram thereof) or cachemiss,
 302 as a cache response was sent.
 303 .TP
 304 .I threadX.num.recursivereplies
 305 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.
 306 .TP
 307 .I threadX.requestlist.avg
 308 The average number of requests in the internal recursive processing request list on insert of a new incoming recursive processing query.
 309 .TP
 310 .I threadX.requestlist.max
 311 Maximum size attained by the internal recursive processing request list.
 312 .TP
 313 .I threadX.requestlist.overwritten
 314 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.
 315 .TP
 316 .I threadX.requestlist.exceeded
 317 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.
 318 .TP
 319 .I threadX.requestlist.current.all
 320 Current size of the request list, includes internally generated queries (such
 321 as priming queries and glue lookups).
 322 .TP
 323 .I threadX.requestlist.current.user
 324 Current size of the request list, only the requests from client queries.
 325 .TP
 326 .I threadX.recursion.time.avg
 327 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.
 328 .TP
 329 .I threadX.recursion.time.median
 330 The median of the time it took to answer queries that needed recursive
 331 processing.  The median means that 50% of the user queries were answered in
 332 less than this time.  Because of big outliers (usually queries to non
 333 responsive servers), the average can be bigger than the median.  This median
 334 has been calculated by interpolation from a histogram.
 335 .TP
 336 .I threadX.tcpusage
 337 The currently held tcp buffers for incoming connections.  A spot value on
 338 the time of the request.  This helps you spot if the incoming\-num\-tcp
 339 buffers are full.
 340 .TP
 341 .I total.num.queries
 342 summed over threads.
 343 .TP
 344 .I total.num.cachehits
 345 summed over threads.
 346 .TP
 347 .I total.num.cachemiss
 348 summed over threads.
 349 .TP
 350 .I total.num.prefetch
 351 summed over threads.
 352 .TP
 353 .I total.num.recursivereplies
 354 summed over threads.
 355 .TP
 356 .I total.requestlist.avg
 357 averaged over threads.
 358 .TP
 359 .I total.requestlist.max
 360 the maximum of the thread requestlist.max values.
 361 .TP
 362 .I total.requestlist.overwritten
 363 summed over threads.
 364 .TP
 365 .I total.requestlist.exceeded
 366 summed over threads.
 367 .TP
 368 .I total.requestlist.current.all
 369 summed over threads.
 370 .TP
 371 .I total.recursion.time.median
 372 averaged over threads.
 373 .TP
 374 .I total.tcpusage
 375 summed over threads.
 376 .TP
 377 .I time.now
 378 current time in seconds since 1970.
 379 .TP
 380 .I time.up
 381 uptime since server boot in seconds.
 382 .TP
 383 .I time.elapsed
 384 time since last statistics printout, in seconds.
 385 .SH EXTENDED STATISTICS
 386 .TP
 387 .I mem.total.sbrk
 388 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.
 389 .TP
 390 .I mem.cache.rrset
 391 Memory in bytes in use by the RRset cache.
 392 .TP
 393 .I mem.cache.message
 394 Memory in bytes in use by the message cache.
 395 .TP
 396 .I mem.mod.iterator
 397 Memory in bytes in use by the iterator module.
 398 .TP
 399 .I mem.mod.validator
 400 Memory in bytes in use by the validator module. Includes the key cache and
 401 negative cache.
 402 .TP
 403 .I histogram.<sec>.<usec>.to.<sec>.<usec>
 404 Shows a histogram, summed over all threads. Every element counts the
 405 recursive queries whose reply time fit between the lower and upper bound.
 406 Times larger or equal to the lowerbound, and smaller than the upper bound.
 407 There are 40 buckets, with bucket sizes doubling.
 408 .TP
 409 .I num.query.type.A
 410 The total number of queries over all threads with query type A.
 411 Printed for the other query types as well, but only for the types for which
 412 queries were received, thus =0 entries are omitted for brevity.
 413 .TP
 414 .I num.query.type.other
 415 Number of queries with query types 256\-65535.
 416 .TP
 417 .I num.query.class.IN
 418 The total number of queries over all threads with query class IN (internet).
 419 Also printed for other classes (such as CH (CHAOS) sometimes used for
 420 debugging), or NONE, ANY, used by dynamic update.
 421 num.query.class.other is printed for classes 256\-65535.
 422 .TP
 423 .I num.query.opcode.QUERY
 424 The total number of queries over all threads with query opcode QUERY.
 425 Also printed for other opcodes, UPDATE, ...
 426 .TP
 427 .I num.query.tcp
 428 Number of queries that were made using TCP towards the unbound server.
 429 .TP
 430 .I num.query.tcpout
 431 Number of queries that the unbound server made using TCP outgoing towards
 432 other servers.
 433 .TP
 434 .I num.query.ipv6
 435 Number of queries that were made using IPv6 towards the unbound server.
 436 .TP
 437 .I num.query.flags.RD
 438 The number of queries that had the RD flag set in the header.
 439 Also printed for flags QR, AA, TC, RA, Z, AD, CD.
 440 Note that queries with flags QR, AA or TC may have been rejected
 441 because of that.
 442 .TP
 443 .I num.query.edns.present
 444 number of queries that had an EDNS OPT record present.
 445 .TP
 446 .I num.query.edns.DO
 447 number of queries that had an EDNS OPT record with the DO (DNSSEC OK) bit set.
 448 These queries are also included in the num.query.edns.present number.
 449 .TP
 450 .I num.answer.rcode.NXDOMAIN
 451 The number of answers to queries, from cache or from recursion, that had the
 452 return code NXDOMAIN. Also printed for the other return codes.
 453 .TP
 454 .I num.answer.rcode.nodata
 455 The number of answers to queries that had the pseudo return code nodata.
 456 This means the actual return code was NOERROR, but additionally, no data was
 457 carried in the answer (making what is called a NOERROR/NODATA answer).
 458 These queries are also included in the num.answer.rcode.NOERROR number.
 459 Common for AAAA lookups when an A record exists, and no AAAA.
 460 .TP
 461 .I num.answer.secure
 462 Number of answers that were secure.  The answer validated correctly.
 463 The AD bit might have been set in some of these answers, where the client
 464 signalled (with DO or AD bit in the query) that they were ready to accept
 465 the AD bit in the answer.
 466 .TP
 467 .I num.answer.bogus
 468 Number of answers that were bogus.  These answers resulted in SERVFAIL
 469 to the client because the answer failed validation.
 470 .TP
 471 .I num.rrset.bogus
 472 The number of rrsets marked bogus by the validator.  Increased for every
 473 RRset inspection that fails.
 474 .TP
 475 .I unwanted.queries
 476 Number of queries that were refused or dropped because they failed the
 477 access control settings.
 478 .TP
 479 .I unwanted.replies
 480 Replies that were unwanted or unsolicited.  Could have been random traffic,
 481 delayed duplicates, very late answers, or could be spoofing attempts.
 482 Some low level of late answers and delayed duplicates are to be expected
 483 with the UDP protocol.  Very high values could indicate a threat (spoofing).
 484 .TP
 485 .I msg.cache.count
 486 The number of items (DNS replies) in the message cache.
 487 .TP
 488 .I rrset.cache.count
 489 The number of RRsets in the rrset cache.  This includes rrsets used by
 490 the messages in the message cache, but also delegation information.
 491 .TP
 492 .I infra.cache.count
 493 The number of items in the infra cache.  These are IP addresses with their
 494 timing and protocol support information.
 495 .TP
 496 .I key.cache.count
 497 The number of items in the key cache.  These are DNSSEC keys, one item
 498 per delegation point, and their validation status.
 499 .SH "FILES"
 500 .TP
 501 .I @ub_conf_file@
 502 unbound configuration file.
 503 .TP
 504 .I @UNBOUND_RUN_DIR@
 505 directory with private keys (unbound_server.key and unbound_control.key) and
 506 self\-signed certificates (unbound_server.pem and unbound_control.pem).
 507 .SH "SEE ALSO"
 508 \fIunbound.conf\fR(5),
 509 \fIunbound\fR(8).