ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
Code Activity

lxc_container: rearrange docs notes (#11325)

Browse source 
* lxc_container: rearrange docs notes

* Update plugins/modules/lxc_container.py

* reformat docs
This commit is contained in:
Alexei Znamensky 2025-12-25 20:22:03 +13:00 • committed by GitHub
parent ec6b7bf91c
commit 04d0a4daf3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
plugins/modules/lxc_container.py
View file

@ -86,6 +86,12 @@ options:
container_command: container_command:
description: description:
- Run a command within a container. - Run a command within a container.
- The O(container_command) can be used with any state except V(absent). If used with state V(stopped) the container
is V(started), the command executed, and then the container V(stopped) again. Likewise if O(state=stopped) and the
container does not exist it is first created, V(started), the command executed, and then V(stopped). If you use a
C(|) in the variable you can use common script formatting within the variable itself. The O(container_command) option
always execute as C(bash). When using O(container_command), a log file is created in the C(/tmp/) directory which
contains both RV(ignore:stdout) and RV(ignore:stderr) of any command executed.
type: str type: str
lxc_path: lxc_path:
description: description:
@ -125,8 +131,8 @@ options:
default: false default: false
archive: archive:
description: description:
- Create an archive of a container. - When set to V(true) the system attempts to create a compressed tarball of the running container. The O(archive) option
- This creates a tarball of the running container. supports LVM backed containers and creates a snapshot of the running container when creating the archive.
type: bool type: bool
default: false default: false
archive_path: archive_path:
@ -170,14 +176,6 @@ requirements:
notes: notes:
- Containers must have a unique name. If you attempt to create a container with a name that already exists in the users - Containers must have a unique name. If you attempt to create a container with a name that already exists in the users
namespace the module simply returns as "unchanged". namespace the module simply returns as "unchanged".
- The O(container_command) can be used with any state except V(absent). If used with state V(stopped) the container is V(started),
the command executed, and then the container V(stopped) again. Likewise if O(state=stopped) and the container does not
exist it is first created, V(started), the command executed, and then V(stopped). If you use a C(|) in the variable you
can use common script formatting within the variable itself. The O(container_command) option always execute as C(bash).
When using O(container_command), a log file is created in the C(/tmp/) directory which contains both RV(ignore:stdout) and RV(ignore:stderr)
of any command executed.
- If O(archive=true) the system attempts to create a compressed tarball of the running container. The O(archive) option
supports LVM backed containers and creates a snapshot of the running container when creating the archive.
- If your distro does not have a package for C(python3-lxc), which is a requirement for this module, it can be installed - If your distro does not have a package for C(python3-lxc), which is a requirement for this module, it can be installed
from source at U(https://github.com/lxc/python3-lxc) or installed using C(pip install lxc). from source at U(https://github.com/lxc/python3-lxc) or installed using C(pip install lxc).
""" """