• Logo
    LXD
  • canonical.com/lxd
  • More resources
    • Discourse
    • Matrix
    • GitHub
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.8
LXD documentation 6.8
  • LXD
  • Tutorial
  • How-to guides
    • Getting started
      • Install LXD
      • Initialize LXD
      • Access the UI
      • Access documentation locally
    • LXD server and client
      • Configure the LXD server
      • Expose LXD to the network
      • Configure single sign-on with OIDC
        • Configure Auth0
        • Configure Ory Hydra
        • Configure Keycloak
        • Configure Entra ID
        • 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
      • Import existing machines
      • Migrate instances
      • Pass NVIDIA GPUs
    • Images
      • Use remote images
      • Manage images
      • Associate profiles
      • Copy and import images
      • Create images
    • Projects
      • Create and configure projects
      • Work with projects
      • Confine users to projects
    • Storage
      • Manage pools
      • Manage volumes
      • Manage buckets
      • Create or move an instance in a pool
      • Back up a custom volume
      • Move or copy a custom 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
      • Recover orphaned volume entries
      • Set up a highly available virtual IP
      • Create cluster links
      • Manage cluster links
      • Set up replicators
      • Manage replicators
    • 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
      • Disaster recovery with replicators
    • Manage the snap
    • Harden security
    • Troubleshooting
      • Configure your firewall
      • Troubleshoot instances
      • Troubleshoot networks
      • Troubleshoot Dqlite
      • Frequently asked
      • Debug LXD
    • Authenticate to the LXD API using bearer tokens
    • Authenticate to the DevLXD API
    • Get support
    • Contribute to LXD
  • 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
    • Replicators
    • Performance tuning
    • Security
    • Privilege delegation using BPF Token
    • The LXD CSI driver
  • Reference
    • Requirements
    • Architectures
    • Guest OS compatibility
    • Container environment
    • Man pages
      • lxc
    • Release notes
      • LXD 6.8
      • LXD 6.7
      • LXD 6.6
    • Releases and snap
    • Remote image servers
    • Image format
    • 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
    • Replicator configuration
    • Permissions
    • Production server settings
    • Provided metrics
    • REST API
      • Main API overview
      • Main API specification
      • Main API extensions
      • Events stream
      • DevLXD API for instances
    • LXD CSI driver reference
    • Internals
      • Environment variables
      • Daemon behavior
      • UEFI variables for VMs
      • System call interception
      • User namespace setup
      • OVN implementation
      • VM live migration implementation
      • Dqlite database for cluster state
    • 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
Replicator configuration
Previous
Cluster member configuration
© 2014-2026 AGPL-3.0, LXD contributors
Last updated on Apr 29, 2026
Manage your tracker settings
Contents
  • Cluster link configuration
    • Miscellaneous options
    • Volatile internal data
    • Related topics