<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
 - Copyright (C) 2004, 2005, 2007, 2013  Internet Systems Consortium, Inc. ("ISC")
 - Copyright (C) 2000, 2001  Internet Software Consortium.
 -
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<!-- $Id: rndc.docbook,v 1.21 2007/12/14 20:39:14 marka Exp $ -->
<refentry id="man.rndc">
  <refentryinfo>
    <date>June 7, 2013</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>rndc</application></refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname><application>rndc</application></refname>
    <refpurpose>name server control utility</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
      <year>2007</year>
      <year>2013</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <holder>Internet Software Consortium.</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>rndc</command>
      <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg>
      <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
      <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg>
      <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>
      <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
      <arg><option>-V</option></arg>
      <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>
      <arg choice="req">command</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para><command>rndc</command>
      controls the operation of a name
      server.  It supersedes the <command>ndc</command> utility
      that was provided in old BIND releases.  If
      <command>rndc</command> is invoked with no command line
      options or arguments, it prints a short summary of the
      supported commands and the available options and their
      arguments.
    </para>
    <para><command>rndc</command>
      communicates with the name server
      over a TCP connection, sending commands authenticated with
      digital signatures.  In the current versions of
      <command>rndc</command> and <command>named</command>,
      the only supported authentication algorithm is HMAC-MD5,
      which uses a shared secret on each end of the connection.
      This provides TSIG-style authentication for the command
      request and the name server's response.  All commands sent
      over the channel must be signed by a key_id known to the
      server.
    </para>
    <para><command>rndc</command>
      reads a configuration file to
      determine how to contact the name server and decide what
      algorithm and key it should use.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-b <replaceable class="parameter">source-address</replaceable></term>
        <listitem>
          <para>
            Use <replaceable class="parameter">source-address</replaceable>
            as the source address for the connection to the server.
            Multiple instances are permitted to allow setting of both
            the IPv4 and IPv6 source addresses.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-c <replaceable class="parameter">config-file</replaceable></term>
        <listitem>
          <para>
            Use <replaceable class="parameter">config-file</replaceable>
            as the configuration file instead of the default,
            <filename>/etc/rndc.conf</filename>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-k <replaceable class="parameter">key-file</replaceable></term>
        <listitem>
          <para>
            Use <replaceable class="parameter">key-file</replaceable>
            as the key file instead of the default,
            <filename>/etc/rndc.key</filename>.  The key in
            <filename>/etc/rndc.key</filename> will be used to
            authenticate
            commands sent to the server if the <replaceable class="parameter">config-file</replaceable>
            does not exist.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-s <replaceable class="parameter">server</replaceable></term>
        <listitem>
          <para><replaceable class="parameter">server</replaceable> is
            the name or address of the server which matches a
            server statement in the configuration file for
            <command>rndc</command>.  If no server is supplied on the
            command line, the host named by the default-server clause
            in the options statement of the <command>rndc</command>
	    configuration file will be used.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-p <replaceable class="parameter">port</replaceable></term>
        <listitem>
          <para>
            Send commands to TCP port
            <replaceable class="parameter">port</replaceable>
            instead
            of BIND 9's default control channel port, 953.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-V</term>
        <listitem>
          <para>
            Enable verbose logging.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-y <replaceable class="parameter">key_id</replaceable></term>
        <listitem>
          <para>
            Use the key <replaceable class="parameter">key_id</replaceable>
            from the configuration file.
            <replaceable class="parameter">key_id</replaceable>
            must be
            known by named with the same algorithm and secret string
            in order for control message validation to succeed.
            If no <replaceable class="parameter">key_id</replaceable>
            is specified, <command>rndc</command> will first look
            for a key clause in the server statement of the server
            being used, or if no server statement is present for that
            host, then the default-key clause of the options statement.
            Note that the configuration file contains shared secrets
            which are used to send authenticated control commands
            to name servers.  It should therefore not have general read
            or write access.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>COMMANDS</title>
    <para>
      A list of commands supported by <command>rndc</command> can
      be seen by running <command>rndc</command> without arguments.
    </para>
    <para>
      Currently supported commands are:
    </para>

    <variablelist>
      <varlistentry>
        <term><userinput>reload</userinput></term>
        <listitem>
          <para>
            Reload configuration file and zones.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><userinput>reload <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
        <listitem>
          <para>
            Reload the given zone.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><userinput>refresh <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
        <listitem>
          <para>
            Schedule zone maintenance for the given zone.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><userinput>retransfer <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
        <listitem>
          <para>
            Retransfer the given zone from the master.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><userinput>sign <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
        <listitem>
          <para>
            Fetch all DNSSEC keys for the given zone
            from the key directory (see the 
            <command>key-directory</command> option in
            the BIND 9 Administrator Reference Manual).  If they are within
            their publication period, merge them into the
            zone's DNSKEY RRset.  If the DNSKEY RRset
            is changed, then the zone is automatically
            re-signed with the new key set.
          </para>
          <para>
            This command requires that the
            <command>auto-dnssec</command> zone option be set
            to <literal>allow</literal> or
            <literal>maintain</literal>,
            and also requires the zone to be configured to
            allow dynamic DNS.
            (See "Dynamic Update Policies" in the Administrator
            Reference Manual for more details.)
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><userinput>loadkeys <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
        <listitem>
          <para>
            Fetch all DNSSEC keys for the given zone
            from the key directory.  If they are within
            their publication period, merge them into the
            zone's DNSKEY RRset.  Unlike <command>rndc
            sign</command>, however, the zone is not
            immediately re-signed by the new keys, but is
            allowed to incrementally re-sign over time.
          </para>
          <para>
            This command requires that the
            <command>auto-dnssec</command> zone option
            be set to <literal>maintain</literal>,
            and also requires the zone to be configured to
            allow dynamic DNS.
            (See "Dynamic Update Policies" in the Administrator
            Reference Manual for more details.)
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><userinput>freeze <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
        <listitem>
          <para>
            Suspend updates to a dynamic zone.  If no zone is
            specified, then all zones are suspended.  This allows
            manual edits to be made to a zone normally updated by
            dynamic update.  It also causes changes in the
            journal file to be synced into the master file,
            and the journal file to be removed.
            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.
          </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>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>
            Toggle query logging.  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 to the secroots
            file for the specified views.  If no view is
            specified, security roots for 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 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>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 <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>
        </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:
-->
