---
title: "LXD integration · RUAL Documentation"
description: "Use LXD in RUAL blueprints. Inspect an LXD cluster and start, restart, create and remove its instances. Every block, with its pins."
canonical: https://docs.rual.nl/integrations/lxd
language: en
---

# LXD

Inspect an LXD cluster and start, restart, create and remove its instances.

## Blocks

Add these blocks on the canvas by searching for their name. Each block page lists its pins and how it behaves.

- [get cluster info `lxdconnection_cluster_info` Retreives the information about the LXD cluster.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_cluster_info)

- [get cluster members `lxdconnection_cluster_members` Retreives the LXD cluster members.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_cluster_members)

- [get instance info `lxdconnection_instance` Get info of a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance)

- [remove instance `lxdconnection_instance_remove` Starts a instance remove operation on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_remove)

- [restart instance `lxdconnection_instance_restart` Restart a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_restart)

- [start instance `lxdconnection_instance_start` Start a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_start)

- [get instance state `lxdconnection_instance_state` Get state of a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_state)

- [stop instance `lxdconnection_instance_stop` Stop a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_stop)

- [update instance `lxdconnection_instance_update` Updates a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_update)

- [update instance configuration `lxdconnection_instance_update_configuration` Updates a instance configuration on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instance_update_configuration)

- [get instances `lxdconnection_instances` Retreives the instances that are on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instances)

- [create instance `lxdconnection_instances_create` Creates a instance on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_instances_create)

- [get network info `lxdconnection_network` Retreives all the info of a network on LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network)

- [get network acl info `lxdconnection_network_acl` Retreives all the info of a network ACL on LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_acl)

- [remove network acl `lxdconnection_network_acl_remove` Starts a network acl remove operation on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_acl_remove)

- [update network acl `lxdconnection_network_acl_update` Updates the given network ACL on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_acl_update)

- [get network acls `lxdconnection_network_acls` Retreives all the networks ACLS on LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_acls)

- [connect network acl to network `lxdconnection_network_connect_acl` Connects the given network ACL with the given network on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_connect_acl)

- [remove network `lxdconnection_network_remove` Starts a network remove operation on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_remove)

- [rename network `lxdconnection_network_rename` Renames the given network on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_rename)

- [update network `lxdconnection_network_update` Updates the given network on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_network_update)

- [get networks `lxdconnection_networks` Retreives all the networks on LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_networks)

- [create network acl `lxdconnection_networks_acls_create` Creates a network ACL on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_networks_acls_create)

- [create network `lxdconnection_networks_create` Creates a network on the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_networks_create)

- [open connection `lxdconnection_open` This block is used to open a connection to a LXD or Incus server. Incus is the fork of LXD and answers the same API, so one connection serves both.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_open)

- [get operation state `lxdconnection_operation` Retreives all the state of a operation on LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_operation)

- [get operations `lxdconnection_operations` Retreives all the operations on LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_operations)

- [get server info `lxdconnection_server_info` Retreives the information about the LXD server.](https://docs.rual.nl/block-types/virtualisation/lxdconnection_server_info)

> **4 deprecated blocks not listed** Older blocks for this service still run but should not be used in new work. Their block pages name the successor when there is one.

## Next steps

- [Third-Party Integrations](https://docs.rual.nl/tutorials/third-party-integrations): Calling outside APIs, receiving their webhooks, keeping data in sync and handling failures.

- [All integrations](https://docs.rual.nl/integrations): Everything RUAL connects to, by what it is for.