nsupdate.html revision 90c38ab4e6904126bec2f2f57f60cd834ce759cb
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<!--
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - Copyright (C) 2000-2003 Internet Software Consortium.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak -
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - Permission to use, copy, modify, and/or distribute this software for any
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - purpose with or without fee is hereby granted, provided that the above
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - copyright notice and this permission notice appear in all copies.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak -
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak - PERFORMANCE OF THIS SOFTWARE.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak-->
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<!-- $Id: nsupdate.html,v 1.49 2009/12/17 01:13:46 tbox Exp $ -->
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<html>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<head>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<title>nsupdate</title>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak</head>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<a name="man.nsupdate"></a><div class="titlepage"></div>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<div class="refnamediv">
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<h2>Name</h2>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p><span class="application">nsupdate</span> &#8212; Dynamic DNS update utility</p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak</div>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<div class="refsynopsisdiv">
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<h2>Synopsis</h2>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<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>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak</div>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<div class="refsect1" lang="en">
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<a name="id2543453"></a><h2>DESCRIPTION</h2>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p><span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak is used to submit Dynamic DNS Update requests as defined in RFC 2136
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak to a name server.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak This allows resource records to be added or removed from a zone
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak without manually editing the zone file.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak A single update request can contain requests to add or remove more than
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak one
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak resource record.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak Zones that are under dynamic control via
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak or a DHCP server should not be edited by hand.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak Manual edits could
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak conflict with dynamic updates and cause data to be lost.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The resource records that are dynamically added or removed with
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak have to be in the same zone.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak Requests are sent to the zone's master server.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak This is identified by the MNAME field of the zone's SOA record.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <code class="option">-d</code>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak option makes
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak operate in debug mode.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak This provides tracing information about the update requests that are
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak made and the replies received from the name server.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The <code class="option">-D</code> option makes <span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak report additional debugging information to <code class="option">-d</code>.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The <code class="option">-L</code> option with an integer argument of zero or
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak higher sets the logging debug level. If zero, logging is disabled.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak Transaction signatures can be used to authenticate the Dynamic
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak DNS updates. These use the TSIG resource record type described
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak in RFC 2845 or the SIG(0) record described in RFC 2535 and
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak RFC 2931 or GSS-TSIG as described in RFC 3645. TSIG relies on
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak a shared secret that should only be known to
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span> and the name server. Currently,
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak the only supported encryption algorithm for TSIG is HMAC-MD5,
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak which is defined in RFC 2104. Once other algorithms are
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak defined for TSIG, applications will need to ensure they select
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak the appropriate algorithm as well as the key when authenticating
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak each other. For instance, suitable <span class="type">key</span> and
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span class="type">server</span> statements would be added to
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <code class="filename">/etc/named.conf</code> so that the name server
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak can associate the appropriate secret key and algorithm with
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak the IP address of the client application that will be using
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak TSIG authentication. SIG(0) uses public key cryptography.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak To use a SIG(0) key, the public key must be stored in a KEY
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak record in a zone served by the name server.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span> does not read
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <code class="filename">/etc/named.conf</code>.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak is switched on with the <code class="option">-g</code> flag. A
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak non-standards-compliant variant of GSS-TSIG used by Windows
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak 2000 can be switched on with the <code class="option">-o</code> flag.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p><span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak uses the <code class="option">-y</code> or <code class="option">-k</code> option
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak to provide the shared secret needed to generate a TSIG record
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak for authenticating Dynamic DNS update requests, default type
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak HMAC-MD5. These options are mutually exclusive.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak When the <code class="option">-y</code> option is used, a signature is
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak generated from
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak [<span class="optional"><em class="parameter"><code>hmac:</code></em></span>]<em class="parameter"><code>keyname:secret.</code></em>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <em class="parameter"><code>keyname</code></em> is the name of the key, and
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak Use of the <code class="option">-y</code> option is discouraged because the
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak shared secret is supplied as a command line argument in clear text.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak This may be visible in the output from
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak or in a history file maintained by the user's shell.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak With the
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <code class="option">-k</code> option, <span><strong class="command">nsupdate</strong></span> reads
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak the shared secret from the file <em class="parameter"><code>keyfile</code></em>.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak Keyfiles may be in two formats: a single file containing
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak statement, which may be generated automatically by
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak of the format <code class="filename">K{name}.+157.+{random}.key</code> and
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <code class="filename">K{name}.+157.+{random}.private</code>, which can be
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak generated by <span><strong class="command">dnssec-keygen</strong></span>.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The <code class="option">-k</code> may also be used to specify a SIG(0) key used
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak to authenticate Dynamic DNS update requests. In this case, the key
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak specified is not an HMAC-MD5 key.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span> can be run in a local-host only mode
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak using the <code class="option">-l</code> flag. This sets the server address to
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak localhost (disabling the <span><strong class="command">server</strong></span> so that the server
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak address cannot be overridden). Connections to the local server will
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak use a TSIG key found in <code class="filename">/var/run/named/session.key</code>,
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak which is automatically generated by <span><strong class="command">named</strong></span> if any
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak local master zone has set <span><strong class="command">update-policy</strong></span> to
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">local</strong></span>. The location of this key file can be
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak overridden with the <code class="option">-k</code> option.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak By default, <span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak uses UDP to send update requests to the name server unless they are too
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak large to fit in a UDP request in which case TCP will be used.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <code class="option">-v</code>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak option makes
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak <span><strong class="command">nsupdate</strong></span>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak use a TCP connection.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak This may be preferable when a batch of update requests is made.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The <code class="option">-p</code> sets the default port number to use for
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak connections to a name server. The default is 53.
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak </p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak<p>
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak The <code class="option">-t</code> option sets the maximum time an update request
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak can
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak take before it is aborted. The default is 300 seconds. Zero can be
f21bea4c0f58e17aa1d9a0fac2c219852f89944amaczniak used
to disable the timeout.
</p>
<p>
The <code class="option">-u</code> option sets the UDP retry interval. The default
is
3 seconds. If zero, the interval will be computed from the timeout
interval
and number of UDP retries.
</p>
<p>
The <code class="option">-r</code> option sets the number of UDP retries. The
default is
3. If zero, only one update request will be made.
</p>
<p>
The <code class="option">-R <em class="replaceable"><code>randomdev</code></em></code> option
specifies a source of randomness. If the operating system
does not provide a <code class="filename">/dev/random</code> or
equivalent device, the default source of randomness is keyboard
input. <code class="filename">randomdev</code> specifies the name of
a character device or file containing random data to be used
instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard input
should be used. This option may be specified multiple times.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2543785"></a><h2>INPUT FORMAT</h2>
<p><span><strong class="command">nsupdate</strong></span>
reads input from
<em class="parameter"><code>filename</code></em>
or standard input.
Each command is supplied on exactly one line of input.
Some commands are for administrative purposes.
The others are either update instructions or prerequisite checks on the
contents of the zone.
These checks set conditions that some name or set of
resource records (RRset) either exists or is absent from the zone.
These conditions must be met if the entire update request is to succeed.
Updates will be rejected if the tests for the prerequisite conditions
fail.
</p>
<p>
Every update request consists of zero or more prerequisites
and zero or more updates.
This allows a suitably authenticated update request to proceed if some
specified resource records are present or missing from the zone.
A blank input line (or the <span><strong class="command">send</strong></span> command)
causes the
accumulated commands to be sent as one Dynamic DNS update request to the
name server.
</p>
<p>
The command formats and their meaning are as follows:
</p>
<div class="variablelist"><dl>
<dt><span class="term">
<span><strong class="command">server</strong></span>
{servername}
[port]
</span></dt>
<dd><p>
Sends all dynamic update requests to the name server
<em class="parameter"><code>servername</code></em>.
When no server statement is provided,
<span><strong class="command">nsupdate</strong></span>
will send updates to the master server of the correct zone.
The MNAME field of that zone's SOA record will identify the
master
server for that zone.
<em class="parameter"><code>port</code></em>
is the port number on
<em class="parameter"><code>servername</code></em>
where the dynamic update requests get sent.
If no port number is specified, the default DNS port number of
53 is
used.
</p></dd>
<dt><span class="term">
<span><strong class="command">local</strong></span>
{address}
[port]
</span></dt>
<dd><p>
Sends all dynamic update requests using the local
<em class="parameter"><code>address</code></em>.
When no local statement is provided,
<span><strong class="command">nsupdate</strong></span>
will send updates using an address and port chosen by the
system.
<em class="parameter"><code>port</code></em>
can additionally be used to make requests come from a specific
port.
If no port number is specified, the system will assign one.
</p></dd>
<dt><span class="term">
<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="id2544626"></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="id2544669"></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/session.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="id2544753"></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="id2542148"></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></body>
</html>