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

Note

This module is part of the community.general collection (version 6.6.2).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.proxmox_storage_info.

New in community.general 2.2.0

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 community.general 1.3.0

Specify the token ID.

api_token_secret

string

added in community.general 1.3.0

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 false, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

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)