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