damex.incus.incus_images role – Ensure Incus images.

Note

This role is part of the damex.incus collection (version 1.11.7).

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

Entry point `main` – Ensure Incus images.

Synopsis 

Ensure Incus images.

Parameters 

Parameter	Comments
incus_images list / elements=dictionary	Images to ensure.
alias string / required	Local image alias.
auto_update boolean	Automatic image update on new build. Choices: `false` `true`
copy_aliases boolean	Source alias copying. Choices: `false` `true`
project string	Incus project scope.
public boolean	Unauthenticated user image access. Choices: `false` `true`
source string / required	Remote source identifier.
source_protocol string	Remote image server protocol. Choices: `"simplestreams"` `"incus"` `"oci"`
source_server string	Remote image server URL.
state string	Image desired state. Choices: `"present"` `"absent"`
type string	Image instance type. Choices: `"container"` `"virtual-machine"`
incus_images_auto_update boolean	Automatic image update on new build. Choices: `false` `true`
incus_images_client_cert string	Client certificate content for API authentication.
incus_images_client_cert_path path	TLS client certificate path for API authentication.
incus_images_client_key string	Client key content for API authentication.
incus_images_client_key_path path	TLS client key path for API authentication.
incus_images_copy_aliases boolean	Source alias copying. Choices: `false` `true`
incus_images_project string	Incus project scope.
incus_images_public boolean	Unauthenticated user image access. Choices: `false` `true`
incus_images_server_cert string	Server certificate content for API verification.
incus_images_server_cert_path path	TLS server certificate path for API verification.
incus_images_socket_path path	Incus Unix socket path.
incus_images_source_protocol string	Remote image server protocol. Choices: `"simplestreams"` `"incus"`
incus_images_source_server string	Remote image server URL.
incus_images_state string	Images desired state. Choices: `"present"` `"absent"`
incus_images_token string	Incus API authentication token.
incus_images_type string	Image instance type. Choices: `"container"` `"virtual-machine"`
incus_images_url string	Incus server API URL.
incus_images_validate_certs boolean	TLS certificate validation. Choices: `false` `true`

Examples 

- name: Ensure incus images
  hosts: incus
  tasks:
    - name: Ensure incus images
      ansible.builtin.import_role:
        name: damex.incus.incus_images
      vars:
        incus_images:
          - source: images:debian/13
            alias: debian13
          - source: images:ubuntu/24.04
            alias: ubuntu2404
            type: virtual-machine
            auto_update: true
          - source: docker:library/nginx
            alias: nginx

Collection links