community.general.lxd (8.5.0) — inventory

Install collection

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

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

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

server_cert:
    description:
    - The server certificate file path.
    type: path
    version_added: 8.0.0
    version_added_collection: community.general

type_filter:
    choices:
    - virtual-machine
    - container
    - both
    default: container
    description:
    - Filter the instances by type V(virtual-machine), V(container) or V(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://documentation.ubuntu.com/lxd/en/latest/authentication/#adding-client-certificates-using-a-trust-password).
    - If O(trust_password) is set, this module send a request for authentication before
      sending any requests.
    type: str

server_check_hostname:
    default: true
    description:
    - This option controls if the server's hostname is checked as part of the HTTPS connection
      verification. This can be useful to disable, if for example, the server certificate
      provided (see O(server_cert) option) does not cover a name matching the one used
      to communicate with the server. Such mismatch is common as LXD generates self-signed
      server certificates by default.
    type: bool
    version_added: 8.0.0
    version_added_collection: community.general

prefered_instance_network_family:
    choices:
    - inet
    - inet6
    default: inet
    description:
    - If an instance has multiple network interfaces, which one is the preferred by family.
    - Specify V(inet) for IPv4 and V(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 preferred
      as pattern.
    - Combined with the first number that can be found e.g. 'eth' + 0.
    - The option has been renamed from O(prefered_container_network_interface) to O(prefered_instance_network_interface)
      in community.general 3.8.0. The old name still works as an alias.
    type: str