PageRenderTime 55ms CodeModel.GetById 23ms app.highlight 21ms RepoModel.GetById 2ms app.codeStats 0ms

/contrib/bind9/doc/arm/man.ddns-confgen.html

https://bitbucket.org/freebsd/freebsd-head/
HTML | 180 lines | 163 code | 0 blank | 17 comment | 0 complexity | 03f1e4fb30972bee596f2f555c382590 MD5 | raw file
  1<!--
  2 - Copyright (C) 2004-2012 Internet Systems Consortium, Inc. ("ISC")
  3 - Copyright (C) 2000-2003 Internet Software Consortium.
  4 - 
  5 - Permission to use, copy, modify, and/or distribute this software for any
  6 - purpose with or without fee is hereby granted, provided that the above
  7 - copyright notice and this permission notice appear in all copies.
  8 - 
  9 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 10 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 11 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 12 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 13 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 14 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 15 - PERFORMANCE OF THIS SOFTWARE.
 16-->
 17<!-- $Id$ -->
 18<html>
 19<head>
 20<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 21<title>ddns-confgen</title>
 22<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
 23<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
 24<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
 25<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
 26<link rel="next" href="man.arpaname.html" title="arpaname">
 27</head>
 28<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 29<div class="navheader">
 30<table width="100%" summary="Navigation header">
 31<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
 32<tr>
 33<td width="20%" align="left">
 34<a accesskey="p" href="man.rndc-confgen.html">Prev</a> </td>
 35<th width="60%" align="center">Manual pages</th>
 36<td width="20%" align="right"> <a accesskey="n" href="man.arpaname.html">Next</a>
 37</td>
 38</tr>
 39</table>
 40<hr>
 41</div>
 42<div class="refentry" lang="en">
 43<a name="man.ddns-confgen"></a><div class="titlepage"></div>
 44<div class="refnamediv">
 45<h2>Name</h2>
 46<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
 47</div>
 48<div class="refsynopsisdiv">
 49<h2>Synopsis</h2>
 50<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>
 51</div>
 52<div class="refsect1" lang="en">
 53<a name="id2651677"></a><h2>DESCRIPTION</h2>
 54<p><span><strong class="command">ddns-confgen</strong></span>
 55      generates a key for use by <span><strong class="command">nsupdate</strong></span>
 56      and <span><strong class="command">named</strong></span>.  It simplifies configuration
 57      of dynamic zones by generating a key and providing the
 58      <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
 59      syntax that will be needed to use it, including an example
 60      <span><strong class="command">update-policy</strong></span> statement.
 61    </p>
 62<p>
 63      If a domain name is specified on the command line, it will
 64      be used in the name of the generated key and in the sample
 65      <span><strong class="command">named.conf</strong></span> syntax.  For example,
 66      <span><strong class="command">ddns-confgen example.com</strong></span> would
 67      generate a key called "ddns-key.example.com", and sample
 68      <span><strong class="command">named.conf</strong></span> command that could be used
 69      in the zone definition for "example.com".
 70    </p>
 71<p>
 72      Note that <span><strong class="command">named</strong></span> itself can configure a
 73      local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
 74      <span><strong class="command">ddns-confgen</strong></span> is only needed when a 
 75      more elaborate configuration is required: for instance, if
 76      <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
 77    </p>
 78</div>
 79<div class="refsect1" lang="en">
 80<a name="id2651765"></a><h2>OPTIONS</h2>
 81<div class="variablelist"><dl>
 82<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
 83<dd><p>
 84            Specifies the algorithm to use for the TSIG key.  Available
 85            choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
 86            hmac-sha384 and hmac-sha512.  The default is hmac-sha256.
 87	  </p></dd>
 88<dt><span class="term">-h</span></dt>
 89<dd><p>
 90	    Prints a short summary of the options and arguments to
 91	    <span><strong class="command">ddns-confgen</strong></span>.
 92	  </p></dd>
 93<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
 94<dd><p>
 95	    Specifies the key name of the DDNS authentication key.
 96	    The default is <code class="constant">ddns-key</code> when neither
 97	    the <code class="option">-s</code> nor <code class="option">-z</code> option is
 98	    specified; otherwise, the default
 99	    is <code class="constant">ddns-key</code> as a separate label
100	    followed by the argument of the option, e.g.,
101	    <code class="constant">ddns-key.example.com.</code>
102	    The key name must have the format of a valid domain name,
103	    consisting of letters, digits, hyphens and periods.
104	  </p></dd>
105<dt><span class="term">-q</span></dt>
106<dd><p>
107	    Quiet mode:  Print only the key, with no explanatory text or
108            usage examples.
109	  </p></dd>
110<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
111<dd><p>
112            Specifies a source of random data for generating the
113            authorization.  If the operating system does not provide a
114            <code class="filename">/dev/random</code> or equivalent device, the
115            default source of randomness is keyboard input.
116            <code class="filename">randomdev</code> specifies the name of a
117            character device or file containing random data to be used
118            instead of the default.  The special value
119            <code class="filename">keyboard</code> indicates that keyboard input
120            should be used.
121	  </p></dd>
122<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
123<dd><p>
124	    Single host mode: The example <span><strong class="command">named.conf</strong></span> text
125	    shows how to set an update policy for the specified
126	    <em class="replaceable"><code>name</code></em>
127	    using the "name" nametype.
128	    The default key name is
129	    ddns-key.<em class="replaceable"><code>name</code></em>.
130	    Note that the "self" nametype cannot be used, since
131	    the name to be updated may differ from the key name.
132	    This option cannot be used with the <code class="option">-z</code> option.
133	  </p></dd>
134<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
135<dd><p>
136	    zone mode:  The example <span><strong class="command">named.conf</strong></span> text
137            shows how to set an update policy for the specified
138	    <em class="replaceable"><code>zone</code></em>
139	    using the "zonesub" nametype, allowing updates to all subdomain
140	    names within
141	    that <em class="replaceable"><code>zone</code></em>.
142	    This option cannot be used with the <code class="option">-s</code> option.
143	  </p></dd>
144</dl></div>
145</div>
146<div class="refsect1" lang="en">
147<a name="id2651965"></a><h2>SEE ALSO</h2>
148<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
149      <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
150      <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
151      <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
152    </p>
153</div>
154<div class="refsect1" lang="en">
155<a name="id2652004"></a><h2>AUTHOR</h2>
156<p><span class="corpauthor">Internet Systems Consortium</span>
157    </p>
158</div>
159</div>
160<div class="navfooter">
161<hr>
162<table width="100%" summary="Navigation footer">
163<tr>
164<td width="40%" align="left">
165<a accesskey="p" href="man.rndc-confgen.html">Prev</a> </td>
166<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
167<td width="40%" align="right"> <a accesskey="n" href="man.arpaname.html">Next</a>
168</td>
169</tr>
170<tr>
171<td width="40%" align="left" valign="top">
172<span class="application">rndc-confgen</span> </td>
173<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
174<td width="40%" align="right" valign="top"> <span class="application">arpaname</span>
175</td>
176</tr>
177</table>
178</div>
179</body>
180</html>