summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-server4-get-all.json
blob: 5555752e40520f2f7fc715bd8010848d57cdd29e (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
{
    "access": "read",
    "avail": "1.6.0",
    "brief": [
        "This command fetches information about all DHCPv4 servers specified by the user."
    ],
    "cmd-comment": [
        "This command contains no arguments besides the optional ``remote``."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-server4-get-all\",",
        "    \"arguments\": {",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        }",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-server4-get-all",
    "resp-comment": [
        "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server, and the user-defined description of the server. The Kea Configuration Backend uses the keyword ``all`` to associate parts of the configuration with all servers. Internally, it creates the logical server ``all`` for this purpose. However, this logical server is not returned as a result of the ``remote-server4-get-all`` command; only the user-defined servers are returned."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCPv4 servers found.\",",
        "    \"arguments\": {",
        "        \"servers\": [",
        "            {",
        "                \"server-tag\": <first server tag>,",
        "                \"description\": <first server description>",
        "            },",
        "            {",
        "                \"server-tag\": <second server tag>,",
        "                \"description\": <second server description>",
        "            }",
        "        ],",
        "        \"count\": 2",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}