:orphan:

.. index:: pair: struct; tapi_dns_unbound_cfg_opt
.. _doxid-structtapi__dns__unbound__cfg__opt:

struct tapi_dns_unbound_cfg_opt
===============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Unbound DNS server config file options. :ref:`More...<details-structtapi__dns__unbound__cfg__opt>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_dns_unbound.h>
	
	struct tapi_dns_unbound_cfg_opt {
		// fields
	
		:ref:`tapi_dns_unbound_verbose<doxid-group__tapi__dns__unbound_1ga5f817a628cbd5ff3f5d45aec32e001af>` :ref:`verbosity<doxid-structtapi__dns__unbound__cfg__opt_1a521251dea48dc9e240cb01dd8f13ca7a>`;
		size_t :target:`n<doxid-structtapi__dns__unbound__cfg__opt_1ac9ff04aa13cb036368a5bbdc6afaf16f>`;
		const char** :target:`filename<doxid-structtapi__dns__unbound__cfg__opt_1a290cdf7547704c38fcc5cf6c620ed47a>`;
		struct tapi_dns_unbound_cfg_opt::@54 :ref:`includes<doxid-structtapi__dns__unbound__cfg__opt_1a4ee69fedb5c17c3a056440e61bfd6e6e>`;
		const char* :ref:`username<doxid-structtapi__dns__unbound__cfg__opt_1abe01a14fa88810b11f9024dda8316eb0>`;
		const char* :ref:`chroot<doxid-structtapi__dns__unbound__cfg__opt_1a988d7d221b57cc1cee1792d2537d2aff>`;
		const char* :ref:`directory<doxid-structtapi__dns__unbound__cfg__opt_1a2816de550935b4f0dced4276103599fe>`;
		:ref:`tapi_dns_unbound_cfg_address<doxid-structtapi__dns__unbound__cfg__address>`* :target:`addr<doxid-structtapi__dns__unbound__cfg__opt_1a2df0e874e78cbc8fa25977359b6c76d3>`;
		struct tapi_dns_unbound_cfg_opt::@55 :ref:`interfaces<doxid-structtapi__dns__unbound__cfg__opt_1a67f4a7d52515eaeaf3594935750f2850>`;
		const struct sockaddr** :target:`addr<doxid-structtapi__dns__unbound__cfg__opt_1a98d51321ed342a74a21ce038f4f07b08>`;
		struct tapi_dns_unbound_cfg_opt::@56 :ref:`outgoing_interfaces<doxid-structtapi__dns__unbound__cfg__opt_1a42e12a84ed31757a5493e94d1f7f8fbb>`;
		:ref:`tapi_dns_unbound_cfg_ac<doxid-structtapi__dns__unbound__cfg__ac>`* :target:`rule<doxid-structtapi__dns__unbound__cfg__opt_1a73de54507d90ef4b09f13068545b572e>`;
		struct tapi_dns_unbound_cfg_opt::@57 :ref:`access_controls<doxid-structtapi__dns__unbound__cfg__opt_1a548c92fd3a0c63ae556d7dbbab5be7b6>`;
		:ref:`te_sockaddr_subnet<doxid-structte__sockaddr__subnet>`* :target:`addr<doxid-structtapi__dns__unbound__cfg__opt_1a0067d98f23c7d3bcea835848fd2a8c74>`;
		struct tapi_dns_unbound_cfg_opt::@58 :ref:`private_addresses<doxid-structtapi__dns__unbound__cfg__opt_1abea41f8543e1cd1022818ea789301ec3>`;
		const char* :ref:`private_domain<doxid-structtapi__dns__unbound__cfg__opt_1aa5d4e303951ce7a69a7a7a1aa86763a7>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`port<doxid-structtapi__dns__unbound__cfg__opt_1a11f99fe63c0a35809c177bb8579ce9fb>`;
		bool :ref:`so_reuseport<doxid-structtapi__dns__unbound__cfg__opt_1ac087853b606e46c80dadec55e34bc49e>`;
		:ref:`tapi_dns_unbound_cfg_auth_zone<doxid-structtapi__dns__unbound__cfg__auth__zone>`* :target:`zone<doxid-structtapi__dns__unbound__cfg__opt_1a97d6599f495222b9e0864e204e5e6cf5>`;
		struct tapi_dns_unbound_cfg_opt::@59 :ref:`auth_zones<doxid-structtapi__dns__unbound__cfg__opt_1a372efc546c0407d17877f204f4165cde>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`num_threads<doxid-structtapi__dns__unbound__cfg__opt_1a02a4d7b809b71615c3e02d25228b36d4>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`num_queries_per_thread<doxid-structtapi__dns__unbound__cfg__opt_1a6540f39c9a1ee4f2e1b60ea0f7c0ee6b>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`jostle_timeout<doxid-structtapi__dns__unbound__cfg__opt_1aa39c6bd1f14cd9a66d81b81e94156340>`;
		bool :ref:`minimal_responses<doxid-structtapi__dns__unbound__cfg__opt_1a2b146075068bc90a41fe987a3fc1a228>`;
		bool :ref:`do_ip4<doxid-structtapi__dns__unbound__cfg__opt_1ab70c48975b4a3c7114310d0e57aad145>`;
		bool :ref:`do_ip6<doxid-structtapi__dns__unbound__cfg__opt_1ab7625f8a6100d78470e457230ed3df2c>`;
		bool :ref:`do_udp<doxid-structtapi__dns__unbound__cfg__opt_1ac9827a47e83b191b0d742ddc4f33dc85>`;
		bool :ref:`do_tcp<doxid-structtapi__dns__unbound__cfg__opt_1aa90deb627ec1e46ee910b63801c5a708>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`incoming_num_tcp<doxid-structtapi__dns__unbound__cfg__opt_1a6bca6b6486ab62130620a46487429b8d>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`outgoing_num_tcp<doxid-structtapi__dns__unbound__cfg__opt_1a19795c25399c7f7b6f2328fdf40a2f76>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`cache_max_ttl<doxid-structtapi__dns__unbound__cfg__opt_1abee3bbc6f61b0f3c90fb19118d4993ae>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`cache_min_ttl<doxid-structtapi__dns__unbound__cfg__opt_1a7af175c4c49bb2493b9159f2061bdc85>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`so_rcvbuf<doxid-structtapi__dns__unbound__cfg__opt_1a13adf7bb829f7520be2d9a3a5651749c>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`so_sndbuf<doxid-structtapi__dns__unbound__cfg__opt_1aab4f1ac5f3f1e1ce4fe16c3bd6cb22cb>`;
	};
.. _details-structtapi__dns__unbound__cfg__opt:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Unbound DNS server config file options.

``use-syslog`` option disabled by default.

Fields
------

.. index:: pair: variable; verbosity
.. _doxid-structtapi__dns__unbound__cfg__opt_1a521251dea48dc9e240cb01dd8f13ca7a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_dns_unbound_verbose<doxid-group__tapi__dns__unbound_1ga5f817a628cbd5ff3f5d45aec32e001af>` verbosity

