man.rndc-confgen.html revision 617639b7cc40ba9eb6fde2d98099726d50da812e
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<!--
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync - Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC")
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync -
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync - This Source Code Form is subject to the terms of the Mozilla Public
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync - License, v. 2.0. If a copy of the MPL was not distributed with this
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync - file, You can obtain one at http://mozilla.org/MPL/2.0/.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync-->
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<html lang="en">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<head>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<title>rndc-confgen</title>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync</head>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<div class="navheader">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<table width="100%" summary="Navigation header">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<tr>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<td width="20%" align="left">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<th width="60%" align="center">Manual pages</th>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync</td>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync</tr>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync</table>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<hr>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync</div>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<div class="refentry">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<a name="man.rndc-confgen"></a><div class="titlepage"></div>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync <div class="refnamediv">
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<h2>Name</h2>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<p>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync <span class="application">rndc-confgen</span>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync &#8212; rndc key generation tool
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync</div>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <div class="refsynopsisdiv">
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<h2>Synopsis</h2>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <div class="cmdsynopsis"><p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="command">rndc-confgen</code>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync [<code class="option">-a</code>]
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>]
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>]
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync [<code class="option">-h</code>]
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync [<code class="option">-s <em class="replaceable"><code>address</code></em></code>]
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>]
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p></div>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync </div>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <div class="refsection">
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<a name="id-1.14.29.7"></a><h2>DESCRIPTION</h2>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync <p><span class="command"><strong>rndc-confgen</strong></span>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync generates configuration files
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync for <span class="command"><strong>rndc</strong></span>. It can be used as a
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync convenient alternative to writing the
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="filename">rndc.conf</code> file
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync and the corresponding <span class="command"><strong>controls</strong></span>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync and <span class="command"><strong>key</strong></span>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync statements in <code class="filename">named.conf</code> by hand.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync option to set up a <code class="filename">rndc.key</code> file and
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync avoid the need for a <code class="filename">rndc.conf</code> file
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync and a <span class="command"><strong>controls</strong></span> statement altogether.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </div>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <div class="refsection">
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<a name="id-1.14.29.8"></a><h2>OPTIONS</h2>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <div class="variablelist"><dl class="variablelist">
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dt><span class="term">-a</span></dt>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Do automatic <span class="command"><strong>rndc</strong></span> configuration.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync This creates a file <code class="filename">rndc.key</code>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync in <code class="filename">/etc</code> (or whatever
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="varname">sysconfdir</code>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync was specified as when <acronym class="acronym">BIND</acronym> was
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync built)
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync that is read by both <span class="command"><strong>rndc</strong></span>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync and <span class="command"><strong>named</strong></span> on startup. The
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="filename">rndc.key</code> file defines a default
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync command channel and authentication key allowing
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <span class="command"><strong>rndc</strong></span> to communicate with
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <span class="command"><strong>named</strong></span> on the local host
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync with no further configuration.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync drop-in
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync with no changes to the existing BIND 8
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="filename">named.conf</code> file.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync If a more elaborate configuration than that
b1f3a2dc94cfa582803b349a7ce9c7b2f94e58f1vboxsync generated by <span class="command"><strong>rndc-confgen -a</strong></span>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync is required, for example if rndc is to be used remotely,
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync you should run <span class="command"><strong>rndc-confgen</strong></span> without
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync the
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <span class="command"><strong>-a</strong></span> option and set up a
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="filename">rndc.conf</code> and
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <code class="filename">named.conf</code>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync as directed.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Specifies the algorithm to use for the TSIG key. Available
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync hmac-sha384 and hmac-sha512. The default is hmac-md5 or
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync if MD5 was disabled hmac-sha256.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Specifies the size of the authentication key in bits.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Must be between 1 and 512 bits; the default is the
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync hash size.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync<dd>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync <p>
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync Used with the <span class="command"><strong>-a</strong></span> option to specify
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync an alternate location for <code class="filename">rndc.key</code>.
4ee2f4fc8e99dc69ba5d63fd7dd3f52a38d0501evboxsync </p>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync </dd>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<dt><span class="term">-h</span></dt>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<dd>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync <p>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync Prints a short summary of the options and arguments to
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync <span class="command"><strong>rndc-confgen</strong></span>.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync </p>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync </dd>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync<dd>
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync <p>
Specifies the key name of the rndc authentication key.
This must be a valid domain name.
The default is <code class="constant">rndc-key</code>.
</p>
</dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
<dd>
<p>
Specifies the command channel port where <span class="command"><strong>named</strong></span>
listens for connections from <span class="command"><strong>rndc</strong></span>.
The default is 953.
</p>
</dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
<dd>
<p>
Specifies a source of random data for generating the
authorization. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
is keyboard input. <code class="filename">randomdev</code>
specifies
the name of a character device or file containing random
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
</p>
</dd>
<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
<dd>
<p>
Specifies the IP address where <span class="command"><strong>named</strong></span>
listens for command channel connections from
<span class="command"><strong>rndc</strong></span>. The default is the loopback
address 127.0.0.1.
</p>
</dd>
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
<dd>
<p>
Used with the <span class="command"><strong>-a</strong></span> option to specify
a directory where <span class="command"><strong>named</strong></span> will run
chrooted. An additional copy of the <code class="filename">rndc.key</code>
will be written relative to this directory so that
it will be found by the chrooted <span class="command"><strong>named</strong></span>.
</p>
</dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd>
<p>
Used with the <span class="command"><strong>-a</strong></span> option to set the
owner
of the <code class="filename">rndc.key</code> file generated.
If
<span class="command"><strong>-t</strong></span> is also specified only the file
in
the chroot area has its owner changed.
</p>
</dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.14.29.9"></a><h2>EXAMPLES</h2>
<p>
To allow <span class="command"><strong>rndc</strong></span> to be used with
no manual configuration, run
</p>
<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
</p>
<p>
To print a sample <code class="filename">rndc.conf</code> file and
corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
statements to be manually inserted into <code class="filename">named.conf</code>,
run
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
</div>
<div class="refsection">
<a name="id-1.14.29.10"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">rndc</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">rndc.conf</span>(5)
</span>,
<span class="citerefentry">
<span class="refentrytitle">named</span>(8)
</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<code class="filename">rndc.conf</code>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
</td>
</tr>
</table>
</div>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.3b1 (Extended Support Version)</p>
</body>
</html>