From: Suzanne Goldlust Date: Fri, 5 Nov 2021 21:32:03 +0000 (+0000) Subject: [#2139] Text edits X-Git-Tag: Kea-2.1.1~101 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f5e2fb59fb1a82eb991c22cf2c538dfcf062d4fb;p=thirdparty%2Fkea.git [#2139] Text edits --- diff --git a/doc/sphinx/arm/hooks-class-cmds.rst b/doc/sphinx/arm/hooks-class-cmds.rst index 6cef88a931..715b90dec0 100644 --- a/doc/sphinx/arm/hooks-class-cmds.rst +++ b/doc/sphinx/arm/hooks-class-cmds.rst @@ -1,13 +1,13 @@ .. _class-cmds-library: -class_cmds: Class Commands -========================== +``class_cmds``: Class Commands +============================== This section describes the Class Commands hooks library, which exposes 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. +list the client classes configured for a given server. .. note:: @@ -19,8 +19,8 @@ customers with a paid support contract. .. _command-class-add: -The class-add Command -~~~~~~~~~~~~~~~~~~~~~ +The ``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 @@ -61,8 +61,8 @@ Here is the response to the ``class-add`` command in our example: .. _command-class-update: -The class-update Command -~~~~~~~~~~~~~~~~~~~~~~~~ +The ``class-update`` Command +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``class-update`` command updates an existing client class in the DHCP server configuration. If the client class with the given name @@ -110,8 +110,8 @@ the new name will be added at the end of the list of configured classes. .. _command-class-del: -The class-del Command -~~~~~~~~~~~~~~~~~~~~~ +The ``class-del`` Command +~~~~~~~~~~~~~~~~~~~~~~~~~ The ``class-del`` command is used to remove a particular class from the server @@ -146,8 +146,8 @@ If the class does not exist, the result of 3 is returned. .. _command-class-list: -The class-list Command -~~~~~~~~~~~~~~~~~~~~~~ +The ``class-list`` Command +~~~~~~~~~~~~~~~~~~~~~~~~~~ ``class-list`` is used to retrieve a list of all client classes. This @@ -185,9 +185,8 @@ merely class names. To retrieve full class information, the .. _command-class-get: -The class-get Command -~~~~~~~~~~~~~~~~~~~~~ - +The ``class-get`` Command +~~~~~~~~~~~~~~~~~~~~~~~~~ ``class-get`` is used to retrieve detailed information about a specified class. The command structure is very simple: