985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley [<!ENTITY mdash "&#8212;">]>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley<refentry id="man.rndc">

904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley <refentryinfo>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <date>August 15, 2014</date>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley </refentryinfo>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <refmeta>

904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley <refentrytitle><application>rndc</application></refentrytitle>

904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley <manvolnum>8</manvolnum>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refmiscinfo>BIND9</refmiscinfo>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley </refmeta>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refnamediv>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refname><application>rndc</application></refname>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refpurpose>name server control utility</refpurpose>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley </refnamediv>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <docinfo>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <copyright>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <year>2004</year>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <year>2005</year>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <year>2007</year>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <year>2013</year>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <year>2014</year>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </copyright>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <copyright>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <year>2000</year>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <year>2001</year>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <holder>Internet Software Consortium.</holder>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </copyright>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley </docinfo>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <refsynopsisdiv>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <cmdsynopsis>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <command>rndc</command>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley <arg><option>-q</option></arg>

3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff <arg><option>-V</option></arg>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <arg choice="req">command</arg>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </cmdsynopsis>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </refsynopsisdiv>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refsect1>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <title>DESCRIPTION</title>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para><command>rndc</command>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews controls the operation of a name

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews server. It supersedes the <command>ndc</command> utility

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews that was provided in old BIND releases. If

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <command>rndc</command> is invoked with no command line

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews options or arguments, it prints a short summary of the

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews supported commands and the available options and their

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews arguments.

3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para><command>rndc</command>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews communicates with the name server over a TCP connection, sending

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews commands authenticated with digital signatures. In the current

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews versions of

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <command>rndc</command> and <command>named</command>,

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews the only supported authentication algorithms are HMAC-MD5

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews (default), HMAC-SHA384 and HMAC-SHA512.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews They use a shared secret on each end of the connection.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews This provides TSIG-style authentication for the command

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews request and the name server's response. All commands sent

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews over the channel must be signed by a key_id known to the

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews server.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para><command>rndc</command>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews reads a configuration file to

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews determine how to contact the name server and decide what

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews algorithm and key it should use.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </refsect1>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refsect1>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <title>OPTIONS</title>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <variablelist>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-b <replaceable class="parameter">source-address</replaceable></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Use <replaceable class="parameter">source-address</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews as the source address for the connection to the server.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Multiple instances are permitted to allow setting of both

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews the IPv4 and IPv6 source addresses.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-c <replaceable class="parameter">config-file</replaceable></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Use <replaceable class="parameter">config-file</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews as the configuration file instead of the default,

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <filename>/etc/rndc.conf</filename>.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-k <replaceable class="parameter">key-file</replaceable></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Use <replaceable class="parameter">key-file</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews as the key file instead of the default,

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <filename>/etc/rndc.key</filename>. The key in

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <filename>/etc/rndc.key</filename> will be used to

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews authenticate

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews commands sent to the server if the <replaceable class="parameter">config-file</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews does not exist.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-s <replaceable class="parameter">server</replaceable></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para><replaceable class="parameter">server</replaceable> is

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews the name or address of the server which matches a

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews server statement in the configuration file for

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <command>rndc</command>. If no server is supplied on the

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews command line, the host named by the default-server clause

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews in the options statement of the <command>rndc</command>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews configuration file will be used.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-p <replaceable class="parameter">port</replaceable></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Send commands to TCP port

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <replaceable class="parameter">port</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews instead

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews of BIND 9's default control channel port, 953.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-q</term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Quiet mode: Message text returned by the server

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews will not be printed except when there is an error.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

62e22bc7a5497d759583693ba22d3ef4d9a042afAndreas Gustafsson </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-V</term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Enable verbose logging.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term>-y <replaceable class="parameter">key_id</replaceable></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Use the key <replaceable class="parameter">key_id</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews from the configuration file.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <replaceable class="parameter">key_id</replaceable>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews must be

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews known by named with the same algorithm and secret string

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews in order for control message validation to succeed.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews If no <replaceable class="parameter">key_id</replaceable>

62e22bc7a5497d759583693ba22d3ef4d9a042afAndreas Gustafsson is specified, <command>rndc</command> will first look

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews for a key clause in the server statement of the server

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews being used, or if no server statement is present for that

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews host, then the default-key clause of the options statement.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Note that the configuration file contains shared secrets

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews which are used to send authenticated control commands

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews to name servers. It should therefore not have general read

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews or write access.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </variablelist>

