b10-xfrout.8 4.02 KB
Newer Older
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1
2
3
4
'\" t
.\"     Title: b10-xfrout
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5
.\"      Date: December 15, 2011
Jeremy C. Reed's avatar
Jeremy C. Reed committed
6
7
8
9
.\"    Manual: BIND10
.\"    Source: BIND10
.\"  Language: English
.\"
10
.TH "B10\-XFROUT" "8" "December 15, 2011" "BIND10" "BIND10"
Jeremy C. Reed's avatar
Jeremy C. Reed committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
b10-xfrout \- Outbound DNS zone transfer service
.SH "SYNOPSIS"
.HP \w'\fBb10\-xfrout\fR\ 'u
\fBb10\-xfrout\fR [\fB\-v\fR] [\fB\-\-verbose\fR]
.SH "DESCRIPTION"
.PP
The
\fBb10\-xfrout\fR
30
daemon provides the BIND 10 outgoing DNS zone transfer service using AXFR or IXFR\&. It is also used to send outgoing NOTIFY messages\&. Normally it is started by the
Jeremy C. Reed's avatar
Jeremy C. Reed committed
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
\fBbind10\fR(8)
boss process\&. When the
\fBb10\-auth\fR
DNS server receives a transfer request,
\fBb10\-xfrout\fR
sends the zone as found in the BIND 10 zone data store\&.
.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
50
Currently IXFR only works if it gets the zone via \fBb10\-xfrin\fR and only on TCP\&.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.sp .5v
.RE
.PP
This daemon communicates with BIND 10 over a
\fBb10-msgq\fR(8)
C\-Channel connection\&. If this connection is not established,
\fBb10\-xfrout\fR
will exit\&.
.PP

\fBb10\-xfrout\fR
receives its configurations from
\fBb10-cfgmgr\fR(8)\&.
.SH "CONFIGURATION AND COMMANDS"
.PP
The configurable settings are:
.PP

69
70
\fItransfers_out\fR
defines the maximum number of outgoing zone transfers that can run concurrently\&. The default is 10\&.
71
72
.PP

73
\fItransfer_acl\fR
74
75
76
77
A list of ACL elements that apply to all transfer requests by default (unless overridden in
\fIzone_config\fR)\&. See the
BIND 10 Guide
for configuration examples\&. The default is an element that allows any transfer requests\&.
78
79
80
81
.PP

\fIzone_config\fR
A list of JSON objects (i\&.e\&. maps) that define per zone configuration concerning
82
83
84
\fBb10\-xfrout\fR\&. The supported names of each object are "origin" (the origin name of the zone), "class" (the RR class of the zone, optional, default to "IN"), and "transfer_acl" (ACL only applicable to transfer requests for that zone)\&. See the
BIND 10 Guide
for configuration examples\&. The default is an empty list, that is, no zone specific configuration\&.
85
86
.PP

87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
\fIlog_name\fR
.PP

\fIlog_file\fR
The location of the log file if using a file channel\&. If undefined, then the file channel is closed\&. The default is
/usr/local/var/bind10\-devel/log/Xfrout\&.log\&.
.PP

\fIlog_severity\fR
The default is "debug"\&.
.PP

\fIlog_versions\fR
The default is 5\&.
.PP

\fIlog_max_bytes\fR
The default is 1048576\&.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.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
This prototype version uses SQLite3 as its data source backend\&. Future versions will be configurable, supporting multiple data storage types\&.
.sp .5v
.RE
.PP
122
The configuration commands are:
Jeremy C. Reed's avatar
Jeremy C. Reed committed
123
124
125
126
127
.PP

\fBshutdown\fR
stops all outbound zone transfers and exits
\fBb10\-xfrout\fR\&. (Note that the BIND 10 boss process will restart this service\&.)
128
129
130
131
132
133
134
135
.PP

\fBzone_new_data_ready\fR
is sent from
\fBb10-xfrin\fR(8)
to indicate that the zone transferred in successfully\&. This triggers
\fBb10\-xfrout\fR
to send NOTIFY message(s)\&. This is an internal command and not exposed to the administrator\&.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
136
137
138
139
140
141
.SH "SEE ALSO"
.PP

\fBb10-auth\fR(8),
\fBb10-cfgmgr\fR(8),
\fBb10-msgq\fR(8),
142
\fBb10-xfrin\fR(8),
Jeremy C. Reed's avatar
Jeremy C. Reed committed
143
144
145
146
147
148
\fBbind10\fR(8),
BIND 10 Guide\&.
.SH "HISTORY"
.PP
The
\fBb10\-xfrout\fR
149
daemon was first implemented in March 2010 by Zhang Likun of CNNIC for the ISC BIND 10 project\&.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
150
151
152
153
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
.br