summaryrefslogtreecommitdiffstats
path: root/src/share/api/ha-maintenance-notify.json
blob: d187107f15b67895f3c1926053a07e76f1f6c8bc (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
{
    "access": "write",
    "avail": "1.7.4",
    "brief": [
        "This command is sent by the server receiving the ha-maintenance-start",
        "to its partner to cause the partner to transition to the in-maintenance",
        "state or to revert it from the in-maintenance state as a result of",
        "receiving the ha-maintenance-cancel command."
    ],
    "cmd-comment": [
        "This command includes a boolean argument which, if false, indicates",
        "that the server should transition to the in-maintenance state.",
        "If the argument is set to true it instructs the server to revert from",
        "the in-maintenance state to its previous state.",
        "This command is not meant to be used by the administrator. It is",
        "merely used for internal communication between the HA partners."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"ha-maintenance-notify\",",
        "    \"arguments\": {",
        "        \"cancel\": <boolean>",
        "    }",
        "}"
    ],
    "description": [ "See <xref linkend=\"command-ha-maintenance-notify\"/>" ],
    "hook": "high_availability",
    "name": "ha-maintenance-notify",
    "resp-comment": [
        "The response may include a special error code of 1001",
        "to indicate that the partner refused to enter the maintenance state."
    ],
    "support": [
        "kea-dhcp4",
        "kea-dhcp6"
    ]
}