ansible/docs/man/man3/ansible.wait_for.3
2012-10-03 23:31:50 -04:00

41 lines
No EOL
1.1 KiB
Groff

.TH ANSIBLE.WAIT_FOR 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
." generated from library/wait_for
.SH NAME
wait_for \- Waits for a given port to become accessible on a server.
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This is useful for when services are not immediately available after their init scripts return - which is true of certain Java application servers. It is also useful when starting guests with the \fIvirt\fR module and needing to pause until they are ready.
." ------ OPTIONS
."
."
.SH OPTIONS
.IP delay
number of seconds to wait before starting to poll
.IP host
hostname or IP address to wait for (default: 127.0.0.1)
.IP port
port number to poll(required)
.IP timeout
maximum number of seconds to wait for (default: 300)
.IP state
either \fCstarted\fR, or \fCstopped\fR depending on whether the module should poll for the port being open or closed.
.IR Choices :
started,stopped. (default: started)."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
wait_for port=8000 delay=10
.fi
." ------- AUTHOR
.SH AUTHOR
Jeroen Hoekx
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#wait-for