From 35f2016a0d5c40c3e4b6374ebe459571be544b1f Mon Sep 17 00:00:00 2001 From: omnom62 <75066712+omnom62@users.noreply.github.com> Date: Mon, 28 Sep 2026 20:35:56 +1000 Subject: T8989: ospfv3 dict op refactor (#32) * T8989: vyos_ospfv3 dict_op refactor * T8989: vyos_ospfv3 dict_op refactor * T8989: Update ospfv3 area interface syntax clarification Clarify the usage of the ospfv3 area interface syntax and its relation to the state parameter. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * T8989: Update test description for OSPFv3 configuration Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * T8989: ospfv3 AI comment fixed * T8989: ospfv3 AI comment fixed --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Daniil Baturin --- docs/vyos.rest.vyos_ospfv3_module.rst | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/vyos.rest.vyos_ospfv3_module.rst b/docs/vyos.rest.vyos_ospfv3_module.rst index 18bb48e..2b63cf5 100644 --- a/docs/vyos.rest.vyos_ospfv3_module.rst +++ b/docs/vyos.rest.vyos_ospfv3_module.rst @@ -19,6 +19,9 @@ Synopsis -------- - Manages OSPFv3 configuration on VyOS devices via the REST API. - Uses REST API (``connection=httpapi``) instead of CLI. +- Scope matches the current vyos.vyos.vyos_ospfv3 (CLI collection) module, confirmed against VyOS's official documentation (1.4+/1.5 LTS/rolling). +- ``areas.interface`` (an area-to-interface assignment list) exists in the CLI module's argspec but was deliberately NOT carried over here -- confirmed via VyOS's official docs across multiple versions that ``set protocols ospfv3 area interface `` is the superseded, 1.3-era syntax. The current mechanism, ``set protocols ospfv3 interface area ``, is a per-interface setting and is modeled in :ref:`vyos.rest.vyos_ospf_interfaces `'s ``area`` field instead (and is not affected by this module's ``state=replaced``). +- ``distance`` and ``graceful-restart`` are real, confirmed OSPFv3 features not modeled here, matching a genuine gap in the CLI module's own scope rather than an oversight. @@ -133,7 +136,7 @@ Parameters -
Summarize routes matching prefix.
+
Summarize routes matching prefix (border routers only).
@@ -278,6 +281,7 @@ Parameters
string + / required
@@ -332,6 +336,16 @@ Notes - ``ansible_network_os`` must be set to ``vyos.rest.vyos``. +See Also +-------- + +.. seealso:: + + :ref:`vyos.vyos.vyos_ospfv3_module` + The official documentation on the **vyos.vyos.vyos_ospfv3** module. + :ref:`vyos.rest.vyos_ospf_interfaces_module` + The official documentation on the **vyos.rest.vyos_ospf_interfaces** module. + Examples -------- -- cgit v1.2.3