From: Marcin Siodelski <marcin@isc.org>
Date: Wed, 28 Jun 2023 12:01:24 +0000 (+0200)
Subject: [#2901] Updated ARM after operation-target rename
X-Git-Tag: Kea-2.4.0~36
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=0f4386b37277210a169789f3cb7100a73b55e493;p=thirdparty%2Fkea.git

[#2901] Updated ARM after operation-target rename
---

diff --git a/doc/sphinx/arm/hooks-host-cmds.rst b/doc/sphinx/arm/hooks-host-cmds.rst
index 5c941cb830..52ee87d36c 100644
--- a/doc/sphinx/arm/hooks-host-cmds.rst
+++ b/doc/sphinx/arm/hooks-host-cmds.rst
@@ -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:
diff --git a/src/share/api/reservation-add.json b/src/share/api/reservation-add.json
index 9115645062..6e9259e8bf 100644
--- a/src/share/api/reservation-add.json
+++ b/src/share/api/reservation-add.json
@@ -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)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-del.json b/src/share/api/reservation-del.json
index b913b139af..5f840c7fee 100644
--- a/src/share/api/reservation-del.json
+++ b/src/share/api/reservation-del.json
@@ -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)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-all.json b/src/share/api/reservation-get-all.json
index 19fd18955c..c95d5c4ae9 100644
--- a/src/share/api/reservation-get-all.json
+++ b/src/share/api/reservation-get-all.json
@@ -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)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-by-address.json b/src/share/api/reservation-get-by-address.json
index 4a1eb5fc08..c7ee556f24 100644
--- a/src/share/api/reservation-get-by-address.json
+++ b/src/share/api/reservation-get-by-address.json
@@ -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)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-by-hostname.json b/src/share/api/reservation-get-by-hostname.json
index 86f4f225ed..f1f7aa3e26 100644
--- a/src/share/api/reservation-get-by-hostname.json
+++ b/src/share/api/reservation-get-by-hostname.json
@@ -13,7 +13,7 @@
         "    \"arguments\": {",
         "        \"hostname\": <hostname>,",
         "        \"subnet-id\": <integer>,",
-        "        \"operation-target\": <string (primary, alternate, all, default)>",
+        "        \"operation-target\": <string (memory, database, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-by-id.json b/src/share/api/reservation-get-by-id.json
index 9f90be88e7..75e650e1a6 100644
--- a/src/share/api/reservation-get-by-id.json
+++ b/src/share/api/reservation-get-by-id.json
@@ -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)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get.json b/src/share/api/reservation-get.json
index f42a0ade7e..9b721e8166 100644
--- a/src/share/api/reservation-get.json
+++ b/src/share/api/reservation-get.json
@@ -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)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-update.json b/src/share/api/reservation-update.json
index d998e75877..f40a8e80ae 100644
--- a/src/share/api/reservation-update.json
+++ b/src/share/api/reservation-update.json
@@ -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)>",
         "    }",
         "}"
     ],