man.ddns-confgen.html revision e2e4d321999340802f77adaacd19c797d04b4b95
ea206aebcafe1ed5d470dd99daab9a1cedc81c7cMark Andrews - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
a02a0a8a7eb461619931f4a0e896afa247b52c54Mark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
4e3c7a22ea3219f680e09540ee12bb326fc2ccedMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews - purpose with or without fee is hereby granted, provided that the above
ea206aebcafe1ed5d470dd99daab9a1cedc81c7cMark Andrews - copyright notice and this permission notice appear in all copies.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
01bf5871f8861eb805dd8ca79bdb9b0b9e4e6a5eMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
0756445a735e2df39bf798d8de42ae5dd030aa3bMark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
f8f37672a57524560fbdde52484e6ae3de1c3354Mark Andrews<!-- $Id: man.ddns-confgen.html,v 1.40 2009/12/04 22:22:26 tbox Exp $ -->
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews<link rel="next" href="man.arpaname.html" title="arpaname">
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<table width="100%" summary="Navigation header">
75216e007570b8ea36b3ac9cca096bf70c0ca6f6Mark Andrews<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
ed178efa9ab8f813538fce4ff603b81ded9f1799Mark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<th width="60%" align="center">Manual pages</th>
bac2ed6ec3fbb5420e6ce69dd1218745d4e02b1eMark Andrews<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
ede29aeb412c5448ab9a2028763ae08e7887ca74Mark Andrews<a name="man.ddns-confgen"></a><div class="titlepage"></div>
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews<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>] [ -s <em class="replaceable"><code>name</code></em> | -z <em class="replaceable"><code>zone</code></em> ] [<code class="option">-q</code>] [name]</p></div>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<a name="id2639866"></a><h2>DESCRIPTION</h2>
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews<p><span><strong class="command">ddns-confgen</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington generates a key for use by <span><strong class="command">nsupdate</strong></span>
26a77b80bb7ee886c6fa704348d5e80a011d8811Mark Andrews and <span><strong class="command">named</strong></span>. It simplifies configuration
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews of dynamic zones by generating a key and providing the
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews syntax that will be needed to use it, including an example
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span><strong class="command">update-policy</strong></span> statement.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews 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
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <span><strong class="command">named.conf</strong></span> syntax. For example,
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews <span><strong class="command">ddns-confgen example.com</strong></span> would
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews generate a key called "ddns-key.example.com", and sample
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <span><strong class="command">named.conf</strong></span> command that could be used
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews in the zone definition for "example.com".
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews Note that <span><strong class="command">named</strong></span> itself can configure a
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews <span><strong class="command">ddns-confgen</strong></span> is only needed when a
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington more elaborate configuration is required: for instance, if
c25080dc50542213058c240226c9f342186e6285Mark Andrews <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Specifies the algorithm to use for the TSIG key. Available
c25080dc50542213058c240226c9f342186e6285Mark Andrews choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews hmac-sha384 and hmac-sha512. The default is hmac-sha256.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Prints a short summary of the options and arguments to
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <span><strong class="command">ddns-confgen</strong></span>.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Specifies the key name of the DDNS authentication key.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews The default is <code class="constant">ddns-key</code> when neither
642e0716c8b4ab82ebc8e60f94c9e897ee89f19aMark Andrews the <code class="option">-s</code> nor <code class="option">-z</code> option is
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews specified; otherwise, the default
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews is <code class="constant">ddns-key</code> as a separate label
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews followed by the argument of the option, e.g.,
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <code class="constant">ddns-key.example.com.</code>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews The key name must have the format of a valid domain name,
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews consisting of letters, digits, hyphens and periods.
413988c8166976498250c0ebb2e3a645d0366bd3Mark Andrews Quiet mode: Print only the key, with no explanatory text or
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews usage examples.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Specifies a source of random data for generating the
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews authorization. If the operating system does not provide a
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <code class="filename">/dev/random</code> or equivalent device, the
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews default source of randomness is keyboard input.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <code class="filename">randomdev</code> specifies the name of a
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews character device or file containing random data to be used
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews instead of the default. The special value
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews <code class="filename">keyboard</code> indicates that keyboard input
ed178efa9ab8f813538fce4ff603b81ded9f1799Mark Andrews should be used.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Single host mode: The example <span><strong class="command">named.conf</strong></span> text
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews shows how to set an update policy for the specified
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews using the "name" nametype.
ed178efa9ab8f813538fce4ff603b81ded9f1799Mark Andrews The default key name is
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews ddns-key.<em class="replaceable"><code>name</code></em>.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews Note that the "self" nametype cannot be used, since
ca12f7f4cf72e2368ee946f3eb4915ab73576cdcMark Andrews the name to be updated may differ from the key name.
c25080dc50542213058c240226c9f342186e6285Mark Andrews This option cannot be used with the <code class="option">-z</code> option.
a9789e288ee11ae4315e27235c33bae5405bd7c4Mark Andrews<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington zone mode: The example <span><strong class="command">named.conf</strong></span> text
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews shows how to set an update policy for the specified
642e0716c8b4ab82ebc8e60f94c9e897ee89f19aMark Andrews using the "zonesub" nametype, allowing updates to all subdomain
0756445a735e2df39bf798d8de42ae5dd030aa3bMark Andrews names within
068a66979695c77359e7a9181bb3f831c965b21cMark Andrews that <em class="replaceable"><code>zone</code></em>.
75216e007570b8ea36b3ac9cca096bf70c0ca6f6Mark Andrews This option cannot be used with the <code class="option">-s</code> option.
7c40ffd67bd1e73907f83a79a6ff8c635f4a4a74Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
0756445a735e2df39bf798d8de42ae5dd030aa3bMark Andrews <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
75216e007570b8ea36b3ac9cca096bf70c0ca6f6Mark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
821d2613356f81e5bb5c107288d6d5cf35c2a1e8Mark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<table width="100%" summary="Navigation footer">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
5752b9e296f14034f103149f18188770c2cc5239Mark Andrews<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<span class="application">rndc-confgen</span>�</td>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
e076d0c88be69de7c190ab924d095e69d2e11f7aAndreas Gustafsson<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>