man.ddns-confgen.html revision a3416b0a1b5482b6df32839445ca98c016945570
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!--
b0e8629055a766d4555a005a283c2889a5974945Mark Andrews - Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and/or distribute this software for any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein-->
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews<!-- $Id: man.ddns-confgen.html,v 1.45 2010/01/20 01:14:19 tbox Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<html>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<title>ddns-confgen</title>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="next" href="man.arpaname.html" title="arpaname">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="navheader">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table width="100%" summary="Navigation header">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="left">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<th width="60%" align="center">Manual pages</th>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<hr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refentry" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.ddns-confgen"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refnamediv">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<h2>Name</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsynopsisdiv">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<h2>Synopsis</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews<div class="refsect1" lang="en">
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews<a name="id2639909"></a><h2>DESCRIPTION</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span><strong class="command">ddns-confgen</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generates a key for use by <span><strong class="command">nsupdate</strong></span>
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews and <span><strong class="command">named</strong></span>. It simplifies configuration
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews of dynamic zones by generating a key and providing the
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews syntax that will be needed to use it, including an example
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews <span><strong class="command">update-policy</strong></span> statement.
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p>
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews If a domain name is specified on the command line, it will
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews be used in the name of the generated key and in the sample
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">named.conf</strong></span> syntax. For example,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">ddns-confgen example.com</strong></span> would
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews generate a key called "ddns-key.example.com", and sample
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews <span><strong class="command">named.conf</strong></span> command that could be used
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews in the zone definition for "example.com".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews<p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note that <span><strong class="command">named</strong></span> itself can configure a
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
bea931e17b7567f09107f93ab7e25c7f00abeb9cMark Andrews <span><strong class="command">ddns-confgen</strong></span> is only needed when a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2640065"></a><h2>OPTIONS</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="variablelist"><dl>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-h</span></dt>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Prints a short summary of the options and arguments to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">ddns-confgen</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the key name of the DDNS authentication key.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The default is <code class="constant">ddns-key</code> when neither
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the <code class="option">-s</code> nor <code class="option">-z</code> option is
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews specified; otherwise, the default
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews is <code class="constant">ddns-key</code> as a separate label
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews followed by the argument of the option, e.g.,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="constant">ddns-key.example.com.</code>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews The key name must have the format of a valid domain name,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews consisting of letters, digits, hyphens and periods.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-q</span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies a source of random data for generating the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein authorization. If the operating system does not provide a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="filename">/dev/random</code> or equivalent device, the
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews default source of randomness is keyboard input.
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews <code class="filename">randomdev</code> specifies the name of a
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews character device or file containing random data to be used
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews instead of the default. The special value
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews <code class="filename">keyboard</code> indicates that keyboard input
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews should be used.
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews </p></dd>
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Single host mode: The example <span><strong class="command">named.conf</strong></span> text
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein shows how to set an update policy for the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="replaceable"><code>name</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein using the "name" nametype.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dd><p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein zone mode: The example <span><strong class="command">named.conf</strong></span> text
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein shows how to set an update policy for the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="replaceable"><code>zone</code></em>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein using the "zonesub" nametype, allowing updates to all subdomain
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein names within
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that <em class="replaceable"><code>zone</code></em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This option cannot be used with the <code class="option">-s</code> option.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p></dd>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</dl></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2643474"></a><h2>SEE ALSO</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="refsect1" lang="en">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2643512"></a><h2>AUTHOR</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="corpauthor">Internet Systems Consortium</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="navfooter">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<hr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<table width="100%" summary="Navigation footer">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="left">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<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>
b05bdb520d83f7ecaad708fe305268c3420be01dMark Andrews<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="left" valign="top">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<span class="application">rndc-confgen</span>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</table>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews</div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</body>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</html>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein