summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-subnet6-get-by-id.json
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 11:36:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 11:36:04 +0000
commit040eee1aa49b49df4698d83a05af57c220127fd1 (patch)
treef635435954e6ccde5eee9893889e24f30ca68346 /src/share/api/remote-subnet6-get-by-id.json
parentInitial commit. (diff)
downloadisc-kea-040eee1aa49b49df4698d83a05af57c220127fd1.tar.xz
isc-kea-040eee1aa49b49df4698d83a05af57c220127fd1.zip
Adding upstream version 2.2.0.upstream/2.2.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/share/api/remote-subnet6-get-by-id.json')
-rw-r--r--src/share/api/remote-subnet6-get-by-id.json53
1 files changed, 53 insertions, 0 deletions
diff --git a/src/share/api/remote-subnet6-get-by-id.json b/src/share/api/remote-subnet6-get-by-id.json
new file mode 100644
index 0000000..ac50327
--- /dev/null
+++ b/src/share/api/remote-subnet6-get-by-id.json
@@ -0,0 +1,53 @@
+{
+ "access": "read",
+ "avail": "1.6.0",
+ "brief": [
+ "This command fetches the selected IPv6 subnet by ID from the configuration database."
+ ],
+ "cmd-comment": [
+ "This command includes a list with exactly one ID of the subnet to be returned. The ``server-tags`` parameter must not be specified for this command."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-subnet6-get-by-id\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>",
+ " }",
+ " ],",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " }",
+ " }",
+ "}"
+ ],
+ "hook": "cb_cmds",
+ "name": "remote-subnet6-get-by-id",
+ "resp-comment": [
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (a global subnet). The metadata is included in the returned subnet definition and provides database-specific information associated with the returned object."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"IPv6 subnet found.\",",
+ " \"arguments\": {",
+ " \"subnets\": [",
+ " {",
+ " \"id\": <subnet identifier>,",
+ " \"subnet\": <subnet prefix>,",
+ " \"shared-network-name\": <shared network name> | null,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " },",
+ " <the rest of the subnet specification here>",
+ " }",
+ " ],",
+ " \"count\": 1",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp6"
+ ]
+}