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] [--auth-user]
10 [--auth-password] [--timeout] [--service] [command]
11
13 The kea-shell provides a REST client for the Kea Control Agent (CA).
14 It takes command as a command-line parameter that is being sent to CA
15 with proper JSON encapsulation. Optional arguments may be specified on
16 the standard input. The request is sent via HTTP and a response is re‐
17 trieved, displayed on the standard output.
18
20 The arguments are as follows:
21 -h Displays help regarding command-line parameters.
23 -v Displays the version.
25 --host Specifies the host to connect to. Control Agent must be running
27 at the specified host. If not specified, 127.0.0.1 is used.
28 --port Specifies the TCP port to connect to. Control Agent must be lis‐
30 tening at the specified port. If not specified, 8000 is used.
31 --path Specifies the path in the URL to connect to. If not specified,
33 an empty path is used. As Control Agent listens at the empty
34 path, this parameter is useful only with a reverse proxy.
35 --auth-user
37 Specifies the user id for basic HTTP authentication. If not
38 specified or specified as the empty string authentication is not
39 used.
40 --auth-password
42 Specifies the password for basic HTTP authentication. If not
43 specified but the user id is specified an empty password is
44 used.
45 --timeout
47 Specifies the connection timeout in seconds. If not specified,
48 10 (seconds) is used.
49 --service
51 Specifies the service that is the target of a command. If not
52 specified, Control Agent will be targeted. May be used more than
53 once to specify multiple targets.
54 command
56 Specifies the command to be sent to CA. If not specified,
57 "list-commands" is used.
58
60 Kea comes with an extensive Kea Administrator Reference Manual that
61 covers all aspects of running the Kea software - compilation, installa‐
62 tion, configuration, configuration examples, and much more. Kea also
63 features a Kea Messages Manual, which lists all possible messages Kea
64 can print with a brief description for each of them. Both documents are
65 available in various formats (.txt, .html, .pdf) with the Kea distribu‐
66 tion. The Kea documentation is available at
67 https://kb.isc.org/docs/kea-administrator-reference-manual .
68 Kea source code is documented in the Kea Developer's Guide. Its online
70 version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
71 The Kea project website is available at https://kea.isc.org.
73
75 There are two public mailing lists available for the Kea project.
76 kea-users (kea-users at lists.isc.org) is intended for Kea users, while
77 kea-dev (kea-dev at lists.isc.org) is intended for Kea developers,
78 prospective contributors, and other advanced users. Both lists are
79 available at https://lists.isc.org. The community provides best-effort
80 support on both of those lists.
81 ISC provides professional support for Kea services. See
83 https://www.isc.org/kea/ for details.
84
86 The kea-shell was first coded in March 2017 by Tomek Mrugalski.
87
89 kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8),
90 kea-admin(8), keactrl(8), perfdhcp(8), kea-lfc(8), Kea Administrator
91 Reference Manual.
92
94 Internet Systems Consortium
95
97 2019-2021, Internet Systems Consortium
981.9.4 Feb 08, 2021 KEA-SHELL(8)