{
"avail": "1.2.0",
"brief": [
- "Returns a list of compilation options that this particular binary was built with"
+ "This command returns the list of compilation options that this particular binary was built with."
],
"cmd-syntax": [
"{",
- " \"command\": \"build-report\"",
+ " \"command\": \"build-report\",",
"}"
],
"name": "build-report",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "Returns entries matching the given identifier from the host cache."
+ "This command returns entries matching the given identifier from the host cache."
],
"cmd-syntax": [
"{",
{
"avail": "1.4.0",
"brief": [
- "Returns full content of the host cache."
+ "This command returns the full content of the host cache."
],
"hook": "host_cache",
"name": "cache-get",
{
"avail": "1.4.0",
"brief": [
- "This command may be used to manually insert a host into the cache."
+ "This command manually inserts a host into the cache."
],
"cmd-syntax": [
"{",
{
"avail": "1.4.0",
"brief": [
- "This command allows load the contents of a file on disk into an in-memory cache."
+ "This command allows the contents of a file on disk to be loaded into an in-memory cache."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.4.0",
"brief": [
- "The cache-remove command works similarly to reservation-get command."
+ "This command works similarly to the ``reservation-get`` command."
],
"cmd-syntax": [
"{",
" }",
"}",
"",
- "Another example that removes IPv6 host identifier by DUID and specific subnet-id is:",
+ "Another example that removes the IPv6 host identifier by DUID and specific subnet-id is:",
"{",
" \"command\": \"cache-remove\",",
" \"arguments\": {",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "Returns the number of entries in the host cache."
+ "This command returns the number of entries in the host cache."
],
"hook": "host_cache",
"name": "cache-size",
{
"avail": "1.4.0",
"brief": [
- "Instructs Kea to write its host cache content to disk."
+ "This command instructs Kea to write its host cache content to disk."
],
"cmd-comment": [
- "The command takes one mandatory argument that specifies a filename path of a file to be written."
+ "The command takes one mandatory argument that specifies the filename path of a file to be written."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.5.0",
"brief": [
- "This command is used to create and add a new class to the existing",
- "server configuration."
+ "This command creates and adds a new class to the existing server configuration."
],
"cmd-comment": [
- "The ``next-server``, ``server-hostname``, and ``boot-file-name`` are DHCPv4-specific. Only",
- "one client class can be added with a single command. "
+ "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": [
"{",
"hook": "class_cmds",
"name": "class-add",
"resp-comment": [
- "The command will be successful (result 0), unless the",
- "class name is a duplicate or another error occurs (result 1)."
+ "The command is successful (result 0), unless the class name is a duplicate or another error occurs (result 1)."
],
"resp-syntax": [
"{",
{
"avail": "1.5.0",
"brief": [
- "This command is used to remove a client class from the server configuration."
+ "This command removes a client class from the server configuration."
],
"cmd-syntax": [
"{",
"hook": "class_cmds",
"name": "class-del",
"resp-comment": [
+<<<<<<< HEAD
"The command will return a result of 3 (empty) if the client",
"class doesn't exist. If the client class exists, the returned",
"result is 0 if the deletion was successful and the result is 1",
"if the deletion is unsuccessful."
+=======
+ "The command returns a result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the deletion was successful; the result is 1 if the deletion is unsuccessful."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"resp-syntax": [
"{",
{
"avail": "1.5.0",
"brief": [
- "This command is used to return detailed information about an",
- "existing client class."
+ "This command returns detailed information about an existing client class."
],
"cmd-syntax": [
"{",
"hook": "class_cmds",
"name": "class-get",
"resp-comment": [
- "The returned information depends on the DHCP server type,",
- "i.e. some parameters are specific to DHCPv4 server. Also,",
- "some parameters may not be returned if they are not set for",
- "the client class. If the class with specified name doesn't",
- "exist a result of 3 (empty) is returned. If the client class",
- "is found, the result of 0 is returned. If there is an error",
- "while processing the command, the result of 1 is returned."
+ "The returned information depends on the DHCP server type, i.e. some parameters are specific to the DHCPv4 server. Also, some parameters may not be returned if they are not set for the client class. If a class with the specified name does not exist, a result of 3 (empty) is returned. If the client class is found, the result of 0 is returned. If there is an error while processing the command, the result of 1 is returned."
],
"resp-syntax": [
"{",
" \"only-if-required\": <only if required boolean value>,",
" \"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>",
{
"avail": "1.5.0",
"brief": [
- "This command is used to retrieve a list of all client",
- "classes from the server configuration."
+ "This command retrieves a list of all client classes from the server configuration."
],
"cmd-comment": [
"This command includes no arguments."
"resp-comment": [
"The returned list of classes merely contains their names.",
"In order to retrieve full information about one of these",
- "classes use :ref:`command-class-get`.",
+ "classes, use :ref:`command-class-get`.",
"The returned result is 3 (empty) if no classes are found.",
"If the command is processed successfully and the list of",
"client classes is not empty, the result of 0 is returned.",
{
"avail": "1.5.0",
"brief": [
- "This command is used to update an existing client class in",
- "the server configuration."
+ "This command updates an existing client class in the server configuration."
],
"cmd-comment": [
- "The ``next-server``, ``server-hostname``, and ``boot-file-name`` are DHCPv4-specific. Only",
- "one client class can be updated with a single command. "
+ "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": [
"{",
"hook": "class_cmds",
"name": "class-update",
"resp-comment": [
+<<<<<<< HEAD
"The command will return the result of 3 (empty) if the client",
"class doesn't exist. If the client class exists, the returned",
"result is 0 if the update was successful and the result is 1",
"if the update is unsuccessful."
+=======
+ "The command returns the result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the update was successful or 1 if the update is unsuccessful."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"resp-syntax": [
"{",
{
"avail": "1.2.0",
"brief": [
- "Retrieves the current configuration used by the server. The configuration",
- "is roughtly equal to the configuration file, but includes additional",
- "changes made by other commands and due to parameters inheritance."
+ "This command retrieves the current configuration used by the server. The configuration is essentially the same as the contents of the configuration file, but includes additional changes made by other commands and due to parameters' inheritance."
],
"cmd-comment": [
"This command takes no parameters."
{
"avail": "1.2.0",
"brief": [
- "The config-reload command instructs Kea to load again the configuration file that was used previously."
+ "This command instructs Kea to reload the configuration file that was used previously."
],
"cmd-syntax": [
"{",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
{
"avail": "1.2.0",
"brief": [
- "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
+ "This command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
],
"cmd-comment": [
- "where '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+ "In the example below, '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"."
],
"cmd-syntax": [
"{",
{
"avail": "1.2.0",
"brief": [
- "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
+ "This command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
],
"cmd-comment": [
- "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"."
+ "In the example below, <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"."
],
"cmd-syntax": [
"{",
{
"avail": "1.2.0",
"brief": [
- "The config-write command instructs the Kea server to write its",
+ "This command instructs the Kea server to write its",
"current configuration to a file on disk."
],
"cmd-syntax": [
{
"avail": "1.4.0",
"brief": [
- "The dhcp-disable command globally disables the DHCP service."
+ "This command globally disables the DHCP service."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.4.0",
"brief": [
- "The dhcp-enable command globally enables the DHCP service."
+ "This command globally enables the DHCP service."
],
"cmd-syntax": [
"{",
- " \"command\": \"dhcp-enable\"",
+ " \"command\": \"dhcp-enable\",",
"}"
],
"description": "See <xref linkend=\"command-dhcp-enable\"/>",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.4.0",
"brief": [
- "This command is used to resume the operation of the paused HA state machine."
+ "This command resumes the operation of a paused HA state machine."
],
- "description": "See <xref linkend=\"anchor-in-the-docs\"/>",
+ "description": "See <xref linkend=\"command-ha-continue\"/>",
"hook": "high_availability",
"name": "ha-continue",
"support": [
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.4.0",
"brief": [
- "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."
+ "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": [
"{",
"This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode."
],
"cmd-comment": [
- "In the example given, the arguments configure the server to handle traffic from both HA_server1 and HA_server2 scopes."
+ "In the example below, the arguments configure the server to handle traffic from both the HA_server1 and HA_server2 scopes."
],
"cmd-syntax": [
"{",
{
"avail": "1.4.0",
"brief": [
- "The command is issued to instruct the server running in HA mode to ",
- "synchronize its local lease database with the selected peer."
+ "This command instructs the server running in HA mode to synchronize its local lease database with the selected peer."
],
"cmd-syntax": [
"{",
{
"avail": "1.3.0",
"brief": [
- "The lease4-add command adds a new IPv4 lease administratively."
+ "This command administratively adds a new IPv4 lease."
],
"cmd-comment": [
- "Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other more detailed optional arguments are also supported."
+ "Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other, more-detailed, optional arguments are also supported."
],
"cmd-syntax": [
"{",
{
"avail": "1.3.0",
"brief": [
- "lease4-del can be used to delete a lease from the lease database."
+ "This command deletes a lease from the lease database."
],
"cmd-comment": [
- "Specify the lease to be deleted either by IP address, or by identifier-type and identifier value. Currently supported identifiers are \"hw-address\" and \"client-id\"."
+ "The lease to be deleted can be specified either by IP address or by identifier-type and identifier value. The currently supported identifiers are \"hw-address\" and \"client-id\"."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.4.0",
"brief": [
- "lease4-get-all is used to retrieve all IPv4 leases or all leases for the specified set of subnets."
+ "This command retrieves all IPv4 leases or all leases for the specified set of subnets."
],
"cmd-comment": [
- "The lease4-get-all command may result in very large responses."
+ "The ``lease4-get-all`` command may result in very large responses."
],
"cmd-syntax": [
"{",
{
"avail": "1.3.0",
"brief": [
- "lease4-get can be used to query the lease database and retrieve existing leases."
+ "This command queries the lease database and retrieves existing leases."
],
"cmd-syntax": [
"{",
"hook": "lease_cmds",
"name": "lease4-get",
"resp-comment": [
- "lease4-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
+ "lease4-get returns a result that indicates the outcome of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error), or 2 (empty)."
],
"resp-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The lease4-update command can be used to update existing leases."
+ "This command updates existing leases."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "lease4-wipe is designed to remove all leases associated with a given subnet."
+ "This command removes all leases associated with a given subnet."
],
"cmd-syntax": [
"{",
{
"avail": "1.3.0",
"brief": [
- "The lease6-add command creates a new lease administratively."
+ "This command administratively creates a new lease."
],
"cmd-comment": [
- "lease6-add can be also used to add leases for IPv6 prefixes.."
+ "lease6-add can be also used to add leases for IPv6 prefixes."
],
"cmd-syntax": [
"{",
{
"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 where it is desirable to apply multiple lease updates in a single transaction."
+ "This command creates, updates, or deletes multiple IPv6 leases in a single transaction. It communicates lease changes between 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, 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."
+ "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 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."
+ "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, insertion 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.3.0",
"brief": [
- "lease6-del can be used to delete a lease from the lease database."
+ "This command deletes a lease from the lease database."
],
"cmd-comment": [
- "lease6-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty)."
+ "lease6-del returns a result that indicates the outcome of the operation. It has one of the following values: 0 (success), 1 (error), or 3 (empty)."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "lease6-get-all is used to retrieve all IPv6 leases or all leases for the specified set of subnets."
+ "This command retrieves all IPv6 leases or all leases for the specified set of subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "lease6-get can be used to query the lease database and retrieve existing leases."
+ "This command queries the lease database and retrieves existing leases."
],
"cmd-comment": [
- "lease6-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
+ "lease6-get returns a result that indicates the outcome of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error), or 2 (empty)."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The lease6-update command can be used to update existing leases."
+ "This command updates existing leases."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "lease6-wipe is designed to remove all leases associated with a given subnet."
+ "This command removes all leases associated with a given subnet."
],
"cmd-comment": [
"Note: not all backends support this command."
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.0.0",
"brief": [
- "The leases-reclaim command instructs the server to reclaim all expired leases immediately."
+ "This command instructs the server to reclaim all expired leases immediately."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.2.0",
"brief": [
- "The libreload command will first unload and then load all currently loaded hook libraries."
+ "This command first unloads and then reloads all currently loaded hooks libraries."
],
"cmd-comment": [
- "The server will respond with a result of 0 indicating success, or 1 indicating a failure."
+ "The server responds with 0, indicating success, or 1, indicating a failure."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.0.0",
"brief": [
- "The list-commands command retrieves a list of all commands supported by the server."
+ "This command retrieves a list of all commands supported by the server."
],
"cmd-comment": [
- "The server will respond with a list of all supported commands."
+ "The server responds with a list of all supported commands."
],
"cmd-syntax": [
"{",
"kea-dhcp-ddns",
"kea-ctrl-agent"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network4-add command is used to add a new shared network."
+ "This command adds a new shared network."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network4-del command is used to delete existing shared networks."
+ "This command deletes existing shared networks."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network4-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network."
+ "This command retrieves detailed information about shared networks, including subnets that are currently part of a given network."
],
"cmd-syntax": [
"{",
" {",
" \"subnet\": \"192.0.2.0/24\",",
" \"id\": 5,",
- " // many other subnet specific details here",
+ " // many other subnet-specific details here",
" },",
" {",
" \"subnet\": \"192.0.3.0/31\",",
" \"id\": 6,",
- " // many other subnet specific details here",
+ " // many other subnet-specific details here",
" }",
" ],",
" \"valid-lifetime\": 120",
{
"avail": "1.3.0",
"brief": [
- "The network4-list command is used to retrieve full list of currently configured shared networks."
+ "This command retrieves the full list of currently configured shared networks."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network4-subnet-add command is used to add existing subnets to existing shared networks."
+ "This command adds existing subnets to existing shared networks."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network4-subnet-del command is used to remove a subnet that is part of an existing shared network and demote it to a plain, stand-alone subnet."
+ "This command removes a subnet that is part of an existing shared network and demotes it to a plain, stand-alone subnet."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network6-add command is used to add a new shared network."
+ "This command adds a new shared network."
],
"cmd-comment": [
- "The network6-add uses the same syntax for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some are IPv6-only (e.g. interface-id)."
+ "The ``network6-add`` command uses the same syntax as ``network4-add`` for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some that are IPv6-only (e.g. interface-id)."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network6-del command is used to delete existing shared networks."
+ "This command deletes existing shared networks."
],
"cmd-comment": [
- "The network6-del command uses exactly the same syntax for",
- "both the command and the response."
+ "The ``network6-del`` command uses exactly the same syntax as ``network4-del`` for",
+ "both the query and the response."
],
"cmd-syntax": [
"{",
{
"avail": "1.3.0",
"brief": [
- "The network6-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network."
+ "The network6-get command retrieves detailed information about shared networks, including subnets that are currently part of a given network."
],
"cmd-syntax": [
"{",
{
"avail": "1.3.0",
"brief": [
- "The network6-list command is used to retrieve full list of currently configured shared networks."
+ "This command retrieves the full list of currently configured shared networks."
],
"cmd-comment": [
- "network6-list follows exactly the same syntax for both the query and the response."
+ "The ``network6-list`` command uses exactly the same syntax as ``network4-list`` for both the query and the response."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network6-subnet-add command is used to add existing subnets to existing shared networks."
+ "This command adds existing subnets to existing shared networks."
],
"cmd-comment": [
- "The network6-subnet-add command uses exactly the same syntax for both the command and the response."
+ "The ``network6-subnet-add`` command uses exactly the same syntax as ``network4-subnet-add`` for both the query and the response."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "The network6-subnet-del command is used to remove a subnet that is part of existing shared network and demote it to a plain, stand-alone subnet."
+ "This command removes a subnet that is part of an existing shared network and demotes it to a plain, stand-alone subnet."
],
"cmd-comment": [
- "The network6-subnet-del command uses exactly the same syntax for both the command and the response."
+ "The ``network6-subnet-del`` command uses exactly the same syntax as ``network4-subnet-del`` for both the query and the response."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete a global DHCPv4 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database."
+ "This command deletes a global DHCPv4 parameter from the configuration database. The server uses the value specified in the configuration file, or a default value if the parameter is not specified, 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 ``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."
+ "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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch all global parameters for the server from the specified database."
+ "This command fetches all global parameters for the server from the specified 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 global parameters 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; it fetches the global parameters shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-global-parameter4-get-all",
"resp-comment": [
- "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. 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."
+ "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 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 among 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."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
+<<<<<<< HEAD
"This command is used to fetch the selected global parameter for the server from the specified database."
+=======
+ "This command fetches the selected global parameter for the server from the specified database."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"cmd-comment": [
- "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."
+ "This command carries a list including exactly one name of the parameter to be fetched. 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 server tag \"all\" is allowed; it fetches the global parameter value shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-global-parameter4-get",
"resp-comment": [
- "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object. 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."
+ "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 provides database-specific information associated with the returned object. If the \"all\" server tag is specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command fetches the value associated with the given server. If the server-specific value does not exist, the ``remote-global-parameter4-get`` command fetches the value associated with all servers."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or update one or more global parameters in the configuration database."
+ "This command creates or updates 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; 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."
+ "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 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; it associates the specified parameters with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete a global DHCPv6 parameter from the configuration database. The server will use the value specified in the configuration file or a default value (if the parameter is not specified in the configuration file) after deleting the parameter from the database."
+ "This command deletes a global DHCPv6 parameter from the configuration database. The server uses 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 ``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."
+ "This command carries the list including exactly one name of the parameter to be deleted. 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."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch all global parameters for the server from the specified database."
+ "This command fetches all global parameters for the server from the specified 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 global parameters 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; it fetches the global parameters shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-global-parameter6-get-all",
"resp-comment": [
- "The returned response contains a list of maps. Each map contains a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is appended to each parameter and it provides database specific information associated with the returned objects. 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."
+ "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 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 among 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."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
+<<<<<<< HEAD
"This command is used to fetch the selected global parameter for the server from the specified database."
+=======
+ "This command fetches the selected global parameter for the server from the specified database."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"cmd-comment": [
- "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."
+ "This command carries a list including exactly one name of the parameter to be fetched. 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 server tag \"all\" is allowed; it fetches the global parameter value shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-global-parameter6-get",
"resp-comment": [
- "The returned response contains a map with a global parameter name/value pair. The value may be a JSON string, integer, real or boolean. The metadata is included and it provides database specific information associated with the returned object. 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."
+ "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 provides database-specific information associated with the returned object. If the \"all\" server tag is specified, the command attempts to fetch the global parameter value associated with all servers. If the explicit server tag is specified, the command fetches the value associated with the given server. If the server-specific value does not exist, the ``remote-global-parameter6-get`` fetches the value associated with all servers."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or update one or more global parameters in the configuration database."
+ "This command creates or updates 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; 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."
+ "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 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; it associates the specified parameters with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete an IPv4 shared network from the configuration database."
+ "This command deletes 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 ``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."
+ "This command includes a list with exactly one name of the shared network to be deleted. The ``subnets-action`` parameter denotes whether the subnets in this shared network should be deleted. The ``server-tags`` parameter must not be specified for this command."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch the selected IPv4 shared network for the server from the specified database."
+ "This command fetches 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a list of all IPv4 shared networks from the configuration database."
+ "This command fetches a list of all IPv4 shared networks from the configuration database."
],
"cmd-comment": [
+<<<<<<< HEAD
"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."
+=======
+ "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."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"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 ``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 create or replace an IPv4 shared network in the configuration database."
+ "This command creates or replaces 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 ``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."
+ "The provided list must contain exactly one shared network specification, and must not contain subnets (the \"subnet4\" parameter). The subnets are added to the shared network using the ``remote-subnet4-set`` command. The ``server-tags`` list is mandatory and 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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete an IPv6 shared network from the configuration database."
+ "This command deletes 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 ``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."
+ "This command includes a list with exactly one name of the shared network to be deleted. The ``subnets-action`` parameter indicates whether the subnets in this shared network should be deleted. The ``server-tags`` parameter must not be specified for this command."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch the selected IPv6 shared network for the server from the specified database."
+ "This command fetches 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a list of all IPv6 shared networks from the configuration database."
+ "This command fetches a list of all IPv6 shared networks from the configuration database."
],
"cmd-comment": [
+<<<<<<< HEAD
"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."
+=======
+ "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."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"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 ``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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace an IPv6 shared network in the configuration database."
+ "This command creates or replaces 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 ``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."
+ "The provided list must contain exactly one shared network specification, and must not contain subnets (the \"subnet6\" parameter). The subnets are added to the shared network using the ``remote-subnet6-set`` command. The ``server-tags`` list is mandatory and 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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete a DHCPv4 option definition from the configuration database."
+ "This command deletes a DHCPv4 option definition from the configuration database."
],
"cmd-comment": [
+<<<<<<< HEAD
"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."
+=======
+ "This command includes a list with exactly one option definition specification, comprising an option name and code. 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."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch all DHCPv4 option definitions from the configuration database."
+ "This command fetches all DHCPv4 option definitions from the configuration database."
],
"cmd-comment": [
- "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."
+ "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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a DHCPv4 option definition from the configuration database."
+ "This command fetches 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 ``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."
+ "The desired option definition is identified by the pair of option code/space values. 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 server tag \"all\" is allowed, to fetch the option definition instance shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-option-def4-get",
"resp-comment": [
- "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."
+ "The metadata is included and provides database-specific information associated with the returned object. If the \"all\" server tag is specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command fetches the option definition associated with the given server. If the server-specific option definition does not exist, the ``remote-option-def4-get`` command fetches the option definition associated with all servers."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace DHCPv4 option definition in the configuration database."
+ "This command creates or replaces a DHCPv4 option definition in the configuration database."
],
"cmd-comment": [
- "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."
+ "The provided list must contain exactly one option definition specification. 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 server tag \"all\" is allowed; it associates the specified option definition with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete a DHCPv6 option definition from the configuration database."
+ "This command deletes a DHCPv6 option definition from the configuration database."
],
"cmd-comment": [
+<<<<<<< HEAD
"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."
+=======
+ "This command includes a list with exactly one option definition specification, comprising an option name and code. 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."
+>>>>>>> Fix grammar, typos, a few JSON errors
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch all DHCPv6 option definitions from the configuration database."
+ "This command fetches all DHCPv6 option definitions from the configuration database."
],
"cmd-comment": [
- "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."
+ "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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a DHCPv6 option definition from the configuration database."
+ "This command fetches 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 ``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."
+ "The desired option definition is identified by the pair of option code/space values. 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 server tag \"all\" is allowed, to fetch the option definition instance shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-option-def6-get",
"resp-comment": [
- "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."
+ "The metadata is included and provides database-specific information associated with the returned object. If the \"all\" server tag is specified, the command fetches the option definition associated with all servers. If the explicit server tag is specified, the command fetches the option definition associated with the given server. If the server-specific option definition does not exist, the ``remote-option-def6-get`` command fetches the option definition associated with all servers."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace DHCPv6 option definition in the configuration database."
+ "This command creates or replaces a DHCPv6 option definition in the configuration database."
],
"cmd-comment": [
- "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."
+ "The provided list must contain exactly one option definition specification. 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 server tag \"all\" is allowed; it associates the specified option definition with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete a DHCPv4 global option from the configuration database."
+ "This command deletes 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch all DHCPv4 global options for the server from the configuration database."
+ "This command fetches all DHCPv4 global options for the server 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 global options 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 global options shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-option4-global-get-all",
"resp-comment": [
- "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."
+ "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 among 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."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a global DHCPv4 option for the server from the specified database."
+ "This command fetches 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 ``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."
+ "The option is identified by the pair of option code/space values. 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 server tag \"all\" is allowed, to fetch the global option instance shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-option4-global-get",
"resp-comment": [
- "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."
+ "The metadata is included and provides database specific information associated with the returned object. If the \"all\" server tag is specified, the command fetches the global option associated with all servers. If the explicit server tag is specified, the command fetches the global option associated with the given server. If the server specific option does not exist, it fetches the option associated with all servers."
],
"resp-syntax": [
"{",
" \"result\": 0,",
- " \"text\": \"DHCPv4 option in found.\",",
+ " \"text\": \"DHCPv4 option is found.\",",
" \"arguments\": {",
" \"options\": [",
" {",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace a DHCPv4 global option in the configuration database."
+ "This command creates or replaces a DHCPv4 global option in the configuration database."
],
"cmd-comment": [
- "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."
+ "The provided list must contain exactly one option specification. 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 server tag \"all\" is allowed; it associates the specified option with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete a DHCPv6 global option from the configuration database."
+ "This command deletes 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch all DHCPv6 global options for the server from the configuration database."
+ "This command fetches all DHCPv6 global options for the server 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 global options 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 global options shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-option6-global-get-all",
"resp-comment": [
- "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."
+ "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."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a global DHCPv6 option for the server from the specified database."
+ "This command fetches 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 ``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."
+ "The option is identified by the pair of option code/space values. 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 server tag \"all\" is allowed, to fetch the global option instance shared by all servers."
],
"cmd-syntax": [
"{",
"hook": "cb_cmds",
"name": "remote-option6-global-get",
"resp-comment": [
- "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."
+ "The metadata is included and provides database-specific information associated with the returned object. If the \"all\" server tag is 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 does not exist, it fetches the option associated with all servers."
],
"resp-syntax": [
"{",
" \"result\": 0,",
- " \"text\": \"DHCPv6 option in found.\",",
+ " \"text\": \"DHCPv6 option is found.\",",
" \"arguments\": {",
" \"options\": [",
" {",
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace a DHCPv6 global option in the configuration database."
+ "This command creates or replaces a DHCPv6 global option in the configuration database."
],
"cmd-comment": [
- "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."
+ "The provided list must contain exactly one option specification. 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 server tag \"all\" is allowed; it associates the specified option with all servers."
],
"cmd-syntax": [
"{",
{
"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 elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
+ "This command deletes 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. 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch information about all DHCPv4 servers specified by the user."
+ "This command fetches information about all DHCPv4 servers specified by the user."
],
"cmd-comment": [
"This command contains no arguments besides the optional ``remote``."
"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 ``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."
+ "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`` command; only the user-defined servers are returned."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch the information about the DHCPv4 server, such as server tag and description."
+ "This command fetches information about the DHCPv4 server, such as the server tag and description."
],
"cmd-comment": [
"This command carries the list including exactly one map with the tag of the server to be fetched."
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace information about the DHCPv4 server in the database."
+ "This command creates or replaces information about the DHCPv4 server in the database."
],
"cmd-comment": [
- "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."
+ "The provided list must contain exactly one server specification. The ``server-tag`` must be unique across all servers within the configuration database. The ``description`` is the arbitrary text describing the server, its location within the network, etc."
],
"cmd-syntax": [
"{",
{
"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 elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
+ "This command deletes 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. 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch information about all DHCPv6 servers specified by the user."
+ "This command fetches information about all DHCPv6 servers specified by the user."
],
"cmd-comment": [
"This command contains no arguments besides the optional ``remote``."
"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 ``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."
+ "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`` command; only the user-defined servers are returned."
],
"resp-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch the information about the DHCPv6 server, such as server tag and description."
+ "This command fetches information about the DHCPv6 server, such as the server tag and description."
],
"cmd-comment": [
"This command carries the list including exactly one map with the tag of the server to be fetched."
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace information about the DHCPv6 server in the database."
+ "This command creates or replaces information about the DHCPv6 server in the database."
],
"cmd-comment": [
- "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."
+ "The provided list must contain exactly one server specification. The ``server-tag`` must be unique across all servers within the configuration database. The ``description`` is the arbitrary text describing the server, its location within the network, etc."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete an IPv4 subnet by ID from the configuration database."
+ "This command deletes 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 ``server-tags`` parameter must not be specified for this command."
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete an IPv4 subnet by prefix from the configuration database."
+ "This command deletes 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 ``server-tags`` parameter must not be specified for this command."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch the selected IPv4 subnet by ID for the server from the configuration database."
+ "This command fetches the selected IPv4 subnet by ID 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."
"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 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 (a 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 the selected IPv4 subnet by prefix from the configuration database."
+ "This command fetches 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a list of all IPv4 subnets from the configuration database."
+ "This command fetches a list of all IPv4 subnets from the configuration database."
],
"cmd-comment": [
"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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace an IPv4 subnet the configuration database."
+ "This command creates or replaces an IPv4 subnet in the configuration database."
],
"cmd-comment": [
- "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."
+ "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 (a global subnet), the ``null`` value must be specified for the shared network name. The ``server-tags`` list is mandatory and must contain one or more server tags as strings to explicitly associate the subnet with one or more user-defined servers. The ``remote-subnet4-set`` command may include the special server tag \"all\" to associate the subnet with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete an IPv6 subnet by ID from the configuration database."
+ "This command deletes 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 ``server-tags`` parameter must not be specified for this command."
{
"avail": "1.6.0",
"brief": [
- "This command is used to delete an IPv6 subnet by prefix from the configuration database."
+ "This command deletes 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 ``server-tags`` parameter must not be specified for this command."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch the selected IPv6 subnet by ID for the server from the configuration database."
+ "This command fetches the selected IPv6 subnet by ID 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."
"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 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 (a 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 the selected IPv6 subnet by prefix from the configuration database."
+ "This command fetches 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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to fetch a list of all IPv6 subnets from the configuration database."
+ "This command fetches a list of all IPv6 subnets from the configuration database."
],
"cmd-comment": [
"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."
{
"avail": "1.6.0",
"brief": [
- "This command is used to create or replace an IPv6 subnet the configuration database."
+ "This command creates or replaces an IPv6 subnet in the configuration database."
],
"cmd-comment": [
- "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."
+ "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 (a global subnet), the ``null`` value must be specified for the shared network name. The ``server-tags`` list is mandatory and must contain one or more server tags as strings to explicitly associate the subnet with one or more user-defined servers. The ``remote-subnet6-set`` command may include the special server tag \"all\" to associate the subnet with all servers."
],
"cmd-syntax": [
"{",
{
"avail": "1.2.0",
"brief": [
- "Adds a new host reservation. The reservation may include IPv4 address,",
- "IPv6 addresses, IPv6 prefixes, various identifiers, a class",
- "the client will be assigned to, DHCPv4 and DHCPv6 options and",
- "more."
+ "This command adds a new host reservation. The reservation may include IPv4 addresses, IPv6 addresses, IPv6 prefixes, various identifiers, a class the client will be assigned to, DHCPv4 and DHCPv6 options, and more."
],
"cmd-comment": [
- "Note the ip-address, client-id, next-server, server-hostname and",
- "boot-file-name are IPv4 specific. duid, ip-addresses and prefixes are",
- "IPv6 specific."
+ "Note that ip-address, client-id, next-server, server-hostname, and boot-file-name are IPv4-specific. duid, ip-addresses, and prefixes are IPv6-specific."
],
"cmd-syntax": [
"{",
" \"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>",
{
"avail": "1.2.0",
"brief": [
- "Deletes an existing host reservation."
+ "This command deletes an existing host reservation."
],
"cmd-comment": [
"The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
{
"avail": "1.6.0",
"brief": [
- "Retrieve all host reservations for a specified subnet."
+ "This command retrieves all host reservations for a specified subnet."
],
"cmd-syntax": [
"{",
"hook": "host_cmds",
"name": "reservation-get-all",
"resp-comment": [
- "reservation-get-all command may result in very large responses."
+ "The reservation-get-all command may result in very large responses."
],
"support": [
"kea-dhcp4",
{
"avail": "1.6.0",
"brief": [
- "Retrieve host reservations for a specified subnet by page."
+ "This command retrieves host reservations for a specified subnet by page."
],
"cmd-comment": [
- "the subnet id and the page size limit are mandatory. The source index and from host id are optional and default to 0. Values to use to next the next page are returned in responses in a next map."
+ "The subnet-id and the page size limit are mandatory. The source-index and from host id are optional and default to 0. Values to use to load the next page are returned in responses in a next map."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.2.0",
"brief": [
- "This command is used to retrieve an existing host reservation."
+ "This command retrieves an existing host reservation."
],
"cmd-comment": [
"The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
"hook": "host_cmds",
"name": "reservation-get",
"resp-comment": [
- "The arguments object appears only if a host is found. Many fields in the arguments",
- "object appear only if a 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": [
"{",
{
"avail": "1.6.0",
"brief": [
- "The server-tag-get command returns the server tag."
+ "This command returns the server tag."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.0.0",
"brief": [
- "The shutdown command instructs the server to initiate its shutdown procedure."
+ "This command instructs the server to initiate its shutdown procedure."
],
"cmd-comment": [
- "The server will respond with a confirmation that the shutdown",
- "procedure has been initiated."
+ "The server responds with a confirmation that the shutdown procedure has been initiated."
],
"cmd-syntax": [
"{",
{
"avail": "1.0.0",
"brief": [
- "The statistic-get-all command retrieves all statistics recorded."
+ "This command retrieves all recorded statistics."
],
"cmd-comment": [
- "The server will respond with details of all recorded statistics, with result set to 0 indicating that it iterated over all statistics (even when the total number of statistics is zero)."
+ "The server responds with the details of all recorded statistics, with a result of 0 indicating that it iterated over all statistics (even when the total number of statistics is zero)."
],
"cmd-syntax": [
"{",
{
"avail": "1.0.0",
"brief": [
- "The statistic-get command retrieves a single statistic. It takes a single string parameter called name that specifies the statistic name."
+ "This command retrieves a single statistic. It takes a single string parameter called name that specifies the statistic name."
],
"cmd-comment": [
- "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the \"arguments\" parameter."
+ "The server responds with the details of the requested statistic, with a result of 0 indicating success, and the specified statistic as the value of the \"arguments\" parameter."
],
"cmd-syntax": [
"{",
{
"avail": "1.0.0",
"brief": [
- "The statistic-remove-all command attempts to delete all statistics."
+ "This command deletes all statistics."
],
"cmd-comment": [
- "If the removal of all statistics was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ "If the removal of all statistics is successful, the server responds with a status of 0, indicating success, and an empty parameters field. If an error is encountered, the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.0.0",
"brief": [
- "The statistic-remove command attempts to delete a single statistic. It takes a single string parameter called name that specifies the statistic name."
+ "This command deletes a single statistic. It takes a single string parameter called name that specifies the statistic name."
],
"cmd-comment": [
- "If the specific statistic is found and its removal was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ "If the specific statistic is found and its removal is successful, the server responds with a status of 0, indicating success, and an empty parameters field. If an error is encountered (e.g. the requested statistic was not found), the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.0.0",
"brief": [
- "The statistic-reset command sets all statistics to their neutral values: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type."
+ "This command sets all statistics to their neutral values: 0 for integer, 0.0 for float, 0h0m0s0us for time duration, and \"\" for string type."
],
"cmd-comment": [
- "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ "If the operation is successful, the server responds with a status of 0, indicating success, and an empty parameters field. If an error is encountered, the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.0.0",
"brief": [
- "The statistic-reset command sets the specified statistic to its neutral value: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type. It takes a single string parameter called name that specifies the statistic name."
+ "This command sets the specified statistic to its neutral value: 0 for integer, 0.0 for float, 0h0m0s0us for time duration, and \"\" for string type. It takes a single string parameter called name that specifies the statistic name."
],
"cmd-comment": [
- "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ "If the specific statistic is found and the reset is successful, the server responds with a status of 0, indicating success, and an empty parameters field. If an error is encountered (e.g. the requested statistic was not found), the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "The statistic-sample-age-set-all command sets time based limit for all statistics. It takes a single integer parameter called duration."
+ "This command sets a time-based limit for all statistics. It takes a single integer parameter called duration."
],
"cmd-comment": [
- "The server will respond with message about successfully set limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ "The server responds with a message about successfully set limits for all statistics, with a result of 0 indicating success, and an empty parameters field. If an error is encountered, the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "The statistic-sample-age-set command sets time based limit for single statistic. It takes two parameters: a string called name and an integer value called duration."
+ "This command sets a time-based limit for a single statistic. It takes two parameters: a string called name and an integer value called duration."
],
"cmd-comment": [
- "The server will respond with message about successfully set limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ "The server responds with a message about a successfully set limit for the given statistic, with a result of 0 indicating success, and an empty parameters field. If an error is encountered (e.g. the requested statistic was not found), the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "The statistic-sample-count-set-all command sets size based limit for all statistics. It takes a single integer parameter called max-samples."
+ "This command sets a size-based limit for all statistics. It takes a single integer parameter called max-samples."
],
"cmd-comment": [
- "The server will respond with message about successfully set limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+ "The server responds with a message about successfully set limits for all statistics, with a result of 0 indicating success, and an empty parameters field. If an error is encountered, the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.6.0",
"brief": [
- "The statistic-sample-count-set command sets size based limit for single statistic. It takes two parameters: a string called name and an integer value called max-samples."
+ "This command sets a size-based limit for a single statistic. It takes two parameters: a string called name and an integer value called max-samples."
],
"cmd-comment": [
- "The server will respond with message about successfully set limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+ "The server responds with a message about a successfully set limit for the given statistic, with a result of 0 indicating success, and an empty parameters field. If an error is encountered (e.g. the requested statistic was not found), the server returns a status code of 1 (error) and the text field contains the error description."
],
"cmd-syntax": [
"{",
"kea-dhcp4",
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "This command is used to create and add a new subnet to the existing server configuration."
+ "This command creates and adds a new subnet to the existing server configuration. This operation has no impact on other subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of."
+ "This command removes a subnet from the server's configuration. This command has no effect on other configured subnets, but removing a subnet has certain implications which the server's administrator should be aware of."
],
"cmd-syntax": [
"{",
"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 ``subnet4-list``, which is used to discover available subnets with their respective subnet identifiers and prefixes."
+ "This command retrieves detailed information about the specified subnet. This command usually follows ``subnet4-list``, which discovers available subnets with their respective subnet identifiers and prefixes."
],
"cmd-syntax": [
"{",
" \"id\": 1,",
" \"option-data\": [",
" ...",
- " ]",
+ " ],",
" ...",
" }",
" ]",
{
"avail": "1.3.0",
"brief": [
- "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet."
+ "This command lists all currently configured subnets. The subnets are returned in a brief format, i.e. a subnet identifier and subnet prefix are included for each subnet."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to update a subnet in the existing server configuration."
+ "This command updates a subnet in the existing server configuration. This operation has no impact on other subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp4"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "This command is used to create and add new subnet to the existing server configuration. This operation has no impact on other subnets."
+ "This command creates and adds a new subnet to the existing server configuration. This operation has no impact on other subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.3.0",
"brief": [
- "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of."
+ "This command removes a subnet from the server's configuration. This command has no effect on other configured subnets, but removing a subnet has certain implications which the server's administrator should be aware of."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ 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 ``subnet6-list``, which is used to discover available subnets with their respective subnet identifiers and prefixes."
+ "This command retrieves detailed information about the specified subnet. This command usually follows ``subnet6-list``, which discovers available subnets with their respective subnet identifiers and prefixes."
],
"cmd-syntax": [
"{",
" \"id\": 1,",
" \"option-data\": [",
" ...",
- " ]",
+ " ],",
" ...",
" }",
" ]",
{
"avail": "1.3.0",
"brief": [
- "This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet."
+ "This command lists all currently configured subnets. The subnets are returned in a brief format, i.e. a subnet identifier and subnet prefix are included for each subnet."
],
"cmd-syntax": [
"{",
{
"avail": "1.6.0",
"brief": [
- "This command is used to update a subnet in the existing server configuration. This operation has no impact on other subnets."
+ "This command updates a subnet in the existing server configuration. This operation has no impact on other subnets."
],
"cmd-syntax": [
"{",
"support": [
"kea-dhcp6"
]
-}
\ No newline at end of file
+}
{
"avail": "1.2.0",
"brief": [
- "The version-get command returns extended information about",
- "Kea version. The returned string is the same as if Kea would",
- "be run with ``-V`` command line option."
+ "This command returns extended information about the Kea version that is running. The returned string is the same as if Kea were run with the ``-V`` command-line option."
],
"cmd-syntax": [
"{",
projects / thirdparty / kea.git / commitdiff
