diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 11:36:04 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 11:36:04 +0000 |
commit | 040eee1aa49b49df4698d83a05af57c220127fd1 (patch) | |
tree | f635435954e6ccde5eee9893889e24f30ca68346 /doc/sphinx/man/kea-netconf.8.rst | |
parent | Initial commit. (diff) | |
download | isc-kea-040eee1aa49b49df4698d83a05af57c220127fd1.tar.xz isc-kea-040eee1aa49b49df4698d83a05af57c220127fd1.zip |
Adding upstream version 2.2.0.upstream/2.2.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/sphinx/man/kea-netconf.8.rst')
-rw-r--r-- | doc/sphinx/man/kea-netconf.8.rst | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/sphinx/man/kea-netconf.8.rst b/doc/sphinx/man/kea-netconf.8.rst new file mode 100644 index 0000000..9029d01 --- /dev/null +++ b/doc/sphinx/man/kea-netconf.8.rst @@ -0,0 +1,95 @@ +.. + Copyright (C) 2019-2021 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 configuring Kea +--------------------------------------------------- + +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://kea.readthedocs.io. + +Kea source code is documented in the Kea Developer's Guide, +available at https://reports.kea.isc.org/dev_guide/. + +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. |