man.ddns-confgen.html revision 7a0d680aa507f1b9beaa5c350e4d562aab534323
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe<!--
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
db8ac7cbb1fa6cdd6abcc4bb797d4deed32dd269jim - Copyright (C) 2000-2003 Internet Software Consortium.
db8ac7cbb1fa6cdd6abcc4bb797d4deed32dd269jim -
db8ac7cbb1fa6cdd6abcc4bb797d4deed32dd269jim - Permission to use, copy, modify, and/or distribute this software for any
db8ac7cbb1fa6cdd6abcc4bb797d4deed32dd269jim - purpose with or without fee is hereby granted, provided that the above
db8ac7cbb1fa6cdd6abcc4bb797d4deed32dd269jim - copyright notice and this permission notice appear in all copies.
7b979864a91b52ecebca11d0a9a22e09349e59baminfrin -
8d755accbdc5ae15bb0d00169b815d264c7de745minfrin - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8d755accbdc5ae15bb0d00169b815d264c7de745minfrin - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
7b979864a91b52ecebca11d0a9a22e09349e59baminfrin - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
7b979864a91b52ecebca11d0a9a22e09349e59baminfrin - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
7b0a3bcc0e689305df49f7d4da7abc35aa891862brianp - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7b0a3bcc0e689305df49f7d4da7abc35aa891862brianp - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
7b0a3bcc0e689305df49f7d4da7abc35aa891862brianp - PERFORMANCE OF THIS SOFTWARE.
1bae4591a85d90325ecdacedf7e54d1bbfe31037aaron-->
1bae4591a85d90325ecdacedf7e54d1bbfe31037aaron<!-- $Id: man.ddns-confgen.html,v 1.41 2009/12/19 01:14:05 tbox Exp $ -->
1bae4591a85d90325ecdacedf7e54d1bbfe31037aaron<html>
a6f48cc01ab8f5377e570c61826dcdfc36741936trawick<head>
a6f48cc01ab8f5377e570c61826dcdfc36741936trawick<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a6f48cc01ab8f5377e570c61826dcdfc36741936trawick<title>ddns-confgen</title>
a6f48cc01ab8f5377e570c61826dcdfc36741936trawick<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
2da345202997f8f5860c801d68f7913c02fc05fctrawick<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
2da345202997f8f5860c801d68f7913c02fc05fctrawick<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
2da345202997f8f5860c801d68f7913c02fc05fctrawick<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe<link rel="next" href="man.arpaname.html" title="arpaname">
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe</head>
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe<div class="navheader">
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe<table width="100%" summary="Navigation header">
5bd562b1d7da51cb5715899d32bb4c79c54459b0wrowe<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
1c06e98017400874d5ff6ad79f13145ec4589225striker<tr>
1c06e98017400874d5ff6ad79f13145ec4589225striker<td width="20%" align="left">
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe<th width="60%" align="center">Manual pages</th>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe</td>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe</tr>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe</table>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe<hr>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe</div>
99a041314eb3db0b0cca325c9c40d0a6c5fdf04fwrowe<div class="refentry" lang="en">
6e119e632566d69798ce6cf4e714ed374b72914frederpj<a name="man.ddns-confgen"></a><div class="titlepage"></div>
6e119e632566d69798ce6cf4e714ed374b72914frederpj<div class="refnamediv">
6e119e632566d69798ce6cf4e714ed374b72914frederpj<h2>Name</h2>
6e119e632566d69798ce6cf4e714ed374b72914frederpj<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
6e119e632566d69798ce6cf4e714ed374b72914frederpj</div>
bd120542ebe7e09cdbada5daf4924f4690e5ece3trawick<div class="refsynopsisdiv">
bd120542ebe7e09cdbada5daf4924f4690e5ece3trawick<h2>Synopsis</h2>
bd120542ebe7e09cdbada5daf4924f4690e5ece3trawick<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>
bd120542ebe7e09cdbada5daf4924f4690e5ece3trawick</div>
bd120542ebe7e09cdbada5daf4924f4690e5ece3trawick<div class="refsect1" lang="en">
68d439bc0482b2e41053480f748edc2574c2ea7btrawick<a name="id2638790"></a><h2>DESCRIPTION</h2>
68d439bc0482b2e41053480f748edc2574c2ea7btrawick<p><span><strong class="command">ddns-confgen</strong></span>
68d439bc0482b2e41053480f748edc2574c2ea7btrawick generates a key for use by <span><strong class="command">nsupdate</strong></span>
68d439bc0482b2e41053480f748edc2574c2ea7btrawick and <span><strong class="command">named</strong></span>. It simplifies configuration
dddbde8480d265d06c84f2281f01e00f8ef52e94mjc of dynamic zones by generating a key and providing the
dddbde8480d265d06c84f2281f01e00f8ef52e94mjc <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
dddbde8480d265d06c84f2281f01e00f8ef52e94mjc syntax that will be needed to use it, including an example
a5ca705e053a6c754c5958aafcd6f0aa60a2e67frbb <span><strong class="command">update-policy</strong></span> statement.
e06675c51d084791089d79c3ac18aeae8dd465fcrbb </p>
e06675c51d084791089d79c3ac18aeae8dd465fcrbb<p>
e06675c51d084791089d79c3ac18aeae8dd465fcrbb If a domain name is specified on the command line, it will
e06675c51d084791089d79c3ac18aeae8dd465fcrbb be used in the name of the generated key and in the sample
481c1206b6065a8f37ab75ca1fc26c947cb37852ianh <span><strong class="command">named.conf</strong></span> syntax. For example,
481c1206b6065a8f37ab75ca1fc26c947cb37852ianh <span><strong class="command">ddns-confgen example.com</strong></span> would
481c1206b6065a8f37ab75ca1fc26c947cb37852ianh generate a key called "ddns-key.example.com", and sample
a964f7434f5c7f512a5fa0d0178260ccb74c84berbb <span><strong class="command">named.conf</strong></span> command that could be used
a964f7434f5c7f512a5fa0d0178260ccb74c84berbb in the zone definition for "example.com".
a964f7434f5c7f512a5fa0d0178260ccb74c84berbb </p>
a964f7434f5c7f512a5fa0d0178260ccb74c84berbb<p>
6a7877447bcb8e6ff848d72f82f184c404ef4c0bminfrin Note that <span><strong class="command">named</strong></span> itself can configure a
6a7877447bcb8e6ff848d72f82f184c404ef4c0bminfrin local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
6a7877447bcb8e6ff848d72f82f184c404ef4c0bminfrin <span><strong class="command">ddns-confgen</strong></span> is only needed when a
9335cbd541cca1ca6038af329bbd1645310aabccminfrin more elaborate configuration is required: for instance, if
9335cbd541cca1ca6038af329bbd1645310aabccminfrin <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
9335cbd541cca1ca6038af329bbd1645310aabccminfrin </p>
9335cbd541cca1ca6038af329bbd1645310aabccminfrin</div>
9335cbd541cca1ca6038af329bbd1645310aabccminfrin<div class="refsect1" lang="en">
9335cbd541cca1ca6038af329bbd1645310aabccminfrin<a name="id2638877"></a><h2>OPTIONS</h2>
9335cbd541cca1ca6038af329bbd1645310aabccminfrin<div class="variablelist"><dl>
9335cbd541cca1ca6038af329bbd1645310aabccminfrin<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
e156db58351d1c040bc72430f3eb072cb6ae7107brianp<dd><p>
e156db58351d1c040bc72430f3eb072cb6ae7107brianp Specifies the algorithm to use for the TSIG key. Available
e156db58351d1c040bc72430f3eb072cb6ae7107brianp choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
e156db58351d1c040bc72430f3eb072cb6ae7107brianp hmac-sha384 and hmac-sha512. The default is hmac-sha256.
1c06e98017400874d5ff6ad79f13145ec4589225striker </p></dd>
1c06e98017400874d5ff6ad79f13145ec4589225striker<dt><span class="term">-h</span></dt>
1c06e98017400874d5ff6ad79f13145ec4589225striker<dd><p>
eb1349e4ab58bd2935f7054a1bfc5c86ab5a5fa3striker Prints a short summary of the options and arguments to
eb1349e4ab58bd2935f7054a1bfc5c86ab5a5fa3striker <span><strong class="command">ddns-confgen</strong></span>.
6a94da925498a20a09fde0a66002607be8d83b1astriker </p></dd>
6a94da925498a20a09fde0a66002607be8d83b1astriker<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
75161f3b2029c25bdb3f8ab87b85cb1810c479eajerenkrantz<dd><p>
7639aa8b39e0d9dbd096f9cc3379bcd3d5e4003bstriker Specifies the key name of the DDNS authentication key.
8dc5aa056a586ffa920a6ecd5c31048702371ea6brianp The default is <code class="constant">ddns-key</code> when neither
4c9d27bfdfea41b388dc705f7cc2b49318ab5344jim the <code class="option">-s</code> nor <code class="option">-z</code> option is
4c9d27bfdfea41b388dc705f7cc2b49318ab5344jim specified; otherwise, the default
4c9d27bfdfea41b388dc705f7cc2b49318ab5344jim is <code class="constant">ddns-key</code> as a separate label
e8e8ab3cbc3d90f15eb78e094c381a6e908fd6efjerenkrantz followed by the argument of the option, e.g.,
e8e8ab3cbc3d90f15eb78e094c381a6e908fd6efjerenkrantz <code class="constant">ddns-key.example.com.</code>
e8e8ab3cbc3d90f15eb78e094c381a6e908fd6efjerenkrantz The key name must have the format of a valid domain name,
f4c472b8dce3c2e559232dbb5b27ed2466922ea4jerenkrantz consisting of letters, digits, hyphens and periods.
f4c472b8dce3c2e559232dbb5b27ed2466922ea4jerenkrantz </p></dd>
8dc5aa056a586ffa920a6ecd5c31048702371ea6brianp<dt><span class="term">-q</span></dt>
8dc5aa056a586ffa920a6ecd5c31048702371ea6brianp<dd><p>
8dc5aa056a586ffa920a6ecd5c31048702371ea6brianp Quiet mode: Print only the key, with no explanatory text or
7e31ef4870c7ef94838585004405e8854fefcc51ianh usage examples.
7e31ef4870c7ef94838585004405e8854fefcc51ianh </p></dd>
7e31ef4870c7ef94838585004405e8854fefcc51ianh<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
7e31ef4870c7ef94838585004405e8854fefcc51ianh<dd><p>
7e31ef4870c7ef94838585004405e8854fefcc51ianh Specifies a source of random data for generating the
bd496a3a7752a55c849e62ed00cacc492d4f6d3erederpj authorization. If the operating system does not provide a
bd496a3a7752a55c849e62ed00cacc492d4f6d3erederpj <code class="filename">/dev/random</code> or equivalent device, the
bd496a3a7752a55c849e62ed00cacc492d4f6d3erederpj default source of randomness is keyboard input.
bd496a3a7752a55c849e62ed00cacc492d4f6d3erederpj <code class="filename">randomdev</code> specifies the name of a
bd496a3a7752a55c849e62ed00cacc492d4f6d3erederpj character device or file containing random data to be used
a8c401eadf77822e851f19c7740e7ec6dca03daastoddard instead of the default. The special value
a8c401eadf77822e851f19c7740e7ec6dca03daastoddard <code class="filename">keyboard</code> indicates that keyboard input
a8c401eadf77822e851f19c7740e7ec6dca03daastoddard should be used.
a8c401eadf77822e851f19c7740e7ec6dca03daastoddard </p></dd>
93d7153aa172665f55b04463b831ad556269c3efbrianp<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
791781f2ccc1f1f1bc1b1643861d3da23edfd147jerenkrantz<dd><p>
791781f2ccc1f1f1bc1b1643861d3da23edfd147jerenkrantz Single host mode: The example <span><strong class="command">named.conf</strong></span> text
2ffa5829cad36f12b0a1fc3481592e85bc210a5bjerenkrantz shows how to set an update policy for the specified
2ffa5829cad36f12b0a1fc3481592e85bc210a5bjerenkrantz <em class="replaceable"><code>name</code></em>
2ffa5829cad36f12b0a1fc3481592e85bc210a5bjerenkrantz using the "name" nametype.
02e8590d904653a95eca31bdf8e60866642bb592slive The default key name is
02e8590d904653a95eca31bdf8e60866642bb592slive ddns-key.<em class="replaceable"><code>name</code></em>.
30a5ee06ae5f7f67a83d6852871f654ae3e14aadslive Note that the "self" nametype cannot be used, since
02e8590d904653a95eca31bdf8e60866642bb592slive the name to be updated may differ from the key name.
a97c4ce2bea3dbf8ddc82c796cf93aa6b46765a4brianp This option cannot be used with the <code class="option">-z</code> option.
a97c4ce2bea3dbf8ddc82c796cf93aa6b46765a4brianp </p></dd>
a97c4ce2bea3dbf8ddc82c796cf93aa6b46765a4brianp<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
b7838ae85a698af19d90ba4ebe03e10bdc149eacjerenkrantz<dd><p>
b7838ae85a698af19d90ba4ebe03e10bdc149eacjerenkrantz zone mode: The example <span><strong class="command">named.conf</strong></span> text
435d2db95b905b0d16d35410e18ff77dc39688aabrianp shows how to set an update policy for the specified
435d2db95b905b0d16d35410e18ff77dc39688aabrianp <em class="replaceable"><code>zone</code></em>
435d2db95b905b0d16d35410e18ff77dc39688aabrianp using the "zonesub" nametype, allowing updates to all subdomain
1a7728c0205d607d5d87c6b6bf1b8837a9785a99ianh names within
a574815e2c6db68b9d8139db89921ededf033decianh that <em class="replaceable"><code>zone</code></em>.
a574815e2c6db68b9d8139db89921ededf033decianh This option cannot be used with the <code class="option">-s</code> option.
964f539e766a3301b3e2f767baeffddcf9f6092bjerenkrantz </p></dd>
964f539e766a3301b3e2f767baeffddcf9f6092bjerenkrantz</dl></div>
964f539e766a3301b3e2f767baeffddcf9f6092bjerenkrantz</div>
5e538c6ced13aa2f7c358e1a44f651d31dd5fab8brianp<div class="refsect1" lang="en">
5e538c6ced13aa2f7c358e1a44f651d31dd5fab8brianp<a name="id2639351"></a><h2>SEE ALSO</h2>
5e538c6ced13aa2f7c358e1a44f651d31dd5fab8brianp<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
5e538c6ced13aa2f7c358e1a44f651d31dd5fab8brianp <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
61202a45487668abad788c02e339f626176e645fianh <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
61202a45487668abad788c02e339f626176e645fianh <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
61202a45487668abad788c02e339f626176e645fianh </p>
02c49e1f35a4d1a171df2d319e76af0c5163dc4dmartin</div>
02c49e1f35a4d1a171df2d319e76af0c5163dc4dmartin<div class="refsect1" lang="en">
02c49e1f35a4d1a171df2d319e76af0c5163dc4dmartin<a name="id2639389"></a><h2>AUTHOR</h2>
6deb8bcfb8511ac38243a8274fc589842841b398ianh<p><span class="corpauthor">Internet Systems Consortium</span>
6deb8bcfb8511ac38243a8274fc589842841b398ianh </p>
6deb8bcfb8511ac38243a8274fc589842841b398ianh</div>
49bbbd1939208be54a3eb00b95e61d90d180a606ianh</div>
49bbbd1939208be54a3eb00b95e61d90d180a606ianh<div class="navfooter">
93d7153aa172665f55b04463b831ad556269c3efbrianp<hr>
93d7153aa172665f55b04463b831ad556269c3efbrianp<table width="100%" summary="Navigation footer">
93d7153aa172665f55b04463b831ad556269c3efbrianp<tr>
93d7153aa172665f55b04463b831ad556269c3efbrianp<td width="40%" align="left">
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard</td>
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard</tr>
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard<tr>
bc6600a6207e5d15b895294e370e4e3320a803d8stoddard<td width="40%" align="left" valign="top">
4e21f1a207aefa9796dc758bf7274b0f1fea780fstoddard<span class="application">rndc-confgen</span>�</td>
7a23067e782dd5612d4d4b539906e1733b664df7jwoolley<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
5c214a63f9722864ac4983995da11353779515dbrederpj<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
5c214a63f9722864ac4983995da11353779515dbrederpj</td>
5c214a63f9722864ac4983995da11353779515dbrederpj</tr>
5c214a63f9722864ac4983995da11353779515dbrederpj</table>
9f20717d827f2113a23dfa45539813171cf626eaianh</div>
9f20717d827f2113a23dfa45539813171cf626eaianh</body>
9f20717d827f2113a23dfa45539813171cf626eaianh</html>
9f20717d827f2113a23dfa45539813171cf626eaianh