summaryrefslogtreecommitdiffstats
path: root/src/share/api/ha-scopes.json
blob: 99240aa6956c59f739999a0ac659f2e30688b3a1 (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
{
    "access": "write",
    "avail": "1.4.0",
    "brief": [
        "This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode."
    ],
    "cmd-comment": [
        "In the example below, the arguments configure the server to handle traffic from both the HA_server1 and HA_server2 scopes."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"ha-scopes\",",
        "    \"service\": [ <service, typically 'dhcp4' or 'dhcp6'> ],",
        "    \"arguments\": {",
        "        \"scopes\": [ \"HA_server1\", \"HA_server2\" ]",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"command-ha-scopes\"/>",
    "hook": "high_availability",
    "name": "ha-scopes",
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}