man.nsupdate.html revision 8e821eea5f57ac47a94305aa7ab0c3570d92a311
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<!--
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - Copyright (C) 2000-2003 Internet Software Consortium.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis -
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - Permission to use, copy, modify, and/or distribute this software for any
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - purpose with or without fee is hereby granted, provided that the above
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - copyright notice and this permission notice appear in all copies.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis -
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis - PERFORMANCE OF THIS SOFTWARE.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis-->
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<!-- $Id: man.nsupdate.html,v 1.70 2009/10/23 01:14:48 tbox Exp $ -->
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<html>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<head>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<title>nsupdate</title>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<link rel="prev" href="man.named.html" title="named">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<link rel="next" href="man.rndc.html" title="rndc">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</head>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="navheader">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<table width="100%" summary="Navigation header">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<tr>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<td width="20%" align="left">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<a accesskey="p" href="man.named.html">Prev</a>�</td>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<th width="60%" align="center">Manual pages</th>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<td width="20%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</td>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</tr>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</table>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<hr>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</div>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="refentry" lang="en">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<a name="man.nsupdate"></a><div class="titlepage"></div>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="refnamediv">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<h2>Name</h2>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p><span class="application">nsupdate</span> &#8212; Dynamic DNS update utility</p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</div>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="refsynopsisdiv">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<h2>Synopsis</h2>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</code>] [[<code class="option">-g</code>] | [<code class="option">-o</code>] | [<code class="option">-l</code>] | [<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>] | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]] [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>] [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>] [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>] [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-v</code>] [filename]</p></div>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</div>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="refsect1" lang="en">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<a name="id2615574"></a><h2>DESCRIPTION</h2>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p><span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis is used to submit Dynamic DNS Update requests as defined in RFC 2136
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis to a name server.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis This allows resource records to be added or removed from a zone
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis without manually editing the zone file.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis A single update request can contain requests to add or remove more than
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis one
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis resource record.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Zones that are under dynamic control via
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis or a DHCP server should not be edited by hand.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Manual edits could
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis conflict with dynamic updates and cause data to be lost.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The resource records that are dynamically added or removed with
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis have to be in the same zone.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Requests are sent to the zone's master server.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis This is identified by the MNAME field of the zone's SOA record.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="option">-d</code>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis option makes
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis operate in debug mode.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis This provides tracing information about the update requests that are
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis made and the replies received from the name server.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-D</code> option makes <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis report additional debugging information to <code class="option">-d</code>.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-L</code> option with an integer argument of zero or
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis higher sets the logging debug level. If zero, logging is disabled.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Transaction signatures can be used to authenticate the Dynamic
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis DNS updates. These use the TSIG resource record type described
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis in RFC 2845 or the SIG(0) record described in RFC 2535 and
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis RFC 2931 or GSS-TSIG as described in RFC 3645. TSIG relies on
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis a shared secret that should only be known to
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span> and the name server. Currently,
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis the only supported encryption algorithm for TSIG is HMAC-MD5,
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis which is defined in RFC 2104. Once other algorithms are
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis defined for TSIG, applications will need to ensure they select
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis the appropriate algorithm as well as the key when authenticating
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis each other. For instance, suitable <span class="type">key</span> and
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span class="type">server</span> statements would be added to
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="filename">/etc/named.conf</code> so that the name server
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis can associate the appropriate secret key and algorithm with
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis the IP address of the client application that will be using
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis TSIG authentication. SIG(0) uses public key cryptography.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis To use a SIG(0) key, the public key must be stored in a KEY
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis record in a zone served by the name server.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span> does not read
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="filename">/etc/named.conf</code>.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis is switched on with the <code class="option">-g</code> flag. A
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis non-standards-compliant variant of GSS-TSIG used by Windows
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis 2000 can be switched on with the <code class="option">-o</code> flag.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p><span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis uses the <code class="option">-y</code> or <code class="option">-k</code> option
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis to provide the shared secret needed to generate a TSIG record
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis for authenticating Dynamic DNS update requests, default type
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis HMAC-MD5. These options are mutually exclusive.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis When the <code class="option">-y</code> option is used, a signature is
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis generated from
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis [<span class="optional"><em class="parameter"><code>hmac:</code></em></span>]<em class="parameter"><code>keyname:secret.</code></em>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>keyname</code></em> is the name of the key, and
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Use of the <code class="option">-y</code> option is discouraged because the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis shared secret is supplied as a command line argument in clear text.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis This may be visible in the output from
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis or in a history file maintained by the user's shell.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis With the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="option">-k</code> option, <span><strong class="command">nsupdate</strong></span> reads
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis the shared secret from the file <em class="parameter"><code>keyfile</code></em>.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Keyfiles may be in two formats: a single file containing
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis statement, which may be generated automatically by
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis of the format <code class="filename">K{name}.+157.+{random}.key</code> and
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="filename">K{name}.+157.+{random}.private</code>, which can be
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis generated by <span><strong class="command">dnssec-keygen</strong></span>.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-k</code> may also be used to specify a SIG(0) key used
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis to authenticate Dynamic DNS update requests. In this case, the key
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis specified is not an HMAC-MD5 key.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span> can be run in a local-host only mode
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis using the <code class="option">-l</code> flag. This sets the server address to
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis localhost (disabling the <span><strong class="command">server</strong></span> so that the server
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis address cannot be overridden). Connections to the local server will
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis use a TSIG key found in <code class="filename">/var/run/named/ddns.key</code>,
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis which is automatically generated by <span><strong class="command">named</strong></span> if any
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis local master zone has set <span><strong class="command">update-policy</strong></span> to
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">local</strong></span>. The location of this key file can be
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis overridden with the <code class="option">-k</code> option.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis By default, <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis uses UDP to send update requests to the name server unless they are too
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis large to fit in a UDP request in which case TCP will be used.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="option">-v</code>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis option makes
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis use a TCP connection.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis This may be preferable when a batch of update requests is made.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-p</code> sets the default port number to use for
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis connections to a name server. The default is 53.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-t</code> option sets the maximum time an update request
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis can
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis take before it is aborted. The default is 300 seconds. Zero can be
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis used
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis to disable the timeout.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-u</code> option sets the UDP retry interval. The default
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis is
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis 3 seconds. If zero, the interval will be computed from the timeout
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis interval
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis and number of UDP retries.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-r</code> option sets the number of UDP retries. The
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis default is
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis 3. If zero, only one update request will be made.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The <code class="option">-R <em class="replaceable"><code>randomdev</code></em></code> option
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis specifies a source of randomness. If the operating system
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis does not provide a <code class="filename">/dev/random</code> or
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis equivalent device, the default source of randomness is keyboard
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis input. <code class="filename">randomdev</code> specifies the name of
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis a character device or file containing random data to be used
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis instead of the default. The special value
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <code class="filename">keyboard</code> indicates that keyboard input
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis should be used. This option may be specified multiple times.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis</div>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="refsect1" lang="en">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<a name="id2624100"></a><h2>INPUT FORMAT</h2>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p><span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis reads input from
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>filename</code></em>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis or standard input.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Each command is supplied on exactly one line of input.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Some commands are for administrative purposes.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The others are either update instructions or prerequisite checks on the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis contents of the zone.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis These checks set conditions that some name or set of
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis resource records (RRset) either exists or is absent from the zone.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis These conditions must be met if the entire update request is to succeed.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Updates will be rejected if the tests for the prerequisite conditions
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis fail.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Every update request consists of zero or more prerequisites
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis and zero or more updates.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis This allows a suitably authenticated update request to proceed if some
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis specified resource records are present or missing from the zone.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis A blank input line (or the <span><strong class="command">send</strong></span> command)
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis causes the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis accumulated commands to be sent as one Dynamic DNS update request to the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis name server.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The command formats and their meaning are as follows:
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<div class="variablelist"><dl>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<dt><span class="term">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">server</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis {servername}
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis [port]
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </span></dt>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<dd><p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Sends all dynamic update requests to the name server
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>servername</code></em>.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis When no server statement is provided,
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis will send updates to the master server of the correct zone.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis The MNAME field of that zone's SOA record will identify the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis master
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis server for that zone.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>port</code></em>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis is the port number on
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>servername</code></em>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis where the dynamic update requests get sent.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis If no port number is specified, the default DNS port number of
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis 53 is
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis used.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p></dd>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<dt><span class="term">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">local</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis {address}
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis [port]
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </span></dt>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<dd><p>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis Sends all dynamic update requests using the local
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>address</code></em>.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis When no local statement is provided,
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">nsupdate</strong></span>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis will send updates using an address and port chosen by the
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis system.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <em class="parameter"><code>port</code></em>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis can additionally be used to make requests come from a specific
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis port.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis If no port number is specified, the system will assign one.
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis </p></dd>
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis<dt><span class="term">
25c28e83beb90e7c80452a7c818c5e6f73a07dc8Piotr Jasiukajtis <span><strong class="command">zone</strong></span>
{zonename}
</span></dt>
<dd><p>
Specifies that all updates are to be made to the zone
<em class="parameter"><code>zonename</code></em>.
If no
<em class="parameter"><code>zone</code></em>
statement is provided,
<span><strong class="command">nsupdate</strong></span>
will attempt determine the correct zone to update based on the
rest of the input.
</p></dd>
<dt><span class="term">
<span><strong class="command">class</strong></span>
{classname}
</span></dt>
<dd><p>
Specify the default class.
If no <em class="parameter"><code>class</code></em> is specified, the
default class is
<em class="parameter"><code>IN</code></em>.
</p></dd>
<dt><span class="term">
<span><strong class="command">ttl</strong></span>
{seconds}
</span></dt>
<dd><p>
Specify the default time to live for records to be added.
The value <em class="parameter"><code>none</code></em> will clear the default
ttl.
</p></dd>
<dt><span class="term">
<span><strong class="command">key</strong></span>
{name}
{secret}
</span></dt>
<dd><p>
Specifies that all updates are to be TSIG-signed using the
<em class="parameter"><code>keyname</code></em> <em class="parameter"><code>keysecret</code></em> pair.
The <span><strong class="command">key</strong></span> command
overrides any key specified on the command line via
<code class="option">-y</code> or <code class="option">-k</code>.
</p></dd>
<dt><span class="term">
<span><strong class="command">prereq nxdomain</strong></span>
{domain-name}
</span></dt>
<dd><p>
Requires that no resource record of any type exists with name
<em class="parameter"><code>domain-name</code></em>.
</p></dd>
<dt><span class="term">
<span><strong class="command">prereq yxdomain</strong></span>
{domain-name}
</span></dt>
<dd><p>
Requires that
<em class="parameter"><code>domain-name</code></em>
exists (has as at least one resource record, of any type).
</p></dd>
<dt><span class="term">
<span><strong class="command">prereq nxrrset</strong></span>
{domain-name}
[class]
{type}
</span></dt>
<dd><p>
Requires that no resource record exists of the specified
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>class</code></em>
and
<em class="parameter"><code>domain-name</code></em>.
If
<em class="parameter"><code>class</code></em>
is omitted, IN (internet) is assumed.
</p></dd>
<dt><span class="term">
<span><strong class="command">prereq yxrrset</strong></span>
{domain-name}
[class]
{type}
</span></dt>
<dd><p>
This requires that a resource record of the specified
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>class</code></em>
and
<em class="parameter"><code>domain-name</code></em>
must exist.
If
<em class="parameter"><code>class</code></em>
is omitted, IN (internet) is assumed.
</p></dd>
<dt><span class="term">
<span><strong class="command">prereq yxrrset</strong></span>
{domain-name}
[class]
{type}
{data...}
</span></dt>
<dd><p>
The
<em class="parameter"><code>data</code></em>
from each set of prerequisites of this form
sharing a common
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>class</code></em>,
and
<em class="parameter"><code>domain-name</code></em>
are combined to form a set of RRs. This set of RRs must
exactly match the set of RRs existing in the zone at the
given
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>class</code></em>,
and
<em class="parameter"><code>domain-name</code></em>.
The
<em class="parameter"><code>data</code></em>
are written in the standard text representation of the resource
record's
RDATA.
</p></dd>
<dt><span class="term">
<span><strong class="command">update delete</strong></span>
{domain-name}
[ttl]
[class]
[type [data...]]
</span></dt>
<dd><p>
Deletes any resource records named
<em class="parameter"><code>domain-name</code></em>.
If
<em class="parameter"><code>type</code></em>
and
<em class="parameter"><code>data</code></em>
is provided, only matching resource records will be removed.
The internet class is assumed if
<em class="parameter"><code>class</code></em>
is not supplied. The
<em class="parameter"><code>ttl</code></em>
is ignored, and is only allowed for compatibility.
</p></dd>
<dt><span class="term">
<span><strong class="command">update add</strong></span>
{domain-name}
{ttl}
[class]
{type}
{data...}
</span></dt>
<dd><p>
Adds a new resource record with the specified
<em class="parameter"><code>ttl</code></em>,
<em class="parameter"><code>class</code></em>
and
<em class="parameter"><code>data</code></em>.
</p></dd>
<dt><span class="term">
<span><strong class="command">show</strong></span>
</span></dt>
<dd><p>
Displays the current message, containing all of the
prerequisites and
updates specified since the last send.
</p></dd>
<dt><span class="term">
<span><strong class="command">send</strong></span>
</span></dt>
<dd><p>
Sends the current message. This is equivalent to entering a
blank line.
</p></dd>
<dt><span class="term">
<span><strong class="command">answer</strong></span>
</span></dt>
<dd><p>
Displays the answer.
</p></dd>
<dt><span class="term">
<span><strong class="command">debug</strong></span>
</span></dt>
<dd><p>
Turn on debugging.
</p></dd>
</dl></div>
<p>
</p>
<p>
Lines beginning with a semicolon are comments and are ignored.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2671212"></a><h2>EXAMPLES</h2>
<p>
The examples below show how
<span><strong class="command">nsupdate</strong></span>
could be used to insert and delete resource records from the
<span class="type">example.com</span>
zone.
Notice that the input in each example contains a trailing blank line so
that
a group of commands are sent as one dynamic update request to the
master name server for
<span class="type">example.com</span>.
</p>
<pre class="programlisting">
# nsupdate
&gt; update delete oldhost.example.com A
&gt; update add newhost.example.com 86400 A 172.16.1.1
&gt; send
</pre>
<p>
</p>
<p>
Any A records for
<span class="type">oldhost.example.com</span>
are deleted.
And an A record for
<span class="type">newhost.example.com</span>
with IP address 172.16.1.1 is added.
The newly-added record has a 1 day TTL (86400 seconds).
</p>
<pre class="programlisting">
# nsupdate
&gt; prereq nxdomain nickname.example.com
&gt; update add nickname.example.com 86400 CNAME somehost.example.com
&gt; send
</pre>
<p>
</p>
<p>
The prerequisite condition gets the name server to check that there
are no resource records of any type for
<span class="type">nickname.example.com</span>.
If there are, the update request fails.
If this name does not exist, a CNAME for it is added.
This ensures that when the CNAME is added, it cannot conflict with the
long-standing rule in RFC 1034 that a name must not exist as any other
record type if it exists as a CNAME.
(The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
RRSIG, DNSKEY and NSEC records.)
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2671262"></a><h2>FILES</h2>
<div class="variablelist"><dl>
<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
<dd><p>
used to identify default name server
</p></dd>
<dt><span class="term"><code class="constant">/var/run/named/ddns.key</code></span></dt>
<dd><p>
sets the default TSIG key for use in local-only mode
</p></dd>
<dt><span class="term"><code class="constant">K{name}.+157.+{random}.key</code></span></dt>
<dd><p>
base-64 encoding of HMAC-MD5 key created by
<span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
</p></dd>
<dt><span class="term"><code class="constant">K{name}.+157.+{random}.private</code></span></dt>
<dd><p>
base-64 encoding of HMAC-MD5 key created by
<span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2671346"></a><h2>SEE ALSO</h2>
<p>
<em class="citetitle">RFC 2136</em>,
<em class="citetitle">RFC 3007</em>,
<em class="citetitle">RFC 2104</em>,
<em class="citetitle">RFC 2845</em>,
<em class="citetitle">RFC 1034</em>,
<em class="citetitle">RFC 2535</em>,
<em class="citetitle">RFC 2931</em>,
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">ddns-confgen</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2671403"></a><h2>BUGS</h2>
<p>
The TSIG key is redundantly stored in two separate files.
This is a consequence of nsupdate using the DST library
for its cryptographic operations, and may change in future
releases.
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.named.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">named</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">rndc</span>
</td>
</tr>
</table>
</div>
</body>
</html>