community.general.jail connection – Run tasks in jails

Note

This connection plugin is part of the community.general collection (version 9.2.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.jail.

Synopsis

  • Run commands or put/fetch files to an existing jail

Parameters

Parameter

Comments

remote_addr

string

Path to the jail

Default: "inventory_hostname"

Configuration:

  • Variable: inventory_hostname

  • Variable: ansible_host

  • Variable: ansible_jail_host

remote_user

string

User to execute as inside the jail

Configuration:

  • Variable: ansible_user

  • Variable: ansible_jail_user

Authors

  • Ansible Core Team

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.