damex.incus.incus_client role – Ensure Incus client.

Note

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

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

Entry point main – Ensure Incus client.

Synopsis

  • Ensure Incus client.

Parameters

Parameter

Comments

incus_client_apt_preference_name

string

Name of the APT preference file for the Incus client.

incus_client_apt_preference_pin

string

APT pin specification for the Incus client package.

incus_client_apt_preference_pin_priority

integer

APT pin priority for the Incus client package.

incus_client_configuration

dictionary / required

Incus client configuration dictionary.

aliases

dictionary

Command aliases for the Incus client.

default-remote

string / required

Name of the default remote.

defaults

dictionary

Default settings for the Incus client.

console_spice_command

string

Command used for SPICE console connections.

console_type

string

Default console type.

list_format

string

Default output format for list commands.

remotes

list / elements=dictionary / required

List of remote server definitions.

addr

string / required

Address of the remote server.

name

string / required

Name of the remote.

protocol

string / required

Protocol used to communicate with the remote.

public

boolean

Whether the remote is public.

Choices:

  • false

  • true

incus_client_configuration_directory

path

Path to the Incus client configuration directory.

incus_client_configuration_file

path

Path to the Incus client configuration file.

incus_client_group

string

Group of the client configuration files.

incus_client_package_name

string

Name of the Incus client package.

incus_client_package_state

string

Desired state of the Incus client package.

Choices:

  • "present"

  • "absent"

incus_client_user

string

Owner of the client configuration files.

Examples

- name: Ensure incus client
  hosts: incus
  tasks:
    - name: Ensure incus client
      ansible.builtin.import_role:
        name: damex.incus.incus_client

- name: Ensure incus client with remote servers
  hosts: workstations
  tasks:
    - name: Ensure incus client with remote servers
      ansible.builtin.import_role:
        name: damex.incus.incus_client
      vars:
        incus_client_configuration:
          default-remote: local
          remotes:
            - name: local
              addr: unix://
              protocol: incus
              public: false
            - name: production
              addr: https://incus.example.com:8443
              protocol: incus
              public: false