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