summaryrefslogtreecommitdiffstats
path: root/lib/ansible/modules/ping.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:55:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:55:42 +0000
commit62d9962ec7d01c95bf5732169320d3857a41446e (patch)
treef60d8fc63ff738e5f5afec48a84cf41480ee1315 /lib/ansible/modules/ping.py
parentReleasing progress-linux version 2.14.13-1~progress7.99u1. (diff)
downloadansible-core-62d9962ec7d01c95bf5732169320d3857a41446e.tar.xz
ansible-core-62d9962ec7d01c95bf5732169320d3857a41446e.zip
Merging upstream version 2.16.5.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/ansible/modules/ping.py')
-rw-r--r--lib/ansible/modules/ping.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/lib/ansible/modules/ping.py b/lib/ansible/modules/ping.py
index f6267a8..c724798 100644
--- a/lib/ansible/modules/ping.py
+++ b/lib/ansible/modules/ping.py
@@ -12,9 +12,9 @@ DOCUMENTATION = '''
---
module: ping
version_added: historical
-short_description: Try to connect to host, verify a usable python and return C(pong) on success
+short_description: Try to connect to host, verify a usable python and return V(pong) on success
description:
- - A trivial test module, this module always returns C(pong) on successful
+ - A trivial test module, this module always returns V(pong) on successful
contact. It does not make sense in playbooks, but it is useful from
C(/usr/bin/ansible) to verify the ability to login and that a usable Python is configured.
- This is NOT ICMP ping, this is just a trivial test module that requires Python on the remote-node.
@@ -23,8 +23,8 @@ description:
options:
data:
description:
- - Data to return for the C(ping) return value.
- - If this parameter is set to C(crash), the module will cause an exception.
+ - Data to return for the RV(ping) return value.
+ - If this parameter is set to V(crash), the module will cause an exception.
type: str
default: pong
extends_documentation_fragment:
@@ -58,7 +58,7 @@ EXAMPLES = '''
RETURN = '''
ping:
- description: Value provided with the data parameter.
+ description: Value provided with the O(data) parameter.
returned: success
type: str
sample: pong