diff options
Diffstat (limited to 'doc/sphinx/_build/man/kea-ctrl-agent.8')
| -rw-r--r-- | doc/sphinx/_build/man/kea-ctrl-agent.8 | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/sphinx/_build/man/kea-ctrl-agent.8 b/doc/sphinx/_build/man/kea-ctrl-agent.8 new file mode 100644 index 0000000..75c3fae --- /dev/null +++ b/doc/sphinx/_build/man/kea-ctrl-agent.8 @@ -0,0 +1,113 @@ +.\" Man page generated from reStructuredText. +. +.TH "KEA-CTRL-AGENT" "8" "Jul 26, 2022" "2.2.0" "Kea" +.SH NAME +kea-ctrl-agent \- Control Agent process in Kea +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.sp +\fBkea\-ctrl\-agent\fP [\fB\-v\fP] [\fB\-V\fP] [\fB\-W\fP] [\fB\-d\fP] [\fB\-c\fP config\-file] [\fB\-t\fP config\-file] +.SH DESCRIPTION +.sp +The \fBkea\-ctrl\-agent\fP provides a REST service for controlling Kea +services. The received HTTP requests are decapsulated and forwarded to +the respective Kea services in JSON format. Received JSON responses are +encapsulated within HTTP responses and returned to the controlling +entity. Some commands may be handled by the Control Agent directly, and +not forwarded to any Kea service. +.SH ARGUMENTS +.sp +The arguments are as follows: +.INDENT 0.0 +.TP +.B \fB\-v\fP +Displays the version. +.TP +.B \fB\-V\fP +Displays the extended version. +.TP +.B \fB\-W\fP +Displays the configuration report. +.TP +.B \fB\-d\fP +Sets the logging level to debug with extra verbosity. This is primarily for +development purposes in stand\-alone mode. +.TP +.B \fB\-c config\-file\fP +Specifies the file with the configuration for the Control Agent +server. It may also contain configuration entries for other Kea +services. +.TP +.B \fB\-t config\-file\fP +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. +.UNINDENT +.SH DOCUMENTATION +.sp +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 +\fI\%https://kea.readthedocs.io\fP\&. +.sp +Kea source code is documented in the Kea Developer\(aqs Guide, +available at \fI\%https://reports.kea.isc.org/dev_guide/\fP\&. +.sp +The Kea project website is available at \fI\%https://kea.isc.org\fP\&. +.SH MAILING LISTS AND SUPPORT +.sp +There are two public mailing lists available for the Kea project. \fBkea\-users\fP +(kea\-users at lists.isc.org) is intended for Kea users, while \fBkea\-dev\fP +(kea\-dev at lists.isc.org) is intended for Kea developers, prospective +contributors, and other advanced users. Both lists are available at +\fI\%https://lists.isc.org\fP\&. The community provides best\-effort support +on both of those lists. +.sp +ISC provides professional support for Kea services. See +\fI\%https://www.isc.org/kea/\fP for details. +.SH HISTORY +.sp +The \fBkea\-ctrl\-agent\fP was first coded in December 2016 by Marcin +Siodelski. +.SH SEE ALSO +.sp +\fBkea\-dhcp4(8)\fP, \fBkea\-dhcp6(8)\fP, +\fBkea\-dhcp\-ddns(8)\fP, \fBkea\-admin(8)\fP, \fBkeactrl(8)\fP, +\fBperfdhcp(8)\fP, \fBkea\-lfc(8)\fP, Kea Administrator Reference Manual. +.SH AUTHOR +Internet Systems Consortium +.SH COPYRIGHT +2019-2022, Internet Systems Consortium +.\" Generated by docutils manpage writer. +. |