kea-netconf.xml 6.6 KB
Newer Older
1
<!--
2
 - Copyright (C) 2018 Internet Systems Consortium, Inc. ("ISC")
3 4 5 6 7 8 9 10 11 12
 -
 - 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/.
-->
<!-- Converted by db4-upgrade version 1.1 -->
<refentry>

  <info>
    <productname>ISC Kea</productname>
13 14
    <date>Nov. 9, 2018</date>
    <edition>1.5.0-beta</edition>
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
    <author>
      <contrib>The Kea software has been written by a number of
        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
        chronological order in which the authors made their first
        contribution. For a complete list of authors and
        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
  </info>

  <refmeta>
    <refentrytitle>kea-netconf</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="manual">Kea</refmiscinfo>
  </refmeta>

  <refnamediv>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
32 33
    <refname>kea-netconf</refname>
    <refpurpose>NETCONF agent for Kea environment</refpurpose>
34 35 36 37
  </refnamediv>

  <docinfo>
    <copyright>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
38
      <year>2018</year>
39 40 41 42 43 44
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis sepchar=" ">
45
      <command>kea-netconf</command>
46 47
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
48
      <arg choice="opt" rep="norepeat"><option>-W</option></arg>
49 50
      <arg choice="opt" rep="norepeat"><option>-d</option></arg>
      <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
51
      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">config-file</replaceable></option></arg>
52 53 54 55 56 57
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
58
      The <command>kea-netconf</command> agent provides a YANG/NETCONF
Tomek Mrugalski's avatar
Tomek Mrugalski committed
59
      interface for the Kea environment.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
    </para>

  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

    <para>The arguments are as follows:</para>

    <variablelist>

      <varlistentry>
        <term><option>-v</option></term>
        <listitem><para>
          Display the version.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-V</option></term>
        <listitem><para>
          Display the extended version.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-W</option></term>
        <listitem><para>
          Display the configuration report.
        </para></listitem>
90
      </varlistentry>
91 92 93 94 95 96 97 98 99 100 101

      <varlistentry>
        <term><option>-d</option></term>
        <listitem><para>
          Enable the debug mode with extra verbosity.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c</option></term>
        <listitem><para>
102 103 104 105 106 107 108 109 110 111 112
          Configuration file including the configuration for NETCONF agent.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t</option></term>
        <listitem><para>
            Check the syntax of the configuration file and report the
            first error if any. Note that not all parameters are
            completely checked, in particular, service and client
            sockets are not opened, and hook libraries are not loaded.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
        </para></listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>DOCUMENTATION</title>
    <para>Kea comes with an extensive Kea User's Guide documentation
      that covers all aspects of running the Kea software -
      compilation, installation, configuration, configuration examples
      and many more. Kea also features a Kea Messages Manual, which
      lists all possible messages Kea can print with a brief
      description for each of them. Both documents are typically
      available in various formats (txt, html, pdf) with your Kea
      distribution. The on-line version is available at
129
      http://oldkea.isc.org/docs/.</para>
130 131
    <para>
      Kea source code is documented in the Kea Developer's Guide. It's
132
      on-line version is available at http://oldkea.isc.org. Please
133 134 135
      follow Developer's Guide link.
    </para>
    <para>
136
      Kea project website is available at: http://oldkea.isc.org.
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
    </para>
  </refsect1>

  <refsect1>
    <title>MAILING LISTS AND SUPPORT</title>
    <para>
      There are two mailing lists available for Kea project. kea-users
      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
      contributors and other advanced users.  Both lists are available at
      http://lists.isc.org. The community provides best effort type of support
      on both of those lists.
    </para>
    <para>
      ISC provides professional support for Kea services. See
      https://www.isc.org/kea/ for details.
    </para>
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
159 160 161 162
      Early prototypes of kea-netconf implementation were written during IETF
      Hackathons in Berlin, London and Montreal. An actual production ready
      implementation was started in August 2018 by Tomek Mrugalski and Francis
      Dupont.
163 164 165 166 167 168
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
169 170 171 172 173
      <citerefentry>
        <refentrytitle>kea-dhcp4</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
      <citerefentry>
        <refentrytitle>kea-dhcp6</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-dhcp-ddns</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-ctrl-agent</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-admin</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>keactrl</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>perfdhcp</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-lfc</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citetitle>Kea Administrator's Guide</citetitle>.

    </para>
  </refsect1>

</refentry>