[#1106] Udpated the ARM and created API files

new file:   doc/sphinx/api/lease4-resend-ddns.json
new file:   doc/sphinx/api/lease6-resend-ddns.json
modified:   doc/sphinx/arm/hooks-lease-cmds.rst

diff --git a/doc/sphinx/api/lease4-resend-ddns.json b/doc/sphinx/api/lease4-resend-ddns.json
new file mode 100644 (file)
index 0000000..9178c36
--- /dev/null
+++ b/doc/sphinx/api/lease4-resend-ddns.json
@@ -0,0 +1,31 @@
+{
+    "avail": "1.7.6",
+    "brief": [
+        "This command resends request 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 2 (empty)."
+    ],
+    "resp-syntax": [
+        "{",
+        "  \"arguments\": {",
+        "  },",
+        "  \"result\": 0,",
+        "  \"text\": \"NCR generated for: 192.0.2.1, hostname: example.com.\"",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}

diff --git a/doc/sphinx/api/lease6-resend-ddns.json b/doc/sphinx/api/lease6-resend-ddns.json
new file mode 100644 (file)
index 0000000..2ca4066
--- /dev/null
+++ b/doc/sphinx/api/lease6-resend-ddns.json
@@ -0,0 +1,31 @@
+{
+    "avail": "1.7.6",
+    "brief": [
+        "This command resends request to update DNS for an existing lease."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"lease6-resend-ddns\",",
+        "    \"arguments\": {",
+        "        \"ip-address\": \"2001.db8.0::1\"",
+        "    }",
+        "}"
+    ],
+    "description": "See <xref linkend=\"idp58\"/>",
+    "hook": "lease_cmds",
+    "name": "lease6-resend-ddns",
+    "resp-comment": [
+        "lease6-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 2 (empty)."
+    ],
+    "resp-syntax": [
+        "{",
+        "  \"arguments\": {",
+        "  },",
+        "  \"result\": 0,",
+        "  \"text\": \"NCR generated for: 2001:db8:0::1, hostname: example.com.\"",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp6"
+    ]
+}

diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst
index 8fa4b4df53f8236487e3eafe3fbce6cc5a1c3595..43d683ddfe96f7876f22e9d27aa3ee498c26e507 100644 (file)
--- a/doc/sphinx/arm/hooks-lease-cmds.rst
+++ b/doc/sphinx/arm/hooks-lease-cmds.rst
@@ -87,6 +87,12 @@ This library provides the following commands:
 -  ``lease6-wipe`` - removes all leases from a specific IPv6 subnet or
    from all subnets.
 
+-  ``lease4-resend-ddns`` - resend a request to udpate DNS entries for
+   and existing lease.
+
+-  ``lease6-resend-ddns`` - resend a request to udpate DNS entries for
+   and existing lease.
+
 The lease commands library is part of the open source code and is
 available to every Kea user.
 
@@ -891,6 +897,71 @@ An example of ``lease6-wipe`` is:
      }
    }
 
+.. _command-lease4-resend-ddns:
+
+.. _command-lease6-resend-ddns:
+
+The lease4-resend-ddns, lease6-resend-ddns Commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``lease4-resend-ddns`` or ``lease6-resend-ddns`` can be used to generate
+a request to kea-dhcp-ddns to update the DNS entries for an existing
+lease.  The desired lease is selected by a single parameter, "ip-address".
+In order for an update request to be generated, DDNS updating must be enabled
+and DNS must entries must have been made (or attempted) on the lease. In
+other words all of the following must be true:
+
+- DDNS updating must be enabled. (i.e. "dhcp-ddns":{ "enable-updates": true"})
+- The hostname on the lease must not be blank.
+- At least one of the DNS direction flags (fdqn_fwd or fdqn_rev) on the lease
+must be true.
+
+An example ``lease4-resend-ddns`` command for getting a lease using an IPv4
+address is:
+
+::
+
+   {
+       "command": "lease4-resend-ddns",
+       "arguments": {
+           "ip-address": "192.0.2.1"
+       }
+   }
+
+An example of the ``lease6-resend-ddns`` query is:
+
+::
+
+   {
+     "command": "lease6-resend-ddns",
+     "arguments": {
+       "ip-address": "2001:db8:1234:ab::"
+     }
+   }
+
+``leaseX-resend-ddns`` returns a result that indicates a result of the operation.
+It has one of the following values: 0 (success), 1 (error), or 2 (empty). An empty
+result means that a query has been completed properly, but the object (a lease in
+this case) has not been found.
+
+A successful result does not mean that DNS has been successfully updates. Rather it
+indicates that a request to update DNS has been created and queued for transmission
+to kea-dhcp-ddns.
+
+An example result returned when the lease was found:
+
+::
+
+   {
+     "result": 0,
+     "text": "NCR generated for: 2001:db8:1::1, hostname: example.com."
+   }
+
+.. _command-lease4-get-all:
+
+.. _command-lease6-get-all:
+
+
 The commands return a text description of the number of leases removed,
 plus the status code 0 (success) if any leases were removed or 2 (empty)
 if there were no leases. Status code 1 (error) may be returned if the