man.ddns-confgen.html revision 996dbb19570bb25601a3611db5d59ccda0a064c5
c80e152862cc3e3207dc837fde7116bd4c0e4b9dTinderbox User - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
c80e152862cc3e3207dc837fde7116bd4c0e4b9dTinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
8d1b3ceb4d491ce32572f1702f37ed585eede993Evan Hunt - Permission to use, copy, modify, and/or distribute this software for any
d77cb075aae5595e460e3299bfc1e8ea5d42b560Evan Hunt - purpose with or without fee is hereby granted, provided that the above
d77cb075aae5595e460e3299bfc1e8ea5d42b560Evan Hunt - copyright notice and this permission notice appear in all copies.
30ca20f720ad0887772a79e7abb25b4fa0e4b5b0Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
30ca20f720ad0887772a79e7abb25b4fa0e4b5b0Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
30ca20f720ad0887772a79e7abb25b4fa0e4b5b0Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
30ca20f720ad0887772a79e7abb25b4fa0e4b5b0Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
701a93f5a592e4652343e049aa495d409c3ee133Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7ec97ae74e42ec21b354fd2d1366313b41d947d6Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
701a93f5a592e4652343e049aa495d409c3ee133Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
002f1373374a0b72fc0329baa682917929bef168Tony Finch<!-- $Id: man.ddns-confgen.html,v 1.38 2009/11/29 01:14:50 tbox Exp $ -->
8f1ed05dc0aae7ae6c3da6ec6d405df61257a61eMark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
8f1ed05dc0aae7ae6c3da6ec6d405df61257a61eMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
8f1ed05dc0aae7ae6c3da6ec6d405df61257a61eMark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
73cf0ba4e82c6baef638ecc4e31321223f841d28Mark Andrews<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
73cf0ba4e82c6baef638ecc4e31321223f841d28Mark Andrews<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
d8351dfc9b725b0d727be7acab6247d7d501d9a0Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
d8351dfc9b725b0d727be7acab6247d7d501d9a0Mark Andrews<table width="100%" summary="Navigation header">
3a29ce9c08dd31709c73e7187aebda0d360c537bEvan Hunt<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
f1740da065d4555039fe8bb53beb4153e3f94de3Mark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
f1740da065d4555039fe8bb53beb4153e3f94de3Mark Andrews<th width="60%" align="center">Manual pages</th>
ad309e8dfa0601d6053aaa12770a98a6940f89deEvan Hunt<a name="man.ddns-confgen"></a><div class="titlepage"></div>
635e4351b04fd61ca6d853bdac6268c090b55129Mark Andrews<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
7cbac360bf98c0a52b2d6866ad887616c32d4d3aMark Andrews<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>
1cf118a656f5fd210787908b845362077fc507f8Evan Hunt<p><span><strong class="command">ddns-confgen</strong></span>
1cf118a656f5fd210787908b845362077fc507f8Evan Hunt generates a key for use by <span><strong class="command">nsupdate</strong></span>
1cf118a656f5fd210787908b845362077fc507f8Evan Hunt and <span><strong class="command">named</strong></span>. It simplifies configuration
1cf118a656f5fd210787908b845362077fc507f8Evan Hunt of dynamic zones by generating a key and providing the
1cf118a656f5fd210787908b845362077fc507f8Evan Hunt <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
1cf118a656f5fd210787908b845362077fc507f8Evan Hunt syntax that will be needed to use it, including an example
6fb3db01acad7f5c1f4e23789fb0f2ce56cc07deMukund Sivaraman <span><strong class="command">update-policy</strong></span> statement.
fd82c70695888c134287b8018296028c252d100eMukund Sivaraman If a domain name is specified on the command line, it will
fd82c70695888c134287b8018296028c252d100eMukund Sivaraman be used in the name of the generated key and in the sample
fd82c70695888c134287b8018296028c252d100eMukund Sivaraman <span><strong class="command">named.conf</strong></span> syntax. For example,
fd82c70695888c134287b8018296028c252d100eMukund Sivaraman <span><strong class="command">ddns-confgen example.com</strong></span> would
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews generate a key called "ddns-key.example.com", and sample
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews <span><strong class="command">named.conf</strong></span> command that could be used
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews in the zone definition for "example.com".
2cf0fe3b8092f64f8f68ae3693fe2e73e90ad1a4Mark Andrews Note that <span><strong class="command">named</strong></span> itself can configure a
2cf0fe3b8092f64f8f68ae3693fe2e73e90ad1a4Mark Andrews local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
4221d9cd1d02311fbf9b5f08a038f5af78b10b4aEvan Hunt <span><strong class="command">ddns-confgen</strong></span> is only needed when a
4221d9cd1d02311fbf9b5f08a038f5af78b10b4aEvan Hunt more elaborate configuration is required: for instance, if
4221d9cd1d02311fbf9b5f08a038f5af78b10b4aEvan Hunt <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
f9c410d93711fbf312a0162f1e2d3f2a5ede69afFrancis Dupont<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
e526027287b849f0b6ab6e069156697cbafa22c1Michał Kępień Specifies the algorithm to use for the TSIG key. Available
e526027287b849f0b6ab6e069156697cbafa22c1Michał Kępień choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
e526027287b849f0b6ab6e069156697cbafa22c1Michał Kępień hmac-sha384 and hmac-sha512. The default is hmac-sha256.
7e1a62eea2e4ba9d6c3fc718e679b965fa514f69Mark Andrews Prints a short summary of the options and arguments to
ec29d217ba3a2bf3e617a7b5b6708ae221bee999Mark Andrews <span><strong class="command">ddns-confgen</strong></span>.
afefd754734f896bf3e0590177fff83e7cdfdf35Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
afefd754734f896bf3e0590177fff83e7cdfdf35Mark Andrews Specifies the key name of the DDNS authentication key.
f0353a586c2bfbae999193cb644b6bc94c7944d8Mark Andrews The default is <code class="constant">ddns-key</code> when neither
f0353a586c2bfbae999193cb644b6bc94c7944d8Mark Andrews the <code class="option">-s</code> nor <code class="option">-z</code> option is
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt specified; otherwise, the default
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt is <code class="constant">ddns-key</code> as a separate label
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt followed by the argument of the option, e.g.,
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt <code class="constant">ddns-key.example.com.</code>
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt The key name must have the format of a valid domain name,
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt consisting of letters, digits, hyphens and periods.
7ff28f5befbee76048a23e504dcd3f9a44ce6209Evan Hunt Quiet mode: Print only the key, with no explanatory text or
cad79077bd5b2616bc4a7a6b3cbc0953bef8917fMark Andrews usage examples.
cad79077bd5b2616bc4a7a6b3cbc0953bef8917fMark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
adfe58e8e5cd1890585e92b67f1fd01989a1fa7dMark Andrews Specifies a source of random data for generating the
adfe58e8e5cd1890585e92b67f1fd01989a1fa7dMark Andrews authorization. If the operating system does not provide a
adfe58e8e5cd1890585e92b67f1fd01989a1fa7dMark Andrews <code class="filename">/dev/random</code> or equivalent device, the
c3237dec879f82855403ff7e3ba87b298172efd5Mark Andrews default source of randomness is keyboard input.
c3237dec879f82855403ff7e3ba87b298172efd5Mark Andrews <code class="filename">randomdev</code> specifies the name of a
c3237dec879f82855403ff7e3ba87b298172efd5Mark Andrews character device or file containing random data to be used
c3237dec879f82855403ff7e3ba87b298172efd5Mark Andrews instead of the default. The special value
c3237dec879f82855403ff7e3ba87b298172efd5Mark Andrews <code class="filename">keyboard</code> indicates that keyboard input
cb616c6d5c2ece1fac37fa6e0bca2b53d4043098Mark Andrews should be used.
cb616c6d5c2ece1fac37fa6e0bca2b53d4043098Mark Andrews<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
c0a2210466dec0cc81ebf2ffbe21693b57b9c29cMark Andrews Single host mode: The example <span><strong class="command">named.conf</strong></span> text
c0a2210466dec0cc81ebf2ffbe21693b57b9c29cMark Andrews shows how to set an update policy for the specified
534057c9f91a3eb6e0541f3526459c716239b337Mark Andrews using the "name" nametype.
534057c9f91a3eb6e0541f3526459c716239b337Mark Andrews The default key name is
0f14b041328c062b1fa391887376388dfc8b2fe5Mark Andrews ddns-key.<em class="replaceable"><code>name</code></em>.
0f14b041328c062b1fa391887376388dfc8b2fe5Mark Andrews Note that the "self" nametype cannot be used, since
0f14b041328c062b1fa391887376388dfc8b2fe5Mark Andrews the name to be updated may differ from the key name.
0f14b041328c062b1fa391887376388dfc8b2fe5Mark Andrews This option cannot be used with the <code class="option">-z</code> option.
f7f4730e563a2749629fe7fef4cd9513cd2bfab7Mark Andrews<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
1848d38f441ebf70ab21f6151bc3487a92d25b63Mark Andrews zone mode: The example <span><strong class="command">named.conf</strong></span> text
2d82ed9456e72dc4373bea19d63411afe1c48962Mark Andrews shows how to set an update policy for the specified
2d82ed9456e72dc4373bea19d63411afe1c48962Mark Andrews using the "zonesub" nametype, allowing updates to all subdomain
a5a1cbece45e6ca68aafe3b9b995eac6b0f45dd2Mark Andrews names within
a5a1cbece45e6ca68aafe3b9b995eac6b0f45dd2Mark Andrews that <em class="replaceable"><code>zone</code></em>.
0d6328ce5f6b799f8e7c6cbbb3b965cf29bfb7baMark Andrews This option cannot be used with the <code class="option">-s</code> option.
677f507de7c546c187c1505c48bc7b440545485cMark Andrews<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
124cc0660c7eff8021c2422fb47441e9ca08b3f9Tinderbox User <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
e01ef6f01c7e8f80122cd80a2e011425a0135489Mark Andrews <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
677f507de7c546c187c1505c48bc7b440545485cMark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
677f507de7c546c187c1505c48bc7b440545485cMark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
677f507de7c546c187c1505c48bc7b440545485cMark Andrews<table width="100%" summary="Navigation footer">
f53e0bda467d96dfeeba1b4da30c37b37766bb75Evan Hunt<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
f53e0bda467d96dfeeba1b4da30c37b37766bb75Evan Hunt<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
81e3e3084980afcd61416f572c6e72d38a3808abMichał Kępień<span class="application">rndc-confgen</span>�</td>
81e3e3084980afcd61416f572c6e72d38a3808abMichał Kępień<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
64d7fa3ec4785b390665860aa6bdae304b3c1d24Mark Andrews<td width="40%" align="right" valign="top">�</td>