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