rndc.docbook revision 2637d30fbd235fe98145f4312b10cc41a13bf7dc
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync [<!ENTITY mdash "&#8212;">]>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<!--
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - Copyright (C) 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - Copyright (C) 2000, 2001 Internet Software Consortium.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync -
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - Permission to use, copy, modify, and/or distribute this software for any
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - purpose with or without fee is hereby granted, provided that the above
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - copyright notice and this permission notice appear in all copies.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync -
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync - PERFORMANCE OF THIS SOFTWARE.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync-->
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync<refentry id="man.rndc">
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refentryinfo>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <date>August 15, 2014</date>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </refentryinfo>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refmeta>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refentrytitle><application>rndc</application></refentrytitle>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <manvolnum>8</manvolnum>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refmiscinfo>BIND9</refmiscinfo>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </refmeta>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refnamediv>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refname><application>rndc</application></refname>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refpurpose>name server control utility</refpurpose>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </refnamediv>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <docinfo>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <copyright>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2004</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2005</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2007</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2013</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2014</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2015</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </copyright>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <copyright>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2000</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <year>2001</year>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <holder>Internet Software Consortium.</holder>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </copyright>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </docinfo>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refsynopsisdiv>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <cmdsynopsis>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>rndc</command>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-q</option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-V</option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <arg choice="req">command</arg>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </cmdsynopsis>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </refsynopsisdiv>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refsect1>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <title>DESCRIPTION</title>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para><command>rndc</command>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync controls the operation of a name
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync server. It supersedes the <command>ndc</command> utility
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync that was provided in old BIND releases. If
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>rndc</command> is invoked with no command line
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync options or arguments, it prints a short summary of the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync supported commands and the available options and their
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync arguments.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para><command>rndc</command>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync communicates with the name server over a TCP connection, sending
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync commands authenticated with digital signatures. In the current
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync versions of
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>rndc</command> and <command>named</command>,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync the only supported authentication algorithms are HMAC-MD5
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync (default), HMAC-SHA384 and HMAC-SHA512.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync They use a shared secret on each end of the connection.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync This provides TSIG-style authentication for the command
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync request and the name server's response. All commands sent
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync over the channel must be signed by a key_id known to the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync server.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para><command>rndc</command>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync reads a configuration file to
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync determine how to contact the name server and decide what
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync algorithm and key it should use.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </refsect1>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refsect1>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <title>OPTIONS</title>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <variablelist>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-b <replaceable class="parameter">source-address</replaceable></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Use <replaceable class="parameter">source-address</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync as the source address for the connection to the server.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Multiple instances are permitted to allow setting of both
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync the IPv4 and IPv6 source addresses.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-c <replaceable class="parameter">config-file</replaceable></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Use <replaceable class="parameter">config-file</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync as the configuration file instead of the default,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <filename>/etc/rndc.conf</filename>.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-k <replaceable class="parameter">key-file</replaceable></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Use <replaceable class="parameter">key-file</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync as the key file instead of the default,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <filename>/etc/rndc.key</filename>. The key in
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <filename>/etc/rndc.key</filename> will be used to
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync authenticate
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync commands sent to the server if the <replaceable class="parameter">config-file</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync does not exist.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-s <replaceable class="parameter">server</replaceable></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para><replaceable class="parameter">server</replaceable> is
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync the name or address of the server which matches a
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync server statement in the configuration file for
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>rndc</command>. If no server is supplied on the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync command line, the host named by the default-server clause
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync in the options statement of the <command>rndc</command>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync configuration file will be used.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-p <replaceable class="parameter">port</replaceable></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Send commands to TCP port
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <replaceable class="parameter">port</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync instead
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync of BIND 9's default control channel port, 953.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-q</term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Quiet mode: Message text returned by the server
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync will not be printed except when there is an error.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-V</term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Enable verbose logging.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term>-y <replaceable class="parameter">key_id</replaceable></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Use the key <replaceable class="parameter">key_id</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync from the configuration file.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <replaceable class="parameter">key_id</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync must be
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync known by <command>named</command> with the same algorithm and secret string
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync in order for control message validation to succeed.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync If no <replaceable class="parameter">key_id</replaceable>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync is specified, <command>rndc</command> will first look
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync for a key clause in the server statement of the server
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync being used, or if no server statement is present for that
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync host, then the default-key clause of the options statement.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Note that the configuration file contains shared secrets
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync which are used to send authenticated control commands
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync to name servers. It should therefore not have general read
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync or write access.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </variablelist>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </refsect1>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <refsect1>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <title>COMMANDS</title>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync A list of commands supported by <command>rndc</command> can
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync be seen by running <command>rndc</command> without arguments.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Currently supported commands are:
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <variablelist>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>reload</userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Reload configuration file and zones.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>reload <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Reload the given zone.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>refresh <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Schedule zone maintenance for the given zone.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>retransfer <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Retransfer the given slave zone from the master server.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync If the zone is configured to use
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>inline-signing</command>, the signed
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync version of the zone is discarded; after the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync retransfer of the unsigned version is complete, the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync signed version will be regenerated with all new
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync signatures.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>sign <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Fetch all DNSSEC keys for the given zone
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync from the key directory (see the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>key-directory</command> option in
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync the BIND 9 Administrator Reference Manual). If they are within
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync their publication period, merge them into the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync zone's DNSKEY RRset. If the DNSKEY RRset
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync is changed, then the zone is automatically
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync re-signed with the new key set.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync This command requires that the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>auto-dnssec</command> zone option be set
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync to <literal>allow</literal> or
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <literal>maintain</literal>,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync and also requires the zone to be configured to
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync allow dynamic DNS.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync (See "Dynamic Update Policies" in the Administrator
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Reference Manual for more details.)
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>loadkeys <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Fetch all DNSSEC keys for the given zone
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync from the key directory. If they are within
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync their publication period, merge them into the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync zone's DNSKEY RRset. Unlike <command>rndc
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync sign</command>, however, the zone is not
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync immediately re-signed by the new keys, but is
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync allowed to incrementally re-sign over time.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync This command requires that the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>auto-dnssec</command> zone option
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync be set to <literal>maintain</literal>,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync and also requires the zone to be configured to
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync allow dynamic DNS.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync (See "Dynamic Update Policies" in the Administrator
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Reference Manual for more details.)
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>freeze <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Suspend updates to a dynamic zone. If no zone is
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync specified, then all zones are suspended. This allows
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync manual edits to be made to a zone normally updated by
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync dynamic update. It also causes changes in the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync journal file to be synced into the master file.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync All dynamic update attempts will be refused while
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync the zone is frozen.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>thaw <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Enable updates to a frozen dynamic zone. If no
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync zone is specified, then all frozen zones are
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync enabled. This causes the server to reload the zone
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync from disk, and re-enables dynamic updates after the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync load has completed. After a zone is thawed,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync dynamic updates will no longer be refused. If
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync the zone has changed and the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>ixfr-from-differences</command> option is
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync in use, then the journal file will be updated to
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync reflect changes in the zone. Otherwise, if the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync zone has changed, any existing journal file will be
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync removed.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>scan</userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Scan the list of available network interfaces
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync for changes, without performing a full
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>reconfig</command> or waiting for the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <command>interface-interval</command> timer.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>sync <optional>-clean</optional> <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Sync changes in the journal file for a dynamic zone
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync to the master file. If the <option>-clean</option> option is
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync specified, the journal file is also removed. If
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync no zone is specified, then all zones are synced.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>notify <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Resend NOTIFY messages for the zone.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>reconfig</userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Reload the configuration file and load new zones,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync but do not reload existing zone files even if they
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync have changed.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync This is faster than a full <command>reload</command> when there
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync is a large number of zones because it avoids the need
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync to examine the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync modification times of the zones files.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <term><userinput>zonestatus <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync Displays the current status of the given zone,
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync including the master file name and any include
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync files from which it was loaded, when it was most
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync recently loaded, the current serial number, the
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync number of nodes, whether the zone supports
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync dynamic updates, whether the zone is DNSSEC
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync signed, whether it uses automatic DNSSEC key
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync management or inline signing, and the scheduled
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync refresh or expiry times for the zone.
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </para>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </listitem>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync </varlistentry>
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync
b8014c3bbb8a0f9d16e82278eabba771cbfd9b2evboxsync <varlistentry>
<term><userinput>managed-keys <replaceable>(status | refresh | sync)</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<listitem>
<para>
When run with the "status" keyword, print the current
status of the managed-keys database for the specified
view, or for all views if none is specified. When run
with the "refresh" keyword, force an immediate refresh
of all the managed-keys in the specified view, or all
views. When run with the "sync" keyword, force an
immediate dump of the managed-keys database to disk (in
the file <filename>managed-keys.bind</filename> or
(<filename><replaceable>viewname</replaceable>.mkeys</filename>).
</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>-</optional> <optional><replaceable>view ...</replaceable></optional></userinput></term>
<listitem>
<para>
Dump the server's security roots and negative trust anchors
for the specified views. If no view is specified, all views
are dumped.
</para>
<para>
If the first argument is "-", then the output is
returned via the <command>rndc</command> response channel
and printed to the standard output.
Otherwise, it is written to the secroots dump file, which
defaults to <filename>named.secroots</filename>, but can be
overridden via the <option>secroots-file</option> option in
<filename>named.conf</filename>.
</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 view's DNS cache
and, if applicable, from the view's nameserver address
database, bad server cache and SERVFAIL 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 view's DNS cache, address database,
bad server cache, and SERVFAIL 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>duration</option>. The default lifetime is
configured in <filename>named.conf</filename> via the
<option>nta-lifetime</option> option, and defaults to
one hour. The lifetime cannot exceed one week.
</para>
<para>
A negative trust anchor selectively disables
DNSSEC validation for zones that are 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.
</para>
<para>
NTAs persist across restarts of the <command>named</command> server.
The NTAs for a view are saved in a file called
<filename><replaceable>name</replaceable>.nta</filename>,
where <replaceable>name</replaceable> 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.
</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>name</replaceable>.nzf</filename>,
where <replaceable>name</replaceable> 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 <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>modzone <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> <replaceable>configuration</replaceable> </userinput></term>
<listitem>
<para>
Modify the configuration of a zone while the server
is running. This command requires the
<command>allow-new-zones</command> option to be
set to <userinput>yes</userinput>. As with
<command>addzone</command>, 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>
If the zone was originally added via
<command>rndc addzone</command>, the configuration
changes will be recorded permanently and will still be
in effect after the server is restarted or reconfigured.
However, if it was originally configured in
<filename>named.conf</filename>, then that original
configuration is still in place; when the server is
restarted or reconfigured, the zone will revert to
its original configuration. To make the changes
permanent, it must also be modified in
<filename>named.conf</filename>
</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.
</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>
<para>
If the zone was originally added via
<command>rndc addzone</command>, then it will be
removed permanently. However, if it was originally
configured in <filename>named.conf</filename>, then
that original configuration is still in place; when
the server is restarted or reconfigured, the zone will
come back. To remove it permanently, it must also be
removed from <filename>named.conf</filename>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>showzone <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> </userinput></term>
<listitem>
<para>
Print the configuration of a running zone.
</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> ) | -serial <replaceable>value</replaceable> ) </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>
<para>
<command>rndc signing -serial value</command> sets
the serial number of the zone to value. If the value
would cause the serial number to go backwards it will
be rejected. The primary use is to set the serial on
inline signed zones.
</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><!--
- Local variables:
- mode: sgml
- End:
-->