kea-shell.8.rst 3.59 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
..
   Copyright (C) Internet Systems Consortium, Inc. ("ISC")

   This Source Code Form is subject to the terms of the Mozilla Public
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.

   See the COPYRIGHT file distributed with this work for additional
   information regarding copyright ownership.

.. highlight: console

.. kea-shell:

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

Synopsis
~~~~~~~~

21
:program:`kea-shell` [**-h**] [**-v**] [**--host**] [**--port**] [**--path**] [**--timeout**] [**--service**] [**command**]
22
23
24

Description
~~~~~~~~~~~
25
26
27
28

The ``kea-shell`` provides a REST client for the Kea Control Agent (CA).
It takes command as a command-line parameter that is being sent to CA
with proper JSON encapsulation. Optional arguments may be specified on
29
30
the standard input. The request is sent via HTTP and a response is
retrieved, displayed on the standard output.
31

32
33
Arguments
~~~~~~~~~
34
35
36
37

The arguments are as follows:

``-h``
38
   Displays help regarding command-line parameters.
39
40

``-v``
41
   Displays the version.
42
43

``--host``
44
   Specifies the host to connect to. Control Agent must be running at the
45
46
47
48
   specified host. If not specified, 127.0.0.1 is used.

``--port``
   Specifies the TCP port to connect to. Control Agent must be listening
49
   at the specified port. If not specified, 8000 is used.
50
51

``--path``
52
53
   Specifies the path in the URL to connect to. If not specified, an empty
   path is used. As Control Agent listens at the empty path, this
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
   parameter is useful only with a reverse proxy.

``--timeout``
   Specifies the connection timeout in seconds. If not specified, 10
   (seconds) is used.

``--service``
   Specifies the service that is the target of a command. If not
   specified, Control Agent will be targeted. May be used more than once
   to specify multiple targets.

``command``
   Specifies the command to be sent to CA. If not specified,
   "list-commands" is used.

69
70
Documentation
~~~~~~~~~~~~~
71

72
Kea comes with an extensive Kea Administrator Reference Manual that covers
73
all aspects of running the Kea software - compilation, installation,
74
configuration, configuration examples, and much more. Kea also features a
75
Kea Messages Manual, which lists all possible messages Kea can print
76
77
with a brief description for each of them. Both documents are
available in various formats (.txt, .html, .pdf) with the Kea
78
79
80
distribution. The Kea documentation is available at
https://kb.isc.org/docs/kea-administrator-reference-manual .

81
Kea source code is documented in the Kea Developer's Guide. Its online
82
83
version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.

84
The Kea project website is available at https://kea.isc.org.
85

86
87
Mailing Lists and Support
~~~~~~~~~~~~~~~~~~~~~~~~~
88

89
90
There are two public mailing lists available for the Kea project. **kea-users**
(kea-users at lists.isc.org) is intended for Kea users, while **kea-dev**
91
(kea-dev at lists.isc.org) is intended for Kea developers, prospective
92
93
contributors, and other advanced users. Both lists are available at
https://lists.isc.org. The community provides best-effort support
94
95
96
97
98
on both of those lists.

ISC provides professional support for Kea services. See
https://www.isc.org/kea/ for details.

99
100
History
~~~~~~~
101
102
103

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

104
105
See Also
~~~~~~~~
106

107
108
109
:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`, :manpage:`kea-dhcp-ddns(8)`,
:manpage:`kea-ctrl-agent(8)`, :manpage:`kea-admin(8)`, :manpage:`keactrl(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-lfc(8)`, Kea Administrator Reference Manual.