From: Marcin Siodelski Date: Mon, 15 Jul 2019 18:04:06 +0000 (+0200) Subject: [#643,!421] Regenerated api.xml. X-Git-Tag: Kea-1.6.0-beta2~24 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d065e3156a531e815b3c1068ed7067f8b8f06a99;p=thirdparty%2Fkea.git [#643,!421] Regenerated api.xml. --- diff --git a/doc/guide/api.xml b/doc/guide/api.xml index 00a1a4a5f6..7646599185 100644 --- a/doc/guide/api.xml +++ b/doc/guide/api.xml @@ -2693,13 +2693,14 @@ Result is an integer representation of the status. Currently supported statuses { "command": "remote-global-parameter4-del", "arguments": { - "parameters": [ <parameter name> ], + "parameters": [ <parameter name as string> ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command carries the list including exactly one name of the parameter to be deleted. +This command carries the list including exactly one name of the parameter to be deleted. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. Response syntax: { @@ -2736,13 +2737,14 @@ Result is an integer representation of the status. Currently supported statuses { "command": "remote-global-parameter4-get", "arguments": { - "parameters": [ <parameter name> ], + "parameters": [ <parameter name as string> ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command carries a list including exactly one name of the parameter to be fetched. +This command carries a list including exactly one name of the parameter to be fetched. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed to fetch the global parameter value shared by all servers. Response syntax: { @@ -2752,13 +2754,13 @@ This command carries a list including exactly one name of the parameter to be fe "parameters": { <parameter name>: <parameter value>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } }, "count": 1 } } -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. +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. If the "all" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers. @@ -2780,10 +2782,11 @@ The returned response contains a map with a global parameter name/value pair. Th "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command contains no arguments besides the optional remote. +The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag "all" is allowed to fetch the global parameters shared by all servers. Response syntax: { @@ -2794,20 +2797,20 @@ This command contains no arguments besides the optional remote -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. +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. If the server tag "all" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present. @@ -2833,10 +2836,11 @@ The returned response contains a list of maps. Each map contains a global parame }, "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -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. +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. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed and it associates the specified parameters with all servers. Response syntax: { @@ -2877,13 +2881,14 @@ Result is an integer representation of the status. Currently supported statuses { "command": "remote-global-parameter6-del", "arguments": { - "parameters": [ <parameter name> ], + "parameters": [ <parameter name as string> ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command carries the list including exactly one name of the parameter to be deleted. +This command carries the list including exactly one name of the parameter to be deleted. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. Response syntax: { @@ -2891,7 +2896,8 @@ This command carries the list including exactly one name of the parameter to be "text": "DHCPv6 global parameter(s) deleted.", "arguments": { "count": 1 - } + } +} Result is an integer representation of the status. Currently supported statuses are: 0 - success @@ -2917,15 +2923,16 @@ Result is an integer representation of the status. Currently supported statuses Command syntax: { - "command": "remote-global-parameter6-get" + "command": "remote-global-parameter6-get", "arguments": { - "parameters": [ <parameter name> ], + "parameters": [ <parameter name as string> ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command carries a list including exactly one name of the parameter to be fetched. +This command carries a list including exactly one name of the parameter to be fetched. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed to fetch the global parameter value shared by all servers. Response syntax: { @@ -2935,13 +2942,13 @@ This command carries a list including exactly one name of the parameter to be fe "parameters": { <parameter name>: <parameter value>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } }, "count": 1 } } -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. +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. If the "all" server tag was specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command will fetch the value associated with the given server. If the server specific value doesn't exist, it will try to fetch the value associated with all servers. @@ -2959,14 +2966,15 @@ The returned response contains a map with a global parameter name/value pair. Th Command syntax: { - "command": "remote-global-parameter6-get-all" + "command": "remote-global-parameter6-get-all", "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command contains no arguments besides the optional remote. +The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag "all" is allowed to fetch the global parameters shared by all servers. Response syntax: { @@ -2977,20 +2985,20 @@ This command contains no arguments besides the optional remote -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. +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. If the server tag "all" is included in the command, the response contains the global parameters shared between all servers. It excludes server specific global parameters. If an explicit server tag is included in the command, the response contains all global parameters directly associated with the given server and the global parameters associated with all servers when server specific values are not present. @@ -2998,7 +3006,7 @@ The returned response contains a list of maps. Each map contains a global parame
remote-global-parameter6-set reference -remote-global-parameter6-set - This command is used to create or update one more global DHCP parameters in the configuration database. +remote-global-parameter6-set - This command is used to create or update one more global parameters in the configuration database. Supported by: kea-dhcp6 @@ -3016,10 +3024,11 @@ The returned response contains a list of maps. Each map contains a global parame }, "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -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. +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. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed and it associates the specified parameters with all servers. Response syntax: { @@ -3071,7 +3080,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -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. +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 server-tags parameter must not be specified for this command. Response syntax: { @@ -3119,7 +3128,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -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. +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. The server-tags parameter must not be specified for this command. Response syntax: { @@ -3160,10 +3169,11 @@ If the subnets are returned with the shared network they are carried in the -This command contains no arguments besides the optional remote. +The server-tags list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single null value. Response syntax: { @@ -3174,20 +3184,20 @@ This command contains no arguments besides the optional remote -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. +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. If the command includes explicit server tags as strings (including the special server tag "all"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the null value in the server-tags list, the response contains all shared networks which are assigned to no servers (unassigned).
@@ -3214,10 +3224,11 @@ The returned response contains the list of maps. Each map contains the shared ne ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <first server tag>, <second server tag>, ... ] } } -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 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 server-tags list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag "all" to associate the network with all servers. Response syntax: { @@ -3262,7 +3273,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -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. +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 server-tags parameter must not be specified for this command. Response syntax: { @@ -3310,7 +3321,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -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. +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. The server-tags parameter must not be specified for this command. Response syntax: { @@ -3351,10 +3362,11 @@ If the subnets are returned with the shared network they are carried in the -This command contains no arguments besides the optional remote. +The server-tags list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single null value. Response syntax: { @@ -3365,20 +3377,20 @@ This command contains no arguments besides the optional remote -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. +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. If the command includes explicit server tags as strings (including the special server tag "all"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the null value in the server-tags list, the response contains all shared networks which are assigned to no servers (unassigned). @@ -3405,10 +3417,11 @@ The returned response contains the list of maps. Each map contains the shared ne ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <first server tag>, <second server tag>, ... ] } } -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. +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. The server-tags list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag "all" to associate the network with all servers. Response syntax: { @@ -3448,10 +3461,11 @@ Result is an integer representation of the status. Currently supported statuses } ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command includes a list with exactly one option definition specification comprising an option name and code. +This command includes a list with exactly one option definition specification comprising an option name and code. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. Response syntax: { @@ -3496,10 +3510,11 @@ Result is an integer representation of the status. Currently supported statuses ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -The desired option definition is identified by the pair of the option code/space values. +The desired option definition is identified by the pair of the option code/space values. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed to fetch the option definition instance shared by all servers. Response syntax: { @@ -3510,14 +3525,14 @@ The desired option definition is identified by the pair of the option code/space { <option definition>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } } ], "count": 1 } } -The metadata is included and it provides database specific information associated with the returned object. +The metadata is included and it provides database specific information associated with the returned object. If the "all" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers. @@ -3539,10 +3554,11 @@ The metadata is included and it provides database specific information associate "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command contains no arguments besides the optional remote. +The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag "all" is allowed to fetch the option definitions shared by all servers. Response syntax: { @@ -3553,20 +3569,20 @@ This command contains no arguments besides the optional remote -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. +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. If the server tag "all" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present. @@ -3593,10 +3609,11 @@ The returned response contains a list of maps. Each map contains an option defin ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -The provided list must contain exactly one option definition specification. +The provided list must contain exactly one option definition specification. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed and it associates the specified option definition with all servers. Response syntax: { @@ -3630,18 +3647,17 @@ Result is an integer representation of the status. Currently supported statuses { "command": "remote-option-def6-del", "arguments": { - "option-defs": [ - { - "code": <option code>, - "space": <option space - } - ], + "option-defs": [ { + "code": <option code>, + "space": <option space + } ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command includes a list with exactly one option definition specification comprising an option name and code. +This command includes a list with exactly one option definition specification comprising an option name and code. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. Response syntax: { @@ -3686,10 +3702,11 @@ Result is an integer representation of the status. Currently supported statuses ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -The desired option definition is identified by the pair of the option code/space values. +The desired option definition is identified by the pair of the option code/space values. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed to fetch the option definition instance shared by all servers. Response syntax: { @@ -3700,14 +3717,14 @@ The desired option definition is identified by the pair of the option code/space { <option definition>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } } ], "count": 1 } } -The metadata is included and it provides database specific information associated with the returned object. +The metadata is included and it provides database specific information associated with the returned object. If the "all" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers. @@ -3729,10 +3746,11 @@ The metadata is included and it provides database specific information associate "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command contains no arguments besides the optional remote. +The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag "all" is allowed to fetch the option definitions shared by all servers. Response syntax: { @@ -3743,20 +3761,20 @@ This command contains no arguments besides the optional remote -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. +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. If the server tag "all" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present. @@ -3783,10 +3801,11 @@ The returned response contains a list of maps. Each map contains an option defin ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -The provided list must contain exactly one option definition specification. +The provided list must contain exactly one option definition specification. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed and it associates the specified option definition with all servers. Response syntax: { @@ -3828,10 +3847,11 @@ Result is an integer representation of the status. Currently supported statuses ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command includes a list with exactly one option specification comprising an option name and code. +This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of null or multiple server tags will result in an error. Response syntax: { @@ -3876,9 +3896,10 @@ Result is an integer representation of the status. Currently supported statuses ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } -The option is identified by the pair of option code/space values. +The option is identified by the pair of option code/space values. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed to fetch the global option instance shared by all servers. Response syntax: { @@ -3889,13 +3910,13 @@ The option is identified by the pair of option code/space values. { <option information>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } } ] } } -The metadata is included and it provides database specific information associated with the returned object. +The metadata is included and it provides database specific information associated with the returned object. If the "all" server tag was specified, the command attempts to fetch the global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers. @@ -3917,10 +3938,11 @@ The metadata is included and it provides database specific information associate "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command takes no arguments besides the optional remote map. +The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag "all" is allowed to fetch the global options shared by all servers. Response syntax: { @@ -3931,20 +3953,20 @@ This command takes no arguments besides the optional remote m { <first option specification>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } }, { <second option specification>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } } ], "count": 2 } } -The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. +The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag "all" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present. @@ -3971,10 +3993,11 @@ The returned response contains a list of maps. Each map contains a global option ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -The provided list must cotain exactly one option specification. +The provided list must cotain exactly one option specification. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed and it associates the specified option with all servers. Response syntax: { @@ -4024,10 +4047,11 @@ Result is an integer representation of the status. Currently supported statuses ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command includes a list with exactly one option specification comprising an option name and code. +This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of null or multiple server tags will result in an error. Response syntax: { @@ -4052,7 +4076,7 @@ Result is an integer representation of the status. Currently supported statuses
remote-option6-global-get reference -remote-option6-global-get - This command is used to delete a DHCPv6 global option from the configuration database. +remote-option6-global-get - This command is used to fetch a global DHCPv6 option for the server from the specified database. Supported by: kea-dhcp6 @@ -4072,26 +4096,27 @@ Result is an integer representation of the status. Currently supported statuses ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } -The option is identified by the pair of option code/space values. +The option is identified by the pair of option code/space values. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed to fetch the global option instance shared by all servers. Response syntax: { "result": 0, - "text": "DHCPv6 option found.", + "text": "DHCPv6 option in found.", "arguments": { "options": [ { <option information>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } } ] } } -The metadata is included and it provides database specific information associated with the returned object. +The metadata is included and it provides database specific information associated with the returned object. If the "all" server tag was specified, the command attempts to fetch the global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers.
@@ -4113,10 +4138,11 @@ The metadata is included and it provides database specific information associate "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -This command takes no arguments besides the optional remote map. +The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The special server tag "all" is allowed to fetch the global options shared by all servers. Response syntax: { @@ -4127,20 +4153,20 @@ This command takes no arguments besides the optional remote m { <first option specification>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } }, { <second option specification>, "metadata": { - "server-tag": <server tag> + "server-tags": [ <server tag> ] } } ], "count": 2 } } -The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. +The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag "all" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present. @@ -4167,10 +4193,11 @@ The returned response contains a list of maps. Each map contains a global option ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <single server tag as string> ] } } -The provided list must cotain exactly one option specification. +The provided list must cotain exactly one option specification. The server-tags list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of null or multiple server tags will result in an error. The server tag "all" is allowed and it associates the specified option with all servers. Response syntax: { @@ -4604,7 +4631,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -This command includes a list with exactly one id of the subnet to be deleted. +This command includes a list with exactly one id of the subnet to be deleted. The server-tags parameter must not be specified for this command. Response syntax: { @@ -4651,7 +4678,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -This command includes a list with exactly one prefix of the subnet to be deleted. +This command includes a list with exactly one prefix of the subnet to be deleted. The server-tags parameter must not be specified for this command. Response syntax: { @@ -4696,7 +4723,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -This command includes a list with exactly one id of the subnet to be returned. +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. Response syntax: { @@ -4708,7 +4735,7 @@ This command includes a list with exactly one id of the subnet to be returned. -This command includes a list with exactly one prefix of the subnet to be returned. +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. Response syntax: { @@ -4756,7 +4783,7 @@ This command includes a list with exactly one prefix of the subnet to be returne "subnet": <subnet prefix>, "shared-network-name": <shared network name> | null, "metadata": { - "server-tag": <server tag> + "server-tags": [ <first server tag>, <second server tag>, ... ] }, <the rest of the subnet specification here> } @@ -4786,10 +4813,11 @@ If the shared network name is null, it means that the returned subnet does not b "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <first server tag>, <second server tag>, ... ] } } -This command includes no arguments besides the optional remote map. +The server-tags list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single null value. Response syntax: { @@ -4802,7 +4830,7 @@ This command includes no arguments besides the optional remoteremote -The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use remote-subnet4-get to fetch the full information about the selected subnets. +The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use remote-subnet4-get to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag "all"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the null value in the server-tags list, the response contains all subnets which are assigned to no servers (unassigned). @@ -4847,10 +4875,11 @@ The returned response contains a list of maps. Each map contains a subnet identi ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <first server tag>, <second server tag>, ... ] } } -The provided list must contain exactly one subnet specification. The shared-network-name parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the null value must be specified for the shared network name. +The provided list must contain exactly one subnet specification. The shared-network-name parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the null value must be specified for the shared network name. The server-tags list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag "all" to associate the subnet with all servers. Response syntax: { @@ -4898,7 +4927,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -This command includes a list with exactly one id of the subnet to be deleted. +This command includes a list with exactly one id of the subnet to be deleted. The server-tags parameter must not be specified for this command. Response syntax: { @@ -4945,7 +4974,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -This command includes a list with exactly one prefix of the subnet to be deleted. +This command includes a list with exactly one prefix of the subnet to be deleted. The server-tags parameter must not be specified for this command. Response syntax: { @@ -4992,7 +5021,7 @@ Result is an integer representation of the status. Currently supported statuses } } } -This command includes a list with exactly one id of the subnet to be returned. +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. Response syntax: { @@ -5005,7 +5034,7 @@ This command includes a list with exactly one id of the subnet to be returned. -This command includes a list with exactly one prefix of the subnet to be returned. +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. Response syntax: { @@ -5055,7 +5084,7 @@ This command includes a list with exactly one prefix of the subnet to be returne "subnet": <subnet prefix>, "shared-network-name": <shared network name> | null, "metadata": { - "server-tag": <server tag> + "server-tags": [ <first server tag>, <second server tag>, ... ] }, <the rest of the subnet specification here> } ], @@ -5084,10 +5113,11 @@ If the shared network name is null, it means that the returned subnet does not b "arguments": { "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <first server tag>, <second server tag>, ... ] } } -This command includes no arguments besides the optional remote map. +The server-tags list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single null value. Response syntax: { @@ -5100,7 +5130,7 @@ This command includes no arguments besides the optional remoteremote -The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use remote-subnet6-get to fetch the full information about the selected subnets. +The returned response contains a list of maps. Each map contains a subnet identifier, prefix and shared network name to which the subnet belongs. If the subnet does not belong to a shared netork the name is null. The metadata includes database specific information associated with the subnets. The returned list does not contain full subnet definitions. Use remote-subnet6-get to fetch the full information about the selected subnets. If the command includes explicit server tags as strings (including the special server tag "all"), the list contains all subnets which are associated with any of the specified tags. A subnet is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the null value in the server-tags list, the response contains all subnets which are assigned to no servers (unassigned). @@ -5123,7 +5153,7 @@ The returned response contains a list of maps. Each map contains a subnet identi
remote-subnet6-set reference -remote-subnet6-set - This command is used to create or replace an IPv4 subnet the configuration database. +remote-subnet6-set - This command is used to create or replace an IPv6 subnet the configuration database. Supported by: kea-dhcp6 @@ -5145,10 +5175,11 @@ The returned response contains a list of maps. Each map contains a subnet identi ], "remote": { <specification of the database to connect to> - } + }, + "server-tags": [ <first server tag>, <second server tag>, ... ] } } -The provided list must contain exactly one subnet specification. The shared-network-name parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the null value must be specified for the shared network name. +The provided list must contain exactly one subnet specification. The shared-network-name parameter is required for these commands. It associates the subnet with the shared network by its name. If the subnet must not belong to any shared network (global subnet), the null value must be specified for the shared network name. The server-tags list is mandatory and it must contain one or more server tags as strings to explicitly associate the subnet with one or more user defined servers. It may include the special server tag "all" to associate the subnet with all servers. Response syntax: {