Description: By default, the command-line client interacts with the local LXD daemon, but you can add other servers or clusters to interact with. One use case for remote servers is to distribute images that can...

Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# How to add remote servers

Note

Remote servers are a concept in the LXD CLI.

If you are using the UI or the API, you can interact with different remotes by using their exposed UI or API addresses instead.

By default, the command-line client interacts with the local LXD daemon, but you can add other servers or clusters to interact with.

One use case for remote servers is to distribute images that can be used to create instances on local servers. See Remote image servers for more information.

You can also add a full LXD server as a remote server to your client. In this case, you can interact with the remote server in the same way as with your local daemon. For example, you can manage instances or update the server configuration on the remote server.

## Authentication

To be able to add a LXD server as a remote server, the server’s API must be exposed, which means that its `core.https_address` server configuration option must be set.

When adding the server, you must then authenticate with it using the chosen method for Remote API authentication.

See How to expose LXD to the network for more information.

## List configured remotes

To see all configured remote servers, enter the following command:

    lxc remote list

Remote servers that use the simple streams format are pure image servers. Servers that use the `lxd` format are LXD servers, which either serve solely as image servers or might provide some images in addition to serving as regular LXD servers. See Remote server types for more information.

## Add a remote LXD server

To add a LXD server as a remote, enter the following command:

    lxc remote add <remote_name> <IP|FQDN|URL|token> [flags]

Some authentication methods require specific flags (for example, use `lxc remote add <remote_name> <IP|FQDN|URL> --auth-type=oidc` for OIDC authentication). See Authenticate with the LXD server and Remote API authentication for more information.

For example, enter the following command to add a remote through an IP address:

    lxc remote add my-remote 192.0.2.10

You are prompted to confirm the remote server fingerprint and then asked for the token.

## Select a default remote

The LXD command-line client is pre-configured with the `local` remote, which is the local LXD daemon.

To select a different remote as the default remote, enter the following command:

    lxc remote switch <remote_name>

To see which server is configured as the default remote, enter the following command:

    lxc remote get-default

## Configure a global remote

You can configure remotes on a global, per-system basis. These remotes are available for every user of the LXD server for which you add the configuration.

Users can override these system remotes (for example, by running `lxc remote rename` or `lxc remote set-url`), which results in the remote and its associated certificates being copied to the user configuration.

To configure a global remote, edit the `config.yml` file that is located in one of the following directories:

- the directory specified by `LXD_GLOBAL_CONF` (if defined)

- `/var/snap/lxd/common/global-conf/` (if you use the snap)

- `/etc/lxd/` (otherwise)

Certificates for the remotes must be stored in the `servercerts` directory in the same location (for example, `/etc/lxd/servercerts/`). They must match the remote name (for example, `foo.crt`).

See the following example configuration:

    remotes:
      foo:
        addr: https://192.0.2.4:8443
        auth_type: tls
        project: default
        protocol: lxd
        public: false
      bar:
        addr: https://192.0.2.5:8443
        auth_type: tls
        project: default
        protocol: lxd
        public: false