de10b83a231451e03d08b3293c503d11ea03a90bMark Andrews </refsect1>

de10b83a231451e03d08b3293c503d11ea03a90bMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <refsect1>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <title>COMMANDS</title>

de10b83a231451e03d08b3293c503d11ea03a90bMark Andrews <para>

de10b83a231451e03d08b3293c503d11ea03a90bMark Andrews A list of commands supported by <command>rndc</command> can

de10b83a231451e03d08b3293c503d11ea03a90bMark Andrews be seen by running <command>rndc</command> without arguments.

de10b83a231451e03d08b3293c503d11ea03a90bMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Currently supported commands are:

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

518be7faab2498c795e6dc9bb25ac10ca38b3a8dMark Andrews <variablelist>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term><userinput>reload</userinput></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

c1e7aff941dbf40090fec49300e728ad017d4f0cMark Andrews <para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews Reload configuration file and zones.

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </para>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </listitem>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews </varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <varlistentry>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <term><userinput>reload <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>

52637f592f705ca93fadc218e403fd55e8ce4aeaMark Andrews <listitem>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <para>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews Reload the given zone.

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </listitem>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <term><userinput>refresh <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <listitem>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews Schedule zone maintenance for the given zone.

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </para>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </listitem>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </varlistentry>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <term><userinput>retransfer <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <listitem>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews Retransfer the given slave zone from the master server.

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews If the zone is configured to use

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <command>inline-signing</command>, the signed

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews version of the zone is discarded; after the

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews retransfer of the unsigned version is complete, the

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews signed version will be regenerated with all new

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews signatures.

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </listitem>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <term><userinput>sign <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <listitem>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <para>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews Fetch all DNSSEC keys for the given zone

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews from the key directory (see the

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <command>key-directory</command> option in

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews the BIND 9 Administrator Reference Manual). If they are within

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews their publication period, merge them into the

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews zone's DNSKEY RRset. If the DNSKEY RRset

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews is changed, then the zone is automatically

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews re-signed with the new key set.

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </para>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <para>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews This command requires that the

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews <command>auto-dnssec</command> zone option be set

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews to <literal>allow</literal> or

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <literal>maintain</literal>,

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews and also requires the zone to be configured to

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews allow dynamic DNS.

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews (See "Dynamic Update Policies" in the Administrator

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews Reference Manual for more details.)

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </para>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </listitem>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews </varlistentry>

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <term><userinput>loadkeys <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <listitem>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews Fetch all DNSSEC keys for the given zone

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews from the key directory. If they are within

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews their publication period, merge them into the

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews zone's DNSKEY RRset. Unlike <command>rndc

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews sign</command>, however, the zone is not

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews immediately re-signed by the new keys, but is

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews allowed to incrementally re-sign over time.

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews This command requires that the

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <command>auto-dnssec</command> zone option

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews be set to <literal>maintain</literal>,

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews and also requires the zone to be configured to

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews allow dynamic DNS.

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews (See "Dynamic Update Policies" in the Administrator

1ef8965366d91e02a4672c35a187d30aa4a4c72cMark Andrews Reference Manual for more details.)

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </para>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </listitem>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews </varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <varlistentry>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <term><userinput>freeze <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>

d0221bfa6a08f7b284b231886928aa5d8ac87fc2Mark Andrews <listitem>

904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley <para>

904a5734375869ffb504ed8cde6b68cafadb6d64Bob Halley Suspend updates to a dynamic zone. If no zone is

985687b4e080182c1a3a2173df02b94a5b78b24fBob Halley 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.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>thaw <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>

<listitem>

<para>

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

<command>ixfr-from-differences</command> 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.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>scan</userinput></term>

<listitem>

<para>

Scan the list of available network interfaces

for changes, without performing a full

<command>reconfig</command> or waiting for the

<command>interface-interval</command> timer.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>sync <optional>-clean</optional> <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>

<listitem>

<para>

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.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>notify <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>

<listitem>

<para>

Resend NOTIFY messages for the zone.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>reconfig</userinput></term>

<listitem>

<para>

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 <command>reload</command> when there

is a large number of zones because it avoids the need

to examine the

modification times of the zones files.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>zonestatus <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>

<listitem>

<para>

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.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>stats</userinput></term>

<listitem>

<para>

Write server statistics to the statistics file.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>querylog</userinput> <optional>on|off</optional> </term>

<listitem>

<para>

Enable or disable query logging. (For backward

compatibility, this command can also be used without

an argument to toggle query logging on and off.)

</para>

<para>

