damex.incus.incus_client role – Ensure Incus client.

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

Entry point main – Ensure Incus client.

Synopsis

  • Ensure Incus client.

Parameters

Parameter

Comments

incus_client_apt_preference_name

string

Incus client APT preference file name.

incus_client_apt_preference_pin

string

Incus client APT pin specification.

incus_client_apt_preference_pin_priority

integer

Incus client APT pin priority.

incus_client_configuration

dictionary / required

Incus client configuration.

aliases

dictionary

Incus client command aliases.

default-remote

string / required

Default remote name.

defaults

dictionary

Incus client default settings.

console_spice_command

string

SPICE console connection command.

console_type

string

Console type.

list_format

string

List commands output format.

remotes

list / elements=dictionary / required

Remote server definitions.

addr

string / required

Remote server address.

name

string / required

Remote name.

protocol

string / required

Remote communication protocol.

public

boolean

Public remote.

Choices:

  • false

  • true

incus_client_configuration_directory

path

Incus client configuration directory path.

incus_client_configuration_file

path

Incus client configuration file path.

incus_client_group

string

Client configuration files group.

incus_client_package_name

string

Incus client package name.

incus_client_package_state

string

Incus client package state.

Choices:

  • "present"

  • "absent"

incus_client_user

string

Client configuration files owner.

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