diff options
| author | omnom62 <75066712+omnom62@users.noreply.github.com> | 2026-09-28 21:31:03 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-09-28 12:31:03 +0100 |
| commit | 683e120725c4b03b671ac66ce47b2fceccf6f8ba (patch) | |
| tree | 45e527539ba9e5c306ae6744387f7b360ce50508 /docs | |
| parent | 9a0deaabf0d046db4e99c20d09b04e8c2f5fef1c (diff) | |
| download | rest.vyos-683e120725c4b03b671ac66ce47b2fceccf6f8ba.tar.gz rest.vyos-683e120725c4b03b671ac66ce47b2fceccf6f8ba.zip | |
T8989: vyos_ospf_inferfaces dict_op rework (#31)
* T8989: vyos_ospf_inferfaces dict_op rework
* T8989: vyos_ospf_inferfaces Copilot comments
* T8989: vyos_ospf_inferfaces Copilot comments
* T8989: vyos_ospf_inferfaces Copilot comments
* T8989: vyos_ospf_inferfaces Copilot comments
* T8989: ospf_interfaces AI comment fixes
* T8989: ospf_interfaces AI comment fixes
---------
Co-authored-by: Daniil Baturin <daniil@vyos.io>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vyos.rest.vyos_ospf_interfaces_module.rst | 57 |
1 files changed, 30 insertions, 27 deletions
diff --git a/docs/vyos.rest.vyos_ospf_interfaces_module.rst b/docs/vyos.rest.vyos_ospf_interfaces_module.rst index 1439a71..60424ac 100644 --- a/docs/vyos.rest.vyos_ospf_interfaces_module.rst +++ b/docs/vyos.rest.vyos_ospf_interfaces_module.rst @@ -17,10 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Manages OSPF and OSPFv3 interface configuration on VyOS devices via the REST API. -- IPv4 OSPF maps to ``protocols ospf interface``. -- IPv6 OSPFv3 maps to ``protocols ospfv3 interface``. -- Uses REST API (``connection=httpapi``) instead of CLI. +- Manages OSPFv2 (IPv4) and OSPFv3 (IPv6) per-interface configuration on VyOS devices via the REST API. @@ -96,6 +93,23 @@ Parameters <td class="elbow-placeholder"></td> <td colspan="3"> <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>area</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div>OSPF area to assign this interface to (<code>set protocols ospf interface <name> area <id></code> for OSPFv2, <code>set protocols ospfv3 interface <name> area <id></code> for OSPFv3). This is a per-interface alternative to enabling OSPF via <code>area <id> network <prefix></code> -- VyOS's own documentation frames the network-based form as standard and this per-interface form as more convenient in some cases (many interfaces/subnets). Confirmed via VyOS's official documentation across 1.4+/1.5 LTS/rolling as the current syntax, distinct from and superseding the older (1.3-era) <code>area <id> interface <name></code> form.</div> + </td> + </tr> + <tr> + <td class="elbow-placeholder"></td> + <td class="elbow-placeholder"></td> + <td colspan="3"> + <div class="ansibleOptionAnchor" id="parameter-"></div> <b>authentication</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> @@ -198,7 +212,7 @@ Parameters <td> </td> <td> - <div>Interface bandwidth in kbps (IPv4 only).</div> + <div>Interface bandwidth in Mbit/s (IPv4 only).</div> </td> </tr> <tr> @@ -304,7 +318,7 @@ Parameters </ul> </td> <td> - <div>Disable MTU check (IPv4 only).</div> + <div>Disable MTU mismatch detection.</div> </td> </tr> <tr> @@ -327,7 +341,7 @@ Parameters </ul> </td> <td> - <div>Network type (IPv4 only).</div> + <div>Network type.</div> </td> </tr> <tr> @@ -348,7 +362,7 @@ Parameters </ul> </td> <td> - <div>Disable adjacency formation (IPv6 only).</div> + <div>Suppress adjacency formation on this interface.</div> </td> </tr> <tr> @@ -460,6 +474,14 @@ Notes - ``ansible_network_os`` must be set to ``vyos.rest.vyos``. +See Also +-------- + +.. seealso:: + + :ref:`vyos.vyos.vyos_ospf_interfaces_module` + The official documentation on the **vyos.vyos.vyos_ospf_interfaces** module. + Examples -------- @@ -473,27 +495,8 @@ Examples address_family: - afi: ipv4 cost: 100 - transmit_delay: 50 - priority: 26 - - afi: ipv6 - dead_interval: 39 - passive: true state: merged - - name: Delete OSPF interface configuration - vyos.rest.vyos_ospf_interfaces: - config: - - name: eth1 - state: deleted - - - name: Delete all OSPF interface configuration - vyos.rest.vyos_ospf_interfaces: - state: deleted - - - name: Gather current OSPF interface configuration - vyos.rest.vyos_ospf_interfaces: - state: gathered - Return Values |