man.rndc.html revision 48cbc7cd1eb8e7620dce2b5cda587bbd3a459d59
581N/A<!--
581N/A - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC")
581N/A - Copyright (C) 2000-2003 Internet Software Consortium.
581N/A -
581N/A - Permission to use, copy, modify, and/or distribute this software for any
581N/A - purpose with or without fee is hereby granted, provided that the above
581N/A - copyright notice and this permission notice appear in all copies.
581N/A -
581N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
581N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
581N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
581N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
581N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
581N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
581N/A - PERFORMANCE OF THIS SOFTWARE.
581N/A-->
581N/A<!-- $Id$ -->
581N/A<html>
581N/A<head>
581N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
581N/A<title>rndc</title>
581N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
835N/A<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
581N/A<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
581N/A<link rel="prev" href="man.nsupdate.html" title="nsupdate">
581N/A<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
581N/A</head>
581N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
581N/A<div class="navheader">
926N/A<table width="100%" summary="Navigation header">
581N/A<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
581N/A<tr>
581N/A<td width="20%" align="left">
926N/A<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
1431N/A<th width="60%" align="center">Manual pages</th>
926N/A<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
581N/A</td>
1431N/A</tr>
1431N/A</table>
581N/A<hr>
581N/A</div>
581N/A<div class="refentry" lang="en">
581N/A<a name="man.rndc"></a><div class="titlepage"></div>
581N/A<div class="refnamediv">
581N/A<h2>Name</h2>
581N/A<p><span class="application">rndc</span> &#8212; name server control utility</p>
581N/A</div>
581N/A<div class="refsynopsisdiv">
581N/A<h2>Synopsis</h2>
581N/A<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>
581N/A</div>
581N/A<div class="refsect1" lang="en">
581N/A<a name="id2642345"></a><h2>DESCRIPTION</h2>
581N/A<p><span><strong class="command">rndc</strong></span>
581N/A controls the operation of a name
581N/A server. It supersedes the <span><strong class="command">ndc</strong></span> utility
581N/A that was provided in old BIND releases. If
581N/A <span><strong class="command">rndc</strong></span> is invoked with no command line
581N/A options or arguments, it prints a short summary of the
581N/A supported commands and the available options and their
581N/A arguments.
581N/A </p>
581N/A<p><span><strong class="command">rndc</strong></span>
581N/A communicates with the name server
581N/A over a TCP connection, sending commands authenticated with
581N/A digital signatures. In the current versions of
1431N/A <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
1431N/A the only supported authentication algorithm is HMAC-MD5,
581N/A which uses a shared secret on each end of the connection.
581N/A This provides TSIG-style authentication for the command
581N/A request and the name server's response. All commands sent
1431N/A over the channel must be signed by a key_id known to the
926N/A server.
581N/A </p>
581N/A<p><span><strong class="command">rndc</strong></span>
581N/A reads a configuration file to
581N/A determine how to contact the name server and decide what
581N/A algorithm and key it should use.
581N/A </p>
581N/A</div>
581N/A<div class="refsect1" lang="en">
581N/A<a name="id2642395"></a><h2>OPTIONS</h2>
581N/A<div class="variablelist"><dl>
581N/A<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
1431N/A<dd><p>
1431N/A Use <em class="replaceable"><code>source-address</code></em>
1431N/A as the source address for the connection to the server.
1431N/A Multiple instances are permitted to allow setting of both
1431N/A the IPv4 and IPv6 source addresses.
1431N/A </p></dd>
1431N/A<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
1431N/A<dd><p>
1431N/A Use <em class="replaceable"><code>config-file</code></em>
1431N/A as the configuration file instead of the default,
1431N/A <code class="filename">/etc/rndc.conf</code>.
1431N/A </p></dd>
1431N/A<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
1431N/A<dd><p>
1431N/A Use <em class="replaceable"><code>key-file</code></em>
1431N/A as the key file instead of the default,
1431N/A <code class="filename">/etc/rndc.key</code>. The key in
1431N/A <code class="filename">/etc/rndc.key</code> will be used to
1431N/A authenticate
1431N/A commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
1431N/A does not exist.
1431N/A </p></dd>
1431N/A<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
1431N/A<dd><p><em class="replaceable"><code>server</code></em> is
1431N/A the name or address of the server which matches a
1431N/A server statement in the configuration file for
1431N/A <span><strong class="command">rndc</strong></span>. If no server is supplied on the
1431N/A command line, the host named by the default-server clause
1431N/A in the options statement of the <span><strong class="command">rndc</strong></span>
1431N/A configuration file will be used.
1431N/A </p></dd>
1431N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
1431N/A<dd><p>
1431N/A Send commands to TCP port
1431N/A <em class="replaceable"><code>port</code></em>
1431N/A instead
1431N/A of BIND 9's default control channel port, 953.
1431N/A </p></dd>
1431N/A<dt><span class="term">-V</span></dt>
1431N/A<dd><p>
1431N/A Enable verbose logging.
1431N/A </p></dd>
1431N/A<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
1431N/A<dd><p>
1431N/A Use the key <em class="replaceable"><code>key_id</code></em>
1431N/A from the configuration file.
1431N/A <em class="replaceable"><code>key_id</code></em>
1431N/A must be
1431N/A known by named with the same algorithm and secret string
1431N/A in order for control message validation to succeed.
581N/A If no <em class="replaceable"><code>key_id</code></em>
581N/A is specified, <span><strong class="command">rndc</strong></span> will first look
581N/A for a key clause in the server statement of the server
581N/A being used, or if no server statement is present for that
581N/A host, then the default-key clause of the options statement.
581N/A Note that the configuration file contains shared secrets
581N/A which are used to send authenticated control commands
581N/A to name servers. It should therefore not have general read
581N/A or write access.
581N/A </p></dd>
581N/A</dl></div>
581N/A<p>
581N/A For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
581N/A see the BIND 9 Administrator Reference Manual or run
926N/A <span><strong class="command">rndc</strong></span> without arguments to see its help
581N/A message.
581N/A </p>
581N/A</div>
581N/A<div class="refsect1" lang="en">
581N/A<a name="id2643098"></a><h2>LIMITATIONS</h2>
581N/A<p><span><strong class="command">rndc</strong></span>
581N/A does not yet support all the commands of
581N/A the BIND 8 <span><strong class="command">ndc</strong></span> utility.
581N/A </p>
1431N/A<p>
581N/A There is currently no way to provide the shared secret for a
581N/A <code class="option">key_id</code> without using the configuration file.
581N/A </p>
581N/A<p>
926N/A Several error messages could be clearer.
581N/A </p>
1431N/A</div>
926N/A<div class="refsect1" lang="en">
581N/A<a name="id2643129"></a><h2>SEE ALSO</h2>
581N/A<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
996N/A <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
996N/A <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
996N/A <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
996N/A <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
996N/A <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
996N/A </p>
996N/A</div>
996N/A<div class="refsect1" lang="en">
996N/A<a name="id2643185"></a><h2>AUTHOR</h2>
996N/A<p><span class="corpauthor">Internet Systems Consortium</span>
996N/A </p>
581N/A</div>
996N/A</div>
581N/A<div class="navfooter">
581N/A<hr>
581N/A<table width="100%" summary="Navigation footer">
581N/A<tr>
581N/A<td width="40%" align="left">
581N/A<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
1431N/A<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
926N/A<td width="40%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
581N/A</td>
581N/A</tr>
996N/A<tr>
996N/A<td width="40%" align="left" valign="top">
996N/A<span class="application">nsupdate</span>�</td>
996N/A<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
996N/A<td width="40%" align="right" valign="top">�<code class="filename">rndc.conf</code>
996N/A</td>
996N/A</tr>
996N/A</table>
581N/A</div>
581N/A</body>
996N/A</html>
581N/A