ddns-confgen.html revision 2cbb4ab75757fbb656997a82c14ca07db37d481a
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User - Permission to use, copy, modify, and distribute this software for any
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User - purpose with or without fee is hereby granted, provided that the above
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User - copyright notice and this permission notice appear in all copies.
5e047890ac9b745db060d95f7d1b4f876511240dTinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
137fdbc214e99c4cbe57551e9e14f2015c2e42aeTinderbox User - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
02b47c5d62e1e827743684c28a08e871da454a2dMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User - PERFORMANCE OF THIS SOFTWARE.
e20309353e6246485c521278131d3fced73d7957Tinderbox User<!-- $Id: ddns-confgen.html,v 1.8 2009/07/04 01:13:18 tbox Exp $ -->
3cc98b8ecedcbc8465f1cf2740b966b315662430Automatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
e20309353e6246485c521278131d3fced73d7957Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<a name="man.ddns-confgen"></a><div class="titlepage"></div>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<div class="cmdsynopsis"><p><code class="command">ddns-confgen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s name | -z zone</code>] [<code class="option">-q</code>] [name]</p></div>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt<p><span><strong class="command">ddns-confgen</strong></span>
e130ab53e992670e2a2ecf043976ac09f21358d1Automatic Updater generates a key for use by <span><strong class="command">nsupdate</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater and <span><strong class="command">named</strong></span>. It simplifies configuration
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt of dynamic zones by generating a key and providing the
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
24934f08b9ff81c2be711e566e8002d145573031Tinderbox User syntax that will be needed to use it, including an example
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">update-policy</strong></span> statement.
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User If a domain name is specified on the command line, it will
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt be used in the name of the generated key and in the sample
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <span><strong class="command">named.conf</strong></span> syntax. For example,
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">ddns-confgen example.com</strong></span> would
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater generate a key called "ddns-key.example.com", and sample
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">named.conf</strong></span> command that could be used
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater in the zone definition for "example.com".
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater Note that <span><strong class="command">named</strong></span> itself can configure a
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">ddns-confgen</strong></span> is only needed when a
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews more elaborate configuration is required: for instance, if
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
e20309353e6246485c521278131d3fced73d7957Tinderbox User<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
7feccf248d2a20a2ae48b290f58ded5abc853e9aTinderbox User Specifies the algorithm to use for the TSIG key. Available
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
c59750de3ea3c7d5890000fb4606e8f5835a52aaTinderbox User hmac-sha384 and hmac-sha512. The default is hmac-sha256.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Prints a short summary of the options and arguments to
114f7780384371121918624ae2c80ecfce545683Tinderbox User <span><strong class="command">ddns-confgen</strong></span>.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Specifies the key name of the DDNS authentication key.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The default is <code class="constant">ddns-key</code> when neither
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater the <code class="option">-s</code> nor <code class="option">-z</code> option is
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews specified; otherwise, the default
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater is <code class="constant">ddns-key</code> as a separate label
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson followed by the argument of the option, e.g.,
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <code class="constant">ddns-key.example.com.</code>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The key name must have the format of a valid domain name,
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson consisting of letters, digits, hyphens and periods.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Quiet mode: Print only the key, with no explanatory text or
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User usage examples.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User Specifies a source of random data for generating the
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User authorization. If the operating system does not provide a
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <code class="filename">/dev/random</code> or equivalent device, the
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews default source of randomness is keyboard input.
2ba8f584b97cbab864570e38fd26b8cb90961428Tinderbox User <code class="filename">randomdev</code> specifies the name of a
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User character device or file containing random data to be used
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews instead of the default. The special value
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <code class="filename">keyboard</code> indicates that keyboard input
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews should be used.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
2ba8f584b97cbab864570e38fd26b8cb90961428Tinderbox User Single host mode: The example <span><strong class="command">named.conf</strong></span> text
a308b69ac66fadf66863484f301314d6e6a3f1d2Automatic Updater shows how to set an update policy for the specified
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews using the "name" nametype.
551271d8198ae06e37edf5da519d8ee153eeac0fTinderbox User The default key name is
27c3c21f41520e8d6336d80a8094389e321cb6d2Mark Andrews ddns-key.<em class="replaceable"><code>name</code></em>.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Note that the "self" nametype cannot be used, since
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews the name to be updated may differ from the key name.
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews This option cannot be used with the <code class="option">-z</code> option.
01a5c5503482fb3ba52088bf0178a7213273bf96Mark Andrews<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews zone mode: The example <span><strong class="command">named.conf</strong></span> text
df4ebd8217d02dafc12145b55c4d93d0255d1ec7Tinderbox User shows how to set an update policy for the specified
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <em class="replaceable"><code>zone</code></em>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater using the "zonesub" nametype, allowing updates to all subdomain
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater that <em class="replaceable"><code>zone</code></em>.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater This option cannot be used with the <code class="option">-s</code> option.
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<p><span class="corpauthor">Internet Systems Consortium</span>