2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-28 20:47:48 +00:00
kea/doc/sphinx/man/kea-netconf.8.rst

96 lines
3.0 KiB
ReStructuredText

..
Copyright (C) 2019 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/.
See the COPYRIGHT file distributed with this work for additional
information regarding copyright ownership.
kea-netconf - NETCONF agent for Kea environment
-----------------------------------------------
Synopsis
~~~~~~~~
:program:`kea-netconf` [**-v**] [**-V**] [**-W**] [**-d**] [**-c** config-file] [**-t** config-file]
Description
~~~~~~~~~~~
The ``kea-netconf`` agent provides a YANG/NETCONF interface for the Kea
environment.
Arguments
~~~~~~~~~
The arguments are as follows:
``-v``
Displays the version.
``-V``
Displays the extended version.
``-W``
Displays the configuration report.
``-d``
Enables the debug mode with extra verbosity.
``-c config-file``
Specifies the file with the configuration for the NETCONF agent.
``-t config-file``
Checks the syntax of the configuration file and reports 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.
Documentation
~~~~~~~~~~~~~
Kea comes with an extensive Kea Administrator Reference Manual that covers
all aspects of running the Kea software - compilation, installation,
configuration, configuration examples, and much 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
available in various formats (.txt, .html, .pdf) with the Kea
distribution. The Kea documentation is available at
https://kb.isc.org/docs/kea-administrator-reference-manual .
Kea source code is documented in the Kea Developer's Guide. Its online
version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
The Kea project website is available at https://kea.isc.org.
Mailing Lists and Support
~~~~~~~~~~~~~~~~~~~~~~~~~
There are two public mailing lists available for the 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
https://lists.isc.org. The community provides best-effort support
on both of those lists.
ISC provides professional support for Kea services. See
https://www.isc.org/kea/ for details.
History
~~~~~~~
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.
See Also
~~~~~~~~
:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`, :manpage:`kea-dhcp-ddns(8)`,
:manpage:`kea-ctrl-agent(8)`, :manpage:`kea-admin(8)`, :manpage:`keactrl(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-lfc(8)`, Kea Administrator Reference Manual.