community.general.lxd (6.6.8) — inventory

Install collection

Install with ansible-galaxy collection install community.general:==6.6.8

Add to requirements.yml

  collections:
    - name: community.general
      version: 6.6.8

Description

Get inventory from the lxd.

Uses a YAML configuration file that ends with 'lxd.(yml|yaml)'.

Requirements

• ipaddress
• lxd >= 4.0

Inputs

    
url:
    default: unix:/var/snap/lxd/common/lxd/unix.socket
    description:
    - The unix domain socket path or the https URL for the lxd server.
    - Sockets in filesystem have to start with C(unix:).
    - Mostly C(unix:/var/lib/lxd/unix.socket) or C(unix:/var/snap/lxd/common/lxd/unix.socket).
    type: str

state:
    choices:
    - STOPPED
    - STARTING
    - RUNNING
    - none
    default: none
    description: Filter the instance according to the current status.
    type: str

plugin:
    choices:
    - community.general.lxd
    description: Token that ensures this is a source file for the 'lxd' plugin.
    required: true

groupby:
    description:
    - Create groups by the following keywords C(location), C(network_range), C(os), C(pattern),
      C(profile), C(release), C(type), C(vlanid).
    - See example for syntax.
    type: dict

project:
    default: default
    description: Filter the instance according to the given project.
    type: str
    version_added: 6.2.0
    version_added_collection: community.general

client_key:
    aliases:
    - key_file
    default: $HOME/.config/lxc/client.key
    description:
    - The client certificate key file path.
    type: path

client_cert:
    aliases:
    - cert_file
    default: $HOME/.config/lxc/client.crt
    description:
    - The client certificate file path.
    type: path

type_filter:
    choices:
    - virtual-machine
    - container
    - both
    default: container
    description:
    - Filter the instances by type C(virtual-machine), C(container) or C(both).
    - The first version of the inventory only supported containers.
    type: str
    version_added: 4.2.0
    version_added_collection: community.general

trust_password:
    description:
    - The client trusted password.
    - You need to set this password on the lxd server before running this module using
      the following command C(lxc config set core.trust_password <some random password>)
      See U(https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/).
    - If I(trust_password) is set, this module send a request for authentication before
      sending any requests.
    type: str

prefered_instance_network_family:
    choices:
    - inet
    - inet6
    default: inet
    description:
    - If an instance has multiple network interfaces, which one is the prefered by family.
    - Specify C(inet) for IPv4 and C(inet6) for IPv6.
    type: str

prefered_instance_network_interface:
    aliases:
    - prefered_container_network_interface
    default: eth
    description:
    - If an instance has multiple network interfaces, select which one is the prefered
      as pattern.
    - Combined with the first number that can be found e.g. 'eth' + 0.
    - The option has been renamed from I(prefered_container_network_interface) to I(prefered_instance_network_interface)
      in community.general 3.8.0. The old name still works as an alias.
    type: str