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 2.5.1).
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
Requirements¶
The below requirements are needed on the host that executes this module.
proxmoxer
requests
Parameters¶
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:
Authors¶
Tristan Le Guern (@Aversiste)