From 9ebafb2968e4ea4b254ac577f2245b5b2aa75e77 Mon Sep 17 00:00:00 2001 From: omnom62 <75066712+omnom62@users.noreply.github.com> Date: Tue, 24 Jun 2025 19:30:30 +1000 Subject: Pre release 6 doc updates (#421) * pre release doc updates * changelog * module doc updates --- docs/vyos.vyos.vyos_ospfv2_module.rst | 45 ++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 22 deletions(-) (limited to 'docs/vyos.vyos.vyos_ospfv2_module.rst') diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 38e7e5ee..be060285 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1641,7 +1641,8 @@ Notes ----- .. note:: - - Tested against VyOS 1.3.8 + - Tested against VyOS 1.3.8, 1.4.2, the upcoming 1.5, and the rolling release of spring 2025 + - The provided examples of commands are valid for VyOS 1.4+ - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. @@ -1740,8 +1741,8 @@ Examples # "set protocols ospf parameters opaque-lsa", # "set protocols ospf parameters abr-type 'cisco'", # "set protocols ospf parameters rfc1583-compatibility", - # "set protocols ospf passive-interface eth1", - # "set protocols ospf passive-interface eth2", + # "set protocols ospf interface 'eth1' passive", + # "set protocols ospf interface 'eth2' passive", # "set protocols ospf max-metric router-lsa on-shutdown 10", # "set protocols ospf max-metric router-lsa administrative", # "set protocols ospf max-metric router-lsa on-startup 10", @@ -1885,8 +1886,8 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' - # set protocols ospf passive-interface 'eth2' + # set protocols ospf interface 'eth1' passive + # set protocols ospf interface 'eth2' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' @@ -2148,8 +2149,8 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' - # set protocols ospf passive-interface 'eth2' + # set protocols ospf interface 'eth1' passive + # set protocols ospf interface 'eth2' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' @@ -2185,8 +2186,8 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' - # set protocols ospf passive-interface 'eth2' + # set protocols ospf interface 'eth1' passive + # set protocols ospf interface 'eth2' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' # @@ -2343,7 +2344,7 @@ Examples # } # # "commands": [ - # "delete protocols ospf passive-interface eth2", + # "delete protocols ospf interface 'eth2' passive", # "delete protocols ospf area 3", # "delete protocols ospf area 4 range 192.0.3.0/24 cost", # "delete protocols ospf area 4 range 192.0.3.0/24", @@ -2475,7 +2476,7 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' + # set protocols ospf interface 'eth1' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' @@ -2563,8 +2564,8 @@ Examples # "set protocols ospf parameters opaque-lsa", # "set protocols ospf parameters abr-type 'cisco'", # "set protocols ospf parameters rfc1583-compatibility", - # "set protocols ospf passive-interface eth1", - # "set protocols ospf passive-interface eth2", + # "set protocols ospf interface 'eth1' passive", + # "set protocols ospf interface 'eth2' passive", # "set protocols ospf max-metric router-lsa on-shutdown 10", # "set protocols ospf max-metric router-lsa administrative", # "set protocols ospf max-metric router-lsa on-startup 10", @@ -2619,8 +2620,8 @@ Examples set protocols ospf parameters 'opaque-lsa' set protocols ospf parameters 'rfc1583-compatibility' set protocols ospf parameters router-id '192.0.1.1' - set protocols ospf passive-interface 'eth1' - set protocols ospf passive-interface 'eth2' + set protocols ospf interface 'eth1' passive + set protocols ospf interface 'eth2' passive set protocols ospf redistribute bgp metric '10' set protocols ospf redistribute bgp metric-type '2' state: parsed @@ -2756,8 +2757,8 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' - # set protocols ospf passive-interface 'eth2' + # set protocols ospf interface 'eth1' passive + # set protocols ospf interface 'eth2' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' # @@ -2892,8 +2893,8 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' - # set protocols ospf passive-interface 'eth2' + # set protocols ospf interface 'eth1' passive + # set protocols ospf interface 'eth2' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' @@ -2929,8 +2930,8 @@ Examples # set protocols ospf parameters 'opaque-lsa' # set protocols ospf parameters 'rfc1583-compatibility' # set protocols ospf parameters router-id '192.0.1.1' - # set protocols ospf passive-interface 'eth1' - # set protocols ospf passive-interface 'eth2' + # set protocols ospf interface 'eth1' passive + # set protocols ospf interface 'eth2' passive # set protocols ospf redistribute bgp metric '10' # set protocols ospf redistribute bgp metric-type '2' # @@ -3108,7 +3109,7 @@ Common return values are documented `here The set of commands pushed to the remote device.
Sample:
-
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospf passive-interface 'eth1'"]
+
['set protocols ospf parameters router-id 192.0.1.1', "set protocols ospf interface 'eth1' passive"]
-- cgit v1.2.3