.\" 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 "KEA-SHELL" "8" "Mar 22, 2024" "2.5.7" "Kea"
.SH NAME
kea-shell \- Text client for Control Agent process
.SH SYNOPSIS
.sp
\fBkea\-shell\fP [\fB\-h\fP] [\fB\-v\fP] [\fB\-\-host\fP] [\fB\-\-port\fP] [\fB\-\-path\fP] [\fB\-\-ca\fP] [\fB\-\-cert\fP] [\fB\-\-key\fP] [\fB\-\-auth\-user\fP] [\fB\-\-auth\-password\fP] [\fB\-\-timeout\fP] [\fB\-\-service\fP] [command]
.SH DESCRIPTION
.sp
The \fBkea\-shell\fP provides a REST client for the Kea Control Agent (CA).
It takes commands as a command\-line parameter that is sent to the CA
with proper JSON encapsulation. Optional arguments may be specified on
the standard input. The request is sent via HTTP and a response is
retrieved, displayed on the standard output. Basic HTTP authentication
and HTTPS, i.e. TLS transport, are supported.
.SH ARGUMENTS
.sp
The arguments are as follows:
.INDENT 0.0
.TP
.B \fB\-h\fP
Displays help regarding command\-line parameters.
.TP
.B \fB\-v\fP
Displays the version.
.TP
.B \fB\-\-host\fP
Specifies the host to connect to. The Control Agent must be running at the
specified host. If not specified, 127.0.0.1 is used.
.TP
.B \fB\-\-port\fP
Specifies the TCP port to connect to. Control Agent must be listening
at the specified port. If not specified, 8000 is used.
.TP
.B \fB\-\-path\fP
Specifies the path in the URL to connect to. If not specified, an empty
path is used. As Control Agent listens at the empty path, this
parameter is useful only with a reverse proxy.
.TP
.B \fB\-\-ca\fP
Specifies the file or directory name of the Certification Authority.
If not specified, HTTPS is not used.
.TP
.B \fB\-\-cert\fP
Specifies the file name of the user end\-entity public key certificate.
If specified, the file name of the user key must also be specified.
.TP
.B \fB\-\-key\fP
Specifies the file name of the user key file. If specified, the file
name of the user certificate must also be specified.
Encrypted key files are not supported.
.TP
.B \fB\-\-auth\-user\fP
Specifies the user ID for basic HTTP authentication. If not specified,
or specified as the empty string, authentication is not used.
.TP
.B \fB\-\-auth\-password\fP
Specifies the password for basic HTTP authentication. If not specified
but the user ID is specified, an empty password is used.
.TP
.B \fB\-\-timeout\fP
Specifies the connection timeout, in seconds. The default is 10.
.TP
.B \fB\-\-service\fP
Specifies the service that is the target of a command. If not
specified, the Control Agent itself is targeted. May be used more than once
to specify multiple targets.
.TP
.B \fBcommand\fP
Specifies the command to be sent to the CA. If not specified,
\fBlist\-commands\fP is used.
.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\-shell\fP was first coded in March 2017 by Tomek Mrugalski.
.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, \fBkeactrl(8)\fP,
\fBperfdhcp(8)\fP, \fBkea\-lfc(8)\fP, Kea Administrator Reference Manual.
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
2019-2024, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.