damex.incus.incus_instance_info module – Ensure Incus instance information is gathered

Note

This module 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_instance_info.

Synopsis

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

  • Returns information about all instances or a specific instance.

Parameters

Parameter

Comments

client_cert

string

Client certificate content for remote authentication.

Requires url and client_key. Mutually exclusive with token and client_cert_path.

client_cert_path

string

Client certificate path for remote authentication.

Requires url and client_key_path. Mutually exclusive with token and client_cert.

client_key

string

Client key content for remote authentication.

Requires url and client_cert. Mutually exclusive with client_key_path.

client_key_path

string

Client key path for remote authentication.

Requires url and client_cert_path. Mutually exclusive with client_key.

name

string

Name of the instance to query.

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

project

string

Incus project to query.

Default: "default"

server_cert

string

Server certificate content for remote verification.

Requires url. Mutually exclusive with server_cert_path.

server_cert_path

string

Server certificate path for remote verification.

Requires url. Mutually exclusive with server_cert.

socket_path

string

Incus Unix socket path for local connections.

Default: "/var/lib/incus/unix.socket"

token

string

Token for remote authentication.

Requires url. Mutually exclusive with client_cert.

url

string

Remote Incus server URL (e.g. https://host:8443).

If specified, connects via HTTPS instead of Unix socket.

validate_certs

boolean

Server TLS certificate validation.

Choices:

  • false

  • true ← (default)

Examples

- name: Ensure instance information is gathered
  damex.incus.incus_instance_info:
    project: default
  register: result

- name: Ensure specific instance information is gathered
  damex.incus.incus_instance_info:
    name: myinstance
    project: default
  register: result

- name: Ensure instance information is gathered from remote server
  damex.incus.incus_instance_info:
    url: https://incus.example.com:8443
    client_cert_path: /etc/incus/client.crt
    client_key_path: /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

instances

list / elements=dictionary

List of instance information.

Returned: always

config

dictionary

Instance configuration.

Returned: success

devices

dictionary

Instance devices.

Returned: success

name

string

Name of the instance.

Returned: success

profiles

list / elements=string

Profiles applied to the instance.

Returned: success

project

string

Project the instance belongs to.

Returned: success

status

string

Status of the instance.

Returned: success

type

string

Type of the instance (container or virtual-machine).

Returned: success

Authors

  • Roman Kuzmitskii (@damex)