diff options
Diffstat (limited to 'src/share/api/remote-subnet4-get-by-prefix.json')
| -rw-r--r-- | src/share/api/remote-subnet4-get-by-prefix.json | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/share/api/remote-subnet4-get-by-prefix.json b/src/share/api/remote-subnet4-get-by-prefix.json new file mode 100644 index 0000000..fec9e54 --- /dev/null +++ b/src/share/api/remote-subnet4-get-by-prefix.json @@ -0,0 +1,51 @@ +{ + "access": "read", + "avail": "1.6.0", + "brief": [ + "This command fetches the selected IPv4 subnet by prefix from the configuration database." + ], + "cmd-comment": [ + "This command includes a list with exactly one prefix of the subnet to be returned. The ``server-tags`` parameter must not be specified for this command." + ], + "cmd-syntax": [ + "{", + " \"command\": \"remote-subnet4-get-by-prefix\",", + " \"arguments\": {", + " \"subnets\": [ {", + " \"subnet\": <subnet prefix>", + " } ],", + " \"remote\": {", + " <specification of the database to connect to>", + " }", + " }", + "}" + ], + "hook": "cb_cmds", + "name": "remote-subnet4-get-by-prefix", + "resp-comment": [ + "If the shared network name is null, it means that the returned subnet does not belong to any shared network (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\": \"IPv4 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-dhcp4" + ] +} |