Documentation

accelerate - Enable accelerated mode on remote node

New in version 1.3.

DEPRECATED

Use SSH with ControlPersist instead.

Synopsis

  • 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 (on host that executes module)

  • python >= 2.4
  • python-keyczar

Options

parameter required default choices comments
ipv6
no
The listener daemon on the remote host will bind to the ipv6 localhost socket if this parameter is set to true.
minutes
no 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)
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
no 5099
TCP port for the socket connection
timeout
no 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.

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

Notes

Note

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.