Class: Ansible::Ruby::Modules::Wait_for

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#connect_timeout ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



18
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 18

attribute :connect_timeout

#delay ⇒ Integer?

Returns number of seconds to wait before starting to poll.

Returns:

  • (Integer, nil) —

    number of seconds to wait before starting to poll



22
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 22

attribute :delay

#exclude_hosts ⇒ Array<String>, ...

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

Returns:

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

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



42
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 42

attribute :exclude_hosts

#host ⇒ String?

Returns A resolvable hostname or IP address to wait for.

Returns:

  • (String, nil) —

    A resolvable hostname or IP address to wait for



10
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 10

attribute :host

#path ⇒ String?

Returns path to a file on the filesytem that must exist before continuing.

Returns:

  • (String, nil) —

    path to a file on the filesytem that must exist before continuing



34
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 34

attribute :path

#port ⇒ String?

Returns port number to poll.

Returns:

  • (String, nil) —

    port number to poll



26
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 26

attribute :port

#search_regex ⇒ String?

Returns Can be used to match a string in either a file or a socket connection. Defaults to a multiline regex.

Returns:

  • (String, nil) —

    Can be used to match a string in either a file or a socket connection. Defaults to a multiline regex.



38
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 38

attribute :search_regex

#state ⇒ :present, ...

Returns either C(present), C(started), or C(stopped), C(absent), or C(drained),When checking a port C(started) will ensure the port is open, C(stopped) will check that it is closed, 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 before continuing, C(absent) will check that file is absent or removed.

Returns:

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

    either C(present), C(started), or C(stopped), C(absent), or C(drained),When checking a port C(started) will ensure the port is open, C(stopped) will check that it is closed, 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 before continuing, C(absent) will check that file is absent or removed



30
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 30

attribute :state

#timeout ⇒ Integer?

Returns maximum number of seconds to wait for.

Returns:

  • (Integer, nil) —

    maximum number of seconds to wait for



14
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/logic/wait_for.rb', line 14

attribute :timeout