mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-08-30 22:15:20 +00:00
[master] add dnssec-keygen and nslookup man page links to ARM
This commit is contained in:
@@ -35,7 +35,7 @@
|
|||||||
- SUCH DAMAGE.
|
- SUCH DAMAGE.
|
||||||
-->
|
-->
|
||||||
<!-- Converted by db4-upgrade version 1.0 -->
|
<!-- Converted by db4-upgrade version 1.0 -->
|
||||||
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
|
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nslookup">
|
||||||
<info>
|
<info>
|
||||||
<date>2014-01-24</date>
|
<date>2014-01-24</date>
|
||||||
</info>
|
</info>
|
||||||
|
@@ -18398,12 +18398,14 @@ allow-query { !{ !10/8; any; }; key example; };
|
|||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/tools/mdig.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/tools/mdig.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dig/host.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dig/host.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/delv/delv.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/delv/delv.docbook"/>
|
||||||
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dig/nslookup.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/python/dnssec-checkds.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/python/dnssec-checkds.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/python/dnssec-coverage.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/python/dnssec-coverage.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-dsfromkey.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-dsfromkey.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-importkey.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-importkey.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-keyfromlabel.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-keyfromlabel.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-keygen.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-keygen.docbook"/>
|
||||||
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/python/dnssec-keymgr.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-revoke.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-revoke.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-settime.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-settime.docbook"/>
|
||||||
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-signzone.docbook"/>
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../bin/dnssec/dnssec-signzone.docbook"/>
|
||||||
|
313
doc/arm/man.dnssec-keymgr.html
Normal file
313
doc/arm/man.dnssec-keymgr.html
Normal file
@@ -0,0 +1,313 @@
|
|||||||
|
<!--
|
||||||
|
- Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
|
||||||
|
-
|
||||||
|
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
-->
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||||
|
<title>dnssec-keymgr</title>
|
||||||
|
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
||||||
|
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
|
||||||
|
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
|
||||||
|
<link rel="prev" href="man.dnssec-keygen.html" title="dnssec-keygen">
|
||||||
|
<link rel="next" href="man.dnssec-revoke.html" title="dnssec-revoke">
|
||||||
|
</head>
|
||||||
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||||
|
<div class="navheader">
|
||||||
|
<table width="100%" summary="Navigation header">
|
||||||
|
<tr><th colspan="3" align="center"><span class="application">dnssec-keymgr</span></th></tr>
|
||||||
|
<tr>
|
||||||
|
<td width="20%" align="left">
|
||||||
|
<a accesskey="p" href="man.dnssec-keygen.html">Prev</a><EFBFBD></td>
|
||||||
|
<th width="60%" align="center">Manual pages</th>
|
||||||
|
<td width="20%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-revoke.html">Next</a>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
</div>
|
||||||
|
<div class="refentry">
|
||||||
|
<a name="man.dnssec-keymgr"></a><div class="titlepage"></div>
|
||||||
|
<div class="refnamediv">
|
||||||
|
<h2>Name</h2>
|
||||||
|
<p><span class="application">dnssec-keymgr</span> — Ensures correct DNSKEY coverage for a zone based on a defined policy</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsynopsisdiv">
|
||||||
|
<h2>Synopsis</h2>
|
||||||
|
<div class="cmdsynopsis"><p><code class="command">dnssec-keymgr</code> [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-c <em class="replaceable"><code>file</code></em></code>] [<code class="option">-f</code>] [<code class="option">-k</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-z</code>] [<code class="option">-g <em class="replaceable"><code>path</code></em></code>] [<code class="option">-r <em class="replaceable"><code>path</code></em></code>] [<code class="option">-s <em class="replaceable"><code>path</code></em></code>] [zone...]</p></div>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.12.7"></a><h2>DESCRIPTION</h2>
|
||||||
|
<p>
|
||||||
|
<span class="command"><strong>dnssec-keymgr</strong></span> is a high level Python wrapper
|
||||||
|
to facilitate the key rollover process for zones handled by
|
||||||
|
BIND. It uses the BIND commands for manipulating DNSSEC key
|
||||||
|
metadata: <span class="command"><strong>dnssec-keygen</strong></span> and
|
||||||
|
<span class="command"><strong>dnssec-settime</strong></span>.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
DNSSEC policy can be read from a configuration file (default
|
||||||
|
<code class="filename">/etc/dnssec.policy</code>), from which the key
|
||||||
|
parameters, publication and rollover schedule, and desired
|
||||||
|
coverage duration for any given zone can be determined. This
|
||||||
|
file may be used to define individual DNSSEC policies on a
|
||||||
|
per-zone basis, or to set a default policy used for all zones.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
When <span class="command"><strong>dnssec-keymgr</strong></span> runs, it examines the DNSSEC
|
||||||
|
keys for one or more zones, comparing their timing metadata against
|
||||||
|
the policies for those zones. If key settings do not conform to the
|
||||||
|
DNSSEC policy (for example, because the policy has been changed),
|
||||||
|
they are automatically corrected.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
A zone policy can specify a duration for which we want to
|
||||||
|
ensure the key correctness (<code class="option">coverage</code>). It can
|
||||||
|
also specify a rollover period (<code class="option">roll-period</code>).
|
||||||
|
If policy indicates that a key should roll over before the
|
||||||
|
coverage period ends, then a successor key will automatically be
|
||||||
|
created and added to the end of the key series.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
If zones are specified on the command line,
|
||||||
|
<span class="command"><strong>dnssec-keymgr</strong></span> will examine only those zones.
|
||||||
|
If a specified zone does not already have keys in place, then
|
||||||
|
keys will be generated for it according to policy.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
If zones are <span class="emphasis"><em>not</em></span> specified on the command
|
||||||
|
line, then <span class="command"><strong>dnssec-keymgr</strong></span> will search the
|
||||||
|
key directory (either the current working directory or the directory
|
||||||
|
set by the <code class="option">-K</code> option), and check the keys for
|
||||||
|
all the zones represented in the directory.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
It is expected that this tool will be run automatically and
|
||||||
|
unattended (for example, by <span class="command"><strong>cron</strong></span>).
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.12.8"></a><h2>OPTIONS</h2>
|
||||||
|
<div class="variablelist"><dl class="variablelist">
|
||||||
|
<dt><span class="term">-c <em class="replaceable"><code>file</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
If <code class="option">-c</code> is specified, then the DNSSEC
|
||||||
|
policy is read from <code class="option">file</code>. (If not
|
||||||
|
specified, then the policy is read from
|
||||||
|
<code class="filename">/etc/policy.conf</code>; if that file
|
||||||
|
doesn't exist, a built-in global default policy is used.)
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-f</span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Force: allow updating of key events even if they are
|
||||||
|
already in the past. This is not recommended for use with
|
||||||
|
zones in which keys have already been published. However,
|
||||||
|
if a set of keys has been generated all of which have
|
||||||
|
publication and activation dates in the past, but the
|
||||||
|
keys have not been published in a zone as yet, then this
|
||||||
|
option can be used to clean them up and turn them into a
|
||||||
|
proper series of keys with appropriate rollover intervals.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-g <em class="replaceable"><code>keygen-path</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Specifies a path to a <span class="command"><strong>dnssec-keygen</strong></span> binary.
|
||||||
|
Used for testing.
|
||||||
|
See also the <code class="option">-s</code> option.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-h</span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Print the <span class="command"><strong>dnssec-keymgr</strong></span> help summary
|
||||||
|
and exit.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Sets the directory in which keys can be found. Defaults to the
|
||||||
|
current working directory.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-k</span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Only apply policies to KSK keys.
|
||||||
|
See also the <code class="option">-z</code> option.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-q</span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Quiet: suppress printing of <span class="command"><strong>dnssec-keygen</strong></span>
|
||||||
|
and <span class="command"><strong>dnssec-settime</strong></span>.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-r <em class="replaceable"><code>randomdev</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Specifies a path to a file containing random data.
|
||||||
|
This is passed to the <span class="command"><strong>dnssec-keygen</strong></span> binary
|
||||||
|
using its <code class="option">-r</code> option.
|
||||||
|
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-s <em class="replaceable"><code>settime-path</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Specifies a path to a <span class="command"><strong>dnssec-settime</strong></span> binary.
|
||||||
|
Used for testing.
|
||||||
|
See also the <code class="option">-g</code> option.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-v</span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Print the <span class="command"><strong>dnssec-keymgr</strong></span> version and exit.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term">-z</span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Only apply policies to ZSK keys.
|
||||||
|
See also the <code class="option">-k</code> option.
|
||||||
|
</p></dd>
|
||||||
|
</dl></div>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.12.9"></a><h2>POLICY CONFIGURATION</h2>
|
||||||
|
<p>
|
||||||
|
The <code class="filename">policy.conf</code> file can specify three kinds
|
||||||
|
of policies:
|
||||||
|
</p>
|
||||||
|
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
||||||
|
<li class="listitem"><p>
|
||||||
|
<span class="emphasis"><em>Policy classes</em></span>
|
||||||
|
(<code class="option">policy <em class="replaceable"><code>name</code></em> { ... };</code>)
|
||||||
|
can be inherited by zone policies or other policy classes; these
|
||||||
|
can be used to create sets of different security profiles. For
|
||||||
|
example, a policy class <strong class="userinput"><code>normal</code></strong> might specify
|
||||||
|
1024-bit key sizes, but a class <strong class="userinput"><code>extra</code></strong> might
|
||||||
|
specify 2048 bits instead; <strong class="userinput"><code>extra</code></strong> would be
|
||||||
|
used for zones that had unusually high security needs.
|
||||||
|
</p></li>
|
||||||
|
<li class="listitem"><p>
|
||||||
|
Algorithm policies:
|
||||||
|
(<code class="option">algorithm-policy <em class="replaceable"><code>algorithm</code></em> { ... };</code> )
|
||||||
|
override default per-algorithm settings. For example, by default,
|
||||||
|
RSASHA256 keys use 2048-bit key sizes for both KSK and ZSK. This
|
||||||
|
can be modified using <span class="command"><strong>algorithm-policy</strong></span>, and the
|
||||||
|
new key sizes would then be used for any key of type RSASHA256.
|
||||||
|
</p></li>
|
||||||
|
<li class="listitem"><p>
|
||||||
|
Zone policies:
|
||||||
|
(<code class="option">zone <em class="replaceable"><code>name</code></em> { ... };</code> )
|
||||||
|
set policy for a single zone by name. A zone policy can inherit
|
||||||
|
a policy class by including a <code class="option">policy</code> option.
|
||||||
|
</p></li>
|
||||||
|
</ul></div>
|
||||||
|
<p>
|
||||||
|
Options that can be specified in policies:
|
||||||
|
</p>
|
||||||
|
<div class="variablelist"><dl class="variablelist">
|
||||||
|
<dt><span class="term"><span class="command"><strong>algorithm</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
The key algorithm. If no policy is defined, the default is
|
||||||
|
RSASHA256.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>coverage</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
The length of time to ensure that keys will be correct; no action
|
||||||
|
will be taken to create new keys to be activated after this time.
|
||||||
|
This can be represented as a number of seconds, or as a duration using
|
||||||
|
human-readable units (examples: "1y" or "6 months").
|
||||||
|
A default value for this option can be set in algorithm policies
|
||||||
|
as well as in policy classes or zone policies.
|
||||||
|
If no policy is configured, the default is six months.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>directory</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Specifies the directory in which keys should be stored.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>key-size</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Specifies the number of bits to use in creating keys.
|
||||||
|
Takes two arguments: keytype (eihter "zsk" or "ksk") and size.
|
||||||
|
A default value for this option can be set in algorithm policies
|
||||||
|
as well as in policy classes or zone policies. If no policy is
|
||||||
|
configured, the default is 1024 bits for DSA keys and 2048 for
|
||||||
|
RSA.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>keyttl</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
The key TTL. If no policy is defined, the default is one hour.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>post-publish</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
How long after inactivation a key should be deleted from the zone.
|
||||||
|
Note: If <code class="option">roll-period</code> is not set, this value is
|
||||||
|
ignored. Takes two arguments: keytype (eihter "zsk" or "ksk") and a
|
||||||
|
duration. A default value for this option can be set in algorithm
|
||||||
|
policies as well as in policy classes or zone policies. The default
|
||||||
|
is one month.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>pre-publish</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
How long before activation a key should be published. Note: If
|
||||||
|
<code class="option">roll-period</code> is not set, this value is ignored.
|
||||||
|
Takes two arguments: keytype (either "zsk" or "ksk") and a duration.
|
||||||
|
A default value for this option can be set in algorithm policies
|
||||||
|
as well as in policy classes or zone policies. The default is
|
||||||
|
one month.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>roll-period</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
How frequently keys should be rolled over.
|
||||||
|
Takes two arguments: keytype (eihter "zsk" or "ksk") and a duration.
|
||||||
|
A default value for this option can be set in algorithm policies
|
||||||
|
as well as in policy classes or zone policies. If no policy is
|
||||||
|
configured, the default is one year for ZSK's. KSK's do not
|
||||||
|
roll over by default.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><span class="command"><strong>standby</strong></span></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Not yet implemented.
|
||||||
|
</p></dd>
|
||||||
|
</dl></div>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.12.10"></a><h2>REMAINING WORK</h2>
|
||||||
|
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
||||||
|
<li class="listitem"><p>
|
||||||
|
Enable scheduling of KSK rollovers using the <code class="option">-P sync</code>
|
||||||
|
and <code class="option">-D sync</code> options to
|
||||||
|
<span class="command"><strong>dnssec-keygen</strong></span> and
|
||||||
|
<span class="command"><strong>dnssec-settime</strong></span>. Check the parent zone
|
||||||
|
(as in <span class="command"><strong>dnssec-checkds</strong></span>) to determine when it's
|
||||||
|
safe for the key to roll.
|
||||||
|
</p></li>
|
||||||
|
<li class="listitem"><p>
|
||||||
|
Allow configuration of standby keys and use of the REVOKE bit,
|
||||||
|
for keys that use RFC 5011 semantics.
|
||||||
|
</p></li>
|
||||||
|
</ul></div>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.12.11"></a><h2>SEE ALSO</h2>
|
||||||
|
<p>
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">dnssec-coverage</span>(8)</span>,
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">dnssec-settime</span>(8)</span>,
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">dnssec-checkds</span>(8)</span>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="navfooter">
|
||||||
|
<hr>
|
||||||
|
<table width="100%" summary="Navigation footer">
|
||||||
|
<tr>
|
||||||
|
<td width="40%" align="left">
|
||||||
|
<a accesskey="p" href="man.dnssec-keygen.html">Prev</a><EFBFBD></td>
|
||||||
|
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
|
||||||
|
<td width="40%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-revoke.html">Next</a>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td width="40%" align="left" valign="top">
|
||||||
|
<span class="application">dnssec-keygen</span><EFBFBD></td>
|
||||||
|
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
|
||||||
|
<td width="40%" align="right" valign="top"><EFBFBD><span class="application">dnssec-revoke</span>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0a3</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
350
doc/arm/man.nslookup.html
Normal file
350
doc/arm/man.nslookup.html
Normal file
@@ -0,0 +1,350 @@
|
|||||||
|
<!--
|
||||||
|
- Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
|
||||||
|
-
|
||||||
|
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
-->
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||||
|
<title>nslookup</title>
|
||||||
|
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
||||||
|
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
|
||||||
|
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
|
||||||
|
<link rel="prev" href="man.delv.html" title="delv">
|
||||||
|
<link rel="next" href="man.dnssec-checkds.html" title="dnssec-checkds">
|
||||||
|
</head>
|
||||||
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||||
|
<div class="navheader">
|
||||||
|
<table width="100%" summary="Navigation header">
|
||||||
|
<tr><th colspan="3" align="center">nslookup</th></tr>
|
||||||
|
<tr>
|
||||||
|
<td width="20%" align="left">
|
||||||
|
<a accesskey="p" href="man.delv.html">Prev</a><EFBFBD></td>
|
||||||
|
<th width="60%" align="center">Manual pages</th>
|
||||||
|
<td width="20%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-checkds.html">Next</a>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<hr>
|
||||||
|
</div>
|
||||||
|
<div class="refentry">
|
||||||
|
<a name="man.nslookup"></a><div class="titlepage"></div>
|
||||||
|
<div class="refnamediv">
|
||||||
|
<h2>Name</h2>
|
||||||
|
<p>nslookup — query Internet name servers interactively</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsynopsisdiv">
|
||||||
|
<h2>Synopsis</h2>
|
||||||
|
<div class="cmdsynopsis"><p><code class="command">nslookup</code> [<code class="option">-option</code>] [name | -] [server]</p></div>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.6.7"></a><h2>DESCRIPTION</h2>
|
||||||
|
<p><span class="command"><strong>Nslookup</strong></span>
|
||||||
|
is a program to query Internet domain name servers. <span class="command"><strong>Nslookup</strong></span>
|
||||||
|
has two modes: interactive and non-interactive. Interactive mode allows
|
||||||
|
the user to query name servers for information about various hosts and
|
||||||
|
domains or to print a list of hosts in a domain. Non-interactive mode
|
||||||
|
is
|
||||||
|
used to print just the name and requested information for a host or
|
||||||
|
domain.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.6.8"></a><h2>ARGUMENTS</h2>
|
||||||
|
<p>
|
||||||
|
Interactive mode is entered in the following cases:
|
||||||
|
</p>
|
||||||
|
<div class="orderedlist"><ol class="orderedlist" type="a">
|
||||||
|
<li class="listitem"><p>
|
||||||
|
when no arguments are given (the default name server will be used)
|
||||||
|
</p></li>
|
||||||
|
<li class="listitem"><p>
|
||||||
|
when the first argument is a hyphen (-) and the second argument is
|
||||||
|
the host name or Internet address of a name server.
|
||||||
|
</p></li>
|
||||||
|
</ol></div>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Non-interactive mode is used when the name or Internet address of the
|
||||||
|
host to be looked up is given as the first argument. The optional second
|
||||||
|
argument specifies the host name or address of a name server.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Options can also be specified on the command line if they precede the
|
||||||
|
arguments and are prefixed with a hyphen. For example, to
|
||||||
|
change the default query type to host information, and the initial
|
||||||
|
timeout to 10 seconds, type:
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<pre class="programlisting">
|
||||||
|
nslookup -query=hinfo -timeout=10
|
||||||
|
</pre>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The <code class="option">-version</code> option causes
|
||||||
|
<span class="command"><strong>nslookup</strong></span> to print the version
|
||||||
|
number and immediately exits.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.6.9"></a><h2>INTERACTIVE COMMANDS</h2>
|
||||||
|
<div class="variablelist"><dl class="variablelist">
|
||||||
|
<dt><span class="term"><code class="constant">host</code> [<span class="optional">server</span>]</span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Look up information for host using the current default server or
|
||||||
|
using server, if specified. If host is an Internet address and
|
||||||
|
the query type is A or PTR, the name of the host is returned.
|
||||||
|
If host is a name and does not have a trailing period, the
|
||||||
|
search list is used to qualify the name.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
To look up a host not in the current domain, append a period to
|
||||||
|
the name.
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">server</code> <em class="replaceable"><code>domain</code></em></span></dt>
|
||||||
|
<dd><p></p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">lserver</code> <em class="replaceable"><code>domain</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Change the default server to <em class="replaceable"><code>domain</code></em>; <code class="constant">lserver</code> uses the initial
|
||||||
|
server to look up information about <em class="replaceable"><code>domain</code></em>, while <code class="constant">server</code> uses
|
||||||
|
the current default server. If an authoritative answer can't be
|
||||||
|
found, the names of servers that might have the answer are
|
||||||
|
returned.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">root</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
not implemented
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">finger</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
not implemented
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">ls</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
not implemented
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">view</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
not implemented
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">help</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
not implemented
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">?</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
not implemented
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">exit</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Exits the program.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">set</code>
|
||||||
|
<em class="replaceable"><code>keyword[<span class="optional">=value</span>]</code></em></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
This command is used to change state information that affects
|
||||||
|
the lookups. Valid keywords are:
|
||||||
|
</p>
|
||||||
|
<div class="variablelist"><dl class="variablelist">
|
||||||
|
<dt><span class="term"><code class="constant">all</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Prints the current values of the frequently used
|
||||||
|
options to <span class="command"><strong>set</strong></span>.
|
||||||
|
Information about the current default
|
||||||
|
server and host is also printed.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">class=</code><em class="replaceable"><code>value</code></em></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Change the query class to one of:
|
||||||
|
</p>
|
||||||
|
<div class="variablelist"><dl class="variablelist">
|
||||||
|
<dt><span class="term"><code class="constant">IN</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
the Internet class
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">CH</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
the Chaos class
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">HS</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
the Hesiod class
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">ANY</code></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
wildcard
|
||||||
|
</p></dd>
|
||||||
|
</dl></div>
|
||||||
|
<p>
|
||||||
|
The class specifies the protocol group of the information.
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = IN; abbreviation = cl)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">
|
||||||
|
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>debug</code></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Turn on or off the display of the full response packet and
|
||||||
|
any intermediate response packets when searching.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = nodebug; abbreviation = [<span class="optional">no</span>]deb)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">
|
||||||
|
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>d2</code></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Turn debugging mode on or off. This displays more about
|
||||||
|
what nslookup is doing.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = nod2)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">domain=</code><em class="replaceable"><code>name</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Sets the search list to <em class="replaceable"><code>name</code></em>.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">
|
||||||
|
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>search</code></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
If the lookup request contains at least one period but
|
||||||
|
doesn't end with a trailing period, append the domain
|
||||||
|
names in the domain search list to the request until an
|
||||||
|
answer is received.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = search)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">port=</code><em class="replaceable"><code>value</code></em></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Change the default TCP/UDP name server port to <em class="replaceable"><code>value</code></em>.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = 53; abbreviation = po)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">querytype=</code><em class="replaceable"><code>value</code></em></span></dt>
|
||||||
|
<dd><p></p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">type=</code><em class="replaceable"><code>value</code></em></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Change the type of the information query.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = A; abbreviations = q, ty)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">
|
||||||
|
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>recurse</code></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Tell the name server to query other servers if it does not
|
||||||
|
have the
|
||||||
|
information.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = recurse; abbreviation = [no]rec)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">ndots=</code><em class="replaceable"><code>number</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Set the number of dots (label separators) in a domain
|
||||||
|
that will disable searching. Absolute names always
|
||||||
|
stop searching.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">retry=</code><em class="replaceable"><code>number</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Set the number of retries to number.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">timeout=</code><em class="replaceable"><code>number</code></em></span></dt>
|
||||||
|
<dd><p>
|
||||||
|
Change the initial timeout interval for waiting for a
|
||||||
|
reply to number seconds.
|
||||||
|
</p></dd>
|
||||||
|
<dt><span class="term"><code class="constant">
|
||||||
|
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>vc</code></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Always use a virtual circuit when sending requests to the
|
||||||
|
server.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = novc)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
<dt><span class="term"><code class="constant">
|
||||||
|
<em class="replaceable"><code>[<span class="optional">no</span>]</code></em>fail</code></span></dt>
|
||||||
|
<dd>
|
||||||
|
<p>
|
||||||
|
Try the next nameserver if a nameserver responds with
|
||||||
|
SERVFAIL or a referral (nofail) or terminate query
|
||||||
|
(fail) on such a response.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
(Default = nofail)
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
</dl></div>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</dd>
|
||||||
|
</dl></div>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.6.10"></a><h2>RETURN VALUES</h2>
|
||||||
|
<p>
|
||||||
|
<span class="command"><strong>nslookup</strong></span> returns with an exit status of 1
|
||||||
|
if any query failed, and 0 otherwise.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.6.11"></a><h2>FILES</h2>
|
||||||
|
<p><code class="filename">/etc/resolv.conf</code>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="refsection">
|
||||||
|
<a name="id-1.14.6.12"></a><h2>SEE ALSO</h2>
|
||||||
|
<p><span class="citerefentry"><span class="refentrytitle">dig</span>(1)</span>,
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">host</span>(1)</span>,
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="navfooter">
|
||||||
|
<hr>
|
||||||
|
<table width="100%" summary="Navigation footer">
|
||||||
|
<tr>
|
||||||
|
<td width="40%" align="left">
|
||||||
|
<a accesskey="p" href="man.delv.html">Prev</a><EFBFBD></td>
|
||||||
|
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
|
||||||
|
<td width="40%" align="right"><EFBFBD><a accesskey="n" href="man.dnssec-checkds.html">Next</a>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td width="40%" align="left" valign="top">delv<EFBFBD></td>
|
||||||
|
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
|
||||||
|
<td width="40%" align="right" valign="top"><EFBFBD><span class="application">dnssec-checkds</span>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0a3</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
Reference in New Issue
Block a user