community.general.chroot connection – Interact with local chroot
Note
This connection plugin is part of the community.general collection (version 9.5.1).
You might already have this collection installed if you are using the ansible
package.
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.chroot
.
Synopsis
Run commands or put/fetch files to an existing chroot on the Ansible controller.
Parameters
Parameter |
Comments |
---|---|
User specified chroot binary Default: Configuration:
|
|
Do not check that the user is not root. Choices:
Configuration:
|
|
User specified executable shell Default: Configuration:
|
|
The path of the chroot you want to access. Default: Configuration:
|
Examples
# Plugin requires root privileges for chroot, -E preserves your env (and location of ~/.ansible):
# sudo -E ansible-playbook ...
#
# Static inventory file
# [chroots]
# /path/to/debootstrap
# /path/to/feboostrap
# /path/to/lxc-image
# /path/to/chroot
# playbook
---
- hosts: chroots
connection: community.general.chroot
tasks:
- debug:
msg: "This is coming from chroot environment"