From: Andrei Pavel Date: Tue, 6 Jun 2023 10:33:44 +0000 (+0300) Subject: [#2554] add 'isccmd' anchors X-Git-Tag: Kea-2.4.0~197 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bf8efb65021bba18a951baa1d46c61721eec25cb;p=thirdparty%2Fkea.git [#2554] add 'isccmd' anchors --- diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst index e9a6b971c0..5f0dd67913 100644 --- a/doc/sphinx/arm/ctrl-channel.rst +++ b/doc/sphinx/arm/ctrl-channel.rst @@ -323,6 +323,7 @@ This assumes that the Control Agent is running on host Commands Supported by Both the DHCPv4 and DHCPv6 Servers ======================================================== +.. isccmd:: build-report .. _command-build-report: The ``build-report`` Command @@ -338,6 +339,7 @@ command line ``-W`` argument displays, i.e. the embedded content of the "command": "build-report" } +.. isccmd:: config-get .. _command-config-get: The ``config-get`` Command @@ -367,6 +369,7 @@ An example command invocation looks like this: "command": "config-get" } +.. isccmd:: config-reload .. _command-config-reload: The ``config-reload`` Command @@ -398,6 +401,7 @@ If the configuration file is incorrect, reloading it can raise an error which leaves the server in an unusable state. See :ref:`command-config-set` to learn how to recover from a non-working server. +.. isccmd:: config-test .. _command-config-test: The ``config-test`` Command @@ -448,6 +452,7 @@ outcome: {"result": 1, "text": "unsupported parameter: BOGUS (:16:26)" } +.. isccmd:: config-write .. _command-config-write: The ``config-write`` Command @@ -471,6 +476,7 @@ An example command invocation looks like this: } } +.. isccmd:: leases-reclaim .. _command-leases-reclaim: The ``leases-reclaim`` Command @@ -496,6 +502,7 @@ returning client that previously used that lease. See :ref:`lease-affinity` for details. Also, see :ref:`lease-reclamation` for general information about the processing of expired leases (lease reclamation). +.. isccmd:: libreload .. _command-libreload: The ``libreload`` Command @@ -520,6 +527,7 @@ originally loaded. The server responds with a result of either 0, indicating success, or 1, indicating failure. +.. isccmd:: list-commands .. _command-list-commands: The ``list-commands`` Command @@ -540,6 +548,7 @@ The server responds with a list of all supported commands. The arguments element is a list of strings, each of which conveys one supported command. +.. isccmd:: config-set .. _command-config-set: The ``config-set`` Command @@ -599,6 +608,7 @@ string, ``text``, describing the outcome: {"result": 1, "text": "unsupported parameter: BOGUS (:16:26)" } +.. isccmd:: shutdown .. _command-shutdown: The ``shutdown`` Command @@ -646,6 +656,7 @@ An example command may look like this: } } +.. isccmd:: dhcp-disable .. _command-dhcp-disable: The ``dhcp-disable`` Command @@ -681,6 +692,7 @@ HA operation. The administrator should either omit this parameter or set it to } } +.. isccmd:: dhcp-enable .. _command-dhcp-enable: The ``dhcp-enable`` Command @@ -707,6 +719,7 @@ HA operation. The administrator should either omit this parameter or set it to } } +.. isccmd:: status-get .. _command-status-get: The ``status-get`` Command @@ -759,6 +772,7 @@ To learn more about the HA status information returned by the section. +.. isccmd:: server-tag-get .. _command-server-tag-get: The ``server-tag-get`` Command: @@ -767,6 +781,7 @@ The ``server-tag-get`` Command: The ``server-tag-get`` command returns the configured server tag of the DHCPv4 or DHCPv6 server (:ref:`cb-sharing` explains the server tag concept). +.. isccmd:: config-backend-pull .. _command-config-backend-pull: The ``config-backend-pull`` Command: @@ -776,6 +791,7 @@ The ``config-backend-pull`` command triggers the polling of configuration backen (which must be configured for this command to have an effect), explained in :ref:`dhcp4-cb-json`. +.. isccmd:: version-get .. _command-version-get: The ``version-get`` Command diff --git a/doc/sphinx/arm/ext-gss-tsig.rst b/doc/sphinx/arm/ext-gss-tsig.rst index 266273f519..413fccd8d9 100644 --- a/doc/sphinx/arm/ext-gss-tsig.rst +++ b/doc/sphinx/arm/ext-gss-tsig.rst @@ -957,6 +957,7 @@ GSS-TSIG Commands The GSS-TSIG hook library supports some commands, which are described below. +.. isccmd:: gss-tsig-get-all .. _command-gss-tsig-get-all: The ``gss-tsig-get-all`` Command @@ -1014,6 +1015,7 @@ Here is an example of a response returning one GSS-TSIG server and one key: } } +.. isccmd:: gss-tsig-get .. _command-gss-tsig-get: The ``gss-tsig-get`` Command @@ -1060,6 +1062,7 @@ Here is an example of a response returning information about the server "foo": } } +.. isccmd:: gss-tsig-list .. _command-gss-tsig-list: The ``gss-tsig-list`` Command @@ -1095,6 +1098,7 @@ Here is an example of a response returning two GSS-TSIG servers and three keys: } } +.. isccmd:: gss-tsig-key-get .. _command-gss-tsig-key-get: The ``gss-tsig-key-get`` Command @@ -1130,6 +1134,7 @@ Here is an example of a response returning information about GSS-TSIG key "1234. } } +.. isccmd:: gss-tsig-key-expire .. _command-gss-tsig-key-expire: The ``gss-tsig-key-expire`` Command @@ -1157,6 +1162,7 @@ Here is an example of a response indicating that GSS-TSIG key "1234.sig-foo.com. "text": "GSS-TSIG key '1234.sig-foo.com.' expired" } +.. isccmd:: gss-tsig-key-del .. _command-gss-tsig-key-del: The ``gss-tsig-key-del`` Command @@ -1184,6 +1190,7 @@ Here is an example of a response indicating that GSS-TSIG key "1234.sig-foo.com. "text": "GSS-TSIG key '1234.sig-foo.com.' deleted" } +.. isccmd:: gss-tsig-purge-all .. _command-gss-tsig-purge-all: The ``gss-tsig-purge-all`` Command @@ -1208,6 +1215,7 @@ Here is an example of a response indicating that two GSS-TSIG keys have been pur "text": "2 purged GSS-TSIG keys" } +.. isccmd:: gss-tsig-purge .. _command-gss-tsig-purge: The ``gss-tsig-purge`` Command @@ -1235,6 +1243,7 @@ Here is an example of a response indicating that two GSS-TSIG keys for server "f "text": "2 purged keys for GSS-TSIG server[foo]" } +.. isccmd:: gss-tsig-rekey-all .. _command-gss-tsig-rekey-all: The ``gss-tsig-rekey-all`` Command @@ -1263,6 +1272,7 @@ Here is an example of a response indicating that a rekey was performed: This command is useful when, for instance, the DHCP-DDNS server is reconnected to the network. +.. isccmd:: gss-tsig-rekey .. _command-gss-tsig-rekey: The ``gss-tsig-rekey`` Command diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst index 6459414c4b..f7ab62e8ed 100644 --- a/doc/sphinx/arm/hooks-cb-cmds.rst +++ b/doc/sphinx/arm/hooks-cb-cmds.rst @@ -172,7 +172,9 @@ the ``server-tags`` parameter. In future releases, it is expected that this map will be extended with additional information, e.g. object modification time, log message created during the last modification, etc. +.. isccmd:: remote-server4-del .. _command-remote-server4-del: +.. isccmd:: remote-server6-del .. _command-remote-server6-del: The ``remote-server4-del``, ``remote-server6-del`` Commands @@ -238,7 +240,9 @@ The following is the successful response to the ``remote-server4-del`` command: does not revert the lost configuration for that server and such configuration must be re-created manually by the user. +.. isccmd:: remote-server4-get .. _command-remote-server4-get: +.. isccmd:: remote-server6-get .. _command-remote-server6-get: The ``remote-server4-get``, ``remote-server6-get`` Commands @@ -285,7 +289,9 @@ description of the server: } } +.. isccmd:: remote-server4-get-all .. _command-remote-server4-get-all: +.. isccmd:: remote-server6-get-all .. _command-remote-server6-get-all: The ``remote-server4-get-all``, ``remote-server6-get-all`` Commands @@ -328,7 +334,9 @@ tag and description: } } +.. isccmd:: remote-server4-set .. _command-remote-server4-set: +.. isccmd:: remote-server6-set .. _command-remote-server6-set: The ``remote-server4-set``, ``remote-server6-set`` Commands @@ -387,8 +395,10 @@ The following is the example response to the above command: } +.. isccmd:: remote-global-parameter4-del .. _command-remote-global-parameter4-del: +.. isccmd:: remote-global-parameter6-del .. _command-remote-global-parameter6-del: The ``remote-global-parameter4-del``, ``remote-global-parameter6-del`` Commands @@ -420,8 +430,10 @@ If a server-specific parameter is to be deleted, the ``server-tags`` list must contain the tag of the appropriate server. There must be exactly one server tag specified in this list. +.. isccmd:: remote-global-parameter4-get .. _command-remote-global-parameter4-get: +.. isccmd:: remote-global-parameter6-get .. _command-remote-global-parameter6-get: The ``remote-global-parameter4-get``, ``remote-global-parameter6-get`` Commands @@ -533,8 +545,10 @@ Finally, the boolean value: } +.. isccmd:: remote-global-parameter4-get-all .. _command-remote-global-parameter4-get-all: +.. isccmd:: remote-global-parameter6-get-all .. _command-remote-global-parameter6-get-all: The ``remote-global-parameter4-get-all``, ``remote-global-parameter6-get-all`` Commands @@ -599,8 +613,10 @@ global parameters are non-shareable configuration elements. example above), the returned list combines parameters associated with this server and all servers, but the former take precedence. +.. isccmd:: remote-global-parameter4-set .. _command-remote-global-parameter4-set: +.. isccmd:: remote-global-parameter6-set .. _command-remote-global-parameter6-set: The ``remote-global-parameter4-set``, ``remote-global-parameter6-set`` Commands @@ -642,8 +658,10 @@ The ``server-tags`` list is mandatory and must contain a single server tag or the keyword "all". In the example above, all specified parameters are associated with the "server1" server. +.. isccmd:: remote-network4-del .. _command-remote-network4-del: +.. isccmd:: remote-network6-del .. _command-remote-network6-del: The ``remote-network4-del``, ``remote-network6-del`` Commands @@ -683,8 +701,10 @@ global. This behavior corresponds to the behavior of the Note that the ``server-tags`` parameter cannot be used for this command. +.. isccmd:: remote-network4-get .. _command-remote-network4-get: +.. isccmd:: remote-network6-get .. _command-remote-network6-get: The ``remote-network4-get``, ``remote-network6-get`` Commands @@ -719,8 +739,10 @@ with the full information about the subnets belonging to it: Note that the ``server-tags`` parameter cannot be used for this command. +.. isccmd:: remote-network4-list .. _command-remote-network4-list: +.. isccmd:: remote-network6-list .. _command-remote-network6-list: The ``remote-network4-list``, ``remote-network6-list`` Commands @@ -829,8 +851,10 @@ to this: The ``null`` value in the metadata indicates that the returned shared network is unassigned. +.. isccmd:: remote-network4-set .. _command-remote-network4-set: +.. isccmd:: remote-network6-set .. _command-remote-network6-set: The ``remote-network4-set``, ``remote-network6-set`` Commands @@ -897,8 +921,10 @@ database when the keyword "all" is included. be marked unspecified in the database, even if its value was present prior to sending the command. +.. isccmd:: remote-option-def4-del .. _command-remote-option-def4-del: +.. isccmd:: remote-option-def6-del .. _command-remote-option-def6-del: The ``remote-option-def4-del``, ``remote-option-def6-del`` Commands @@ -935,8 +961,10 @@ deleted. To delete an option belonging to "all" servers, the keyword "all" must be used as the server tag. The ``server-tags`` list must contain exactly one tag and cannot include the ``null`` value. +.. isccmd:: remote-option-def4-get .. _command-remote-option-def4-get: +.. isccmd:: remote-option-def6-get .. _command-remote-option-def6-get: The ``remote-option-def4-get``, ``remote-option-def6-get`` Commands @@ -971,8 +999,10 @@ servers, having the code of 1 and belonging to the option space "isc": The ``server-tags`` list must include exactly one server tag or the keyword "all", and cannot contain the `null` value. +.. isccmd:: remote-option-def4-get-all .. _command-remote-option-def4-get-all: +.. isccmd:: remote-option-def6-get-all .. _command-remote-option-def6-get-all: The ``remote-option-def4-get-all``, ``remote-option-def6-get-all`` Commands @@ -1027,8 +1057,10 @@ The following is the example response to this command: The response contains an option definition associated with all servers, as indicated by the metadata. +.. isccmd:: remote-option-def4-set .. _command-remote-option-def4-set: +.. isccmd:: remote-option-def6-set .. _command-remote-option-def6-set: The ``remote-option-def4-set``, ``remote-option-def6-set`` Commands @@ -1068,8 +1100,10 @@ The ``server-tags`` list must include exactly one server tag or the keyword "all", and cannot contain the ``null`` value. +.. isccmd:: remote-option4-global-del .. _command-remote-option4-global-del: +.. isccmd:: remote-option6-global-del .. _command-remote-option6-global-del: The ``remote-option4-global-del``, ``remote-option6-global-del`` Commands @@ -1105,8 +1139,10 @@ server. If there is no such option associated with the given server, no option is deleted. To delete an option associated with all servers, the keyword "all" must be specified. +.. isccmd:: remote-option4-global-get .. _command-remote-option4-global-get: +.. isccmd:: remote-option6-global-get .. _command-remote-option6-global-get: The ``remote-option4-global-get``, ``remote-option6-global-get`` Commands @@ -1142,8 +1178,10 @@ The ``server-tags`` parameter is mandatory and must include exactly one server tag or the keyword "all". It cannot contain the ``null`` value. +.. isccmd:: remote-option4-global-get-all .. _command-remote-option4-global-get-all: +.. isccmd:: remote-option6-global-get-all .. _command-remote-option6-global-get-all: The ``remote-option4-global-get-all``, ``remote-option6-global-get-all`` Commands @@ -1194,8 +1232,10 @@ command with a single option being associated with "server1" returned: } } +.. isccmd:: remote-option4-global-set .. _command-remote-option4-global-set: +.. isccmd:: remote-option6-global-set .. _command-remote-option6-global-set: The ``remote-option4-global-set``, ``remote-option6-global-set`` Commands @@ -1250,8 +1290,10 @@ instead of the name. For example: } } +.. isccmd:: remote-option4-network-del .. _command-remote-option4-network-del: +.. isccmd:: remote-option6-network-del .. _command-remote-option6-network-del: The ``remote-option4-network-del``, ``remote-option6-network-del`` Commands @@ -1299,8 +1341,10 @@ network "fancy". The "dhcp4" value represents the top-level option space where the standard DHCPv4 options belong. The ``server-tags`` parameter cannot be specified for this command. +.. isccmd:: remote-option4-network-set .. _command-remote-option4-network-set: +.. isccmd:: remote-option6-network-set .. _command-remote-option6-network-set: The ``remote-option4-network-set``, ``remote-option6-network-set`` Commands @@ -1342,6 +1386,7 @@ Specifying an option name instead of the option code only works reliably for standard DHCP options. When specifying a value for a user-defined DHCP option, the option code should be indicated instead of the name. +.. isccmd:: remote-option6-pd-pool-del .. _command-remote-option6-pd-pool-del: The ``remote-option6-pd-pool-del`` Command @@ -1385,6 +1430,7 @@ option. To delete a subnet level option, the The "dhcp6" value represents the top-level option space where the standard DHCPv6 options belong. The ``server-tags`` parameter cannot be specified for this command. +.. isccmd:: remote-option6-pd-pool-set .. _command-remote-option6-pd-pool-set: The ``remote-option6-pd-pool-set`` Command @@ -1430,8 +1476,10 @@ Specifying an option name instead of the option code only works reliably for standard DHCP options. When specifying a value for a user-defined DHCP option, the option code should be indicated instead of the name. +.. isccmd:: remote-option4-pool-del .. _command-remote-option4-pool-del: +.. isccmd:: remote-option6-pool-del .. _command-remote-option6-pool-del: The ``remote-option4-pool-del``, ``remote-option6-pool-del`` Commands @@ -1478,8 +1526,10 @@ pool: The "dhcp4" value represents the top-level option space where the standard DHCPv4 options belong. The ``server-tags`` parameter cannot be specified for this command. +.. isccmd:: remote-option4-pool-set .. _command-remote-option4-pool-set: +.. isccmd:: remote-option6-pool-set .. _command-remote-option6-pool-set: The ``remote-option4-pool-set``, ``remote-option6-pool-set`` Commands @@ -1523,8 +1573,10 @@ Specifying an option name instead of the option code only works reliably for standard DHCP options. When specifying a value for a user-defined DHCP option, the option code should be indicated instead of the name. +.. isccmd:: remote-option4-subnet-del .. _command-remote-option4-subnet-del: +.. isccmd:: remote-option6-subnet-del .. _command-remote-option6-subnet-del: The ``remote-option4-subnet-del``, ``remote-option6-subnet-del`` Commands @@ -1567,8 +1619,10 @@ having an identifier of 123. The "dhcp4" value represents the top-level option space where the standard DHCPv4 options belong. The ``server-tags`` parameter cannot be specified for this command. +.. isccmd:: remote-option4-subnet-set .. _command-remote-option4-subnet-set: +.. isccmd:: remote-option6-subnet-set .. _command-remote-option6-subnet-set: The ``remote-option4-subnet-set``, ``remote-option6-subnet-set`` Commands @@ -1610,8 +1664,10 @@ Specifying an option name instead of the option code only works reliably for the standard DHCP options. When specifying a value for the user-defined DHCP option, the option code should be indicated instead of the name. +.. isccmd:: remote-subnet4-del-by-id .. _command-remote-subnet4-del-by-id: +.. isccmd:: remote-subnet6-del-by-id .. _command-remote-subnet6-del-by-id: The ``remote-subnet4-del-by-id``, ``remote-subnet6-del-by-id`` Commands @@ -1639,8 +1695,10 @@ example, to delete the IPv4 subnet with an ID of 5: The ``server-tags`` parameter cannot be used with this command. +.. isccmd:: remote-subnet4-del-by-prefix .. _command-remote-subnet4-del-by-prefix: +.. isccmd:: remote-subnet6-del-by-prefix .. _command-remote-subnet6-del-by-prefix: The ``remote-subnet4-del-by-prefix``, ``remote-subnet6-del-by-prefix`` Commands @@ -1668,8 +1726,10 @@ subnet. For example: The ``server-tags`` parameter cannot be used with this command. +.. isccmd:: remote-subnet4-get-by-id .. _command-remote-subnet4-get-by-id: +.. isccmd:: remote-subnet6-get-by-id .. _command-remote-subnet6-get-by-id: The ``remote-subnet4-get-by-id``, ``remote-subnet6-get-by-id`` Commands @@ -1697,8 +1757,10 @@ For example: The ``server-tags`` parameter cannot be used with this command. +.. isccmd:: remote-subnet4-get-by-prefix .. _command-remote-subnet4-get-by-prefix: +.. isccmd:: remote-subnet6-get-by-prefix .. _command-remote-subnet6-get-by-prefix: The ``remote-subnet4-get-by-prefix``, ``remote-subnet6-get-by-prefix`` Commands @@ -1726,8 +1788,10 @@ subnet. For example: The ``server-tags`` parameter cannot be used with this command. +.. isccmd:: remote-subnet4-list .. _command-remote-subnet4-list: +.. isccmd:: remote-subnet6-list .. _command-remote-subnet6-list: The ``remote-subnet4-list``, ``remote-subnet6-list`` Commands @@ -1835,8 +1899,10 @@ When listing unassigned subnets, the response will look similar to this: The ``null`` value in the metadata indicates that the returned subnet is unassigned. +.. isccmd:: remote-subnet4-set .. _command-remote-subnet4-set: +.. isccmd:: remote-subnet6-set .. _command-remote-subnet6-set: The ``remote-subnet4-set``, ``remote-subnet6-set`` Commands @@ -1927,8 +1993,10 @@ to the database when the keyword "all" is used as the server tag. will be marked as unspecified in the database, even if its value was present prior to sending the command. +.. isccmd:: remote-class4-del .. _command-remote-class4-del: +.. isccmd:: remote-class6-del .. _command-remote-class6-del: The ``remote-class4-del``, ``remote-class6-del`` Commands @@ -1960,8 +2028,10 @@ the dependent ones. The ``server-tags`` parameter cannot be used for this command because client classes are uniquely identified by name. +.. isccmd:: remote-class4-get .. _command-remote-class4-get: +.. isccmd:: remote-class6-get .. _command-remote-class6-get: The ``remote-class4-get``, ``remote-class6-get`` Commands @@ -2009,8 +2079,10 @@ A response to the command looks similar to this: } } +.. isccmd:: remote-class4-get-all .. _command-remote-class4-get-all: +.. isccmd:: remote-class6-get-all .. _command-remote-class6-get-all: The ``remote-class4-get-all``, ``remote-class6-get-all`` Commands @@ -2070,8 +2142,10 @@ A response to the command looks similar to this: } } +.. isccmd:: remote-class4-set .. _command-remote-class4-set: +.. isccmd:: remote-class6-set .. _command-remote-class6-set: The ``remote-class4-set``, ``remote-class6-set`` Commands diff --git a/doc/sphinx/arm/hooks-class-cmds.rst b/doc/sphinx/arm/hooks-class-cmds.rst index af21e0d4c1..4eb4d057e3 100644 --- a/doc/sphinx/arm/hooks-class-cmds.rst +++ b/doc/sphinx/arm/hooks-class-cmds.rst @@ -17,6 +17,7 @@ list the client classes configured for a given server. The Class Commands hook library is currently available only to ISC customers with a paid support contract. +.. isccmd:: class-add .. _command-class-add: The ``class-add`` Command @@ -59,6 +60,7 @@ Here is the response to the ``class-add`` command in our example: "text": "Class 'ipxe_efi_x64' added." } +.. isccmd:: class-update .. _command-class-update: The ``class-update`` Command @@ -117,6 +119,7 @@ of the client class, picking the client class out of the response, modifying it to the required outcome, and then issuing the ``client-update`` command with the resulting client class attached. +.. isccmd:: class-del .. _command-class-del: The ``class-del`` Command @@ -151,6 +154,7 @@ the specified client class has been found: If the class does not exist, the result of 3 is returned. +.. isccmd:: class-list .. _command-class-list: The ``class-list`` Command @@ -190,6 +194,7 @@ Note that the returned list does not contain full class definitions, but merely class names. To retrieve full class information, the ``class-get`` command should be used. +.. isccmd:: class-get .. _command-class-get: The ``class-get`` Command diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst index 6b9f47bdb1..53ec9169e0 100644 --- a/doc/sphinx/arm/hooks-ha.rst +++ b/doc/sphinx/arm/hooks-ha.rst @@ -1904,6 +1904,7 @@ queries, the server administrator must enable this function manually. The following sections describe commands supported by the HA hook library which are available for the administrator. +.. isccmd:: ha-sync .. _command-ha-sync: The ``ha-sync`` Command @@ -1948,6 +1949,7 @@ in progress. If the DHCP server subsequently allocates any leases during the synchronization, those new (or updated) leases will not be fetched by the synchronizing server, leading to database inconsistencies. +.. isccmd:: ha-scopes .. _command-ha-scopes: The ``ha-scopes`` Command @@ -1981,6 +1983,7 @@ and "HA_server2" scopes. To disable all scopes specify an empty list: } } +.. isccmd:: ha-continue .. _command-ha-continue: The ``ha-continue`` Command @@ -1997,6 +2000,7 @@ command structure is simply: "service": [ "dhcp4" ] } +.. isccmd:: ha-heartbeat .. _command-ha-heartbeat: The ``ha-heartbeat`` Command @@ -2095,6 +2099,7 @@ has entered the ``partner-down`` state. the state of the entire HA setup. Sending it to only one of the servers may not reflect issues that just began with one of the servers. +.. isccmd:: ha-status-get .. _command-ha-status-get: The ``status-get`` Command @@ -2231,6 +2236,7 @@ The ``status-get`` response has the format described above only in the only one active server (local). The response includes no information about the status of the backup servers. +.. isccmd:: ha-maintenance-start .. _command-ha-maintenance-start: The ``ha-maintenance-start`` Command @@ -2248,6 +2254,7 @@ for details. "service": [ "dhcp4" ] } +.. isccmd:: ha-maintenance-cancel .. _command-ha-maintenance-cancel: The ``ha-maintenance-cancel`` Command @@ -2266,6 +2273,7 @@ its previous state. See the :ref:`ha-maintenance` section for details. "service": [ "dhcp4" ] } +.. isccmd:: ha-maintenance-notify .. _command-ha-maintenance-notify: The ``ha-maintenance-notify`` Command @@ -2293,6 +2301,7 @@ previous state. See the :ref:`ha-maintenance` section for details. HA-enabled DHCP servers. Direct use of this command is not supported and may produce unintended consequences. +.. isccmd:: ha-reset .. _command-ha-reset: The ``ha-reset`` Command @@ -2331,6 +2340,7 @@ And elicits the response: If the server receiving this command is already in the ``waiting`` state, the command has no effect. +.. isccmd:: ha-sync-complete-notify .. _command-ha-sync-complete-notify: The ``ha-sync-complete-notify`` Command diff --git a/doc/sphinx/arm/hooks-host-cache.rst b/doc/sphinx/arm/hooks-host-cache.rst index 04c310b180..ad7f3d2d39 100644 --- a/doc/sphinx/arm/hooks-host-cache.rst +++ b/doc/sphinx/arm/hooks-host-cache.rst @@ -52,6 +52,7 @@ commands which can be used either over the control channel (see :ref:`shell-overview`. The following sections describe the commands available. +.. isccmd:: cache-flush .. _command-cache-flush: The ``cache-flush`` Command @@ -72,6 +73,7 @@ This command removes 1000 hosts; to delete *all* cached hosts, use ``cache-clear`` instead. The hosts are stored in FIFO (first-in, first-out) order, so the oldest entries are always removed. +.. isccmd:: cache-clear .. _command-cache-clear: The ``cache-clear`` Command @@ -89,6 +91,7 @@ looks as follows: This command removes all hosts. To delete only a certain number of cached hosts, please use ``cache-flush`` instead. +.. isccmd:: cache-size .. _command-cache-size: The ``cache-size`` Command @@ -103,6 +106,7 @@ as follows: "command": "cache-size" } +.. isccmd:: cache-write .. _command-cache-write: The ``cache-write`` Command @@ -133,6 +137,7 @@ This causes the contents to be stored in the ``/tmp/kea-host-cache.json`` file. That file can then be loaded with the ``cache-load`` command or processed by any other tool that is able to understand JSON format. +.. isccmd:: cache-load .. _command-cache-load: The ``cache-load`` Command @@ -156,6 +161,7 @@ This command stores the contents to the ``/tmp/kea-host-cache.json`` file. That file can then be loaded with the ``cache-load`` command or processed by any other tool that is able to understand JSON format. +.. isccmd:: cache-get .. _command-cache-get: The ``cache-get`` Command @@ -177,6 +183,7 @@ example usage looks as follows: This command returns all the cached hosts; the response may be large. +.. isccmd:: cache-get-by-id .. _command-cache-get-by-id: The ``cache-get-by-id`` Command @@ -200,6 +207,7 @@ host reservations. An example usage looks as follows: This command returns all the cached hosts with the given hardware address. +.. isccmd:: cache-insert .. _command-cache-insert: The ``cache-insert`` Command @@ -261,6 +269,7 @@ looks as follows: } } +.. isccmd:: cache-remove .. _command-cache-remove: The ``cache-remove`` Command diff --git a/doc/sphinx/arm/hooks-host-cmds.rst b/doc/sphinx/arm/hooks-host-cmds.rst index 6f32c8556a..02f1bdf278 100644 --- a/doc/sphinx/arm/hooks-host-cmds.rst +++ b/doc/sphinx/arm/hooks-host-cmds.rst @@ -125,6 +125,7 @@ The operation target accepts the following values: - ``all`` - query both sources - JSON configuration and host database(s). - ``default`` - query the default source - it's command specific. +.. isccmd:: reservation-add .. _command-reservation-add: The ``reservation-add`` Command @@ -260,6 +261,7 @@ As ``reservation-add`` is expected to store the host, the ``hosts-databases`` parameter must be specified in the configuration, and databases must not run in read-only mode. +.. isccmd:: reservation-get .. _command-reservation-get: The ``reservation-get`` Command @@ -360,6 +362,7 @@ An example result returned when the query was malformed might look like this: { "result": 1, "text": "No 'ip-address' provided and 'identifier-type' is either missing or not a string." } +.. isccmd:: reservation-get-all .. _command-reservation-get-all: The ``reservation-get-all`` Command @@ -439,6 +442,7 @@ reservation from both JSON configuration and the hosts database. For more information, see :ref:`command-reservation-get-all`. +.. isccmd:: reservation-get-page .. _command-reservation-get-page: The ``reservation-get-page`` command @@ -569,6 +573,7 @@ users retrieve larger host reservations lists in smaller chunks. For small deployments with few reservations, it is easier to use ``reservation-get-all`` (see :ref:`command-reservation-get-all`). +.. isccmd:: reservation-get-by-hostname .. _command-reservation-get-by-hostname: The ``reservation-get-by-hostname`` Command @@ -653,6 +658,7 @@ For more information, see :ref:`command-reservation-get-by-hostname`. collation, as explained in the :ref:`mysql-database` section of :ref:`admin`. +.. isccmd:: reservation-get-by-id .. _command-reservation-get-by-id: The ``reservation-get-by-id`` Command @@ -733,6 +739,7 @@ reservation from both JSON configuration and the hosts database. For more information, see :ref:`command-reservation-get-by-id`. +.. isccmd:: reservation-del .. _command-reservation-del: The ``reservation-del`` Command @@ -823,6 +830,7 @@ the reservation from the hosts database only. } } +.. isccmd:: reservation-update .. _command-reservation-update: The ``reservation-update`` Command diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst index 4e5e48dd8b..5af6debf8e 100644 --- a/doc/sphinx/arm/hooks-lease-cmds.rst +++ b/doc/sphinx/arm/hooks-lease-cmds.rst @@ -118,8 +118,10 @@ servers. ] } +.. isccmd:: lease4-add .. _command-lease4-add: +.. isccmd:: lease6-add .. _command-lease6-add: The ``lease4-add``, ``lease6-add`` Commands @@ -277,6 +279,7 @@ Example failure: { "result": 1, "text": "missing parameter 'ip-address' (:3:19)" } +.. isccmd:: lease6-bulk-apply .. _command-lease6-bulk-apply: The ``lease6-bulk-apply`` Command @@ -388,8 +391,10 @@ lease, e.g. a communication error with the database. The result of 3 indicates that an attempt to delete the lease was unsuccessful because such a lease doesn't exist (an empty result). +.. isccmd:: lease4-get .. _command-lease4-get: +.. isccmd:: lease6-get .. _command-lease6-get: The ``lease4-get``, ``lease6-get`` Commands @@ -521,8 +526,10 @@ An example result returned when the host was found: :math:`cltt = expire` when :math:`valid\_lft = 4294967295` and the lease backend is MySQL or PostgreSQL. +.. isccmd:: lease4-get-all .. _command-lease4-get-all: +.. isccmd:: lease6-get-all .. _command-lease6-get-all: The ``lease4-get-all``, ``lease6-get-all`` Commands @@ -606,8 +613,10 @@ following format: restriction on the number of leases returned as a result of this command. +.. isccmd:: lease4-get-page .. _command-lease4-get-page: +.. isccmd:: lease6-get-page .. _command-lease6-get-page: The ``lease4-get-page``, ``lease6-get-page`` Commands @@ -729,14 +738,19 @@ The client may assume that it has reached the last page when the includes the case when the ``count`` is equal to 0, meaning that no leases were found. +.. isccmd:: lease4-get-by-hw-address .. _command-lease4-get-by-hw-address: +.. isccmd:: lease4-get-by-client-id .. _command-lease4-get-by-client-id: +.. isccmd:: lease6-get-by-duid .. _command-lease6-get-by-duid: +.. isccmd:: lease4-get-by-hostname .. _command-lease4-get-by-hostname: +.. isccmd:: lease6-get-by-hostname .. _command-lease6-get-by-hostname: The ``lease4-get-by-*``, ``lease6-get-by-*`` Commands @@ -774,8 +788,10 @@ The ``by`` key is the only parameter. The returned response contains a detailed list of leases in the same format as ``lease4-get-all`` or ``lease6-get-all``. This list can be empty and is usually not large. +.. isccmd:: lease4-del .. _command-lease4-del: +.. isccmd:: lease6-del .. _command-lease6-del: The ``lease4-del``, ``lease6-del`` Commands @@ -845,8 +861,10 @@ of the operation. It has one of the following values: 0 (success), 1 (error), or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease, in this case) has not been found. +.. isccmd:: lease4-update .. _command-lease4-update: +.. isccmd:: lease6-update .. _command-lease6-update: The ``lease4-update``, ``lease6-update`` Commands @@ -912,8 +930,10 @@ command to get the current state of the lease, picking the lease out of the response, modifying it to the required outcome, and then issuing the ``lease4-update``/``lease6-update`` command with the resulting lease attached. +.. isccmd:: lease4-wipe .. _command-lease4-wipe: +.. isccmd:: lease6-wipe .. _command-lease6-wipe: The ``lease4-wipe``, ``lease6-wipe`` Commands @@ -959,8 +979,10 @@ not specified, leases from all subnets are wiped. Note: currently only memfile lease storage supports this command. +.. isccmd:: lease4-resend-ddns .. _command-lease4-resend-ddns: +.. isccmd:: lease6-resend-ddns .. _command-lease6-resend-ddns: The ``lease4-resend-ddns``, ``lease6-resend-ddns`` Commands @@ -1018,8 +1040,10 @@ Here's an example of a result returned when the lease was found: "text": "NCR generated for: 2001:db8:1::1, hostname: example.com." } +.. isccmd:: lease4-write .. _command-lease4-write: +.. isccmd:: lease6-write .. _command-lease6-write: The ``lease4-write``, ``lease6-write`` Commands diff --git a/doc/sphinx/arm/hooks-lease-query.rst b/doc/sphinx/arm/hooks-lease-query.rst index 0d40831bbf..4f917a55bd 100644 --- a/doc/sphinx/arm/hooks-lease-query.rst +++ b/doc/sphinx/arm/hooks-lease-query.rst @@ -609,6 +609,7 @@ backends, leases created prior to the server being configured for Bulk Lease Query will not contain the new data required. In order to populate this data it is necessary to run API commands: +.. isccmd:: extended-info4-upgrade .. _command-extended-info4-upgrade: For DHCPv4 lease data, the command is: @@ -619,6 +620,7 @@ For DHCPv4 lease data, the command is: "command": "extended-info4-upgrade" } +.. isccmd:: binary-address6-upgrade .. _command-binary-address6-upgrade: For DHCPv6 lease data, there are two commands, for upgrading the binary @@ -630,6 +632,7 @@ address used for by link address query the command is: "command": "binary-address6-upgrade" } +.. isccmd:: extended-info6-upgrade .. _command-extended-info6-upgrade: for extended info used for by relay id and by remote id the command is diff --git a/doc/sphinx/arm/hooks-stat-cmds.rst b/doc/sphinx/arm/hooks-stat-cmds.rst index 211a384271..cdd23b402f 100644 --- a/doc/sphinx/arm/hooks-stat-cmds.rst +++ b/doc/sphinx/arm/hooks-stat-cmds.rst @@ -57,8 +57,10 @@ a server's response to a that server. In other words, if a subnet does not appear in a server's configuration, Kea will not retrieve statistics for it. +.. isccmd:: stat-lease4-get .. _command-stat-lease4-get: +.. isccmd:: stat-lease6-get .. _command-stat-lease6-get: The ``stat-lease4-get``, ``stat-lease6-get`` Commands diff --git a/doc/sphinx/arm/hooks-subnet-cmds.rst b/doc/sphinx/arm/hooks-subnet-cmds.rst index 166d0d1403..7dedb04f45 100644 --- a/doc/sphinx/arm/hooks-subnet-cmds.rst +++ b/doc/sphinx/arm/hooks-subnet-cmds.rst @@ -60,6 +60,7 @@ The following commands are currently supported: - ``network4-subnet-del``/``network6-subnet-del`` - removes a subnet from an existing shared network and demotes it to a plain subnet. +.. isccmd:: subnet4-list .. _command-subnet4-list: The ``subnet4-list`` Command @@ -102,6 +103,7 @@ The list of subnets is returned in the following format: If no IPv4 subnets are found, an error code is returned along with the error description. +.. isccmd:: subnet6-list .. _command-subnet6-list: The ``subnet6-list`` Command @@ -144,6 +146,7 @@ The list of subnets is returned in the following format: If no IPv6 subnets are found, an error code is returned along with the error description. +.. isccmd:: subnet4-get .. _command-subnet4-get: The ``subnet4-get`` Command @@ -199,6 +202,7 @@ If the subnet exists, the response will be similar to this: } } +.. isccmd:: subnet6-get .. _command-subnet6-get: The ``subnet6-get`` Command @@ -254,6 +258,7 @@ If the subnet exists, the response will be similar to this: } } +.. isccmd:: subnet4-add .. _command-subnet4-add: The ``subnet4-add`` Command @@ -301,6 +306,7 @@ The response to this command has the following structure: } } +.. isccmd:: subnet6-add .. _command-subnet6-add: The ``subnet6-add`` Command @@ -373,6 +379,7 @@ automatic ``subnet-id`` generation works in Kea. Subnet IDs must be greater than zero and less than 4294967295. +.. isccmd:: subnet4-update .. _command-subnet4-update: The ``subnet4-update`` Command @@ -426,6 +433,7 @@ entry. If the IPv4 subnet previously had a resource assigned to it, and the server configuration. If an incremental update of the subnet is desired, then this can be achieved with `subnet4-delta-add `_. +.. isccmd:: subnet6-update .. _command-subnet6-update: The ``subnet6-update`` Command @@ -479,6 +487,7 @@ entry. If the IPv6 subnet previously had a resource assigned to it, and the server configuration. If an incremental update of the subnet is desired, then this can be achieved with `subnet6-delta-add `_. +.. isccmd:: subnet4-del .. _command-subnet4-del: The ``subnet4-del`` Command @@ -534,6 +543,7 @@ A successful response may look like this: } } +.. isccmd:: subnet6-del .. _command-subnet6-del: The ``subnet6-del`` Command @@ -587,6 +597,7 @@ A successful response may look like this: ] } +.. isccmd:: subnet4-delta-add .. _command-subnet4-delta-add: The ``subnet4-delta-add`` Command @@ -664,6 +675,7 @@ lifetime, adding or changing the subnet level option 3 ("routers"), by adding or changing the pool "10.20.30.1-10.20.30.10" and by adding or changing the pool level option 4 ("time-servers"). +.. isccmd:: subnet6-delta-add .. _command-subnet6-delta-add: The ``subnet6-delta-add`` Command @@ -760,6 +772,7 @@ changing the pool level option 31 ("sntp-servers"), by adding or changing the pd-pool "2001:db8:2::" with prefix-len 48 and by adding or changing the pd-pool level option 22 ("sip-server-addr"). +.. isccmd:: subnet4-delta-del .. _command-subnet4-delta-del: The ``subnet4-delta-del`` Command @@ -836,6 +849,7 @@ The scalar values don't need to match what is configured, but still need to be present to maintain a valid json structure and to be a valid value to be able to be parsed. +.. isccmd:: subnet6-delta-del .. _command-subnet6-delta-del: The ``subnet6-delta-del`` Command @@ -930,8 +944,10 @@ The scalar values don't need to match what is configured, but still need to be present to maintain a valid json structure and to be a valid value to be able to be parsed. +.. isccmd:: network4-list .. _command-network4-list: +.. isccmd:: network6-list .. _command-network6-list: The ``network4-list``, ``network6-list`` Commands @@ -968,8 +984,10 @@ An example response for ``network4-list`` looks as follows: The ``network6-list`` command uses exactly the same syntax for both the command and the response. +.. isccmd:: network4-get .. _command-network4-get: +.. isccmd:: network6-get .. _command-network6-get: The ``network4-get``, ``network6-get`` Commands @@ -1044,8 +1062,10 @@ omitted here for clarity. The response format is exactly the same as used in ``config-get``, just limited to returning the shared network's information. +.. isccmd:: network4-add .. _command-network4-add: +.. isccmd:: network6-add .. _command-network6-add: The ``network4-add``, ``network6-add`` Commands @@ -1125,8 +1145,10 @@ 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``). The same applies to subnets within the network. +.. isccmd:: network4-del .. _command-network4-del: +.. isccmd:: network6-del .. _command-network6-del: The ``network4-del``, ``network6-del`` Commands @@ -1187,8 +1209,10 @@ subnets in it could look as follows: Alternatively, to completely remove the subnets, it is possible to use the ``subnet4-del`` or ``subnet6-del`` commands. +.. isccmd:: network4-subnet-add .. _command-network4-subnet-add: +.. isccmd:: network6-subnet-add .. _command-network6-subnet-add: The ``network4-subnet-add``, ``network6-subnet-add`` Commands @@ -1250,8 +1274,10 @@ command and the response. Any missing parameters will be filled with default values, rather than inherited from the global scope or from the shared network. +.. isccmd:: network4-subnet-del .. _command-network4-subnet-del: +.. isccmd:: network6-subnet-del .. _command-network6-subnet-del: The ``network4-subnet-del``, ``network6-subnet-del`` Commands diff --git a/doc/sphinx/arm/stats.rst b/doc/sphinx/arm/stats.rst index 289d4dd92c..4b00dbad87 100644 --- a/doc/sphinx/arm/stats.rst +++ b/doc/sphinx/arm/stats.rst @@ -83,6 +83,7 @@ and the device is removed, the system administrator may want to remove the ``pkt4-decline-received`` statistic so that it is no longer reported, until and unless a duplicate address is again detected. +.. isccmd:: stats .. _command-stats: Commands for Manipulating Statistics @@ -111,6 +112,7 @@ to record it. more information on sending commands to Kea, see :ref:`ctrl-channel`. +.. isccmd:: statistic-get .. _command-statistic-get: The ``statistic-get`` Command @@ -147,6 +149,7 @@ Here is an example response: "result": 0 } +.. isccmd:: statistic-reset .. _command-statistic-reset: The ``statistic-reset`` Command @@ -173,6 +176,7 @@ 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. +.. isccmd:: statistic-remove .. _command-statistic-remove: The ``statistic-remove`` Command @@ -197,6 +201,7 @@ 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. +.. isccmd:: statistic-get-all .. _command-statistic-get-all: The ``statistic-get-all`` Command @@ -437,6 +442,7 @@ Here is an example response returning all collected statistics: "result": 0 } +.. isccmd:: statistic-reset-all .. _command-statistic-reset-all: The ``statistic-reset-all`` Command @@ -458,6 +464,7 @@ 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. +.. isccmd:: statistic-remove-all .. _command-statistic-remove-all: The ``statistic-remove-all`` Command @@ -478,6 +485,7 @@ 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. +.. isccmd:: statistic-sample-age-set .. _command-statistic-sample-age-set: The ``statistic-sample-age-set`` Command @@ -506,6 +514,7 @@ 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. +.. isccmd:: statistic-sample-age-set-all .. _command-statistic-sample-age-set-all: The ``statistic-sample-age-set-all`` Command @@ -531,6 +540,7 @@ If the command is successful, the server responds with a status of 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. +.. isccmd:: statistic-sample-count-set .. _command-statistic-sample-count-set: The ``statistic-sample-count-set`` Command @@ -557,6 +567,7 @@ 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. +.. isccmd:: statistic-sample-count-set-all .. _command-statistic-sample-count-set-all: The ``statistic-sample-count-set-all`` Command