[#2795] init reservations-get doc

diff --git a/doc/sphinx/arm/hooks-host-cmds.rst b/doc/sphinx/arm/hooks-host-cmds.rst
index 183997433b3c43d32c5df6b7d44f058854f25d6a..b205805006c060e1b5801623d32632698a6e03fc 100644 (file)
--- a/doc/sphinx/arm/hooks-host-cmds.rst
+++ b/doc/sphinx/arm/hooks-host-cmds.rst
@@ -367,6 +367,14 @@ An example result returned when the query was malformed might look like this:
 
    { "result": 1, "text": "No 'ip-address' provided and 'identifier-type' is either missing or not a string." }
 
+.. _command-reservations-get:
+
+The ``reservations-get`` Command
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``reservations-get`` can be used to query the host database and
+retrieve all reservations in a specified subnet for given ip address.
+
 .. isccmd:: reservation-get-all
 .. _command-reservation-get-all:
 

diff --git a/src/share/api/reservations-get.json b/src/share/api/reservations-get.json
index 57823bc642dd962392222b7b81b41251b3b79933..3bd6df47cfd4bdd1830d95e92fa5088a281a2cac 100644 (file)
--- a/src/share/api/reservations-get.json
+++ b/src/share/api/reservations-get.json
@@ -1,29 +1,29 @@
 {
-  "access": "read",
-  "avail": "2.3.9",
-  "brief": [
-    "This command retrieves all host reservations for a specified subnet and ip-address."
-  ],
-  "cmd-comment": [
-    "The host reservations can be identified by a pair of subnet-id, ip-address. Operation-target is optional; default is 'all'."
-  ],
-  "cmd-syntax": [
-    "{",
-    "    \"command\": \"reservation-get-all\",",
-    "    \"arguments\": {",
-    "        \"subnet-id\": <integer>,",
-    "        \"ip-address\": <string>,",
-    "        \"operation-target\": <string (primary, alternate, all, default)>",
-    "    }",
-    "}"
-  ],
-  "hook": "host_cmds",
-  "name": "reservations-get",
-  "resp-comment": [
-    "The reservations-get may return many reservations for the same ip-address. This is useful in case ip-reservations-unique configuration flag is set to false."
-  ],
-  "support": [
-    "kea-dhcp4",
-    "kea-dhcp6"
-  ]
+    "access": "read",
+    "avail": "2.3.9",
+    "brief": [
+        "This command retrieves all host reservations for a specified subnet and ip-address."
+    ],
+    "cmd-comment": [
+        "The host reservations can be identified by a pair of subnet-id, ip-address. Operation-target is optional; default is 'all'."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"reservations-get\",",
+        "    \"arguments\": {",
+        "        \"subnet-id\": <integer>,",
+        "        \"ip-address\": <string>,",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "    }",
+        "}"
+    ],
+    "hook": "host_cmds",
+    "name": "reservations-get",
+    "resp-comment": [
+       "The reservations-get may return many reservations for the same ip-address. This is useful in case ip-reservations-unique configuration flag is set to false."
+    ],
+    "support": [
+        "kea-dhcp4",
+        "kea-dhcp6"
+    ]
 }