mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Added DOCUMENTATION to ping module.
This commit is contained in:
parent
a75348b406
commit
2aaaf986d3
1 changed files with 14 additions and 0 deletions
14
library/ping
14
library/ping
|
@ -18,6 +18,20 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: ping
|
||||||
|
short_description: Try to connect to host and return pong on success.
|
||||||
|
description:
|
||||||
|
- A trivial test module, this module always returns 'pong' on successful contact. It does not make sense in playbooks, but is useful from /usr/bin/ansible
|
||||||
|
version_added: "0.7"
|
||||||
|
examples:
|
||||||
|
- code: ansible webservers -m ping
|
||||||
|
description: Test 'webservers' status
|
||||||
|
author:
|
||||||
|
'''
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
argument_spec = dict()
|
argument_spec = dict()
|
||||||
|
|
Loading…
Add table
Reference in a new issue