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 |
---|---|
Specify the target host of the Proxmox VE cluster. |
|
Specify the password to authenticate with. You can use |
|
Specify the target port of the Proxmox VE cluster. Uses the |
|
Specify the token ID. Requires |
|
Specify the token secret. Requires |
|
Specify the user to authenticate with. |
|
Filter on a specific content type. Choices:
|
|
Proxmox node to which the storage is attached. |
|
Only return content stored on that specific storage. |
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
|
Filter on a specific VMID. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Action group: community.general.proxmox added in community.general 9.0.0 |
Use |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
Content of of storage attached to a node. Returned: success |
|
Proxmox content of listed objects on this storage. Returned: success |
|
Creation time of the listed objects. Returned: success |
|
Format of the listed objects (can be Returned: success |
|
Size of the listed objects. Returned: success |
|
Subtype of the listed objects (can be Returned: When storage is dedicated to backup, typically on PBS storage. |
|
Backup verification status of the listed objects. Returned: When storage is dedicated to backup, typically on PBS storage. Sample: |
|
Volume identifier of the listed objects. Returned: success |