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] [--ca] [--cert] [--key]
10 [--auth-user] [--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. Basic HTTP authentication
18 and HTTPS i.e. TLS transport are supported.
19
21 The arguments are as follows:
22 -h Displays help regarding command-line parameters.
24 -v Displays the version.
26 --host Specifies the host to connect to. Control Agent must be running
28 at the specified host. If not specified, 127.0.0.1 is used.
29 --port Specifies the TCP port to connect to. Control Agent must be lis‐
31 tening at the specified port. If not specified, 8000 is used.
32 --path Specifies the path in the URL to connect to. If not specified,
34 an empty path is used. As Control Agent listens at the empty
35 path, this parameter is useful only with a reverse proxy.
36 --ca Specifies the file or directory name of the Certification Au‐
38 thority. If not specified HTTPS is not used.
39 --cert Specifies the file name of the user end-entity public key cer‐
41 tificate. If specified the file name of the user key must be
42 specified too.
43 --key Specifies the file name of the user key file. If specified the
45 file name of the user certificate must be specified too. Note
46 that encrypted key files are not supported.
47 --auth-user
49 Specifies the user id for basic HTTP authentication. If not
50 specified or specified as the empty string authentication is not
51 used.
52 --auth-password
54 Specifies the password for basic HTTP authentication. If not
55 specified but the user id is specified an empty password is
56 used.
57 --timeout
59 Specifies the connection timeout in seconds. If not specified,
60 10 (seconds) is used.
61 --service
63 Specifies the service that is the target of a command. If not
64 specified, Control Agent will be targeted. May be used more than
65 once to specify multiple targets.
66 command
68 Specifies the command to be sent to CA. If not specified,
69 "list-commands" is used.
70
72 Kea comes with an extensive Kea Administrator Reference Manual that
73 covers all aspects of running the Kea software - compilation, installa‐
74 tion, configuration, configuration examples, and much more. Kea also
75 features a Kea Messages Manual, which lists all possible messages Kea
76 can print with a brief description for each of them. Both documents are
77 available in various formats (.txt, .html, .pdf) with the Kea distribu‐
78 tion. The Kea documentation is available at
79 https://kb.isc.org/docs/kea-administrator-reference-manual .
80 Kea source code is documented in the Kea Developer's Guide. Its online
82 version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
83 The Kea project website is available at https://kea.isc.org.
85
87 There are two public mailing lists available for the Kea project.
88 kea-users (kea-users at lists.isc.org) is intended for Kea users, while
89 kea-dev (kea-dev at lists.isc.org) is intended for Kea developers,
90 prospective contributors, and other advanced users. Both lists are
91 available at https://lists.isc.org. The community provides best-effort
92 support on both of those lists.
93 ISC provides professional support for Kea services. See
95 https://www.isc.org/kea/ for details.
96
98 The kea-shell was first coded in March 2017 by Tomek Mrugalski.
99
101 kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8),
102 kea-admin(8), keactrl(8), perfdhcp(8), kea-lfc(8), Kea Administrator
103 Reference Manual.
104
106 Internet Systems Consortium
107
109 2019-2021, Internet Systems Consortium
1101.9.8 Aug 06, 2021 KEA-SHELL(8)