From: Razvan Becheriu Date: Tue, 31 Mar 2026 17:47:06 +0000 (+0300) Subject: [#3144] updated doc X-Git-Tag: Kea-3.1.9~62 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9357ebcaa6eebdd7bafc128b239a160d36c137c8;p=thirdparty%2Fkea.git [#3144] updated doc --- diff --git a/doc/sphinx/api-files.txt b/doc/sphinx/api-files.txt index 1a55ac4002..50d0ff2fef 100644 --- a/doc/sphinx/api-files.txt +++ b/doc/sphinx/api-files.txt @@ -43,6 +43,9 @@ src/share/api/ha-reset.json src/share/api/ha-scopes.json src/share/api/ha-sync.json src/share/api/ha-sync-complete-notify.json +src/share/api/interface-list.json +src/share/api/interface-redetect.json +src/share/api/interface-use.json src/share/api/kea-lfc-start.json src/share/api/lease4-add.json src/share/api/lease4-del.json diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst index 740554b1a6..a5c3eb80fb 100644 --- a/doc/sphinx/arm/ctrl-channel.rst +++ b/doc/sphinx/arm/ctrl-channel.rst @@ -484,6 +484,30 @@ 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:: interface-list +.. _command-interface-list: + +The ``interface-list`` Command +------------------------------ + +The :isccmd:`interface-list` command retrieves. + +.. isccmd:: interface-redetect +.. _command-interface-redetect: + +The ``interface-redetect`` Command +---------------------------------- + +The :isccmd:`interface-redetect` command retrieves. + +.. isccmd:: interface-use +.. _command-interface-use: + +The ``interface-use`` Command +----------------------------- + +The :isccmd:`interface-use` command updates. + .. isccmd:: list-commands .. _command-list-commands: diff --git a/src/share/api/interface-list.json b/src/share/api/interface-list.json new file mode 100644 index 0000000000..b7d49277f4 --- /dev/null +++ b/src/share/api/interface-list.json @@ -0,0 +1,56 @@ +{ + "access": "read", + "avail": "3.1.8", + "brief": [ + "This command returns the list of detected interfaces.", + "This command does not take any parameters." + ], + "cmd-syntax": [ + "{", + " \"command\": \"interface-list\"", + "}" + ], + "description": "See ", + "name": "interface-list", + "resp-syntax": [ + "{", + " \"result\": 0,", + " \"text\": \"2 interfaces detected.\",", + " \"arguments\": {", + " \"interfaces\": [ {", + " \"name\": \"eth0\",", + " \"index\": 4,", + " \"mac\": \"00:11:22:33:44:55\",", + " \"type\": 6,", + " \"addresses\" [ \"192.168.1.1\", \"10.10.1.1\",", + " \"2003:db8:1::1\", \"3001:db8:1::1\",", + " \"fe80::3a60:77ff:fed5:abcd\" ],", + " \"flag-loopback\": false,", + " \"flag-up\": true,", + " \"flag-running\": true,", + " \"flag-multicast\": false,", + " \"flag-broadcast\": false,", + " \"in-use\": true", + " }, {", + " \"name\": \"eth1\",", + " \"index\": 7,", + " \"mac\": \"11:22:33:44:55:66\",", + " \"type\": 6,", + " \"addresses\" [ \"10.10.1.2\",", + " \"2003:db8:1::2\",", + " \"fe80::3a60:77ff:fed5:1234\" ],", + " \"flag-loopback\": false,", + " \"flag-up\": true,", + " \"flag-running\": true,", + " \"flag-multicast\": false,", + " \"flag-broadcast\": false,", + " \"in-use\": false", + " }]", + " }", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} diff --git a/src/share/api/interface-redetect.json b/src/share/api/interface-redetect.json new file mode 100644 index 0000000000..38b68b9d30 --- /dev/null +++ b/src/share/api/interface-redetect.json @@ -0,0 +1,71 @@ +{ + "access": "write", + "avail": "3.1.8", + "brief": [ + "This command returns the list of detected interfaces after performing", + "a re-detect procedure.", + "This command does not take any parameters." + ], + "cmd-syntax": [ + "{", + " \"command\": \"interface-redetect\"", + "}" + ], + "description": "See ", + "name": "interface-redetect", + "resp-syntax": [ + "{", + " \"result\": 0,", + " \"text\": \"3 interfaces detected.\",", + " \"arguments\": {", + " \"interfaces\": [ {", + " \"name\": \"eth0\",", + " \"index\": 4,", + " \"mac\": \"00:11:22:33:44:55\",", + " \"type\": 6,", + " \"addresses\" [ \"192.168.1.1\", \"10.10.1.1\", \"130.50.1.1\",", + " \"2003:db8:1::1\", \"3001:db8:1::1\",", + " \"fe80::3a60:77ff:fed5:abcd\" ],", + " \"flag-loopback\": false,", + " \"flag-up\": true,", + " \"flag-running\": true,", + " \"flag-multicast\": false,", + " \"flag-broadcast\": false,", + " \"in-use\": true", + " }, {", + " \"name\": \"eth1\",", + " \"index\": 7,", + " \"mac\": \"11:22:33:44:55:66\",", + " \"type\": 6,", + " \"addresses\" [ \"10.10.1.2\",", + " \"2003:db8:1::2\",", + " \"fe80::3a60:77ff:fed5:1234\" ],", + " \"flag-loopback\": false,", + " \"flag-up\": true,", + " \"flag-running\": true,", + " \"flag-multicast\": false,", + " \"flag-broadcast\": false,", + " \"in-use\": false", + " }, {", + " \"name\": \"eth2\",", + " \"index\": 8,", + " \"mac\": \"22:33:44:55:66:77\",", + " \"type\": 6,", + " \"addresses\" [ \"192.168.1.2\",", + " \"3001:db8:1::2\",", + " \"fe80::3a60:77ff:fed5:5678\" ],", + " \"flag-loopback\": false,", + " \"flag-up\": true,", + " \"flag-running\": false,", + " \"flag-multicast\": false,", + " \"flag-broadcast\": false,", + " \"in-use\": false", + " }]", + " }", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} diff --git a/src/share/api/interface-use.json b/src/share/api/interface-use.json new file mode 100644 index 0000000000..0630c34f6e --- /dev/null +++ b/src/share/api/interface-use.json @@ -0,0 +1,32 @@ +{ + "access": "write", + "avail": "3.1.8", + "brief": [ + "This command returns the list of detected interfaces after performing", + "a re-detect procedure.", + "This command take as parameters the list of interfaces with respective", + "addresses (if specified) on which the server should start listening for", + "DHCP traffic." + ], + "cmd-syntax": [ + "{", + " \"command\": \"interface-use\",", + " \"arguments\": {", + " \"interfaces\": [ \"eth0/10.10.1.1\", \"eth0/192.168.1.1\", \"eth1\"]", + " }", + "}" + ], + "description": "See ", + "name": "interface-use", + "resp-syntax": [ + "{", + " \"result\": 0,", + " \"text\": \"Operation succeeded.\"", + " }", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} diff --git a/src/share/api/remote-option-def4-del.json b/src/share/api/remote-option-def4-del.json index 128558b31f..ed05bc13a2 100644 --- a/src/share/api/remote-option-def4-del.json +++ b/src/share/api/remote-option-def4-del.json @@ -13,7 +13,7 @@ " \"arguments\": {", " \"option-defs\": [ {", " \"code\":