man.rndc-confgen.html revision 9c716f839c5dc2a9e236dada3af83b03e863078b
45e9809aff7304721fddb95654901b32195c9c7avboxsync - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
45e9809aff7304721fddb95654901b32195c9c7avboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
45e9809aff7304721fddb95654901b32195c9c7avboxsync - Permission to use, copy, modify, and/or distribute this software for any
45e9809aff7304721fddb95654901b32195c9c7avboxsync - purpose with or without fee is hereby granted, provided that the above
45e9809aff7304721fddb95654901b32195c9c7avboxsync - copyright notice and this permission notice appear in all copies.
45e9809aff7304721fddb95654901b32195c9c7avboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
45e9809aff7304721fddb95654901b32195c9c7avboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
45e9809aff7304721fddb95654901b32195c9c7avboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
45e9809aff7304721fddb95654901b32195c9c7avboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
45e9809aff7304721fddb95654901b32195c9c7avboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
45e9809aff7304721fddb95654901b32195c9c7avboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
45e9809aff7304721fddb95654901b32195c9c7avboxsync - PERFORMANCE OF THIS SOFTWARE.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<!-- $Id$ -->
45e9809aff7304721fddb95654901b32195c9c7avboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45e9809aff7304721fddb95654901b32195c9c7avboxsync<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<a name="man.rndc-confgen"></a><div class="titlepage"></div>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</code>] [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s <em class="replaceable"><code>address</code></em></code>] [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]</p></div>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p><span><strong class="command">rndc-confgen</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync generates configuration files
45e9809aff7304721fddb95654901b32195c9c7avboxsync for <span><strong class="command">rndc</strong></span>. It can be used as a
45e9809aff7304721fddb95654901b32195c9c7avboxsync convenient alternative to writing the
45e9809aff7304721fddb95654901b32195c9c7avboxsync and the corresponding <span><strong class="command">controls</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync and <span><strong class="command">key</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync statements in <code class="filename">named.conf</code> by hand.
45e9809aff7304721fddb95654901b32195c9c7avboxsync Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync option to set up a <code class="filename">rndc.key</code> file and
45e9809aff7304721fddb95654901b32195c9c7avboxsync avoid the need for a <code class="filename">rndc.conf</code> file
45e9809aff7304721fddb95654901b32195c9c7avboxsync and a <span><strong class="command">controls</strong></span> statement altogether.
45e9809aff7304721fddb95654901b32195c9c7avboxsync Do automatic <span><strong class="command">rndc</strong></span> configuration.
45e9809aff7304721fddb95654901b32195c9c7avboxsync This creates a file <code class="filename">rndc.key</code>
45e9809aff7304721fddb95654901b32195c9c7avboxsync was specified as when <acronym class="acronym">BIND</acronym> was
45e9809aff7304721fddb95654901b32195c9c7avboxsync that is read by both <span><strong class="command">rndc</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync and <span><strong class="command">named</strong></span> on startup. The
45e9809aff7304721fddb95654901b32195c9c7avboxsync <code class="filename">rndc.key</code> file defines a default
45e9809aff7304721fddb95654901b32195c9c7avboxsync command channel and authentication key allowing
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span><strong class="command">rndc</strong></span> to communicate with
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span><strong class="command">named</strong></span> on the local host
45e9809aff7304721fddb95654901b32195c9c7avboxsync with no further configuration.
45e9809aff7304721fddb95654901b32195c9c7avboxsync Running <span><strong class="command">rndc-confgen -a</strong></span> allows
45e9809aff7304721fddb95654901b32195c9c7avboxsync BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
45e9809aff7304721fddb95654901b32195c9c7avboxsync replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
45e9809aff7304721fddb95654901b32195c9c7avboxsync with no changes to the existing BIND 8
45e9809aff7304721fddb95654901b32195c9c7avboxsync If a more elaborate configuration than that
45e9809aff7304721fddb95654901b32195c9c7avboxsync generated by <span><strong class="command">rndc-confgen -a</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync is required, for example if rndc is to be used remotely,
45e9809aff7304721fddb95654901b32195c9c7avboxsync you should run <span><strong class="command">rndc-confgen</strong></span> without
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span><strong class="command">-a</strong></span> option and set up a
45e9809aff7304721fddb95654901b32195c9c7avboxsync as directed.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Specifies the algorithm to use for the TSIG key. Available
45e9809aff7304721fddb95654901b32195c9c7avboxsync choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
45e9809aff7304721fddb95654901b32195c9c7avboxsync hmac-sha384 and hmac-sha512. The default is hmac-md5.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Specifies the size of the authentication key in bits.
45e9809aff7304721fddb95654901b32195c9c7avboxsync Must be between 1 and 512 bits; the default is the
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Used with the <span><strong class="command">-a</strong></span> option to specify
45e9809aff7304721fddb95654901b32195c9c7avboxsync an alternate location for <code class="filename">rndc.key</code>.
45e9809aff7304721fddb95654901b32195c9c7avboxsync Prints a short summary of the options and arguments to
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span><strong class="command">rndc-confgen</strong></span>.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Specifies the key name of the rndc authentication key.
45e9809aff7304721fddb95654901b32195c9c7avboxsync This must be a valid domain name.
45e9809aff7304721fddb95654901b32195c9c7avboxsync The default is <code class="constant">rndc-key</code>.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Specifies the command channel port where <span><strong class="command">named</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync listens for connections from <span><strong class="command">rndc</strong></span>.
45e9809aff7304721fddb95654901b32195c9c7avboxsync The default is 953.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Specifies a source of random data for generating the
45e9809aff7304721fddb95654901b32195c9c7avboxsync authorization. If the operating
45e9809aff7304721fddb95654901b32195c9c7avboxsync system does not provide a <code class="filename">/dev/random</code>
45e9809aff7304721fddb95654901b32195c9c7avboxsync or equivalent device, the default source of randomness
45e9809aff7304721fddb95654901b32195c9c7avboxsync is keyboard input. <code class="filename">randomdev</code>
45e9809aff7304721fddb95654901b32195c9c7avboxsync the name of a character device or file containing random
45e9809aff7304721fddb95654901b32195c9c7avboxsync data to be used instead of the default. The special value
45e9809aff7304721fddb95654901b32195c9c7avboxsync <code class="filename">keyboard</code> indicates that keyboard
45e9809aff7304721fddb95654901b32195c9c7avboxsync input should be used.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Specifies the IP address where <span><strong class="command">named</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync listens for command channel connections from
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span><strong class="command">rndc</strong></span>. The default is the loopback
45e9809aff7304721fddb95654901b32195c9c7avboxsync address 127.0.0.1.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Used with the <span><strong class="command">-a</strong></span> option to specify
45e9809aff7304721fddb95654901b32195c9c7avboxsync a directory where <span><strong class="command">named</strong></span> will run
45e9809aff7304721fddb95654901b32195c9c7avboxsync chrooted. An additional copy of the <code class="filename">rndc.key</code>
45e9809aff7304721fddb95654901b32195c9c7avboxsync will be written relative to this directory so that
45e9809aff7304721fddb95654901b32195c9c7avboxsync it will be found by the chrooted <span><strong class="command">named</strong></span>.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
45e9809aff7304721fddb95654901b32195c9c7avboxsync Used with the <span><strong class="command">-a</strong></span> option to set the
45e9809aff7304721fddb95654901b32195c9c7avboxsync of the <code class="filename">rndc.key</code> file generated.
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span><strong class="command">-t</strong></span> is also specified only the file
45e9809aff7304721fddb95654901b32195c9c7avboxsync the chroot area has its owner changed.
45e9809aff7304721fddb95654901b32195c9c7avboxsync To allow <span><strong class="command">rndc</strong></span> to be used with
45e9809aff7304721fddb95654901b32195c9c7avboxsync no manual configuration, run
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
45e9809aff7304721fddb95654901b32195c9c7avboxsync To print a sample <code class="filename">rndc.conf</code> file and
45e9809aff7304721fddb95654901b32195c9c7avboxsync corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync statements to be manually inserted into <code class="filename">named.conf</code>,
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p><strong class="userinput"><code>rndc-confgen</code></strong>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
45e9809aff7304721fddb95654901b32195c9c7avboxsync <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
45e9809aff7304721fddb95654901b32195c9c7avboxsync <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p><span class="corpauthor">Internet Systems Consortium</span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
45e9809aff7304721fddb95654901b32195c9c7avboxsync<p style="text-align: center;">BIND 9.11.0pre-alpha</p>