\"client-classes6\": [ ],
\"option-data4\": [ ],
\"option-data6\": [ ],
- \"next-server\": "192.0.0.2",
+ \"next-server\": \"192.0.0.2\",
\"server-hostname\": \"server-hostname.example.org\",
\"boot-file-name\": \"bootfile.efi\",
\"host-id\": 0
\"client-classes6\": [ ],
\"option-data4\": [ ],
\"option-data6\": [ ],
- \"next-server\": "0.0.0.0",
+ \"next-server\": \"0.0.0.0\",
\"server-hostname\": \"\",
\"boot-file-name\": \"\",
\"host-id\": 0
}
-}",
-}
\ No newline at end of file
+}"
+}
"cmd-syntax": "{
\"command\": \"cache-load\",
\"arguments\": \"/tmp/kea-host-cache.json\"
-}",
+}"
}
\"duid\": \"00:01:ab:cd:f0:a1:c2:d3:e4\",
\"subnet-id\": 123
}
-}",
-}
\ No newline at end of file
+}"
+}
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-reload\"
-}",
+}"
}
or
- {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }",
-}
\ No newline at end of file
+ {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+}
or
- {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }",
-}
\ No newline at end of file
+ {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+}
"cmd-syntax": "{
\"command\": \"config-write\",
\"arguments\": {
- \"filename": \"config-modified-2017-03-15.json\"
+ \"filename\": \"config-modified-2017-03-15.json\"
}
-}",
-}
\ No newline at end of file
+}"
+}
\"arguments\": {
\"max-period\": 20
}
-}",
-}
\ No newline at end of file
+}"
+}
"avail": "1.4.0",
"cmd-syntax": "{
\"command\": \"dhcp-enable\"
-}",
-}
\ No newline at end of file
+}"
+}
\"ip-address\": \"192.0.2.202\",
\"hw-address\": \"1a:1b:1c:1d:1e:1f\"
}
-}",
-}
\ No newline at end of file
+}"
+}
\"ip-address\": \"192.0.2.202\"
}
}",
- "cmd-comment": "leaseX-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease in this case) has not been found.",
-}
\ No newline at end of file
+ "cmd-comment": "leaseX-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease in this case) has not been found."
+}
"cmd-syntax": "{
\"command\": \"lease4-get-all\"
}",
- "cmd-comment": "The lease4-get-all command may result in very large responses.",
-}
\ No newline at end of file
+ "cmd-comment": "The lease4-get-all command may result in very large responses."
+}
\"text\": \"IPv4 lease found.\"
}",
"resp-comment": "lease4-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
-}
\ No newline at end of file
+}
\"subnet-id\": 44,
\"force-create\": true
}
-}",
-}
\ No newline at end of file
+}"
+}
\"arguments\": {
\"subnet-id\": 44
}
+}"
}
-",
-}
\ No newline at end of file
}",
"cmd-comment": "lease6-add can be also used to add leases for IPv6 prefixes..",
"resp-syntax": "{ \"result\": 0, \"text\": \"Lease added.\" }
- { \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }",
-}
\ No newline at end of file
+ { \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
+}
"name": "lease6-del",
"brief": "lease6-del can be used to delete a lease from the lease database.",
"description": "See <xref linkend=\"idp61\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6"" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": "{
\"ip-address\": \"192.0.2.202\"
}
}",
- "cmd-comment": "lease6-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty).",
-}
\ No newline at end of file
+ "cmd-comment": "lease6-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty)."
+}
\"force-create\": false
}
}
-",
-}
\ No newline at end of file
+"
+}
\"subnet-id\": 66
}
}",
- "cmd-comment": "Note: not all backends support this command.",
-}
\ No newline at end of file
+ "cmd-comment": "Note: not all backends support this command."
+}
\"arguments\": {
\"remove\": true
}
-}",
-}
\ No newline at end of file
+}"
+}
\"command\": \"libreload\",
\"arguments\": { }
}",
- "cmd-comment": "The server will respond with a result of 0 indicating success, or 1 indicating a failure.",
-}
\ No newline at end of file
+ "cmd-comment": "The server will respond with a result of 0 indicating success, or 1 indicating a failure."
+}
"name": "list-commands",
"brief": "The list-commands command retrieves a list of all commands supported by the server.",
"description": "See <xref linkend=\"command-list-commands\"/>",
- "support": [ "kea-dhcp4", "kea-dhcp6" ],
+ "support": [ "kea-dhcp4", "kea-dhcp6" , "ca" ],
"avail": "1.0.0",
"cmd-syntax": "{
\"command\": \"list-commands\",
\"arguments\": { }
}",
- "cmd-comment": "The server will respond with a list of all supported commands.",
-}
\ No newline at end of file
+ "cmd-comment": "The server will respond with a list of all supported commands."
+}
\"shared-networks\": [ { \"name\": \"floor13\" } ]
},
\"result\": 0,
- \"text\": \"A new IPv4 shared network \'floor13\' added\"
-}",
-}
\ No newline at end of file
+ \"text\": \"A new IPv4 shared network 'floor13' added\"
+}"
+}
]
},
\"result\": 0,
- \"text\": \"IPv4 shared network \'floor13\' deleted\"
-}",
-}
\ No newline at end of file
+ \"text\": \"IPv4 shared network 'floor13' deleted\"
+}"
+}
}",
"resp-syntax": "{
\"result\": 0,
- \"text\": \"Info about IPv4 shared network \'floor13\' returned\",
+ \"text\": \"Info about IPv4 shared network 'floor13' returned\",
\"arguments\": {
\"shared-networks\": [
{
}
}",
"resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
-}
\ No newline at end of file
+}
"hook": "subnet_cmds",
"cmd-syntax": "{
\"command\": \"network4-list\"
-}d",
+}",
"resp-syntax": "{
\"arguments\": {
\"shared-networks\": [
},
\"result\": 0,
\"text\": \"2 IPv4 network(s) found\"
-}",
-}
\ No newline at end of file
+}"
+}
}",
"resp-syntax": "{
\"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network \'floor1\'\"
-}",
-}
\ No newline at end of file
+ \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"
+}"
+}
}",
"resp-syntax": "{
\"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network \'floor13\'\"
-}",
-}
\ No newline at end of file
+ \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"
+}"
+}
\"shared-networks\": [ { \"name\": \"floor13\" } ]
},
\"result\": 0,
- \"text\": \"A new IPv4 shared network \'floor13\' added\"
-}",
-}
\ No newline at end of file
+ \"text\": \"A new IPv4 shared network 'floor13' added\"
+}"
+}
\"name\": \"floor13\",
\"subnets-action\": \"delete\"
}
-}",
-}
\ No newline at end of file
+}"
+}
}",
"resp-syntax": "{
\"result\": 0,
- \"text\": \"Info about IPv4 shared network \'floor13\' returned\",
+ \"text\": \"Info about IPv4 shared network 'floor13' returned\",
\"arguments\": {
\"shared-networks\": [
{
}
}",
"resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
-}
\ No newline at end of file
+}
{ \"name\": \"office\" }
]
},
- "result": 0,
- "text": "2 IPv4 network(s) found"
-}",
-}
\ No newline at end of file
+ \"result\": 0,
+ \"text\": \"2 IPv4 network(s) found\"
+}"
+}
"cmd-comment": "The network6-subnet-add command uses exactly the same syntax for both the command and the response.",
"resp-syntax": "{
\"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network \'floor1\'\"
-}",
-}
\ No newline at end of file
+ \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"
+}"
+}
"cmd-comment": "The network6-subnet-del command uses exactly the same syntax for both the command and the response.",
"resp-syntax": "{
\"result\": 0,
- \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network \'floor13\'\"
-}",
-}
\ No newline at end of file
+ \"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"
+}"
+}
"cmd-syntax": "{
\"command\": \"shutdown\"
}",
- "cmd-comment": "The server will respond with a confirmation that the shutdown procedure has been initiated.",
-}
\ No newline at end of file
+ "cmd-comment": "The server will respond with a confirmation that the shutdown procedure has been initiated."
+}
\"timestamp\": \"2018-05-04 15:03:37.000000\"
}
}
- }",
-}
\ No newline at end of file
+ }"
+}
\"timestamp\": \"2018-05-04 15:03:37.000000\"
}
}
- }",
-}
\ No newline at end of file
+ }"
+}
\"command\": \"statistic-get-all\",
\"arguments\": { }
}",
- "cmd-comment": "The server will respond with details of all recorded statistics, with result set to 0 indicating that it iterated over all statistics (even when the total number of statistics is zero).",
-}
\ No newline at end of file
+ "cmd-comment": "The server will respond with details of all recorded statistics, with result set to 0 indicating that it iterated over all statistics (even when the total number of statistics is zero)."
+}
\"name\": \"pkt4-received\"
}
}",
- "cmd-comment": "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the "arguments" parameter.",
-}
\ No newline at end of file
+ "cmd-comment": "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the \"arguments\" parameter."
+}
\"command\": \"statistic-remove-all\",
\"arguments\": { }
}",
- "cmd-comment": "If the removal of all statistics was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description.",
-}
\ No newline at end of file
+ "cmd-comment": "If the removal of all statistics was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+}
\"name\": \"pkt4-received\"
}
}",
- "cmd-comment": "If the specific statistic is found and its removal was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description.",
-}
\ No newline at end of file
+ "cmd-comment": "If the specific statistic is found and its removal was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+}