man.ddns-confgen.html revision 24abfe433efd98bb2099b867fb14d049b2f1f531
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Permission to use, copy, modify, and/or distribute this software for any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - purpose with or without fee is hereby granted, provided that the above
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - copyright notice and this permission notice appear in all copies.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - PERFORMANCE OF THIS SOFTWARE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<!-- $Id$ -->
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<link rel="next" href="man.arpaname.html" title="arpaname">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<a name="man.ddns-confgen"></a><div class="titlepage"></div>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<div class="cmdsynopsis"><p><code class="command">tsig-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [name]</p></div>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<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">-q</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> ]</p></div>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are invocation methods for a utility that generates keys for use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in TSIG signing. The resulting keys can be used, for example,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to secure dynamic DNS updates to a zone or for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">rndc</strong></span> command channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be specified on the command line which will be used as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the name of the generated key. If no name is specified,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the default is <code class="constant">tsig-key</code>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When run as <span><strong class="command">ddns-confgen</strong></span>, the generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync key is accompanied by configuration text and instructions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that can be used with <span><strong class="command">nsupdate</strong></span> and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">named</strong></span> when setting up dynamic DNS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync including an example <span><strong class="command">update-policy</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync statement. (This usage similar to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">rndc-confgen</strong></span> command for setting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync up command channel security.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that <span><strong class="command">named</strong></span> itself can configure a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it does this when a zone is configured with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">update-policy local;</strong></span>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span><strong class="command">ddns-confgen</strong></span> is only needed when a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync more elaborate configuration is required: for instance,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if <span><strong class="command">nsupdate</strong></span> is to be used from a remote
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specifies the algorithm to use for the TSIG key. Available
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hmac-sha384 and hmac-sha512. The default is hmac-sha256.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Options are case-insensitive, and the "hmac-" prefix
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may be omitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Prints a short summary of options and arguments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specifies the key name of the DDNS authentication key.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default is <code class="constant">ddns-key</code> when neither
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the <code class="option">-s</code> nor <code class="option">-z</code> option is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified; otherwise, the default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is <code class="constant">ddns-key</code> as a separate label
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync followed by the argument of the option, e.g.,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="constant">ddns-key.example.com.</code>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The key name must have the format of a valid domain name,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync consisting of letters, digits, hyphens and periods.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync only the key, with no explanatory text or usage examples;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specifies a source of random data for generating the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync authorization. If the operating system does not provide a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="filename">/dev/random</code> or equivalent device, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync default source of randomness is keyboard input.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="filename">randomdev</code> specifies the name of a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync character device or file containing random data to be used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instead of the default. The special value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <code class="filename">keyboard</code> indicates that keyboard input
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (<span><strong class="command">ddns-confgen</strong></span> only.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Generate configuration example to allow dynamic updates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a single hostname. The example <span><strong class="command">named.conf</strong></span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync text shows how to set an update policy for the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using the "name" nametype. The default key name is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ddns-key.<em class="replaceable"><code>name</code></em>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note that the "self" nametype cannot be used, since
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the name to be updated may differ from the key name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This option cannot be used with the <code class="option">-z</code> option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (<span><strong class="command">ddns-confgen</strong></span> only.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Generate configuration example to allow dynamic updates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a zone: The example <span><strong class="command">named.conf</strong></span> text
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync shows how to set an update policy for the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using the "zonesub" nametype, allowing updates to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all subdomain names within that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This option cannot be used with the <code class="option">-s</code> option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p><span class="corpauthor">Internet Systems Consortium</span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync<p style="text-align: center;">BIND 9.11.0pre-alpha</p>