From 5de080061514116f059874dc76b25b2704272646 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Mon, 22 Jun 2020 22:44:43 -0400 Subject: [vyos] Update docs for vyos.ospfv2 (#50) [vyos] Update docs for vyos.ospfv2 Reviewed-by: https://github.com/apps/ansible-zuul --- README.md | 2 +- docs/vyos.vyos.vyos_banner_module.rst | 2 -- docs/vyos.vyos.vyos_command_module.rst | 2 -- docs/vyos.vyos.vyos_config_module.rst | 2 -- docs/vyos.vyos.vyos_facts_module.rst | 2 -- docs/vyos.vyos.vyos_firewall_global_module.rst | 2 -- docs/vyos.vyos.vyos_firewall_interfaces_module.rst | 2 -- docs/vyos.vyos.vyos_firewall_rules_module.rst | 2 -- docs/vyos.vyos.vyos_interface_module.rst | 2 -- docs/vyos.vyos.vyos_interfaces_module.rst | 2 -- docs/vyos.vyos.vyos_l3_interface_module.rst | 2 -- docs/vyos.vyos.vyos_l3_interfaces_module.rst | 2 -- docs/vyos.vyos.vyos_lag_interfaces_module.rst | 2 -- docs/vyos.vyos.vyos_linkagg_module.rst | 2 -- docs/vyos.vyos.vyos_lldp_global_module.rst | 2 -- docs/vyos.vyos.vyos_lldp_interface_module.rst | 2 -- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 2 -- docs/vyos.vyos.vyos_lldp_module.rst | 2 -- docs/vyos.vyos.vyos_logging_module.rst | 2 -- docs/vyos.vyos.vyos_ospfv2_module.rst | 3 +-- docs/vyos.vyos.vyos_ospfv3_module.rst | 2 -- docs/vyos.vyos.vyos_ping_module.rst | 2 -- docs/vyos.vyos.vyos_static_route_module.rst | 2 -- docs/vyos.vyos.vyos_static_routes_module.rst | 2 -- docs/vyos.vyos.vyos_system_module.rst | 2 -- docs/vyos.vyos.vyos_user_module.rst | 2 -- docs/vyos.vyos.vyos_vlan_module.rst | 2 -- plugins/modules/vyos_ospfv2.py | 2 +- tests/sanity/ignore-2.9.txt | 1 - 29 files changed, 3 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 24063312..3e33513c 100644 --- a/README.md +++ b/README.md @@ -157,4 +157,4 @@ Please read and familiarize yourself with this document. GNU General Public License v3.0 or later. -See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. +See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. \ No newline at end of file diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index c57ae0e0..61946399 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -283,5 +283,3 @@ Authors - Trishna Guha (@trishnaguha) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index 783ff743..dd7e2994 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -377,5 +377,3 @@ Authors - Nathaniel Case (@Qalthos) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index ee5562bb..44946bc5 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -514,5 +514,3 @@ Authors - Nathaniel Case (@Qalthos) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index ce3aad5a..a0057373 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -429,5 +429,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index 1cece082..dda270d5 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -1739,5 +1739,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst index d873ad53..9e37a423 100644 --- a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst @@ -1411,5 +1411,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst index 37ce7f68..647f8353 100644 --- a/docs/vyos.vyos.vyos_firewall_rules_module.rst +++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst @@ -2438,5 +2438,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index 734e3155..b01595a1 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -488,5 +488,3 @@ Authors - Ganesh Nalawade (@ganeshrn) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 0bcab76a..4e35ea9b 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -1329,5 +1329,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index 3a649ad6..dbf89a06 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -329,5 +329,3 @@ Authors - Ricardo Carrillo Cruz (@rcarrillocruz) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_l3_interfaces_module.rst b/docs/vyos.vyos.vyos_l3_interfaces_module.rst index 1d47393e..106c90d3 100644 --- a/docs/vyos.vyos.vyos_l3_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_l3_interfaces_module.rst @@ -768,5 +768,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index e5a9870b..83a7094c 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -947,5 +947,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index d026b9af..a97a1c24 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -343,5 +343,3 @@ Authors - Ricardo Carrillo Cruz (@rcarrillocruz) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index af51bbaf..1fc23bc0 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -612,5 +612,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index c2d351d3..187ad8fd 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -307,5 +307,3 @@ Authors - Ricardo Carrillo Cruz (@rcarrillocruz) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index d010bcf8..a52251a4 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -926,5 +926,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index 000b55af..bcb1625e 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -271,5 +271,3 @@ Authors - Ricardo Carrillo Cruz (@rcarrillocruz) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index 811cc58d..37d9a34e 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -351,5 +351,3 @@ Authors - Trishna Guha (@trishnaguha) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 7c724531..796e421b 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1208,6 +1208,7 @@ Parameters +
OSPFv2 specific parameters.
@@ -3118,5 +3119,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst index 9f1722f8..6cbffacc 100644 --- a/docs/vyos.vyos.vyos_ospfv3_module.rst +++ b/docs/vyos.vyos.vyos_ospfv3_module.rst @@ -916,5 +916,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index 6c734e56..098a76d3 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -425,5 +425,3 @@ Authors - Nilashish Chakraborty (@NilashishC) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 42d11a99..854cc7f5 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -354,5 +354,3 @@ Authors - Trishna Guha (@trishnaguha) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst index 18860f14..18085381 100644 --- a/docs/vyos.vyos.vyos_static_routes_module.rst +++ b/docs/vyos.vyos.vyos_static_routes_module.rst @@ -1162,5 +1162,3 @@ Authors - Rohit Thakur (@rohitthakur2590) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index 7feb1512..abe75657 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -314,5 +314,3 @@ Authors - Nathaniel Case (@Qalthos) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 7af33899..016208d1 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -373,5 +373,3 @@ Authors - Trishna Guha (@trishnaguha) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index da9f9353..3ec9d114 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -401,5 +401,3 @@ Authors - Trishna Guha (@trishnaguha) -.. hint:: - Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. diff --git a/plugins/modules/vyos_ospfv2.py b/plugins/modules/vyos_ospfv2.py index f8904133..d6ef36d2 100644 --- a/plugins/modules/vyos_ospfv2.py +++ b/plugins/modules/vyos_ospfv2.py @@ -261,7 +261,7 @@ options: description: Neighbor priority. type: int parameters: - descriptions: OSPFv2 specific parameters. + description: OSPFv2 specific parameters. type: dict suboptions: abr_type: diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt index 36fe7bc1..02b70106 100644 --- a/tests/sanity/ignore-2.9.txt +++ b/tests/sanity/ignore-2.9.txt @@ -62,7 +62,6 @@ plugins/modules/vyos_logging.py validate-modules:doc-missing-type plugins/modules/vyos_logging.py validate-modules:missing-suboption-docs plugins/modules/vyos_logging.py validate-modules:parameter-type-not-in-doc plugins/modules/vyos_logging.py validate-modules:undocumented-parameter -plugins/modules/vyos_ospfv2.py validate-modules:invalid-documentation plugins/modules/vyos_ospfv3.py validate-modules:invalid-documentation plugins/modules/vyos_ping.py validate-modules:doc-default-does-not-match-spec plugins/modules/vyos_ping.py validate-modules:parameter-type-not-in-doc -- cgit v1.2.3