From: Tomek Mrugalski <tomasz@isc.org>
Date: Thu, 18 Jul 2019 12:07:25 +0000 (+0200)
Subject: [#644,!370] Manual apply of 8ca01ae0f28a77da251c8d1d1681755d8649cef2
X-Git-Tag: Kea-1.6.1~10^2~66
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=712bab0d20b93afe0ac34e97d7b92fa8d78f73d5;p=thirdparty%2Fkea.git

[#644,!370] Manual apply of 8ca01ae0f28a77da251c8d1d1681755d8649cef2
---

diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst
index 58e956b5d5..50cadfff62 100644
--- a/doc/sphinx/arm/hooks-lease-cmds.rst
+++ b/doc/sphinx/arm/hooks-lease-cmds.rst
@@ -286,13 +286,11 @@ or update two other leases in the database:
       "arguments": {
           "deleted-leases": [
               {
-                  "subnet-id": 66,
                   "ip-address": "2001:db8:abcd::",
                   "type": "IA_PD",
                   ...
               },
               {
-                  "subnet-id": 66,
                   "ip-address": "2001:db8:abcd::234",
                   "type": "IA_NA",
                   ...
@@ -330,17 +328,18 @@ listed in the response. For example:
         "arguments": {
             "failed-deleted-leases": [
                 {
-                    "subnet-id": 66,
                     "ip-address": "2001:db8:abcd::",
-                    "type": "IA_PD"
+                    "type": "IA_PD",
+                    "result": 3,
+                    "error-message": "no lease found"
                 }
             ],
             "failed-leases": [
                 {
-                    "subnet-id": 66,
                     "ip-address": "2001:db8:cafe::",
                     "type": "IA_PD",
-                    ...
+                    "result": 1,
+                    "error-message": "unable to communicate with the lease database"
                 }
             ]
         }
@@ -349,7 +348,14 @@ listed in the response. For example:
 The response above indicates that the hooks library was unable to
 delete the lease for prefix "2001:db8:abcd::" and add or update the lease
 for prefix "2001:db8:cafe::". However, there are two other lease changes
-which have been applied as indicated by the text message.
+which have been applied as indicated by the text message. The
+``result`` is the status constant that indicates the type
+of the error experienced for the particular lease. The meaning of the
+returned codes are the same as the results returned for the commands.
+In particular, the result of 1 indicates an error while processing the
+lease, e.g. a communication error with the database. The result of 3
+indicates that an attempt to delete the lease was unsuccessful because
+such lease doesn't exist (empty result).
 
 .. _command-lease4-get: