rndc-confgen.docbook revision 351b62535d4c4f89883bfdba025999dd32490266
f743002678eb67b99bbc29fee116b65d9530fec0wrowe<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
80833bb9a1bf25dcf19e814438a4b311d2e1f4cffuankg "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem [<!ENTITY mdash "—">]>
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
1337c7673efc1f80f634139fbad7cbb98a0dc657ylavic - Copyright (C) 2001, 2003 Internet Software Consortium.
4da61833a1cbbca94094f9653fd970582b97a72etrawick - Permission to use, copy, modify, and/or distribute this software for any
4da61833a1cbbca94094f9653fd970582b97a72etrawick - purpose with or without fee is hereby granted, provided that the above
4da61833a1cbbca94094f9653fd970582b97a72etrawick - copyright notice and this permission notice appear in all copies.
4da61833a1cbbca94094f9653fd970582b97a72etrawick - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4789804be088bcd86ae637a29cdb7fda25169521jailletc - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4789804be088bcd86ae637a29cdb7fda25169521jailletc - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4789804be088bcd86ae637a29cdb7fda25169521jailletc - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4789804be088bcd86ae637a29cdb7fda25169521jailletc - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
e50c3026198fd496f183cda4c32a202925476778covener - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
e50c3026198fd496f183cda4c32a202925476778covener - PERFORMANCE OF THIS SOFTWARE.
5b88c8507d5ef6d0c4cfbc78230294968175b638minfrin<!-- $Id: rndc-confgen.docbook,v 1.2 2009/06/10 00:27:21 each Exp $ -->
6c3b9cebb551140fbb25d58bae08b539b3802133ylavic <refentryinfo>
4f29b65ab4b547ad5dbe506e2d0ff5d12ead9247ylavic </refentryinfo>
0a0df13b7f1f4f1a74fe295253d89ca3911b301aylavic <refentrytitle><application>rndc-confgen</application></refentrytitle>
69301145375a889e7e37caf7cc7321ac0f91801erpluem <refnamediv>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza <refname><application>rndc-confgen</application></refname>
506bfe33206b2fece40ef25f695af39dd4130facjkaluza </refnamediv>
d58a848a016d401b965111e50ef829e1641f7834minfrin <copyright>
2e6f4d654c96c98b761fb012fd25c5d5b1558c44sf <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic </copyright>
17e6c95f3b22d18acdf8380fb26a8d0e10c80767ylavic <copyright>
e8bd80a4bb88199d2f9a24a50345688e52d9c116ylavic </copyright>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <refsynopsisdiv>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <cmdsynopsis>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <arg><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
330e16bea8fe9cace4de90c349750c03dfb1fe64ylavic <arg><option>-c <replaceable class="parameter">keyfile</replaceable></option></arg>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener <arg><option>-s <replaceable class="parameter">address</replaceable></option></arg>
d7205b1a86c51c27b71a2c458dc453fd53a261c1covener <arg><option>-t <replaceable class="parameter">chrootdir</replaceable></option></arg>
44ff304057225e944e220e981d434a046d14cf06covener <arg><option>-u <replaceable class="parameter">user</replaceable></option></arg>
44ff304057225e944e220e981d434a046d14cf06covener </cmdsynopsis>
44ff304057225e944e220e981d434a046d14cf06covener </refsynopsisdiv>
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrand generates configuration files
032982212dbcc7c3cce95bf89c503bb56e185ac7kbrand convenient alternative to writing the
caad2986f81ab263f7af41467dd622dc9add17f3ylavic statements in <filename>named.conf</filename> by hand.
caad2986f81ab263f7af41467dd622dc9add17f3ylavic Alternatively, it can be run with the <command>-a</command>
45a10d38e6051fd7bdf9d742aaae633d97ff02abjailletc option to set up a <filename>rndc.key</filename> file and
f7317ff316c2b141feea31bddb74d5d3fa1584edjorton avoid the need for a <filename>rndc.conf</filename> file
f7317ff316c2b141feea31bddb74d5d3fa1584edjorton and a <command>controls</command> statement altogether.
a34684a59b60a4173c25035d0c627ef17e6dc215rpluem </refsect1>
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedooh <variablelist>
fa7ed98b9dc94c5845cf845aea0a44ecacd290c9humbedooh <varlistentry>
c1a63b8fad09c419c1a64f75993feb8a343a6801ylavic command channel and authentication key allowing
e466c40e1801982602ee0200c9e8b61cc148742djailletc with no further configuration.
15890c9306ba98f6fc243e15a3c4778ddc7d773erpluem with no changes to the existing BIND 8
49dacedb6c387b786b7911082ff35121a45f414bcovener If a more elaborate configuration than that
cfd9415521847b2f9394fad04fb701cfb955f503rjung is required, for example if rndc is to be used remotely,
cfd9415521847b2f9394fad04fb701cfb955f503rjung you should run <command>rndc-confgen</command> without
28c31fb73c1264bd1d0ff932573677030b024c7dwrowe as directed.
63b9f1f5880391261705f696d7d65507bbe9ace3covener </listitem>
63b9f1f5880391261705f696d7d65507bbe9ace3covener </varlistentry>
49dacedb6c387b786b7911082ff35121a45f414bcovener <varlistentry>
49dacedb6c387b786b7911082ff35121a45f414bcovener <term>-b <replaceable class="parameter">keysize</replaceable></term>
3c990331fc6702119e4f5b8ba9eae3021aea5265jim Specifies the size of the authentication key in bits.
3c990331fc6702119e4f5b8ba9eae3021aea5265jim Must be between 1 and 512 bits; the default is 128.
3c990331fc6702119e4f5b8ba9eae3021aea5265jim </listitem>
fc42512879dd0504532f52fe5d0d0383dda96a1eniq </varlistentry>
fc42512879dd0504532f52fe5d0d0383dda96a1eniq <varlistentry>
0451df5dc50fa5d8b3e07d92ee6a92e36a1181a5niq <term>-c <replaceable class="parameter">keyfile</replaceable></term>
0451df5dc50fa5d8b3e07d92ee6a92e36a1181a5niq <listitem>
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc Used with the <command>-a</command> option to specify
983528026996668ea295be95aedb9c7a346af470ylavic an alternate location for <filename>rndc.key</filename>.
da0442c0440caef34706e2c2f3af05cb65921cc0jailletc </listitem>
06b8f183140c8e02e0974e938a05078b511d1603covener </varlistentry>
06b8f183140c8e02e0974e938a05078b511d1603covener <varlistentry>
259878293a997ff49f5ddfc53d3739cbdc25444ecovener Prints a short summary of the options and arguments to
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin </listitem>
b54b024c06a19926832d77d40ba35ad8c41e4d3dminfrin </varlistentry>
65967d05f839dbf27cf91d91fa79585eeae19660minfrin <varlistentry>
65967d05f839dbf27cf91d91fa79585eeae19660minfrin <term>-k <replaceable class="parameter">keyname</replaceable></term>
8152945ae46857b170cb227e79bb799f4fc7710dminfrin Specifies the key name of the rndc authentication key.
8152945ae46857b170cb227e79bb799f4fc7710dminfrin This must be a valid domain name.
75f5c2db254c0167a0e396254460de09b775d203trawick </listitem>
75f5c2db254c0167a0e396254460de09b775d203trawick </varlistentry>
4f0358189bfa57b8e75bd6b94db264302a8f336amrumph <varlistentry>
4f0358189bfa57b8e75bd6b94db264302a8f336amrumph <term>-p <replaceable class="parameter">port</replaceable></term>
5716f9c6daa92dde5f2f9d11ed63f7c9549c223atrawick Specifies the command channel port where <command>named</command>
5716f9c6daa92dde5f2f9d11ed63f7c9549c223atrawick listens for connections from <command>rndc</command>.
5716f9c6daa92dde5f2f9d11ed63f7c9549c223atrawick The default is 953.
54d750a84a175d8e338880514d440773eb986b50covener </listitem>
54d750a84a175d8e338880514d440773eb986b50covener </varlistentry>
54d750a84a175d8e338880514d440773eb986b50covener <varlistentry>
54d750a84a175d8e338880514d440773eb986b50covener <term>-r <replaceable class="parameter">randomfile</replaceable></term>
7a3aa12f0eda24793ee26d6a179bd53132e9dae8covener Specifies a source of random data for generating the
54d750a84a175d8e338880514d440773eb986b50covener authorization. If the operating
54d750a84a175d8e338880514d440773eb986b50covener system does not provide a <filename>/dev/random</filename>
83b50288fa7d306324bba68832011ea08f5c7832covener or equivalent device, the default source of randomness
5f066f496cd9f20a2a701255bc67d44e7cb46daetrawick the name of a character device or file containing random
5f066f496cd9f20a2a701255bc67d44e7cb46daetrawick data to be used instead of the default. The special value
5f066f496cd9f20a2a701255bc67d44e7cb46daetrawick <filename>keyboard</filename> indicates that keyboard
2e15620d724fb8e3a5be183b917359a2fd6e9468covener input should be used.
2e15620d724fb8e3a5be183b917359a2fd6e9468covener </listitem>
2e15620d724fb8e3a5be183b917359a2fd6e9468covener </varlistentry>
1b988c41ee505962781d110a3e4c2c90f1ea0aa4covener <varlistentry>
1b988c41ee505962781d110a3e4c2c90f1ea0aa4covener <term>-s <replaceable class="parameter">address</replaceable></term>
b8efdc95bec9cf089aa1be0bfd07d46aa1137a7acovener Specifies the IP address where <command>named</command>
b8efdc95bec9cf089aa1be0bfd07d46aa1137a7acovener listens for command channel connections from
f06e7c4b1bce6b6491e5de0b7998d3f5696b293dchrisd address 127.0.0.1.
179565be4043d7e5f9161aa75271fa0a001866d9covener </listitem>
179565be4043d7e5f9161aa75271fa0a001866d9covener </varlistentry>
111436a32ba1254291e4883292fb116d15fe8f64covener <varlistentry>
fce4949fb0b309a5744afcd503c6ed2d35621ee2covener <term>-t <replaceable class="parameter">chrootdir</replaceable></term>
fce4949fb0b309a5744afcd503c6ed2d35621ee2covener Used with the <command>-a</command> option to specify
7b7430e701e9a31ce809da7c220bb8dfcf68c86etrawick chrooted. An additional copy of the <filename>rndc.key</filename>
7b7430e701e9a31ce809da7c220bb8dfcf68c86etrawick will be written relative to this directory so that
ccc20788c1e5fc973f36df634399c89acb70deaejerenkrantz it will be found by the chrooted <command>named</command>.
273e512f20f262e5e2aa8e0e83371d1929fb76adjkaluza </varlistentry>
273e512f20f262e5e2aa8e0e83371d1929fb76adjkaluza <varlistentry>
efe780dcf13b2b95effabf897d694d8f23feac74trawick <term>-u <replaceable class="parameter">user</replaceable></term>
fe83f60b41477b14a37edcfcd1f7f5c5a1ebfe44minfrin Used with the <command>-a</command> option to set the
993d1261a278d7322bccef219101220b7b4fb8c5jkaluza of the <filename>rndc.key</filename> file generated.
ba050a6f942b9fa0e81ed73437588005c569655ccovener <command>-t</command> is also specified only the file
ba050a6f942b9fa0e81ed73437588005c569655ccovener the chroot area has its owner changed.
135ddda3a989215d2bedbcf1529bfb269c3eda23niq </listitem>
135ddda3a989215d2bedbcf1529bfb269c3eda23niq </varlistentry>
001a44c352f89c9ec332ffd3e0a6927dcd19432chumbedooh </variablelist>
9b0076ddd1103e5fa9c1f9bafde4b06ce244fbaecovener no manual configuration, run
249d09d51808cb7981af99762c3b3736ca126cd5jkaluza To print a sample <filename>rndc.conf</filename> file and
56589be3d7a3e9343370df240010c6928cc78b39jkaluza corresponding <command>controls</command> and <command>key</command>
56589be3d7a3e9343370df240010c6928cc78b39jkaluza statements to be manually inserted into <filename>named.conf</filename>,
77ca16c5676da23155311e13cee61e7eaba9fa3ejailletc </refsect1>
4d12805e6c18253040223ea637acd6b3b3c18f60jorton <refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum>
4d12805e6c18253040223ea637acd6b3b3c18f60jorton </citerefentry>,
85eacfc96a04547ef25aabbc06440039715084c2jorton <citerefentry>
85eacfc96a04547ef25aabbc06440039715084c2jorton <refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>
e5d909f2b06bd880fb3675cd49363df981caa631trawick </citerefentry>,
a4df2cd1e1391575a327c2a90ba4315f805a0a78covener <citerefentry>
a4df2cd1e1391575a327c2a90ba4315f805a0a78covener <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
a4df2cd1e1391575a327c2a90ba4315f805a0a78covener </citerefentry>,
cb666b29f81df1d11d65002250153353568021fccovener <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
cb666b29f81df1d11d65002250153353568021fccovener </refsect1>
75a230a728338d84dcfe81edd375352f34de22d0covener <para><corpauthor>Internet Systems Consortium</corpauthor>
75a230a728338d84dcfe81edd375352f34de22d0covener </refsect1>
1f50dc34ae069adeed20b2986e5ffdefa5c410e0covener - Local variables:
63a5ea80bddcc84a462e40f402b4f330e0e05411covener - mode: sgml