• Logo
    LXD
  • canonical.com/lxd
  • More resources
    • Install LXD
    • Manage LXD
    • Forum
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
LXD
  • LXD
  • Tutorials
    • First steps with LXD
    • Getting started with the UI
  • 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 OIDC authentication with Auth0
      • Configure OIDC authentication with Ory Hydra
      • Configure OIDC authentication with Keycloak
      • Configure OIDC authentication with Microsoft Entra 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
    • 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
      • Recover a cluster
      • 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
    • Manage the snap
    • Troubleshooting
      • Configure your firewall
      • Troubleshoot instances
      • Troubleshoot Dqlite
      • Debug LXD
      • Frequently asked
    • 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
    • Performance tuning
    • Security
    • Privilege delegation using BPF Token
  • Reference
    • Requirements
    • Architectures
    • 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
      • Btrfs - btrfs
      • CephFS - cephfs
      • Ceph Object - cephobject
      • Ceph RBD - ceph
      • Dell PowerFlex - powerflex
      • Pure Storage - pure
      • Directory - dir
      • LVM - lvm
      • ZFS - zfs
    • Networks
      • Bridge network
      • OVN network
      • Macvlan network
      • Physical network
      • SR-IOV network
    • 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
    • Man pages
      • lxc
    • Internals
      • Environment variables
      • UEFI variables for VMs
      • Daemon behavior
      • System call interception
      • User namespace setup
      • OVN implementation
      • VM live migration implementation
    • Project repository
    • Image server
Back to top
View 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
Copyright © 2014-2025 LXD contributors
Last updated on Aug 11, 2025
Show source
Thanks to our contributor!
  • Kadin Sayani
Ask a question on Discourse
Ask a question on Matrix
Open a GitHub issue for this page
Edit this page on GitHub
Contents
  • Cluster link configuration
    • Miscellaneous options
    • Volatile internal data
    • Related topics