Gecko [ www.jdcpatala.org ]

Name	Size	Permission	Action
index.html	68.73 KB	-rw-r--r--

Code Editor : index.html

<!doctype html>
<html class="no-js" lang="en" data-content_root="../">
  <head><meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1"/>
    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Communication between instance and host" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://documentation.ubuntu.com/lxd/en/latest/dev-lxd/" />
<meta property="og:site_name" content="LXD documentation" />
<meta property="og:description" content="Communication between the hosted workload (instance) and its host while not strictly needed is a pretty useful feature. In LXD, this feature is implemented through a/dev/lxd/sock node which is crea..." />
<meta property="og:image" content="https://documentation.ubuntu.com/lxd/en/latest/_static/tag.png" />
<meta property="og:image:alt" content="LXD documentation" />
<meta name="description" content="Communication between the hosted workload (instance) and its host while not strictly needed is a pretty useful feature. In LXD, this feature is implemented through a/dev/lxd/sock node which is crea..." />
<link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" /><link rel="next" title="Man pages" href="../reference/manpages/" /><link rel="prev" title="Events" href="../events/" />

<li class="nav-ubuntu-com">
        <a href="https://canonical.com/lxd" class="p-navigation__link">canonical.com/lxd</a>
      </li>

<li>
        <a href="#" class="p-navigation__link nav-more-links">More resources</a>
        <ul class="more-links-dropdown">

<li>
            <a href="https://ubuntu.com/lxd/install/" class="p-navigation__sub-link p-dropdown__link">Install LXD</a>
          </li>

<li>
            <a href="https://ubuntu.com/lxd/manage/" class="p-navigation__sub-link p-dropdown__link">Manage LXD</a>
          </li>

<li>
            <a href="https://discourse.ubuntu.com/c/lxd/" class="p-navigation__sub-link p-dropdown__link">Forum</a>
          </li>

<li>
            <a href="https://github.com/canonical/lxd" class="p-navigation__sub-link p-dropdown__link">GitHub</a>
          </li>

</ul>
      </li>

</ul>
  </div>
</header>
   
    <script>
      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    </script>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
  <div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
  <div class="visually-hidden">Hide table of contents sidebar</div>
</label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>

<div class="page">
  <header class="mobile-header">
    <div class="header-left">
      <label class="nav-overlay-icon" for="__navigation">
        <div class="visually-hidden">Toggle site navigation sidebar</div>
        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
      </label>
    </div>
    <div class="header-center">
      <a href="../"><div class="brand">LXD</div></a>
    </div>
    <div class="header-right">
      <div class="theme-toggle-container theme-toggle-header">
        <button class="theme-toggle">
          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
      <label class="toc-overlay-icon toc-header-icon" for="__toc">
        <div class="visually-hidden">Toggle table of contents sidebar</div>
        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
      </label>
    </div>
  </header>
  <aside class="sidebar-drawer">
    <div class="sidebar-container">
      
      <div class="sidebar-sticky"><a class="sidebar-brand" href="../">
  
  
  
</a><form class="sidebar-search-container" method="get" action="../search/" role="search">
    <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
    <input type="submit" value="Go">
    <input type="hidden" name="check_keywords" value="yes">
    <input type="hidden" name="area" value="default">
  </form>
  <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../">LXD</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../tutorial/">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/first_steps/">First steps with LXD</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/ui/">Getting started with the UI</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../howto/">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of How-to guides</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="../getting_started/">Getting started</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Getting started</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing/">Install LXD</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/initialize/">Initialize LXD</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/snap/">Manage the snap</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/access_ui/">Access the UI</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/access_documentation/">Access documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../support/">Get support</a></li>