Increase verbosity.

.. index:: pair: variable; includes
.. _doxid-structtapi__dns__unbound__cfg__opt_1a4ee69fedb5c17c3a056440e61bfd6e6e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unnamed-struct includes

Array of file names to include.

.. index:: pair: variable; username
.. _doxid-structtapi__dns__unbound__cfg__opt_1abe01a14fa88810b11f9024dda8316eb0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* username

If given, after binding the port the user privileges are dropped. If username is set as an empty string or ``NULL``, then no user change is performed.

.. index:: pair: variable; chroot
.. _doxid-structtapi__dns__unbound__cfg__opt_1a988d7d221b57cc1cee1792d2537d2aff:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* chroot

Change root directory to the new one.

.. index:: pair: variable; directory
.. _doxid-structtapi__dns__unbound__cfg__opt_1a2816de550935b4f0dced4276103599fe:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* directory

Sets the working directory for the program.

.. index:: pair: variable; interfaces
.. _doxid-structtapi__dns__unbound__cfg__opt_1a67f4a7d52515eaeaf3594935750f2850:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unnamed-struct interfaces

Array of interfaces to use to connect to the network. These interfaces are listened to for queries from clients, and answers to clients are given from this.

.. index:: pair: variable; outgoing_interfaces
.. _doxid-structtapi__dns__unbound__cfg__opt_1a42e12a84ed31757a5493e94d1f7f8fbb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unnamed-struct outgoing_interfaces

Array of interfaces to use to connect to the network. These interfaces are used to send queries to authoritative servers and receive their replies.

.. index:: pair: variable; access_controls
.. _doxid-structtapi__dns__unbound__cfg__opt_1a548c92fd3a0c63ae556d7dbbab5be7b6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unnamed-struct access_controls

Array of access control rules for given netblocks and actions.

.. index:: pair: variable; private_addresses
.. _doxid-structtapi__dns__unbound__cfg__opt_1abea41f8543e1cd1022818ea789301ec3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unnamed-struct private_addresses

Array of addresses on private network, and are not allowed to be returned for public internet names.

.. index:: pair: variable; private_domain
.. _doxid-structtapi__dns__unbound__cfg__opt_1aa5d4e303951ce7a69a7a7a1aa86763a7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* private_domain

