.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "KEACTRL" "8" "Oct 15, 2022" "2.2.0" "Kea"
.SH NAME
keactrl \- Shell script for managing Kea
.SH SYNOPSIS
.sp
\fBkeactrl\fP [\fBcommand\fP] [\fB\-c\fP keactrl\-config\-file] [\fB\-s\fP server[,server,...]] [\fB\-v\fP]
.SH DESCRIPTION
.sp
\fBkeactrl\fP is a shell script which controls the startup, shutdown, and
reconfiguration of the Kea servers (\fBkea\-dhcp4\fP, \fBkea\-dhcp6\fP,
\fBkea\-dhcp\-ddns\fP, \fBkea\-ctrl\-agent\fP, and \fBkea\-netconf\fP). It also
provides a way to check the current status of the servers and
determine the configuration files in use.
.SH CONFIGURATION FILE
.sp
Depending on the user\(aqs requirements, not all of the available servers need be run.
The \fBkeactrl\fP configuration file specifies which servers are enabled and which
are disabled. By default the configuration file is
\fB[kea\-install\-dir]/etc/kea/keactrl.conf\fP\&.
.sp
See the Kea Administrator Reference Manual for documentation of the
parameters in the \fBkeactrl\fP configuration file.
.SH OPTIONS
.INDENT 0.0
.TP
.B \fBcommand\fP
Specifies the command to be issued to the servers. It can be one of the following:
.INDENT 7.0
.TP
.B \fBstart\fP
Starts the servers.
.TP
.B \fBstop\fP
Stops the servers.
.TP
.B \fBreload\fP
Instructs the servers to re\-read the Kea configuration file. This
command is not supported by the NETCONF agent.
.TP
.B \fBstatus\fP
Prints the status of the servers.
.UNINDENT
.TP
.B \fB\-c|\-\-ctrl\-config keactrl\-config\-file\fP
Specifies the \fBkeactrl\fP configuration file. Without this switch,
\fBkeactrl\fP uses the file
\fB[kea\-install\-dir]/etc/kea/keactrl.conf\fP\&.
.TP
.B \fB\-s|\-\-server server[,server,...]\fP
Specifies a subset of the enabled servers to which the command should
be issued. The list of servers should be separated by commas, with no
intervening spaces. Acceptable values are:
.INDENT 7.0
.TP
.B \fBdhcp4\fP
DHCPv4 server (\fBkea\-dhcp4\fP).
.TP
.B \fBdhcp6\fP
DHCPv6 server (\fBkea\-dhcp6\fP).
.TP
.B \fBdhcp_ddns\fP
DHCP DDNS server (\fBkea\-dhcp\-ddns\fP).
.TP
.B \fBctrl_agent\fP
Control Agent (\fBkea\-ctrl\-agent\fP).
.TP
.B \fBnetconf\fP
NETCONF agent (\fBkea\-netconf\fP).
.TP
.B \fBall\fP
All servers, including NETCONF if it was configured to be
built. This is the default.
.UNINDENT
.TP
.B \fB\-v|\-\-version\fP
Prints the \fBkeactrl\fP version and quits.
.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 SEE ALSO
.sp
\fBkea\-dhcp4(8)\fP, \fBkea\-dhcp6(8)\fP, \fBkea\-dhcp\-ddns(8)\fP,
\fBkea\-ctrl\-agent(8)\fP, \fBkea\-admin(8)\fP, \fBkea\-netconf(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.
.