"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."
],
"cmd-comment": [
- "This command carries the list including exactly one name of the parameter to be deleted. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch all global parameters for the server from the specified database."
],
"cmd-comment": [
- "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected global parameter for the server from the specified database."
],
"cmd-comment": [
- "This command carries a list including exactly one name of the parameter to be fetched. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to create or update one more global parameters in the configuration database."
],
"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 <command>remote-global-parameter4-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified parameters with all servers."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"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."
],
"cmd-comment": [
- "This command carries the list including exactly one name of the parameter to be deleted. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch all global parameters for the server from the specified database."
],
"cmd-comment": [
- "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected global parameter for the server from the specified database."
],
"cmd-comment": [
- "This command carries a list including exactly one name of the parameter to be fetched. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to create or update one more global parameters in the configuration database."
],
"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 <command>remote-global-parameter6-get-all</command> may be useful to verify the contents of the database after the update. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified parameters with all servers."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to delete an IPv4 shared network from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected IPv4 shared network for the server from the specified database."
],
"cmd-comment": [
- "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-network4-get",
"resp-comment": [
- "If the subnets are returned with the shared network they are carried in the <command>subnet4</command> 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."
+ "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."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a list of all IPv4 shared networks from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> 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 <command>null</command> value."
+ "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."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-network4-list",
"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 <command>remote-network4-get</command> 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 <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
+ "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)."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace an IPv4 shared network in the configuration database."
],
"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 <command>remote-subnet4-set</command> command. The <command>server-tags</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to delete an IPv6 shared network from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected IPv6 shared network for the server from the specified database."
],
"cmd-comment": [
- "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-network6-get",
"resp-comment": [
- "If the subnets are returned with the shared network they are carried in the <command>subnet6</command> 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."
+ "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."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a list of all IPv6 shared networks from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> 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 <command>null</command> value."
+ "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."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-network6-list",
"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 <command>remote-network6-get</command> 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 <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
+ "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)."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace an IPv6 shared network in the configuration database."
],
"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 <command>remote-subnet6-set</command> command. The <command>server-tags</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to delete a DHCPv4 option definition from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one option definition specification comprising an option name and code. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch all DHCPv4 option definitions from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a DHCPv4 option definition from the configuration database."
],
"cmd-comment": [
- "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace DHCPv4 option definition in the configuration database."
],
"cmd-comment": [
- "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to delete a DHCPv6 option definition from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one option definition specification comprising an option name and code. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch all DHCPv6 option definitions from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a DHCPv6 option definition from the configuration database."
],
"cmd-comment": [
- "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace DHCPv6 option definition in the configuration database."
],
"cmd-comment": [
- "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to delete a DHCPv4 global option from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch all DHCPv4 global options for the server from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a global DHCPv4 option for the server from the specified database."
],
"cmd-comment": [
- "The option is identified by the pair of option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace a DHCPv4 global option in the configuration database."
],
"cmd-comment": [
- "The provided list must cotain exactly one option specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option with all servers."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to delete a DHCPv6 global option from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one option specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch all DHCPv6 global options for the server from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a global DHCPv6 option for the server from the specified database."
],
"cmd-comment": [
- "The option is identified by the pair of option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace a DHCPv6 global option in the configuration database."
],
"cmd-comment": [
- "The provided list must cotain exactly one option specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option with all servers."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch information about all DHCPv4 servers specified by the user."
],
"cmd-comment": [
- "This command contains no arguments besides the optional <command>remote</command>."
+ "This command contains no arguments besides the optional ``remote``."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-server4-get-all",
"resp-comment": [
- "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server4-get-all</command>. Only the user defined servers are returned."
+ "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword ``all`` to associate parts of the configuration with all servers. Internally, it creates the logical server ``all`` for this purpose. However, this logical server is not returned as a result of the ``remote-server4-get-all``. Only the user defined servers are returned."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace information about the DHCPv4 server in the database."
],
"cmd-comment": [
- "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc."
+ "The provided list must contain exactly one server specification. The ``server-tag`` must be unique accross all servers within the configuration database. The ``description`` is the arbitrary text describing the server, its location within the network etc."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch information about all DHCPv6 servers specified by the user."
],
"cmd-comment": [
- "This command contains no arguments besides the optional <command>remote</command>."
+ "This command contains no arguments besides the optional ``remote``."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-server6-get-all",
"resp-comment": [
- "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server6-get-all</command>. Only the user defined servers are returned."
+ "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword ``all`` to associate parts of the configuration with all servers. Internally, it creates the logical server ``all`` for this purpose. However, this logical server is not returned as a result of the ``remote-server6-get-all``. Only the user defined servers are returned."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace information about the DHCPv6 server in the database."
],
"cmd-comment": [
- "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc."
+ "The provided list must contain exactly one server specification. The ``server-tag`` must be unique accross all servers within the configuration database. The ``description`` is the arbitrary text describing the server, its location within the network etc."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to delete an IPv4 subnet by ID from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to delete an IPv4 subnet by prefix from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected IPv4 subnet by ID for the server from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch 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 <command>server-tags</command> parameter must not be specified for this command."
+ "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": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a list of all IPv4 subnets from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> 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 <command>null</command> value."
+ "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."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-subnet4-list",
"resp-comment": [
- "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 <command>remote-subnet4-get</command> 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 <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
+ "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)."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace an IPv4 subnet the configuration database."
],
"cmd-comment": [
- "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> 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 <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
"This command is used to delete an IPv6 subnet by ID from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one id of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to delete an IPv6 subnet by prefix from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one prefix of the subnet to be deleted. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected IPv6 subnet by ID for the server from the configuration database."
],
"cmd-comment": [
- "This command includes a list with exactly one id of the subnet to be returned. The <command>server-tags</command> parameter must not be specified for this command."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch selected IPv6 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 <command>server-tags</command> parameter must not be specified for this command."
+ "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": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to fetch a list of all IPv6 subnets from the configuration database."
],
"cmd-comment": [
- "The <command>server-tags</command> 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 <command>null</command> value."
+ "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."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-subnet6-list",
"resp-comment": [
- "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 <command>remote-subnet6-get</command> 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 <command>null</command> value in the <command>server-tags</command> list, the response contains all subnets which are assigned to no servers (unassigned)."
+ "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)."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
"This command is used to create or replace an IPv6 subnet the configuration database."
],
"cmd-comment": [
- "The provided list must contain exactly one subnet specification. The <command>shared-network-name</command> 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 <command>null</command> value must be specified for the shared network name. The <command>server-tags</command> 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."
+ "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."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
projects / thirdparty / kea.git / commitdiff
