From 4e04586f36f4e2bb8fa0e2d6838c13e753bea51c Mon Sep 17 00:00:00 2001 From: Baptiste Mille-Mathias Date: Wed, 8 Jul 2020 21:46:11 +0200 Subject: [PATCH] Use FQCN for modules in documentation --- docs/vyos.vyos.vyos_banner_module.rst | 4 ++-- docs/vyos.vyos.vyos_command_module.rst | 4 ++-- docs/vyos.vyos.vyos_config_module.rst | 4 ++-- docs/vyos.vyos.vyos_facts_module.rst | 4 ++-- docs/vyos.vyos.vyos_firewall_global_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 | 4 ++-- docs/vyos.vyos.vyos_ospfv2_module.rst | 2 +- docs/vyos.vyos.vyos_ospfv3_module.rst | 2 +- docs/vyos.vyos.vyos_ping_module.rst | 4 ++-- docs/vyos.vyos.vyos_static_route_module.rst | 4 ++-- docs/vyos.vyos.vyos_static_routes_module.rst | 2 +- docs/vyos.vyos.vyos_system_module.rst | 4 ++-- docs/vyos.vyos.vyos_user_module.rst | 4 ++-- docs/vyos.vyos.vyos_vlan_module.rst | 4 ++-- plugins/doc_fragments/vyos.py | 2 +- plugins/modules/vyos_banner.py | 2 +- plugins/modules/vyos_command.py | 2 +- plugins/modules/vyos_config.py | 2 +- plugins/modules/vyos_facts.py | 6 +++--- plugins/modules/vyos_firewall_global.py | 2 +- plugins/modules/vyos_firewall_rules.py | 2 +- plugins/modules/vyos_interfaces.py | 2 +- plugins/modules/vyos_l3_interfaces.py | 2 +- plugins/modules/vyos_lag_interfaces.py | 2 +- plugins/modules/vyos_lldp_global.py | 2 +- plugins/modules/vyos_lldp_interfaces.py | 2 +- plugins/modules/vyos_logging.py | 2 +- plugins/modules/vyos_ospfv2.py | 2 +- plugins/modules/vyos_ospfv3.py | 2 +- plugins/modules/vyos_ping.py | 14 +++++++------- plugins/modules/vyos_static_route.py | 2 +- plugins/modules/vyos_static_routes.py | 2 +- plugins/modules/vyos_system.py | 2 +- plugins/modules/vyos_user.py | 2 +- plugins/modules/vyos_vlan.py | 2 +- 46 files changed, 64 insertions(+), 64 deletions(-) diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index d046cc4d..f42364a2 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -66,7 +66,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -212,7 +212,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index 36ae7643..bb79752d 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -100,7 +100,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -247,7 +247,7 @@ Notes - Tested against VyOS 1.1.8 (helium). - Running ``show system boot-messages all`` will cause the module to hang since VyOS is using a custom pager setting to display the output of that command. - If a command sent to the device requires answering a prompt, it is possible to pass a dict containing *command*, *answer* and *prompt*. See examples. - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index d6f2f6bb..0e22b772 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -179,7 +179,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -325,7 +325,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index 3177888b..9dcfb1ea 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -79,7 +79,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -191,7 +191,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst index b37cf020..e1e65cb2 100644 --- a/docs/vyos.vyos.vyos_firewall_global_module.rst +++ b/docs/vyos.vyos.vyos_firewall_global_module.rst @@ -776,7 +776,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst index cebe64cc..24561c63 100644 --- a/docs/vyos.vyos.vyos_firewall_rules_module.rst +++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst @@ -1320,7 +1320,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index 46af72db..b7097754 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -417,7 +417,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 52ae1ccc..d1cdf0b6 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -312,7 +312,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst index 8c76dcb8..b423b01c 100644 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ b/docs/vyos.vyos.vyos_l3_interface_module.rst @@ -184,7 +184,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
diff --git a/docs/vyos.vyos.vyos_l3_interfaces_module.rst b/docs/vyos.vyos.vyos_l3_interfaces_module.rst index 94b3d585..9e441162 100644 --- a/docs/vyos.vyos.vyos_l3_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_l3_interfaces_module.rst @@ -296,7 +296,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index 52da8678..4ccbcf93 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -266,7 +266,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst index f7586d65..3ce06b9f 100644 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ b/docs/vyos.vyos.vyos_linkagg_module.rst @@ -208,7 +208,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index 851ed202..8ecc9005 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -173,7 +173,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 01036649..df139a59 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -124,7 +124,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index 030cd734..fffa1c2d 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -363,7 +363,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst index 88d0211c..e3162136 100644 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ b/docs/vyos.vyos.vyos_lldp_module.rst @@ -69,7 +69,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index 9cb024d0..dd31172b 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -221,7 +221,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -352,7 +352,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst index 9433538e..5e71f116 100644 --- a/docs/vyos.vyos.vyos_ospfv2_module.rst +++ b/docs/vyos.vyos.vyos_ospfv2_module.rst @@ -1642,7 +1642,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst index 568dbabe..1cc5645f 100644 --- a/docs/vyos.vyos.vyos_ospfv3_module.rst +++ b/docs/vyos.vyos.vyos_ospfv3_module.rst @@ -341,7 +341,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index f9c4a681..cf3fd5d3 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -97,7 +97,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -276,7 +276,7 @@ Notes - For a general purpose network module, see the :ref:`net_ping ` module. - For Windows targets, use the :ref:`win_ping ` module instead. - For targets running Python, use the :ref:`ping ` module instead. - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst index 69afb568..10df0c04 100644 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ b/docs/vyos.vyos.vyos_static_route_module.rst @@ -215,7 +215,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -346,7 +346,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst index 5a6884b1..220eb7b9 100644 --- a/docs/vyos.vyos.vyos_static_routes_module.rst +++ b/docs/vyos.vyos.vyos_static_routes_module.rst @@ -336,7 +336,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index bc521f07..b3b51e80 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -109,7 +109,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -240,7 +240,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index f47ab015..3af72486 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -231,7 +231,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -400,7 +400,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index b6e3ccf5..970928f4 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -261,7 +261,7 @@ Parameters
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.network_cli.
For more information please see the Network Guide.
A dict object containing connection details.
@@ -426,7 +426,7 @@ Notes .. note:: - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - This module works with connection ``ansible.netcommon.network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` diff --git a/plugins/doc_fragments/vyos.py b/plugins/doc_fragments/vyos.py index ca406737..745ba5a3 100644 --- a/plugins/doc_fragments/vyos.py +++ b/plugins/doc_fragments/vyos.py @@ -14,7 +14,7 @@ class ModuleDocFragment(object): provider: description: - B(Deprecated) - - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' + - 'Starting with Ansible 2.5 we recommend using C(connection: ansible.netcommon.network_cli).' - For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols). - HORIZONTALLINE - A dict object containing connection details. diff --git a/plugins/modules/vyos_banner.py b/plugins/modules/vyos_banner.py index 9fcaf87b..07b5a281 100644 --- a/plugins/modules/vyos_banner.py +++ b/plugins/modules/vyos_banner.py @@ -33,7 +33,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: banner: description: diff --git a/plugins/modules/vyos_command.py b/plugins/modules/vyos_command.py index cb1fd476..c0df9ce9 100644 --- a/plugins/modules/vyos_command.py +++ b/plugins/modules/vyos_command.py @@ -89,7 +89,7 @@ is using a custom pager setting to display the output of that command. - If a command sent to the device requires answering a prompt, it is possible to pass a dict containing I(command), I(answer) and I(prompt). See examples. -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). """ EXAMPLES = """ diff --git a/plugins/modules/vyos_config.py b/plugins/modules/vyos_config.py index 5e4836d8..6bde3102 100644 --- a/plugins/modules/vyos_config.py +++ b/plugins/modules/vyos_config.py @@ -34,7 +34,7 @@ - vyos.vyos.vyos notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: lines: description: diff --git a/plugins/modules/vyos_facts.py b/plugins/modules/vyos_facts.py index 01c43c2e..4180b1cf 100644 --- a/plugins/modules/vyos_facts.py +++ b/plugins/modules/vyos_facts.py @@ -28,14 +28,14 @@ - vyos.vyos.vyos notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: gather_subset: description: - When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. Can specify a list of values to include a larger subset. Values can also be used with an - initial C(M(!)) to specify that a specific subset should not be collected. + initial C(!) to specify that a specific subset should not be collected. required: false default: '!config' type: list @@ -45,7 +45,7 @@ - When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces. Can specify a list of values to include a larger subset. Values can also be - used with an initial C(M(!)) to specify that a specific subset should not be + used with an initial C(!) to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'static_routes', 'firewall_rules', 'firewall_global', 'firewall_interfaces', 'ospfv3', 'ospfv2'. diff --git a/plugins/modules/vyos_firewall_global.py b/plugins/modules/vyos_firewall_global.py index 6ff30719..9e3ff9d5 100644 --- a/plugins/modules/vyos_firewall_global.py +++ b/plugins/modules/vyos_firewall_global.py @@ -39,7 +39,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_firewall_rules.py b/plugins/modules/vyos_firewall_rules.py index 3bd6451d..f7a28b9e 100644 --- a/plugins/modules/vyos_firewall_rules.py +++ b/plugins/modules/vyos_firewall_rules.py @@ -38,7 +38,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_interfaces.py b/plugins/modules/vyos_interfaces.py index 87738c69..4429e4b9 100644 --- a/plugins/modules/vyos_interfaces.py +++ b/plugins/modules/vyos_interfaces.py @@ -41,7 +41,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Nilashish Chakraborty (@nilashishc) - Rohit Thakur (@rohitthakur2590) diff --git a/plugins/modules/vyos_l3_interfaces.py b/plugins/modules/vyos_l3_interfaces.py index 39dd23c1..7ec9e2aa 100644 --- a/plugins/modules/vyos_l3_interfaces.py +++ b/plugins/modules/vyos_l3_interfaces.py @@ -38,7 +38,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Nilashish Chakraborty (@NilashishC) - Rohit Thakur (@rohitthakur2590) diff --git a/plugins/modules/vyos_lag_interfaces.py b/plugins/modules/vyos_lag_interfaces.py index 08480859..a5307891 100644 --- a/plugins/modules/vyos_lag_interfaces.py +++ b/plugins/modules/vyos_lag_interfaces.py @@ -39,7 +39,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: Rohit Thakur (@rohitthakur2590) options: config: diff --git a/plugins/modules/vyos_lldp_global.py b/plugins/modules/vyos_lldp_global.py index e3adfcf7..192aa7f1 100644 --- a/plugins/modules/vyos_lldp_global.py +++ b/plugins/modules/vyos_lldp_global.py @@ -39,7 +39,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_lldp_interfaces.py b/plugins/modules/vyos_lldp_interfaces.py index 99ca61c2..43ff75cc 100644 --- a/plugins/modules/vyos_lldp_interfaces.py +++ b/plugins/modules/vyos_lldp_interfaces.py @@ -38,7 +38,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_logging.py b/plugins/modules/vyos_logging.py index c7780d8e..ebab561e 100644 --- a/plugins/modules/vyos_logging.py +++ b/plugins/modules/vyos_logging.py @@ -32,7 +32,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: dest: description: diff --git a/plugins/modules/vyos_ospfv2.py b/plugins/modules/vyos_ospfv2.py index 280630fb..43b06756 100644 --- a/plugins/modules/vyos_ospfv2.py +++ b/plugins/modules/vyos_ospfv2.py @@ -39,7 +39,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_ospfv3.py b/plugins/modules/vyos_ospfv3.py index ca5bc93c..38d71db2 100644 --- a/plugins/modules/vyos_ospfv3.py +++ b/plugins/modules/vyos_ospfv3.py @@ -39,7 +39,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_ping.py b/plugins/modules/vyos_ping.py index 64509fbc..faab5b38 100644 --- a/plugins/modules/vyos_ping.py +++ b/plugins/modules/vyos_ping.py @@ -30,9 +30,9 @@ description: - Tests reachability using ping from a VyOS device to a remote destination. - Tested against VyOS 1.1.8 (helium) -- For a general purpose network module, see the M(net_ping) module. -- For Windows targets, use the M(win_ping) module instead. -- For targets running Python, use the M(ping) module instead. +- For a general purpose network module, see the M(ansible.netcommon.net_ping) module. +- For Windows targets, use the M(ansible.windows.win_ping) module instead. +- For targets running Python, use the M(ansible.builtin.ping) module instead. version_added: 1.0.0 author: - Nilashish Chakraborty (@NilashishC) @@ -73,10 +73,10 @@ default: present notes: - Tested against VyOS 1.1.8 (helium). -- For a general purpose network module, see the M(net_ping) module. -- For Windows targets, use the M(win_ping) module instead. -- For targets running Python, use the M(ping) module instead. -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- For a general purpose network module, see the M(ansible.netcommon.net_ping) module. +- For Windows targets, use the M(ansible.windows.win_ping) module instead. +- For targets running Python, use the M(ansible.builtin.ping) module instead. +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). extends_documentation_fragment: - vyos.vyos.vyos """ diff --git a/plugins/modules/vyos_static_route.py b/plugins/modules/vyos_static_route.py index 3a969974..0f0986d8 100644 --- a/plugins/modules/vyos_static_route.py +++ b/plugins/modules/vyos_static_route.py @@ -38,7 +38,7 @@ removed_at_date: '2022-06-01' notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: prefix: description: diff --git a/plugins/modules/vyos_static_routes.py b/plugins/modules/vyos_static_routes.py index fa29b722..26717a10 100644 --- a/plugins/modules/vyos_static_routes.py +++ b/plugins/modules/vyos_static_routes.py @@ -38,7 +38,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). author: - Rohit Thakur (@rohitthakur2590) options: diff --git a/plugins/modules/vyos_system.py b/plugins/modules/vyos_system.py index 93c0909b..4a9fdcdd 100644 --- a/plugins/modules/vyos_system.py +++ b/plugins/modules/vyos_system.py @@ -33,7 +33,7 @@ - vyos.vyos.vyos notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: host_name: description: diff --git a/plugins/modules/vyos_user.py b/plugins/modules/vyos_user.py index 4f67529d..6d07f9d8 100644 --- a/plugins/modules/vyos_user.py +++ b/plugins/modules/vyos_user.py @@ -35,7 +35,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: aggregate: description: diff --git a/plugins/modules/vyos_vlan.py b/plugins/modules/vyos_vlan.py index c04ac93c..6accef72 100644 --- a/plugins/modules/vyos_vlan.py +++ b/plugins/modules/vyos_vlan.py @@ -18,7 +18,7 @@ version_added: 1.0.0 notes: - Tested against VyOS 1.1.8 (helium). -- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). +- This module works with connection C(ansible.netcommon.network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html). options: name: description: