damex.incus.incus_storage_volume_info module – Ensure Incus storage volume information is gathered

Note

This module is part of the damex.incus collection (version 1.8.9).

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 damex.incus.

To use it in a playbook, specify: damex.incus.incus_storage_volume_info.

Synopsis

• Gather information about Incus custom storage volumes via the Incus REST API.

• Returns information about all custom volumes in a pool or a specific volume.

• Storage volumes are project-scoped resources within a storage pool.

Parameters

Parameter	Comments
client_cert path	Path to the client certificate for remote authentication. Requires url and client_key. Mutually exclusive with token.
client_key path	Path to the client key for remote authentication. Requires url and client_cert.
name string	Name of the storage volume to query. If not specified, all custom volumes in the pool are returned.
pool string / required	Name of the storage pool to query volumes from.
project string	Incus project to query. Default: "default"
server_cert path	Path to the server certificate for remote verification. Requires url.
socket_path string	Path to the Incus Unix socket for local connections. Default: "/var/lib/incus/unix.socket"
token string	Token for remote authentication. Requires url. Mutually exclusive with client_cert.
url string	URL of the remote Incus server (e.g. https://host:8443). If specified, connects via HTTPS instead of Unix socket.
validate_certs boolean	Whether to validate the server TLS certificate. Choices: false true ← (default)

Examples

- name: Ensure storage volume information is gathered
  damex.incus.incus_storage_volume_info:
    pool: default
  register: result

- name: Ensure specific storage volume information is gathered
  damex.incus.incus_storage_volume_info:
    pool: default
    name: data
  register: result

- name: Ensure storage volume information is gathered from project
  damex.incus.incus_storage_volume_info:
    pool: default
    project: myproject
  register: result

Return Values

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

Key	Description
storage_volumes list / elements=dictionary	List of storage volume information. Returned: always
config dictionary	Storage volume configuration. Returned: success
content_type string	Content type (filesystem or block). Returned: success
description string	Storage volume description. Returned: success
name string	Name of the storage volume. Returned: success

Authors

• Roman Kuzmitskii (@damex)

Collection links

• Issue Tracker
• Repository (Sources)