Allow this domain, and all its subdomains to contain private addresses.

.. index:: pair: variable; port
.. _doxid-structtapi__dns__unbound__cfg__opt_1a11f99fe63c0a35809c177bb8579ce9fb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` port

The port number on which the server responds to queries.

.. index:: pair: variable; so_reuseport
.. _doxid-structtapi__dns__unbound__cfg__opt_1ac087853b606e46c80dadec55e34bc49e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool so_reuseport

If ``true``, then open dedicated listening sockets for incoming queries for each thread and try to set the ``SO_REUSEPORT`` socket option on each socket.

.. index:: pair: variable; auth_zones
.. _doxid-structtapi__dns__unbound__cfg__opt_1a372efc546c0407d17877f204f4165cde:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unnamed-struct auth_zones

Authority zones.

.. index:: pair: variable; num_threads
.. _doxid-structtapi__dns__unbound__cfg__opt_1a02a4d7b809b71615c3e02d25228b36d4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` num_threads

The number of threads to create to serve clients.

.. index:: pair: variable; num_queries_per_thread
.. _doxid-structtapi__dns__unbound__cfg__opt_1a6540f39c9a1ee4f2e1b60ea0f7c0ee6b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` num_queries_per_thread

The number of queries that every thread will service simultaneously.

.. index:: pair: variable; jostle_timeout
.. _doxid-structtapi__dns__unbound__cfg__opt_1aa39c6bd1f14cd9a66d81b81e94156340:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` jostle_timeout

Timeout used when the server is very busy. Set to a value that usually results in one roundtrip to the authority servers.

.. index:: pair: variable; minimal_responses
.. _doxid-structtapi__dns__unbound__cfg__opt_1a2b146075068bc90a41fe987a3fc1a228:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool minimal_responses

If ``true``, Unbound does not insert authority/additional sections into response messages when those sections are not required. This reduces response size significantly, and may avoid TCP fallback for some responses. This may cause a slight speedup.

.. index:: pair: variable; do_ip4
.. _doxid-structtapi__dns__unbound__cfg__opt_1ab70c48975b4a3c7114310d0e57aad145:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool do_ip4

Enable or disable whether IPv4 queries are answered or issued.

.. index:: pair: variable; do_ip6
.. _doxid-structtapi__dns__unbound__cfg__opt_1ab7625f8a6100d78470e457230ed3df2c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool do_ip6

Enable or disable whether IPv6 queries are answered or issued.

.. index:: pair: variable; do_udp
.. _doxid-structtapi__dns__unbound__cfg__opt_1ac9827a47e83b191b0d742ddc4f33dc85:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool do_udp

Enable or disable whether UDP queries are answered or issued.

.. index:: pair: variable; do_tcp
.. _doxid-structtapi__dns__unbound__cfg__opt_1aa90deb627ec1e46ee910b63801c5a708:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool do_tcp

Enable or disable whether TCP queries are answered or issued.

.. index:: pair: variable; incoming_num_tcp
.. _doxid-structtapi__dns__unbound__cfg__opt_1a6bca6b6486ab62130620a46487429b8d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` incoming_num_tcp

Number of incoming TCP buffers to allocate per thread.

.. index:: pair: variable; outgoing_num_tcp
.. _doxid-structtapi__dns__unbound__cfg__opt_1a19795c25399c7f7b6f2328fdf40a2f76:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` outgoing_num_tcp

Number of outgoing TCP buffers to allocate per thread.

.. index:: pair: variable; cache_max_ttl
.. _doxid-structtapi__dns__unbound__cfg__opt_1abee3bbc6f61b0f3c90fb19118d4993ae:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` cache_max_ttl

Time to live maximum for RRsets and messages in the cache.

.. index:: pair: variable; cache_min_ttl
.. _doxid-structtapi__dns__unbound__cfg__opt_1a7af175c4c49bb2493b9159f2061bdc85:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` cache_min_ttl

Time to live minimum for RRsets and messages in the cache.

.. index:: pair: variable; so_rcvbuf
.. _doxid-structtapi__dns__unbound__cfg__opt_1a13adf7bb829f7520be2d9a3a5651749c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` so_rcvbuf

If not ``0``, then set the ``SO_RCVBUF`` socket option to get more buffer space on UDP port 53 incoming queries.

.. index:: pair: variable; so_sndbuf
.. _doxid-structtapi__dns__unbound__cfg__opt_1aab4f1ac5f3f1e1ce4fe16c3bd6cb22cb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` so_sndbuf

If not ``0``, then set the ``SO_SNDBUF`` socket option to get more buffer space on UDP port 53 outgoing queries.