damex.incus.incus_cluster_group_info module – Ensure Incus cluster group 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_cluster_group_info.

Synopsis

  • Gather information about Incus cluster groups via the Incus REST API.

  • Returns information about all cluster groups or a specific group.

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 cluster group to query.

If not specified, all cluster groups are returned.

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 cluster group information is gathered
  damex.incus.incus_cluster_group_info:
    socket_path: /var/lib/incus/unix.socket
  register: result

- name: Ensure specific cluster group information is gathered
  damex.incus.incus_cluster_group_info:
    name: dpu
  register: result

Return Values

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

Key

Description

cluster_groups

list / elements=dictionary

List of cluster group information.

Returned: always

description

string

The description of the cluster group.

Returned: success

members

list / elements=string

List of members in this group.

Returned: success

name

string

Name of the cluster group.

Returned: success

Authors

  • Roman Kuzmitskii (@damex)