contrib/bind9/bin/dnssec/dnssec-importkey.html

   1 <!--
   2  - Copyright (C) 2013  Internet Systems Consortium, Inc. ("ISC")
   3  -
   4  - Permission to use, copy, modify, and/or distribute this software for any
   5  - purpose with or without fee is hereby granted, provided that the above
   6  - copyright notice and this permission notice appear in all copies.
   7  -
   8  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14  - PERFORMANCE OF THIS SOFTWARE.
  15 -->
  16
  17 <!-- $Id$ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>dnssec-importkey</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
  25 <a name="man.dnssec-importkey"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p><span class="application">dnssec-importkey</span> &#8212; Import DNSKEY records from external systems so they can be managed.</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <div class="cmdsynopsis"><p><code class="command">dnssec-importkey</code>  [<code class="option">-f <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-K <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-P <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-D <em class="replaceable"><code>date/offset</code></em></code>] [<code class="option">-h</code>] [<code class="option">-v <em class="replaceable"><code>level</code></em></code>] [<code class="option">keyname</code>]</p></div>
  33 </div>
  34 <div class="refsect1">
  35 <a name="idp5321760"></a><h2>DESCRIPTION</h2>
  36 <p><span class="command"><strong>dnssec-importkey</strong></span>
  37       read a DNSKEY record and generated a .key/.private key pair.
  38       Publication (<code class="option">-P</code>) and deletions (<code class="option">-D</code>)
  39       times can be set for the key.
  40     </p>
  41 </div>
  42 <div class="refsect1">
  43 <a name="idp5324080"></a><h2>OPTIONS</h2>
  44 <div class="variablelist"><dl class="variablelist">
  45 <dt><span class="term">-f <em class="replaceable"><code>filename</code></em></span></dt>
  46 <dd><p>
  47             Filename to read the key from.
  48           </p></dd>
  49 <dt><span class="term">-K <em class="replaceable"><code>directory</code></em></span></dt>
  50 <dd><p>
  51             Sets the directory in which the key files are to reside.
  52           </p></dd>
  53 <dt><span class="term">-L <em class="replaceable"><code>ttl</code></em></span></dt>
  54 <dd><p>
  55             Sets the default TTL to use for this key when it is converted
  56             into a DNSKEY RR.  If the key is imported into a zone,
  57             this is the TTL that will be used for it, unless there was
  58             already a DNSKEY RRset in place, in which case the existing TTL
  59             would take precedence.  importkey the default TTL to
  60             <code class="literal">0</code> or <code class="literal">none</code> removes it.
  61           </p></dd>
  62 <dt><span class="term">-h</span></dt>
  63 <dd><p>
  64             Emit usage message and exit.
  65           </p></dd>
  66 <dt><span class="term">-v <em class="replaceable"><code>level</code></em></span></dt>
  67 <dd><p>
  68             Sets the debugging level.
  69           </p></dd>
  70 </dl></div>
  71 </div>
  72 <div class="refsect1">
  73 <a name="idp5336224"></a><h2>TIMING OPTIONS</h2>
  74 <p>
  75       Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS.
  76       If the argument begins with a '+' or '-', it is interpreted as
  77       an offset from the present time.  For convenience, if such an offset
  78       is followed by one of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi',
  79       then the offset is computed in years (defined as 365 24-hour days,
  80       ignoring leap years), months (defined as 30 24-hour days), weeks,
  81       days, hours, or minutes, respectively.  Without a suffix, the offset
  82       is computed in seconds.  To unset a date, use 'none'.
  83     </p>
  84 <div class="variablelist"><dl class="variablelist">
  85 <dt><span class="term">-P <em class="replaceable"><code>date/offset</code></em></span></dt>
  86 <dd><p>
  87             Sets the date on which a key is to be published to the zone.
  88             After that date, the key will be included in the zone but will
  89             not be used to sign it.
  90           </p></dd>
  91 <dt><span class="term">-D <em class="replaceable"><code>date/offset</code></em></span></dt>
  92 <dd><p>
  93             Sets the date on which the key is to be deleted.  After that
  94             date, the key will no longer be included in the zone.  (It
  95             may remain in the key repository, however.)
  96           </p></dd>
  97 </dl></div>
  98 </div>
  99 <div class="refsect1">
 100 <a name="idp5342816"></a><h2>SEE ALSO</h2>
 101 <p><span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>,
 102       <span class="citerefentry"><span class="refentrytitle">dnssec-signzone</span>(8)</span>,
 103       <em class="citetitle">BIND 9 Administrator Reference Manual</em>,
 104       <em class="citetitle">RFC 5011</em>.
 105     </p>
 106 </div>
 107 <div class="refsect1">
 108 <a name="idp5346704"></a><h2>AUTHOR</h2>
 109 <p><span class="corpauthor">Internet Systems Consortium</span>
 110     </p>
 111 </div>
 112 </div></body>
 113 </html>