kea/src/bin/auth/b10-auth.8

'\" t
.\"     Title: b10-auth
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: March 1, 2012
.\"    Manual: BIND10
.\"    Source: BIND10
.\"  Language: English
.\"
.TH "B10\-AUTH" "8" "March 1, 2012" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
b10-auth \- Authoritative DNS server
.SH "SYNOPSIS"
.HP \w'\fBb10\-auth\fR\ 'u
\fBb10\-auth\fR [\fB\-n\fR] [\fB\-v\fR]
.SH "DESCRIPTION"
.PP
The
\fBb10\-auth\fR
daemon provides the BIND 10 authoritative DNS server\&. Normally it is started by the
\fBbind10\fR(8)
boss process\&.
.PP
This daemon communicates with other BIND 10 components over a
\fBb10-msgq\fR(8)
C\-Channel connection\&. If this connection is not established,
\fBb10\-auth\fR
will exit\&.
It receives its configurations from
\fBb10-cfgmgr\fR(8)\&.
.SH "OPTIONS"
.PP
The arguments are as follows:
.PP
\fB\-n\fR
.RS 4
Do not cache answers in memory\&. The default is to use the cache for faster responses\&. The cache keeps the most recent 30,000 answers (positive and negative) in memory for 30 seconds (instead of querying the data source, such as SQLite3 database, each time)\&.
.RE
.PP
\fB\-v\fR
.RS 4
Enabled verbose mode\&. This enables diagnostic messages to STDERR\&.
.RE
.SH "CONFIGURATION AND COMMANDS"
.PP
The configurable settings are:
.PP

\fIdatabase_file\fR
defines the path to the SQLite3 zone file when using the sqlite datasource\&. The default is
/usr/local/var/bind10\-devel/zone\&.sqlite3\&.
.PP

\fIdatasources\fR
configures data sources\&. The list items include:
\fItype\fR
to optionally choose the data source type (such as
\(lqmemory\(rq);
\fIclass\fR
to optionally select the class (it defaults to
\(lqIN\(rq); and
\fIzones\fR
to define the
\fIfile\fR
path name and the
\fIorigin\fR
(default domain)\&. By default, this is empty\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In this development version, currently this is only used for the memory data source\&. Only the IN class is supported at this time\&. By default, the memory data source is disabled\&. Also, currently the zone file must be canonical such as generated by \fBnamed\-compilezone \-D\fR\&.
.sp .5v
.RE
.PP

\fIlisten_on\fR
is a list of addresses and ports for
\fBb10\-auth\fR
to listen on\&. The list items are the
\fIaddress\fR
string and
\fIport\fR
number\&. By default,
\fBb10\-auth\fR
listens on port 53 on the IPv6 (::) and IPv4 (0\&.0\&.0\&.0) wildcard addresses\&.
.PP

\fIstatistics\-interval\fR
is the timer interval in seconds for
\fBb10\-auth\fR
to share its statistics information to
\fBb10-stats\fR(8)\&. Statistics updates can be disabled by setting this to 0\&. The default is 60\&.
.PP
The configuration commands are:
.PP

\fBloadzone\fR
tells
\fBb10\-auth\fR
to load or reload a zone file\&. The arguments include:
\fIclass\fR
which optionally defines the class (it defaults to
\(lqIN\(rq);
\fIorigin\fR
is the domain name of the zone; and
\fIdatasrc\fR
optionally defines the type of datasource (it defaults to
\(lqmemory\(rq)\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
.sp
In this development version, currently this only supports the IN class and the memory data source\&.
.sp .5v
.RE
.PP

\fBsendstats\fR
tells
\fBb10\-auth\fR
to send its statistics data to
\fBb10-stats\fR(8)
immediately\&.
.PP

\fBshutdown\fR
exits
\fBb10\-auth\fR\&. This has an optional
\fIpid\fR
argument to select the process ID to stop\&. (Note that the BIND 10 boss process may restart this service if configured\&.)
.SH "STATISTICS DATA"
.PP
The statistics data collected by the
\fBb10\-stats\fR
daemon for
\(lqAuth\(rq
include:
.PP
queries\&.tcp
.RS 4
Total count of queries received by the
\fBb10\-auth\fR
server over TCP since startup\&.
.RE
.PP
queries\&.udp
.RS 4
Total count of queries received by the
\fBb10\-auth\fR
server over UDP since startup\&.
.RE
.SH "FILES"
.PP

/usr/local/var/bind10\-devel/zone\&.sqlite3
\(em Location for the SQLite3 zone database when
\fIdatabase_file\fR
configuration is not defined\&.
.SH "SEE ALSO"
.PP

\fBb10-cfgmgr\fR(8),
\fBb10-loadzone\fR(8),
\fBb10-msgq\fR(8),
\fBb10-stats\fR(8),
\fBb10-zonemgr\fR(8),
\fBbind10\fR(8),
BIND 10 Guide\&.
.SH "HISTORY"
.PP
The
\fBb10\-auth\fR
daemon was first coded in October 2009\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010-2012 Internet Systems Consortium, Inc. ("ISC")
.br