{
"avail": "1.6.0",
"brief": [
- "Returns entries matching the given identifier from the host cache."
+ "Returns entries matching the given identifier from the host cache."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "Returns number of entries of the host cache."
+ "Returns the number of entries in the host cache."
],
"hook": "host_cache",
"name": "cache-size",
"server configuration."
],
"cmd-comment": [
- "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only",
+ "The ``next-server``, ``server-hostname``, and ``boot-file-name`` are DHCPv4-specific. Only",
"one client class can be added with a single command. "
],
"cmd-syntax": [
" \"name\": <name of the class>,",
" \"test\": <test expression to be evaluated on incoming packets>,",
" \"option-data\": [ <option values here> ],",
- " \"option-def\": [ <option defintions here> ],",
+ " \"option-def\": [ <option definitions here> ],",
" \"next-server\": <ipv4 address>,",
" \"server-hostname\": <string>,",
" \"boot-file-name\": <name of the boot file>",
"the server configuration."
],
"cmd-comment": [
- "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only",
+ "The ``next-server``, ``server-hostname``, and ``boot-file-name`` are DHCPv4-specific. Only",
"one client class can be updated with a single command. "
],
"cmd-syntax": [
" \"name\": <name of the class>,",
" \"test\": <test expression to be evaluated on incoming packets>,",
" \"option-data\": [ <option values here> ],",
- " \"option-def\": [ <option defintions here> ],",
+ " \"option-def\": [ <option definitions here> ],",
" \"next-server\": <ipv4 address>,",
" \"server-hostname\": <string>,",
" \"boot-file-name\": <name of the boot file>",
"name": "class-update",
"resp-comment": [
"The command will return the result of 3 (empty) if the client",
- "class doesn't exist. If the client class exists, the retured",
- "result is 0 if the update was successful and the result is 1",
+ "class doesn't exist. If the client class exists, the returned",
+ "result is 0 if the update was successful; the result is 1",
"if the update is unsuccessful."
],
"resp-syntax": [
{
"avail": "1.4.0",
"brief": [
- "This command is sent internally by Kea partner when operating",
- "in High Availability (HA) mode. It will retrieve the server HA state and clock value."
+ "This command is sent internally by a Kea partner when operating",
+ "in High-Availability (HA) mode. It retrieves the server's HA state and clock value."
],
"cmd-syntax": [
"{",
"hook": "high_availability",
"name": "ha-heartbeat",
"resp-comment": [
- "The response to this command is different from the typical command response. The response will include server state (see :ref:`ha-server-states`) plus the current clock value."
+ "The response to this command is different from the typical command response. The response includes the server state (see :ref:`ha-server-states`) plus the current clock value."
],
"support": [
"kea-dhcp4",
{
"avail": "1.6.0",
"brief": [
- "The lease6-bulk-apply command can be used to create, update and delete multiple IPv6 leases in a single transaction. This is used to communicate lease changes between the HA peers but may be used in all cases when it is desired to apply multiple lease updates in a single transaction."
+ "The lease6-bulk-apply command can be used to create, update, and delete multiple IPv6 leases in a single transaction. This is used to communicate lease changes between the HA peers, but may be used in all cases where it is desirable to apply multiple lease updates in a single transaction."
],
"cmd-comment": [
- "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The \"deleted-leases\" and \"leases\" are optional parameters but one of them must be specified."
+ "If any of the leases is malformed, all changes are rolled back. If the leases are well-formed but the operation fails for one or more leases, these leases are listed in the response; however, the changes are preserved for all leases for which the operation was successful. The \"deleted-leases\" and \"leases\" are optional parameters but one of them must be specified."
],
"cmd-syntax": [
"{",
"hook": "lease_cmds",
"name": "lease6-bulk-apply",
"resp-comment": [
- "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
+ "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error during processing, inserting it into the database, etc., the result is set to 1. For each lease which was not deleted because the server did not find it in the database, the result of 3 is returned."
],
"resp-syntax": [
" {",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or update one more global parameters in the configuration database."
+ "This command is used to create or update one or 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 ``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."
+ "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter; 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`` command 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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or update one more global parameters in the configuration database."
+ "This command is used to create or update one or 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 ``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."
+ "This command carries multiple global parameters with their values. Care should be taken when specifying more than one parameter; 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`` command 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": [
"{",
- " \"command\": \"remote-global-parameter6-set\"",
+ " \"command\": \"remote-global-parameter6-set\",",
" \"arguments\": {",
" \"parameters\": {",
" <first parameter name>: <first parameter value>,",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch selected IPv4 shared network for the server from the specified database."
+ "This command is used to fetch the 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 ``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": [
"{",
- " \"command\": \"remote-network4-get\"",
+ " \"command\": \"remote-network4-get\",",
" \"arguments\": {",
" \"shared-networks\": [",
" {",
"hook": "cb_cmds",
"name": "remote-network4-get",
"resp-comment": [
- "If the subnets are returned with the shared network they are carried in the ``subnet4`` list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object."
+ "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 provides the database-specific information associated with the returned object."
],
"resp-syntax": [
"{",
],
"cmd-syntax": [
"{",
- " \"command\": \"remote-network4-list\"",
+ " \"command\": \"remote-network4-list\",",
" \"arguments\": {",
" \"remote\": {",
" <specification of the database to connect to>",
"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 ``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)."
+ "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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch selected IPv6 shared network for the server from the specified database."
+ "This command is used to fetch the 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 ``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": [
"{",
- " \"command\": \"remote-network6-get\"",
+ " \"command\": \"remote-network6-get\",",
" \"arguments\": {",
" \"shared-networks\": [",
" {",
"hook": "cb_cmds",
"name": "remote-network6-get",
"resp-comment": [
- "If the subnets are returned with the shared network they are carried in the ``subnet6`` list within the shared network definition. The metadata is included in the returned shared network definition and it provides the database specific information associated with the returned object."
+ "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 provides the database-specific information associated with the returned object."
],
"resp-syntax": [
"{",
],
"cmd-syntax": [
"{",
- " \"command\": \"remote-network6-list\"",
+ " \"command\": \"remote-network6-list\",",
" \"arguments\": {",
" \"remote\": {",
" <specification of the database to connect to>",
"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 ``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)."
+ "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": [
"{",
"This command is used to fetch all DHCPv4 option definitions from the configuration database."
],
"cmd-comment": [
- "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."
+ "The ``server-tags`` list is mandatory and 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": [
"{",
- " \"command\": \"remote-option-def4-get-all\"",
+ " \"command\": \"remote-option-def4-get-all\",",
" \"arguments\": {",
" \"remote\": {",
" <specification of the database to connect to>",
"hook": "cb_cmds",
"name": "remote-option-def4-get-all",
"resp-comment": [
- "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. 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."
+ "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 among 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."
],
"resp-syntax": [
"{",
"This command is used to fetch all DHCPv6 option definitions from the configuration database."
],
"cmd-comment": [
- "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."
+ "The ``server-tags`` list is mandatory and 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": [
"{",
- " \"command\": \"remote-option-def6-get-all\"",
+ " \"command\": \"remote-option-def6-get-all\",",
" \"arguments\": {",
" \"remote\": {",
" <specification of the database to connect to>",
"hook": "cb_cmds",
"name": "remote-option-def6-get-all",
"resp-comment": [
- "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. 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."
+ "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 among 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."
],
"resp-syntax": [
"{",
"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 ``null`` 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": [
"{",
" \"arguments\": {",
" \"options\": [",
" {",
- " \"code\": <option code>",
- " \"space\": <option space>",
+ " \"code\": <option code>,",
+ " \"space\": <option space>,",
" }",
" ],",
" \"remote\": {",
"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 ``null`` 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": [
"{",
" \"arguments\": {",
" \"options\": [",
" {",
- " \"code\": <option code>",
- " \"space\": <option space>",
+ " \"code\": <option code>,",
+ " \"space\": <option space>,",
" }",
" ],",
" \"remote\": {",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers."
+ "This command is used to delete information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
],
"cmd-comment": [
"This command carries the list including exactly one map with the tag of the server to be deleted."
"resp-syntax": [
"{",
" \"result\": 0,",
- " \"text\": \"1 DHCPv4 server(s) deleted.\"",
+ " \"text\": \"1 DHCPv4 server(s) deleted.\",",
" \"arguments\": {",
" \"count\": 1",
" }",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers."
+ "This command is used to delete information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
],
"cmd-comment": [
"This command carries the list including exactly one map with the tag of the server to be deleted."
"resp-syntax": [
"{",
" \"result\": 0,",
- " \"text\": \"1 DHCPv6 server(s) deleted.\"",
+ " \"text\": \"1 DHCPv6 server(s) deleted.\",",
" \"arguments\": {",
" \"count\": 1",
" }",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch selected IPv4 subnet by ID for the server from the configuration database."
+ "This command is used to fetch the 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 ``server-tags`` 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": [
"{",
- " \"command\": \"remote-subnet4-get-by-id\"",
+ " \"command\": \"remote-subnet4-get-by-id\",",
" \"arguments\": {",
" \"subnets\": [ {",
" \"id\": <subnet identifier>",
"hook": "cb_cmds",
"name": "remote-subnet4-get-by-id",
"resp-comment": [
- "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and provides database-specific information associated with the returned object."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch selected IPv4 subnet by prefix from the configuration database."
+ "This command is used to fetch the 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 ``server-tags`` parameter must not be specified for this command."
],
"cmd-syntax": [
"{",
- " \"command\": \"remote-subnet4-get-by-prefix\"",
+ " \"command\": \"remote-subnet4-get-by-prefix\",",
" \"arguments\": {",
" \"subnets\": [ {",
" \"subnet\": <subnet prefix>",
"hook": "cb_cmds",
"name": "remote-subnet4-get-by-prefix",
"resp-comment": [
- "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and provides database-specific information associated with the returned object."
],
"resp-syntax": [
"{",
"This command is used to fetch a list of all IPv4 subnets from the configuration database."
],
"cmd-comment": [
- "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."
+ "The ``server-tags`` list is required for this command, and must not be empty. It may either contain one or multiple server tags as strings, or a single ``null`` value."
],
"cmd-syntax": [
"{",
- " \"command\": \"remote-subnet4-list\"",
+ " \"command\": \"remote-subnet4-list\",",
" \"arguments\": {",
" \"remote\": {",
" <specification of the database to connect to>",
"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 ``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)."
+ "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 network, 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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch selected IPv6 subnet by ID for the server from the configuration database."
+ "This command is used to fetch the 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 ``server-tags`` 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": [
"{",
- " \"command\": \"remote-subnet6-get-by-id\"",
+ " \"command\": \"remote-subnet6-get-by-id\",",
" \"arguments\": {",
" \"subnets\": [",
" {",
"hook": "cb_cmds",
"name": "remote-subnet6-get-by-id",
"resp-comment": [
- "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and provides database-specific information associated with the returned object."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch selected IPv6 subnet by prefix from the configuration database."
+ "This command is used to fetch the 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 ``server-tags`` parameter must not be specified for this command."
],
"cmd-syntax": [
"{",
- " \"command\": \"remote-subnet4-get-by-prefix\"",
+ " \"command\": \"remote-subnet6-get-by-prefix\",",
" \"arguments\": {",
" \"subnets\": [",
" {",
"hook": "cb_cmds",
"name": "remote-subnet6-get-by-prefix",
"resp-comment": [
- "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and it provides database specific information associated with the returned object."
+ "If the shared network name is null, it means that the returned subnet does not belong to any shared network (global subnet). The metadata is included in the returned subnet definition and provides database-specific information associated with the returned object."
],
"resp-syntax": [
"{",
"This command is used to fetch a list of all IPv6 subnets from the configuration database."
],
"cmd-comment": [
- "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."
+ "The ``server-tags`` list is required for this command, and must not be empty. It may either contain one or multiple server tags as strings, or a single ``null`` value."
],
"cmd-syntax": [
"{",
- " \"command\": \"remote-subnet6-list\"",
+ " \"command\": \"remote-subnet6-list\",",
" \"arguments\": {",
" \"remote\": {",
" <specification of the database to connect to>",
"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 ``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)."
+ "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 network, 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": [
"{",
{
"avail": "1.2.0",
"brief": [
- "Attempts to retrieve an existing host reservation"
+ "This command is used to retrieve an existing host reservation."
],
"cmd-comment": [
- "The host reservation can be identified by either (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
+ "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
],
"cmd-syntax": [
"{",
" \"command\": \"reservation-get\",",
" \"arguments\": {",
" \"subnet-id\": <integer>,",
- " \"identifier-type\": <string with one value out of: hw-address|duid|circuit-id|client-id|flex-id>,",
+ " \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,",
" \"identifier\": <string>;",
" }",
"}"
"hook": "host_cmds",
"name": "reservation-get",
"resp-comment": [
- "Arguments object appear only if a host is found. Many fields in the arguments",
- "object appear only if specific field is set."
+ "The arguments object appears only if a host is found. Many fields in the arguments",
+ "object appear only if a specific field is set."
],
"resp-syntax": [
"{",
" \"text\": <string>,",
" \"arguments\": {",
" \"boot-file-name\": <string>,",
- " \"comment\": <string>",
+ " \"comment\": <string>,",
" \"client-id\": <string>,",
" \"circuit-id\": <string>,",
" \"duid\": <string>,",
" \"flex-id\": <string>,",
" \"ip-address\": <string (IPv4 address)>,",
- " \"ip-addresses\": [ <comma separated strings> ],",
+ " \"ip-addresses\": [ <comma-separated strings> ],",
" \"hw-address\": <string>,",
" \"hostname\": <string>,",
" \"next-server\": <string (IPv4 address)>,",
- " \"option-data-list\": [ <comma separated structures defining options> ],",
- " \"prefixes\": [ <comma separated IPv6 prefixes> ],",
- " \"reservation-client-classes\": [ <comma separated strings> ],",
+ " \"option-data-list\": [ <comma-separated structures defining options> ],",
+ " \"prefixes\": [ <comma-separated IPv6 prefixes> ],",
+ " \"reservation-client-classes\": [ <comma-separated strings> ],",
" \"server-hostname\": <string>,",
" \"subnet-id\": <integer>,",
- " \"user-context\": <any valid JSON>,",
+ " \"user-context\": <any valid JSON>",
" }",
"}"
],
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.4.0",
"brief": [
- "The stat-lease4-get command fetches lease statistics for a range",
- "of known IPv4 subnets."
+ "This command fetches lease statistics for a range of known IPv4 subnets."
],
"cmd-syntax": [
"{",
- " \"command\": \"stat-lease4-get\"",
+ " \"command\": \"stat-lease4-get\",",
"}"
],
"description": "See <xref linkend=\"command-stat-lease4-get\"/>",
" \"columns\": [ \"subnet-id\",",
" \"total-addresses\",",
" \"assigned-addresses\",",
- " \"declined-addresses\" ]",
+ " \"declined-addresses\" ],",
" \"rows\": [",
" [ 10, 256, 111, 0 ],",
" [ 20, 4098, 2034, 4 ]",
{
"avail": "1.4.0",
"brief": [
- "The stat-lease6-get command fetches lease statistics for a range",
- "of known IPv6 subnets."
+ "This command fetches lease statistics for a range of known IPv6 subnets."
],
"cmd-syntax": [
"{",
" \"text\": \"stat-lease6-get: 2 rows found\",",
" \"arguments\": {",
" \"result-set\": {",
- " \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ]",
+ " \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ],",
" \"rows\": [",
" [ 10, 4096, 2400, 3, 0, 0],",
" [ 20, 0, 0, 0, 1048, 233 ]",
{
"avail": "1.3.0",
"brief": [
- "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet4-list, which is used to discover available subnets with their respective subnet identifiers and prefixes."
+ "This command is used to retrieve detailed information about the specified subnet. This command usually follows ``subnet4-list``, which is used to discover available subnets with their respective subnet identifiers and prefixes."
],
"cmd-syntax": [
"{",
" \"subnet\": \"10.0.0.0/8\",",
" \"id\": 1,",
" \"option-data\": [",
- " ....",
+ " ...",
" ]",
" ...",
" }",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet6-list, which is used to discover available subnets with their respective subnet identifiers and prefixes."
+ "This command is used to retrieve detailed information about the specified subnet. This command usually follows ``subnet6-list``, which is used to discover available subnets with their respective subnet identifiers and prefixes."
],
"cmd-syntax": [
"{",
" \"option-data\": [",
" ...",
" ]",
- " ....",
+ " ...",
" }",
" ]",
" }",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
projects / thirdparty / kea.git / commitdiff
