man.ddns-confgen.html revision 27963ad22062efe8eac2beed51ff70d8f0b35900
fdd80e9a55c70b36a3bf3e409b86897301c44ff8Automatic Updater - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - 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 - 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<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
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<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="man.ddns-confgen"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<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>
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">-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>
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span>
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater are invokation methods for a utility that generates keys for use
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater in TSIG signing. The resulting keys can be used, for example,
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater to secure dynamic DNS updates to a zone or for the
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater <span><strong class="command">rndc</strong></span> command channel.
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater can be specified on the command line which will be used as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the name of the generated key. If no name is specified,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the default is <code class="constant">tsig-key</code>.
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater When run as <span><strong class="command">ddns-confgen</strong></span>, the generated
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key is accompanied by configuration text and instructions
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater that can be used with <span><strong class="command">nsupdate</strong></span> and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span><strong class="command">named</strong></span> when setting up dynamic DNS,
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater including an example <span><strong class="command">update-policy</strong></span>
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater statement. (This usage similar to the
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater <span><strong class="command">rndc-confgen</strong></span> command for setting
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater up command channel security.)
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater Note that <span><strong class="command">named</strong></span> itself can configure a
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>:
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater it does this when a zone is configured with
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater <span><strong class="command">update-policy local;</strong></span>.
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater <span><strong class="command">ddns-confgen</strong></span> is only needed when a
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater more elaborate configuration is required: for instance,
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater if <span><strong class="command">nsupdate</strong></span> is to be used from a remote
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater Specifies the algorithm to use for the TSIG key. Available
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater hmac-sha384 and hmac-sha512. The default is hmac-sha256.
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater Options are case-insensitive, and the "hmac-" prefix
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater may be omitted.
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater Prints a short summary of options and arguments.
ebabe300b615154d08f5577822cfd8726d2643c8Automatic Updater<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the key name of the DDNS authentication key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The default is <code class="constant">ddns-key</code> when neither
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the <code class="option">-s</code> nor <code class="option">-z</code> option is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specified; otherwise, the default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is <code class="constant">ddns-key</code> as a separate label
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein followed by the argument of the option, e.g.,
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <code class="constant">ddns-key.example.com.</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The key name must have the format of a valid domain name,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews consisting of letters, digits, hyphens and periods.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews only the key, with no explanatory text or usage examples;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies a source of random data for generating the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein authorization. If the operating system does not provide a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="filename">/dev/random</code> or equivalent device, the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews default source of randomness is keyboard input.
58d9e9169e7ab4355a0b0bfc13bc616bc5247dfeAutomatic Updater <code class="filename">randomdev</code> specifies the name of a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews character device or file containing random data to be used
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews instead of the default. The special value
58d9e9169e7ab4355a0b0bfc13bc616bc5247dfeAutomatic Updater <code class="filename">keyboard</code> indicates that keyboard input
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews should be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (<span><strong class="command">ddns-confgen</strong></span> only.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Generate configuration example to allow dynamic updates
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of a single hostname. The example <span><strong class="command">named.conf</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein text shows how to set an update policy for the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein using the "name" nametype. 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.
acb72d5e2c83b597332e3eb0c7d59e1142f1adfdMark Andrews This option cannot be used with the <code class="option">-z</code> option.
3cddb2c552ee6582e8db0849c28747f6b6ca57feAutomatic Updater<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
852ccdd42a71550c974111b49415204ffeca6573Automatic Updater (<span><strong class="command">ddns-confgen</strong></span> only.)
3cddb2c552ee6582e8db0849c28747f6b6ca57feAutomatic Updater Generate configuration example to allow dynamic updates
3cddb2c552ee6582e8db0849c28747f6b6ca57feAutomatic Updater of a zone: The example <span><strong class="command">named.conf</strong></span> text
3cddb2c552ee6582e8db0849c28747f6b6ca57feAutomatic Updater shows how to set an update policy for the specified
ca67ebfe9eef0b8f04179f7e511a19e0337a5422Automatic Updater <em class="replaceable"><code>zone</code></em>
3cddb2c552ee6582e8db0849c28747f6b6ca57feAutomatic Updater using the "zonesub" nametype, allowing updates to
852ccdd42a71550c974111b49415204ffeca6573Automatic Updater all subdomain names within that
852ccdd42a71550c974111b49415204ffeca6573Automatic Updater <em class="replaceable"><code>zone</code></em>.
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater This option cannot be used with the <code class="option">-s</code> option.
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
66f25f2ceeb589e67efe7af2413baaa3426b0042Automatic Updater <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>.
38417cbfb1a328c20b5b723b8584a02c57f88897Automatic Updater<p><span class="corpauthor">Internet Systems Consortium</span>
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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
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>