summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-update.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/lease6-update.json')
-rw-r--r--src/share/api/lease6-update.json30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/share/api/lease6-update.json b/src/share/api/lease6-update.json
new file mode 100644
index 0000000..0c27104
--- /dev/null
+++ b/src/share/api/lease6-update.json
@@ -0,0 +1,30 @@
+{
+ "access": "write",
+ "avail": "1.3.0",
+ "brief": [
+ "This command updates existing leases."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease6-update\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"2001:db8::1\",",
+ " \"duid\": \"88:88:88:88:88:88:88:88\",",
+ " \"iaid\": 7654321,",
+ " \"hostname\": \"newhostname.example.org\",",
+ " \"subnet-id\": 66,",
+ " \"force-create\": false",
+ " }",
+ "}",
+ ""
+ ],
+ "description": "See <xref linkend=\"idp62\"/>",
+ "hook": "lease_cmds",
+ "name": "lease6-update",
+ "resp-comment": [
+ "If the returned result is equal to 4, it indicates that the lease could not be updated because it was in conflict with the server's state or its notion of the configuration. The High Availability hook library can handle such a result differently than a general error. A general error of 1 can indicate issues with processing the command, database availability etc."
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}