"avail": "1.5.0",
"brief": [
"This command is used to create and add a new class to the existing",
- " server configuration."
+ "server configuration."
],
"cmd-comment": [
- "The <command>next-server</command>,",
- " <command>server-hostname</command> and",
- " <command>boot-file-name</command> are DHCPv4 specific. Only",
- " one client class can be added with a single command. "
+ "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only",
+ "one client class can be added with a single command. "
],
"cmd-syntax": [
"{",
"name": "class-add",
"resp-comment": [
"The command will be successful (result 0), unless the",
- " class name is a duplicate or another error occurs (result 1)."
+ "class name is a duplicate or another error occurs (result 1)."
],
"resp-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"name": "class-del",
"resp-comment": [
"The command will return a result of 3 (empty) if the client",
- " class doesn't exist. If the client class exists, the retured",
- " result is 0 if the deletion was successful and the result is 1",
- " if the deletion is unsuccessful."
+ "class doesn't exist. If the client class exists, the retured",
+ "result is 0 if the deletion was successful and the result is 1",
+ "if the deletion is unsuccessful."
],
"resp-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"avail": "1.5.0",
"brief": [
"This command is used to return detailed information about an",
- " existing client class."
+ "existing client class."
],
"cmd-syntax": [
"{",
"name": "class-get",
"resp-comment": [
"The returned information depends on the DHCP server type,",
- " i.e. some parameters are specific to DHCPv4 server. Also,",
- " some parameters may not be returned if they are not set for",
- " the client class. If the class with specified name doesn't",
- " exist a result of 3 (empty) is returned. If the client class",
- " is found, the result of 0 is returned. If there is an error",
- " while processing the command, the result of 1 is returned."
+ "i.e. some parameters are specific to DHCPv4 server. Also,",
+ "some parameters may not be returned if they are not set for",
+ "the client class. If the class with specified name doesn't",
+ "exist a result of 3 (empty) is returned. If the client class",
+ "is found, the result of 0 is returned. If there is an error",
+ "while processing the command, the result of 1 is returned."
],
"resp-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"avail": "1.5.0",
"brief": [
"This command is used to retrieve a list of all client",
- " classes from the server configuration."
+ "classes from the server configuration."
],
"cmd-comment": [
"This command includes no arguments."
"name": "class-list",
"resp-comment": [
"The returned list of classes merely contains their names.",
- " In order to retrieve full information about one of these",
- " classes use <xref linkend=\"command-class-get\"/>.",
- " The returned result is 3 (empty) if no classes are found.",
- " If the command is processed successfully and the list of",
- " client classes is not empty, the result of 0 is returned.",
- " If there is an error while processing the command, the",
- " result of 1 is returned."
+ "In order to retrieve full information about one of these",
+ "classes use :ref:`command-class-get`.",
+ "The returned result is 3 (empty) if no classes are found.",
+ "If the command is processed successfully and the list of",
+ "client classes is not empty, the result of 0 is returned.",
+ "If there is an error while processing the command, the",
+ "result of 1 is returned."
],
"resp-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"avail": "1.5.0",
"brief": [
"This command is used to update an existing client class in",
- " the server configuration."
+ "the server configuration."
],
"cmd-comment": [
- "The <command>next-server</command>,",
- " <command>server-hostname</command> and",
- " <command>boot-file-name</command> are DHCPv4 specific. Only",
- " one client class can be updated with a single command. "
+ "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only",
+ "one client class can be updated with a single command. "
],
"cmd-syntax": [
"{",
"name": "class-update",
"resp-comment": [
"The command will return the result of 3 (empty) if the client",
- " class doesn't exist. If the client class exists, the retured",
- " result is 0 if the update was successful and the result is 1",
- " if the update is unsuccessful."
+ "class doesn't exist. If the client class exists, the retured",
+ "result is 0 if the update was successful and the result is 1",
+ "if the update is unsuccessful."
],
"resp-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"avail": "1.2.0",
"brief": [
"Retrieves the current configuration used by the server. The configuration",
- " is roughtly equal to the configuration file, but includes additional",
- " changes made by other commands and due to parameters inheritance."
+ "is roughtly equal to the configuration file, but includes additional",
+ "changes made by other commands and due to parameters inheritance."
],
"cmd-comment": [
"This command takes no parameters."
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
"description": "See <xref linkend=\"command-config-test\"/>",
"name": "config-test",
"resp-syntax": [
- "{\"result\": 0, \"text\": \"Configuration seems sane...\" }",
+ "{ \"result\": 0, \"text\": \"Configuration seems sane...\" }",
"",
" or",
"",
- " {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+ "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
],
"support": [
"kea-dhcp4",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
"avail": "1.2.0",
"brief": [
"The config-write command instructs the Kea server to write its",
- " current configuration to a file on disk."
+ "current configuration to a file on disk."
],
"cmd-syntax": [
"{",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
"avail": "1.4.0",
"brief": [
"This command is sent internally by Kea partner when operating",
- " in High Availability (HA) mode. It will retrieve the server HA state and clock value."
+ "in High Availability (HA) mode. It will retrieve the server HA state and clock value."
],
"cmd-syntax": [
"{",
"hook": "high_availability",
"name": "ha-heartbeat",
"resp-comment": [
- "The response to this command is different from the typical command response. The response will include server state (see <xref linkend=\"ha-server-states\"/> plus the current clock value."
+ "The response to this command is different from the typical command response. The response will include server state (see :ref:`ha-server-states`) plus the current clock value."
],
"support": [
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"avail": "1.4.0",
"brief": [
"The command is issued to instruct the server running in HA mode to ",
- " synchronize its local lease database with the selected peer."
+ "synchronize its local lease database with the selected peer."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
],
"cmd-syntax": [
"{",
- " \"command\": \"lease4-wipe\",",
- " \"arguments\": {",
- " \"subnet-id\": 44",
- " }",
+ " \"command\": \"lease4-wipe\",",
+ " \"arguments\": {",
+ " \"subnet-id\": 44",
+ " }",
"}"
],
"description": "See <xref linkend=\"idp63\"/>",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"name": "lease6-add",
"resp-syntax": [
"{ \"result\": 0, \"text\": \"Lease added.\" }",
- " { \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
+ " or ",
+ "{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
],
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
],
"cmd-syntax": [
"{",
- " \"command\": \"lease6-bulk-apply\",",
- " \"arguments\": {",
- " \"deleted-leases\": [",
- " {",
- " \"ip-address\": \"2001:db8:abcd::\",",
- " \"type\": \"IA_PD\",",
- " ...",
- " },",
- " {",
- " \"ip-address\": \"2001:db8:abcd::234\",",
- " \"type\": \"IA_NA\",",
- " ...",
- " }",
- " ],",
- " \"leases\": [",
- " {",
- " \"subnet-id\": 66,",
- " \"ip-address\": \"2001:db8:cafe::\",",
- " \"type\": \"IA_PD\",",
- " ...",
- " },",
- " {",
- " \"subnet-id\": 66,",
- " \"ip-address\": \"2001:db8:abcd::333\",",
- " \"type\": \"IA_NA\",",
- " ...",
- " }",
- " ]",
- " }",
+ " \"command\": \"lease6-bulk-apply\",",
+ " \"arguments\": {",
+ " \"deleted-leases\": [",
+ " {",
+ " \"ip-address\": \"2001:db8:abcd::\",",
+ " \"type\": \"IA_PD\",",
+ " ...",
+ " },",
+ " {",
+ " \"ip-address\": \"2001:db8:abcd::234\",",
+ " \"type\": \"IA_NA\",",
+ " ...",
+ " }",
+ " ],",
+ " \"leases\": [",
+ " {",
+ " \"subnet-id\": 66,",
+ " \"ip-address\": \"2001:db8:cafe::\",",
+ " \"type\": \"IA_PD\",",
+ " ...",
+ " },",
+ " {",
+ " \"subnet-id\": 66,",
+ " \"ip-address\": \"2001:db8:abcd::333\",",
+ " \"type\": \"IA_NA\",",
+ " ...",
+ " }",
+ " ]",
+ " }",
"}"
],
"hook": "lease_cmds",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
],
"cmd-comment": [
"The network6-del command uses exactly the same syntax for",
- " both the command and the response."
+ "both the command and the response."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.2.0",
"brief": [
- "adds a new host reservation. The reservation may include IPv4 address,",
- " IPv6 addresses, IPv6 prefixes, various identifiers, a class",
- " the client will be assigned to, DHCPv4 and DHCPv6 options and",
- " more."
+ "Adds a new host reservation. The reservation may include IPv4 address,",
+ "IPv6 addresses, IPv6 prefixes, various identifiers, a class",
+ "the client will be assigned to, DHCPv4 and DHCPv6 options and",
+ "more."
],
"cmd-comment": [
"Note the ip-address, client-id, next-server, server-hostname and",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
],
"cmd-comment": [
"The server will respond with a confirmation that the shutdown",
- " procedure has been initiated."
+ "procedure has been initiated."
],
"cmd-syntax": [
"{",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
"avail": "1.4.0",
"brief": [
"The stat-lease4-get command fetches lease statistics for a range",
- " of known IPv4 subnets."
+ "of known IPv4 subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"avail": "1.4.0",
"brief": [
"The stat-lease6-get command fetches lease statistics for a range",
- " of known IPv6 subnets."
+ "of known IPv6 subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"avail": "1.2.0",
"brief": [
"The version-get command returns extended information about",
- " Kea version. The returned string is the same as if Kea would",
- " be run with -V command line option."
+ "Kea version. The returned string is the same as if Kea would",
+ "be run with ``-V`` command line option."
],
"cmd-syntax": [
"{",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
projects / thirdparty / kea.git / commitdiff
