etc/services - sync with NetBSD-8

[minix.git] / external / bsd / bind / dist / bin / rndc / rndc.8

.\"     $NetBSD: rndc.8,v 1.7 2014/12/10 04:37:52 christos Exp $
.\"
.\" Copyright (C) 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.\" Copyright (C) 2000, 2001 Internet Software Consortium.
.\" 
.\" Permission to use, copy, modify, and/or 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.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
.\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
.\" AND FITNESS. IN NO EVENT SHALL ISC 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.
.\"
.\" Id
.\"
.hy 0
.ad l
.\"     Title: rndc
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
.\"      Date: August 15, 2014
.\"    Manual: BIND9
.\"    Source: BIND9
.\"
.TH "RNDC" "8" "August 15, 2014" "BIND9" "BIND9"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
rndc \- name server control utility
.SH "SYNOPSIS"
.HP 5
\fBrndc\fR [\fB\-b\ \fR\fB\fIsource\-address\fR\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-k\ \fR\fB\fIkey\-file\fR\fR] [\fB\-s\ \fR\fB\fIserver\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-q\fR] [\fB\-V\fR] [\fB\-y\ \fR\fB\fIkey_id\fR\fR] {command}
.SH "DESCRIPTION"
.PP
\fBrndc\fR
controls the operation of a name server. It supersedes the
\fBndc\fR
utility that was provided in old BIND releases. If
\fBrndc\fR
is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments.
.PP
\fBrndc\fR
communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of
\fBrndc\fR
and
\fBnamed\fR, the only supported authentication algorithms are HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512. They use a shared secret on each end of the connection. This provides TSIG\-style authentication for the command request and the name server's response. All commands sent over the channel must be signed by a key_id known to the server.
.PP
\fBrndc\fR
reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.
.SH "OPTIONS"
.PP
\-b \fIsource\-address\fR
.RS 4
Use
\fIsource\-address\fR
as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses.
.RE
.PP
\-c \fIconfig\-file\fR
.RS 4
Use
\fIconfig\-file\fR
as the configuration file instead of the default,
\fI/etc/rndc.conf\fR.
.RE
.PP
\-k \fIkey\-file\fR
.RS 4
Use
\fIkey\-file\fR
as the key file instead of the default,
\fI/etc/rndc.key\fR. The key in
\fI/etc/rndc.key\fR
will be used to authenticate commands sent to the server if the
\fIconfig\-file\fR
does not exist.
.RE
.PP
\-s \fIserver\fR
.RS 4
\fIserver\fR
is the name or address of the server which matches a server statement in the configuration file for
\fBrndc\fR. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the
\fBrndc\fR
configuration file will be used.
.RE
.PP
\-p \fIport\fR
.RS 4
Send commands to TCP port
\fIport\fR
instead of BIND 9's default control channel port, 953.
.RE
.PP
\-q
.RS 4
Quiet mode: Message text returned by the server will not be printed except when there is an error.
.RE
.PP
\-V
.RS 4
Enable verbose logging.
.RE
.PP
\-y \fIkey_id\fR
.RS 4
Use the key
\fIkey_id\fR
from the configuration file.
\fIkey_id\fR
must be known by named with the same algorithm and secret string in order for control message validation to succeed. If no
\fIkey_id\fR
is specified,
\fBrndc\fR
will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers. It should therefore not have general read or write access.
.RE
.SH "COMMANDS"
.PP
A list of commands supported by
\fBrndc\fR
can be seen by running
\fBrndc\fR
without arguments.
.PP
Currently supported commands are:
.PP
\fBreload\fR
.RS 4
Reload configuration file and zones.
.RE
.PP
\fBreload \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Reload the given zone.
.RE
.PP
\fBrefresh \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Schedule zone maintenance for the given zone.
.RE
.PP
\fBretransfer \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Retransfer the given slave zone from the master server.
.sp
If the zone is configured to use
\fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures.
.RE
.PP
\fBsign \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Fetch all DNSSEC keys for the given zone from the key directory (see the
\fBkey\-directory\fR
option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set.
.sp
This command requires that the
\fBauto\-dnssec\fR
zone option be set to
allow
or
maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)
.RE
.PP
\fBloadkeys \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Fetch all DNSSEC keys for the given zone from the key directory. If they are within their publication period, merge them into the zone's DNSKEY RRset. Unlike
\fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time.
.sp
This command requires that the
\fBauto\-dnssec\fR
zone option be set to
maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)
.RE
.PP
\fBfreeze \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by dynamic update. It also causes changes in the journal file to be synced into the master file. All dynamic update attempts will be refused while the zone is frozen.
.RE
.PP
\fBthaw \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
Enable updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone from disk, and re\-enables dynamic updates after the load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the
\fBixfr\-from\-differences\fR
option is in use, then the journal file will be updated to reflect changes in the zone. Otherwise, if the zone has changed, any existing journal file will be removed.
.RE
.PP
\fBscan\fR
.RS 4
Scan the list of available network interfaces for changes, without performing a full
\fBreconfig\fR
or waiting for the
\fBinterface\-interval\fR
timer.
.RE
.PP
\fBsync \fR\fB[\-clean]\fR\fB \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
Sync changes in the journal file for a dynamic zone to the master file. If the "\-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced.
.RE
.PP
\fBnotify \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
.RS 4
Resend NOTIFY messages for the zone.
.RE
.PP
\fBreconfig\fR
.RS 4
Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed. This is faster than a full
\fBreload\fR
when there is a large number of zones because it avoids the need to examine the modification times of the zones files.
.RE
.PP
\fBzonestatus \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
.RS 4
Displays the current status of the given zone, including the master file name and any include files from which it was loaded, when it was most recently loaded, the current serial number, the number of nodes, whether the zone supports dynamic updates, whether the zone is DNSSEC signed, whether it uses automatic DNSSEC key management or inline signing, and the scheduled refresh or expiry times for the zone.
.RE
.PP
\fBstats\fR
.RS 4
Write server statistics to the statistics file.
.RE
.PP
\fBquerylog\fR [on|off]
.RS 4
Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)
.sp
Query logging can also be enabled by explicitly directing the
\fBqueries\fR
\fBcategory\fR
to a
\fBchannel\fR
in the
\fBlogging\fR
section of
\fInamed.conf\fR
or by specifying
\fBquerylog yes;\fR
in the
\fBoptions\fR
section of
\fInamed.conf\fR.
.RE
.PP
\fBdumpdb \fR\fB[\-all|\-cache|\-zone]\fR\fB \fR\fB[\fIview ...\fR]\fR
.RS 4
Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped.
.RE
.PP
\fBsecroots \fR\fB[\fIview ...\fR]\fR
.RS 4
Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped.
.RE
.PP
\fBstop \fR\fB[\-p]\fR
.RS 4
Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. If
\fB\-p\fR
is specified
\fBnamed\fR's process id is returned. This allows an external process to determine when
\fBnamed\fR
had completed stopping.
.RE
.PP
\fBhalt \fR\fB[\-p]\fR
.RS 4
Stop the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the journal files when the server is restarted. If
\fB\-p\fR
is specified
\fBnamed\fR's process id is returned. This allows an external process to determine when
\fBnamed\fR
had completed halting.
.RE
.PP
\fBtrace\fR
.RS 4
Increment the servers debugging level by one.
.RE
.PP
\fBtrace \fR\fB\fIlevel\fR\fR
.RS 4
Sets the server's debugging level to an explicit value.
.RE
.PP
\fBnotrace\fR
.RS 4
Sets the server's debugging level to 0.
.RE
.PP
\fBflush\fR
.RS 4
Flushes the server's cache.
.RE
.PP
\fBflushname\fR \fIname\fR [\fIview\fR]
.RS 4
Flushes the given name from the server's DNS cache and, if applicable, from the server's nameserver address database or bad\-server cache.
.RE
.PP
\fBflushtree\fR \fIname\fR [\fIview\fR]
.RS 4
Flushes the given name, and all of its subdomains, from the server's DNS cache, the address database, and the bad server cache.
.RE
.PP
\fBstatus\fR
.RS 4
Display status of the server. Note that the number of zones includes the internal
\fBbind/CH\fR
zone and the default
\fB./IN\fR
hint zone if there is not an explicit root zone configured.
.RE
.PP
\fBrecursing\fR
.RS 4
Dump the list of queries
\fBnamed\fR
is currently recursing on.
.RE
.PP
\fBvalidation ( on | off | check ) \fR\fB[\fIview ...\fR]\fR\fB \fR
.RS 4
Enable, disable, or check the current status of DNSSEC validation. Note
\fBdnssec\-enable\fR
also needs to be set to
\fByes\fR
or
\fBauto\fR
to be effective. It defaults to enabled.
.RE
.PP
\fBtsig\-list\fR
.RS 4
List the names of all TSIG keys currently configured for use by
\fBnamed\fR
in each view. The list both statically configured keys and dynamic TKEY\-negotiated keys.
.RE
.PP
\fBtsig\-delete\fR \fIkeyname\fR [\fIview\fR]
.RS 4
Delete a given TKEY\-negotiated key from the server. (This does not apply to statically configured TSIG keys.)
.RE
.PP
\fBaddzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR
.RS 4
Add a zone while the server is running. This command requires the
\fBallow\-new\-zones\fR
option to be set to
\fByes\fR. The
\fIconfiguration\fR
string specified on the command line is the zone configuration text that would ordinarily be placed in
\fInamed.conf\fR.
.sp
The configuration is saved in a file called
\fI\fIhash\fR\fR\fI.nzf\fR, where
\fIhash\fR
is a cryptographic hash generated from the name of the view. When
\fBnamed\fR
is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart.
.sp
This sample
\fBaddzone\fR
command would add the zone
example.com
to the default view:
.sp
$\fBrndc addzone example.com '{ type master; file "example.com.db"; };'\fR
.sp
(Note the brackets and semi\-colon around the zone configuration text.)
.RE
.PP
\fBdelzone \fR\fB[\-clean]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
.RS 4
Delete a zone while the server is running. Only zones that were originally added via
\fBrndc addzone\fR
can be deleted in this manner.
.sp
If the
\fB\-clean\fR
is specified, the zone's master file (and journal file, if any) will be deleted along with the zone. Without the
\fB\-clean\fR
option, zone files must be cleaned up by hand. (If the zone is of type "slave" or "stub", the files needing to be cleaned up will be reported in the output of the
\fBrndc delzone\fR
command.)
.RE
.PP
\fBsigning \fR\fB[( \-list | \-clear \fIkeyid/algorithm\fR | \-clear all | \-nsec3param ( \fIparameters\fR | none ) ) ]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
.RS 4
List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type
\fBsig\-signing\-type\fR.
\fBrndc signing \-list\fR
converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed.
.sp
\fBrndc signing \-clear\fR
can remove a single key (specified in the same format that
\fBrndc signing \-list\fR
uses to display it), or all keys. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained.
.sp
\fBrndc signing \-nsec3param\fR
sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with
\fBinline\-signing\fR
zones. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order.
.sp
Currently, the only defined value for hash algorithm is
1, representing SHA\-1. The
\fBflags\fR
may be set to
0
or
1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain.
\fBiterations\fR
defines the number of additional times to apply the algorithm when generating an NSEC3 hash. The
\fBsalt\fR
is a string of data expressed in hexadecimal, a hyphen (`\-') if no salt is to be used, or the keyword
auto, which causes
\fBnamed\fR
to generate a random 64\-bit salt.
.sp
So, for example, to create an NSEC3 chain using the SHA\-1 hash algorithm, no opt\-out flag, 10 iterations, and a salt value of "FFFF", use:
\fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR. To set the opt\-out flag, 15 iterations, and no salt, use:
\fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR.
.sp
\fBrndc signing \-nsec3param none\fR
removes an existing NSEC3 chain and replaces it with NSEC.
.RE
.SH "LIMITATIONS"
.PP
There is currently no way to provide the shared secret for a
\fBkey_id\fR
without using the configuration file.
.PP
Several error messages could be clearer.
.SH "SEE ALSO"
.PP
\fBrndc.conf\fR(5),
\fBrndc\-confgen\fR(8),
\fBnamed\fR(8),
\fBnamed.conf\fR(5),
\fBndc\fR(8),
BIND 9 Administrator Reference Manual.
.SH "AUTHOR"
.PP
Internet Systems Consortium
.SH "COPYRIGHT"
Copyright \(co 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
.br
Copyright \(co 2000, 2001 Internet Software Consortium.
.br