You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

containers.podman.podman_volume_info – Gather info about podman volumes

Note

This plugin is part of the containers.podman collection (version 1.9.0).

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 containers.podman.

To use it in a playbook, specify: containers.podman.podman_volume_info.

Synopsis

• Gather info about podman volumes with podman inspect command.

Requirements

The below requirements are needed on the host that executes this module.

• Podman installed on host

Parameters

Parameter	Comments
executable string	Path to podman executable if it is not in the $PATH on the machine running podman Default: “podman”
name string	Name of the volume

Examples

- name: Gather info about all present volumes
  podman_volume_info:

- name: Gather info about specific volume
  podman_volume_info:
    name: specific_volume

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
volumes list / elements=string	Facts from all or specified volumes Returned: always Sample: [{“driver”: “local”, “labels”: {}, “mountPoint”: “/home/ansible/.local/share/testvolume/_data”, “name”: “testvolume”, “options”: {}, “scope”: “local”}]

Authors

• Sagi Shnaidman (@sshnaidm)