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.

community.general.proxmox_storage_info – Retrieve information about one or more Proxmox VE storages

Note

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

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.proxmox_storage_info.

New in version 2.2.0: of community.general

Synopsis

• Retrieve information about one or more Proxmox VE storages.

Requirements

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

• proxmoxer

• requests

Parameters

Parameter	Comments
api_host string / required	Specify the target host of the Proxmox VE cluster.
api_password string	Specify the password to authenticate with. You can use PROXMOX_PASSWORD environment variable.
api_token_id string added in 1.3.0 of community.general	Specify the token ID.
api_token_secret string added in 1.3.0 of community.general	Specify the token secret.
api_user string / required	Specify the user to authenticate with.
storage aliases: name string	Only return informations on a specific storage.
type string	Filter on a specifc storage type.
validate_certs boolean	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices: no ← (default) yes

Notes

Note

• Storage specific options can be returned by this module, please look at the documentation at https://pve.proxmox.com/wiki/Storage.

Examples

- name: List existing storages
  community.general.proxmox_storage_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_storages

- name: List NFS storages only
  community.general.proxmox_storage_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    type: nfs
  register: proxmox_storages_nfs

- name: Retrieve information about the lvm2 storage
  community.general.proxmox_storage_info:
    api_host: helldorado
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
    storage: lvm2
  register: proxmox_storage_lvm

Return Values

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

Key	Description
proxmox_storages list / elements=dictionary	List of storage pools. Returned: on success
content list / elements=string	Proxmox content types available in this storage Returned: on success
digest string	Storage’s digest Returned: on success
nodes list / elements=string	List of nodes associated to this storage Returned: on success, if storage is not local
path string	Physical path to this storage Returned: on success
prune-backups list / elements=dictionary	Backup retention options Returned: on success
shared boolean	Is this storage shared Returned: on success
storage string	Storage name Returned: on success
type string	Storage type Returned: on success

Authors

• Tristan Le Guern (@tleguern)