rndc.docbook revision b39ee56af9c9a690db068a98cf44af175dbb45ed
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
297be3708069ef31814d6d75c0d71a50a78feb03Mark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews [<!ENTITY mdash "—">]>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2000, 2001 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and/or distribute this software for any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: rndc.docbook,v 1.21 2007/12/14 20:39:14 marka Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><application>rndc</application></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>rndc</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>name server control utility</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
297be3708069ef31814d6d75c0d71a50a78feb03Mark Andrews </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </cmdsynopsis>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </refsynopsisdiv>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater controls the operation of a name
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater server. It supersedes the <command>ndc</command> utility
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater that was provided in old BIND releases. If
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <command>rndc</command> is invoked with no command line
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater options or arguments, it prints a short summary of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein supported commands and the available options and their
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein communicates with the name server
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater over a TCP connection, sending commands authenticated with
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater digital signatures. In the current versions of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>rndc</command> and <command>named</command>,
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater the only supported authentication algorithm is HMAC-MD5,
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater which uses a shared secret on each end of the connection.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This provides TSIG-style authentication for the command
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater request and the name server's response. All commands sent
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater over the channel must be signed by a key_id known to the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein reads a configuration file to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein determine how to contact the name server and decide what
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm and key it should use.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <variablelist>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <varlistentry>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <term>-b <replaceable class="parameter">source-address</replaceable></term>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater Use <replaceable class="parameter">source-address</replaceable>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein as the source address for the connection to the server.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater Multiple instances are permitted to allow setting of both
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater the IPv4 and IPv6 source addresses.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </varlistentry>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-c <replaceable class="parameter">config-file</replaceable></term>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater Use <replaceable class="parameter">config-file</replaceable>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater as the configuration file instead of the default,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-k <replaceable class="parameter">key-file</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use <replaceable class="parameter">key-file</replaceable>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein as the key file instead of the default,
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <filename>/etc/rndc.key</filename> will be used to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein authenticate
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein commands sent to the server if the <replaceable class="parameter">config-file</replaceable>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein does not exist.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-s <replaceable class="parameter">server</replaceable></term>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <para><replaceable class="parameter">server</replaceable> is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the name or address of the server which matches a
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater server statement in the configuration file for
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <command>rndc</command>. If no server is supplied on the
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater command line, the host named by the default-server clause
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater in the options statement of the <command>rndc</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein configuration file will be used.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <term>-p <replaceable class="parameter">port</replaceable></term>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater Send commands to TCP port
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <replaceable class="parameter">port</replaceable>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of BIND 9's default control channel port, 953.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Enable verbose logging.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <term>-y <replaceable class="parameter">key_id</replaceable></term>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater Use the key <replaceable class="parameter">key_id</replaceable>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater from the configuration file.
7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <replaceable class="parameter">key_id</replaceable>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein known by named with the same algorithm and secret string
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews in order for control message validation to succeed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no <replaceable class="parameter">key_id</replaceable>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is specified, <command>rndc</command> will first look
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater for a key clause in the server statement of the server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein being used, or if no server statement is present for that
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater host, then the default-key clause of the options statement.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater Note that the configuration file contains shared secrets
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein which are used to send authenticated control commands
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to name servers. It should therefore not have general read
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or write access.
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </varlistentry>
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater </variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein For the complete set of commands supported by <command>rndc</command>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein see the BIND 9 Administrator Reference Manual or run
ab8729140b1ad688ab03e1e9ce438fb1cbb49222Automatic Updater <command>rndc</command> without arguments to see its help
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein does not yet support all the commands of
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews There is currently no way to provide the shared secret for a
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <option>key_id</option> without using the configuration file.
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews Several error messages could be clearer.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <citerefentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <citerefentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <citerefentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <citerefentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>ndc</refentrytitle><manvolnum>8</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><corpauthor>Internet Systems Consortium</corpauthor>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Local variables:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - mode: sgml