rndc.html revision 659d063f23a35d77ad5826e6556d3137672bb937
ab71b233b3a36489e44a7b061c48293be0b17788jwoolley - Copyright (C) 2004, 2005, 2007, 2013-2015 Internet Systems Consortium, Inc. ("ISC")
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj - Copyright (C) 2000, 2001 Internet Software Consortium.
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj - Permission to use, copy, modify, and/or distribute this software for any
ab71b233b3a36489e44a7b061c48293be0b17788jwoolley - purpose with or without fee is hereby granted, provided that the above
571760de5e60c0b459cb11be45507b923cd023eejwoolley - copyright notice and this permission notice appear in all copies.
9180a5933673ffb1af633c255ceee029340f3b1erbb - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
bcb6e1be6041dfeb549c8ea8d37f97ad4e90a0c3rbb - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9bd71e35f5d26d26d23fe3a677401828e842ed72wrowe - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2900ab946a2d76b73a14cebfe2985d253f01c967stoddard - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a548c09e6a8ca1b059d0e93b5256c6ccb2b3c3cdrbb - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a548c09e6a8ca1b059d0e93b5256c6ccb2b3c3cdrbb - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a548c09e6a8ca1b059d0e93b5256c6ccb2b3c3cdrbb - PERFORMANCE OF THIS SOFTWARE.
cf6bf6c34c936e6a6fe731dbce4a5c3c8bf8e9a3gstein<!-- $Id$ -->
8dd4618c4709236b4ea297d7250d282e463ce2d8rbb<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2deb319e6b3de239f45c16a3e9e836d44f1f7108rbb<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
70f6f32765cfaadd6da8de6f0fea97ddd72d8fadmanoj<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
af4c982a7cf4515f124935f99a329744035fc699slive<p><span class="application">rndc</span> — name server control utility</p>
af4c982a7cf4515f124935f99a329744035fc699slive<div class="cmdsynopsis"><p><code class="command">rndc</code> [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>] [<code class="option">-s <em class="replaceable"><code>server</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-q</code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
bf9acc131271d18db51d30ace549d3c3b6a2b9fbrbb controls the operation of a name
bf9acc131271d18db51d30ace549d3c3b6a2b9fbrbb server. It supersedes the <span><strong class="command">ndc</strong></span> utility
bf9acc131271d18db51d30ace549d3c3b6a2b9fbrbb that was provided in old BIND releases. If
bf9acc131271d18db51d30ace549d3c3b6a2b9fbrbb <span><strong class="command">rndc</strong></span> is invoked with no command line
bf9acc131271d18db51d30ace549d3c3b6a2b9fbrbb options or arguments, it prints a short summary of the
79d5106a9b65b956d646f5daae4b94bc79e315b8trawick supported commands and the available options and their
79d5106a9b65b956d646f5daae4b94bc79e315b8trawick<p><span><strong class="command">rndc</strong></span>
79d5106a9b65b956d646f5daae4b94bc79e315b8trawick communicates with the name server over a TCP connection, sending
79d5106a9b65b956d646f5daae4b94bc79e315b8trawick commands authenticated with digital signatures. In the current
9eccc0a669a3e711629345b357c46acce5fefdb4gstein versions of
9eccc0a669a3e711629345b357c46acce5fefdb4gstein <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
750fcd3495b59eff6d4844409ae1dfb46d026059gstein the only supported authentication algorithms are HMAC-MD5
750fcd3495b59eff6d4844409ae1dfb46d026059gstein (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
750fcd3495b59eff6d4844409ae1dfb46d026059gstein (default), HMAC-SHA384 and HMAC-SHA512.
750fcd3495b59eff6d4844409ae1dfb46d026059gstein They use a shared secret on each end of the connection.
750fcd3495b59eff6d4844409ae1dfb46d026059gstein This provides TSIG-style authentication for the command
750fcd3495b59eff6d4844409ae1dfb46d026059gstein request and the name server's response. All commands sent
750fcd3495b59eff6d4844409ae1dfb46d026059gstein over the channel must be signed by a key_id known to the
9eccc0a669a3e711629345b357c46acce5fefdb4gstein reads a configuration file to
281da4c02cf40c663298ded7e4e5b913a8f8b814gstein determine how to contact the name server and decide what
281da4c02cf40c663298ded7e4e5b913a8f8b814gstein algorithm and key it should use.
ec75f189410513ab8f6e1173a9d9d277ebec9ce7gstein<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
ec75f189410513ab8f6e1173a9d9d277ebec9ce7gstein Use <em class="replaceable"><code>source-address</code></em>
ec75f189410513ab8f6e1173a9d9d277ebec9ce7gstein as the source address for the connection to the server.
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe Multiple instances are permitted to allow setting of both
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe the IPv4 and IPv6 source addresses.
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe Use <em class="replaceable"><code>config-file</code></em>
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe as the configuration file instead of the default,
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe Use <em class="replaceable"><code>key-file</code></em>
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe as the key file instead of the default,
dc96a5e6f9af3c514df4c61ab9468fcf97f9846fwrowe <code class="filename">/etc/rndc.key</code>. The key in
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard <code class="filename">/etc/rndc.key</code> will be used to
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard authenticate
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard does not exist.
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard<dd><p><em class="replaceable"><code>server</code></em> is
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard the name or address of the server which matches a
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard server statement in the configuration file for
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard <span><strong class="command">rndc</strong></span>. If no server is supplied on the
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj command line, the host named by the default-server clause
33a70d93b992bbb63b809c24df29451f38f017c1rbb in the options statement of the <span><strong class="command">rndc</strong></span>
410912d9cb56a09a74f8655647ed9e81d49023f4gregames configuration file will be used.
410912d9cb56a09a74f8655647ed9e81d49023f4gregames<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe Send commands to TCP port
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe of BIND 9's default control channel port, 953.
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe Quiet mode: Message text returned by the server
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe will not be printed except when there is an error.
d180ec1b29106f4fec480ef7fcdb04df078010cerse Enable verbose logging.
d180ec1b29106f4fec480ef7fcdb04df078010cerse<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
d180ec1b29106f4fec480ef7fcdb04df078010cerse Use the key <em class="replaceable"><code>key_id</code></em>
d180ec1b29106f4fec480ef7fcdb04df078010cerse from the configuration file.
d180ec1b29106f4fec480ef7fcdb04df078010cerse known by named with the same algorithm and secret string
d180ec1b29106f4fec480ef7fcdb04df078010cerse in order for control message validation to succeed.
d180ec1b29106f4fec480ef7fcdb04df078010cerse is specified, <span><strong class="command">rndc</strong></span> will first look
d180ec1b29106f4fec480ef7fcdb04df078010cerse for a key clause in the server statement of the server
d180ec1b29106f4fec480ef7fcdb04df078010cerse being used, or if no server statement is present for that
d180ec1b29106f4fec480ef7fcdb04df078010cerse host, then the default-key clause of the options statement.
d180ec1b29106f4fec480ef7fcdb04df078010cerse Note that the configuration file contains shared secrets
d180ec1b29106f4fec480ef7fcdb04df078010cerse which are used to send authenticated control commands
d180ec1b29106f4fec480ef7fcdb04df078010cerse to name servers. It should therefore not have general read
d180ec1b29106f4fec480ef7fcdb04df078010cerse or write access.
e32adabcbf3bf5b69ba2e8b163b971839efc94dbtrawick A list of commands supported by <span><strong class="command">rndc</strong></span> can
bebc7b9445f95339822c26bfd470349006f9ec40stoddard be seen by running <span><strong class="command">rndc</strong></span> without arguments.
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard Currently supported commands are:
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard<dt><span class="term"><strong class="userinput"><code>reload</code></strong></span></dt>
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard Reload configuration file and zones.
7bce59d998f2e5ca1cb60038ef6c1d0817605d62stoddard<dt><span class="term"><strong class="userinput"><code>reload <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
49facccad3f5c3e9e49311487b5069699c3bf3fdjwoolley Reload the given zone.
49facccad3f5c3e9e49311487b5069699c3bf3fdjwoolley<dt><span class="term"><strong class="userinput"><code>refresh <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
49facccad3f5c3e9e49311487b5069699c3bf3fdjwoolley Schedule zone maintenance for the given zone.
19cbe4d7b7c931723e7249de6829bf965a1fee72stoddard<dt><span class="term"><strong class="userinput"><code>retransfer <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
93db592309ba9e5ab230f67611a2c74fece9cdb2marc Retransfer the given slave zone from the master server.
93db592309ba9e5ab230f67611a2c74fece9cdb2marc If the zone is configured to use
93db592309ba9e5ab230f67611a2c74fece9cdb2marc <span><strong class="command">inline-signing</strong></span>, the signed
93db592309ba9e5ab230f67611a2c74fece9cdb2marc version of the zone is discarded; after the
b187d568e1507d75139ebc13ca945b38fc05d55cstoddard retransfer of the unsigned version is complete, the
b187d568e1507d75139ebc13ca945b38fc05d55cstoddard signed version will be regenerated with all new
b187d568e1507d75139ebc13ca945b38fc05d55cstoddard signatures.
8bed76428f56e5c643174a2d6807c3f18016af5cbjh<dt><span class="term"><strong class="userinput"><code>sign <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
d2f8b010487ffa990a9c268df5a25579e7291bcdrbb Fetch all DNSSEC keys for the given zone
d2f8b010487ffa990a9c268df5a25579e7291bcdrbb from the key directory (see the
a5ed555df952c85bc1b179f5981e8a6c54ba16e6stoddard <span><strong class="command">key-directory</strong></span> option in
0bff2f28ef945280c17099c142126178a78e1e54manoj the BIND 9 Administrator Reference Manual). If they are within
0bff2f28ef945280c17099c142126178a78e1e54manoj their publication period, merge them into the
0bff2f28ef945280c17099c142126178a78e1e54manoj zone's DNSKEY RRset. If the DNSKEY RRset
1e585ba09ea32272e63c4c39c35491e975d21d98stoddard is changed, then the zone is automatically
0bff2f28ef945280c17099c142126178a78e1e54manoj re-signed with the new key set.
9c09943bad734ebd5c7cc10bd6d63b75c4c6e056stoddard This command requires that the
ff849e4163ed879288f0df15f78b6c9d278ec804fanf <span><strong class="command">auto-dnssec</strong></span> zone option be set
447c6ce3ff08073c44f6785d5256271fcb877512wrowe and also requires the zone to be configured to
447c6ce3ff08073c44f6785d5256271fcb877512wrowe allow dynamic DNS.
447c6ce3ff08073c44f6785d5256271fcb877512wrowe (See "Dynamic Update Policies" in the Administrator
447c6ce3ff08073c44f6785d5256271fcb877512wrowe Reference Manual for more details.)
cf6bf6c34c936e6a6fe731dbce4a5c3c8bf8e9a3gstein<dt><span class="term"><strong class="userinput"><code>loadkeys <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
dd4713dc5b186f4d1be7b88f86608fdb84cbe5d5gstein Fetch all DNSSEC keys for the given zone
0eb7ca6cf812d98c534661ac474e873a32bf6325gstein from the key directory. If they are within
cf6bf6c34c936e6a6fe731dbce4a5c3c8bf8e9a3gstein their publication period, merge them into the
8d07897b52e3b7055874501f8a499e75800db206gstein zone's DNSKEY RRset. Unlike <span><strong class="command">rndc
db3ccce11afac4fc1d4f51a65424412f7480c46cgstein immediately re-signed by the new keys, but is
79d5106a9b65b956d646f5daae4b94bc79e315b8trawick allowed to incrementally re-sign over time.
cf6bf6c34c936e6a6fe731dbce4a5c3c8bf8e9a3gstein This command requires that the
cf6bf6c34c936e6a6fe731dbce4a5c3c8bf8e9a3gstein <span><strong class="command">auto-dnssec</strong></span> zone option
6fa71a1bd8c61518b05f5798a7a1594c270e78afrbb and also requires the zone to be configured to
93c5cba06b623ebe8e4372e886eece12d9a80c3egstein allow dynamic DNS.
14cccaddba3a9263cf0d0ddc311e18f3e3dc9b0fgstein (See "Dynamic Update Policies" in the Administrator
14cccaddba3a9263cf0d0ddc311e18f3e3dc9b0fgstein Reference Manual for more details.)
14cccaddba3a9263cf0d0ddc311e18f3e3dc9b0fgstein<dt><span class="term"><strong class="userinput"><code>freeze [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
823c303d33c9e637a83d82208bcbafaf5f532d7bgstein Suspend updates to a dynamic zone. If no zone is
823c303d33c9e637a83d82208bcbafaf5f532d7bgstein specified, then all zones are suspended. This allows
e636eba7474e0010b5c7198af1c2fe5ad8652dbbmanoj manual edits to be made to a zone normally updated by
e636eba7474e0010b5c7198af1c2fe5ad8652dbbmanoj dynamic update. It also causes changes in the
e636eba7474e0010b5c7198af1c2fe5ad8652dbbmanoj journal file to be synced into the master file.
281da4c02cf40c663298ded7e4e5b913a8f8b814gstein All dynamic update attempts will be refused while
281da4c02cf40c663298ded7e4e5b913a8f8b814gstein the zone is frozen.
333eac96e4fb7d6901cb75e6ca7bb22b2ccb84cetrawick<dt><span class="term"><strong class="userinput"><code>thaw [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
2f728b2e8555fee1b7cc11e886488692f2575fbddougm Enable updates to a frozen dynamic zone. If no
2f728b2e8555fee1b7cc11e886488692f2575fbddougm zone is specified, then all frozen zones are
114cc51b75ed89d5ab2f39b85ba7d472293f3dedtrawick enabled. This causes the server to reload the zone
114cc51b75ed89d5ab2f39b85ba7d472293f3dedtrawick from disk, and re-enables dynamic updates after the
114cc51b75ed89d5ab2f39b85ba7d472293f3dedtrawick load has completed. After a zone is thawed,
114cc51b75ed89d5ab2f39b85ba7d472293f3dedtrawick dynamic updates will no longer be refused. If
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe the zone has changed and the
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe <span><strong class="command">ixfr-from-differences</strong></span> option is
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe in use, then the journal file will be updated to
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe reflect changes in the zone. Otherwise, if the
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe zone has changed, any existing journal file will be
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe<dt><span class="term"><strong class="userinput"><code>scan</code></strong></span></dt>
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe Scan the list of available network interfaces
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe for changes, without performing a full
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe <span><strong class="command">reconfig</strong></span> or waiting for the
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe <span><strong class="command">interface-interval</strong></span> timer.
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe<dt><span class="term"><strong class="userinput"><code>sync [<span class="optional">-clean</span>] [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
60d567a0c2aae815ee6fc20c0d65032bea52c92cwrowe Sync changes in the journal file for a dynamic zone
64ad864fa0f4493eebb181e393b40a8a90beccb9coar to the master file. If the "-clean" option is
64ad864fa0f4493eebb181e393b40a8a90beccb9coar specified, the journal file is also removed. If
64ad864fa0f4493eebb181e393b40a8a90beccb9coar no zone is specified, then all zones are synced.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>notify <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Resend NOTIFY messages for the zone.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>reconfig</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Reload the configuration file and load new zones,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar but do not reload existing zone files even if they
64ad864fa0f4493eebb181e393b40a8a90beccb9coar have changed.
28d1da9ca818f831ea491f110dafcc10f7f07050coar This is faster than a full <span><strong class="command">reload</strong></span> when there
64ad864fa0f4493eebb181e393b40a8a90beccb9coar is a large number of zones because it avoids the need
64ad864fa0f4493eebb181e393b40a8a90beccb9coar to examine the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar modification times of the zones files.
28d1da9ca818f831ea491f110dafcc10f7f07050coar<dt><span class="term"><strong class="userinput"><code>zonestatus [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Displays the current status of the given zone,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar including the master file name and any include
28d1da9ca818f831ea491f110dafcc10f7f07050coar files from which it was loaded, when it was most
64ad864fa0f4493eebb181e393b40a8a90beccb9coar recently loaded, the current serial number, the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar number of nodes, whether the zone supports
64ad864fa0f4493eebb181e393b40a8a90beccb9coar dynamic updates, whether the zone is DNSSEC
28d1da9ca818f831ea491f110dafcc10f7f07050coar signed, whether it uses automatic DNSSEC key
64ad864fa0f4493eebb181e393b40a8a90beccb9coar management or inline signing, and the scheduled
64ad864fa0f4493eebb181e393b40a8a90beccb9coar refresh or expiry times for the zone.
28d1da9ca818f831ea491f110dafcc10f7f07050coar<dt><span class="term"><strong class="userinput"><code>managed-keys <em class="replaceable"><code>(status | refresh | sync)</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar When run with the "status" keyword, print the current
64ad864fa0f4493eebb181e393b40a8a90beccb9coar status of the managed-keys database for the specified
64ad864fa0f4493eebb181e393b40a8a90beccb9coar view, or for all views if none is specified. When run
28d1da9ca818f831ea491f110dafcc10f7f07050coar with the "refresh" keyword, force an immediate refresh
64ad864fa0f4493eebb181e393b40a8a90beccb9coar of all the managed-keys in the specified view, or all
64ad864fa0f4493eebb181e393b40a8a90beccb9coar views. When run with the "sync" keyword, force an
64ad864fa0f4493eebb181e393b40a8a90beccb9coar immediate dump of the managed-keys database to disk (in
28d1da9ca818f831ea491f110dafcc10f7f07050coar the file <code class="filename">managed-keys.bind</code> or
64ad864fa0f4493eebb181e393b40a8a90beccb9coar (<code class="filename"><em class="replaceable"><code>viewname</code></em>.mkeys</code>).
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>stats</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Write server statistics to the statistics file.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Enable or disable query logging. (For backward
64ad864fa0f4493eebb181e393b40a8a90beccb9coar compatibility, this command can also be used without
28d1da9ca818f831ea491f110dafcc10f7f07050coar an argument to toggle query logging on and off.)
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Query logging can also be enabled
28d1da9ca818f831ea491f110dafcc10f7f07050coar by explicitly directing the <span><strong class="command">queries</strong></span>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">category</strong></span> to a
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">channel</strong></span> in the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">logging</strong></span> section of
28d1da9ca818f831ea491f110dafcc10f7f07050coar <code class="filename">named.conf</code> or by specifying
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">querylog yes;</strong></span> in the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">options</strong></span> section of
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>dumpdb [<span class="optional">-all|-cache|-zone</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar dump file for the specified views. If no view is
64ad864fa0f4493eebb181e393b40a8a90beccb9coar specified, all
64ad864fa0f4493eebb181e393b40a8a90beccb9coar views are dumped.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>secroots [<span class="optional">-</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Dump the server's security roots and negative trust anchors
64ad864fa0f4493eebb181e393b40a8a90beccb9coar for the specified views. If no view is specified, all views
64ad864fa0f4493eebb181e393b40a8a90beccb9coar are dumped.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If the first argument is "-", then the output is
64ad864fa0f4493eebb181e393b40a8a90beccb9coar returned via the <span><strong class="command">rndc</strong></span> response channel
64ad864fa0f4493eebb181e393b40a8a90beccb9coar and printed to the standard output.
28d1da9ca818f831ea491f110dafcc10f7f07050coar Otherwise, it is written to the secroots dump file, which
64ad864fa0f4493eebb181e393b40a8a90beccb9coar defaults to <code class="filename">named.secroots</code>, but can be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar overridden via the <code class="option">secroots-file</code> option in
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>stop [<span class="optional">-p</span>]</code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Stop the server, making sure any recent changes
64ad864fa0f4493eebb181e393b40a8a90beccb9coar made through dynamic update or IXFR are first saved to
64ad864fa0f4493eebb181e393b40a8a90beccb9coar the master files of the updated zones.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
28d1da9ca818f831ea491f110dafcc10f7f07050coar This allows an external process to determine when <span><strong class="command">named</strong></span>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar had completed stopping.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Stop the server immediately. Recent changes
64ad864fa0f4493eebb181e393b40a8a90beccb9coar made through dynamic update or IXFR are not saved to
64ad864fa0f4493eebb181e393b40a8a90beccb9coar the master files, but will be rolled forward from the
28d1da9ca818f831ea491f110dafcc10f7f07050coar journal files when the server is restarted.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar This allows an external process to determine when <span><strong class="command">named</strong></span>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar had completed halting.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>trace</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Increment the servers debugging level by one.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>trace <em class="replaceable"><code>level</code></em></code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Sets the server's debugging level to an explicit
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>notrace</code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Sets the server's debugging level to 0.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Flushes the server's cache.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>flushname</code></strong> <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Flushes the given name from the view's DNS cache
64ad864fa0f4493eebb181e393b40a8a90beccb9coar and, if applicable, from the view's nameserver address
6694e265e9a71ceaedbe1f1aa4db4d9ba42fb866wrowe database, bad server cache and SERVFAIL cache.
28d1da9ca818f831ea491f110dafcc10f7f07050coar<dt><span class="term"><strong class="userinput"><code>flushtree</code></strong> <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Flushes the given name, and all of its subdomains,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar from the view's DNS cache, address database,
28d1da9ca818f831ea491f110dafcc10f7f07050coar bad server cache, and SERVFAIL cache.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>status</code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Display status of the server.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Note that the number of zones includes the internal <span><strong class="command">bind/CH</strong></span> zone
64ad864fa0f4493eebb181e393b40a8a90beccb9coar and the default <span><strong class="command">/IN</strong></span>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar hint zone if there is not an
28d1da9ca818f831ea491f110dafcc10f7f07050coar explicit root zone configured.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>recursing</code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Dump the list of queries <span><strong class="command">named</strong></span> is currently recursing
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>validation ( on | off | check ) [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>] </code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Enable, disable, or check the current status of
64ad864fa0f4493eebb181e393b40a8a90beccb9coar DNSSEC validation.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Note <span><strong class="command">dnssec-enable</strong></span> also needs to be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar set to <strong class="userinput"><code>yes</code></strong> or
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <strong class="userinput"><code>auto</code></strong> to be effective.
28d1da9ca818f831ea491f110dafcc10f7f07050coar It defaults to enabled.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>nta
64ad864fa0f4493eebb181e393b40a8a90beccb9coar [<span class="optional">( -d | -f | -r | -l <em class="replaceable"><code>duration</code></em>)</span>]
64ad864fa0f4493eebb181e393b40a8a90beccb9coar [<span class="optional"><em class="replaceable"><code>view</code></em></span>]
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Sets a DNSSEC negative trust anchor (NTA)
64ad864fa0f4493eebb181e393b40a8a90beccb9coar for <code class="option">domain</code>, with a lifetime of
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <code class="option">duration</code>. The default lifetime is
28d1da9ca818f831ea491f110dafcc10f7f07050coar configured in <code class="filename">named.conf</code> via the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <code class="option">nta-lifetime</code> option, and defaults to
64ad864fa0f4493eebb181e393b40a8a90beccb9coar one hour. The lifetime cannot exceed one week.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar A negative trust anchor selectively disables
64ad864fa0f4493eebb181e393b40a8a90beccb9coar DNSSEC validation for zones that are known to be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar failing because of misconfiguration rather than
64ad864fa0f4493eebb181e393b40a8a90beccb9coar an attack. When data to be validated is
28d1da9ca818f831ea491f110dafcc10f7f07050coar at or below an active NTA (and above any other
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configured trust anchors), <span><strong class="command">named</strong></span> will
64ad864fa0f4493eebb181e393b40a8a90beccb9coar abort the DNSSEC validation process and treat the data as
64ad864fa0f4493eebb181e393b40a8a90beccb9coar insecure rather than bogus. This continues until the
28d1da9ca818f831ea491f110dafcc10f7f07050coar NTA's lifetime is elapsed.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar NTAs persist across restarts of the named server.
28d1da9ca818f831ea491f110dafcc10f7f07050coar The NTAs for a view are saved in a file called
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <code class="filename"><em class="replaceable"><code>name</code></em>.nta</code>,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar where <em class="replaceable"><code>name</code></em> is the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar name of the view, or if it contains characters
64ad864fa0f4493eebb181e393b40a8a90beccb9coar that are incompatible with use as a file name, a
28d1da9ca818f831ea491f110dafcc10f7f07050coar cryptographic hash generated from the name
64ad864fa0f4493eebb181e393b40a8a90beccb9coar of the view.
28d1da9ca818f831ea491f110dafcc10f7f07050coar An existing NTA can be removed by using the
28d1da9ca818f831ea491f110dafcc10f7f07050coar An NTA's lifetime can be specified with the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <code class="option">-lifetime</code> option. TTL-style
64ad864fa0f4493eebb181e393b40a8a90beccb9coar suffixes can be used to specify the lifetime in
64ad864fa0f4493eebb181e393b40a8a90beccb9coar seconds, minutes, or hours. If the specified NTA
28d1da9ca818f831ea491f110dafcc10f7f07050coar already exists, its lifetime will be updated to the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar new value. Setting <code class="option">lifetime</code> to zero
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If <code class="option">-dump</code> is used, any other arguments
64ad864fa0f4493eebb181e393b40a8a90beccb9coar are ignored, and a list of existing NTAs is printed
64ad864fa0f4493eebb181e393b40a8a90beccb9coar (note that this may include NTAs that are expired but
28d1da9ca818f831ea491f110dafcc10f7f07050coar have not yet been cleaned up).
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Normally, <span><strong class="command">named</strong></span> will periodically
28d1da9ca818f831ea491f110dafcc10f7f07050coar test to see whether data below an NTA can now be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar validated (see the <code class="option">nta-recheck</code> option
64ad864fa0f4493eebb181e393b40a8a90beccb9coar in the Administrator Reference Manual for details).
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If data can be validated, then the NTA is regarded as
28d1da9ca818f831ea491f110dafcc10f7f07050coar no longer necessary, and will be allowed to expire
64ad864fa0f4493eebb181e393b40a8a90beccb9coar early. The <code class="option">-force</code> overrides this
64ad864fa0f4493eebb181e393b40a8a90beccb9coar behavior and forces an NTA to persist for its entire
64ad864fa0f4493eebb181e393b40a8a90beccb9coar lifetime, regardless of whether data could be
28d1da9ca818f831ea491f110dafcc10f7f07050coar validated if the NTA were not present.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar All of these options can be shortened, i.e., to
28d1da9ca818f831ea491f110dafcc10f7f07050coar <code class="option">-l</code>, <code class="option">-r</code>, <code class="option">-d</code>,
28d1da9ca818f831ea491f110dafcc10f7f07050coar<dt><span class="term"><strong class="userinput"><code>tsig-list</code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar List the names of all TSIG keys currently configured
64ad864fa0f4493eebb181e393b40a8a90beccb9coar for use by <span><strong class="command">named</strong></span> in each view. The
28d1da9ca818f831ea491f110dafcc10f7f07050coar list both statically configured keys and dynamic
64ad864fa0f4493eebb181e393b40a8a90beccb9coar TKEY-negotiated keys.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>tsig-delete</code></strong> <em class="replaceable"><code>keyname</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Delete a given TKEY-negotiated key from the server.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar (This does not apply to statically configured TSIG
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>addzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Add a zone while the server is running. This
64ad864fa0f4493eebb181e393b40a8a90beccb9coar command requires the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">allow-new-zones</strong></span> option to be set
64ad864fa0f4493eebb181e393b40a8a90beccb9coar to <strong class="userinput"><code>yes</code></strong>. The
28d1da9ca818f831ea491f110dafcc10f7f07050coar <em class="replaceable"><code>configuration</code></em> string
64ad864fa0f4493eebb181e393b40a8a90beccb9coar specified on the command line is the zone
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configuration text that would ordinarily be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar The configuration is saved in a file called
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
28d1da9ca818f831ea491f110dafcc10f7f07050coar where <em class="replaceable"><code>name</code></em> is the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar name of the view, or if it contains characters
64ad864fa0f4493eebb181e393b40a8a90beccb9coar that are incompatible with use as a file name, a
64ad864fa0f4493eebb181e393b40a8a90beccb9coar cryptographic hash generated from the name
28d1da9ca818f831ea491f110dafcc10f7f07050coar of the view.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar When <span><strong class="command">named</strong></span> is
64ad864fa0f4493eebb181e393b40a8a90beccb9coar restarted, the file will be loaded into the view
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configuration, so that zones that were added
28d1da9ca818f831ea491f110dafcc10f7f07050coar can persist after a restart.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar This sample <span><strong class="command">addzone</strong></span> command
64ad864fa0f4493eebb181e393b40a8a90beccb9coar would add the zone <code class="literal">example.com</code>
28d1da9ca818f831ea491f110dafcc10f7f07050coar to the default view:
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar (Note the brackets and semi-colon around the zone
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configuration text.)
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>modzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
28d1da9ca818f831ea491f110dafcc10f7f07050coar Modify the configuration of a zone while the server
64ad864fa0f4493eebb181e393b40a8a90beccb9coar is running. This command requires the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">allow-new-zones</strong></span> option to be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar set to <strong class="userinput"><code>yes</code></strong>. As with
28d1da9ca818f831ea491f110dafcc10f7f07050coar <span><strong class="command">addzone</strong></span>, the
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <em class="replaceable"><code>configuration</code></em> string
64ad864fa0f4493eebb181e393b40a8a90beccb9coar specified on the command line is the zone
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configuration text that would ordinarily be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If the zone was originally added via
28d1da9ca818f831ea491f110dafcc10f7f07050coar <span><strong class="command">rndc addzone</strong></span>, the configuration
64ad864fa0f4493eebb181e393b40a8a90beccb9coar changes will be recorded permanently and will still be
64ad864fa0f4493eebb181e393b40a8a90beccb9coar in effect after the server is restarted or reconfigured.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar However, if it was originally configured in
28d1da9ca818f831ea491f110dafcc10f7f07050coar <code class="filename">named.conf</code>, then that original
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configuration is still in place; when the server is
64ad864fa0f4493eebb181e393b40a8a90beccb9coar restarted or reconfigured, the zone will revert to
64ad864fa0f4493eebb181e393b40a8a90beccb9coar its original configuration. To make the changes
64ad864fa0f4493eebb181e393b40a8a90beccb9coar permanent, it must also be modified in
64ad864fa0f4493eebb181e393b40a8a90beccb9coar<dt><span class="term"><strong class="userinput"><code>delzone [<span class="optional">-clean</span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Delete a zone while the server is running.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If the <code class="option">-clean</code> is specified,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar the zone's master file (and journal file, if any)
64ad864fa0f4493eebb181e393b40a8a90beccb9coar will be deleted along with the zone. Without the
28d1da9ca818f831ea491f110dafcc10f7f07050coar <code class="option">-clean</code> option, zone files must
64ad864fa0f4493eebb181e393b40a8a90beccb9coar be cleaned up by hand. (If the zone is of
64ad864fa0f4493eebb181e393b40a8a90beccb9coar type "slave" or "stub", the files needing to
64ad864fa0f4493eebb181e393b40a8a90beccb9coar be cleaned up will be reported in the output
64ad864fa0f4493eebb181e393b40a8a90beccb9coar of the <span><strong class="command">rndc delzone</strong></span> command.)
64ad864fa0f4493eebb181e393b40a8a90beccb9coar If the zone was originally added via
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">rndc addzone</strong></span>, then it will be
28d1da9ca818f831ea491f110dafcc10f7f07050coar removed permanently. However, if it was originally
64ad864fa0f4493eebb181e393b40a8a90beccb9coar configured in <code class="filename">named.conf</code>, then
64ad864fa0f4493eebb181e393b40a8a90beccb9coar that original configuration is still in place; when
120ff80b38fc1f72cdc911d62bb249a7c0c7262bwrowe the server is restarted or reconfigured, the zone will
28d1da9ca818f831ea491f110dafcc10f7f07050coar come back. To remove it permanently, it must also be
28d1da9ca818f831ea491f110dafcc10f7f07050coar<dt><span class="term"><strong class="userinput"><code>showzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Print the configuration of a running zone.
28d1da9ca818f831ea491f110dafcc10f7f07050coar<dt><span class="term"><strong class="userinput"><code>signing [<span class="optional">( -list | -clear <em class="replaceable"><code>keyid/algorithm</code></em> | -clear <code class="literal">all</code> | -nsec3param ( <em class="replaceable"><code>parameters</code></em> | <code class="literal">none</code> ) | -serial <em class="replaceable"><code>value</code></em> ) </span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
64ad864fa0f4493eebb181e393b40a8a90beccb9coar List, edit, or remove the DNSSEC signing state records
64ad864fa0f4493eebb181e393b40a8a90beccb9coar for the specified zone. The status of ongoing DNSSEC
28d1da9ca818f831ea491f110dafcc10f7f07050coar operations (such as signing or generating
64ad864fa0f4493eebb181e393b40a8a90beccb9coar NSEC3 chains) is stored in the zone in the form
64ad864fa0f4493eebb181e393b40a8a90beccb9coar of DNS resource records of type
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">sig-signing-type</strong></span>.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">rndc signing -list</strong></span> converts
28d1da9ca818f831ea491f110dafcc10f7f07050coar these records into a human-readable form,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar indicating which keys are currently signing
64ad864fa0f4493eebb181e393b40a8a90beccb9coar or have finished signing the zone, and which NSEC3
64ad864fa0f4493eebb181e393b40a8a90beccb9coar chains are being created or removed.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">rndc signing -clear</strong></span> can remove
64ad864fa0f4493eebb181e393b40a8a90beccb9coar a single key (specified in the same format that
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">rndc signing -list</strong></span> uses to
28d1da9ca818f831ea491f110dafcc10f7f07050coar display it), or all keys. In either case, only
64ad864fa0f4493eebb181e393b40a8a90beccb9coar completed keys are removed; any record indicating
64ad864fa0f4493eebb181e393b40a8a90beccb9coar that a key has not yet finished signing the zone
64ad864fa0f4493eebb181e393b40a8a90beccb9coar will be retained.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">rndc signing -nsec3param</strong></span> sets
120ff80b38fc1f72cdc911d62bb249a7c0c7262bwrowe the NSEC3 parameters for a zone. This is the
28d1da9ca818f831ea491f110dafcc10f7f07050coar only supported mechanism for using NSEC3 with
64ad864fa0f4493eebb181e393b40a8a90beccb9coar <span><strong class="command">inline-signing</strong></span> zones.
64ad864fa0f4493eebb181e393b40a8a90beccb9coar Parameters are specified in the same format as
64ad864fa0f4493eebb181e393b40a8a90beccb9coar an NSEC3PARAM resource record: hash algorithm,
64ad864fa0f4493eebb181e393b40a8a90beccb9coar flags, iterations, and salt, in that order.
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj Currently, the only defined value for hash algorithm
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj is <code class="literal">1</code>, representing SHA-1.
d5defd5a0c5cdbaf74b85939484dc2b6c8317d19manoj <code class="literal">0</code> or <code class="literal">1</code>,
d5defd5a0c5cdbaf74b85939484dc2b6c8317d19manoj depending on whether you wish to set the opt-out
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj bit in the NSEC3 chain. <code class="option">iterations</code>
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj defines the number of additional times to apply
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj the algorithm when generating an NSEC3 hash. The
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj <code class="option">salt</code> is a string of data expressed
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj in hexadecimal, a hyphen (`-') if no salt is
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj to be used, or the keyword <code class="literal">auto</code>,
0bff2f28ef945280c17099c142126178a78e1e54manoj which causes <span><strong class="command">named</strong></span> to generate a
0bff2f28ef945280c17099c142126178a78e1e54manoj random 64-bit salt.
ec0315cdf832eac2b78e50ad636af84fe4c9118cgstein So, for example, to create an NSEC3 chain using
ec0315cdf832eac2b78e50ad636af84fe4c9118cgstein the SHA-1 hash algorithm, no opt-out flag,
ec0315cdf832eac2b78e50ad636af84fe4c9118cgstein 10 iterations, and a salt value of "FFFF", use:
ec0315cdf832eac2b78e50ad636af84fe4c9118cgstein <span><strong class="command">rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
ec0315cdf832eac2b78e50ad636af84fe4c9118cgstein To set the opt-out flag, 15 iterations, and no
ec0315cdf832eac2b78e50ad636af84fe4c9118cgstein <span><strong class="command">rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>.
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj <span><strong class="command">rndc signing -nsec3param none</strong></span>
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj removes an existing NSEC3 chain and replaces it
dbf0c7bef06259486cd2748a2d0e82f27e099d6efielding <span><strong class="command">rndc signing -serial value</strong></span> sets
dbf0c7bef06259486cd2748a2d0e82f27e099d6efielding the serial number of the zone to value. If the value
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj would cause the serial number to go backwards it will
670734c2ee137c587411795c6f82566c9d3729b7coar be rejected. The primary use is to set the serial on
3e17185356213124b2e18ecaf1678a676f8e9ba5rbb inline signed zones.
863ec32e13d6c9619414c48b51109f3dca99cbc6wrowe There is currently no way to provide the shared secret for a
863ec32e13d6c9619414c48b51109f3dca99cbc6wrowe <code class="option">key_id</code> without using the configuration file.
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj Several error messages could be clearer.
ae6907470ddf23ab7c6b506e6407cc5372f9c0dftrawick<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
ef7ff29d74b8684761de5758423f1cc5a49f48e3rbb <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
ef7ff29d74b8684761de5758423f1cc5a49f48e3rbb <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
ef7ff29d74b8684761de5758423f1cc5a49f48e3rbb <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
ef7ff29d74b8684761de5758423f1cc5a49f48e3rbb <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
2a6c49cfaef5979a5a06098f3ce987cd76769409manoj<p><span class="corpauthor">Internet Systems Consortium</span>