summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-server6-get.json
blob: 1acbfd4fd5fdecc4b29649ab929fd50dd92caa75 (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
{
    "access": "read",
    "avail": "1.6.0",
    "brief": [
        "This command fetches information about the DHCPv6 server, such as the server tag and description."
    ],
    "cmd-comment": [
        "This command carries the list including exactly one map with the tag of the server to be fetched."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"remote-server6-get\",",
        "    \"arguments\": {",
        "        \"servers\": [",
        "            {",
        "                \"server-tag\": <server tag>",
        "            }",
        "        ],",
        "        \"remote\": {",
        "            <specification of the database to connect to>",
        "        }",
        "    }",
        "}"
    ],
    "hook": "cb_cmds",
    "name": "remote-server6-get",
    "resp-comment": [
        "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
    ],
    "resp-syntax": [
        "{",
        "    \"result\": 0,",
        "    \"text\": \"DHCP server 'server tag' found.\",",
        "    \"arguments\": {",
        "        \"servers\": [",
        "            {",
        "                \"server-tag\": <server tag>,",
        "                \"description\": <server description>",
        "            }",
        "        ],",
        "        \"count\": 1",
        "    }",
        "}"
    ],
    "support": [
        "kea-dhcp6"
    ]
}