Files
coredns/man/coredns-transfer.7

78 lines
2.1 KiB
Groff
Raw Normal View History

.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TRANSFER" 7 "March 2026" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
2020-09-24 18:30:59 +00:00
\fItransfer\fP - perform (outgoing) zone transfers for other plugins.
.SH "DESCRIPTION"
.PP
2020-09-24 18:30:59 +00:00
This plugin answers zone transfers for authoritative plugins that implement \fB\fCtransfer.Transferer\fR.
.PP
2020-09-24 18:30:59 +00:00
\fItransfer\fP answers full zone transfer (AXFR) requests and incremental zone transfer (IXFR) requests
with AXFR fallback if the zone has changed.
.PP
2020-09-24 18:30:59 +00:00
When a plugin wants to notify it's secondaries it will call back into the \fItransfer\fP plugin.
.PP
The following plugins implement zone transfers using this plugin: \fIfile\fP, \fIauto\fP, \fIsecondary\fP, and
\fIkubernetes\fP. See \fB\fCtransfer.go\fR for implementation details if you are a plugin author that wants to
use this plugin.
.SH "SYNTAX"
.PP
.RS
.nf
transfer [ZONE...] {
2020-09-24 18:30:59 +00:00
to ADDRESS...
}
.fi
.RE
.IP \(bu 4
2020-09-24 18:30:59 +00:00
\fBZONE\fP The zones \fItransfer\fP will answer zone transfer requests for. If left blank, the zones
are inherited from the enclosing server block. To answer zone transfers for a given zone,
there must be another plugin in the same server block that serves the same zone, and implements
\fB\fCtransfer.Transferer\fR.
.IP \(bu 4
2020-09-24 18:30:59 +00:00
\fB\fCto\fR \fBADDRESS...\fP The hosts \fItransfer\fP will transfer to. Use \fB\fC*\fR to permit transfers to all
addresses. Zone change notifications are sent to all \fBADDRESS\fP that are an IP address or
an IP address and port e.g. \fB\fC1.2.3.4\fR, \fB\fC12:34::56\fR, \fB\fC1.2.3.4:5300\fR, \fB\fC[12:34::56]:5300\fR.
\fB\fCto\fR may be specified multiple times.
.PP
You can use the \fIacl\fP plugin to further restrict hosts permitted to receive a zone transfer.
See example below.
.SH "EXAMPLES"
.PP
Use in conjunction with the \fIacl\fP plugin to restrict access to subnet 10.1.0.0/16.
.PP
.RS
.nf
\&...
acl {
allow type AXFR net 10.1.0.0/16
allow type IXFR net 10.1.0.0/16
block type AXFR net *
block type IXFR net *
}
transfer {
to *
}
\&...
.fi
.RE
.PP
Each plugin that can use \fItransfer\fP includes an example of use in their respective documentation.