Query logging can also be enabled

by explicitly directing the <command>queries</command>

<command>category</command> to a

<command>channel</command> in the

<command>logging</command> section of

<filename>named.conf</filename> or by specifying

<command>querylog yes;</command> in the

<command>options</command> section of

<filename>named.conf</filename>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>dumpdb <optional>-all|-cache|-zone</optional> <optional><replaceable>view ...</replaceable></optional></userinput></term>

<listitem>

<para>

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.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>secroots <optional><replaceable>view ...</replaceable></optional></userinput></term>

<listitem>

<para>

Dump the server's security roots and negative trust anchors

to the secroots file for the specified views. If no view is

specified, all views are dumped.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>stop <optional>-p</optional></userinput></term>

<listitem>

<para>

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 <option>-p</option> is specified <command>named</command>'s process id is returned.

This allows an external process to determine when <command>named</command>

had completed stopping.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>halt <optional>-p</optional></userinput></term>

<listitem>

<para>

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 <option>-p</option> is specified <command>named</command>'s process id is returned.

This allows an external process to determine when <command>named</command>

had completed halting.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>trace</userinput></term>

<listitem>

<para>

Increment the servers debugging level by one.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>trace <replaceable>level</replaceable></userinput></term>

<listitem>

<para>

Sets the server's debugging level to an explicit

value.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>notrace</userinput></term>

<listitem>

<para>

Sets the server's debugging level to 0.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>flush</userinput></term>

<listitem>

<para>

Flushes the server's cache.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>flushname</userinput> <replaceable>name</replaceable> <optional><replaceable>view</replaceable></optional> </term>

<listitem>

<para>

Flushes the given name from the server's DNS cache

and, if applicable, from the server's nameserver address

database or bad-server cache.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>flushtree</userinput> <replaceable>name</replaceable> <optional><replaceable>view</replaceable></optional> </term>

<listitem>

<para>

Flushes the given name, and all of its subdomains,

from the server's DNS cache, the address database,

and the bad server cache.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>status</userinput></term>

<listitem>

<para>

Display status of the server.

Note that the number of zones includes the internal <command>bind/CH</command> zone

and the default <command>/IN</command>

hint zone if there is not an

explicit root zone configured.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>recursing</userinput></term>

<listitem>

<para>

Dump the list of queries <command>named</command> is currently recursing

on.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>validation ( on | off | check ) <optional><replaceable>view ...</replaceable></optional> </userinput></term>

<listitem>

<para>

Enable, disable, or check the current status of

DNSSEC validation.

Note <command>dnssec-enable</command> also needs to be

set to <userinput>yes</userinput> or

<userinput>auto</userinput> to be effective.

It defaults to enabled.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>nta

<optional>( -d | -f | -r | -l <replaceable>duration</replaceable>)</optional>

<replaceable>domain</replaceable>

<optional><replaceable>view</replaceable></optional>

</userinput></term>

<listitem>

<para>

Sets a DNSSEC negative trust anchor (NTA)

for <option>domain</option>, with a lifetime of

<option>lifetime</option>. The default lifetime is

configured in <file>named.conf</file> via the

<option>nta-lifetime</option>, and defaults to

one hour. The lifetime cannot exceed one day.

</para>

<para>

A negative trust anchor selectively disables

DNSSEC validation for zones that known to be

failing because of misconfiguration rather than

an attack. When data to be validated is

at or below an active NTA (and above any other

configured trust anchors), <command>named</command> will

abort the DNSSEC validation process and treat the data as

insecure rather than bogus. This continues until the

NTA's lifetime is elapsed, or until the server is

