summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoromnom62 <omnom62@outlook.com>2026-09-16 14:00:51 +1000
committeromnom62 <omnom62@outlook.com>2026-09-16 14:00:51 +1000
commit4c6145d0f5e6fd4f7574d950017534e2b0381737 (patch)
treebfd760348fcd3ce60cba150075eff52416ce2cd5
parent33a9524fa7a6e0da32ad3630a307b30ab3b9c6cb (diff)
downloadrest.vyos-T8989_vyos_ospf_interfaces_dict_op.tar.gz
rest.vyos-T8989_vyos_ospf_interfaces_dict_op.zip
T8989: ospf_interfaces AI comment fixesT8989_vyos_ospf_interfaces_dict_op
-rw-r--r--docs/vyos.rest.vyos_ospf_interfaces_module.rst2
-rw-r--r--plugins/modules/vyos_ospf_interfaces.py21
2 files changed, 13 insertions, 10 deletions
diff --git a/docs/vyos.rest.vyos_ospf_interfaces_module.rst b/docs/vyos.rest.vyos_ospf_interfaces_module.rst
index 4c6f0fa..60424ac 100644
--- a/docs/vyos.rest.vyos_ospf_interfaces_module.rst
+++ b/docs/vyos.rest.vyos_ospf_interfaces_module.rst
@@ -102,7 +102,7 @@ Parameters
<td>
</td>
<td>
- <div>OSPF area to assign this interface to (<code>set protocols ospf interface &lt;name&gt; area &lt;id&gt;</code> for OSPFv2, <code>set protocols ospfv3 interface &lt;name&gt; area &lt;id&gt;</code> for OSPFv3). This is the primary mechanism that enables OSPF on an interface at all -- confirmed via VyOS&#x27;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 &lt;id&gt; interface &lt;name&gt;</code> form.</div>
+ <div>OSPF area to assign this interface to (<code>set protocols ospf interface &lt;name&gt; area &lt;id&gt;</code> for OSPFv2, <code>set protocols ospfv3 interface &lt;name&gt; area &lt;id&gt;</code> for OSPFv3). This is a per-interface alternative to enabling OSPF via <code>area &lt;id&gt; network &lt;prefix&gt;</code> -- VyOS&#x27;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&#x27;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 &lt;id&gt; interface &lt;name&gt;</code> form.</div>
</td>
</tr>
<tr>
diff --git a/plugins/modules/vyos_ospf_interfaces.py b/plugins/modules/vyos_ospf_interfaces.py
index 0fd302a..992aa4d 100644
--- a/plugins/modules/vyos_ospf_interfaces.py
+++ b/plugins/modules/vyos_ospf_interfaces.py
@@ -39,15 +39,18 @@ options:
required: true
area:
description: >-
- OSPF area to assign this interface to (C(set protocols
- ospf interface <name> area <id>) for OSPFv2, C(set
- protocols ospfv3 interface <name> area <id>) for
- OSPFv3). This is the
- primary mechanism that enables OSPF on an interface at
- all -- 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)
- C(area <id> interface <name>) form.
+ OSPF area to assign this interface to (C(set protocols
+ ospf interface <name> area <id>) for OSPFv2, C(set
+ protocols ospfv3 interface <name> area <id>) for
+ OSPFv3). This is a per-interface alternative to
+ enabling OSPF via C(area <id> network <prefix>) --
+ 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) C(area <id>
+ interface <name>) form.
type: str
authentication:
description: Authentication settings (IPv4 only).