From: Suzanne Goldlust Date: Fri, 28 Dec 2018 19:04:56 +0000 (-0500) Subject: Update hooks-class-cmds.xml X-Git-Tag: 481-remote-subnet4-set-inconsistent-work-when-id-subnet-is-duplicated_base~59 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=cbc8b6480be65518772a317449aa13b520f7e087;p=thirdparty%2Fkea.git Update hooks-class-cmds.xml --- diff --git a/doc/guide/hooks-class-cmds.xml b/doc/guide/hooks-class-cmds.xml index 0c45236d44..c6324bb635 100644 --- a/doc/guide/hooks-class-cmds.xml +++ b/doc/guide/hooks-class-cmds.xml @@ -3,21 +3,21 @@ - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - - file, You can obtain one at http://mozilla.org/MPL/2.0/. + - file, you can obtain one at http://mozilla.org/MPL/2.0/. -->
class_cmds: Class Commands This section describes the Class Commands hooks library, which exposes - several control commands for manipulating client classes, being a part of - the Kea DHCP servers' configurations, without the need to restart those - servers. Using these commands it is possible to add, update, delete and + several control commands for manipulating client classes (part of + the Kea DHCP servers' configurations) without the need to restart those + servers. Using these commands it is possible to add, update, delete, and list client classes configured for a given server. - This library may only be loaded by kea-dhcp4 - or kea-dhcp6 process. + This library may only be loaded by the kea-dhcp4 + or the kea-dhcp6 process. @@ -26,10 +26,10 @@
- class-add command - The class-add command is used to add a new client + class-add Command + The class-add command adds a new client class to the DHCP server configuration. This class is appended at the - end of the list of classes used by the server, i.e. this class may depend + end of the list of classes used by the server and may depend on any of the already configured client classes. The following example demonstrates how to add a new client class to the DHCPv4 server configuration: @@ -52,14 +52,12 @@ Note that the client-classes parameter is a JSON list, - but it allows only a single client class to be present. In the future this - hooks library may be extended to support specification of multiple client - classes within a single class-add command. + but it allows only a single client class to be present. - The following is the example response to the class-add - command: + Here is the response to the class-add + command in our example: { "result": 0, @@ -70,18 +68,18 @@
- class-update command + class-update Command - The class-update command is used to update an existing + The class-update command updates an existing client class in the DHCP server configuration. If the client class with the - given name doesn't exist, the server returns result code of 3. In such case, - the server configuration is not modified (client class is not created). The + given name doesn't exist, the server returns the result code of 3, which means that + the server configuration is not modified and the client class does not exist. The class-add command must be used instead to create the new client class. - The class-update command has the same arguments structure - as class-add command: + The class-update command has the same argument structure + as the class-add command: { "command": "class-update", @@ -100,7 +98,7 @@ - The following is the example response: + Here is the response for our example: { "result": 0, @@ -112,21 +110,21 @@ Any parameter of the client class can be modified with this command, except name. There is currently no way to rename the class, because the class name is used as a key for searching the class to be updated. - In order to achieve similar effect to renaming the class, an existing class - should be removed with class-del command and then added - again with a different name using class-add. Note however, + To achieve a similar effect to renaming the class, an existing class + can be removed with the class-del command and then added + again with a different name using class-add. Note, however, that the class with the new name will be added at the end of the list of configured classes.
- class-del command + class-del Command The class-del is used to remove a particular class from the server configuration. The class to be removed is identified by name. - The class won't be removed if there are other classes dependening on it. - In order to remove such class, the dependent classes must be removed first. - The following is the example command removing + The class is not removed if there are other classes depending on it; + to remove such a class, the dependent classes must be removed first. + The following is a sample command removing the ipxe_efi_x64 class: { @@ -139,8 +137,8 @@ } - The following is the sample response to the class-del - command when the specified client class has been found: + Here is the response to the class-del + command in our example, when the specified client class has been found: { "result": 0, @@ -152,8 +150,8 @@
- class-list command - The class-list is used to retrieve a list of all + class-list Command + class-list is used to retrieve a list of all client classes. This command includes no arguments: { @@ -162,7 +160,7 @@ - The following is the example response of the server including the list + Here is the response of the server in our example, including the list of client classes: { @@ -183,15 +181,15 @@ Note that the returned list does not contain full class definitions, but - merely class names. In order to retrieve full class information, the + merely class names. To retrieve full class information, the class-get command should be used.
- class-get command - The class-get is used to retrieve detail information - about specified class. The command structure is very simple: + class-get Command + class-get is used to retrieve detailed information + about a specified class. The command structure is very simple: { "command": "class-get", @@ -202,7 +200,7 @@ - If the class with the specified name doesn't exist, the status code of 3 + If the class with the specified name does not exist, the status code of 3 is returned. If the specified client class exists, the class details are returned in the following format: @@ -233,11 +231,11 @@ - Note that the example above is DHCPv4 specific. The last three parameters - are only returned by the DHCPv4 server and never returned by the DHCPv6 + Note that the example above is DHCPv4-specific; the last three parameters + are only returned by the DHCPv4 server and are never returned by the DHCPv6 server. Also, some of the parameters provided in this example may not be returned if they are not specified for the class. Specifically, - only-if-required, test and the + only-if-required, test, and option-def are not returned if they are not specified for the class.