<li class="toctree-l3"><a class="reference internal" href="../contributing/">Contribute to LXD</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../operation/">LXD server and client</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of LXD server and client</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/server_expose/">Expose LXD to the network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/server_configure/">Configure the LXD server</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/oidc_entra_id/">Configure OIDC authentication with Microsoft Entra ID</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/oidc_auth0/">Configure OIDC authentication with Auth0</a></li>
<li class="toctree-l3"><a class="reference internal" href="../remotes/">Add remote servers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/lxc_alias/">Add command aliases</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../instances/">Instances</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Instances</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_create/">Create instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_configure/">Configure instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_manage/">Manage instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../profiles/">Use profiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_troubleshoot/">Troubleshoot errors</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_access_files/">Access files</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_console/">Access the console</a></li>
<li class="toctree-l3"><a class="reference internal" href="../instance-exec/">Run commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cloud-init/">Use cloud-init</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_routed_nic_vm/">Add a routed NIC to a VM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_backup/">Back up instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/move_instances/">Move instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/import_machines_to_instances/">Import existing machines</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/migrate_from_lxc/">Migrate from LXC</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/container_gpu_passthrough_with_docker/">Pass NVIDIA GPUs</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../images/">Images</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Images</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_remote/">Use remote images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_manage/">Manage images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_profiles/">Associate profiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_copy/">Copy and import images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_create/">Create images</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../projects/">Projects</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of Projects</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/projects_create/">Create and configure</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/projects_work/">Work with projects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/projects_confine/">Confine users to projects</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../storage/">Storage</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Storage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_pools/">Manage pools</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_volumes/">Manage volumes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_buckets/">Manage buckets</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_create_instance/">Create an instance in a pool</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_backup_volume/">Back up a volume</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_move_volume/">Move or copy a volume</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../networks/">Networking</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of Networking</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_create/">Create a network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_configure/">Configure a network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bgp/">Configure as BGP server</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_acls/">Configure network ACLs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_forwards/">Configure forwards</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_zones/">Configure network zones</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_firewalld/">Configure your firewall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_resolved/">Integrate with resolved</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_ovn_setup/">Set up OVN</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_load_balancers/">Configure load balancers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_ovn_peers/">Configure peer routing</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_ipam/">Display IPAM information</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../howto/troubleshoot/">Troubleshooting</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of Troubleshooting</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_firewalld/">Configure your firewall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_troubleshoot/">Troubleshoot instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/dqlite_troubleshoot/">Troubleshoot Dqlite</a></li>
<li class="toctree-l3"><a class="reference internal" href="../debugging/">Debug LXD</a></li>
<li class="toctree-l3"><a class="reference internal" href="../faq/">Frequently asked</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../clustering/">Clustering</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of Clustering</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_form/">Form a cluster</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_manage/">Manage a cluster</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_config_networks/">Configure networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_config_storage/">Configure storage</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_manage_instance/">Manage instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_groups/">Set up cluster groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_recover/">Recover a cluster</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../production-setup/">Production setup</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of Production setup</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/benchmark_performance/">Benchmark performance</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_increase_bandwidth/">Increase bandwidth</a></li>
<li class="toctree-l3"><a class="reference internal" href="../metrics/">Monitor metrics</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/logs_loki/">Send logs to Loki</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/grafana/">Set up Grafana</a></li>
<li class="toctree-l3"><a class="reference internal" href="../backup/">Back up a server</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/disaster_recovery/">Recover instances</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../explanation/">Explanation</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle navigation of Explanation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../explanation/lxd_lxc/"><code class="docutils literal notranslate"><span class="pre">lxd</span></code> and <code class="docutils literal notranslate"><span class="pre">lxc</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/instances/">Containers and VMs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image-handling/">Local and remote images</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/storage/">Storage pools, volumes, and buckets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/networks/">Networking setups</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/">The LXD Dqlite database</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/lxc_show_info/"><code class="docutils literal notranslate"><span class="pre">lxc</span></code> <code class="docutils literal notranslate"><span class="pre">show</span></code> and <code class="docutils literal notranslate"><span class="pre">info</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../authentication/">Remote API authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/authorization/">Remote API authorization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/projects/">Instances grouping with projects</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/clusters/">Clusters</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/performance_tuning/">Performance tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/security/">Security</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../reference/">Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><div class="visually-hidden">Toggle navigation of Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../requirements/">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../architectures/">Architectures</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/remote_image_servers/">Remote image servers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/image_format/">Image format</a></li>
<li class="toctree-l2"><a class="reference internal" href="../guest-os-compatibility/">Guest OS compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="../container-environment/">Container environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="../config-options/">Configuration option index</a></li>
<li class="toctree-l2"><a class="reference internal" href="../server/">Server configuration</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../explanation/instance_config/">Instance configuration</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><div class="visually-hidden">Toggle navigation of Instance configuration</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/instance_properties/">Instance properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/instance_options/">Instance options</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="../reference/devices/">Devices</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" role="switch" type="checkbox"/><label for="toctree-checkbox-16"><div class="visually-hidden">Toggle navigation of Devices</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="../reference/standard_devices/">Standard devices</a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_none/">Type: <code class="docutils literal notranslate"><span class="pre">none</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_nic/">Type: <code class="docutils literal notranslate"><span class="pre">nic</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_disk/">Type: <code class="docutils literal notranslate"><span class="pre">disk</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_char/">Type: <code class="docutils literal notranslate"><span class="pre">unix-char</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_block/">Type: <code class="docutils literal notranslate"><span class="pre">unix-block</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_usb/">Type: <code class="docutils literal notranslate"><span class="pre">usb</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_gpu/">Type: <code class="docutils literal notranslate"><span class="pre">gpu</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_infiniband/">Type: <code class="docutils literal notranslate"><span class="pre">infiniband</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_proxy/">Type: <code class="docutils literal notranslate"><span class="pre">proxy</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_hotplug/">Type: <code class="docutils literal notranslate"><span class="pre">unix-hotplug</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_tpm/">Type: <code class="docutils literal notranslate"><span class="pre">tpm</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_pci/">Type: <code class="docutils literal notranslate"><span class="pre">pci</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../reference/instance_units/">Units for storage and network limits</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/preseed_yaml_fields/">Preseed YAML file fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/projects/">Project configuration</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/storage_drivers/">Storage drivers</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" role="switch" type="checkbox"/><label for="toctree-checkbox-17"><div class="visually-hidden">Toggle navigation of Storage drivers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_btrfs/">Btrfs - <code class="docutils literal notranslate"><span class="pre">btrfs</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_cephfs/">CephFS - <code class="docutils literal notranslate"><span class="pre">cephfs</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_cephobject/">Ceph Object - <code class="docutils literal notranslate"><span class="pre">cephobject</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_ceph/">Ceph RBD - <code class="docutils literal notranslate"><span class="pre">ceph</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_powerflex/">Dell PowerFlex - <code class="docutils literal notranslate"><span class="pre">powerflex</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_pure/">Pure Storage - <code class="docutils literal notranslate"><span class="pre">pure</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_dir/">Directory - <code class="docutils literal notranslate"><span class="pre">dir</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_lvm/">LVM - <code class="docutils literal notranslate"><span class="pre">lvm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_zfs/">ZFS - <code class="docutils literal notranslate"><span class="pre">zfs</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/networks/">Networks</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" role="switch" type="checkbox"/><label for="toctree-checkbox-18"><div class="visually-hidden">Toggle navigation of Networks</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_bridge/">Bridge network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_ovn/">OVN network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_macvlan/">Macvlan network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_physical/">Physical network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_sriov/">SR-IOV network</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/cluster_member_config/">Cluster configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/server_settings/">Production server settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/provided_metrics/">Provided metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/permissions/">Permissions</a></li>
<li class="toctree-l2 current has-children"><a class="reference internal" href="../restapi_landing/">REST API</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" role="switch" type="checkbox"/><label for="toctree-checkbox-19"><div class="visually-hidden">Toggle navigation of REST API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../rest-api/">Main API documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../api/">Main API specification</a></li>
<li class="toctree-l3"><a class="reference internal" href="../api-extensions/">Main API extensions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../events/">Events API documentation</a></li>
<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">Instance API</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/manpages/">Man pages</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" role="switch" type="checkbox"/><label for="toctree-checkbox-20"><div class="visually-hidden">Toggle navigation of Man pages</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/manpages/lxc/"><code class="docutils literal notranslate"><span class="pre">lxc</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../internals/">Internals</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" role="switch" type="checkbox"/><label for="toctree-checkbox-21"><div class="visually-hidden">Toggle navigation of Internals</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../environment/">Environment variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/uefi_variables/">UEFI variables for VMs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../daemon-behavior/">Daemon behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="../syscall-interception/">System call interception</a></li>
<li class="toctree-l3"><a class="reference internal" href="../userns-idmap/">User namespace setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/ovn-internals/">OVN implementation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/vm_live_migration_internals/">VM live migration implementation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference external" href="https://github.com/canonical/lxd">Project repository</a></li>
<li class="toctree-l2"><a class="reference external" href="https://images.lxd.canonical.com">Image server</a></li>
</ul>
</li>
</ul>

