rndc(8) - phpMan

RNDC(8) BIND9 RNDC(8)

NAME
rndc - name server control utility

SYNOPSIS
rndc [-b source-address] [-c config-file] [-k key-file] [-s server] [-p port] [-q] [-r]
[-V] [-y key_id] {command}

DESCRIPTION
rndc controls the operation of a name server. It supersedes the ndc utility that was
provided in old BIND releases. If rndc 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.

rndc communicates with the name server over a TCP connection, sending commands
authenticated with digital signatures. In the current versions of rndc and named, 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.

rndc reads a configuration file to determine how to contact the name server and decide
what algorithm and key it should use.

OPTIONS
-b source-address
Use source-address 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.

-c config-file
Use config-file as the configuration file instead of the default, /etc/rndc.conf.

-k key-file
Use key-file as the key file instead of the default, /etc/rndc.key. The key in
/etc/rndc.key will be used to authenticate commands sent to the server if the
config-file does not exist.

-s server
server is the name or address of the server which matches a server statement in the
configuration file for rndc. If no server is supplied on the command line, the host
named by the default-server clause in the options statement of the rndc configuration
file will be used.

-p port
Send commands to TCP port port instead of BIND 9's default control channel port, 953.

-q
Quiet mode: Message text returned by the server will not be printed except when there
is an error.

-r
Instructs rndc to print the result code returned by named after executing the
requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).

-V
Enable verbose logging.

-y key_id
Use the key key_id from the configuration file. key_id must be known by named with
the same algorithm and secret string in order for control message validation to
succeed. If no key_id is specified, rndc 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.

COMMANDS
A list of commands supported by rndc can be seen by running rndc without arguments.

Currently supported commands are:

addzone zone [class [view]] configuration
Add a zone while the server is running. This command requires the allow-new-zones
option to be set to yes. The configuration string specified on the command line is the
zone configuration text that would ordinarily be placed in named.conf.

The configuration is saved in a file called name.nzf, where name is the name of the
view, or if it contains characters that are incompatible with use as a file name, a
cryptographic hash generated from the name of the view. When named is restarted, the
file will be loaded into the view configuration, so that zones that were added can
persist after a restart.

This sample addzone command would add the zone example.com to the default view:

$rndc addzone example.com '{ type master; file "example.com.db"; };'

(Note the brackets and semi-colon around the zone configuration text.)