1KEA-SHELL(8)                          Kea                         KEA-SHELL(8)
2
3
4

NAME

6       kea-shell - Text client for Control Agent process
7

SYNOPSIS

9       kea-shell  [-h] [-v] [--host] [--port] [--path] [--ca] [--cert] [--key]
10       [--auth-user] [--auth-password] [--timeout] [--service] [command]
11

DESCRIPTION

13       The kea-shell provides a REST client for the Kea  Control  Agent  (CA).
14       It  takes  commands  as a command-line parameter that is sent to the 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

ARGUMENTS

21       The arguments are as follows:
22
23       -h     Displays help regarding command-line parameters.
24
25       -v     Displays the version.
26
27       --host Specifies the host to connect to. The Control Agent must be run‐
28              ning at the specified host. If not specified, 127.0.0.1 is used.
29
30       --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
33       --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
37       --ca   Specifies  the  file  or directory name of the Certification Au‐
38              thority.  If not specified, HTTPS is not used.
39
40       --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 also
42              be specified.
43
44       --key  Specifies the file name of the user key file. If specified,  the
45              file  name  of the user certificate must also be specified.  En‐
46              crypted key files are not supported.
47
48       --auth-user
49              Specifies the user ID for  basic  HTTP  authentication.  If  not
50              specified,  or  specified as the empty string, authentication is
51              not used.
52
53       --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
58       --timeout
59              Specifies the connection timeout, in seconds. The default is 10.
60
61       --service
62              Specifies the service that is the target of a  command.  If  not
63              specified,  the  Control  Agent  itself is targeted. May be used
64              more than once to specify multiple targets.
65
66       command
67              Specifies the command to be sent to the CA.  If  not  specified,
68              list-commands is used.
69

DOCUMENTATION

71       Kea  comes  with  an  extensive Kea Administrator Reference Manual that
72       covers all aspects of running the Kea software - compilation, installa‐
73       tion,  configuration,  configuration  examples, and much more. Kea also
74       features a Kea Messages Manual, which lists all possible  messages  Kea
75       can print with a brief description for each of them. Both documents are
76       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
77       tion. The Kea documentation is available at https://kea.readthedocs.io.
78
79       Kea  source  code is documented in the Kea Developer's Guide, available
80       at https://reports.kea.isc.org/dev_guide/.
81
82       The Kea project website is available at https://kea.isc.org.
83

MAILING LISTS AND SUPPORT

85       There are two public mailing  lists  available  for  the  Kea  project.
86       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
87       kea-dev (kea-dev at lists.isc.org)  is  intended  for  Kea  developers,
88       prospective  contributors,  and  other  advanced  users. Both lists are
89       available at https://lists.isc.org. The community provides  best-effort
90       support on both of those lists.
91
92       ISC    provides    professional   support   for   Kea   services.   See
93       https://www.isc.org/kea/ for details.
94

HISTORY

96       The kea-shell was first coded in March 2017 by Tomek Mrugalski.
97

SEE ALSO

99       kea-dhcp4(8),   kea-dhcp6(8),   kea-dhcp-ddns(8),    kea-ctrl-agent(8),
100       kea-admin(8),  keactrl(8),  perfdhcp(8),  kea-lfc(8), Kea Administrator
101       Reference Manual.
102

AUTHOR

104       Internet Systems Consortium
105

107       2019-2023, Internet Systems Consortium
108
109
110
111
112 2.4.1                           Nov 30, 2023                     KEA-SHELL(8)
Impressum