restarted (NTA's do not persist across restarts).

</para>

<para>

An existing NTA can be removed by using the

<option>-remove</option> option.

</para>

<para>

An NTA's lifetime can be specified with the

<option>-lifetime</option> option. TTL-style

suffixes can be used to specify the lifetime in

seconds, minutes, or hours. If the specified NTA

already exists, its lifetime will be updated to the

new value. Setting <option>lifetime</option> to zero

is equivalent to <option>-remove</option>.

</para>

<para>

If <option>-dump</option> is used, any other arguments

are ignored, and a list of existing NTAs is printed

(note that this may include NTAs that are expired but

have not yet been cleaned up).

</para>

<para>

Normally, <command>named</command> will periodically

test to see whether data below an NTA can now be

validated (see the <option>nta-recheck</option> option

in the Administrator Reference Manual for details).

If data can be validated, then the NTA is regarded as

no longer necessary, and will be allowed to expire

early. The <option>-force</option> overrides this

behavior and forces an NTA to persist for its entire

lifetime, regardless of whether data could be

validated if the NTA were not present.

</para>

<para>

All of these options can be shortened, i.e., to

<option>-l</option>, <option>-r</option>, <option>-d</option>,

and <option>-f</option>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>tsig-list</userinput></term>

<listitem>

<para>

List the names of all TSIG keys currently configured

for use by <command>named</command> in each view. The

list both statically configured keys and dynamic

TKEY-negotiated keys.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>tsig-delete</userinput> <replaceable>keyname</replaceable> <optional><replaceable>view</replaceable></optional></term>

<listitem>

<para>

Delete a given TKEY-negotiated key from the server.

(This does not apply to statically configured TSIG

keys.)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>addzone <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> <replaceable>configuration</replaceable> </userinput></term>

<listitem>

<para>

Add a zone while the server is running. This

command requires the

<command>allow-new-zones</command> option to be set

to <userinput>yes</userinput>. The

<replaceable>configuration</replaceable> string

specified on the command line is the zone

configuration text that would ordinarily be

placed in <filename>named.conf</filename>.

</para>

<para>

The configuration is saved in a file called

<filename><replaceable>hash</replaceable>.nzf</filename>,

where <replaceable>hash</replaceable> is a

cryptographic hash generated from the name of

the view. When <command>named</command> is

restarted, the file will be loaded into the view

configuration, so that zones that were added

can persist after a restart.

</para>

<para>

This sample <command>addzone</command> command

would add the zone <literal>example.com</literal>

to the default view:

</para>

<para>

<prompt>$ </prompt><userinput>rndc addzone example.com '{ type master; file "example.com.db"; };'</userinput>

</para>

<para>

(Note the brackets and semi-colon around the zone

configuration text.)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>delzone <optional>-clean</optional> <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> </userinput></term>

<listitem>

<para>

Delete a zone while the server is running.

Only zones that were originally added via

<command>rndc addzone</command> can be deleted

in this manner.

</para>

<para>

If the <option>-clean</option> is specified,

the zone's master file (and journal file, if any)

will be deleted along with the zone. Without the

<option>-clean</option> 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 <command>rndc delzone</command> command.)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><userinput>signing <optional>( -list | -clear <replaceable>keyid/algorithm</replaceable> | -clear <literal>all</literal> | -nsec3param ( <replaceable>parameters</replaceable> | <literal>none</literal> ) ) </optional> <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> </userinput></term>

<listitem>

<para>

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

<command>sig-signing-type</command>.

<command>rndc signing -list</command> 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.

</para>

<para>

<command>rndc signing -clear</command> can remove

a single key (specified in the same format that

<command>rndc signing -list</command> 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.

</para>

<para>

<command>rndc signing -nsec3param</command> sets

the NSEC3 parameters for a zone. This is the

only supported mechanism for using NSEC3 with

<command>inline-signing</command> zones.

Parameters are specified in the same format as

an NSEC3PARAM resource record: hash algorithm,

flags, iterations, and salt, in that order.

</para>

<para>

Currently, the only defined value for hash algorithm

is <literal>1</literal>, representing SHA-1.

The <option>flags</option> may be set to

<literal>0</literal> or <literal>1</literal>,

depending on whether you wish to set the opt-out

bit in the NSEC3 chain. <option>iterations</option>

defines the number of additional times to apply

the algorithm when generating an NSEC3 hash. The

<option>salt</option> is a string of data expressed

in hexadecimal, a hyphen (`-') if no salt is

to be used, or the keyword <literal>auto</literal>,

which causes <command>named</command> to generate a

random 64-bit salt.

</para>

<para>

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:

<command>rndc signing -nsec3param 1 0 10 FFFF <replaceable>zone</replaceable></command>.

To set the opt-out flag, 15 iterations, and no

salt, use:

<command>rndc signing -nsec3param 1 1 15 - <replaceable>zone</replaceable></command>.

</para>

<para>

<command>rndc signing -nsec3param none</command>

removes an existing NSEC3 chain and replaces it

with NSEC.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>LIMITATIONS</title>

<para>

There is currently no way to provide the shared secret for a

<option>key_id</option> without using the configuration file.

</para>

<para>

Several error messages could be clearer.

</para>

</refsect1>

<refsect1>

<title>SEE ALSO</title>

<para><citerefentry>

<refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>ndc</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citetitle>BIND 9 Administrator Reference Manual</citetitle>.

</para>

</refsect1>

<refsect1>

<title>AUTHOR</title>

<para><corpauthor>Internet Systems Consortium</corpauthor>

</para>

</refsect1>

</refentry><!--