Current File : //backups/router/usr/local/share/kea/api/ha-maintenance-notify.json
{
"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\": true",
" }",
"}"
],
"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"
]
}
Mini Shell