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] [--timeout] [--service]
10       [command]
11

DESCRIPTION

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
17       retrieved, displayed on the standard output.
18

ARGUMENTS

20       The arguments are as follows:
21
22       -h     Displays help regarding command-line parameters.
23
24       -v     Displays the version.
25
26       --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
29       --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
32       --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
36       --timeout
37              Specifies the connection timeout in seconds. If  not  specified,
38              10 (seconds) is used.
39
40       --service
41              Specifies  the  service  that is the target of a command. If not
42              specified, Control Agent will be targeted. May be used more than
43              once to specify multiple targets.
44
45       command
46              Specifies  the  command  to  be  sent  to  CA. If not specified,
47              "list-commands" is used.
48

DOCUMENTATION

50       Kea comes with an extensive Kea  Administrator  Reference  Manual  that
51       covers all aspects of running the Kea software - compilation, installa‐
52       tion, configuration, configuration examples, and much  more.  Kea  also
53       features  a  Kea Messages Manual, which lists all possible messages Kea
54       can print with a brief description for each of them. Both documents are
55       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
56       tion.     The     Kea      documentation      is      available      at
57       https://kb.isc.org/docs/kea-administrator-reference-manual .
58
59       Kea  source code is documented in the Kea Developer's Guide. Its online
60       version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
61
62       The Kea project website is available at https://kea.isc.org.
63

MAILING LISTS AND SUPPORT

65       There are two public mailing  lists  available  for  the  Kea  project.
66       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
67       kea-dev (kea-dev at lists.isc.org)  is  intended  for  Kea  developers,
68       prospective  contributors,  and  other  advanced  users. Both lists are
69       available at https://lists.isc.org. The community provides  best-effort
70       support on both of those lists.
71
72       ISC    provides    professional   support   for   Kea   services.   See
73       https://www.isc.org/kea/ for details.
74

HISTORY

76       The kea-shell was first coded in March 2017 by Tomek Mrugalski.
77

SEE ALSO

79       kea-dhcp4(8),   kea-dhcp6(8),   kea-dhcp-ddns(8),    kea-ctrl-agent(8),
80       kea-admin(8),  keactrl(8),  perfdhcp(8),  kea-lfc(8), Kea Administrator
81       Reference Manual.
82

AUTHOR

84       Internet Systems Consortium
85

87       2020, Internet Systems Consortium
88
89
90
91
921.6.0                            Jan 29, 2020                     KEA-SHELL(8)
Impressum