man.ddns-confgen.html revision 94479b38340a00f0daf0ae0e1d3d673f845609ff
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC")
c78c39caab4cf8b5daefc9c65878f7f5ed3eb7a0Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
ab496cc3df1648e9ad992a87c35c2c0870fdc69dTinderbox User - Permission to use, copy, modify, and/or distribute this software for any
7c1468ed500356839a4a222517364e6ce18cb1a2Tinderbox User - purpose with or without fee is hereby granted, provided that the above
c57668a2fbbe558c1bd21652813616f2f517c469Tinderbox User - copyright notice and this permission notice appear in all copies.
287a6a8f9040dc43560cd69cddf83bfc0f53b76fTinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8de3f14f1c300c3e1ed99084cc03485b42c92bf1Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
950d203b64f512b85fcc093ee1e9e3e531a1aea3Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont - PERFORMANCE OF THIS SOFTWARE.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<!-- $Id$ -->
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
d5637bdbb931ff79fced3d4858d83212ea58ed15Tinderbox User<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<link rel="next" href="man.arpaname.html" title="arpaname">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<table width="100%" summary="Navigation header">
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<th width="60%" align="center">Manual pages</th>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews<a name="man.ddns-confgen"></a><div class="titlepage"></div>
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<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>] [ -s <em class="replaceable"><code>name</code></em> | -z <em class="replaceable"><code>zone</code></em> ] [<code class="option">-q</code>] [name]</p></div>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt<p><span><strong class="command">ddns-confgen</strong></span>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User 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
3759f10fc543747668b1ca4b4671f35b0dea8445Francis Dupont 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>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews syntax that will be needed to use it, including an example
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <span><strong class="command">update-policy</strong></span> statement.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews If a domain name is specified on the command line, it will
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews be used in the name of the generated key and in the sample
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">named.conf</strong></span> syntax. For example,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span><strong class="command">ddns-confgen example.com</strong></span> would
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews generate a key called "ddns-key.example.com", and sample
16f6050f29b6b0422cee858e609f65e474e70ef2Tinderbox User <span><strong class="command">named.conf</strong></span> command that could be used
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews in the zone definition for "example.com".
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews Note that <span><strong class="command">named</strong></span> itself can configure a
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span><strong class="command">ddns-confgen</strong></span> is only needed when a
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews more elaborate configuration is required: for instance, if
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
294e9d4c34462d29a3e766c88f452b46aeb3702fTinderbox User<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt Specifies the algorithm to use for the TSIG key. Available
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt hmac-sha384 and hmac-sha512. The default is hmac-sha256.
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews Prints a short summary of the options and arguments to
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span><strong class="command">ddns-confgen</strong></span>.
ee11dfc481f2ef6a032a715454f6290961a722d2Tinderbox User<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User Specifies the key name of the DDNS authentication key.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews The default is <code class="constant">ddns-key</code> when neither
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User the <code class="option">-s</code> nor <code class="option">-z</code> option is
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User specified; otherwise, the default
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews is <code class="constant">ddns-key</code> as a separate label
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User followed by the argument of the option, e.g.,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <code class="constant">ddns-key.example.com.</code>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User The key name must have the format of a valid domain name,
77932ac533c711eca5cd86de4e7eca8d91102b43Tinderbox User consisting of letters, digits, hyphens and periods.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User Quiet mode: Print only the key, with no explanatory text or
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews usage examples.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews Specifies a source of random data for generating the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews authorization. If the operating system does not provide a
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <code class="filename">/dev/random</code> or equivalent device, the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews default source of randomness is keyboard input.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <code class="filename">randomdev</code> specifies the name of a
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson character device or file containing random data to be used
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User instead of the default. The special value
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <code class="filename">keyboard</code> indicates that keyboard input
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User should be used.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User Single host mode: The example <span><strong class="command">named.conf</strong></span> text
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews shows how to set an update policy for the specified
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <em class="replaceable"><code>name</code></em>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews using the "name" nametype.
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews The default key name is
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews ddns-key.<em class="replaceable"><code>name</code></em>.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Note that the "self" nametype cannot be used, since
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User the name to be updated may differ from the key name.
a450977e98155f6e828fe6f8d52cf24674231831Mark Andrews This option cannot be used with the <code class="option">-z</code> option.
fd972434c29fc1169d66594e4cc7697d33036c2bTinderbox User<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User zone mode: The example <span><strong class="command">named.conf</strong></span> text
fd972434c29fc1169d66594e4cc7697d33036c2bTinderbox User shows how to set an update policy for the specified
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <em class="replaceable"><code>zone</code></em>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User using the "zonesub" nametype, allowing updates to all subdomain
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews names within
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont that <em class="replaceable"><code>zone</code></em>.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews This option cannot be used with the <code class="option">-s</code> option.
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User<table width="100%" summary="Navigation footer">
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<span class="application">rndc-confgen</span>�</td>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>