ddns-confgen.docbook revision 6493425eaa8d09485bcbf78e4f854b1a35ef71ed
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
7a2a1b8b14fc804ac80612d7b98064095e445be5Automatic Updater [<!ENTITY mdash "—">]>
1167fc7904c5f0a472f8df207ac46dd52c7f1ec8Automatic Updater - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
46da3117812814a29432a8d9a9ccf8acdbfdadceAutomatic Updater - Permission to use, copy, modify, and/or distribute this software for any
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater - purpose with or without fee is hereby granted, provided that the above
fe84edc17e0d582cf7b4270f8df9d4742a107b1cAutomatic Updater - copyright notice and this permission notice appear in all copies.
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
6c6a121295b30772cbf3dd75a51fb9d883051a0eAutomatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
bbde8dc56605130058a1540609264fa109da3b63Automatic Updater - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
bbde8dc56605130058a1540609264fa109da3b63Automatic Updater - PERFORMANCE OF THIS SOFTWARE.
3cc98b8ecedcbc8465f1cf2740b966b315662430Automatic Updater<!-- $Id: ddns-confgen.docbook,v 1.5 2009/07/02 22:50:24 jinmei Exp $ -->
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refentryinfo>
bbde8dc56605130058a1540609264fa109da3b63Automatic Updater </refentryinfo>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <refentrytitle><application>ddns-confgen</application></refentrytitle>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <refname><application>ddns-confgen</application></refname>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <refpurpose>ddns key generation tool</refpurpose>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
e130ab53e992670e2a2ecf043976ac09f21358d1Automatic Updater <refsynopsisdiv>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <arg><option>-s name | -z zone</option></arg>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater </cmdsynopsis>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater </refsynopsisdiv>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User generates a key for use by <command>nsupdate</command>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater and <command>named</command>. It simplifies configuration
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews of dynamic zones by generating a key and providing the
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater <command>nsupdate</command> and <command>named.conf</command>
8e9f3b69914ee02a80b87c97b1f8093edb3e9ae0Automatic Updater syntax that will be needed to use it, including an example
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater If a domain name is specified on the command line, it will
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews be used in the name of the generated key and in the sample
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater <command>named.conf</command> syntax. For example,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <command>ddns-confgen example.com</command> would
930f6069e5aa157cf6987cdafd412f5757a5a558Automatic Updater generate a key called "ddns-key.example.com", and sample
693c4232dfdffaff672197d4b9fea944c64cf80aAutomatic Updater <command>named.conf</command> command that could be used
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews in the zone definition for "example.com".
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater Note that <command>named</command> itself can configure a
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews local DDNS key for use with <command>nsupdate -l</command>.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <command>ddns-confgen</command> is only needed when a
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson more elaborate configuration is required: for instance, if
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <command>nsupdate</command> is to be used from a remote system.
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User <variablelist>
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User <varlistentry>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <term>-a <replaceable class="parameter">algorithm</replaceable></term>
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User Specifies the algorithm to use for the TSIG key. Available
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews hmac-sha384 and hmac-sha512. The default is hmac-sha256.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </varlistentry>
24bf1e02f03577db0feb50b80238c4150c96d05dAutomatic Updater <varlistentry>
a308b69ac66fadf66863484f301314d6e6a3f1d2Automatic Updater Prints a short summary of the options and arguments to
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <varlistentry>
24bf1e02f03577db0feb50b80238c4150c96d05dAutomatic Updater <term>-k <replaceable class="parameter">keyname</replaceable></term>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater Specifies the key name of the DDNS authentication key.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The default is <constant>ddns-key</constant> when neither
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater the <option>-s</option> nor <option>-z</option> option is
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater specified; otherwise, the default
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater is <constant>ddns-key</constant> as a separate label
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater followed by the argument of the option, e.g.,
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <constant>ddns-key.example.com.</constant>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The key name must have the format of a valid domain name,
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson consisting of letters, digits, hyphens and periods.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </varlistentry>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater <varlistentry>
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater Quiet mode: Print only the key, with no explanatory text or
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater usage examples.
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User </varlistentry>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <varlistentry>
1368e4b34cef64604c874fcc40201c78e548714cTinderbox User <term>-r <replaceable class="parameter">randomfile</replaceable></term>
f132a836c4e386b1af045dd8fe7106ae61b90bffAutomatic Updater Specifies a source of random data for generating the
8f2c45a35dd8c40bcc9caba8f7d40ce64fc27bcdAutomatic Updater authorization. If the operating system does not provide a
c6a0f4ae1d7183a16ffb196b86b647f870694796Automatic Updater <filename>/dev/random</filename> or equivalent device, the
8f2c45a35dd8c40bcc9caba8f7d40ce64fc27bcdAutomatic Updater default source of randomness is keyboard input.
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <filename>randomdev</filename> specifies the name of a
d145b64cacc8d9cda51f9924ec70cd4661c3e2cfAutomatic Updater character device or file containing random data to be used
8711e5c73ca872d59810760af0332194cbdd619bAutomatic Updater instead of the default. The special value
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <filename>keyboard</filename> indicates that keyboard input
8f2c45a35dd8c40bcc9caba8f7d40ce64fc27bcdAutomatic Updater should be used.
9c446b72069d0ab9f710502f4d7048e50875fccbAutomatic Updater </varlistentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <varlistentry>
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater <term>-s <replaceable class="parameter">name</replaceable></term>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater Single host mode: The example <command>named.conf</command> text
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater shows how to set an update policy for the specified
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <replaceable class="parameter">name</replaceable>
7f79131f9a8e804b93c57f3c679065cce878b726Automatic Updater using the "name" nametype.
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater The default key name is
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater ddns-key.<replaceable class="parameter">name</replaceable>.
3f616e6f846be57b1717c6beaba0f74de9d5a7c6Automatic Updater Note that the "self" nametype cannot be used, since
8f2c45a35dd8c40bcc9caba8f7d40ce64fc27bcdAutomatic Updater the name to be updated may differ from the key name.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater This option cannot be used with the <option>-z</option> option.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater </varlistentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <varlistentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <term>-z <replaceable class="parameter">zone</replaceable></term>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater zone mode: The example <command>named.conf</command> text
71bd43eebd9d6e42dbcae62b730f5b6508d5acd8Automatic Updater shows how to set an update policy for the specified
82447d835d3ff5c658749b4e9b4f66166407b3eaAutomatic Updater <replaceable class="parameter">zone</replaceable>
7262eb86f2b465822206122921e2f357218f0cfdAutomatic Updater using the "zonesub" nametype, allowing updates to all subdomain
96ea71632887c58a9d00f47eb318bf76b35903c3Mark Andrews names within
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater that <replaceable class="parameter">zone</replaceable>.
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater This option cannot be used with the <option>-s</option> option.
4cda4fd158d6ded5586bacea8c388445d99611eaAutomatic Updater </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </variablelist>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </citerefentry>,
765c97d56ccddc9d7904c7d9ff2e2d825d9687e4Automatic Updater <citerefentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
cafd3a2b9974fe0a4ab95e0289746062bd958d68Automatic Updater </citerefentry>,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <citerefentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
7a2a1b8b14fc804ac80612d7b98064095e445be5Automatic Updater </citerefentry>,
f132a836c4e386b1af045dd8fe7106ae61b90bffAutomatic Updater <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
fe84edc17e0d582cf7b4270f8df9d4742a107b1cAutomatic Updater <para><corpauthor>Internet Systems Consortium</corpauthor>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater - Local variables: