damex.incus.incus_cluster_members role – Ensure Incus cluster members.

Note

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

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

Entry point main – Ensure Incus cluster members.

Synopsis

  • Ensure Incus cluster members.

Parameters

Parameter

Comments

incus_cluster_members

list / elements=dictionary

List of Incus cluster members to ensure.

config

dictionary

Cluster member configuration key-value pairs.

scheduler.instance

string

Controls how instances are scheduled to run on this member.

Choices:

  • "all"

  • "manual"

  • "group"

description

string

Description of the cluster member.

failure_domain

string

Failure domain of the cluster member.

groups

list / elements=string

List of cluster groups for the member.

name

string / required

Name of the cluster member.

roles

list / elements=string

List of roles assigned to the cluster member.

state

string

Desired state of the cluster member.

Choices:

  • "present"

  • "absent"

incus_cluster_members_client_cert

string

Client certificate content for API authentication.

incus_cluster_members_client_cert_path

path

Path to the TLS client certificate for API authentication.

incus_cluster_members_client_key

string

Client key content for API authentication.

incus_cluster_members_client_key_path

path

Path to the TLS client key for API authentication.

incus_cluster_members_server_cert

string

Server certificate content for API verification.

incus_cluster_members_server_cert_path

path

Path to the TLS server certificate for API verification.

incus_cluster_members_socket_path

path

Path to the Incus Unix socket.

incus_cluster_members_state

string

Default desired state of the cluster members.

Choices:

  • "present"

  • "absent"

incus_cluster_members_token

string

Authentication token for the Incus API.

incus_cluster_members_url

string

URL of the Incus server API.

incus_cluster_members_validate_certs

boolean

Whether to validate TLS certificates.

Choices:

  • false

  • true

Examples

- name: Ensure incus cluster members
  hosts: incus
  tasks:
    - name: Ensure incus cluster members
      ansible.builtin.import_role:
        name: damex.incus.incus_cluster_members
      vars:
        incus_cluster_members:
          - name: node1
            description: Primary node
            config:
              scheduler.instance: all
          - name: node2
            config:
              scheduler.instance: manual