summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKate Case <this.is@nathanielca.se>2022-08-30 08:35:16 -0400
committerGitHub <noreply@github.com>2022-08-30 08:35:16 -0400
commit4c116b506d4a529370dd63761f601a89d1adbf92 (patch)
tree18fa9a985b53cc5ec8848be918c9af03ee18aa69 /docs
parent7f79df30d5992e85b34b51fc42f857a7199dffb2 (diff)
downloadvyos.vyos-4c116b506d4a529370dd63761f601a89d1adbf92.tar.gz
vyos.vyos-4c116b506d4a529370dd63761f601a89d1adbf92.zip
Use FQCN for modules in documentation (#267)
* Use FQCN for modules in documentation Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/vyos.vyos.vyos_banner_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_command_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_config_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_facts_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_firewall_global_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.rst4
-rw-r--r--docs/vyos.vyos.vyos_ospfv2_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_ospfv3_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_ping_module.rst16
-rw-r--r--docs/vyos.vyos.vyos_static_route_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_static_routes_module.rst2
-rw-r--r--docs/vyos.vyos.vyos_system_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_user_module.rst4
-rw-r--r--docs/vyos.vyos.vyos_vlan_module.rst4
25 files changed, 41 insertions, 41 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
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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 <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
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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 <network_guide>`
diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst
index 7195cd2c..ddd1c535 100644
--- a/docs/vyos.vyos.vyos_config_module.rst
+++ b/docs/vyos.vyos.vyos_config_module.rst
@@ -179,7 +179,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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>`_.
- To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation.
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst
index 7e7d7624..66e84980 100644
--- a/docs/vyos.vyos.vyos_facts_module.rst
+++ b/docs/vyos.vyos.vyos_facts_module.rst
@@ -98,7 +98,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -210,7 +210,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 <network_guide>`
diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst
index 0a9b615c..e090e2e7 100644
--- a/docs/vyos.vyos.vyos_firewall_global_module.rst
+++ b/docs/vyos.vyos.vyos_firewall_global_module.rst
@@ -820,7 +820,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 05c74f56..f35f1e7e 100644
--- a/docs/vyos.vyos.vyos_firewall_rules_module.rst
+++ b/docs/vyos.vyos.vyos_firewall_rules_module.rst
@@ -1343,7 +1343,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 1fc22329..62329777 100644
--- a/docs/vyos.vyos.vyos_interface_module.rst
+++ b/docs/vyos.vyos.vyos_interface_module.rst
@@ -417,7 +417,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
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 f185550c..8f639f52 100644
--- a/docs/vyos.vyos.vyos_l3_interface_module.rst
+++ b/docs/vyos.vyos.vyos_l3_interface_module.rst
@@ -184,7 +184,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
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 836ddcf5..a2948041 100644
--- a/docs/vyos.vyos.vyos_linkagg_module.rst
+++ b/docs/vyos.vyos.vyos_linkagg_module.rst
@@ -208,7 +208,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
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 380b4e8a..b93f13c3 100644
--- a/docs/vyos.vyos.vyos_lldp_interface_module.rst
+++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst
@@ -124,7 +124,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
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 9a5048a5..c0a0d22f 100644
--- a/docs/vyos.vyos.vyos_lldp_module.rst
+++ b/docs/vyos.vyos.vyos_lldp_module.rst
@@ -69,7 +69,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst
index 48183dfb..c846cf92 100644
--- a/docs/vyos.vyos.vyos_logging_module.rst
+++ b/docs/vyos.vyos.vyos_logging_module.rst
@@ -228,7 +228,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -359,7 +359,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 <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 6bad877e..5437f460 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 841ca819..7b2e2d05 100644
--- a/docs/vyos.vyos.vyos_ping_module.rst
+++ b/docs/vyos.vyos.vyos_ping_module.rst
@@ -19,9 +19,9 @@ Synopsis
--------
- 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 net_ping module.
-- For Windows targets, use the win_ping module instead.
-- For targets running Python, use the ping module instead.
+- For a general purpose network module, see the :ref:`ansible.netcommon.net_ping <ansible.netcommon.net_ping_module>` module.
+- For Windows targets, use the :ref:`ansible.windows.win_ping <ansible.windows.win_ping_module>` module instead.
+- For targets running Python, use the :ref:`ansible.builtin.ping <ansible.builtin.ping_module>` module instead.
@@ -97,7 +97,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -273,10 +273,10 @@ Notes
.. note::
- Tested against VyOS 1.1.8 (helium).
- - For a general purpose network module, see the net_ping module.
- - For Windows targets, use the win_ping module instead.
- - For targets running Python, use the ping module instead.
- - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_.
+ - For a general purpose network module, see the :ref:`ansible.netcommon.net_ping <ansible.netcommon.net_ping_module>` module.
+ - For Windows targets, use the :ref:`ansible.windows.win_ping <ansible.windows.win_ping_module>` module instead.
+ - For targets running Python, use the :ref:`ansible.builtin.ping <ansible.builtin.ping_module>` module instead.
+ - 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 <network_guide>`
diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst
index 67ae6be2..98200af9 100644
--- a/docs/vyos.vyos.vyos_static_route_module.rst
+++ b/docs/vyos.vyos.vyos_static_route_module.rst
@@ -215,7 +215,7 @@ Parameters
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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 <network_guide>`
diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst
index 889f7348..d1ed8344 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
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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 <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
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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 <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
</td>
<td>
<div><b>Deprecated</b></div>
- <div>Starting with Ansible 2.5 we recommend using <code>connection: network_cli</code>.</div>
+ <div>Starting with Ansible 2.5 we recommend using <code>connection: ansible.netcommon.network_cli</code>.</div>
<div>For more information please see the <a href='../network/getting_started/network_differences.html#multiple-communication-protocols'>Network Guide</a>.</div>
<div><hr/></div>
<div>A dict object containing connection details.</div>
@@ -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 <network_guide>`