accelerate - Enable accelerated mode on remote node

New in version 1.3.

DEPRECATED

Removed in Ansible:
version: 2.4
Why: Replaced by ControlPersist
Alternative: Use SSH with ControlPersist instead.

Synopsis

  • This module has been removed, this file is kept for historical documentation purposes.
  • This modules launches an ephemeral 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

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.4
  • python-keyczar

Parameters

Parameter Choices/Defaults Comments
ipv6 Default:
no
The listener daemon on the remote host will bind to the ipv6 localhost socket if this parameter is set to true.
minutes Default:
30
The accelerate listener daemon is started on nodes and will stay around for this number of minutes before turning itself off.
multi_key
(added in 1.6)
 Default:
no
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.
port Default:
5099
TCP port for the socket connection
timeout Default:
300
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.

Notes

Note

  • See the advanced playbooks chapter for more about using accelerated mode.

Examples

# To use accelerate mode, simply add "accelerate: true" to your play. The initial
# key exchange and starting up of the daemon will occur over SSH, but all commands and
# subsequent actions will be conducted over the raw socket connection using AES encryption

- hosts: devservers
  accelerate: true
  tasks:
      - command: /usr/bin/anything

Status

This module is flagged as deprecated and will be removed in version 2.4. For more information see DEPRECATED.

Author

  • James Cammarata (@jimi-c)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/accelerate_module.html