+++ /dev/null
-{
- "name": "lease6-bulk-apply",
- "brief": "The lease6-bulk-apply command can be used to create, update and delete multiple IPv6 leases in a single transaction. This is used to communicate lease changes between the HA peers but may be used in all cases when it is desired to apply multiple lease updates in a single transaction.",
- "support": [ "kea-dhcp6" ],
- "avail": "1.6.0",
- "hook": "lease_cmds",
- "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\",
- ...
- }
- ]
- }
-}",
- "cmd-comment": "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The \"deleted-leases\" and \"leases\" are optional parameters but one of them must be specified.",
- "resp-syntax": " {
- {
- \"result\": 0,
- \"text\": IPv6 leases bulk apply completed.
- \"arguments\": {
- \"failed-deleted-leases\": [
- {
- \"ip-address\": \"2001:db8:abcd::\",
- \"type\": \"IA_PD\",
- \"result\": <control result>,
- \"error-message\": <error message>
- }
- ],
- \"failed-leases\": [
- {
- \"ip-address\": \"2001:db8:cafe::\",
- \"type\": \"IA_PD\",
- \"result\" <control result>,
- \"error-message\": <error message>
- }
- ]
- }
- }
-}",
- "resp-comment": "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
-}
+++ /dev/null
-<?xml version='1.0'?>
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- version="1.0">
-
- <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/>
-
- <!-- override encoding from ISO-8859-1 to UTF-8 -->
- <xsl:output method="html"
- encoding="UTF-8"
- indent="no"/>
-
-</xsl:stylesheet>
api_files+=api/lease4-update.json
api_files+=api/lease4-wipe.json
api_files+=api/lease6-add.json
+api_files+=api/lease6-bulk-apply.json
api_files+=api/lease6-del.json
api_files+=api/lease6-get-all.json
api_files+=api/lease6-get.json
--- /dev/null
+{
+ "name": "lease6-bulk-apply",
+ "brief": "The lease6-bulk-apply command can be used to create, update and delete multiple IPv6 leases in a single transaction. This is used to communicate lease changes between the HA peers but may be used in all cases when it is desired to apply multiple lease updates in a single transaction.",
+ "support": [ "kea-dhcp6" ],
+ "avail": "1.6.0",
+ "hook": "lease_cmds",
+ "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"
+ }
+ ]
+ }
+ },
+ "cmd-comment": "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The 'deleted-leases' and 'leases' are optional parameters but one of them must be specified.",
+ "resp-syntax": {
+ "result": 0,
+ "text": "IPv6 leases bulk apply completed.",
+ "arguments": {
+ "failed-deleted-leases": [
+ {
+ "ip-address": "2001:db8:abcd::",
+ "type": "IA_PD",
+ "result": "<control result>",
+ "error-message": "<error message>"
+ }
+ ],
+ "failed-leases": [
+ {
+ "ip-address": "2001:db8:cafe::",
+ "type": "IA_PD",
+ "result": "<control result>",
+ "error-message": "<error message>"
+ }
+ ]
+ }
+ },
+ "resp-comment": "The 'failed-deleted-leases' holds the list of leases which failed to delete. This includes leases which were not found in the database. The 'failed-leases' includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
+}