community.general.proxmox_storage_contents_info module – List content from a Proxmox VE storage

Note

This module is part of the community.general collection (version 9.5.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. 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_contents_info.

New in community.general 8.2.0

Synopsis

  • Retrieves information about stored objects on a specific storage attached to a node.

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_port

integer

added in community.general 9.1.0

Specify the target port of the Proxmox VE cluster.

Uses the PROXMOX_PORT environment variable if not specified.

api_token_id

string

added in community.general 1.3.0

Specify the token ID.

Requires proxmoxer>=1.1.0 to work.

api_token_secret

string

added in community.general 1.3.0

Specify the token secret.

Requires proxmoxer>=1.1.0 to work.

api_user

string / required

Specify the user to authenticate with.

content

string

Filter on a specific content type.

Choices:

  • "all" ← (default)

  • "backup"

  • "rootdir"

  • "images"

  • "iso"

node

string / required

Proxmox node to which the storage is attached.

storage

aliases: name

string / required

Only return content stored on that specific storage.

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

vmid

integer

Filter on a specific VMID.

Attributes

Attribute

Support

Description

action_group

Action group: community.general.proxmox

added in community.general 9.0.0

Use group/community.general.proxmox in module_defaults to set defaults for this module.

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.

Examples

- name: List existing storages
  community.general.proxmox_storage_contents_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
    content: backup
    vmid: 130

Return Values

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

Key

Description

proxmox_storage_content

list / elements=dictionary

Content of of storage attached to a node.

Returned: success

content

string

Proxmox content of listed objects on this storage.

Returned: success

ctime

string

Creation time of the listed objects.

Returned: success

format

string

Format of the listed objects (can be raw, pbs-vm, iso,…).

Returned: success

size

integer

Size of the listed objects.

Returned: success

subtype

string

Subtype of the listed objects (can be qemu or lxc).

Returned: When storage is dedicated to backup, typically on PBS storage.

verification

dictionary

Backup verification status of the listed objects.

Returned: When storage is dedicated to backup, typically on PBS storage.

Sample: {"state": "ok", "upid": "UPID:backup-srv:00130F49:1A12D8375:00001CD7:657A2258:verificationjob:daily:v-d0cc18c5-8707:root@pam:"}

volid

string

Volume identifier of the listed objects.

Returned: success

Authors

  • Julian Vanden Broeck (@l00ptr)