• Logo
    MicroCloud
  • Logo
    LXD
  • Logo
    MicroCeph
  • Logo
    MicroOVN
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
LXD documentation 6.7
LXD documentation 6.7
  • LXD
  • Tutorial
  • How-to guides
    • Getting started
      • Install LXD
      • Initialize LXD
      • Access the UI
      • Access documentation locally
    • LXD server and client
      • Expose LXD to the network
      • Configure the LXD server
      • Configure single sign-on with OIDC
        • How to configure Auth0
        • How to configure Ory Hydra
        • How to configure Keycloak
        • How to configure Entra ID
        • How to configure Pocket ID
      • Add remote servers
      • Add command aliases
    • Instances
      • Create instances
      • Configure instances
      • Manage instances
      • Use profiles
      • Troubleshoot errors
      • Auto attach Ubuntu Pro
      • Access files
      • Access the console
      • Run commands
      • Use cloud-init
      • Add a routed NIC to a VM
      • Back up instances
      • Migrate instances
      • Import existing machines
      • Pass NVIDIA GPUs
    • Images
      • Use remote images
      • Manage images
      • Associate profiles
      • Copy and import images
      • Create images
    • Projects
      • Create and configure
      • Work with projects
      • Confine users to projects
    • Storage
      • Manage pools
      • Manage volumes
      • Manage buckets
      • Create an instance in a pool
      • Back up a volume
      • Move or copy a volume
      • Use the LXD CSI driver with Kubernetes
    • Networking
      • Create a network
      • Configure a network
      • Configure as BGP server
      • Configure network ACLs
      • Configure forwards
      • Configure network zones
      • Configure your firewall
      • Integrate with resolved
      • Set up OVN
      • Configure load balancers
      • Configure peer routing
      • Display IPAM information
    • Clustering
      • Form a cluster
      • Manage a cluster
      • Configure networks
      • Configure storage
      • Manage instances
      • Set up cluster groups
      • Use placement groups
      • Recover a cluster
      • Set up a highly available virtual IP
      • Create cluster links
      • Manage cluster links
    • Production setup
      • Benchmark performance
      • Increase bandwidth
      • Monitor metrics
      • Send logs to Loki
      • Set up Grafana
      • Back up a server
      • Recover instances
      • Disaster recovery with storage replication
    • Manage the snap
    • Harden security
    • Troubleshooting
      • Configure your firewall
      • Troubleshoot instances
      • Troubleshoot Dqlite
      • Debug LXD
      • Frequently asked
    • Get support
    • Contribute to LXD
    • How to authenticate to the LXD API using bearer tokens
    • How to authenticate to the DevLXD API
  • Explanation
    • lxd and lxc
    • Containers and VMs
    • Local and remote images
    • Storage pools, volumes, and buckets
    • Networking setups
    • The LXD Dqlite database
    • lxc show and info
    • Remote API authentication
    • Remote API authorization
    • Instances grouping with projects
    • Clusters
    • Performance tuning
    • Security
    • Privilege delegation using BPF Token
    • The LXD CSI driver
  • Reference
    • Requirements
    • Architectures
    • Release notes
      • LXD 6.7
      • LXD 6.6
    • Releases and snap
    • Remote image servers
    • Image format
    • Guest OS compatibility
    • Container environment
    • Configuration option index
    • Server configuration
    • Instance configuration
      • Instance properties
      • Instance options
      • Devices
        • Standard devices
        • Type: none
        • Type: nic
        • Type: disk
        • Type: unix-char
        • Type: unix-block
        • Type: usb
        • Type: gpu
        • Type: infiniband
        • Type: proxy
        • Type: unix-hotplug
        • Type: tpm
        • Type: pci
      • Units for storage and network limits
    • Preseed YAML file fields
    • Project configuration
    • Storage drivers
      • Directory - dir
      • Btrfs - btrfs
      • LVM - lvm
      • ZFS - zfs
      • Ceph RBD - ceph
      • Dell PowerFlex - powerflex
      • Pure Storage - pure
      • HPE Alletra - alletra
      • CephFS - cephfs
      • Ceph Object - cephobject
    • Networks
      • Bridge network
      • OVN network
      • Macvlan network
      • Physical network
      • SR-IOV network
    • Placement group configuration
    • Clusters
      • Cluster member configuration
      • Cluster link configuration
    • Production server settings
    • Provided metrics
    • Permissions
    • REST API
      • Main API documentation
      • Main API specification
      • Main API extensions
      • Events API documentation
      • Instance API
    • LXD CSI driver reference
    • Man pages
      • lxc
    • Internals
      • Environment variables
      • UEFI variables for VMs
      • Daemon behavior
      • System call interception
      • User namespace setup
      • OVN implementation
      • VM live migration implementation
      • Dqlite
    • Project repository
    • Image server
Back to top
Contribute to this page

Cluster link configuration¶

Each cluster link has its own key/value configuration with the following supported namespaces:

  • Miscellaneous options

  • Volatile internal data

Miscellaneous options¶

The following keys are currently supported:

user.*

Free form user key/value storage

Key: user.*
Type:

string

User keys can be used in search.

Volatile internal data¶

Warning

The volatile.* keys cannot be manipulated by the user. Do not attempt to modify these keys in any way. LXD modifies these keys, and attempting to manipulate them yourself might break LXD in non-obvious ways.

The following volatile keys are currently used internally by LXD to store internal data specific to a cluster link:

volatile.addresses

Cluster link member addresses.

Key: volatile.addresses
Type:

string

Scope:

global

A comma-separated list of cluster link member addresses.

Related topics¶

How-to guides:

  • Clustering

Explanation:

  • Clusters

Next
Server settings for a LXD production setup
Previous
Cluster member configuration
© 2014-2026 AGPL-3.0, LXD contributors
Last updated on Apr 10, 2026
Manage your tracker settings
Contents
  • Cluster link configuration
    • Miscellaneous options
    • Volatile internal data
    • Related topics