</div>
</div>

</div>
      
    </div>
  </aside>
  <div class="main">
    <div class="content">
      <div class="article-container">
        <a href="#" class="back-to-top muted-link">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
          </svg>
          <span>Back to top</span>
        </a>
        <div class="content-icon-container">
          <div class="view-this-page">
  <a class="muted-link" href="../_sources/dev-lxd.md.txt" title="View this page">
    <svg><use href="#svg-eye"></use></svg>
    <span class="visually-hidden">View this page</span>
  </a>
</div>
<div class="theme-toggle-container theme-toggle-content">
            <button class="theme-toggle">
              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
          <label class="toc-overlay-icon toc-content-icon" for="__toc">
            <div class="visually-hidden">Toggle table of contents sidebar</div>
            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
          </label>
        </div>
        <article role="main" id="furo-main-content">
          <section id="communication-between-instance-and-host">
<span id="dev-lxd"></span><h1>Communication between instance and host<a class="headerlink" href="#communication-between-instance-and-host" title="Link to this heading">¶</a></h1>
         <p class="youtube_link">           <a href="https://www.youtube.com/watch?v=xZSnqqWykmo" target="_blank">             <span title="The LXD instance API - YouTube" class="play_icon">▶</span>             <span title="The LXD instance API - YouTube">Watch on YouTube</span>           </a>         </p><p>Communication between the hosted workload (instance) and its host while
