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

New in version 2.2.0: of community.general

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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	Choices/Defaults	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 string		Only return informations on a specific storage. aliases: name
type string		Filter on a specifc storage type.
validate_certs boolean	Choices: no ← yes	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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

Authors

Tristan Le Guern (@tleguern)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/proxmox_storage_info_module.html