nsupdate.html revision e3f6b4d2195b2fcd28f769452d460d1b35f1952a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!--
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Permission to use, copy, modify, and 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-->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<HTML
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><HEAD
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><TITLE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</TITLE
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><META
14a656f94b1fd0ababd84a772228dfa52276ba15Evan HuntNAME="GENERATOR"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCONTENT="Modular DocBook HTML Stylesheet Version 1.73
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein"></HEAD
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User><BODY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFENTRY"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinBGCOLOR="#FFFFFF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinTEXT="#000000"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinLINK="#0000FF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinVLINK="#840084"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinALINK="#0000FF"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><H1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN1"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></H1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFNAMEDIV"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN8"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User></A
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><H2
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>Name</H2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate&nbsp;--&nbsp;Dynamic DNS update utility</DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><DIV
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserCLASS="REFSYNOPSISDIV"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><A
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserNAME="AEN11"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User></A
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><H2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>Synopsis</H2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><P
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>nsupdate</B
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User> [<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>-d</TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>] [<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-y <TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REPLACEABLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>keyname:secret</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User></TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User> | <TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-k <TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserCLASS="REPLACEABLE"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><I
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews>keyfile</I
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews></TT
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews></TT
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews>] [<TT
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark AndrewsCLASS="OPTION"
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews>-t <TT
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark AndrewsCLASS="REPLACEABLE"
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews><I
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews>timeout</I
48abcd3eb789fdd24a2e0a6155b25e6979a39ae0Mark Andrews></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>] [<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-u <TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REPLACEABLE"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><I
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>udptimeout</I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>] [<TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="OPTION"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>-r <TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserCLASS="REPLACEABLE"
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><I
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>udpretries</I
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User></TT
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User></TT
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews>] [<TT
71c66a876ecca77923638d3f94cc0783152b2f03Mark AndrewsCLASS="OPTION"
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>-v</TT
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>] [filename]</P
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews></DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><DIV
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="REFSECT1"
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews><A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinNAME="AEN35"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein></A
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews><H2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>DESCRIPTION</H2
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User><P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><B
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserCLASS="COMMAND"
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews>nsupdate</B
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinis used to submit Dynamic DNS Update requests as defined in RFC2136
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinto a name server.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox UserThis allows resource records to be added or removed from a zone
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox Userwithout manually editing the zone file.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinA single update request can contain requests to add or remove more than one
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinresource record.</P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein><P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>Zones that are under dynamic control via
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinor a DHCP server should not be edited by hand.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinManual edits could
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinconflict with dynamic updates and cause data to be lost.</P
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews><P
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>The resource records that are dynamically added or removed with
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User<B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCLASS="COMMAND"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>nsupdate</B
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunthave to be in the same zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinRequests are sent to the zone's master server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinThis is identified by the MNAME field of the zone's SOA record.</P
><P
>The
<TT
CLASS="OPTION"
>-d</TT
>
option makes
<B
CLASS="COMMAND"
>nsupdate</B
>
operate in debug mode.
This provides tracing information about the update requests that are
made and the replies received from the name server.</P
><P
>Transaction signatures can be used to authenticate the Dynamic DNS
updates.
These use the TSIG resource record type described in RFC2845 or the
SIG(0) record described in RFC3535 and RFC2931.
TSIG relies on a shared secret that should only be known to
<B
CLASS="COMMAND"
>nsupdate</B
> and the name server.
Currently, the only supported encryption algorithm for TSIG is
HMAC-MD5, which is defined in RFC 2104.
Once other algorithms are defined for TSIG, applications will need to
ensure they select the appropriate algorithm as well as the key when
authenticating each other.
For instance suitable
<SPAN
CLASS="TYPE"
>key</SPAN
>
and
<SPAN
CLASS="TYPE"
>server</SPAN
>
statements would be added to
<TT
CLASS="FILENAME"
>/etc/named.conf</TT
>
so that the name server can associate the appropriate secret key
and algorithm with the IP address of the
client application that will be using TSIG authentication.
SIG(0) uses public key cryptography. To use a SIG(0) key, the public
key must be stored in a KEY record in a zone served by the name server.
<B
CLASS="COMMAND"
>nsupdate</B
>
does not read
<TT
CLASS="FILENAME"
>/etc/named.conf</TT
>.</P
><P
><B
CLASS="COMMAND"
>nsupdate</B
>
uses the
<TT
CLASS="OPTION"
>-y</TT
>
or
<TT
CLASS="OPTION"
>-k</TT
>
option (with an HMAC-MD5 key) to provide the shared secret needed to generate
a TSIG record for authenticating Dynamic DNS update requests.
These options are mutually exclusive.
With the
<TT
CLASS="OPTION"
>-k</TT
>
option,
<B
CLASS="COMMAND"
>nsupdate</B
>
reads the shared secret from the file
<TT
CLASS="PARAMETER"
><I
>keyfile</I
></TT
>,
whose name is of the form
<TT
CLASS="FILENAME"
>K{name}.+157.+{random}.private</TT
>.
For historical
reasons, the file
<TT
CLASS="FILENAME"
>K{name}.+157.+{random}.key</TT
>
must also be present. When the
<TT
CLASS="OPTION"
>-y</TT
>
option is used, a signature is generated from
<TT
CLASS="PARAMETER"
><I
>keyname:secret.</I
></TT
>
<TT
CLASS="PARAMETER"
><I
>keyname</I
></TT
>
is the name of the key,
and
<TT
CLASS="PARAMETER"
><I
>secret</I
></TT
>
is the base64 encoded shared secret.
Use of the
<TT
CLASS="OPTION"
>-y</TT
>
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
><P
>The <TT
CLASS="OPTION"
>-k</TT
> may also be used to specify a SIG(0) key used
to authenticate Dynamic DNS update requests. In this case, the key
specified is not an HMAC-MD5 key.</P
><P
>By default
<B
CLASS="COMMAND"
>nsupdate</B
>
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.
The
<TT
CLASS="OPTION"
>-v</TT
>
option makes
<B
CLASS="COMMAND"
>nsupdate</B
>
use a TCP connection.
This may be preferable when a batch of update requests is made.</P
><P
>The <TT
CLASS="OPTION"
>-t</TT
> option sets the maximum time a update request can
take before it is aborted. The default is 300 seconds. Zero can be used
to disable the timeout.</P
><P
>The <TT
CLASS="OPTION"
>-u</TT
> option sets the UDP retry interval. The default is
3 seconds. If zero the interval will be computed from the timeout interval
and number of UDP retries.</P
><P
>The <TT
CLASS="OPTION"
>-r</TT
> option sets the number of UDP retries. The default is
3. If zero only one update request will be made.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN82"
></A
><H2
>INPUT FORMAT</H2
><P
><B
CLASS="COMMAND"
>nsupdate</B
>
reads input from
<TT
CLASS="PARAMETER"
><I
>filename</I
></TT
>
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 <B
CLASS="COMMAND"
>send</B
> 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
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><P
><B
CLASS="COMMAND"
>server</B
> {servername} [port]</P
></DT
><DD
><P
>Sends all dynamic update requests to the name server
<TT
CLASS="PARAMETER"
><I
>servername</I
></TT
>.
When no server statement is provided,
<B
CLASS="COMMAND"
>nsupdate</B
>
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.
<TT
CLASS="PARAMETER"
><I
>port</I
></TT
>
is the port number on
<TT
CLASS="PARAMETER"
><I
>servername</I
></TT
>
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
><P
><B
CLASS="COMMAND"
>local</B
> {address} [port]</P
></DT
><DD
><P
>Sends all dynamic update requests using the local
<TT
CLASS="PARAMETER"
><I
>address</I
></TT
>.
When no local statement is provided,
<B
CLASS="COMMAND"
>nsupdate</B
>
will send updates using an address and port chosen by the system.
<TT
CLASS="PARAMETER"
><I
>port</I
></TT
>
can additionally be used to make requests come from a specific port.
If no port number is specified, the system will assign one.&#13;</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>zone</B
> {zonename}</P
></DT
><DD
><P
>Specifies that all updates are to be made to the zone
<TT
CLASS="PARAMETER"
><I
>zonename</I
></TT
>.
If no
<TT
CLASS="PARAMETER"
><I
>zone</I
></TT
>
statement is provided,
<B
CLASS="COMMAND"
>nsupdate</B
>
will attempt determine the correct zone to update based on the rest of the input.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>class</B
> {classname}</P
></DT
><DD
><P
>Specify the default class.
If no <TT
CLASS="PARAMETER"
><I
>class</I
></TT
> is specified the default class is
<TT
CLASS="PARAMETER"
><I
>IN</I
></TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>key</B
> {name} {secret}</P
></DT
><DD
><P
>Specifies that all updates are to be TSIG signed using the
<TT
CLASS="PARAMETER"
><I
>keyname</I
></TT
> <TT
CLASS="PARAMETER"
><I
>keysecret</I
></TT
> pair.
The <B
CLASS="COMMAND"
>key</B
> command
overrides any key specified on the command line via
<TT
CLASS="OPTION"
>-y</TT
> or <TT
CLASS="OPTION"
>-k</TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq nxdomain</B
> {domain-name}</P
></DT
><DD
><P
>Requires that no resource record of any type exists with name
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq yxdomain</B
> {domain-name}</P
></DT
><DD
><P
>Requires that
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>
exists (has as at least one resource record, of any type).</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq nxrrset</B
> {domain-name} [class] {type}</P
></DT
><DD
><P
>Requires that no resource record exists of the specified
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.
If
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
is omitted, IN (internet) is assumed.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq yxrrset</B
> {domain-name} [class] {type}</P
></DT
><DD
><P
>This requires that a resource record of the specified
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>
must exist.
If
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
is omitted, IN (internet) is assumed.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>prereq yxrrset</B
> {domain-name} [class] {type} {data...}</P
></DT
><DD
><P
>The
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>
from each set of prerequisites of this form
sharing a common
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>,
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>
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
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>,
and
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.
The
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>
are written in the standard text representation of the resource record's
RDATA.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>update delete</B
> {domain-name} [ttl] [class] [type [data...]]</P
></DT
><DD
><P
>Deletes any resource records named
<TT
CLASS="PARAMETER"
><I
>domain-name</I
></TT
>.
If
<TT
CLASS="PARAMETER"
><I
>type</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>
is provided, only matching resource records will be removed.
The internet class is assumed if
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
is not supplied. The
<TT
CLASS="PARAMETER"
><I
>ttl</I
></TT
>
is ignored, and is only allowed for compatibility.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>update add</B
> {domain-name} {ttl} [class] {type} {data...}</P
></DT
><DD
><P
>Adds a new resource record with the specified
<TT
CLASS="PARAMETER"
><I
>ttl</I
></TT
>,
<TT
CLASS="PARAMETER"
><I
>class</I
></TT
>
and
<TT
CLASS="PARAMETER"
><I
>data</I
></TT
>.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>show</B
> </P
></DT
><DD
><P
>Displays the current message, containing all of the prerequisites and
updates specified since the last send.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>send</B
> </P
></DT
><DD
><P
>Sends the current message. This is equivalent to entering a blank line.</P
></DD
><DT
><P
><B
CLASS="COMMAND"
>answer</B
> </P
></DT
><DD
><P
>Displays the answer.</P
></DD
></DL
></DIV
>&#13;</P
><P
>Lines beginning with a semicolon are comments and are ignored.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN255"
></A
><H2
>EXAMPLES</H2
><P
>The examples below show how
<B
CLASS="COMMAND"
>nsupdate</B
>
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
>.
<PRE
CLASS="PROGRAMLISTING"
># nsupdate
&#62; update delete oldhost.example.com A
&#62; update add newhost.example.com 86400 A 172.16.1.1
&#62; send</PRE
></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
>
it IP address 172.16.1.1 is added.
The newly-added record has a 1 day TTL (86400 seconds)
<PRE
CLASS="PROGRAMLISTING"
># nsupdate
&#62; prereq nxdomain nickname.example.com
&#62; update add nickname.example.com 86400 CNAME somehost.example.com
&#62; send</PRE
></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 RFC1034 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 RFC2535 to allow CNAMEs to have
RRSIG, DNSKEY and NSEC records.)</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN268"
></A
><H2
>FILES</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="CONSTANT"
>/etc/resolv.conf</TT
></DT
><DD
><P
>used to identify default name server</P
></DD
><DT
><TT
CLASS="CONSTANT"
>K{name}.+157.+{random}.key</TT
></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
><TT
CLASS="CONSTANT"
>K{name}.+157.+{random}.private</TT
></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"
><A
NAME="AEN292"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2136</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC3007</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2104</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2845</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC1034</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2535</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2931</SPAN
></SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>named</SPAN
>(8)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>dnssec-keygen</SPAN
>(8)</SPAN
>.&#13;</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN315"
></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
></BODY
></HTML
>