not strictly needed is a pretty useful feature.</p>
<p>In LXD, this feature is implemented through a <code class="docutils literal notranslate"><span class="pre">/dev/lxd/sock</span></code> node which is
created and set up for all LXD instances.</p>
<p>This file is a Unix socket which processes inside the instance can
connect to. It’s multi-threaded so multiple clients can be connected at the
same time.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.devlxd"><code class="docutils literal notranslate"><span class="pre">security.devlxd</span></code></a> must be set to <code class="docutils literal notranslate"><span class="pre">true</span></code> (which is the default) for an instance to allow access to the socket.</p>
</div>
<section id="implementation-details">
<h2>Implementation details<a class="headerlink" href="#implementation-details" title="Link to this heading">¶</a></h2>
<p>LXD on the host binds <code class="docutils literal notranslate"><span class="pre">/var/lib/lxd/devlxd/sock</span></code> and starts listening for new
connections on it.</p>
<p>This socket is then exposed into every single instance started by
LXD at <code class="docutils literal notranslate"><span class="pre">/dev/lxd/sock</span></code>.</p>
<p>The single socket is required so we can exceed 4096 instances, otherwise,
LXD would have to bind a different socket for every instance, quickly
reaching the FD limit.</p>
</section>
<section id="authentication">
<h2>Authentication<a class="headerlink" href="#authentication" title="Link to this heading">¶</a></h2>
<p>Queries on <code class="docutils literal notranslate"><span class="pre">/dev/lxd/sock</span></code> will only return information related to the
requesting instance. To figure out where a request comes from, LXD will
extract the initial socket’s user credentials and compare that to the list of
instances it manages.</p>
</section>
<section id="protocol">
<h2>Protocol<a class="headerlink" href="#protocol" title="Link to this heading">¶</a></h2>
<p>The protocol on <code class="docutils literal notranslate"><span class="pre">/dev/lxd/sock</span></code> is plain-text HTTP with JSON messaging, so very
similar to the local version of the LXD protocol.</p>
<p>Unlike the main LXD API, there is no background operation and no
authentication support in the <code class="docutils literal notranslate"><span class="pre">/dev/lxd/sock</span></code> API.</p>
</section>
<section id="rest-api">
<h2>REST-API<a class="headerlink" href="#rest-api" title="Link to this heading">¶</a></h2>
<section id="api-structure">
<h3>API structure<a class="headerlink" href="#api-structure" title="Link to this heading">¶</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0</span></code></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/config</span></code></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/config/{key}</span></code></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/devices</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/events</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/images/{fingerprint}/export</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/meta-data</span></code></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section id="api-details">
<h3>API details<a class="headerlink" href="#api-details" title="Link to this heading">¶</a></h3>
<section id="id1">
<h4><code class="docutils literal notranslate"><span class="pre">/</span></code><a class="headerlink" href="#id1" title="Link to this heading">¶</a></h4>
<section id="get">
<h5>GET<a class="headerlink" href="#get" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: List of supported APIs</p></li>
<li><p>Return: list of supported API endpoint URLs (by default <code class="docutils literal notranslate"><span class="pre">['/1.0']</span></code>)</p></li>
</ul>
<p>Return value:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="w">    </span><span class="s2">&quot;/1.0&quot;</span>
<span class="p">]</span>
</pre></div>
</div>
</section>
</section>
<section id="id2">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0</span></code><a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
<section id="id3">
<h5>GET<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Information about the 1.0 API</p></li>
<li><p>Return: JSON object</p></li>
</ul>
<p>Return value:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">    </span><span class="nt">&quot;api_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1.0&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;location&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;foo.example.com&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;instance_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;container&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;state&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Started&quot;</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
</section>
<section id="patch">
<h4>PATCH<a class="headerlink" href="#patch" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p>Description: Update instance state (valid states are <code class="docutils literal notranslate"><span class="pre">Ready</span></code> and <code class="docutils literal notranslate"><span class="pre">Started</span></code>)</p></li>
<li><p>Return: none</p></li>
</ul>
<p>Input:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">   </span><span class="nt">&quot;state&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Ready&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
<section id="config">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/config</span></code><a class="headerlink" href="#config" title="Link to this heading">¶</a></h4>
<section id="id4">
<h5>GET<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: List of configuration keys</p></li>
<li><p>Return: list of configuration keys URL</p></li>
</ul>
<p>Note that the configuration key names match those in the instance
configuration, however not all configuration namespaces will be exported to
<code class="docutils literal notranslate"><span class="pre">/dev/lxd/sock</span></code>.
Currently only the <code class="docutils literal notranslate"><span class="pre">cloud-init.*</span></code> and <code class="docutils literal notranslate"><span class="pre">user.*</span></code> keys are accessible to the instance.</p>
<p>At this time, there also aren’t any instance-writable namespace.</p>
<p>Return value:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="w">    </span><span class="s2">&quot;/1.0/config/user.a&quot;</span>
<span class="p">]</span>
</pre></div>
</div>
</section>
</section>
<section id="config-key">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/config/&lt;KEY&gt;</span></code><a class="headerlink" href="#config-key" title="Link to this heading">¶</a></h4>
<section id="id5">
<h5>GET<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Value of that key</p></li>
<li><p>Return: Plain-text value</p></li>
</ul>
<p>Return value:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>blah
</pre></div>
</div>
</section>
</section>
<section id="devices">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/devices</span></code><a class="headerlink" href="#devices" title="Link to this heading">¶</a></h4>
<section id="id6">
<h5>GET<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Map of instance devices</p></li>
<li><p>Return: JSON object</p></li>
</ul>
<p>Return value:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">    </span><span class="nt">&quot;eth0&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w">        </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;eth0&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;network&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;lxdbr0&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;nic&quot;</span>
<span class="w">    </span><span class="p">},</span>
<span class="w">    </span><span class="nt">&quot;root&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w">        </span><span class="nt">&quot;path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;pool&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;default&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;disk&quot;</span>
<span class="w">    </span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
</section>
<section id="events">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/events</span></code><a class="headerlink" href="#events" title="Link to this heading">¶</a></h4>
<section id="id7">
<h5>GET<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: WebSocket upgrade</p></li>
<li><p>Return: none (never ending flow of events)</p></li>
</ul>
<p>Supported arguments are:</p>
<ul class="simple">
<li><p>type: comma-separated list of notifications to subscribe to (defaults to all)</p></li>
</ul>
<p>The notification types are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">config</span></code> (changes to any of the <code class="docutils literal notranslate"><span class="pre">user.*</span></code> configuration keys)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">device</span></code> (any device addition, change or removal)</p></li>
</ul>
<p>This never returns. Each notification is sent as a separate JSON object:</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">    </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2017-12-21T18:28:26.846603815-05:00&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;device&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;metadata&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w">        </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;kvm&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;action&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;added&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;config&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w">            </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;unix-char&quot;</span><span class="p">,</span>
<span class="w">            </span><span class="nt">&quot;path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/dev/kvm&quot;</span>
<span class="w">        </span><span class="p">}</span>
<span class="w">    </span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">    </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2017-12-21T18:28:26.846603815-05:00&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;config&quot;</span><span class="p">,</span>
<span class="w">    </span><span class="nt">&quot;metadata&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w">        </span><span class="nt">&quot;key&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;user.foo&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;old_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="w">        </span><span class="nt">&quot;value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bar&quot;</span>
<span class="w">    </span><span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
</section>
<section id="images-fingerprint-export">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/images/&lt;FINGERPRINT&gt;/export</span></code><a class="headerlink" href="#images-fingerprint-export" title="Link to this heading">¶</a></h4>
<section id="id8">
<h5>GET<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Download a public/cached image from the host</p></li>
<li><p>Return: raw image or error</p></li>
<li><p>Access: Requires <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.devlxd.images"><code class="docutils literal notranslate"><span class="pre">security.devlxd.images</span></code></a> set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
<p>Return value:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>See /1.0/images/&lt;FINGERPRINT&gt;/export in the daemon API.
</pre></div>
</div>
</section>
</section>
<section id="meta-data">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/meta-data</span></code><a class="headerlink" href="#meta-data" title="Link to this heading">¶</a></h4>
<section id="id9">
<h5>GET<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Container meta-data compatible with cloud-init</p></li>
<li><p>Return: cloud-init meta-data</p></li>
</ul>
<p>Return value:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>instance-id: af6a01c7-f847-4688-a2a4-37fddd744625
local-hostname: abc
</pre></div>
</div>
</section>
</section>
<section id="ubuntu-pro">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/ubuntu-pro</span></code><a class="headerlink" href="#ubuntu-pro" title="Link to this heading">¶</a></h4>
<section id="id10">
<h5>GET<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Get Ubuntu Pro guest attachment setting for the instance</p></li>
<li><p>Return: JSON object</p></li>
</ul>
<p>Return value</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">   </span><span class="nt">&quot;guest_attach&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;on&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
</section>
<section id="ubuntu-pro-token">
<h4><code class="docutils literal notranslate"><span class="pre">/1.0/ubuntu-pro/token</span></code><a class="headerlink" href="#ubuntu-pro-token" title="Link to this heading">¶</a></h4>
<section id="post">
<h5>POST<a class="headerlink" href="#post" title="Link to this heading">¶</a></h5>
<ul class="simple">
<li><p>Description: Get an Ubuntu Pro guest attachment token</p></li>
<li><p>Return: JSON object</p></li>
</ul>
<p>Return value</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="w">   </span><span class="nt">&quot;expires&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-03-23T20:00:00-04:00&quot;</span><span class="p">,</span>
<span class="w">   </span><span class="nt">&quot;token&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;RANDOM-STRING&gt;&quot;</span><span class="p">,</span>
<span class="w">   </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;9f65c3d0-c326-491e-927f-9b062b6649a0&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
</section>
</section>
</section>
</section>

