man.nsupdate.html revision b4556ecdbc3cad55e1c85ce32b73b7bcd39e43dc
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<!--
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - Copyright (C) 2000-2003 Internet Software Consortium.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington -
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - Permission to use, copy, modify, and/or distribute this software for any
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - purpose with or without fee is hereby granted, provided that the above
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - copyright notice and this permission notice appear in all copies.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington -
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington - PERFORMANCE OF THIS SOFTWARE.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington-->
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<!-- $Id$ -->
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<html>
2dd75eff92ef66e22cca286b6f4fe5a9c929af9dPhill Cunnington<head>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<title>nsupdate</title>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<link rel="prev" href="man.named-rrchecker.html" title="named-rrchecker">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<link rel="next" href="man.rndc.html" title="rndc">
5073b0cc5b527bee3ef575a3414074d4b8093cc0Phill Cunnington</head>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="navheader">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<table width="100%" summary="Navigation header">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<tr>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<td width="20%" align="left">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<a accesskey="p" href="man.named-rrchecker.html">Prev</a>�</td>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<th width="60%" align="center">Manual pages</th>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<td width="20%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</td>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</tr>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</table>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<hr>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</div>
2dd75eff92ef66e22cca286b6f4fe5a9c929af9dPhill Cunnington<div class="refentry" lang="en">
5db031755ab3a8762e266f96f5d74832548d330bPhill Cunnington<a name="man.nsupdate"></a><div class="titlepage"></div>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="refnamediv">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<h2>Name</h2>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<p><span class="application">nsupdate</span> &#8212; Dynamic DNS update utility</p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</div>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="refsynopsisdiv">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<h2>Synopsis</h2>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</code>] [<code class="option">-L <em class="replaceable"><code>level</code></em></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>] [<code class="option">-T</code>] [<code class="option">-P</code>] [<code class="option">-V</code>] [filename]</p></div>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</div>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="refsect1" lang="en">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<a name="id2655537"></a><h2>DESCRIPTION</h2>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<p><span><strong class="command">nsupdate</strong></span>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington is used to submit Dynamic DNS Update requests as defined in RFC 2136
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington to a name server.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington This allows resource records to be added or removed from a zone
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington without manually editing the zone file.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington A single update request can contain requests to add or remove more than
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington one
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington resource record.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Zones that are under dynamic control via
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <span><strong class="command">nsupdate</strong></span>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington or a DHCP server should not be edited by hand.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Manual edits could
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington conflict with dynamic updates and cause data to be lost.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington The resource records that are dynamically added or removed with
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington <span><strong class="command">nsupdate</strong></span>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington have to be in the same zone.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington Requests are sent to the zone's master server.
0b159dcb466aaea46a0d9b20aae6d19fc308ac6cPhill Cunnington This is identified by the MNAME field of the zone's SOA record.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington </p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington<p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington Transaction signatures can be used to authenticate the Dynamic
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington DNS updates. These use the TSIG resource record type described
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington in RFC 2845 or the SIG(0) record described in RFC 2535 and
0b159dcb466aaea46a0d9b20aae6d19fc308ac6cPhill Cunnington RFC 2931 or GSS-TSIG as described in RFC 3645.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington </p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington<p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington TSIG relies on
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington a shared secret that should only be known to
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington <span><strong class="command">nsupdate</strong></span> and the name server.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington For instance, suitable <span class="type">key</span> and
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <span class="type">server</span> statements would be added to
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <code class="filename">/etc/named.conf</code> so that the name server
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington can associate the appropriate secret key and algorithm with
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington the IP address of the client application that will be using
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington TSIG authentication. You can use <span><strong class="command">ddns-confgen</strong></span>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington to generate suitable configuration fragments.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington <span><strong class="command">nsupdate</strong></span>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington uses the <code class="option">-y</code> or <code class="option">-k</code> options
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington to provide the TSIG shared secret. These options are mutually exclusive.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington </p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington<p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington SIG(0) uses public key cryptography.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington To use a SIG(0) key, the public key must be stored in a KEY
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington record in a zone served by the name server.
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington </p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington<p>
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington is switched on with the <code class="option">-g</code> flag. A
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington non-standards-compliant variant of GSS-TSIG used by Windows
4aa2bc2779a92691d5c66593fdbdaa96ed663e6fPhill Cunnington 2000 can be switched on with the <code class="option">-o</code> flag.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington</div>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="refsect1" lang="en">
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<a name="id2655625"></a><h2>OPTIONS</h2>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<div class="variablelist"><dl>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-d</span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Debug mode. This provides tracing information about the
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington update requests that are made and the replies received
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington from the name server.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-D</span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Extra debug mode.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-k <em class="replaceable"><code>keyfile</code></em></span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington The file containing the TSIG authentication key.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Keyfiles may be in two formats: a single file containing
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington statement, which may be generated automatically by
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington of the format <code class="filename">K{name}.+157.+{random}.key</code> and
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <code class="filename">K{name}.+157.+{random}.private</code>, which can be
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington generated by <span><strong class="command">dnssec-keygen</strong></span>.
5db031755ab3a8762e266f96f5d74832548d330bPhill Cunnington The <code class="option">-k</code> may also be used to specify a SIG(0) key used
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington to authenticate Dynamic DNS update requests. In this case, the key
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington specified is not an HMAC-MD5 key.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-l</span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
5073b0cc5b527bee3ef575a3414074d4b8093cc0Phill Cunnington Local-host only mode. This sets the server address to
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington localhost (disabling the <span><strong class="command">server</strong></span> so that the server
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington address cannot be overridden). Connections to the local server will
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington use a TSIG key found in <code class="filename">/var/run/named/session.key</code>,
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington which is automatically generated by <span><strong class="command">named</strong></span> if any
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington local master zone has set <span><strong class="command">update-policy</strong></span> to
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <span><strong class="command">local</strong></span>. The location of this key file can be
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington overridden with the <code class="option">-k</code> option.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-L <em class="replaceable"><code>level</code></em></span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Set the logging debug level. If zero, logging is disabled.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Set the port to use for connections to a name server. The
310700e5800f2c38b03d42e7dcaa4a7b0a16af26James Phillpotts default is 53.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-P</span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington Print the list of private BIND-specific resource record
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington types whose format is understood
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington by <span><strong class="command">nsupdate</strong></span>. See also
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington the <code class="option">-T</code> option.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-r <em class="replaceable"><code>udpretries</code></em></span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington The number of UDP retries. The default is 3. If zero, only
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington one update request will be made.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington </p></dd>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dt><span class="term">-R <em class="replaceable"><code>randomdev</code></em></span></dt>
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington<dd><p>
Where to obtain 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></dd>
<dt><span class="term">-t <em class="replaceable"><code>timeout</code></em></span></dt>
<dd><p>
The maximum time an update request can take before it is
aborted. The default is 300 seconds. Zero can be used to
disable the timeout.
</p></dd>
<dt><span class="term">-T</span></dt>
<dd>
<p>
Print the list of IANA standard resource record types
whose format is understood by <span><strong class="command">nsupdate</strong></span>.
<span><strong class="command">nsupdate</strong></span> will exit after the lists are
printed. The <code class="option">-T</code> option can be combined
with the <code class="option">-P</code> option.
</p>
<p>
Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
decimal value of the type with no leading zeros. The rdata,
if present, will be parsed using the UNKNOWN rdata format,
(&lt;backslash&gt; &lt;hash&gt; &lt;space&gt; &lt;length&gt;
&lt;space&gt; &lt;hexstring&gt;).
</p>
</dd>
<dt><span class="term">-u <em class="replaceable"><code>udptimeout</code></em></span></dt>
<dd><p>
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></dd>
<dt><span class="term">-v</span></dt>
<dd><p>
Use TCP even for small update requests.
By default, <span><strong class="command">nsupdate</strong></span>
uses UDP to send update requests to the name server unless they are too
large to fit in a UDP request in which case TCP will be used.
TCP may be preferable when a batch of update requests is made.
</p></dd>
<dt><span class="term">-V</span></dt>
<dd><p>
Print the version number and exit.
</p></dd>
<dt><span class="term">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></span></dt>
<dd>
<p>
Literal TSIG authentication key.
<em class="parameter"><code>keyname</code></em> is the name of the key, and
<em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
<em class="parameter"><code>hmac</code></em> is the name of the key algorithm;
valid choices are <code class="literal">hmac-md5</code>,
<code class="literal">hmac-sha1</code>, <code class="literal">hmac-sha224</code>,
<code class="literal">hmac-sha256</code>, <code class="literal">hmac-sha384</code>, or
<code class="literal">hmac-sha512</code>. If <em class="parameter"><code>hmac</code></em>
is not specified, the default is <code class="literal">hmac-md5</code>.
</p>
<p>
NOTE: Use of the <code class="option">-y</code> option is discouraged because the
shared secret is supplied as a command line argument in clear text.
This may be visible in the output from
<span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
or in a history file maintained by the user's shell.
</p>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2684808"></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>
[hmac:] {keyname}
{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>secret</code></em> pair.
If <em class="parameter"><code>hmac</code></em> is specified, then it sets the
signing algorithm in use; the default is
<code class="literal">hmac-md5</code>. 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">gsstsig</strong></span>
</span></dt>
<dd><p>
Use GSS-TSIG to sign the updated. This is equivalent to
specifying <code class="option">-g</code> on the commandline.
</p></dd>
<dt><span class="term">
<span><strong class="command">oldgsstsig</strong></span>
</span></dt>
<dd><p>
Use the Windows 2000 version of GSS-TSIG to sign the updated.
This is equivalent to specifying <code class="option">-o</code> on the
commandline.
</p></dd>
<dt><span class="term">
<span><strong class="command">realm</strong></span>
{[<span class="optional">realm_name</span>]}
</span></dt>
<dd><p>
When using GSS-TSIG use <em class="parameter"><code>realm_name</code></em> rather
than the default realm in <code class="filename">krb5.conf</code>. If no
realm is specified the saved realm is cleared.
</p></dd>
<dt><span class="term">
<span><strong class="command">check-names</strong></span>
{[<span class="optional">yes_or_no</span>]}
</span></dt>
<dd><p>
Turn on or off check-names processing on records to
be added. Check-names has no effect on prerequisites
or records to be deleted. By default check-names
processing is on. If check-names processing fails
the record will not be added to the UPDATE message.
</p></dd>
<dt><span class="term">
<span><strong class="command">[<span class="optional">prereq</span>] 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">[<span class="optional">prereq</span>] 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">[<span class="optional">prereq</span>] 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">[<span class="optional">prereq</span>] 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">[<span class="optional">prereq</span>] 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">[<span class="optional">update</span>] del[<span class="optional">ete</span>]</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">[<span class="optional">update</span>] 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>
<dt><span class="term">
<span><strong class="command">version</strong></span>
</span></dt>
<dd><p>
Print version number.
</p></dd>
<dt><span class="term">
<span><strong class="command">help</strong></span>
</span></dt>
<dd><p>
Print a list of commands.
</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="id2686018"></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="id2686068"></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="id2686154"></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="id2686212"></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-rrchecker.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.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-rrchecker</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>
<p style="text-align: center;">BIND 9.11.0pre-alpha</p>
</body>
</html>