summaryrefslogtreecommitdiffstats
path: root/doc/examples/agent/comments.json
blob: 6f40bdbb20af9ff51c48fcfce0187b85b086e338 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// This is a example of a configuration for Control-Agent (CA) or simply Agent.
// It uses embedded (i.e., which will be included in configuration objects
// and not stripped by at lexical analysis) comments.

{
    "Control-agent":
    {
        // Global scope
        "comment": "A Control Agent",

        "http-host": "127.0.0.1",

        // If enabling HA and multi-threading, the 8000 port is used by the HA
        // hook library http listener. When using HA hook library with
        // multi-threading to function, make sure the port used by dedicated
        // listener is different (e.g. 8001) than the one used by CA. Note
        // the commands should still be sent via CA. The dedicated listener
        // is specifically for HA updates only.
        "http-port": 8000,

        // In authentication
        "authentication":
        {
            "comment": "basic HTTP authentication",

            "type": "basic",

            // In basic HTTP authentication clients
            "clients":
            [
                {
                    "comment": "admin is authorized",
                    "user": "admin",
                    "password": "1234"
                }
            ]
        },

        // In control socket
        "control-sockets":
        {
            "dhcp4":
            {
                "comment": "control socket for DHCP4 server",
                "socket-type": "unix",
                "socket-name": "/tmp/kea4-ctrl-socket"
            }
        },

        // In loggers
        "loggers": [
            {
                "comment": "A logger",
                "name": "kea-ctrl-agent"
            }
        ]
    }
}