</article>
      </div>
      <footer>

<div class="related-pages">
  
  
      
  
  
  <a class="next-page" href="../reference/manpages/">
        <div class="page-info">
          <div class="context">
            <span>Next</span>
          </div>
          <div class="title">Man pages</div>
        </div>
        <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
      </a>
    <a class="prev-page" href="../events/">
        <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
        <div class="page-info">
          <div class="context">
            <span>Previous</span>
          </div>
          
            <div class="title">Events</div>
          
        </div>
      </a>
</div>
<div class="bottom-of-page">
  <div class="left-details">
    <div class="copyright">
        Copyright &#169; 2014-2025 LXD contributors
    </div>

<div class="last-updated">
      Last updated on Mar 28, 2025</div>
    <div class="show-source">
      <a class="muted-link" href="../_sources/dev-lxd.md.txt"
         rel="nofollow">Show source</a>
    </div>
  </div>
  <div>
    
        
        
          
              <a class="display-contributors">Thanks to the 13 contributors!</a>
          
          <div id="overlay"></div>
          <ul class="all-contributors">
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/8218bc0f202e8d923c9b54edaccb15a422d15deb" class="contributor">Alberto Donato</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/5ccfe971c9734795900f4e0e811edaef9cdb4b4b" class="contributor">Christopher Bartz</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/350c4dfdf76943b31ef30c15faf52d807d5198c5" class="contributor">Hiroaki Nakamura</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/9a84216e5e443e44594f5e52eadc593b8128b186" class="contributor">Julien Reichardt</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/906114c8c7db9efab2e7c96cbb82d7834c1e174d" class="contributor">KATOH Yasufumi</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/a092ede52deca821bb9da3c7fc8b5d5dfa32e73e" class="contributor">Mark Laing</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/3ab13a6becacc2e13aa9416a6699c36fcb3fa50e" class="contributor">Ruth Fuchss</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/d6108e56493a3916f16ec23069acdfc271973990" class="contributor">Simon Deziel</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/e9e5312b65cdac44ac7e4a7a307e7ee77416a34c" class="contributor">Stéphane Graber</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/49240f603a3c44382817a12dd2fdee24140bee74" class="contributor">Thomas Hipp</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/505db29526c4a46b4af5950f1870ca38ab793283" class="contributor">Thomas Parrott</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/ff45b17d3105ba318b96d512e1616b6cede989a3" class="contributor">hamistao</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/a69d678c2830fe3febbf7a992cafe52eb788b796" class="contributor">silverwind</a>
                  </li>
              
          </ul>
        
    
  </div>
  <div class="right-details">

