diff options
Diffstat (limited to 'src/share/api/remote-server4-get.json')
| -rw-r--r-- | src/share/api/remote-server4-get.json | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/src/share/api/remote-server4-get.json b/src/share/api/remote-server4-get.json new file mode 100644 index 0000000..c648606 --- /dev/null +++ b/src/share/api/remote-server4-get.json @@ -0,0 +1,48 @@ +{ + "access": "read", + "avail": "1.6.0", + "brief": [ + "This command fetches information about the DHCPv4 server, such as the server tag and description." + ], + "cmd-comment": [ + "This command carries the list including exactly one map with the tag of the server to be fetched." + ], + "cmd-syntax": [ + "{", + " \"command\": \"remote-server4-get\",", + " \"arguments\": {", + " \"servers\": [", + " {", + " \"server-tag\": <server tag>", + " }", + " ],", + " \"remote\": {", + " <specification of the database to connect to>", + " }", + " }", + "}" + ], + "hook": "cb_cmds", + "name": "remote-server4-get", + "resp-comment": [ + "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information." + ], + "resp-syntax": [ + "{", + " \"result\": 0,", + " \"text\": \"DHCP server 'server tag' found.\",", + " \"arguments\": {", + " \"servers\": [", + " {", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", + " }", + " ],", + " \"count\": 1", + " }", + "}" + ], + "support": [ + "kea-dhcp4" + ] +} |