diff options
| author | Kate Case <this.is@nathanielca.se> | 2022-08-30 08:35:16 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-30 08:35:16 -0400 |
| commit | 4c116b506d4a529370dd63761f601a89d1adbf92 (patch) | |
| tree | 18fa9a985b53cc5ec8848be918c9af03ee18aa69 /docs/vyos.vyos.vyos_ping_module.rst | |
| parent | 7f79df30d5992e85b34b51fc42f857a7199dffb2 (diff) | |
| download | vyos.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/vyos.vyos.vyos_ping_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_ping_module.rst | 16 |
1 files changed, 8 insertions, 8 deletions
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>` |