<div class="ask-discourse">
      <a class="muted-link" href="https://discourse.ubuntu.com/c/lxd/">Ask a question on Discourse</a>
    </div>

<div class="ask-matrix">
      <a class="muted-link" href="https://matrix.to/#/#documentation:ubuntu.com">Ask a question on Matrix</a>
    </div>

<div class="issue-github">
      <a class="muted-link" href="https://github.com/canonical/lxd/issues/new?title=doc%3A+ADD+A+TITLE&body=DESCRIBE+THE+ISSUE%0A%0A---%0ADocument: dev-lxd.md">Open a GitHub issue for this page</a>
    </div>

<div class="edit-github">
      <a class="muted-link" href="https://github.com/canonical/lxd/edit/main/doc/dev-lxd.md">Edit this page on GitHub</a>
    </div>

</div>
  </div>
</div>

</footer>
    </div>
    <aside class="toc-drawer">
      
<div class="toc-sticky toc-scroll">
   
    <div class="toc-title-container">
      <span class="toc-title">
       Contents
      </span>
    </div>
    <div class="toc-tree-container">
      <div class="toc-tree">
        <ul>
<li><a class="reference internal" href="#">Communication between instance and host</a><ul>
<li><a class="reference internal" href="#implementation-details">Implementation details</a></li>
<li><a class="reference internal" href="#authentication">Authentication</a></li>
<li><a class="reference internal" href="#protocol">Protocol</a></li>
<li><a class="reference internal" href="#rest-api">REST-API</a><ul>
<li><a class="reference internal" href="#api-structure">API structure</a></li>
<li><a class="reference internal" href="#api-details">API details</a><ul>
<li><a class="reference internal" href="#id1"><code class="docutils literal notranslate"><span class="pre">/</span></code></a><ul>
<li><a class="reference internal" href="#get">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id2"><code class="docutils literal notranslate"><span class="pre">/1.0</span></code></a><ul>
<li><a class="reference internal" href="#id3">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#patch">PATCH</a></li>
<li><a class="reference internal" href="#config"><code class="docutils literal notranslate"><span class="pre">/1.0/config</span></code></a><ul>
<li><a class="reference internal" href="#id4">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#config-key"><code class="docutils literal notranslate"><span class="pre">/1.0/config/&lt;KEY&gt;</span></code></a><ul>
<li><a class="reference internal" href="#id5">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#devices"><code class="docutils literal notranslate"><span class="pre">/1.0/devices</span></code></a><ul>
<li><a class="reference internal" href="#id6">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#events"><code class="docutils literal notranslate"><span class="pre">/1.0/events</span></code></a><ul>
<li><a class="reference internal" href="#id7">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#images-fingerprint-export"><code class="docutils literal notranslate"><span class="pre">/1.0/images/&lt;FINGERPRINT&gt;/export</span></code></a><ul>
<li><a class="reference internal" href="#id8">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#meta-data"><code class="docutils literal notranslate"><span class="pre">/1.0/meta-data</span></code></a><ul>
<li><a class="reference internal" href="#id9">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#ubuntu-pro"><code class="docutils literal notranslate"><span class="pre">/1.0/ubuntu-pro</span></code></a><ul>
<li><a class="reference internal" href="#id10">GET</a></li>
</ul>
</li>
<li><a class="reference internal" href="#ubuntu-pro-token"><code class="docutils literal notranslate"><span class="pre">/1.0/ubuntu-pro/token</span></code></a><ul>
<li><a class="reference internal" href="#post">POST</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
    </div>
   
    
  </div>

</aside>
  </div>
</div><script src="../_static/jquery.js?v=5d32c60e"></script>
    <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
    <script src="../_static/documentation_options.js?v=187304be"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/scripts/furo.js?v=5fa4622c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=f281be69"></script>
    <script src="../_static/config-options.js"></script>
    <script src="../_static/design-tabs.js?v=f930bc37"></script>
    <script src="../_static/header-nav.js?v=e117ad08"></script>
    <script src="../_static/footer.js?v=5acea47a"></script>
    <script src="../_static/github_issue_links.js?v=32bb732f"></script>
    
<script>
  const github_url = "https://github.com/canonical/lxd";
</script>
</body>
</html>

${this.title}

Code Editor : index.html