From: Marcin Siodelski Date: Thu, 16 May 2019 18:01:38 +0000 (+0200) Subject: [#71,!314] Updated hooks-cb-cmds with more examples. X-Git-Tag: Kea-1.6.0-beta~58 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2c7f3338c797725dd22b5436ed148620496105f8;p=thirdparty%2Fkea.git [#71,!314] Updated hooks-cb-cmds with more examples. --- diff --git a/doc/api/remote-global-parameter4-del.json b/doc/api/remote-global-parameter4-del.json index f626ee1f10..43cd91544d 100644 --- a/doc/api/remote-global-parameter4-del.json +++ b/doc/api/remote-global-parameter4-del.json @@ -1,7 +1,6 @@ { "name": "remote-global-parameter4-del", - "brief": "This command is used to delete a global DHCPv4 parameter from a configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database.", - "description": "See ", + "brief": "This command is used to delete a global DHCPv4 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database.", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -14,10 +13,10 @@ } } }", - "cmd-comment": "This command includes a list with exactly one name of the parameter to be deleted. The remote map contains specification of the backend from which the global parameter should be deleted. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command carries the list including exactly one name of the parameter to be deleted.", "resp-syntax": "{ \"result\": 0, - \"text\": \"DHCPv4 global parameter successfully deleted.\", + \"text\": \"DHCPv4 global parameter(s) deleted.\", \"arguments\": { \"count\": 1 } diff --git a/doc/api/remote-global-parameter4-get-all.json b/doc/api/remote-global-parameter4-get-all.json index 469b40aa2b..9e6e511a18 100644 --- a/doc/api/remote-global-parameter4-get-all.json +++ b/doc/api/remote-global-parameter4-get-all.json @@ -1,7 +1,6 @@ { "name": "remote-global-parameter4-get-all", "brief": "This command is used to fetch all global parameters for the server from the specified database.", - "description": "See ", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -13,7 +12,7 @@ } } }", - "cmd-comment": "The remote map contains specification of the backend from which the global parameters should be fetched. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command contains no arguments besides the optional remote.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameters found.\", diff --git a/doc/api/remote-global-parameter4-get.json b/doc/api/remote-global-parameter4-get.json index 34e8ee4613..be62d1910b 100644 --- a/doc/api/remote-global-parameter4-get.json +++ b/doc/api/remote-global-parameter4-get.json @@ -1,7 +1,6 @@ { "name": "remote-global-parameter4-get", "brief": "This command is used to fetch selected global parameter for the server from the specified database.", - "description": "See ", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -13,10 +12,8 @@ } } -} - -", - "cmd-comment": "The remote map contains specification of the backend from which the global parameters should be fetched. Typically it contains \"type\": \"mysql\".", +}", + "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameter found.\", diff --git a/doc/api/remote-global-parameter4-set.json b/doc/api/remote-global-parameter4-set.json index e57bbfc644..622ca47e32 100644 --- a/doc/api/remote-global-parameter4-set.json +++ b/doc/api/remote-global-parameter4-set.json @@ -1,7 +1,6 @@ { "name": "remote-global-parameter4-set", - "brief": "This command is used to create or update one more global parameters for a server.", - "description": "See ", + "brief": "This command is used to create or update one more global parameters in the configuration database.", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -17,7 +16,7 @@ } } }", - "cmd-comment": "The remote map contains specification of the backend where global parameter should be set. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because in some cases only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the remote-global-parameter4-get-all may be useful to verify the contents of the database after the update.", "resp-syntax": "{ \"result\": 0, \"text\": \"DHCPv4 global parameter(s) successfully set.\" diff --git a/doc/api/remote-global-parameter6-del.json b/doc/api/remote-global-parameter6-del.json index ce280c12c5..faba037271 100644 --- a/doc/api/remote-global-parameter6-del.json +++ b/doc/api/remote-global-parameter6-del.json @@ -1,12 +1,23 @@ { "name": "remote-global-parameter6-del", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to delete a global DHCPv6 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-global-parameter6-del\", + \"arguments\": { + \"parameters\": [ ], + \"remote\": { + + } + } +}", + "cmd-comment": "This command carries the list including exactly one name of the parameter to be deleted.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"DHCPv6 global parameter(s) deleted.\", + \"arguments\": { + \"count\": 1 + }" } diff --git a/doc/api/remote-global-parameter6-get-all.json b/doc/api/remote-global-parameter6-get-all.json index b40b4eb847..667c7c8f24 100644 --- a/doc/api/remote-global-parameter6-get-all.json +++ b/doc/api/remote-global-parameter6-get-all.json @@ -1,12 +1,38 @@ { "name": "remote-global-parameter6-get-all", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to fetch all global parameters for the server from the specified database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-global-parameter6-get-all\" + \"arguments\": { + \"remote\": { + + } + } +}", + "cmd-comment": "This command contains no arguments besides the optional remote.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"DHCPv6 global parameters found.\", + \"arguments\": { + \"parameters\": [ + { + : , + \"metadata\": { + \"server-tag\": + } + }, + { + : , + \"metadata\": { + \"server-tag\": + } + } + ], + \"count\": 2 + } +}", + "resp-comment": "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects." } diff --git a/doc/api/remote-global-parameter6-get.json b/doc/api/remote-global-parameter6-get.json index 4774608b10..fb94e973e9 100644 --- a/doc/api/remote-global-parameter6-get.json +++ b/doc/api/remote-global-parameter6-get.json @@ -1,12 +1,31 @@ { "name": "remote-global-parameter6-get", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to fetch selected global parameter for the server from the specified database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-global-parameter6-get\" + \"arguments\": { + \"parameters\": [ ], + \"remote\": { + + } + } +}", + "cmd-comment": "This command carries a list including exactly one name of the parameter to be fetched.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"DHCPv6 global parameter found.\", + \"arguments\": { + \"parameters\": { + : , + \"metadata\": { + \"server-tag\": + } + }, + \"count\": 1 + } +}", + "resp-comment": "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object." } diff --git a/doc/api/remote-global-parameter6-set.json b/doc/api/remote-global-parameter6-set.json index 6258861bd0..0ad6d4bf3a 100644 --- a/doc/api/remote-global-parameter6-set.json +++ b/doc/api/remote-global-parameter6-set.json @@ -1,12 +1,24 @@ { "name": "remote-global-parameter6-set", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to create or update one more global DHCP parameters in the configuration database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-global-parameter6-set\" + \"arguments\": { + \"parameters\": { + : , + : + }, + \"remote\": { + + } + } +}", + "cmd-comment": "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter because in some cases only a subset of the parameters may be successfully stored in the database and other parameters may fail to be stored. In such cases the remote-global-parameter6-get-all may be useful to verify the contents of the database after the update.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"DHCPv6 global parameter(s) successfully set.\" +}" } diff --git a/doc/api/remote-network4-del.json b/doc/api/remote-network4-del.json index 7d4846bbc3..d72b748e08 100644 --- a/doc/api/remote-network4-del.json +++ b/doc/api/remote-network4-del.json @@ -1,23 +1,24 @@ { "name": "remote-network4-del", "brief": "This command is used to delete an IPv4 shared network from the configuration database.", - "description": "See ", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", "cmd-syntax": "{ \"command\": \"remote-network4-del\", \"arguments\": { - \"shared-networks\": [ { - \"name\": - } ], + \"shared-networks\": [ + { + \"name\": + } + ], \"subnets-action\": \"keep\" | \"delete\", \"remote\": { } } }", - "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The subnets-action denotes whether the subnets in this shared network should be deleted or not. The remote map contains specification of the backend from which the shared network should be deleted. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The subnets-action denotes whether the subnets in this shared network should be deleted or not.", "resp-syntax": "{ \"result\": 0, \"text\": \"1 IPv4 shared network(s) deleted.\", diff --git a/doc/api/remote-network4-get.json b/doc/api/remote-network4-get.json index b81098aac6..b48ee7a786 100644 --- a/doc/api/remote-network4-get.json +++ b/doc/api/remote-network4-get.json @@ -1,36 +1,39 @@ { "name": "remote-network4-get", "brief": "This command is used to fetch selected IPv4 shared network for the server from the specified database.", - "description": "See ", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", "cmd-syntax": "{ \"command\": \"remote-network4-get\" \"arguments\": { - \"shared-networks\": [ { - \"name\": - } ], + \"shared-networks\": [ + { + \"name\": + } + ], \"subnets-include\": \"full\" | \"no\", \"remote\": { } } }", - "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The subnets-include optional parameter allows for specifying whether subnets belonging to the shared network should also be returned. The remote map contains specification of the backend from which the shared network should be fetched. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The subnets-include optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned.", "resp-syntax": "{ \"result\": 0, - \"text\": \"IPv4 shared network 'floor1' found.\", + \"text\": \"IPv4 shared network found.\", \"arguments\": { - \"shared-networks\": [ { - \"name\": , - \"metadata\": { - \"server-tag\": - }, - - } ], + \"shared-networks\": [ + { + \"name\": , + \"metadata\": { + \"server-tag\": + }, + + } + ], \"count\": 1 } }", - "resp-comment": "The metadata is included in the returned shared network definition and it provides database specific information associated with the returned object." + "resp-comment": "If the subnets are returned with the shared network they are carried in the subnet4 list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object." } diff --git a/doc/api/remote-network4-list.json b/doc/api/remote-network4-list.json index d6f882e5cc..e69b5722b7 100644 --- a/doc/api/remote-network4-list.json +++ b/doc/api/remote-network4-list.json @@ -1,7 +1,6 @@ { "name": "remote-network4-list", - "brief": "This command is used to fetch a list of all subnets for the particular server from the specified database.", - "description": "See ", + "brief": "This command is used to fetch a list of all IPv4 shared networks from the configuration database.", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -13,7 +12,7 @@ } } }", - "cmd-comment": "The remote map contains specification of the backend from which the shared networks should be fetched. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command contains no arguments besides the optional remote.", "resp-syntax": "{ \"result\": 0, \"text\": \"2 IPv4 shared network(s) found.\", @@ -35,5 +34,5 @@ \"count\": 2 } }", - "resp-comment": "The returned response contains a list of maps. Each map contains a shared network name and the metadata which provides database specific information associated with the shared networks. The returned list does not contain full definitions of the shared networks. Use remote-network4-get to fetch the full information about the selected shared networks." + "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use remote-network4-get to fetch the full information about the selected shared networks." } diff --git a/doc/api/remote-network4-set.json b/doc/api/remote-network4-set.json index 0db21abe82..435d3e382a 100644 --- a/doc/api/remote-network4-set.json +++ b/doc/api/remote-network4-set.json @@ -1,22 +1,23 @@ { "name": "remote-network4-set", - "brief": "This command is used to create or update IPv4 shared network for a server in the specified database.", - "description": "See ", + "brief": "This command is used to create or replace an IPv4 shared network in the configuration database.", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", "cmd-syntax": "{ \"command\": \"remote-network4-set\", \"arguments\": { - \"shared-networks\": [ { - - } ], + \"shared-networks\": [ + { + + } + ], \"remote\": { } } }", - "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (subnet4 parameter). The subnets are added to the shared network using remote-subnet4-set command. The remote map contains specification of the backend where shared network should be set. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet4\" parameter). The subnets are added to the shared network using remote-subnet4-set command.", "resp-syntax": "{ \"result\": 0, \"text\": \"IPv4 shared network successfully set.\" diff --git a/doc/api/remote-network6-del.json b/doc/api/remote-network6-del.json index d92b9f7867..570a132097 100644 --- a/doc/api/remote-network6-del.json +++ b/doc/api/remote-network6-del.json @@ -1,12 +1,29 @@ { "name": "remote-network6-del", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to delete an IPv6 shared network from the configuration database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-network6-del\", + \"arguments\": { + \"shared-networks\": [ + { + \"name\": + } + ], + \"subnets-action\": \"keep\" | \"delete\", + \"remote\": { + + } + } +}", + "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The subnets-action denotes whether the subnets in this shared network should be deleted or not.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"1 IPv6 shared network(s) deleted.\", + \"arguments\": { + \"count\": 1 + } +}" } diff --git a/doc/api/remote-network6-get.json b/doc/api/remote-network6-get.json index 5e6ff2e7e2..11ddab1203 100644 --- a/doc/api/remote-network6-get.json +++ b/doc/api/remote-network6-get.json @@ -1,12 +1,39 @@ { "name": "remote-network6-get", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to fetch selected IPv6 shared network for the server from the specified database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-network6-get\" + \"arguments\": { + \"shared-networks\": [ + { + \"name\": + } + ], + \"subnets-include\": \"full\" | \"no\", + \"remote\": { + + } + } +}", + "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The subnets-include optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"IPv6 shared network found.\", + \"arguments\": { + \"shared-networks\": [ + { + \"name\": , + \"metadata\": { + \"server-tag\": + }, + + } + ], + \"count\": 1 + } +}", + "resp-comment": "If the subnets are returned with the shared network they are carried in the subnet6 list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object." } diff --git a/doc/api/remote-network6-list.json b/doc/api/remote-network6-list.json index 015c61bcad..9fb1e0edcd 100644 --- a/doc/api/remote-network6-list.json +++ b/doc/api/remote-network6-list.json @@ -1,12 +1,38 @@ { "name": "remote-network6-list", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to fetch a list of all IPv6 shared networks from the configuration database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-network6-list\" + \"arguments\": { + \"remote\": { + + } + } +}", + "cmd-comment": "This command contains no arguments besides the optional remote.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"2 IPv6 shared network(s) found.\", + \"arguments\": { + \"shared-networks\": [ + { + \"name\": , + \"metadata\": { + \"server-tag\": + } + }, + { + \"name\": , + \"metadata\": { + \"server-tag\": + } + } + ], + \"count\": 2 + } +}", + "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use remote-network6-get to fetch the full information about the selected shared networks." } diff --git a/doc/api/remote-network6-set.json b/doc/api/remote-network6-set.json index 5a7c6de438..1ed48e25a2 100644 --- a/doc/api/remote-network6-set.json +++ b/doc/api/remote-network6-set.json @@ -1,12 +1,25 @@ { "name": "remote-network6-set", - "brief": "a sentence or two explaining what this command does", - "description": "See ", - "support": [ "undocumented" ], - "avail": "0.0.0", - "hook": "undocumented", - "cmd-syntax": "Syntax of the command", - "cmd-comment": "Possibly some extra comments after the syntax.", - "resp-syntax": "Syntax of the response", - "resp-comment": "Optional extra comments after the resposne syntax." + "brief": "This command is used to create or replace an IPv6 shared network in the configuration database.", + "support": [ "kea-dhcp6" ], + "avail": "1.6.0", + "hook": "cb_cmds", + "cmd-syntax": "{ + \"command\": \"remote-network6-set\", + \"arguments\": { + \"shared-networks\": [ + { + + } + ], + \"remote\": { + + } + } +}", + "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet6\" parameter). The subnets are added to the shared network using remote-subnet6-set command.", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"IPv6 shared network successfully set.\" +}" } diff --git a/doc/api/remote-option-def4-del.json b/doc/api/remote-option-def4-del.json index 0d28d516a6..0eeee2cf5d 100644 --- a/doc/api/remote-option-def4-del.json +++ b/doc/api/remote-option-def4-del.json @@ -1,7 +1,6 @@ { "name": "remote-option-def4-del", "brief": "This command is used to delete a DHCPv4 option definition from the configuration database.", - "description": "See ", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -17,7 +16,7 @@ } } }", - "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. The remote map contains specification of the backend from which the shared network should be deleted. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code.", "resp-syntax": "{ \"result\": 0, \"text\": \"1 DHCPv4 option definition(s) deleted.\", diff --git a/doc/api/remote-option-def4-get-all.json b/doc/api/remote-option-def4-get-all.json index 29cae42e7f..f921204d45 100644 --- a/doc/api/remote-option-def4-get-all.json +++ b/doc/api/remote-option-def4-get-all.json @@ -1,7 +1,6 @@ { "name": "remote-option-def4-get-all", - "brief": "This command is used to fetch all option definitions for the server from the specified database.", - "description": "See ", + "brief": "This command is used to fetch all DHCPv4 option definitions from the configuration database.", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", @@ -13,7 +12,7 @@ } } }", - "cmd-comment": "The remote map contains specification of the backend from which the global parameters should be fetched. Typically it contains \"type\": \"mysql\".", + "cmd-comment": "This command contains no arguments besides the optional remote.", "resp-syntax": "{ \"result\": 0, \"text\": \"2 DHCPv4 option definition(s) found.\", @@ -32,7 +31,7 @@ } } ], - \"count\": + \"count\": 2 } }", "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects." diff --git a/doc/api/remote-option-def4-get.json b/doc/api/remote-option-def4-get.json index 8bfc87cf8c..0e625a1d84 100644 --- a/doc/api/remote-option-def4-get.json +++ b/doc/api/remote-option-def4-get.json @@ -1,33 +1,36 @@ { "name": "remote-option-def4-get", - "brief": "This command is used to fetch DHCPv4 option definition for the server from the specified database.", - "description": "See ", + "brief": "This command is used to fetch a DHCPv4 option definition from the configuration database.", "support": [ "kea-dhcp4" ], "avail": "1.6.0", "hook": "cb_cmds", "cmd-syntax": "{ \"command\": \"remote-option-def4-get\", \"arguments\": { - \"option-defs\": [ { - \"code\":