NetBSD/dist/bind/man/named-xfer.8

212 lines
7.6 KiB
Groff

.\" $NetBSD: named-xfer.8,v 1.9 2003/08/07 09:21:06 agc Exp $
.\"
.\" ++Copyright++ 1985
.\" -
.\" Copyright (c) 1985
.\" The Regents of the University of California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\" -
.\" Portions Copyright (c) 1993 by Digital Equipment Corporation.
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies, and that
.\" the name of Digital Equipment Corporation not be used in advertising or
.\" publicity pertaining to distribution of the document or software without
.\" specific, written prior permission.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT
.\" CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
.\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
.\" SOFTWARE.
.\" -
.\" Portions Copyright (c) 1999 by Check Point Software Technologies, Inc.
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies, and that
.\" the name of Check Point Software Technologies Incorporated not be used
.\" in advertising or publicity pertaining to distribution of the document
.\" or software without specific, written prior permission.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND CHECK POINT SOFTWARE TECHNOLOGIES
.\" INCORPORATED DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
.\" IN NO EVENT SHALL CHECK POINT SOFTWARE TECHNOLOGIES INCORPORATED
.\" BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR
.\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
.\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\" --Copyright--
.\"
.\" from named.8 6.6 (Berkeley) 2/14/89
.\"
.Dd June 26, 1993
.Dt NAMED-XFER 8
.Os
.Sh NAME
.Nm named-xfer
.Nd ancillary agent for inbound zone transfers
.Sh SYNOPSIS
.Nm named-xfer
.Fl z Ar zone_to_transfer
.Fl f Ar db_file
.Fl s Ar serial_no
.Op Fl d Ar debuglevel
.Op Fl l Ar debug_log_file
.Op Fl i Ar ixfr_file
.Op Fl t Ar trace_file
.Op Fl p Ar port#
.Op Fl C Ar class
.Op Fl S
.Op Fl q
.Op Fl x Ar src_address
.Op Fl T Ar tsig_file
.Ar nameserver
.Op Sy axfr | ixfr
.Sh DESCRIPTION
.Ic Named-xfer
is an ancillary program executed by
.Xr named 8
to perform an inbound zone transfer. It is rarely executed directly, and then
only by system administrators who are trying to debug a zone transfer problem.
See RFC's 1033, 1034, and 1035 for more information on the Internet
name-domain system.
.Pp
Options are:
.Bl -tag -width Fl
.It Fl z Ar zone_to_transfer
specifies the name of the zone to be transferred.
.It Fl f Ar db_file
specifies the name of the
.Ar db_file
into which the zone should be dumped
when it is received from the primary server.
.It Fl s Ar serial_no
specifies the serial number of our current copy of this zone. If the
.Sy SOA RR
we get from the primary server does not have a serial
number higher than this, the transfer will be aborted.
.It Fl d Ar debuglevel
Print debugging information.
The
.Ar debuglevel
is a number determines the level of messages printed.
.It Fl l Ar debug_log_file
Specifies a log file for debugging messages. The default is system-
dependent but is usually in
.Pa /var/tmp
or
.Pa /usr/tmp .
Note that this only applies if
.Dq Fl d
is also specified.
.It Fl i Ar ixfr_file
Specifies the name of the
.Ar ixfr_file
into which the zone changes from Incremental Zone Transfer (IXFR)
should be dumped when it is received from the primary server.
.It Fl t Ar trace_file
Specifies a
.Ar trace_file
which will contain a protocol trace of the zone
transfer. This is probably only of interest to people debugging the name
server itself.
.It Fl p Ar port#
Use a different port number. The default is the standard port number
as returned by
.Xr getservbyname 3
for the service
.Dq Li domain .
.It Fl C Ar class
Defines which class to use.
Defaults to 'IN'.
.It Fl S
Perform a restricted transfer of only the SOA, NS records and glue A records
for the zone. The SOA record will not be loaded by
.Xr named 8
but will be used to
determine when to verify the NS records. See the
.Dq Li stubs
directive in
.Xr named 8
for more information.
.It Fl q
Tells named-xfer to be quiet.
.It Fl x Ar src_address
Specifies the source address to use for this query.
.It Fl T Ar tsig_file
Specifies a file to transfer TSIG information to named-xfer.
Multiple entries of the following format:
.Pp
.Bl -hang -width "IP address" -compact
.It IP address
When connecting to this address use this TSIG key.
.It key name
.It algorithm
157 (HMAC-MD5) is the only algorithm supported.
.It key data
base64
.El
.Pp
named-xfer expects this file to be temporary in nature and
will explicitly delete this file after its use.
.El
.Pp
Additional arguments are taken as name server addresses in so-called
.Dq dotted-quad
syntax
.Em only ;
no host name are allowed here. At least one address must be specified.
Any additional addresses will be tried, in order, if the first one fails
to transfer to us successfully.
The
.Sy axfr
or
.Sy ixfr
after name server address designates the type of zone transfer to perform.
Use
.Sy axfr
for a full zone transfer or
.Sy ixfr
for an incremental zone transfer.
.Sh SEE ALSO
.Xr hostname 7 ,
.Xr named 8 ,
.Xr resolver 3 ,
.Xr resolv.conf 5 ,
RFC 882, RFC 883, RFC 973, RFC 974, RFC 1033, RFC 1034, RFC 1035,
RFC 1123, RFC 1995
.Dq Name Server Operations Guide for Sy BIND .
.Sh BUGS
.Nm
does not support DNS queries/replies over IPv6 transport.