summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease4-resend-ddns.json
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/share/api/lease4-resend-ddns.json32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/share/api/lease4-resend-ddns.json b/src/share/api/lease4-resend-ddns.json
new file mode 100644
index 0000000..a6c9014
--- /dev/null
+++ b/src/share/api/lease4-resend-ddns.json
@@ -0,0 +1,32 @@
+{
+ "access": "write",
+ "avail": "1.7.6",
+ "brief": [
+ "This command resends a request to kea-dhcp-ddns to update DNS for an existing lease."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"lease4-resend-ddns\",",
+ " \"arguments\": {",
+ " \"ip-address\": \"192.0.2.1\"",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"idp58\"/>",
+ "hook": "lease_cmds",
+ "name": "lease4-resend-ddns",
+ "resp-comment": [
+ "lease4-resend-ddns returns a result that indicates the outcome of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error), or 3 (empty)."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"arguments\": {",
+ " },",
+ " \"result\": 0,",
+ " \"text\": \"NCR generated for: 192.0.2.1, hostname: example.com.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}