summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGomathiselviS <gomathiselvi@gmail.com>2020-06-22 22:44:43 -0400
committerGitHub <noreply@github.com>2020-06-23 02:44:43 +0000
commit5de080061514116f059874dc76b25b2704272646 (patch)
treeea4890900d22567a60af812ad989d7f2099a096e
parente1fb324f0fbd6063b862f62cc2825f93cb6bfd3f (diff)
downloadvyos.vyos-5de080061514116f059874dc76b25b2704272646.tar.gz
vyos.vyos-5de080061514116f059874dc76b25b2704272646.zip
[vyos] Update docs for vyos.ospfv2 (#50)
[vyos] Update docs for vyos.ospfv2 Reviewed-by: https://github.com/apps/ansible-zuul
-rw-r--r--README.md2
-rw-r--r--docs/vyos.vyos.vyos_banner_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_command_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_config_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_facts_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_firewall_global_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_firewall_interfaces_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_firewall_rules_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_interface_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_interfaces_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_l3_interface_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_l3_interfaces_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_lag_interfaces_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_linkagg_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_lldp_global_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_lldp_interface_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_lldp_interfaces_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_lldp_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_logging_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_ospfv2_module.rst3
-rw-r--r--docs/vyos.vyos.vyos_ospfv3_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_ping_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_static_route_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_static_routes_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_system_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_user_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_vlan_module.rst2
-rw-r--r--plugins/modules/vyos_ospfv2.py2
-rw-r--r--tests/sanity/ignore-2.9.txt1
29 files changed, 3 insertions, 55 deletions
diff --git a/README.md b/README.md
index 2406331..3e33513 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 c57ae0e..6194639 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 783ff74..dd7e299 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 ee5562b..44946bc 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 ce3aad5..a005737 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 1cece08..dda270d 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 d873ad5..9e37a42 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 37ce7f6..647f835 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 734e315..b01595a 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 0bcab76..4e35ea9 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 3a649ad..dbf89a0 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 1d47393..106c90d 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 e5a9870..83a7094 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 d026b9a..a97a1c2 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 af51bba..1fc23bc 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 c2d351d..187ad8f 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 d010bcf..a52251a 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 000b55a..bcb1625 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 811cc58..37d9a34 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 7c72453..796e421 100644
--- a/docs/vyos.vyos.vyos_ospfv2_module.rst
+++ b/docs/vyos.vyos.vyos_ospfv2_module.rst
@@ -1208,6 +1208,7 @@ Parameters
<td>
</td>
<td>
+ <div>OSPFv2 specific parameters.</div>
</td>
</tr>
<tr>
@@ -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 9f1722f..6cbffac 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 6c734e5..098a76d 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 42d11a9..854cc7f 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 18860f1..1808538 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 7feb151..abe7565 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 7af3389..016208d 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 da9f935..3ec9d11 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 f890413..d6ef36d 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 36fe7bc..02b7010 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