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