1KEA-SHELL(8) Kea KEA-SHELL(8)
2
6 kea-shell - Text client for Control Agent process
7
9 kea-shell [-h] [-v] [--host] [--port] [--path] [--timeout] [--service]
10 [command]
11
13 The kea-shell provides a REST client for the Kea Control Agent (CA). It
14 takes command as a command-line parameter that is being sent to CA with
15 proper JSON encapsulation. Optional arguments may be specified on the
16 standard input. The request it sent of HTTP and a response is
17 retrieved. That response is displayed out on the standard output.
18
20 The arguments are as follows:
21 -h
23 Displays help regarding command line parameters.
24 -v
26 Display the version.
27 --host
29 Specifies the host to connect to. Control Agent must be running at
30 specified host. If not specified, 127.0.0.1 is used.
31 --port
33 Specifies the TCP port to connect to. Control Agent must be
34 listening at specified port. If not specified, 8000 is used.
35 --path
37 Specifies the path in the URL to connect to. If not specified,
38 empty path is used. As Control Agent listens at the empty path this
39 parameter is useful only with a reverse proxy.
40 --timeout
42 Specifies the connection timeout in seconds. If not specified, 10
43 (seconds) is used.
44 --service
46 Specifies the service that is the target of a command. If not
47 specified, Control Agent will be targeted. May be used more than
48 once to specify multiple targets.
49 command
51 Specifies the command to be sent to CA. If not specified,
52 "list-commands" is used.
53
55 Kea comes with an extensive Kea User's Guide documentation that covers
56 all aspects of running the Kea software - compilation, installation,
57 configuration, configuration examples and many more. Kea also features
58 a Kea Messages Manual, which lists all possible messages Kea can print
59 with a brief description for each of them. Both documents are typically
60 available in various formats (txt, html, pdf) with your Kea
61 distribution. The Kea documentation is available at
62 https://kb.isc.org/docs/kea-administrator-reference-manual .
63 Kea source code is documented in the Kea Developer's Guide. Its on-line
65 version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
66 Kea project website is available at:
68 https://gitlab.isc.org/isc-projects/kea.
69
71 There are two mailing lists available for Kea project. kea-users
72 (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
73 (kea-dev at lists.isc.org) is intended for Kea developers, prospective
74 contributors and other advanced users. Both lists are available at
75 http://lists.isc.org. The community provides best effort type of
76 support on both of those lists.
77 ISC provides professional support for Kea services. See
79 https://www.isc.org/kea/ for details.
80
82 The kea-shell was first coded in March 2017 by Tomek Mrugalski.
83
85 kea-ctrl-agent(8), kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-
86 admin(8), keactrl(8), perfdhcp(8), kea-lfc(8), Kea Administrator's
87 Guide.
88
90 The Kea software has been written by a number of engineers working for
91 ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas
92 Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn
93 Routhier. That list is roughly in the chronological order in which the
94 authors made their first contribution. For a complete list of authors
95 and contributors, see AUTHORS file.
96
98 Copyright © 2017-2018 Internet Systems Consortium, Inc. ("ISC")
99ISC Kea 1.5.0 Dec 14, 2018 KEA-SHELL(8)