damex.incus.incus_cluster_groups role – Ensure Incus cluster groups.

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

Entry point main – Ensure Incus cluster groups.

Synopsis

  • Ensure Incus cluster groups.

Parameters

Parameter

Comments

incus_cluster_groups

list / elements=dictionary

Incus cluster groups to ensure.

description

string

Description of the cluster group.

members

list / elements=string

Cluster member names in the group.

name

string / required

Name of the cluster group.

state

string

Desired state of the cluster group.

Choices:

  • "present"

  • "absent"

incus_cluster_groups_client_cert

string

Client certificate content for API authentication.

incus_cluster_groups_client_cert_path

path

TLS client certificate path for API authentication.

incus_cluster_groups_client_key

string

Client key content for API authentication.

incus_cluster_groups_client_key_path

path

TLS client key path for API authentication.

incus_cluster_groups_server_cert

string

Server certificate content for API verification.

incus_cluster_groups_server_cert_path

path

TLS server certificate path for API verification.

incus_cluster_groups_socket_path

path

Incus Unix socket path.

incus_cluster_groups_state

string

Default desired state of the cluster groups.

Choices:

  • "present"

  • "absent"

incus_cluster_groups_token

string

Authentication token for the Incus API.

incus_cluster_groups_url

string

URL of the Incus server API.

incus_cluster_groups_validate_certs

boolean

TLS certificate validation.

Choices:

  • false

  • true

Examples

- name: Ensure incus cluster groups
  hosts: incus
  tasks:
    - name: Ensure incus cluster groups
      ansible.builtin.import_role:
        name: damex.incus.incus_cluster_groups
      vars:
        incus_cluster_groups:
          - name: dpu
            description: ARM64 DPU nodes
            members:
              - arm64-node1
              - arm64-node2