mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-10 18:34:03 -07:00
utilities: Clean up parameter types and add seealso (#53063)
* utilities: Clean up parameter types and add seealso * Add inventory modules * Add more references, clarify with-loops
This commit is contained in:
parent
77a03af394
commit
f47191674e
21 changed files with 468 additions and 321 deletions
|
@ -7,12 +7,10 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['stableinterface'],
|
||||
'supported_by': 'core'}
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: wait_for_connection
|
||||
|
@ -23,23 +21,27 @@ description:
|
|||
- Tests the transport connection every C(sleep) seconds.
|
||||
- This module makes use of internal ansible transport (and configuration) and the ping/win_ping module to guarantee correct end-to-end functioning.
|
||||
- This module is also supported for Windows targets.
|
||||
version_added: "2.3"
|
||||
version_added: '2.3'
|
||||
options:
|
||||
connect_timeout:
|
||||
description:
|
||||
- Maximum number of seconds to wait for a connection to happen before closing and retrying.
|
||||
- Maximum number of seconds to wait for a connection to happen before closing and retrying.
|
||||
type: int
|
||||
default: 5
|
||||
delay:
|
||||
description:
|
||||
- Number of seconds to wait before starting to poll.
|
||||
- Number of seconds to wait before starting to poll.
|
||||
type: int
|
||||
default: 0
|
||||
sleep:
|
||||
default: 1
|
||||
description:
|
||||
- Number of seconds to sleep between checks.
|
||||
- Number of seconds to sleep between checks.
|
||||
type: int
|
||||
default: 1
|
||||
timeout:
|
||||
description:
|
||||
- Maximum number of seconds to wait for.
|
||||
- Maximum number of seconds to wait for.
|
||||
type: int
|
||||
default: 600
|
||||
notes:
|
||||
- This module is also supported for Windows targets.
|
||||
|
@ -103,6 +105,6 @@ RETURN = r'''
|
|||
elapsed:
|
||||
description: The number of seconds that elapsed waiting for the connection to appear.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 23
|
||||
type: float
|
||||
sample: 23.1
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue