containers.podman.podman_volume – Manage Podman volumes
containers.podman.podman_volume – Manage Podman volumes
Note
This plugin is part of the containers.podman collection (version 1.4.1).
To install it use: ansible-galaxy collection install containers.podman
.
To use it in a playbook, specify: containers.podman.podman_volume
.
New in version 1.1.0: of containers.podman
Synopsis
- Manage Podman volumes
Requirements
The below requirements are needed on the host that executes this module.
- podman
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
debug boolean |
|
Return additional information which can be helpful for investigations. |
driver string |
Specify volume driver name (default local). | |
executable string |
Default: "podman" |
Path to |
label dictionary |
Add metadata to a pod volume (e.g., label com.example.key=value). | |
name string / required |
Name of volume. | |
options list / elements=string |
Set driver specific options. For example 'device=tpmfs', 'type=tmpfs'. | |
recreate boolean |
|
Recreate volume even if exists. |
state string |
|
State of volume, default 'present' |
Examples
# What modules does for example
- podman_volume:
state: present
name: volume1
label:
key: value
key2: value2
options:
- "device=/dev/loop1"
- "type=ext4"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
volume dictionary |
always |
Volume inspection results if exists.
Sample: {'CreatedAt': '2020-06-05T16:38:55.277628769+03:00', 'Driver': 'local', 'Labels': {'key.com': 'value', 'key.org': 'value2'}, 'Mountpoint': '/home/user/.local/share/containers/storage/volumes/test/_data', 'Name': 'test', 'Options': {}, 'Scope': 'local'} |
Authors
- Sagi Shnaidman (@sshnaidm)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/containers/podman/podman_volume_module.html