-2271. [func] func
+2271. [func] fdupont
Extended the control-socket entry taking a map
specifying a UNIX/LOCAL control socket for DHCPv4,
DHCPv6 and DHCP-DDNS servers to a control-sockets
When the ``clients`` authentication list is configured and not empty,
basic HTTP authentication is required. Each element of the list
specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
password is optional; when it is not specified an empty password
is used.
HTTP/HTTPS Control Socket
~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
+The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
TLS is required). The ``socket-address`` (default ``127.0.0.1``) and
``socket-port`` (default 8000) specify an IP address and port to which
the HTTP service will be bound.
When the ``clients`` authentication list is configured and not empty,
basic HTTP authentication is required. Each element of the list
specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
password is optional; when it is not specified an empty password
is used.
such as statistics retrieval, reconfiguration, or shutdown. For more
details, see :ref:`ctrl-channel`. By default there are no sockets
open; to instruct Kea to open a socket, the following entry in the
-configuration file can be used: ::
+configuration file can be used:
+
+::
"Dhcp4": {
- "control-socket": [
+ "control-sockets": [
{
"socket-type": "unix",
"socket-name": "/path/to/the/unix/socket"
HTTP/HTTPS Control Socket
-------------------------
-The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
+The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
TLS is required). The ``socket-address`` (default ``127.0.0.1``) and
``socket-port`` (default 8000) specify an IP address and port to which
the HTTP service will be bound.
When the ``clients`` authentication list is configured and not empty,
basic HTTP authentication is required. Each element of the list
specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
password is optional; when it is not specified an empty password
is used.
"control-sockets": [
{
"socket-type": "https",
- "socket-name": "10.20.30.40",
+ "socket-address": "10.20.30.40",
"socket-port": 8004,
"trust-anchor": "/path/to/the/ca-cert.pem",
"cert-file": "/path/to/the/agent-cert.pem",
::
"Dhcp6": {
- "control-socket": [
+ "control-sockets": [
{
"socket-type": "unix",
"socket-name": "/path/to/the/unix/socket"
HTTP/HTTPS Control Socket
-------------------------
-The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
+The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
TLS is required). The ``socket-address`` (default ``::1``) and
``socket-port`` (default 8000) specify an IP address and port to which
the HTTP service will be bound.
When the ``clients`` authentication list is configured and not empty,
basic HTTP authentication is required. Each element of the list
specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
password is optional; when it is not specified an empty password
is used.
"control-sockets": [
{
"socket-type": "https",
- "socket-name": "2010:30:40::50",
+ "socket-address": "2010:30:40::50",
"socket-port": 8005,
"trust-anchor": "/path/to/the/ca-cert.pem",
"cert-file": "/path/to/the/agent-cert.pem",
"key-file": "/path/to/the/agent-key.pem",
"cert-required": true,
"authentication": {
- "type": "basic",
- "realm": "kea-control-agent",
- "clients": [
- {
- "user": "admin",
- "password": "1234"
- } ]
+ "type": "basic",
+ "realm": "kea-control-agent",
+ "clients": [
+ {
+ "user": "admin",
+ "password": "1234"
+ } ]
}
}
],