nnssuuppddaattee is used to submit Dynamic DNS Update requests as defined in RFC 2136 to a name server. This allows resource records to be added or removed from a zone without manually editing the zone file. A single update request can contain requests to add or remove more than one resource record.
Zones that are under dynamic control via nnssuuppddaattee or a DHCP server should not be edited by hand. Manual edits could conflict with dynamic updates and cause data to be lost.
The resource records that are dynamically added or removed with nnssuuppddaattee have to be in the same zone. Requests are sent to the zone's master server. This is identified by the MNAME field of the zone's SOA record.
The --dd option makes nnssuuppddaattee operate in debug mode. This provides tracing information about the update requests that are made and the replies received from the name server.
The --DD option makes nnssuuppddaattee report additional debugging information to --dd.
The --LL option with an integer argument of zero or higher sets the logging debug level. If zero, logging is disabled.
Transaction signatures can be used to authenticate the Dynamic DNS updates. These use the TSIG resource record type described in RFC 2845 or the SIG(0) record described in RFC 2535 and RFC 2931 or GSS-TSIG as described in RFC 3645. TSIG relies on a shared secret that should only be known to nnssuuppddaattee 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 kkeeyy and sseerrvveerr statements would be added to _/_e_t_c_/_n_a_m_e_d_._c_o_n_f 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. nnssuuppddaattee does not read _/_e_t_c_/_n_a_m_e_d_._c_o_n_f.
GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode is switched on with the --gg flag. A non-standards-compliant variant of GSS-TSIG used by Windows 2000 can be switched on with the --oo flag.
nnssuuppddaattee uses the --yy or --kk option to provide the shared secret needed to generate a TSIG record for authenticating Dynamic DNS update requests, default type HMAC-MD5. These options are mutually exclusive.
When the --yy option is used, a signature is generated from [_h_m_a_c_:]_k_e_y_n_a_m_e_:_s_e_c_r_e_t_. _k_e_y_n_a_m_e is the name of the key, and _s_e_c_r_e_t is the base64 encoded shared secret. Use of the --yy 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 ppss(1) or in a history file maintained by the user's shell.
With the --kk option, nnssuuppddaattee reads the shared secret from the file _k_e_y_f_i_l_e. Keyfiles may be in two formats: a single file containing a _n_a_m_e_d_._c_o_n_f-format kkeeyy statement, which may be generated automatically by ddddnnss--ccoonnffggeenn, or a pair of files whose names are of the format _K_{_n_a_m_e_}_._+_1_5_7_._+_{_r_a_n_d_o_m_}_._k_e_y and _K_{_n_a_m_e_}_._+_1_5_7_._+_{_r_a_n_d_o_m_}_._p_r_i_v_a_t_e, which can be generated by ddnnsssseecc--kkeeyyggeenn. The --kk 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.
nnssuuppddaattee can be run in a local-host only mode using the --ll flag. This sets the server address to localhost (disabling the sseerrvveerr so that the server address cannot be overridden). Connections to the local server will use a TSIG key found in _/_v_a_r_/_r_u_n_/_n_a_m_e_d_/_s_e_s_s_i_o_n_._k_e_y, which is automatically generated by nnaammeedd if any local master zone has set uuppddaattee--ppoolliiccyy to llooccaall. The location of this key file can be overridden with the --kk option.
By default, nnssuuppddaattee 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 --vv option makes nnssuuppddaattee use a TCP connection. This may be preferable when a batch of update requests is made.
The --pp sets the default port number to use for connections to a name server. The default is 53.
The --tt option sets the maximum time an update request can take before it is aborted. The default is 300 seconds. Zero can be used to disable the timeout.
The --uu 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.
The --rr option sets the number of UDP retries. The default is 3. If zero, only one update request will be made.
The --RR _r_a_n_d_o_m_d_e_v option specifies a source of randomness. If the operating system does not provide a _/_d_e_v_/_r_a_n_d_o_m or equivalent device, the default source of randomness is keyboard input. _r_a_n_d_o_m_d_e_v specifies the name of a character device or file containing random data to be used instead of the default. The special value _k_e_y_b_o_a_r_d indicates that keyboard input should be used. This option may be specified multiple times.
nnssuuppddaattee reads input from _f_i_l_e_n_a_m_e 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.
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 sseenndd command) causes the accumulated commands to be sent as one Dynamic DNS update request to the name server.
The command formats and their meaning are as follows:
sseerrvveerr {servername} [port] Sends all dynamic update requests to the name server _s_e_r_v_e_r_n_a_m_e. When no server statement is provided, nnssuuppddaattee 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. _p_o_r_t is the port number on _s_e_r_v_e_r_n_a_m_e where the dynamic update requests get sent. If no port number is specified, the default DNS port number of 53 is used.
llooccaall {address} [port] Sends all dynamic update requests using the local _a_d_d_r_e_s_s. When no local statement is provided, nnssuuppddaattee will send updates using an address and port chosen by the system. _p_o_r_t can additionally be used to make requests come from a specific port. If no port number is specified, the system will assign one.
zzoonnee {zonename} Specifies that all updates are to be made to the zone _z_o_n_e_n_a_m_e. If no _z_o_n_e statement is provided, nnssuuppddaattee will attempt determine the correct zone to update based on the rest of the input.
ccllaassss {classname} Specify the default class. If no _c_l_a_s_s is specified, the default class is _I_N.
ttttll {seconds} Specify the default time to live for records to be added. The value _n_o_n_e will clear the default ttl.
kkeeyy {name} {secret} Specifies that all updates are to be TSIG-signed using the _k_e_y_n_a_m_e _k_e_y_s_e_c_r_e_t pair. The kkeeyy command overrides any key specified on the command line via --yy or --kk.
ggssssttssiigg Use GSS-TSIG to sign the updated. This is equivalent to specifying --gg on the commandline.
oollddggssssttssiigg Use the Windows 2000 version of GSS-TSIG to sign the updated. This is equivalent to specifying --oo on the commandline.
rreeaallmm {[realm_name]} When using GSS-TSIG use _r_e_a_l_m___n_a_m_e rather than the default realm in _k_r_b_5_._c_o_n_f. If no realm is specified the saved realm is cleared.
pprreerreeqq nnxxddoommaaiinn {domain-name} Requires that no resource record of any type exists with name _d_o_m_a_i_n_-_n_a_m_e.
pprreerreeqq yyxxddoommaaiinn {domain-name} Requires that _d_o_m_a_i_n_-_n_a_m_e exists (has as at least one resource record, of any type).
pprreerreeqq nnxxrrrrsseett {domain-name} [class] {type} Requires that no resource record exists of the specified _t_y_p_e, _c_l_a_s_s and _d_o_m_a_i_n_-_n_a_m_e. If _c_l_a_s_s is omitted, IN (internet) is assumed.
pprreerreeqq yyxxrrrrsseett {domain-name} [class] {type} This requires that a resource record of the specified _t_y_p_e, _c_l_a_s_s and _d_o_m_a_i_n_-_n_a_m_e must exist. If _c_l_a_s_s is omitted, IN (internet) is assumed.
pprreerreeqq yyxxrrrrsseett {domain-name} [class] {type} {data...} The _d_a_t_a from each set of prerequisites of this form sharing a common _t_y_p_e, _c_l_a_s_s, and _d_o_m_a_i_n_-_n_a_m_e 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 _t_y_p_e, _c_l_a_s_s, and _d_o_m_a_i_n_-_n_a_m_e. The _d_a_t_a are written in the standard text representation of the resource record's RDATA.
uuppddaattee ddeelleettee {domain-name} [ttl] [class] [type [data...]] Deletes any resource records named _d_o_m_a_i_n_-_n_a_m_e. If _t_y_p_e and _d_a_t_a is provided, only matching resource records will be removed. The internet class is assumed if _c_l_a_s_s is not supplied. The _t_t_l is ignored, and is only allowed for compatibility.
uuppddaattee aadddd {domain-name} {ttl} [class] {type} {data...} Adds a new resource record with the specified _t_t_l, _c_l_a_s_s and _d_a_t_a.
sshhooww Displays the current message, containing all of the prerequisites and updates specified since the last send.
sseenndd Sends the current message. This is equivalent to entering a blank line.
aannsswweerr Displays the answer.
ddeebbuugg Turn on debugging.
Lines beginning with a semicolon are comments and are ignored.
The examples below show how
nnssuuppddaattee
could be used to insert and delete resource records from the
eexxaammppllee..ccoomm
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
eexxaammppllee..ccoomm.
# nsupdate > update delete oldhost.example.com A > update add newhost.example.com 86400 A 172.16.1.1 > send
Any A records for
oollddhhoosstt..eexxaammppllee..ccoomm
are deleted. And an A record for
nneewwhhoosstt..eexxaammppllee..ccoomm
with IP address 172.16.1.1 is added. The newly-added record has a 1 day TTL (86400 seconds).
# nsupdate > prereq nxdomain nickname.example.com > update add nickname.example.com 86400 CNAME somehost.example.com > send
The prerequisite condition gets the name server to check that there are no resource records of any type for nniicckknnaammee..eexxaammppllee..ccoomm. 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.)
//eettcc//rreessoollvv..ccoonnff used to identify default name server
//vvaarr//rruunn//nnaammeedd//sseessssiioonn..kkeeyy sets the default TSIG key for use in local-only mode
KK{{nnaammee}}..++115577..++{{rraannddoomm}}..kkeeyy base-64 encoding of HMAC-MD5 key created by ddnnsssseecc--kkeeyyggeenn(8).
KK{{nnaammee}}..++115577..++{{rraannddoomm}}..pprriivvaattee base-64 encoding of HMAC-MD5 key created by ddnnsssseecc--kkeeyyggeenn(8).
RFC 2136, RFC 3007, RFC 2104, RFC 2845, RFC 1034, RFC 2535, RFC 2931, nnaammeedd(8), ddddnnss--ccoonnffggeenn(8), ddnnsssseecc--kkeeyyggeenn(8).
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.