diff options
Diffstat (limited to 'src/share/api/remote-class4-get.json')
-rw-r--r-- | src/share/api/remote-class4-get.json | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/share/api/remote-class4-get.json b/src/share/api/remote-class4-get.json new file mode 100644 index 0000000..5dfdcb5 --- /dev/null +++ b/src/share/api/remote-class4-get.json @@ -0,0 +1,51 @@ +{ + "access": "read", + "avail": "1.9.10", + "brief": [ + "This command fetches a selected DHCPv4 client class by name from the specified database." + ], + "cmd-comment": [ + "This command includes a list with exactly one name of the client class to be returned. The ``server-tags`` parameter must not be specified for this command." + ], + "cmd-syntax": [ + "{", + " \"command\": \"remote-class4-get\",", + " \"arguments\": {", + " \"client-classes\": [", + " {", + " \"name\": <client class name>", + " }", + " ],", + " \"remote\": {", + " <specification of the database to connect to>", + " }", + " }", + "}" + ], + "hook": "cb_cmds", + "name": "remote-class4-get", + "resp-comment": [ + "The metadata is included in the returned shared network definition and provides the database-specific information associated with the returned object." + ], + "resp-syntax": [ + "{", + " \"result\": 0,", + " \"text\": \"DHCPv4 client class found.\",", + " \"arguments\": {", + " \"client-classes\": [", + " {", + " \"name\": <client class name>,", + " \"metadata\": {", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", + " },", + " <the rest of the client class information>", + " }", + " ],", + " \"count\": 1", + " }", + "}" + ], + "support": [ + "kea-dhcp4" + ] +} |