From: Marcin Siodelski Date: Tue, 16 Jul 2019 09:57:24 +0000 (+0200) Subject: [#643,!421] Editorial corrections in the cb_cmds docs for servers. X-Git-Tag: Kea-1.6.0-beta2~22 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=01d1b6cc6d6be3e43dedaaafa8367f1a7867e642;p=thirdparty%2Fkea.git [#643,!421] Editorial corrections in the cb_cmds docs for servers. --- diff --git a/doc/guide/hooks-cb-cmds.xml b/doc/guide/hooks-cb-cmds.xml index 24090285bd..397fc604cc 100644 --- a/doc/guide/hooks-cb-cmds.xml +++ b/doc/guide/hooks-cb-cmds.xml @@ -161,9 +161,9 @@
remote-server4-del, remote-server6-del commands - This command is used to delete + This command is used to delete the information about a selected DHCP server from the configuration database. - The server is identified by the unique case insensitive server tag. + The server is identified by a unique case insensitive server tag. For example: { @@ -189,18 +189,18 @@ associated with the server are removed from the database. The shareable configuration information, i.e. the configuration elements which may be associated with more than one server, is preserved. In particular, - subnets and shared networks associated with the deleted servers are - preserved. If any of the shareable configuration elements is associated - only with the deleted server, those objects become unassigned (orphaned). - For example: if the subnet has been created and associated with the + the subnets and shared networks associated with the deleted servers are + preserved. If any of the shareable configuration elements was associated + only with the deleted server, this object becomes unassigned (orphaned). + For example: if a subnet has been created and associated with the server1 using the remote-subnet4-set - and the server1 is subsequently deleted, the subnet remains in the + command and the server1 is subsequently deleted, the subnet remains in the database but none of the servers can use this subnet. The subnet can be updated using the remote-subnet4-set and associated with some other server or with all servers using the special server tag "all". Such subnet can be also deleted from the database using the remote-subnet4-del-by-id or - remote-subnet4-del-by-prefix if it is no longer + remote-subnet4-del-by-prefix, if it is no longer needed. @@ -219,7 +219,7 @@ The remote-server4-del and remote-server6-del commands must be used with care, - because an accidental deletion of the server causes parts of the existing + because an accidental deletion of the server causes some parts of the existing configurations to be lost permanently from the database. This operation is not reversible. Re-creation of the accidentally deleted server does not revert the lost configuration for that server and such configuration @@ -236,7 +236,6 @@ { "command": "remote-server6-get" - "service": [ "dhcp6" ], "arguments": { "servers": [ { @@ -253,7 +252,7 @@ This command fetches the information about the DHCPv6 server identified by the server tag server1. The server tag is case insensitive. - The successful response returns basic information about the server such as + A successful response returns basic information about the server, such as server tag and the user's description of the server: { @@ -263,7 +262,7 @@ "servers": [ { "server-tag": "server1", - "description": "A DHCPv6 server located on the first floor" + "description": "A DHCPv6 server located on the first floor." } ], "count": 1 @@ -290,7 +289,7 @@ The response includes basic information about each server, such as - a server tag and description: + its server tag and description: { "result": 0, @@ -299,11 +298,11 @@ "servers": [ { "server-tag": "server1", - "description": "A DHCP server located on the first floor" + "description": "A DHCP server located on the first floor." }, { "server-tag": "server2", - "description": "An old DHCP server to be soon replaced" + "description": "An old DHCP server to be soon replaced." } ], "count": 2 @@ -316,16 +315,17 @@
remote-server4-set, remote-server6-set commands This command is used to create or replace - information about a DHCP server in the database. It is required when there is - a need to differentiate the configurations for various Kea instances connecting - to the same database. Various configuration elements, e.g. global parameters, - subnets may be associated with the selected servers (using server tags as - identifiers) allowing only those servers to use these configuration elements. + an information about a DHCP server in the database. The information about the + server must be created when there is a need to differentiate the configurations + used by various Kea instances connecting to the same database. Various + configuration elements, e.g. global parameters, subnets etc. may be explicitly + associated with the selected servers (using server tags as identifiers), + allowing only these servers to use the respective configuration elements. Using the particular server tag to make such associations is only possible when - the server has been created in the database using the - remote-server4-set or remote-server6-set - commands for the DHCPv4 and DHCPv6 cases respectively. The following command - creates the new (or updates existing) DHCPv6 server in the database: + the server information has been stored in the database via the + remote-server4-set or + remote-server6-set commands. The following command creates + a new (or updates an existing) DHCPv6 server in the database: { "command": "remote-server6-set"