rndc.html revision b0e8629055a766d4555a005a283c2889a5974945
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Copyright (C) 2000, 2001 Internet Software Consortium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Permission to use, copy, modify, and distribute this software for any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - purpose with or without fee is hereby granted, provided that the above
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - copyright notice and this permission notice appear in all copies.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - PERFORMANCE OF THIS SOFTWARE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<!-- $Id: rndc.html,v 1.27 2007/01/30 00:24:59 marka Exp $ -->
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<a name="man.rndc"></a><div class="titlepage"></div>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span class="application">rndc</span> — name server control utility</p>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<div class="cmdsynopsis"><p><code class="command">rndc</code> [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>] [<code class="option">-s <em class="replaceable"><code>server</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span><strong class="command">rndc</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync controls the operation of a name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync server. It supersedes the <span><strong class="command">ndc</strong></span> utility
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that was provided in old BIND releases. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">rndc</strong></span> is invoked with no command line
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync options or arguments, it prints a short summary of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported commands and the available options and their
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span><strong class="command">rndc</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync communicates with the name server
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync over a TCP connection, sending commands authenticated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync digital signatures. In the current versions of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the only supported authentication algorithm is HMAC-MD5,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which uses a shared secret on each end of the connection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This provides TSIG-style authentication for the command
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request and the name server's response. All commands sent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync over the channel must be signed by a key_id known to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span><strong class="command">rndc</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reads a configuration file to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync determine how to contact the name server and decide what
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync algorithm and key it should use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use <em class="replaceable"><code>source-address</code></em>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as the source address for the connection to the server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Multiple instances are permitted to allow setting of both
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the IPv4 and IPv6 source addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use <em class="replaceable"><code>config-file</code></em>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as the configuration file instead of the default,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use <em class="replaceable"><code>key-file</code></em>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as the key file instead of the default,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="filename">/etc/rndc.key</code>. The key in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="filename">/etc/rndc.key</code> will be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync authenticate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dd><p><em class="replaceable"><code>server</code></em> is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the name or address of the server which matches a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync server statement in the configuration file for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">rndc</strong></span>. If no server is supplied on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command line, the host named by the default-server clause
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the option statement of the configuration file will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Send commands to TCP port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of BIND 9's default control channel port, 953.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enable verbose logging.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-y <em class="replaceable"><code>keyid</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Use the key <em class="replaceable"><code>keyid</code></em>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the configuration file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync known by named with the same algorithm and secret string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in order for control message validation to succeed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If no <em class="replaceable"><code>keyid</code></em>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is specified, <span><strong class="command">rndc</strong></span> will first look
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for a key clause in the server statement of the server
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being used, or if no server statement is present for that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync host, then the default-key clause of the options statement.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that the configuration file contains shared secrets
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which are used to send authenticated control commands
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to name servers. It should therefore not have general read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or write access.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync see the BIND 9 Administrator Reference Manual or run
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">rndc</strong></span> without arguments to see its help
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span><strong class="command">rndc</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync does not yet support all the commands of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the BIND 8 <span><strong class="command">ndc</strong></span> utility.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync There is currently no way to provide the shared secret for a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="option">key_id</code> without using the configuration file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Several error messages could be clearer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span class="corpauthor">Internet Systems Consortium</span>