man.ddns-confgen.html revision ce8ac1bc98ba20c1ba02e6a6ff39561140089ae3
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!--
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson - Copyright (C) 2004-2011 Internet Systems Consortium, Inc. ("ISC")
48900a8f62784cce8afb632190512581e1c20d34Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - copyright notice and this permission notice appear in all copies.
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson -
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - PERFORMANCE OF THIS SOFTWARE.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews-->
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<!-- $Id: man.ddns-confgen.html,v 1.102 2011/12/17 01:14:50 tbox Exp $ -->
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<html>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<head>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<title>ddns-confgen</title>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<link rel="next" href="man.arpaname.html" title="arpaname">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="navheader">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<table width="100%" summary="Navigation header">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="left">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<th width="60%" align="center">Manual pages</th>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</table>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<hr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refentry" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="man.ddns-confgen"></a><div class="titlepage"></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refnamediv">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<h2>Name</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsynopsisdiv">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<h2>Synopsis</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<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>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsect1" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id2643470"></a><h2>DESCRIPTION</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><span><strong class="command">ddns-confgen</strong></span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User generates a key for use by <span><strong class="command">nsupdate</strong></span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User and <span><strong class="command">named</strong></span>. It simplifies configuration
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User of dynamic zones by generating a key and providing the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User syntax that will be needed to use it, including an example
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">update-policy</strong></span> statement.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User If a domain name is specified on the command line, it will
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User be used in the name of the generated key and in the sample
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">named.conf</strong></span> syntax. For example,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">ddns-confgen example.com</strong></span> would
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User generate a key called "ddns-key.example.com", and sample
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <span><strong class="command">named.conf</strong></span> command that could be used
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User in the zone definition for "example.com".
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note that <span><strong class="command">named</strong></span> itself can configure a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">ddns-confgen</strong></span> is only needed when a
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User more elaborate configuration is required: for instance, if
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id2643558"></a><h2>OPTIONS</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="variablelist"><dl>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the algorithm to use for the TSIG key. Available
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein hmac-sha384 and hmac-sha512. The default is hmac-sha256.
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews </p></dd>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<dt><span class="term">-h</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Prints a short summary of the options and arguments to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">ddns-confgen</strong></span>.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p></dd>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Specifies the key name of the DDNS authentication key.
03c0efc6892ef2ed17338b2ecbb2c5f23fbad0c9Tinderbox User The default is <code class="constant">ddns-key</code> when neither
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User the <code class="option">-s</code> nor <code class="option">-z</code> option is
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User specified; otherwise, the default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is <code class="constant">ddns-key</code> as a separate label
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User followed by the argument of the option, e.g.,
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="constant">ddns-key.example.com.</code>
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater The key name must have the format of a valid domain name,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User consisting of letters, digits, hyphens and periods.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-q</span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dd><p>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Quiet mode: Print only the key, with no explanatory text or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein usage examples.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Specifies a source of random data for generating the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User authorization. If the operating system does not provide a
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews <code class="filename">/dev/random</code> or equivalent device, the
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User default source of randomness is keyboard input.
9d557856c2a19ec95ee73245f60a92f8675cf5baTinderbox User <code class="filename">randomdev</code> specifies the name of a
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater character device or file containing random data to be used
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews instead of the default. The special value
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews <code class="filename">keyboard</code> indicates that keyboard input
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User should be used.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p></dd>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<dd><p>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Single host mode: The example <span><strong class="command">named.conf</strong></span> text
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User shows how to set an update policy for the specified
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <em class="replaceable"><code>name</code></em>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User using the "name" nametype.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User The default key name is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ddns-key.<em class="replaceable"><code>name</code></em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note that the "self" nametype cannot be used, since
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the name to be updated may differ from the key name.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This option cannot be used with the <code class="option">-z</code> option.
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein zone mode: The example <span><strong class="command">named.conf</strong></span> text
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User shows how to set an update policy for the specified
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <em class="replaceable"><code>zone</code></em>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User using the "zonesub" nametype, allowing updates to all subdomain
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User names within
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User that <em class="replaceable"><code>zone</code></em>.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User This option cannot be used with the <code class="option">-s</code> option.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User </p></dd>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User</dl></div>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsect1" lang="en">
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<a name="id2644646"></a><h2>SEE ALSO</h2>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User </p>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User</div>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<div class="refsect1" lang="en">
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<a name="id2644684"></a><h2>AUTHOR</h2>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<p><span class="corpauthor">Internet Systems Consortium</span>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User </p>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="navfooter">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<hr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<table width="100%" summary="Navigation footer">
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<td width="40%" align="left">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</td>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User</tr>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<tr>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<td width="40%" align="left" valign="top">
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<span class="application">rndc-confgen</span>�</td>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</body>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</html>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User