]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2901] Updated ARM after operation-target rename
authorMarcin Siodelski <marcin@isc.org>
Wed, 28 Jun 2023 12:01:24 +0000 (14:01 +0200)
committerMarcin Siodelski <marcin@isc.org>
Thu, 29 Jun 2023 05:23:01 +0000 (07:23 +0200)
doc/sphinx/arm/hooks-host-cmds.rst
src/share/api/reservation-add.json
src/share/api/reservation-del.json
src/share/api/reservation-get-all.json
src/share/api/reservation-get-by-address.json
src/share/api/reservation-get-by-hostname.json
src/share/api/reservation-get-by-id.json
src/share/api/reservation-get.json
src/share/api/reservation-update.json

index 5c941cb8303196b65f512795a99206108025e115..52ee87d36c721efc26f30f1c96a5417adf383192 100644 (file)
@@ -119,20 +119,21 @@ server) and this entry is ignored.
 The ``operation-target`` Parameter
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Most host commands accept the ``operation-target`` parameter that specifies the
-database(s) to query. The commands may process data from the JSON configuration
-(primary source), the hosts database (alternate source), or both of them
-(all sources). The operation target parameter is optional. By default, the
-commands that only read the data use all data sources (JSON configuration and
-hosts database); the commands that modify the state (as :isccmd:`reservation-add`,
-:isccmd:`reservation-del`, and :isccmd:`reservation-update`) only use the alternate source.
-
-The operation target accepts the following values:
-
-- ``primary`` - query the primary source - JSON configuration.
-- ``alternate`` - query the alternate source - hosts database(s).
-- ``all`` - query both sources - JSON configuration and host database(s).
-- ``default`` - query the default source - it's command specific.
+Most host commands accept the ``operation-target`` parameter that selects
+the host data source. The commands may process data from the server
+configuration (i.e., memory operation target), a database (database target),
+or both of them (all sources). The operation target parameter is optional.
+By default, the commands that only read the data use all data sources
+(memory and database); the commands that modify the state (i.e., :isccmd:`reservation-add`,
+:isccmd:`reservation-del`, and :isccmd:`reservation-update`) only use the
+database target.
+
+The ``operation-target`` parameter accepts the following values:
+
+- ``memory`` - query or update the runtime server configuration.
+- ``database`` - query or update host database(s).
+- ``all`` - query or update both runtime configuration and host database(s).
+- ``default`` - query or update a default host data source - it is command specific.
 
 .. isccmd:: reservation-add
 .. _command-reservation-add:
index 9115645062d7e6133019505c779f9d8f063aae7f..6e9259e8bf006f525312881b7b45940ff8b04079 100644 (file)
@@ -29,7 +29,7 @@
         "            \"subnet-id\": <integer>,",
         "            \"user-context\": <any valid JSON>",
         "        },",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index b913b139af522cf9dcb0c97219bc120f1fb22fb4..5f840c7fee708d9e38f6d94a3568cc8fd186da06 100644 (file)
@@ -15,7 +15,7 @@
         "        \"ip-address\": <string>,",
         "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
         "        \"identifier\": <string>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index 19fd18955c213099fdbc4336c122dbdcf6fb07d5..c95d5c4ae91e229942dbec9a848df82f36e73066 100644 (file)
@@ -12,7 +12,7 @@
         "    \"command\": \"reservation-get-all\",",
         "    \"arguments\": {",
         "        \"subnet-id\": <integer>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index 4a1eb5fc08f6d73fd690fe19748ecbe6a90cef5b..c7ee556f2478b9e48b0817f0b158647ab3e03791 100644 (file)
@@ -13,7 +13,7 @@
         "    \"arguments\": {",
         "        \"ip-address\": <string>,",
         "        \"subnet-id\": <integer>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index 86f4f225edb4d62cb8c3c10cc64005fa81a4722a..f1f7aa3e2653df696609abf12ea05afdb1cbc382 100644 (file)
@@ -13,7 +13,7 @@
         "    \"arguments\": {",
         "        \"hostname\": <hostname>,",
         "        \"subnet-id\": <integer>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index 9f90be88e7330c1e9c2ec1e843f9fc25015c79aa..75e650e1a6608a0107aa177099f6ef7fbd888769 100644 (file)
@@ -13,7 +13,7 @@
         "    \"arguments\": {",
         "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
         "        \"identifier\": <string>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index f42a0ade7e33cce6995aa313fc257f53b928ac73..9b721e8166ccd41241efb59fb61365522f3c945f 100644 (file)
@@ -14,7 +14,7 @@
         "        \"subnet-id\": <integer>,",
         "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
         "        \"identifier\": <string>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
index d998e75877a9c0d59794b5440f1a728b8b0d8eba..f40a8e80aecbfbca37eb61d0901302787a2cfed5 100644 (file)
@@ -29,7 +29,7 @@
         "            \"subnet-id\": <integer>,",
         "            \"user-context\": <any valid JSON>",
         "        },",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],