Skip to content

Commit

Permalink
[Backport 2.7] wait_for: Add note about path and port (#49118)
Browse files Browse the repository at this point in the history
Document that Path and Port are mutually exclusive parameters in the wait_for module.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 70f992c)
  • Loading branch information
Akasurde authored and acozine committed Nov 26, 2018
1 parent eab6034 commit 24eb3c5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions changelogs/fragments/15732-wait_for-documentation_fix.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- Document Path and Port are mutually exclusive parameters in wait_for module.
4 changes: 3 additions & 1 deletion lib/ansible/modules/utilities/logic/wait_for.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
port:
description:
- Port number to poll.
- C(path) and C(port) are mutually exclusive parameters.
active_connection_states:
description:
- The list of TCP connection states which are counted as active connections.
Expand All @@ -67,6 +68,7 @@
version_added: "1.4"
description:
- Path to a file on the filesystem that must exist before continuing.
- C(path) and C(port) are mutually exclusive parameters.
search_regex:
version_added: "1.4"
description:
Expand All @@ -87,7 +89,7 @@
- This overrides the normal error message from a failure to meet the required conditions.
notes:
- The ability to use search_regex with a port connection was added in 1.7.
- Prior to 2.4, testing for the absense of a directory or UNIX socket did not work correctly.
- Prior to 2.4, testing for the absence of a directory or UNIX socket did not work correctly.
- Prior to 2.4, testing for the presence of a file did not work correctly if the remote user did not have read access to that file.
- Under some circumstances when using mandatory access control, a path may always be treated as being absent even if it exists, but
can't be modified or created by the remote user either.
Expand Down

0 comments on commit 24eb3c5

Please sign in to comment.