damex.incus.incus_image_info module – Ensure Incus image information is gathered

Note

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

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_image_info.

Synopsis

  • Gather information about Incus images via the Incus REST API.

  • Returns information about all images or a specific image by alias.

  • Images are project-scoped resources.

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

Alias of the image to query.

If not specified, all images in the project are returned.

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: Get all images
  damex.incus.incus_image_info:
    project: default
  register: result

- name: Get specific image by alias
  damex.incus.incus_image_info:
    name: debian/13
    project: default
  register: result

- name: Get images from remote server
  damex.incus.incus_image_info:
    url: https://incus.example.com:8443
    client_cert: /etc/incus/client.crt
    client_key: /etc/incus/client.key
  register: result

Return Values

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

Key

Description

images

list / elements=dictionary

List of image information.

Returned: always

aliases

list / elements=dictionary

List of aliases for the image.

Returned: success

architecture

string

Image architecture.

Returned: success

auto_update

boolean

Whether auto-update is enabled.

Returned: success

fingerprint

string

SHA-256 fingerprint of the image.

Returned: success

properties

dictionary

Image metadata properties.

Returned: success

public

boolean

Whether the image is publicly available.

Returned: success

size

integer

Image size in bytes.

Returned: success

type

string

Image type (container or virtual-machine).

Returned: success

Authors

  • Roman Kuzmitskii (@damex)