diff options
| author | omnom62 <75066712+omnom62@users.noreply.github.com> | 2026-09-28 20:35:56 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-09-28 11:35:56 +0100 |
| commit | 35f2016a0d5c40c3e4b6374ebe459571be544b1f (patch) | |
| tree | e0dbefaf076da14bae65c62aa25b394e19a7801a /docs | |
| parent | 099b7477d5014499aa9aca41f8854be89356cb4e (diff) | |
| download | rest.vyos-35f2016a0d5c40c3e4b6374ebe459571be544b1f.tar.gz rest.vyos-35f2016a0d5c40c3e4b6374ebe459571be544b1f.zip | |
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 <daniil@vyos.io>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vyos.rest.vyos_ospfv3_module.rst | 16 |
1 files changed, 15 insertions, 1 deletions
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 <id> interface <name>`` is the superseded, 1.3-era syntax. The current mechanism, ``set protocols ospfv3 interface <name> area <id>``, is a per-interface setting and is modeled in :ref:`vyos.rest.vyos_ospf_interfaces <vyos.rest.vyos_ospf_interfaces_module>`'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 <td> </td> <td> - <div>Summarize routes matching prefix.</div> + <div>Summarize routes matching prefix (border routers only).</div> </td> </tr> <tr> @@ -278,6 +281,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> + / <span style="color: red">required</span> </div> </td> <td> @@ -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 -------- |