Class: Ansible::Ruby::Modules::Accelerate

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

Overview

This modules launches an ephemeral I(accelerate) daemon on the remote node which Ansible can use to communicate with nodes at high speed. The daemon listens on a configurable port for a configurable amount of time. Fireball mode is AES encrypted

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, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#ipv6 ⇒ Boolean?

Returns The listener daemon on the remote host will bind to the ipv6 localhost socket if this parameter is set to true.

Returns:

  • (Boolean, nil) —

    The listener daemon on the remote host will bind to the ipv6 localhost socket if this parameter is set to true.



25
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/helper/accelerate.rb', line 25

attribute :ipv6

#minutes ⇒ Integer?

Returns The I(accelerate) listener daemon is started on nodes and will stay around for this number of minutes before turning itself off.

Returns:

  • (Integer, nil) —

    The I(accelerate) listener daemon is started on nodes and will stay around for this number of minutes before turning itself off.



21
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/helper/accelerate.rb', line 21

attribute :minutes

#multi_key ⇒ Boolean?

Returns When enabled, the daemon will open a local socket file which can be used by future daemon executions to upload a new key to the already running daemon, so that multiple users can connect using different keys. This access still requires an ssh connection as the uid for which the daemon is currently running.

Returns:

  • (Boolean, nil) —

    When enabled, the daemon will open a local socket file which can be used by future daemon executions to upload a new key to the already running daemon, so that multiple users can connect using different keys. This access still requires an ssh connection as the uid for which the daemon is currently running.



29
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/helper/accelerate.rb', line 29

attribute :multi_key

#port ⇒ Integer?

Returns TCP port for the socket connection.

Returns:

  • (Integer, nil) —

    TCP port for the socket connection



13
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/helper/accelerate.rb', line 13

attribute :port

#timeout ⇒ Integer?

Returns The number of seconds the socket will wait for data. If none is received when the timeout value is reached, the connection will be closed.

Returns:

  • (Integer, nil) —

    The number of seconds the socket will wait for data. If none is received when the timeout value is reached, the connection will be closed.



17
 
# File 'lib/ansible/ruby/modules/generated/core/utilities/helper/accelerate.rb', line 17

attribute :timeout