summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_ping.py
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 /plugins/modules/vyos_ping.py
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 'plugins/modules/vyos_ping.py')
-rw-r--r--plugins/modules/vyos_ping.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/plugins/modules/vyos_ping.py b/plugins/modules/vyos_ping.py
index 1052a9e2..eb89b4e9 100644
--- a/plugins/modules/vyos_ping.py
+++ b/plugins/modules/vyos_ping.py
@@ -30,9 +30,9 @@ short_description: Tests reachability using ping from VyOS network devices
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 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 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 @@ options:
default: present
notes:
- 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 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
"""