Class: Ansible::Ruby::Modules::Win_wait_for

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_wait_for.rb

Overview

You can wait for a set amount of time C(timeout), this is the default if nothing is specified. Waiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers. You can wait for a file to exist or not exist on the filesystem. This module can also be used to wait for a regex match string to be present in a file. You can wait for active connections to be closed before continuing on a local port.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#connect_timeout ⇒ Integer?

Returns The maximum number of seconds to wait for a connection to happen before closing and retrying.

Returns:

  • (Integer, nil) —

    The maximum number of seconds to wait for a connection to happen before closing and retrying.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 16

attribute :connect_timeout

#delay ⇒ Integer?

Returns The number of seconds to wait before starting to poll.

Returns:

  • (Integer, nil) —

    The number of seconds to wait before starting to poll.



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 20

attribute :delay

#exclude_hosts ⇒ Array<String>, ...

Returns The list of hosts or IPs to ignore when looking for active TCP connections when C(state=drained).

Returns:

  • (Array<String>, String, nil) —

    The list of hosts or IPs to ignore when looking for active TCP connections when C(state=drained).



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 24

attribute :exclude_hosts

#host ⇒ String?

Returns A resolvable hostname or IP address to wait for.,If C(state=drained) then it will only check for connections on the IP specified, you can use ‘0.0.0.0’ to use all host IPs.

Returns:

  • (String, nil) —

    A resolvable hostname or IP address to wait for.,If C(state=drained) then it will only check for connections on the IP specified, you can use ‘0.0.0.0’ to use all host IPs.



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 28

attribute :host

#path ⇒ String?

Returns The path to a file on the filesystem to check.,If C(state) is present or started then it will wait until the file exists.,If C(state) is absent then it will wait until the file does not exist.

Returns:

  • (String, nil) —

    The path to a file on the filesystem to check.,If C(state) is present or started then it will wait until the file exists.,If C(state) is absent then it will wait until the file does not exist.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 32

attribute :path

#port ⇒ Integer?

Returns The port number to poll on C(host).

Returns:

  • (Integer, nil) —

    The port number to poll on C(host).



36
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 36

attribute :port

#search_regex ⇒ String?

Returns Can be used to match a string in a file.,If C(state) is present or started then it will wait until the regex matches.,If C(state) is absent then it will wait until the regex does not match.,Defaults to a multiline regex.

Returns:

  • (String, nil) —

    Can be used to match a string in a file.,If C(state) is present or started then it will wait until the regex matches.,If C(state) is absent then it will wait until the regex does not match.,Defaults to a multiline regex.



40
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 40

attribute :search_regex

#sleep ⇒ Integer?

Returns Number of seconds to sleep between checks.

Returns:

  • (Integer, nil) —

    Number of seconds to sleep between checks.



44
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 44

attribute :sleep

#state ⇒ :absent, ...

Returns When checking a port, C(started) will ensure the port is open, C(stopped) will check that is it closed and C(drained) will check for active connections.,When checking for a file or a search string C(present) or C(started) will ensure that the file or string is present, C(absent) will check that the file or search string is absent or removed.

Returns:

  • (:absent, :drained, :present, :started, :stopped, nil) —

    When checking a port, C(started) will ensure the port is open, C(stopped) will check that is it closed and C(drained) will check for active connections.,When checking for a file or a search string C(present) or C(started) will ensure that the file or string is present, C(absent) will check that the file or search string is absent or removed.



48
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 48

attribute :state

#timeout ⇒ Integer?

Returns The maximum number of seconds to wait for.

Returns:

  • (Integer, nil) —

    The maximum number of seconds to wait for.



52
 
# File 'lib/ansible/ruby/modules/generated/windows/win_wait_for.rb', line 52

attribute :timeout