Class: Ansible::Ruby::Modules::Wait_for_connection

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

Overview

Waits for a total of C(timeout) seconds. Retries the transport connection after a timeout of C(connect_timeout). 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.

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 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.



16
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/wait_for_connection.rb', line 16

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.



20
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/wait_for_connection.rb', line 20

attribute :delay

#sleep ⇒ Integer?

Returns Number of seconds to sleep between checks.

Returns:

  • (Integer, nil) —

    Number of seconds to sleep between checks.



24
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/wait_for_connection.rb', line 24

attribute :sleep

#timeout ⇒ Integer?

Returns Maximum number of seconds to wait for.

Returns:

  • (Integer, nil) —

    Maximum number of seconds to wait for.



28
 
# File 'lib/ansible/ruby/modules/generated/utilities/logic/wait_for_connection.rb', line 28

attribute :timeout