| Server IP : 103.161.17.216 / Your IP : 216.73.216.1 Web Server : nginx/1.18.0 System : Linux tipsysaigoncharming 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 User : www-data ( 33) PHP Version : 7.4.3-4ubuntu2.29 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /snap/lxd/37560/share/lxd-documentation/api-extensions/ |
Upload File : |
<!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="API extensions" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://documentation.ubuntu.com/lxd/latest/api-extensions/" />
<meta property="og:site_name" content="LXD documentation" />
<meta property="og:description" content="The changes below were introduced to the LXD API after the 1.0 API was finalized. They are all backward compatible and can be detected by client tools by looking at the api_extensions field in GET ..." />
<meta property="og:image" content="https://documentation.ubuntu.com/lxd/latest/_static/tag.png" />
<meta property="og:image:alt" content="LXD documentation" />
<meta name="description" content="The changes below were introduced to the LXD API after the 1.0 API was finalized. They are all backward compatible and can be detected by client tools by looking at the api_extensions field in GET ..." />
<link rel="index" title="Index" href="../genindex/"><link rel="search" title="Search" href="../search/"><link rel="next" title="Events" href="../events/"><link rel="prev" title="Main API specification" href="../api/">
<link rel="canonical" href="https://documentation.ubuntu.com/lxd/api-extensions/">
<link rel="shortcut icon" href="../_static/favicon.ico"><!-- Generated with Sphinx 8.2.3 and Furo 2025.12.19 -->
<title>API extensions</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/youtube.css" />
<link rel="stylesheet" type="text/css" href="../_static/related-links.css" />
<link rel="stylesheet" type="text/css" href="../_static/terminal-output.css" />
<link rel="stylesheet" type="text/css" href="../_static/config-options.css" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=66d86e9d" />
<link rel="stylesheet" type="text/css" href="../_static/header.css?v=84f70f09" />
<link rel="stylesheet" type="text/css" href="../_static/github_issue_links.css?v=af88fb93" />
<link rel="stylesheet" type="text/css" href="../_static/furo_colors.css?v=c4ccdb8a" />
<link rel="stylesheet" type="text/css" href="../_static/footer.css?v=bd05fc90" />
<link rel="stylesheet" type="text/css" href="../_static/cookie-banner.css?v=b74831ab" />
</head>
<body>
<header id="header" class="p-navigation">
<script type="module" src="../_static/js/bundle.js">
</script>
<!-- Google Tag Manager -->
<script>
(function(w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({
'gtm.start': new Date().getTime(),
event: 'gtm.js'
});
var f = d.getElementsByTagName(s)[0];
var j = d.createElement(s);
var dl = '';
if (l != 'dataLayer') {
dl = '&l=' + l;
}
j.async = true;
j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-KNX3CJC');
</script>
<div class="p-navigation__nav" role="menubar">
<ul class="p-navigation__links" role="menu">
<li>
<a class="p-logo" href="https://canonical.com/lxd" aria-current="page">
<img src="../_static/tag.png" alt="Logo" class="p-logo-image">
<div class="p-logo-text p-heading--4">LXD
</div>
</a>
</li>
<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>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></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">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</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" aria-label="Toggle Light / Dark / Auto color theme">
<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">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</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"><a class="reference internal" href="../tutorial/first_steps/">Tutorial</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../howto/">How-to guides</a><input aria-label="Toggle navigation of How-to guides" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="../getting_started/">Getting started</a><input aria-label="Toggle navigation of Getting started" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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/access_ui/">Access the UI</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/access_documentation/">Access documentation locally</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../operation/">LXD server and client</a><input aria-label="Toggle navigation of LXD server and client" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 has-children"><a class="reference internal" href="../howto/oidc/">Configure single sign-on with OIDC</a><input aria-label="Toggle navigation of Configure single sign-on with OIDC" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l4"><a class="reference internal" href="../howto/oidc_auth0/">How to configure Auth0</a></li>
<li class="toctree-l4"><a class="reference internal" href="../howto/oidc_ory/">How to configure Ory Hydra</a></li>
<li class="toctree-l4"><a class="reference internal" href="../howto/oidc_keycloak/">How to configure Keycloak</a></li>
<li class="toctree-l4"><a class="reference internal" href="../howto/oidc_entra_id/">How to configure Entra ID</a></li>
</ul>
</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 aria-label="Toggle navigation of Instances" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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_ubuntu_pro_attach/">Auto attach Ubuntu Pro</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/instances_migrate/">Migrate 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/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 aria-label="Toggle navigation of Images" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 aria-label="Toggle navigation of Projects" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 aria-label="Toggle navigation of Storage" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_csi/">Use the LXD CSI driver with Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../networks/">Networking</a><input aria-label="Toggle navigation of Networking" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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="../clustering/">Clustering</a><input aria-label="Toggle navigation of Clustering" class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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_placement_groups/">Use placement groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_recover/">Recover a cluster</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_vip/">Set up a highly available virtual IP</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../production-setup/">Production setup</a><input aria-label="Toggle navigation of Production setup" class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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>
<li class="toctree-l3"><a class="reference internal" href="../howto/disaster_recovery_replication/">Disaster recovery with storage replication</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../howto/snap/">Manage the snap</a></li>
<li class="toctree-l2"><a class="reference internal" href="../howto/security_harden/">Harden security</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../howto/troubleshoot/">Troubleshooting</a><input aria-label="Toggle navigation of Troubleshooting" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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"><a class="reference internal" href="../support/">Get support</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/">Contribute to LXD</a></li>
<li class="toctree-l2"><a class="reference internal" href="../howto/devlxd_authenticate/">How to authenticate to the DevLXD API</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../explanation/">Explanation</a><input aria-label="Toggle navigation of Explanation" class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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>
<li class="toctree-l2"><a class="reference internal" href="../explanation/bpf/">Privilege delegation using BPF Token</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/csi/">The LXD CSI driver</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../reference/">Reference</a><input aria-label="Toggle navigation of Reference" checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 has-children"><a class="reference internal" href="../reference/release-notes/">Release notes</a><input aria-label="Toggle navigation of Release notes" class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/release-notes/release-notes-6.6/">LXD 6.6</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/releases-snap/">Releases and snap</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 aria-label="Toggle navigation of Instance configuration" class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" role="switch" type="checkbox"/><label for="toctree-checkbox-16"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 aria-label="Toggle navigation of Devices" class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" role="switch" type="checkbox"/><label for="toctree-checkbox-17"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 aria-label="Toggle navigation of Storage drivers" class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" role="switch" type="checkbox"/><label for="toctree-checkbox-18"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<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_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_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>
<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_alletra/">HPE Alletra - <code class="docutils literal notranslate"><span class="pre">alletra</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>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/networks/">Networks</a><input aria-label="Toggle navigation of Networks" class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" role="switch" type="checkbox"/><label for="toctree-checkbox-19"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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/placement_groups/">Placement group 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 aria-label="Toggle navigation of REST API" checked="" class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" role="switch" type="checkbox"/><label for="toctree-checkbox-20"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 current current-page"><a class="current reference internal" href="#">Main API extensions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../events/">Events API documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../dev-lxd/">Instance API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/driver_csi/">LXD CSI driver reference</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/manpages/">Man pages</a><input aria-label="Toggle navigation of Man pages" class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" role="switch" type="checkbox"/><label for="toctree-checkbox-21"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 aria-label="Toggle navigation of Internals" class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" role="switch" type="checkbox"/><label for="toctree-checkbox-22"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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/api-extensions.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" aria-label="Toggle Light / Dark / Auto color theme">
<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">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="api-extensions">
<h1>API extensions<a class="headerlink" href="#api-extensions" title="Link to this heading">¶</a></h1>
<p>The changes below were introduced to the LXD API after the 1.0 API was finalized.</p>
<p>They are all backward compatible and can be detected by client tools by
looking at the <code class="docutils literal notranslate"><span class="pre">api_extensions</span></code> field in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0</span></code>.</p>
<section id="storage-zfs-remove-snapshots">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_remove_snapshots</span></code><a class="headerlink" href="#storage-zfs-remove-snapshots" title="Link to this heading">¶</a></h2>
<p>A <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-volume-conf:zfs.remove_snapshots"><code class="docutils literal notranslate"><span class="pre">zfs.remove_snapshots</span></code></a> daemon configuration key was introduced.</p>
<p>It’s a Boolean that defaults to <code class="docutils literal notranslate"><span class="pre">false</span></code> and that when set to <code class="docutils literal notranslate"><span class="pre">true</span></code> instructs LXD
to remove any needed snapshot when attempting to restore another.</p>
<p>This is needed as ZFS will only let you restore the latest snapshot.</p>
</section>
<section id="container-host-shutdown-timeout">
<h2><code class="docutils literal notranslate"><span class="pre">container_host_shutdown_timeout</span></code><a class="headerlink" href="#container-host-shutdown-timeout" title="Link to this heading">¶</a></h2>
<p>A <a class="configref reference internal" href="../reference/instance_options/#instance-boot:boot.host_shutdown_timeout"><code class="docutils literal notranslate"><span class="pre">boot.host_shutdown_timeout</span></code></a> container configuration key was introduced.</p>
<p>It’s an integer which indicates how long LXD should wait for the container
to stop before killing it.</p>
<p>Its value is only used on clean LXD daemon shutdown. It defaults to 30s.</p>
</section>
<section id="container-stop-priority">
<h2><code class="docutils literal notranslate"><span class="pre">container_stop_priority</span></code><a class="headerlink" href="#container-stop-priority" title="Link to this heading">¶</a></h2>
<p>A <a class="configref reference internal" href="../reference/instance_options/#instance-boot:boot.stop.priority"><code class="docutils literal notranslate"><span class="pre">boot.stop.priority</span></code></a> container configuration key was introduced.</p>
<p>It’s an integer which indicates the priority of a container during shutdown.</p>
<p>Containers will shutdown starting with the highest priority level.</p>
<p>Containers with the same priority will shutdown in parallel. It defaults to 0.</p>
</section>
<section id="container-syscall-filtering">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_filtering</span></code><a class="headerlink" href="#container-syscall-filtering" title="Link to this heading">¶</a></h2>
<p>A number of new syscalls related container configuration keys were introduced.</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.deny_default"><code class="docutils literal notranslate"><span class="pre">security.syscalls.deny_default</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.deny_compat"><code class="docutils literal notranslate"><span class="pre">security.syscalls.deny_compat</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.deny"><code class="docutils literal notranslate"><span class="pre">security.syscalls.deny</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.allow"><code class="docutils literal notranslate"><span class="pre">security.syscalls.allow</span></code></a></p></li>
</ul>
<p>See <a class="reference internal" href="../explanation/instance_config/#instance-config"><span class="std std-ref">Instance configuration</span></a> for how to use them.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Initially, those configuration keys were (accidentally) introduced with
offensive names. They have since been renamed
(<code class="docutils literal notranslate"><span class="pre">container_syscall_filtering_allow_deny_syntax</span></code>), and the old names are no
longer accepted.</p>
</div>
</section>
<section id="auth-pki">
<h2><code class="docutils literal notranslate"><span class="pre">auth_pki</span></code><a class="headerlink" href="#auth-pki" title="Link to this heading">¶</a></h2>
<p>This indicates support for PKI authentication mode.</p>
<p>In this mode, the client and server both must use certificates issued by the same PKI.</p>
<p>See <a class="reference internal" href="../explanation/security/#security"><span class="std std-ref">Security</span></a> for details.</p>
</section>
<section id="container-last-used-at">
<h2><code class="docutils literal notranslate"><span class="pre">container_last_used_at</span></code><a class="headerlink" href="#container-last-used-at" title="Link to this heading">¶</a></h2>
<p>A <code class="docutils literal notranslate"><span class="pre">last_used_at</span></code> field was added to the <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/containers/<name></span></code> endpoint.</p>
<p>It is a timestamp of the last time the container was started.</p>
<p>If a container has been created but not started yet, <code class="docutils literal notranslate"><span class="pre">last_used_at</span></code> field
will be <code class="docutils literal notranslate"><span class="pre">1970-01-01T00:00:00Z</span></code></p>
</section>
<section id="etag">
<h2><code class="docutils literal notranslate"><span class="pre">etag</span></code><a class="headerlink" href="#etag" title="Link to this heading">¶</a></h2>
<p>Add support for the ETag header on all relevant endpoints.</p>
<p>This adds the following HTTP header on answers to GET:</p>
<ul class="simple">
<li><p>ETag (SHA-256 of user modifiable content)</p></li>
</ul>
<p>And adds support for the following HTTP header on PUT requests:</p>
<ul class="simple">
<li><p>If-Match (ETag value retrieved through previous GET)</p></li>
</ul>
<p>This makes it possible to GET a LXD object, modify it and PUT it without
risking to hit a race condition where LXD or another client modified the
object in the meantime.</p>
</section>
<section id="patch">
<h2><code class="docutils literal notranslate"><span class="pre">patch</span></code><a class="headerlink" href="#patch" title="Link to this heading">¶</a></h2>
<p>Add support for the HTTP PATCH method.</p>
<p>PATCH allows for partial update of an object in place of PUT.</p>
</section>
<section id="usb-devices">
<h2><code class="docutils literal notranslate"><span class="pre">usb_devices</span></code><a class="headerlink" href="#usb-devices" title="Link to this heading">¶</a></h2>
<p>Add support for USB hotplug.</p>
</section>
<section id="https-allowed-credentials">
<h2><code class="docutils literal notranslate"><span class="pre">https_allowed_credentials</span></code><a class="headerlink" href="#https-allowed-credentials" title="Link to this heading">¶</a></h2>
<p>To use LXD API with all Web Browsers (via SPAs) you must send credentials
(certificate) with each XHR (in order for this to happen, you should set
<a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials"><code class="docutils literal notranslate"><span class="pre">withCredentials=true</span></code></a>
flag to each XHR Request).</p>
<p>Some browsers like Firefox and Safari can’t accept server response without
<code class="docutils literal notranslate"><span class="pre">Access-Control-Allow-Credentials:</span> <span class="pre">true</span></code> header. To ensure that the server will
return a response with that header, set <a class="configref reference internal" href="../server/#server-core:core.https_allowed_credentials"><code class="docutils literal notranslate"><span class="pre">core.https_allowed_credentials</span></code></a> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</section>
<section id="image-compression-algorithm">
<h2><code class="docutils literal notranslate"><span class="pre">image_compression_algorithm</span></code><a class="headerlink" href="#image-compression-algorithm" title="Link to this heading">¶</a></h2>
<p>This adds support for a <code class="docutils literal notranslate"><span class="pre">compression_algorithm</span></code> property when creating an image (<code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/images</span></code>).</p>
<p>Setting this property overrides the server default value (<a class="configref reference internal" href="../server/#server-images:images.compression_algorithm"><code class="docutils literal notranslate"><span class="pre">images.compression_algorithm</span></code></a>).</p>
</section>
<section id="directory-manipulation">
<h2><code class="docutils literal notranslate"><span class="pre">directory_manipulation</span></code><a class="headerlink" href="#directory-manipulation" title="Link to this heading">¶</a></h2>
<p>This allows for creating and listing directories via the LXD API, and exports
the file type via the X-LXD-type header, which can be either <code class="docutils literal notranslate"><span class="pre">file</span></code> or
<code class="docutils literal notranslate"><span class="pre">directory</span></code> right now.</p>
</section>
<section id="container-cpu-time">
<h2><code class="docutils literal notranslate"><span class="pre">container_cpu_time</span></code><a class="headerlink" href="#container-cpu-time" title="Link to this heading">¶</a></h2>
<p>This adds support for retrieving CPU time for a running container.</p>
</section>
<section id="storage-zfs-use-refquota">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_use_refquota</span></code><a class="headerlink" href="#storage-zfs-use-refquota" title="Link to this heading">¶</a></h2>
<p>Introduces a new server property <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-volume-conf:zfs.use_refquota"><code class="docutils literal notranslate"><span class="pre">zfs.use_refquota</span></code></a> which instructs LXD
to set the <code class="docutils literal notranslate"><span class="pre">refquota</span></code> property instead of <code class="docutils literal notranslate"><span class="pre">quota</span></code> when setting a size limit
on a container. LXD will also then use <code class="docutils literal notranslate"><span class="pre">usedbydataset</span></code> in place of <code class="docutils literal notranslate"><span class="pre">used</span></code>
when being queried about disk utilization.</p>
<p>This effectively controls whether disk usage by snapshots should be
considered as part of the container’s disk space usage.</p>
</section>
<section id="storage-lvm-mount-options">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_mount_options</span></code><a class="headerlink" href="#storage-lvm-mount-options" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">storage.lvm_mount_options</span></code> daemon configuration option
which defaults to <code class="docutils literal notranslate"><span class="pre">discard</span></code> and allows the user to set addition mount
options for the file system used by the LVM LV.</p>
</section>
<section id="network">
<h2><code class="docutils literal notranslate"><span class="pre">network</span></code><a class="headerlink" href="#network" title="Link to this heading">¶</a></h2>
<p>Network management API for LXD.</p>
<p>This includes:</p>
<ul class="simple">
<li><p>Addition of the <code class="docutils literal notranslate"><span class="pre">managed</span></code> property on <code class="docutils literal notranslate"><span class="pre">/1.0/networks</span></code> entries</p></li>
<li><p>All the network configuration options (see <a class="reference internal" href="../networks/"><span class="std std-doc">Network configuration</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/networks</span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/networks/<entry></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/networks/<entry></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/networks/<entry></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ipv4.address</span></code> property on <code class="docutils literal notranslate"><span class="pre">nic</span></code> type devices (when <code class="docutils literal notranslate"><span class="pre">nictype</span></code> is <code class="docutils literal notranslate"><span class="pre">bridged</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ipv6.address</span></code> property on <code class="docutils literal notranslate"><span class="pre">nic</span></code> type devices (when <code class="docutils literal notranslate"><span class="pre">nictype</span></code> is <code class="docutils literal notranslate"><span class="pre">bridged</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">security.mac_filtering</span></code> property on <code class="docutils literal notranslate"><span class="pre">nic</span></code> type devices (when <code class="docutils literal notranslate"><span class="pre">nictype</span></code> is <code class="docutils literal notranslate"><span class="pre">bridged</span></code>)</p></li>
</ul>
</section>
<section id="profile-usedby">
<h2><code class="docutils literal notranslate"><span class="pre">profile_usedby</span></code><a class="headerlink" href="#profile-usedby" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">used_by</span></code> field to profile entries listing the containers that are using it.</p>
</section>
<section id="container-push">
<h2><code class="docutils literal notranslate"><span class="pre">container_push</span></code><a class="headerlink" href="#container-push" title="Link to this heading">¶</a></h2>
<p>When a container is created in push mode, the client serves as a proxy between
the source and target server. This is useful in cases where the target server
is behind a NAT or firewall and cannot directly communicate with the source
server and operate in pull mode.</p>
</section>
<section id="container-exec-recording">
<h2><code class="docutils literal notranslate"><span class="pre">container_exec_recording</span></code><a class="headerlink" href="#container-exec-recording" title="Link to this heading">¶</a></h2>
<p>Introduces a new Boolean <code class="docutils literal notranslate"><span class="pre">record-output</span></code>, parameter to
<code class="docutils literal notranslate"><span class="pre">/1.0/containers/<name>/exec</span></code> which when set to <code class="docutils literal notranslate"><span class="pre">true</span></code> and combined with
with <code class="docutils literal notranslate"><span class="pre">wait-for-websocket</span></code> set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, will record stdout and stderr to
disk and make them available through the logs interface.</p>
<p>The URL to the recorded output is included in the operation metadata
once the command is done running.</p>
<p>That output will expire similarly to other log files, typically after 48 hours.</p>
</section>
<section id="certificate-update">
<h2><code class="docutils literal notranslate"><span class="pre">certificate_update</span></code><a class="headerlink" href="#certificate-update" title="Link to this heading">¶</a></h2>
<p>Adds the following to the REST API:</p>
<ul class="simple">
<li><p>ETag header on GET of a certificate</p></li>
<li><p>PUT of certificate entries</p></li>
<li><p>PATCH of certificate entries</p></li>
</ul>
</section>
<section id="container-exec-signal-handling">
<h2><code class="docutils literal notranslate"><span class="pre">container_exec_signal_handling</span></code><a class="headerlink" href="#container-exec-signal-handling" title="Link to this heading">¶</a></h2>
<p>Adds support <code class="docutils literal notranslate"><span class="pre">/1.0/containers/<name>/exec</span></code> for forwarding signals sent to the
client to the processes executing in the container. Currently SIGTERM and
SIGHUP are forwarded. Further signals that can be forwarded might be added
later.</p>
</section>
<section id="gpu-devices">
<h2><code class="docutils literal notranslate"><span class="pre">gpu_devices</span></code><a class="headerlink" href="#gpu-devices" title="Link to this heading">¶</a></h2>
<p>Enables adding GPUs to a container.</p>
</section>
<section id="container-image-properties">
<h2><code class="docutils literal notranslate"><span class="pre">container_image_properties</span></code><a class="headerlink" href="#container-image-properties" title="Link to this heading">¶</a></h2>
<p>Introduces a new <code class="docutils literal notranslate"><span class="pre">image</span></code> configuration key space. Read-only, includes the properties of the parent image.</p>
</section>
<section id="migration-progress">
<h2><code class="docutils literal notranslate"><span class="pre">migration_progress</span></code><a class="headerlink" href="#migration-progress" title="Link to this heading">¶</a></h2>
<p>Transfer progress is now exported as part of the operation, on both sending and receiving ends.
This shows up as a <code class="docutils literal notranslate"><span class="pre">fs_progress</span></code> attribute in the operation metadata.</p>
</section>
<section id="id-map">
<h2><code class="docutils literal notranslate"><span class="pre">id_map</span></code><a class="headerlink" href="#id-map" title="Link to this heading">¶</a></h2>
<p>Enables setting the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.idmap.isolated"><code class="docutils literal notranslate"><span class="pre">security.idmap.isolated</span></code></a>,
<a class="configref reference internal" href="../reference/instance_options/#instance-security:security.idmap.size"><code class="docutils literal notranslate"><span class="pre">security.idmap.size</span></code></a>, and <a class="configref reference internal" href="../reference/instance_options/#instance-raw:raw.idmap"><code class="docutils literal notranslate"><span class="pre">raw.idmap</span></code></a> fields.</p>
</section>
<section id="network-firewall-filtering">
<h2><code class="docutils literal notranslate"><span class="pre">network_firewall_filtering</span></code><a class="headerlink" href="#network-firewall-filtering" title="Link to this heading">¶</a></h2>
<p>Add two new keys, <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.firewall"><code class="docutils literal notranslate"><span class="pre">ipv4.firewall</span></code></a> and <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv6.firewall"><code class="docutils literal notranslate"><span class="pre">ipv6.firewall</span></code></a> which if set to
<code class="docutils literal notranslate"><span class="pre">false</span></code> will turn off the generation of <code class="docutils literal notranslate"><span class="pre">iptables</span></code> FORWARDING rules. NAT
rules will still be added so long as the matching <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.nat"><code class="docutils literal notranslate"><span class="pre">ipv4.nat</span></code></a> or
<a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv6.nat"><code class="docutils literal notranslate"><span class="pre">ipv6.nat</span></code></a> key is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p>Rules necessary for <code class="docutils literal notranslate"><span class="pre">dnsmasq</span></code> to work (DHCP/DNS) will always be applied if
<code class="docutils literal notranslate"><span class="pre">dnsmasq</span></code> is enabled on the bridge.</p>
</section>
<section id="network-routes">
<h2><code class="docutils literal notranslate"><span class="pre">network_routes</span></code><a class="headerlink" href="#network-routes" title="Link to this heading">¶</a></h2>
<p>Introduces <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.routes"><code class="docutils literal notranslate"><span class="pre">ipv4.routes</span></code></a> and <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv6.routes"><code class="docutils literal notranslate"><span class="pre">ipv6.routes</span></code></a> which allow routing additional subnets to a LXD bridge.</p>
</section>
<section id="storage">
<h2><code class="docutils literal notranslate"><span class="pre">storage</span></code><a class="headerlink" href="#storage" title="Link to this heading">¶</a></h2>
<p>Storage management API for LXD.</p>
<p>This includes:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools</span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/storage-pools/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/storage-pools/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/storage-pools/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<name>/volumes</span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<name>/volumes/<volume_type></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<name>/volumes/<volume_type></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<volume_type>/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<volume_type>/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<volume_type>/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<volume_type>/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<volume_type>/<name></span></code> (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details)</p></li>
<li><p>All storage configuration options (see <a class="reference internal" href="../storage/"><span class="std std-doc">Storage configuration</span></a> for details)</p></li>
</ul>
</section>
<section id="file-delete">
<h2><code class="docutils literal notranslate"><span class="pre">file_delete</span></code><a class="headerlink" href="#file-delete" title="Link to this heading">¶</a></h2>
<p>Implements <code class="docutils literal notranslate"><span class="pre">DELETE</span></code> in <code class="docutils literal notranslate"><span class="pre">/1.0/containers/<name>/files</span></code></p>
</section>
<section id="file-append">
<h2><code class="docutils literal notranslate"><span class="pre">file_append</span></code><a class="headerlink" href="#file-append" title="Link to this heading">¶</a></h2>
<p>Implements the <code class="docutils literal notranslate"><span class="pre">X-LXD-write</span></code> header which can be one of <code class="docutils literal notranslate"><span class="pre">overwrite</span></code> or <code class="docutils literal notranslate"><span class="pre">append</span></code>.</p>
</section>
<section id="network-dhcp-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">network_dhcp_expiry</span></code><a class="headerlink" href="#network-dhcp-expiry" title="Link to this heading">¶</a></h2>
<p>Introduces <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.dhcp.expiry"><code class="docutils literal notranslate"><span class="pre">ipv4.dhcp.expiry</span></code></a> and <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv6.dhcp.expiry"><code class="docutils literal notranslate"><span class="pre">ipv6.dhcp.expiry</span></code></a> allowing to set the DHCP lease expiry time.</p>
</section>
<section id="storage-lvm-vg-rename">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_vg_rename</span></code><a class="headerlink" href="#storage-lvm-vg-rename" title="Link to this heading">¶</a></h2>
<p>Introduces the ability to rename a volume group by setting <a class="configref reference internal" href="../reference/storage_lvm/#storage-lvm-pool-conf:lvm.vg_name"><code class="docutils literal notranslate"><span class="pre">lvm.vg_name</span></code></a>.</p>
</section>
<section id="storage-lvm-thinpool-rename">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_thinpool_rename</span></code><a class="headerlink" href="#storage-lvm-thinpool-rename" title="Link to this heading">¶</a></h2>
<p>Introduces the ability to rename a thin pool name by setting <a class="configref reference internal" href="../reference/storage_lvm/#storage-lvm-pool-conf:lvm.thinpool_name"><code class="docutils literal notranslate"><span class="pre">lvm.thinpool_name</span></code></a>.</p>
</section>
<section id="network-vlan">
<h2><code class="docutils literal notranslate"><span class="pre">network_vlan</span></code><a class="headerlink" href="#network-vlan" title="Link to this heading">¶</a></h2>
<p>This adds a new <a class="configref reference internal" href="../reference/devices_nic/#device-nic-macvlan-device-conf:vlan"><code class="docutils literal notranslate"><span class="pre">vlan</span></code></a> property to <code class="docutils literal notranslate"><span class="pre">macvlan</span></code> network devices.</p>
<p>When set, this will instruct LXD to attach to the specified VLAN. LXD
will look for an existing interface for that VLAN on the host. If one
can’t be found it will create one itself and then use that as the
macvlan parent.</p>
</section>
<section id="image-create-aliases">
<h2><code class="docutils literal notranslate"><span class="pre">image_create_aliases</span></code><a class="headerlink" href="#image-create-aliases" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">aliases</span></code> field to <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/images</span></code> allowing for aliases to
be set at image creation/import time.</p>
</section>
<section id="container-stateless-copy">
<h2><code class="docutils literal notranslate"><span class="pre">container_stateless_copy</span></code><a class="headerlink" href="#container-stateless-copy" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">live</span></code> attribute in <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers/<name></span></code>.
Setting it to <code class="docutils literal notranslate"><span class="pre">false</span></code> tells LXD not to attempt running state transfer.</p>
</section>
<section id="container-only-migration">
<h2><code class="docutils literal notranslate"><span class="pre">container_only_migration</span></code><a class="headerlink" href="#container-only-migration" title="Link to this heading">¶</a></h2>
<p>Introduces a new Boolean <code class="docutils literal notranslate"><span class="pre">container_only</span></code> attribute. When set to <code class="docutils literal notranslate"><span class="pre">true</span></code> only the
container will be copied or moved.</p>
</section>
<section id="storage-zfs-clone-copy">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_clone_copy</span></code><a class="headerlink" href="#storage-zfs-clone-copy" title="Link to this heading">¶</a></h2>
<p>Introduces a new Boolean <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-pool-conf:zfs.clone_copy"><code class="docutils literal notranslate"><span class="pre">zfs.clone_copy</span></code></a> property for ZFS storage
pools. When set to <code class="docutils literal notranslate"><span class="pre">false</span></code> copying a container will be done through <code class="docutils literal notranslate"><span class="pre">zfs</span> <span class="pre">send</span></code> and
receive. This will make the target container independent of its source
container thus avoiding the need to keep dependent snapshots in the ZFS pool
around. However, this also entails less efficient storage usage for the
affected pool.
The default value for this property is <code class="docutils literal notranslate"><span class="pre">true</span></code>, i.e. space-efficient snapshots
will be used unless explicitly set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
</section>
<section id="unix-device-rename">
<h2><code class="docutils literal notranslate"><span class="pre">unix_device_rename</span></code><a class="headerlink" href="#unix-device-rename" title="Link to this heading">¶</a></h2>
<p>Introduces the ability to rename the <code class="docutils literal notranslate"><span class="pre">unix-block</span></code>/<code class="docutils literal notranslate"><span class="pre">unix-char</span></code> device inside container by setting <code class="docutils literal notranslate"><span class="pre">path</span></code>,
and the <code class="docutils literal notranslate"><span class="pre">source</span></code> attribute is added to specify the device on host.
If <code class="docutils literal notranslate"><span class="pre">source</span></code> is set without a <code class="docutils literal notranslate"><span class="pre">path</span></code>, we should assume that <code class="docutils literal notranslate"><span class="pre">path</span></code> will be the same as <code class="docutils literal notranslate"><span class="pre">source</span></code>.
If <code class="docutils literal notranslate"><span class="pre">path</span></code> is set without <code class="docutils literal notranslate"><span class="pre">source</span></code> and <code class="docutils literal notranslate"><span class="pre">major</span></code>/<code class="docutils literal notranslate"><span class="pre">minor</span></code> isn’t set,
we should assume that <code class="docutils literal notranslate"><span class="pre">source</span></code> will be the same as <code class="docutils literal notranslate"><span class="pre">path</span></code>.
So at least one of them must be set.</p>
</section>
<section id="storage-rsync-bwlimit">
<h2><code class="docutils literal notranslate"><span class="pre">storage_rsync_bwlimit</span></code><a class="headerlink" href="#storage-rsync-bwlimit" title="Link to this heading">¶</a></h2>
<p>When <code class="docutils literal notranslate"><span class="pre">rsync</span></code> has to be invoked to transfer storage entities setting <code class="docutils literal notranslate"><span class="pre">rsync.bwlimit</span></code>
places an upper limit on the amount of socket I/O allowed.</p>
</section>
<section id="network-vxlan-interface">
<h2><code class="docutils literal notranslate"><span class="pre">network_vxlan_interface</span></code><a class="headerlink" href="#network-vxlan-interface" title="Link to this heading">¶</a></h2>
<p>This introduces a new <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:tunnel.NAME.interface"><code class="docutils literal notranslate"><span class="pre">tunnel.NAME.interface</span></code></a> option for networks.</p>
<p>This key control what host network interface is used for a VXLAN tunnel.</p>
</section>
<section id="storage-btrfs-mount-options">
<h2><code class="docutils literal notranslate"><span class="pre">storage_btrfs_mount_options</span></code><a class="headerlink" href="#storage-btrfs-mount-options" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/storage_btrfs/#storage-btrfs-pool-conf:btrfs.mount_options"><code class="docutils literal notranslate"><span class="pre">btrfs.mount_options</span></code></a> property for Btrfs storage pools.</p>
<p>This key controls what mount options will be used for the Btrfs storage pool.</p>
</section>
<section id="entity-description">
<h2><code class="docutils literal notranslate"><span class="pre">entity_description</span></code><a class="headerlink" href="#entity-description" title="Link to this heading">¶</a></h2>
<p>This adds descriptions to entities like containers, snapshots, networks, storage pools and volumes.</p>
</section>
<section id="image-force-refresh">
<h2><code class="docutils literal notranslate"><span class="pre">image_force_refresh</span></code><a class="headerlink" href="#image-force-refresh" title="Link to this heading">¶</a></h2>
<p>This allows forcing a refresh for an existing image.</p>
</section>
<section id="storage-lvm-lv-resizing">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_lv_resizing</span></code><a class="headerlink" href="#storage-lvm-lv-resizing" title="Link to this heading">¶</a></h2>
<p>This introduces the ability to resize logical volumes by setting the <code class="docutils literal notranslate"><span class="pre">size</span></code>
property in the containers root disk device.</p>
</section>
<section id="id-map-base">
<h2><code class="docutils literal notranslate"><span class="pre">id_map_base</span></code><a class="headerlink" href="#id-map-base" title="Link to this heading">¶</a></h2>
<p>This introduces a new <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.idmap.base"><code class="docutils literal notranslate"><span class="pre">security.idmap.base</span></code></a> allowing the user to skip the
map auto-selection process for isolated containers and specify what host
UID/GID to use as the base.</p>
</section>
<section id="file-symlinks">
<h2><code class="docutils literal notranslate"><span class="pre">file_symlinks</span></code><a class="headerlink" href="#file-symlinks" title="Link to this heading">¶</a></h2>
<p>This adds support for transferring symlinks through the file API.
X-LXD-type can now be <code class="docutils literal notranslate"><span class="pre">symlink</span></code> with the request content being the target path.</p>
</section>
<section id="container-push-target">
<h2><code class="docutils literal notranslate"><span class="pre">container_push_target</span></code><a class="headerlink" href="#container-push-target" title="Link to this heading">¶</a></h2>
<p>This adds the <code class="docutils literal notranslate"><span class="pre">target</span></code> field to <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers/<name></span></code> which can be
used to have the source LXD host connect to the target during migration.</p>
</section>
<section id="network-vlan-physical">
<h2><code class="docutils literal notranslate"><span class="pre">network_vlan_physical</span></code><a class="headerlink" href="#network-vlan-physical" title="Link to this heading">¶</a></h2>
<p>Allows use of <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:vlan"><code class="docutils literal notranslate"><span class="pre">vlan</span></code></a> property with <code class="docutils literal notranslate"><span class="pre">physical</span></code> network devices.</p>
<p>When set, this will instruct LXD to attach to the specified VLAN on the <code class="docutils literal notranslate"><span class="pre">parent</span></code> interface.
LXD will look for an existing interface for that <code class="docutils literal notranslate"><span class="pre">parent</span></code> and VLAN on the host.
If one can’t be found it will create one itself.
Then, LXD will directly attach this interface to the container.</p>
</section>
<section id="storage-images-delete">
<h2><code class="docutils literal notranslate"><span class="pre">storage_images_delete</span></code><a class="headerlink" href="#storage-images-delete" title="Link to this heading">¶</a></h2>
<p>This enabled the storage API to delete storage volumes for images from
a specific storage pool.</p>
</section>
<section id="container-edit-metadata">
<h2><code class="docutils literal notranslate"><span class="pre">container_edit_metadata</span></code><a class="headerlink" href="#container-edit-metadata" title="Link to this heading">¶</a></h2>
<p>This adds support for editing a container <code class="docutils literal notranslate"><span class="pre">metadata.yaml</span></code> and related templates
via API, by accessing URLs under <code class="docutils literal notranslate"><span class="pre">/1.0/containers/<name>/metadata</span></code>. It can be used
to edit a container before publishing an image from it.</p>
</section>
<section id="container-snapshot-stateful-migration">
<h2><code class="docutils literal notranslate"><span class="pre">container_snapshot_stateful_migration</span></code><a class="headerlink" href="#container-snapshot-stateful-migration" title="Link to this heading">¶</a></h2>
<p>This enables migrating stateful container snapshots to new containers.</p>
</section>
<section id="storage-driver-ceph">
<h2><code class="docutils literal notranslate"><span class="pre">storage_driver_ceph</span></code><a class="headerlink" href="#storage-driver-ceph" title="Link to this heading">¶</a></h2>
<p>This adds a Ceph storage driver.</p>
</section>
<section id="storage-ceph-user-name">
<h2><code class="docutils literal notranslate"><span class="pre">storage_ceph_user_name</span></code><a class="headerlink" href="#storage-ceph-user-name" title="Link to this heading">¶</a></h2>
<p>This adds the ability to specify the Ceph user.</p>
</section>
<section id="instance-types">
<h2><code class="docutils literal notranslate"><span class="pre">instance_types</span></code><a class="headerlink" href="#instance-types" title="Link to this heading">¶</a></h2>
<p>This adds the <code class="docutils literal notranslate"><span class="pre">instance_type</span></code> field to the container creation request.
Its value is expanded to LXD resource limits.</p>
</section>
<section id="storage-volatile-initial-source">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volatile_initial_source</span></code><a class="headerlink" href="#storage-volatile-initial-source" title="Link to this heading">¶</a></h2>
<p>This records the actual source passed to LXD during storage pool creation.</p>
</section>
<section id="storage-ceph-force-osd-reuse">
<h2><code class="docutils literal notranslate"><span class="pre">storage_ceph_force_osd_reuse</span></code><a class="headerlink" href="#storage-ceph-force-osd-reuse" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">ceph.osd.force_reuse</span></code> property for the Ceph storage
driver. When set to <code class="docutils literal notranslate"><span class="pre">true</span></code> LXD will reuse an OSD storage pool that is already in
use by another LXD instance.</p>
</section>
<section id="storage-block-filesystem-btrfs">
<h2><code class="docutils literal notranslate"><span class="pre">storage_block_filesystem_btrfs</span></code><a class="headerlink" href="#storage-block-filesystem-btrfs" title="Link to this heading">¶</a></h2>
<p>This adds support for Btrfs as a storage volume file system, in addition to <code class="docutils literal notranslate"><span class="pre">ext4</span></code>
and <code class="docutils literal notranslate"><span class="pre">xfs</span></code>.</p>
</section>
<section id="resources">
<h2><code class="docutils literal notranslate"><span class="pre">resources</span></code><a class="headerlink" href="#resources" title="Link to this heading">¶</a></h2>
<p>This adds support for querying a LXD daemon for the system resources it has
available.</p>
</section>
<section id="kernel-limits">
<h2><code class="docutils literal notranslate"><span class="pre">kernel_limits</span></code><a class="headerlink" href="#kernel-limits" title="Link to this heading">¶</a></h2>
<p>This adds support for setting process limits such as maximum number of open
files for the container via <code class="docutils literal notranslate"><span class="pre">nofile</span></code>. The format is <code class="docutils literal notranslate"><span class="pre">limits.kernel.[limit</span> <span class="pre">name]</span></code>.</p>
</section>
<section id="storage-api-volume-rename">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_volume_rename</span></code><a class="headerlink" href="#storage-api-volume-rename" title="Link to this heading">¶</a></h2>
<p>This adds support for renaming custom storage volumes.</p>
</section>
<section id="network-sriov">
<h2><code class="docutils literal notranslate"><span class="pre">network_sriov</span></code><a class="headerlink" href="#network-sriov" title="Link to this heading">¶</a></h2>
<p>This adds support for SR-IOV enabled network devices.</p>
</section>
<section id="console">
<h2><code class="docutils literal notranslate"><span class="pre">console</span></code><a class="headerlink" href="#console" title="Link to this heading">¶</a></h2>
<p>This adds support to interact with the container console device and console log.</p>
</section>
<section id="restrict-devlxd">
<h2><code class="docutils literal notranslate"><span class="pre">restrict_devlxd</span></code><a class="headerlink" href="#restrict-devlxd" title="Link to this heading">¶</a></h2>
<p>A new <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> container configuration key was introduced.
The key controls whether the <code class="docutils literal notranslate"><span class="pre">/dev/lxd</span></code> interface is made available to the instance.
If set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, this effectively prevents the container from interacting with the LXD daemon.</p>
</section>
<section id="migration-pre-copy">
<h2><code class="docutils literal notranslate"><span class="pre">migration_pre_copy</span></code><a class="headerlink" href="#migration-pre-copy" title="Link to this heading">¶</a></h2>
<p>This adds support for optimized memory transfer during live migration.</p>
</section>
<section id="infiniband">
<h2><code class="docutils literal notranslate"><span class="pre">infiniband</span></code><a class="headerlink" href="#infiniband" title="Link to this heading">¶</a></h2>
<p>This adds support to use InfiniBand network devices.</p>
</section>
<section id="maas-network">
<h2><code class="docutils literal notranslate"><span class="pre">maas_network</span></code><a class="headerlink" href="#maas-network" title="Link to this heading">¶</a></h2>
<p>This adds support for MAAS network integration.</p>
<p>When configured at the daemon level, it’s then possible to attach a <code class="docutils literal notranslate"><span class="pre">nic</span></code>
device to a particular MAAS subnet.</p>
</section>
<section id="devlxd-events">
<h2><code class="docutils literal notranslate"><span class="pre">devlxd_events</span></code><a class="headerlink" href="#devlxd-events" title="Link to this heading">¶</a></h2>
<p>This adds a WebSocket API to the <code class="docutils literal notranslate"><span class="pre">devlxd</span></code> socket.</p>
<p>When connecting to <code class="docutils literal notranslate"><span class="pre">/1.0/events</span></code> over the <code class="docutils literal notranslate"><span class="pre">devlxd</span></code> socket, you will now be
getting a stream of events over WebSocket.</p>
</section>
<section id="proxy">
<h2><code class="docutils literal notranslate"><span class="pre">proxy</span></code><a class="headerlink" href="#proxy" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">proxy</span></code> device type to containers, allowing forwarding
of connections between the host and container.</p>
</section>
<section id="network-dhcp-gateway">
<h2><code class="docutils literal notranslate"><span class="pre">network_dhcp_gateway</span></code><a class="headerlink" href="#network-dhcp-gateway" title="Link to this heading">¶</a></h2>
<p>Introduces a new <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.dhcp.gateway"><code class="docutils literal notranslate"><span class="pre">ipv4.dhcp.gateway</span></code></a> network configuration key to set an alternate gateway.</p>
</section>
<section id="file-get-symlink">
<h2><code class="docutils literal notranslate"><span class="pre">file_get_symlink</span></code><a class="headerlink" href="#file-get-symlink" title="Link to this heading">¶</a></h2>
<p>This makes it possible to retrieve symlinks using the file API.</p>
</section>
<section id="network-leases">
<h2><code class="docutils literal notranslate"><span class="pre">network_leases</span></code><a class="headerlink" href="#network-leases" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">/1.0/networks/NAME/leases</span></code> API endpoint to query the lease database on
bridges which run a LXD-managed DHCP server.</p>
</section>
<section id="unix-device-hotplug">
<h2><code class="docutils literal notranslate"><span class="pre">unix_device_hotplug</span></code><a class="headerlink" href="#unix-device-hotplug" title="Link to this heading">¶</a></h2>
<p>This adds support for the <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:required"><code class="docutils literal notranslate"><span class="pre">required</span></code></a> property for Unix devices.</p>
</section>
<section id="storage-api-local-volume-handling">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_local_volume_handling</span></code><a class="headerlink" href="#storage-api-local-volume-handling" title="Link to this heading">¶</a></h2>
<p>This add the ability to copy and move custom storage volumes locally in the
same and between storage pools.</p>
</section>
<section id="operation-description">
<h2><code class="docutils literal notranslate"><span class="pre">operation_description</span></code><a class="headerlink" href="#operation-description" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">description</span></code> field to all operations.</p>
</section>
<section id="clustering">
<h2><code class="docutils literal notranslate"><span class="pre">clustering</span></code><a class="headerlink" href="#clustering" title="Link to this heading">¶</a></h2>
<p>Clustering API for LXD.</p>
<p>This includes the following new endpoints (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/cluster</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UPDATE</span> <span class="pre">/1.0/cluster</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/cluster/members</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/cluster/members/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/cluster/members/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/cluster/members/<name></span></code></p></li>
</ul>
<p>The following existing endpoints have been modified:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers</span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools</span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pool/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pool/<pool>/volumes/<type></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pool/<pool>/volumes/<type>/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pool/<pool>/volumes/<type>/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/storage-pool/<pool>/volumes/<type>/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/storage-pool/<pool>/volumes/<type>/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/storage-pool/<pool>/volumes/<type>/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/networks</span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/networks/<name></span></code> accepts a new <code class="docutils literal notranslate"><span class="pre">target</span></code> query parameter</p></li>
</ul>
</section>
<section id="event-lifecycle">
<h2><code class="docutils literal notranslate"><span class="pre">event_lifecycle</span></code><a class="headerlink" href="#event-lifecycle" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">lifecycle</span></code> message type to the events API.</p>
</section>
<section id="storage-api-remote-volume-handling">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_remote_volume_handling</span></code><a class="headerlink" href="#storage-api-remote-volume-handling" title="Link to this heading">¶</a></h2>
<p>This adds the ability to copy and move custom storage volumes between remote.</p>
</section>
<section id="nvidia-runtime">
<h2><code class="docutils literal notranslate"><span class="pre">nvidia_runtime</span></code><a class="headerlink" href="#nvidia-runtime" title="Link to this heading">¶</a></h2>
<p>Adds a <a class="configref reference internal" href="../reference/instance_options/#instance-nvidia:nvidia.runtime"><code class="docutils literal notranslate"><span class="pre">nvidia.runtime</span></code></a> configuration option for containers, setting this to
<code class="docutils literal notranslate"><span class="pre">true</span></code> will have the NVIDIA runtime and CUDA libraries passed to the
container.</p>
</section>
<section id="container-mount-propagation">
<h2><code class="docutils literal notranslate"><span class="pre">container_mount_propagation</span></code><a class="headerlink" href="#container-mount-propagation" title="Link to this heading">¶</a></h2>
<p>This adds a new <a class="configref reference internal" href="../reference/devices_disk/#device-disk-device-conf:propagation"><code class="docutils literal notranslate"><span class="pre">propagation</span></code></a> option to the disk device type, allowing
the configuration of kernel mount propagation.</p>
</section>
<section id="container-backup">
<h2><code class="docutils literal notranslate"><span class="pre">container_backup</span></code><a class="headerlink" href="#container-backup" title="Link to this heading">¶</a></h2>
<p>Add container backup support.</p>
<p>This includes the following new endpoints (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/containers/<name>/backups</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers/<name>/backups</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/containers/<name>/backups/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers/<name>/backups/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/containers/<name>/backups/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/containers/<name>/backups/<name>/export</span></code></p></li>
</ul>
<p>The following existing endpoint has been modified:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers</span></code> accepts the new source type <code class="docutils literal notranslate"><span class="pre">backup</span></code></p></li>
</ul>
</section>
<section id="devlxd-images">
<h2><code class="docutils literal notranslate"><span class="pre">devlxd_images</span></code><a class="headerlink" href="#devlxd-images" title="Link to this heading">¶</a></h2>
<p>Adds a <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> configuration option for containers which
controls the availability of a <code class="docutils literal notranslate"><span class="pre">/1.0/images/FINGERPRINT/export</span></code> API over
<code class="docutils literal notranslate"><span class="pre">devlxd</span></code>. This can be used by a container running nested LXD to access raw
images from the host.</p>
</section>
<section id="container-local-cross-pool-handling">
<h2><code class="docutils literal notranslate"><span class="pre">container_local_cross_pool_handling</span></code><a class="headerlink" href="#container-local-cross-pool-handling" title="Link to this heading">¶</a></h2>
<p>This enables copying or moving containers between storage pools on the same LXD
instance.</p>
</section>
<section id="proxy-unix">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_unix</span></code><a class="headerlink" href="#proxy-unix" title="Link to this heading">¶</a></h2>
<p>Add support for both Unix sockets and abstract Unix sockets in proxy devices.
They can be used by specifying the address as <code class="docutils literal notranslate"><span class="pre">unix:/path/to/unix.sock</span></code> (normal
socket) or <code class="docutils literal notranslate"><span class="pre">unix:@/tmp/unix.sock</span></code> (abstract socket).</p>
<p>Supported connections are now:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">TCP</span> <span class="pre"><-></span> <span class="pre">TCP</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UNIX</span> <span class="pre"><-></span> <span class="pre">UNIX</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">TCP</span> <span class="pre"><-></span> <span class="pre">UNIX</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UNIX</span> <span class="pre"><-></span> <span class="pre">TCP</span></code></p></li>
</ul>
</section>
<section id="proxy-udp">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_udp</span></code><a class="headerlink" href="#proxy-udp" title="Link to this heading">¶</a></h2>
<p>Add support for UDP in proxy devices.</p>
<p>Supported connections are now:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">TCP</span> <span class="pre"><-></span> <span class="pre">TCP</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UNIX</span> <span class="pre"><-></span> <span class="pre">UNIX</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">TCP</span> <span class="pre"><-></span> <span class="pre">UNIX</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UNIX</span> <span class="pre"><-></span> <span class="pre">TCP</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UDP</span> <span class="pre"><-></span> <span class="pre">UDP</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">TCP</span> <span class="pre"><-></span> <span class="pre">UDP</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">UNIX</span> <span class="pre"><-></span> <span class="pre">UDP</span></code></p></li>
</ul>
</section>
<section id="clustering-join">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_join</span></code><a class="headerlink" href="#clustering-join" title="Link to this heading">¶</a></h2>
<p>This makes <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/cluster</span></code> return information about which storage pools and
networks are required to be created by joining nodes and which node-specific
configuration keys they are required to use when creating them. Likewise the <code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/cluster</span></code> endpoint now accepts the same format to pass information about
storage pools and networks to be automatically created before attempting to join
a cluster.</p>
</section>
<section id="proxy-tcp-udp-multi-port-handling">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_tcp_udp_multi_port_handling</span></code><a class="headerlink" href="#proxy-tcp-udp-multi-port-handling" title="Link to this heading">¶</a></h2>
<p>Adds support for forwarding traffic for multiple ports. Forwarding is allowed
between a range of ports if the port range is equal for source and target
(for example <code class="docutils literal notranslate"><span class="pre">1.2.3.4</span> <span class="pre">0-1000</span> <span class="pre">-></span> <span class="pre">5.6.7.8</span> <span class="pre">1000-2000</span></code>) and between a range of source
ports and a single target port (for example <code class="docutils literal notranslate"><span class="pre">1.2.3.4</span> <span class="pre">0-1000</span> <span class="pre">-></span> <span class="pre">5.6.7.8</span> <span class="pre">1000</span></code>).</p>
</section>
<section id="network-state">
<h2><code class="docutils literal notranslate"><span class="pre">network_state</span></code><a class="headerlink" href="#network-state" title="Link to this heading">¶</a></h2>
<p>Adds support for retrieving a network’s state.</p>
<p>This adds the following new endpoint (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/networks/<name>/state</span></code></p></li>
</ul>
</section>
<section id="proxy-unix-dac-properties">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_unix_dac_properties</span></code><a class="headerlink" href="#proxy-unix-dac-properties" title="Link to this heading">¶</a></h2>
<p>This adds support for GID, UID, and mode properties for non-abstract Unix
sockets.</p>
</section>
<section id="container-protection-delete">
<h2><code class="docutils literal notranslate"><span class="pre">container_protection_delete</span></code><a class="headerlink" href="#container-protection-delete" title="Link to this heading">¶</a></h2>
<p>Enables setting the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.protection.delete"><code class="docutils literal notranslate"><span class="pre">security.protection.delete</span></code></a> field which prevents containers
from being deleted if set to <code class="docutils literal notranslate"><span class="pre">true</span></code>. Snapshots are not affected by this setting.</p>
</section>
<section id="proxy-priv-drop">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_priv_drop</span></code><a class="headerlink" href="#proxy-priv-drop" title="Link to this heading">¶</a></h2>
<p>Adds <a class="configref reference internal" href="../reference/devices_proxy/#device-proxy-device-conf:security.uid"><code class="docutils literal notranslate"><span class="pre">security.uid</span></code></a> and <a class="configref reference internal" href="../reference/devices_proxy/#device-proxy-device-conf:security.gid"><code class="docutils literal notranslate"><span class="pre">security.gid</span></code></a> for the proxy devices, allowing
privilege dropping and effectively changing the UID/GID used for
connections to Unix sockets too.</p>
</section>
<section id="pprof-http">
<h2><code class="docutils literal notranslate"><span class="pre">pprof_http</span></code><a class="headerlink" href="#pprof-http" title="Link to this heading">¶</a></h2>
<p>This adds a new <a class="configref reference internal" href="../server/#server-core:core.debug_address"><code class="docutils literal notranslate"><span class="pre">core.debug_address</span></code></a> configuration option to start a debugging HTTP server.</p>
<p>That server currently includes a <code class="docutils literal notranslate"><span class="pre">pprof</span></code> API and replaces the old
<code class="docutils literal notranslate"><span class="pre">cpu-profile</span></code>, <code class="docutils literal notranslate"><span class="pre">memory-profile</span></code> and <code class="docutils literal notranslate"><span class="pre">print-goroutines</span></code> debug options.</p>
</section>
<section id="proxy-haproxy-protocol">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_haproxy_protocol</span></code><a class="headerlink" href="#proxy-haproxy-protocol" title="Link to this heading">¶</a></h2>
<p>Adds a <a class="configref reference internal" href="../reference/devices_proxy/#device-proxy-device-conf:proxy_protocol"><code class="docutils literal notranslate"><span class="pre">proxy_protocol</span></code></a> key to the proxy device which controls the use of the HAProxy PROXY protocol header.</p>
</section>
<section id="network-hwaddr">
<h2><code class="docutils literal notranslate"><span class="pre">network_hwaddr</span></code><a class="headerlink" href="#network-hwaddr" title="Link to this heading">¶</a></h2>
<p>Adds a <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:bridge.hwaddr"><code class="docutils literal notranslate"><span class="pre">bridge.hwaddr</span></code></a> key to control the MAC address of the bridge.</p>
</section>
<section id="proxy-nat">
<h2><code class="docutils literal notranslate"><span class="pre">proxy_nat</span></code><a class="headerlink" href="#proxy-nat" title="Link to this heading">¶</a></h2>
<p>This adds optimized UDP/TCP proxying. If the configuration allows, proxying
will be done via <code class="docutils literal notranslate"><span class="pre">iptables</span></code> instead of proxy devices.</p>
</section>
<section id="network-nat-order">
<h2><code class="docutils literal notranslate"><span class="pre">network_nat_order</span></code><a class="headerlink" href="#network-nat-order" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.nat.order"><code class="docutils literal notranslate"><span class="pre">ipv4.nat.order</span></code></a> and <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv6.nat.order"><code class="docutils literal notranslate"><span class="pre">ipv6.nat.order</span></code></a> configuration keys for LXD bridges.
Those keys control whether to put the LXD rules before or after any pre-existing rules in the chain.</p>
</section>
<section id="container-full">
<h2><code class="docutils literal notranslate"><span class="pre">container_full</span></code><a class="headerlink" href="#container-full" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">recursion=2</span></code> mode for <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/containers</span></code> which allows for the retrieval of
all container structs, including the state, snapshots and backup structs.</p>
<p>This effectively allows for <a class="reference internal" href="../reference/manpages/lxc/list/#lxc-list-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">list</span></code></span></a> to get all it needs in one query.</p>
</section>
<section id="backup-compression">
<h2><code class="docutils literal notranslate"><span class="pre">backup_compression</span></code><a class="headerlink" href="#backup-compression" title="Link to this heading">¶</a></h2>
<p>This introduces a new <a class="configref reference internal" href="../server/#server-miscellaneous:backups.compression_algorithm"><code class="docutils literal notranslate"><span class="pre">backups.compression_algorithm</span></code></a> configuration key which
allows configuration of backup compression.</p>
</section>
<section id="nvidia-runtime-config">
<h2><code class="docutils literal notranslate"><span class="pre">nvidia_runtime_config</span></code><a class="headerlink" href="#nvidia-runtime-config" title="Link to this heading">¶</a></h2>
<p>This introduces a few extra configuration keys when using <a class="configref reference internal" href="../reference/instance_options/#instance-nvidia:nvidia.runtime"><code class="docutils literal notranslate"><span class="pre">nvidia.runtime</span></code></a> and the <code class="docutils literal notranslate"><span class="pre">libnvidia-container</span></code> library.
Those keys translate pretty much directly to the matching NVIDIA container environment variables:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-nvidia:nvidia.driver.capabilities"><code class="docutils literal notranslate"><span class="pre">nvidia.driver.capabilities</span></code></a> => <code class="docutils literal notranslate"><span class="pre">NVIDIA_DRIVER_CAPABILITIES</span></code></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-nvidia:nvidia.require.cuda"><code class="docutils literal notranslate"><span class="pre">nvidia.require.cuda</span></code></a> => <code class="docutils literal notranslate"><span class="pre">NVIDIA_REQUIRE_CUDA</span></code></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-nvidia:nvidia.require.driver"><code class="docutils literal notranslate"><span class="pre">nvidia.require.driver</span></code></a> => <code class="docutils literal notranslate"><span class="pre">NVIDIA_REQUIRE_DRIVER</span></code></p></li>
</ul>
</section>
<section id="storage-api-volume-snapshots">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_volume_snapshots</span></code><a class="headerlink" href="#storage-api-volume-snapshots" title="Link to this heading">¶</a></h2>
<p>Add support for storage volume snapshots. They work like container snapshots,
only for volumes.</p>
<p>This adds the following new endpoint (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<type>/<name>/snapshots</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<type>/<name>/snapshots</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<type>/<volume>/snapshots/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<type>/<volume>/snapshots/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<type>/<volume>/snapshots/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/storage-pools/<pool>/volumes/<type>/<volume>/snapshots/<name></span></code></p></li>
</ul>
</section>
<section id="storage-unmapped">
<h2><code class="docutils literal notranslate"><span class="pre">storage_unmapped</span></code><a class="headerlink" href="#storage-unmapped" title="Link to this heading">¶</a></h2>
<p>Introduces a new <code class="docutils literal notranslate"><span class="pre">security.unmapped</span></code> Boolean on storage volumes.</p>
<p>Setting it to <code class="docutils literal notranslate"><span class="pre">true</span></code> will flush the current map on the volume and prevent
any further idmap tracking and remapping on the volume.</p>
<p>This can be used to share data between isolated containers after
attaching it to the container which requires write access.</p>
</section>
<section id="projects">
<h2><code class="docutils literal notranslate"><span class="pre">projects</span></code><a class="headerlink" href="#projects" title="Link to this heading">¶</a></h2>
<p>Add a new project API, supporting creation, update and deletion of projects.</p>
<p>Projects can hold containers, profiles or images at this point and let
you get a separate view of your LXD resources by switching to it.</p>
</section>
<section id="network-vxlan-ttl">
<h2><code class="docutils literal notranslate"><span class="pre">network_vxlan_ttl</span></code><a class="headerlink" href="#network-vxlan-ttl" title="Link to this heading">¶</a></h2>
<p>This adds a new <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:tunnel.NAME.ttl"><code class="docutils literal notranslate"><span class="pre">tunnel.NAME.ttl</span></code></a> network configuration option which
makes it possible to raise the TTL on VXLAN tunnels.</p>
</section>
<section id="container-incremental-copy">
<h2><code class="docutils literal notranslate"><span class="pre">container_incremental_copy</span></code><a class="headerlink" href="#container-incremental-copy" title="Link to this heading">¶</a></h2>
<p>This adds support for incremental container copy. When copying a container
using the <code class="docutils literal notranslate"><span class="pre">--refresh</span></code> flag, only the missing or outdated files will be
copied over. Should the target container not exist yet, a normal copy operation
is performed.</p>
</section>
<section id="usb-optional-vendorid">
<h2><code class="docutils literal notranslate"><span class="pre">usb_optional_vendorid</span></code><a class="headerlink" href="#usb-optional-vendorid" title="Link to this heading">¶</a></h2>
<p>As the name implies, the <a class="configref reference internal" href="../reference/devices_usb/#device-unix-usb-device-conf:vendorid"><code class="docutils literal notranslate"><span class="pre">vendorid</span></code></a> field on USB devices attached to
containers has now been made optional, allowing for all USB devices to
be passed to a container (similar to what’s done for GPUs).</p>
</section>
<section id="snapshot-scheduling">
<h2><code class="docutils literal notranslate"><span class="pre">snapshot_scheduling</span></code><a class="headerlink" href="#snapshot-scheduling" title="Link to this heading">¶</a></h2>
<p>This adds support for snapshot scheduling. It introduces three new
configuration keys: <code class="docutils literal notranslate"><span class="pre">snapshots.schedule</span></code>, <code class="docutils literal notranslate"><span class="pre">snapshots.schedule.stopped</span></code>, and
<code class="docutils literal notranslate"><span class="pre">snapshots.pattern</span></code>. Snapshots can be created automatically up to every minute.</p>
</section>
<section id="snapshots-schedule-aliases">
<h2><code class="docutils literal notranslate"><span class="pre">snapshots_schedule_aliases</span></code><a class="headerlink" href="#snapshots-schedule-aliases" title="Link to this heading">¶</a></h2>
<p>Snapshot schedule can be configured by a comma-separated list of schedule aliases.
Available aliases are <code class="docutils literal notranslate"><span class="pre"><@hourly></span> <span class="pre"><@daily></span> <span class="pre"><@midnight></span> <span class="pre"><@weekly></span> <span class="pre"><@monthly></span> <span class="pre"><@annually></span> <span class="pre"><@yearly></span> <span class="pre"><@startup></span></code> for instances,
and <code class="docutils literal notranslate"><span class="pre"><@hourly></span> <span class="pre"><@daily></span> <span class="pre"><@midnight></span> <span class="pre"><@weekly></span> <span class="pre"><@monthly></span> <span class="pre"><@annually></span> <span class="pre"><@yearly></span></code> for storage volumes.</p>
</section>
<section id="container-copy-project">
<h2><code class="docutils literal notranslate"><span class="pre">container_copy_project</span></code><a class="headerlink" href="#container-copy-project" title="Link to this heading">¶</a></h2>
<p>Introduces a <code class="docutils literal notranslate"><span class="pre">project</span></code> field to the container source JSON object, allowing for
copy/move of containers between projects.</p>
</section>
<section id="clustering-server-address">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_server_address</span></code><a class="headerlink" href="#clustering-server-address" title="Link to this heading">¶</a></h2>
<p>This adds support for configuring a server network address which differs from
the REST API client network address. When bootstrapping a new cluster, clients
can set the new <a class="configref reference internal" href="../server/#server-cluster:cluster.https_address"><code class="docutils literal notranslate"><span class="pre">cluster.https_address</span></code></a> configuration key to specify the address of
the initial server. When joining a new server, clients can set the
<a class="configref reference internal" href="../server/#server-core:core.https_address"><code class="docutils literal notranslate"><span class="pre">core.https_address</span></code></a> configuration key of the joining server to the REST API
address the joining server should listen at, and set the <code class="docutils literal notranslate"><span class="pre">server_address</span></code>
key in the <code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/cluster</span></code> API to the address the joining server should
use for clustering traffic (the value of <code class="docutils literal notranslate"><span class="pre">server_address</span></code> will be
automatically copied to the <code class="docutils literal notranslate"><span class="pre">cluster.https_address</span></code> configuration key of the
joining server).</p>
</section>
<section id="clustering-image-replication">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_image_replication</span></code><a class="headerlink" href="#clustering-image-replication" title="Link to this heading">¶</a></h2>
<p>Enable image replication across the nodes in the cluster.
A new <a class="configref reference internal" href="../server/#server-cluster:cluster.images_minimal_replica"><code class="docutils literal notranslate"><span class="pre">cluster.images_minimal_replica</span></code></a> configuration key was introduced can be used
to specify to the minimal numbers of nodes for image replication.</p>
</section>
<section id="container-protection-shift">
<h2><code class="docutils literal notranslate"><span class="pre">container_protection_shift</span></code><a class="headerlink" href="#container-protection-shift" title="Link to this heading">¶</a></h2>
<p>Enables setting the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.protection.shift"><code class="docutils literal notranslate"><span class="pre">security.protection.shift</span></code></a> option which prevents containers
from having their file system shifted.</p>
</section>
<section id="snapshot-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">snapshot_expiry</span></code><a class="headerlink" href="#snapshot-expiry" title="Link to this heading">¶</a></h2>
<p>This adds support for snapshot expiration. The task is run minutely. The configuration
option <a class="configref reference internal" href="../reference/instance_options/#instance-snapshots:snapshots.expiry"><code class="docutils literal notranslate"><span class="pre">snapshots.expiry</span></code></a> takes an expression in the form of <code class="docutils literal notranslate"><span class="pre">1M</span> <span class="pre">2H</span> <span class="pre">3d</span> <span class="pre">4w</span> <span class="pre">5m</span> <span class="pre">6y</span></code> (1 minute, 2 hours, 3 days, 4 weeks, 5 months, 6 years), however not all
parts have to be used.</p>
<p>Snapshots which are then created will be given an expiry date based on the
expression. This expiry date, defined by <code class="docutils literal notranslate"><span class="pre">expires_at</span></code>, can be manually edited
using the API or <a class="reference internal" href="../reference/manpages/lxc/config/edit/#lxc-config-edit-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">config</span> <span class="pre">edit</span></code></span></a>. Snapshots with a valid expiry date will be
removed when the task in run. Expiry can be disabled by setting <code class="docutils literal notranslate"><span class="pre">expires_at</span></code> to
an empty string or <code class="docutils literal notranslate"><span class="pre">0001-01-01T00:00:00Z</span></code> (zero time). This is the default if
<code class="docutils literal notranslate"><span class="pre">snapshots.expiry</span></code> is not set.</p>
<p>This adds the following new endpoint (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/containers/<name>/snapshots/<name></span></code></p></li>
</ul>
</section>
<section id="snapshot-expiry-creation">
<h2><code class="docutils literal notranslate"><span class="pre">snapshot_expiry_creation</span></code><a class="headerlink" href="#snapshot-expiry-creation" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">expires_at</span></code> to container creation, allowing for override of a
snapshot’s expiry at creation time.</p>
</section>
<section id="network-leases-location">
<h2><code class="docutils literal notranslate"><span class="pre">network_leases_location</span></code><a class="headerlink" href="#network-leases-location" title="Link to this heading">¶</a></h2>
<p>Introduces a <code class="docutils literal notranslate"><span class="pre">Location</span></code> field in the leases list.
This is used when querying a cluster to show what node a particular
lease was found on.</p>
</section>
<section id="resources-cpu-socket">
<h2><code class="docutils literal notranslate"><span class="pre">resources_cpu_socket</span></code><a class="headerlink" href="#resources-cpu-socket" title="Link to this heading">¶</a></h2>
<p>Add Socket field to CPU resources in case we get out of order socket information.</p>
</section>
<section id="resources-gpu">
<h2><code class="docutils literal notranslate"><span class="pre">resources_gpu</span></code><a class="headerlink" href="#resources-gpu" title="Link to this heading">¶</a></h2>
<p>Add a new GPU struct to the server resources, listing all usable GPUs on the system.</p>
</section>
<section id="resources-numa">
<h2><code class="docutils literal notranslate"><span class="pre">resources_numa</span></code><a class="headerlink" href="#resources-numa" title="Link to this heading">¶</a></h2>
<p>Shows the NUMA node for all CPUs and GPUs.</p>
</section>
<section id="kernel-features">
<h2><code class="docutils literal notranslate"><span class="pre">kernel_features</span></code><a class="headerlink" href="#kernel-features" title="Link to this heading">¶</a></h2>
<p>Exposes the state of optional kernel features through the server environment.</p>
</section>
<section id="id-map-current">
<h2><code class="docutils literal notranslate"><span class="pre">id_map_current</span></code><a class="headerlink" href="#id-map-current" title="Link to this heading">¶</a></h2>
<p>This introduces a new internal <a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.idmap.current"><code class="docutils literal notranslate"><span class="pre">volatile.idmap.current</span></code></a> key which is
used to track the current mapping for the container.</p>
<p>This effectively gives us:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.last_state.idmap"><code class="docutils literal notranslate"><span class="pre">volatile.last_state.idmap</span></code></a> => On-disk idmap</p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.idmap.current"><code class="docutils literal notranslate"><span class="pre">volatile.idmap.current</span></code></a> => Current kernel map</p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.idmap.next"><code class="docutils literal notranslate"><span class="pre">volatile.idmap.next</span></code></a> => Next on-disk idmap</p></li>
</ul>
<p>This is required to implement environments where the on-disk map isn’t
changed but the kernel map is (e.g. <code class="docutils literal notranslate"><span class="pre">idmapped</span> <span class="pre">mounts</span></code>).</p>
</section>
<section id="event-location">
<h2><code class="docutils literal notranslate"><span class="pre">event_location</span></code><a class="headerlink" href="#event-location" title="Link to this heading">¶</a></h2>
<p>Expose the location of the generation of API events.</p>
</section>
<section id="storage-api-remote-volume-snapshots">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_remote_volume_snapshots</span></code><a class="headerlink" href="#storage-api-remote-volume-snapshots" title="Link to this heading">¶</a></h2>
<p>This allows migrating storage volumes including their snapshots.</p>
</section>
<section id="network-nat-address">
<h2><code class="docutils literal notranslate"><span class="pre">network_nat_address</span></code><a class="headerlink" href="#network-nat-address" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv4.nat.address"><code class="docutils literal notranslate"><span class="pre">ipv4.nat.address</span></code></a> and <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:ipv6.nat.address"><code class="docutils literal notranslate"><span class="pre">ipv6.nat.address</span></code></a> configuration keys for LXD bridges.
Those keys control the source address used for outbound traffic from the bridge.</p>
</section>
<section id="container-nic-routes">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_routes</span></code><a class="headerlink" href="#container-nic-routes" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:ipv4.routes"><code class="docutils literal notranslate"><span class="pre">ipv4.routes</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:ipv6.routes"><code class="docutils literal notranslate"><span class="pre">ipv6.routes</span></code></a> properties on <code class="docutils literal notranslate"><span class="pre">nic</span></code> type devices.
This allows adding static routes on host to container’s NIC.</p>
</section>
<section id="cluster-internal-copy">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_internal_copy</span></code><a class="headerlink" href="#cluster-internal-copy" title="Link to this heading">¶</a></h2>
<p>This makes it possible to do a normal <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers</span></code> to copy a
container between cluster nodes with LXD internally detecting whether a
migration is required.</p>
</section>
<section id="seccomp-notify">
<h2><code class="docutils literal notranslate"><span class="pre">seccomp_notify</span></code><a class="headerlink" href="#seccomp-notify" title="Link to this heading">¶</a></h2>
<p>If the kernel supports <code class="docutils literal notranslate"><span class="pre">seccomp</span></code>-based syscall interception LXD can be notified
by a container that a registered syscall has been performed. LXD can then
decide to trigger various actions.</p>
</section>
<section id="lxc-features">
<h2><code class="docutils literal notranslate"><span class="pre">lxc_features</span></code><a class="headerlink" href="#lxc-features" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">lxc_features</span></code> section output from the <a class="reference internal" href="../reference/manpages/lxc/info/#lxc-info-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">info</span></code></span></a> command
via the <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0</span></code> route. It outputs the result of checks for key features being present in the
underlying LXC library.</p>
</section>
<section id="container-nic-ipvlan">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan</span></code><a class="headerlink" href="#container-nic-ipvlan" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">ipvlan</span></code> <code class="docutils literal notranslate"><span class="pre">nic</span></code> device type.</p>
</section>
<section id="network-vlan-sriov">
<h2><code class="docutils literal notranslate"><span class="pre">network_vlan_sriov</span></code><a class="headerlink" href="#network-vlan-sriov" title="Link to this heading">¶</a></h2>
<p>This introduces VLAN (<a class="configref reference internal" href="../reference/devices_nic/#device-nic-sriov-device-conf:vlan"><code class="docutils literal notranslate"><span class="pre">vlan</span></code></a>) and MAC filtering (<a class="configref reference internal" href="../reference/devices_nic/#device-nic-sriov-device-conf:security.mac_filtering"><code class="docutils literal notranslate"><span class="pre">security.mac_filtering</span></code></a>) support for SR-IOV devices.</p>
</section>
<section id="storage-cephfs">
<h2><code class="docutils literal notranslate"><span class="pre">storage_cephfs</span></code><a class="headerlink" href="#storage-cephfs" title="Link to this heading">¶</a></h2>
<p>Add support for CephFS as a storage pool driver. This can only be used
for custom volumes, images and containers should be on Ceph (RBD)
instead.</p>
</section>
<section id="container-nic-ipfilter">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_ipfilter</span></code><a class="headerlink" href="#container-nic-ipfilter" title="Link to this heading">¶</a></h2>
<p>This introduces container IP filtering (<a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:security.ipv4_filtering"><code class="docutils literal notranslate"><span class="pre">security.ipv4_filtering</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:security.ipv6_filtering"><code class="docutils literal notranslate"><span class="pre">security.ipv6_filtering</span></code></a>) support for <code class="docutils literal notranslate"><span class="pre">bridged</span></code> NIC devices.</p>
</section>
<section id="resources-v2">
<h2><code class="docutils literal notranslate"><span class="pre">resources_v2</span></code><a class="headerlink" href="#resources-v2" title="Link to this heading">¶</a></h2>
<p>Rework the resources API at <code class="docutils literal notranslate"><span class="pre">/1.0/resources</span></code>, especially:</p>
<ul class="simple">
<li><p>CPU</p>
<ul>
<li><p>Fix reporting to track sockets, cores and threads</p></li>
<li><p>Track NUMA node per core</p></li>
<li><p>Track base and turbo frequency per socket</p></li>
<li><p>Track current frequency per core</p></li>
<li><p>Add CPU cache information</p></li>
<li><p>Export the CPU architecture</p></li>
<li><p>Show online/offline status of threads</p></li>
</ul>
</li>
<li><p>Memory</p>
<ul>
<li><p>Add huge-pages tracking</p></li>
<li><p>Track memory consumption per NUMA node too</p></li>
</ul>
</li>
<li><p>GPU</p>
<ul>
<li><p>Split DRM information to separate struct</p></li>
<li><p>Export device names and nodes in DRM struct</p></li>
<li><p>Export device name and node in NVIDIA struct</p></li>
<li><p>Add SR-IOV VF tracking</p></li>
</ul>
</li>
</ul>
</section>
<section id="container-exec-user-group-cwd">
<h2><code class="docutils literal notranslate"><span class="pre">container_exec_user_group_cwd</span></code><a class="headerlink" href="#container-exec-user-group-cwd" title="Link to this heading">¶</a></h2>
<p>Adds support for specifying <code class="docutils literal notranslate"><span class="pre">User</span></code>, <code class="docutils literal notranslate"><span class="pre">Group</span></code> and <code class="docutils literal notranslate"><span class="pre">Cwd</span></code> during <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers/NAME/exec</span></code>.</p>
</section>
<section id="container-syscall-intercept">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept</span></code><a class="headerlink" href="#container-syscall-intercept" title="Link to this heading">¶</a></h2>
<p>Adds the <code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.*</span></code> configuration keys to control
what system calls will be intercepted by LXD and processed with
elevated permissions.</p>
</section>
<section id="container-disk-shift">
<h2><code class="docutils literal notranslate"><span class="pre">container_disk_shift</span></code><a class="headerlink" href="#container-disk-shift" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/devices_disk/#device-disk-device-conf:shift"><code class="docutils literal notranslate"><span class="pre">shift</span></code></a> property on <code class="docutils literal notranslate"><span class="pre">disk</span></code> devices which controls the use of the <code class="docutils literal notranslate"><span class="pre">idmapped</span> <span class="pre">mounts</span></code> overlay.</p>
</section>
<section id="storage-shifted">
<h2><code class="docutils literal notranslate"><span class="pre">storage_shifted</span></code><a class="headerlink" href="#storage-shifted" title="Link to this heading">¶</a></h2>
<p>Introduces a new <code class="docutils literal notranslate"><span class="pre">security.shifted</span></code> Boolean on storage volumes.</p>
<p>Setting it to <code class="docutils literal notranslate"><span class="pre">true</span></code> will allow multiple isolated containers to attach the
same storage volume while keeping the file system writable from all of
them.</p>
<p>This makes use of <code class="docutils literal notranslate"><span class="pre">idmapped</span> <span class="pre">mounts</span></code> as an overlay file system.</p>
</section>
<section id="resources-infiniband">
<h2><code class="docutils literal notranslate"><span class="pre">resources_infiniband</span></code><a class="headerlink" href="#resources-infiniband" title="Link to this heading">¶</a></h2>
<p>Export InfiniBand character device information (<code class="docutils literal notranslate"><span class="pre">issm</span></code>, <code class="docutils literal notranslate"><span class="pre">umad</span></code>, <code class="docutils literal notranslate"><span class="pre">uverb</span></code>) as part of the resources API.</p>
</section>
<section id="daemon-storage">
<h2><code class="docutils literal notranslate"><span class="pre">daemon_storage</span></code><a class="headerlink" href="#daemon-storage" title="Link to this heading">¶</a></h2>
<p>This introduces two new configuration keys <a class="configref reference internal" href="../server/#server-miscellaneous:storage.images_volume"><code class="docutils literal notranslate"><span class="pre">storage.images_volume</span></code></a> and
<a class="configref reference internal" href="../server/#server-miscellaneous:storage.backups_volume"><code class="docutils literal notranslate"><span class="pre">storage.backups_volume</span></code></a> to allow for a storage volume on an existing
pool be used for storing the daemon-wide images and backups artifacts.</p>
</section>
<section id="instances">
<h2><code class="docutils literal notranslate"><span class="pre">instances</span></code><a class="headerlink" href="#instances" title="Link to this heading">¶</a></h2>
<p>This introduces the concept of instances, of which currently the only type is <code class="docutils literal notranslate"><span class="pre">container</span></code>.</p>
</section>
<section id="image-types">
<h2><code class="docutils literal notranslate"><span class="pre">image_types</span></code><a class="headerlink" href="#image-types" title="Link to this heading">¶</a></h2>
<p>This introduces support for a new Type field on images, indicating what type of images they are.</p>
</section>
<section id="resources-disk-sata">
<h2><code class="docutils literal notranslate"><span class="pre">resources_disk_sata</span></code><a class="headerlink" href="#resources-disk-sata" title="Link to this heading">¶</a></h2>
<p>Extends the disk resource API struct to include:</p>
<ul class="simple">
<li><p>Proper detection of SATA devices (type)</p></li>
<li><p>Device path</p></li>
<li><p>Drive RPM</p></li>
<li><p>Block size</p></li>
<li><p>Firmware version</p></li>
<li><p>Serial number</p></li>
</ul>
</section>
<section id="clustering-roles">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_roles</span></code><a class="headerlink" href="#clustering-roles" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">roles</span></code> attribute to cluster entries, exposing a list of
roles that the member serves in the cluster.</p>
</section>
<section id="images-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">images_expiry</span></code><a class="headerlink" href="#images-expiry" title="Link to this heading">¶</a></h2>
<p>This allows for editing of the expiry date on images.</p>
</section>
<section id="resources-network-firmware">
<h2><code class="docutils literal notranslate"><span class="pre">resources_network_firmware</span></code><a class="headerlink" href="#resources-network-firmware" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">FirmwareVersion</span></code> field to network card entries.</p>
</section>
<section id="backup-compression-algorithm">
<h2><code class="docutils literal notranslate"><span class="pre">backup_compression_algorithm</span></code><a class="headerlink" href="#backup-compression-algorithm" title="Link to this heading">¶</a></h2>
<p>This adds support for a <code class="docutils literal notranslate"><span class="pre">compression_algorithm</span></code> property when creating a backup (<code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/containers/<name>/backups</span></code>).</p>
<p>Setting this property overrides the server default value (<a class="configref reference internal" href="../server/#server-miscellaneous:backups.compression_algorithm"><code class="docutils literal notranslate"><span class="pre">backups.compression_algorithm</span></code></a>).</p>
</section>
<section id="ceph-data-pool-name">
<h2><code class="docutils literal notranslate"><span class="pre">ceph_data_pool_name</span></code><a class="headerlink" href="#ceph-data-pool-name" title="Link to this heading">¶</a></h2>
<p>This adds support for an optional argument (<a class="configref reference internal" href="../reference/storage_ceph/#storage-ceph-pool-conf:ceph.osd.data_pool_name"><code class="docutils literal notranslate"><span class="pre">ceph.osd.data_pool_name</span></code></a>) when creating
storage pools using Ceph RBD, when this argument is used the pool will store it’s
actual data in the pool specified with <code class="docutils literal notranslate"><span class="pre">data_pool_name</span></code> while keeping the metadata
in the pool specified by <code class="docutils literal notranslate"><span class="pre">pool_name</span></code>.</p>
</section>
<section id="container-syscall-intercept-mount">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_mount</span></code><a class="headerlink" href="#container-syscall-intercept-mount" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.intercept.mount"><code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.mount</span></code></a>,
<a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.intercept.mount.allowed"><code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.mount.allowed</span></code></a>, and
<a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.intercept.mount.shift"><code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.mount.shift</span></code></a> configuration keys to control whether
and how the <code class="docutils literal notranslate"><span class="pre">mount</span></code> system call will be intercepted by LXD and processed with
elevated permissions.</p>
</section>
<section id="compression-squashfs">
<h2><code class="docutils literal notranslate"><span class="pre">compression_squashfs</span></code><a class="headerlink" href="#compression-squashfs" title="Link to this heading">¶</a></h2>
<p>Adds support for importing/exporting of images/backups using SquashFS file system format.</p>
</section>
<section id="container-raw-mount">
<h2><code class="docutils literal notranslate"><span class="pre">container_raw_mount</span></code><a class="headerlink" href="#container-raw-mount" title="Link to this heading">¶</a></h2>
<p>This adds support for passing in raw mount options for disk devices.</p>
</section>
<section id="container-nic-routed">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_routed</span></code><a class="headerlink" href="#container-nic-routed" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">routed</span></code> <code class="docutils literal notranslate"><span class="pre">nic</span></code> device type.</p>
</section>
<section id="container-syscall-intercept-mount-fuse">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_mount_fuse</span></code><a class="headerlink" href="#container-syscall-intercept-mount-fuse" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.intercept.mount.fuse"><code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.mount.fuse</span></code></a> key. It can be used to
redirect file-system mounts to their fuse implementation. To this end, set e.g.
<code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.mount.fuse=ext4=fuse2fs</span></code>.</p>
</section>
<section id="container-disk-ceph">
<h2><code class="docutils literal notranslate"><span class="pre">container_disk_ceph</span></code><a class="headerlink" href="#container-disk-ceph" title="Link to this heading">¶</a></h2>
<p>This allows for existing a Ceph RBD or CephFS to be directly connected to a LXD container.</p>
</section>
<section id="virtual-machines">
<h2><code class="docutils literal notranslate"><span class="pre">virtual-machines</span></code><a class="headerlink" href="#virtual-machines" title="Link to this heading">¶</a></h2>
<p>Add virtual machine support.</p>
</section>
<section id="image-profiles">
<h2><code class="docutils literal notranslate"><span class="pre">image_profiles</span></code><a class="headerlink" href="#image-profiles" title="Link to this heading">¶</a></h2>
<p>Allows a list of profiles to be applied to an image when launching a new container.</p>
</section>
<section id="clustering-architecture">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_architecture</span></code><a class="headerlink" href="#clustering-architecture" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">architecture</span></code> attribute to cluster members which indicates a cluster
member’s architecture.</p>
</section>
<section id="resources-disk-id">
<h2><code class="docutils literal notranslate"><span class="pre">resources_disk_id</span></code><a class="headerlink" href="#resources-disk-id" title="Link to this heading">¶</a></h2>
<p>Add a new <code class="docutils literal notranslate"><span class="pre">device_id</span></code> field in the disk entries on the resources API.</p>
</section>
<section id="storage-lvm-stripes">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_stripes</span></code><a class="headerlink" href="#storage-lvm-stripes" title="Link to this heading">¶</a></h2>
<p>This adds the ability to use LVM stripes on normal volumes and thin pool volumes.</p>
</section>
<section id="vm-boot-priority">
<h2><code class="docutils literal notranslate"><span class="pre">vm_boot_priority</span></code><a class="headerlink" href="#vm-boot-priority" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">boot.priority</span></code> property on NIC and disk devices to control the boot order.</p>
</section>
<section id="unix-hotplug-devices">
<h2><code class="docutils literal notranslate"><span class="pre">unix_hotplug_devices</span></code><a class="headerlink" href="#unix-hotplug-devices" title="Link to this heading">¶</a></h2>
<p>Adds support for Unix char and block device hotplugging.</p>
</section>
<section id="api-filtering">
<h2><code class="docutils literal notranslate"><span class="pre">api_filtering</span></code><a class="headerlink" href="#api-filtering" title="Link to this heading">¶</a></h2>
<p>Adds support for filtering the result of a GET request for instances and images.</p>
</section>
<section id="instance-nic-network">
<h2><code class="docutils literal notranslate"><span class="pre">instance_nic_network</span></code><a class="headerlink" href="#instance-nic-network" title="Link to this heading">¶</a></h2>
<p>Adds support for the <code class="docutils literal notranslate"><span class="pre">network</span></code> property on a NIC device to allow a NIC to be linked to a managed network.
This allows it to inherit some of the network’s settings and allows better validation of IP settings.</p>
</section>
<section id="clustering-sizing">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_sizing</span></code><a class="headerlink" href="#clustering-sizing" title="Link to this heading">¶</a></h2>
<p>Support specifying a custom values for database voters and standbys.
The new <a class="configref reference internal" href="../server/#server-cluster:cluster.max_voters"><code class="docutils literal notranslate"><span class="pre">cluster.max_voters</span></code></a> and <a class="configref reference internal" href="../server/#server-cluster:cluster.max_standby"><code class="docutils literal notranslate"><span class="pre">cluster.max_standby</span></code></a> configuration keys were introduced
to specify to the ideal number of database voter and standbys.</p>
</section>
<section id="firewall-driver">
<h2><code class="docutils literal notranslate"><span class="pre">firewall_driver</span></code><a class="headerlink" href="#firewall-driver" title="Link to this heading">¶</a></h2>
<p>Adds the <code class="docutils literal notranslate"><span class="pre">Firewall</span></code> property to the <code class="docutils literal notranslate"><span class="pre">ServerEnvironment</span></code> struct indicating the firewall driver being used.</p>
</section>
<section id="storage-lvm-vg-force-reuse">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_vg_force_reuse</span></code><a class="headerlink" href="#storage-lvm-vg-force-reuse" title="Link to this heading">¶</a></h2>
<p>Introduces the ability to create a storage pool from an existing non-empty volume group.
This option should be used with care, as LXD can then not guarantee that volume name conflicts won’t occur
with non-LXD created volumes in the same volume group.
This could also potentially lead to LXD deleting a non-LXD volume should name conflicts occur.</p>
</section>
<section id="container-syscall-intercept-hugetlbfs">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_hugetlbfs</span></code><a class="headerlink" href="#container-syscall-intercept-hugetlbfs" title="Link to this heading">¶</a></h2>
<p>When mount syscall interception is enabled and <code class="docutils literal notranslate"><span class="pre">hugetlbfs</span></code> is specified as an
allowed file system type LXD will mount a separate <code class="docutils literal notranslate"><span class="pre">hugetlbfs</span></code> instance for the
container with the UID and GID mount options set to the container’s root UID
and GID. This ensures that processes in the container can use huge pages.</p>
</section>
<section id="limits-hugepages">
<h2><code class="docutils literal notranslate"><span class="pre">limits_hugepages</span></code><a class="headerlink" href="#limits-hugepages" title="Link to this heading">¶</a></h2>
<p>This allows to limit the number of huge pages a container can use through the
<code class="docutils literal notranslate"><span class="pre">hugetlb</span></code> cgroup. This means the <code class="docutils literal notranslate"><span class="pre">hugetlb</span></code> cgroup needs to be available. Note, that
limiting huge pages is recommended when intercepting the mount syscall for the
<code class="docutils literal notranslate"><span class="pre">hugetlbfs</span></code> file system to avoid allowing the container to exhaust the host’s
huge pages resources.</p>
</section>
<section id="container-nic-routed-gateway">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_routed_gateway</span></code><a class="headerlink" href="#container-nic-routed-gateway" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv4.gateway"><code class="docutils literal notranslate"><span class="pre">ipv4.gateway</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv6.gateway"><code class="docutils literal notranslate"><span class="pre">ipv6.gateway</span></code></a> NIC configuration keys that can take a value of either <code class="docutils literal notranslate"><span class="pre">auto</span></code> or
<code class="docutils literal notranslate"><span class="pre">none</span></code>. The default value for the key if unspecified is <code class="docutils literal notranslate"><span class="pre">auto</span></code>. This will cause the current behavior of a default
gateway being added inside the container and the same gateway address being added to the host-side interface.
If the value is set to <code class="docutils literal notranslate"><span class="pre">none</span></code> then no default gateway nor will the address be added to the host-side interface.
This allows multiple routed NIC devices to be added to a container.</p>
</section>
<section id="projects-restrictions">
<h2><code class="docutils literal notranslate"><span class="pre">projects_restrictions</span></code><a class="headerlink" href="#projects-restrictions" title="Link to this heading">¶</a></h2>
<p>This introduces support for the <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted"><code class="docutils literal notranslate"><span class="pre">restricted</span></code></a> configuration key on project, which
can prevent the use of security-sensitive features in a project.</p>
</section>
<section id="custom-volume-snapshot-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">custom_volume_snapshot_expiry</span></code><a class="headerlink" href="#custom-volume-snapshot-expiry" title="Link to this heading">¶</a></h2>
<p>This allows custom volume snapshots to expiry.
Expiry dates can be set individually, or by setting the <code class="docutils literal notranslate"><span class="pre">snapshots.expiry</span></code> configuration key on the parent custom volume which then automatically applies to all created snapshots.</p>
</section>
<section id="volume-snapshot-scheduling">
<h2><code class="docutils literal notranslate"><span class="pre">volume_snapshot_scheduling</span></code><a class="headerlink" href="#volume-snapshot-scheduling" title="Link to this heading">¶</a></h2>
<p>This adds support for custom volume snapshot scheduling. It introduces two new
configuration keys: <code class="docutils literal notranslate"><span class="pre">snapshots.schedule</span></code> and
<code class="docutils literal notranslate"><span class="pre">snapshots.pattern</span></code>. Snapshots can be created automatically up to every minute.</p>
</section>
<section id="trust-ca-certificates">
<h2><code class="docutils literal notranslate"><span class="pre">trust_ca_certificates</span></code><a class="headerlink" href="#trust-ca-certificates" title="Link to this heading">¶</a></h2>
<p>This allows for checking client certificates trusted by the provided CA (<code class="docutils literal notranslate"><span class="pre">server.ca</span></code>).
It can be enabled by setting <a class="configref reference internal" href="../server/#server-core:core.trust_ca_certificates"><code class="docutils literal notranslate"><span class="pre">core.trust_ca_certificates</span></code></a> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
If enabled, it will perform the check, and bypass the trusted password if <code class="docutils literal notranslate"><span class="pre">true</span></code>.
An exception will be made if the connecting client certificate is in the provided CRL (<code class="docutils literal notranslate"><span class="pre">ca.crl</span></code>).
In this case, it will ask for the password.</p>
</section>
<section id="snapshot-disk-usage">
<h2><code class="docutils literal notranslate"><span class="pre">snapshot_disk_usage</span></code><a class="headerlink" href="#snapshot-disk-usage" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">size</span></code> field to the output of <code class="docutils literal notranslate"><span class="pre">/1.0/instances/<name>/snapshots/<snapshot></span></code> which represents the disk usage of the snapshot.</p>
</section>
<section id="clustering-edit-roles">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_edit_roles</span></code><a class="headerlink" href="#clustering-edit-roles" title="Link to this heading">¶</a></h2>
<p>This adds a writable endpoint for cluster members, allowing the editing of their roles.</p>
</section>
<section id="container-nic-routed-host-address">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_routed_host_address</span></code><a class="headerlink" href="#container-nic-routed-host-address" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv4.host_address"><code class="docutils literal notranslate"><span class="pre">ipv4.host_address</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv6.host_address"><code class="docutils literal notranslate"><span class="pre">ipv6.host_address</span></code></a> NIC configuration keys that can be used to control the
host-side <code class="docutils literal notranslate"><span class="pre">veth</span></code> interface’s IP addresses. This can be useful when using multiple routed NICs at the same time and
needing a predictable next-hop address to use.</p>
<p>This also alters the behavior of <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv4.gateway"><code class="docutils literal notranslate"><span class="pre">ipv4.gateway</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv6.gateway"><code class="docutils literal notranslate"><span class="pre">ipv6.gateway</span></code></a> NIC configuration keys. When they are set to <code class="docutils literal notranslate"><span class="pre">auto</span></code>
the container will have its default gateway set to the value of <code class="docutils literal notranslate"><span class="pre">ipv4.host_address</span></code> or <code class="docutils literal notranslate"><span class="pre">ipv6.host_address</span></code> respectively.</p>
<p>The default values are:</p>
<p><code class="docutils literal notranslate"><span class="pre">ipv4.host_address</span></code>: <code class="docutils literal notranslate"><span class="pre">169.254.0.1</span></code>
<code class="docutils literal notranslate"><span class="pre">ipv6.host_address</span></code>: <code class="docutils literal notranslate"><span class="pre">fe80::1</span></code></p>
<p>This is backward compatible with the previous default behavior.</p>
</section>
<section id="container-nic-ipvlan-gateway">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan_gateway</span></code><a class="headerlink" href="#container-nic-ipvlan-gateway" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv4.gateway"><code class="docutils literal notranslate"><span class="pre">ipv4.gateway</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv6.gateway"><code class="docutils literal notranslate"><span class="pre">ipv6.gateway</span></code></a> NIC configuration keys that can take a value of either <code class="docutils literal notranslate"><span class="pre">auto</span></code> or
<code class="docutils literal notranslate"><span class="pre">none</span></code>. The default value for the key if unspecified is <code class="docutils literal notranslate"><span class="pre">auto</span></code>. This will cause the current behavior of a default
gateway being added inside the container and the same gateway address being added to the host-side interface.
If the value is set to <code class="docutils literal notranslate"><span class="pre">none</span></code> then no default gateway nor will the address be added to the host-side interface.
This allows multiple IPVLAN NIC devices to be added to a container.</p>
</section>
<section id="resources-usb-pci">
<h2><code class="docutils literal notranslate"><span class="pre">resources_usb_pci</span></code><a class="headerlink" href="#resources-usb-pci" title="Link to this heading">¶</a></h2>
<p>This adds USB and PCI devices to the output of <code class="docutils literal notranslate"><span class="pre">/1.0/resources</span></code>.</p>
</section>
<section id="resources-cpu-threads-numa">
<h2><code class="docutils literal notranslate"><span class="pre">resources_cpu_threads_numa</span></code><a class="headerlink" href="#resources-cpu-threads-numa" title="Link to this heading">¶</a></h2>
<p>This indicates that the <code class="docutils literal notranslate"><span class="pre">numa_node</span></code> field is now recorded per-thread
rather than per core as some hardware apparently puts threads in
different NUMA domains.</p>
</section>
<section id="resources-cpu-core-die">
<h2><code class="docutils literal notranslate"><span class="pre">resources_cpu_core_die</span></code><a class="headerlink" href="#resources-cpu-core-die" title="Link to this heading">¶</a></h2>
<p>Exposes the <code class="docutils literal notranslate"><span class="pre">die_id</span></code> information on each core.</p>
</section>
<section id="api-os">
<h2><code class="docutils literal notranslate"><span class="pre">api_os</span></code><a class="headerlink" href="#api-os" title="Link to this heading">¶</a></h2>
<p>This introduces two new fields in <code class="docutils literal notranslate"><span class="pre">/1.0</span></code>, <code class="docutils literal notranslate"><span class="pre">os</span></code> and <code class="docutils literal notranslate"><span class="pre">os_version</span></code>.</p>
<p>Those are taken from the OS-release data on the system.</p>
</section>
<section id="container-nic-routed-host-table">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_routed_host_table</span></code><a class="headerlink" href="#container-nic-routed-host-table" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv4.host_table"><code class="docutils literal notranslate"><span class="pre">ipv4.host_table</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv6.host_table"><code class="docutils literal notranslate"><span class="pre">ipv6.host_table</span></code></a> NIC configuration keys that can be used to add static routes
for the instance’s IPs to a custom policy routing table by ID.</p>
</section>
<section id="container-nic-ipvlan-host-table">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan_host_table</span></code><a class="headerlink" href="#container-nic-ipvlan-host-table" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv4.host_table"><code class="docutils literal notranslate"><span class="pre">ipv4.host_table</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv6.host_table"><code class="docutils literal notranslate"><span class="pre">ipv6.host_table</span></code></a> NIC configuration keys that can be used to add static routes
for the instance’s IPs to a custom policy routing table by ID.</p>
</section>
<section id="container-nic-ipvlan-mode">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan_mode</span></code><a class="headerlink" href="#container-nic-ipvlan-mode" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:mode"><code class="docutils literal notranslate"><span class="pre">mode</span></code></a> NIC configuration key that can be used to switch the <code class="docutils literal notranslate"><span class="pre">ipvlan</span></code> mode into either <code class="docutils literal notranslate"><span class="pre">l2</span></code> or <code class="docutils literal notranslate"><span class="pre">l3s</span></code>.
If not specified, the default value is <code class="docutils literal notranslate"><span class="pre">l3s</span></code> (which is the old behavior).</p>
<p>In <code class="docutils literal notranslate"><span class="pre">l2</span></code> mode the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv4.address"><code class="docutils literal notranslate"><span class="pre">ipv4.address</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv6.address"><code class="docutils literal notranslate"><span class="pre">ipv6.address</span></code></a> keys will accept addresses in either CIDR or singular formats.
If singular format is used, the default subnet size is taken to be /24 and /64 for IPv4 and IPv6 respectively.</p>
<p>In <code class="docutils literal notranslate"><span class="pre">l2</span></code> mode the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv4.gateway"><code class="docutils literal notranslate"><span class="pre">ipv4.gateway</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ipvlan-device-conf:ipv6.gateway"><code class="docutils literal notranslate"><span class="pre">ipv6.gateway</span></code></a> keys accept only a singular IP address.</p>
</section>
<section id="resources-system">
<h2><code class="docutils literal notranslate"><span class="pre">resources_system</span></code><a class="headerlink" href="#resources-system" title="Link to this heading">¶</a></h2>
<p>This adds system information to the output of <code class="docutils literal notranslate"><span class="pre">/1.0/resources</span></code>.</p>
</section>
<section id="images-push-relay">
<h2><code class="docutils literal notranslate"><span class="pre">images_push_relay</span></code><a class="headerlink" href="#images-push-relay" title="Link to this heading">¶</a></h2>
<p>This adds the push and relay modes to image copy.
It also introduces the following new endpoint:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">1.0/images/<fingerprint>/export</span></code></p></li>
</ul>
</section>
<section id="network-dns-search">
<h2><code class="docutils literal notranslate"><span class="pre">network_dns_search</span></code><a class="headerlink" href="#network-dns-search" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">dns.search</span></code> configuration option on networks.</p>
</section>
<section id="container-nic-routed-limits">
<h2><code class="docutils literal notranslate"><span class="pre">container_nic_routed_limits</span></code><a class="headerlink" href="#container-nic-routed-limits" title="Link to this heading">¶</a></h2>
<p>This introduces <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:limits.ingress"><code class="docutils literal notranslate"><span class="pre">limits.ingress</span></code></a>, <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:limits.egress"><code class="docutils literal notranslate"><span class="pre">limits.egress</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:limits.max"><code class="docutils literal notranslate"><span class="pre">limits.max</span></code></a> for routed NICs.</p>
</section>
<section id="instance-nic-bridged-vlan">
<h2><code class="docutils literal notranslate"><span class="pre">instance_nic_bridged_vlan</span></code><a class="headerlink" href="#instance-nic-bridged-vlan" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:vlan"><code class="docutils literal notranslate"><span class="pre">vlan</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:vlan.tagged"><code class="docutils literal notranslate"><span class="pre">vlan.tagged</span></code></a> settings for <code class="docutils literal notranslate"><span class="pre">bridged</span></code> NICs.</p>
<p><code class="docutils literal notranslate"><span class="pre">vlan</span></code> specifies the non-tagged VLAN to join, and <code class="docutils literal notranslate"><span class="pre">vlan.tagged</span></code> is a comma-delimited list of tagged VLANs to join.</p>
</section>
<section id="network-state-bond-bridge">
<h2><code class="docutils literal notranslate"><span class="pre">network_state_bond_bridge</span></code><a class="headerlink" href="#network-state-bond-bridge" title="Link to this heading">¶</a></h2>
<p>This adds a <code class="docutils literal notranslate"><span class="pre">bridge</span></code> and <code class="docutils literal notranslate"><span class="pre">bond</span></code> section to the <code class="docutils literal notranslate"><span class="pre">/1.0/networks/NAME/state</span></code> API.</p>
<p>Those contain additional state information relevant to those particular types.</p>
<p>Bond:</p>
<ul class="simple">
<li><p>Mode</p></li>
<li><p>Transmit hash</p></li>
<li><p>Up delay</p></li>
<li><p>Down delay</p></li>
<li><p>MII frequency</p></li>
<li><p>MII state</p></li>
<li><p>Lower devices</p></li>
</ul>
<p>Bridge:</p>
<ul class="simple">
<li><p>ID</p></li>
<li><p>Forward delay</p></li>
<li><p>STP mode</p></li>
<li><p>Default VLAN</p></li>
<li><p>VLAN filtering</p></li>
<li><p>Upper devices</p></li>
</ul>
</section>
<section id="resources-cpu-isolated">
<h2><code class="docutils literal notranslate"><span class="pre">resources_cpu_isolated</span></code><a class="headerlink" href="#resources-cpu-isolated" title="Link to this heading">¶</a></h2>
<p>Add an <code class="docutils literal notranslate"><span class="pre">Isolated</span></code> property on CPU threads to indicate if the thread is
physically <code class="docutils literal notranslate"><span class="pre">Online</span></code> but is configured not to accept tasks.</p>
</section>
<section id="usedby-consistency">
<h2><code class="docutils literal notranslate"><span class="pre">usedby_consistency</span></code><a class="headerlink" href="#usedby-consistency" title="Link to this heading">¶</a></h2>
<p>This extension indicates that <code class="docutils literal notranslate"><span class="pre">UsedBy</span></code> should now be consistent with
suitable <code class="docutils literal notranslate"><span class="pre">?project=</span></code> and <code class="docutils literal notranslate"><span class="pre">?target=</span></code> when appropriate.</p>
<p>The 5 entities that have <code class="docutils literal notranslate"><span class="pre">UsedBy</span></code> are:</p>
<ul class="simple">
<li><p>Profiles</p></li>
<li><p>Projects</p></li>
<li><p>Networks</p></li>
<li><p>Storage pools</p></li>
<li><p>Storage volumes</p></li>
</ul>
</section>
<section id="custom-block-volumes">
<h2><code class="docutils literal notranslate"><span class="pre">custom_block_volumes</span></code><a class="headerlink" href="#custom-block-volumes" title="Link to this heading">¶</a></h2>
<p>This adds support for creating and attaching custom block volumes to instances.
It introduces the new <code class="docutils literal notranslate"><span class="pre">--type</span></code> flag when creating custom storage volumes, and accepts the values <code class="docutils literal notranslate"><span class="pre">fs</span></code> and <code class="docutils literal notranslate"><span class="pre">block</span></code>.</p>
</section>
<section id="clustering-failure-domains">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_failure_domains</span></code><a class="headerlink" href="#clustering-failure-domains" title="Link to this heading">¶</a></h2>
<p>This extension adds a new <code class="docutils literal notranslate"><span class="pre">failure_domain</span></code> field to the <code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/cluster/<node></span></code> API,
which can be used to set the failure domain of a node.</p>
</section>
<section id="container-syscall-filtering-allow-deny-syntax">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_filtering_allow_deny_syntax</span></code><a class="headerlink" href="#container-syscall-filtering-allow-deny-syntax" title="Link to this heading">¶</a></h2>
<p>A number of new syscalls related container configuration keys were updated.</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.deny_default"><code class="docutils literal notranslate"><span class="pre">security.syscalls.deny_default</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.deny_compat"><code class="docutils literal notranslate"><span class="pre">security.syscalls.deny_compat</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.deny"><code class="docutils literal notranslate"><span class="pre">security.syscalls.deny</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.allow"><code class="docutils literal notranslate"><span class="pre">security.syscalls.allow</span></code></a></p></li>
</ul>
<p>Support for the offensively named variants was removed.</p>
</section>
<section id="resources-gpu-mdev">
<h2><code class="docutils literal notranslate"><span class="pre">resources_gpu_mdev</span></code><a class="headerlink" href="#resources-gpu-mdev" title="Link to this heading">¶</a></h2>
<p>Expose available mediated device profiles and devices in <code class="docutils literal notranslate"><span class="pre">/1.0/resources</span></code>.</p>
</section>
<section id="console-vga-type">
<h2><code class="docutils literal notranslate"><span class="pre">console_vga_type</span></code><a class="headerlink" href="#console-vga-type" title="Link to this heading">¶</a></h2>
<p>This extends the <code class="docutils literal notranslate"><span class="pre">/1.0/console</span></code> endpoint to take a <code class="docutils literal notranslate"><span class="pre">?type=</span></code> argument, which can
be set to <code class="docutils literal notranslate"><span class="pre">console</span></code> (default) or <code class="docutils literal notranslate"><span class="pre">vga</span></code> (the new type added by this extension).</p>
<p>When doing a <code class="docutils literal notranslate"><span class="pre">POST</span></code> to <code class="docutils literal notranslate"><span class="pre">/1.0/<instance</span> <span class="pre">name>/console?type=vga</span></code> the data WebSocket
returned by the operation in the metadata field will be a bidirectional proxy
attached to a SPICE Unix socket of the target virtual machine.</p>
</section>
<section id="projects-limits-disk">
<h2><code class="docutils literal notranslate"><span class="pre">projects_limits_disk</span></code><a class="headerlink" href="#projects-limits-disk" title="Link to this heading">¶</a></h2>
<p>Add <a class="configref reference internal" href="../reference/projects/#project-limits:limits.disk"><code class="docutils literal notranslate"><span class="pre">limits.disk</span></code></a> to the available project configuration keys. If set, it limits
the total amount of disk space that instances volumes, custom volumes and images
volumes can use in the project.</p>
</section>
<section id="network-type-macvlan">
<h2><code class="docutils literal notranslate"><span class="pre">network_type_macvlan</span></code><a class="headerlink" href="#network-type-macvlan" title="Link to this heading">¶</a></h2>
<p>Adds support for additional network type <code class="docutils literal notranslate"><span class="pre">macvlan</span></code> and adds <a class="configref reference internal" href="../reference/network_macvlan/#network-macvlan-network-conf:parent"><code class="docutils literal notranslate"><span class="pre">parent</span></code></a> configuration key for this network type to
specify which parent interface should be used for creating NIC device interfaces on top of.</p>
<p>Also adds <a class="configref reference internal" href="../reference/devices_nic/#device-nic-macvlan-device-conf:network"><code class="docutils literal notranslate"><span class="pre">network</span></code></a> configuration key support for <code class="docutils literal notranslate"><span class="pre">macvlan</span></code> NICs to allow them to specify the associated network of
the same type that they should use as the basis for the NIC device.</p>
</section>
<section id="network-type-sriov">
<h2><code class="docutils literal notranslate"><span class="pre">network_type_sriov</span></code><a class="headerlink" href="#network-type-sriov" title="Link to this heading">¶</a></h2>
<p>Adds support for additional network type <code class="docutils literal notranslate"><span class="pre">sriov</span></code> and adds <a class="configref reference internal" href="../reference/network_sriov/#network-sriov-network-conf:parent"><code class="docutils literal notranslate"><span class="pre">parent</span></code></a> configuration key for this network type to
specify which parent interface should be used for creating NIC device interfaces on top of.</p>
<p>Also adds <a class="configref reference internal" href="../reference/devices_nic/#device-nic-sriov-device-conf:network"><code class="docutils literal notranslate"><span class="pre">network</span></code></a> configuration key support for <code class="docutils literal notranslate"><span class="pre">sriov</span></code> NICs to allow them to specify the associated network of
the same type that they should use as the basis for the NIC device.</p>
</section>
<section id="container-syscall-intercept-bpf-devices">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_bpf_devices</span></code><a class="headerlink" href="#container-syscall-intercept-bpf-devices" title="Link to this heading">¶</a></h2>
<p>This adds support to intercept the <code class="docutils literal notranslate"><span class="pre">bpf</span></code> syscall in containers. Specifically, it allows to manage device cgroup <code class="docutils literal notranslate"><span class="pre">bpf</span></code> programs.</p>
</section>
<section id="network-type-ovn">
<h2><code class="docutils literal notranslate"><span class="pre">network_type_ovn</span></code><a class="headerlink" href="#network-type-ovn" title="Link to this heading">¶</a></h2>
<p>Adds support for additional network type <code class="docutils literal notranslate"><span class="pre">ovn</span></code> with the ability to specify a <code class="docutils literal notranslate"><span class="pre">bridge</span></code> type network as the <code class="docutils literal notranslate"><span class="pre">parent</span></code>.</p>
<p>Introduces a new NIC device type of <code class="docutils literal notranslate"><span class="pre">ovn</span></code> which allows the <code class="docutils literal notranslate"><span class="pre">network</span></code> configuration key to specify which <code class="docutils literal notranslate"><span class="pre">ovn</span></code>
type network they should connect to.</p>
<p>Also introduces two new global configuration keys that apply to all <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks and NIC devices:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-miscellaneous:network.ovn.integration_bridge"><code class="docutils literal notranslate"><span class="pre">network.ovn.integration_bridge</span></code></a> - the OVS integration bridge to use.</p></li>
<li><p><a class="configref reference internal" href="../server/#server-miscellaneous:network.ovn.northbound_connection"><code class="docutils literal notranslate"><span class="pre">network.ovn.northbound_connection</span></code></a> - the OVN northbound database connection string.</p></li>
</ul>
</section>
<section id="projects-networks">
<h2><code class="docutils literal notranslate"><span class="pre">projects_networks</span></code><a class="headerlink" href="#projects-networks" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/projects/#project-features:features.networks"><code class="docutils literal notranslate"><span class="pre">features.networks</span></code></a> configuration key to projects and the ability for a project to hold networks.</p>
</section>
<section id="projects-networks-restricted-uplinks">
<h2><code class="docutils literal notranslate"><span class="pre">projects_networks_restricted_uplinks</span></code><a class="headerlink" href="#projects-networks-restricted-uplinks" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.networks.uplinks"><code class="docutils literal notranslate"><span class="pre">restricted.networks.uplinks</span></code></a> project configuration key to indicate (as a comma-delimited list) which networks
the networks created inside the project can use as their uplink network.</p>
</section>
<section id="custom-volume-backup">
<h2><code class="docutils literal notranslate"><span class="pre">custom_volume_backup</span></code><a class="headerlink" href="#custom-volume-backup" title="Link to this heading">¶</a></h2>
<p>Add custom volume backup support.</p>
<p>This includes the following new endpoints (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume>/backups</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume>/backups</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume>/backups/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume>/backups/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume>/backups/<name></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume>/backups/<name>/export</span></code></p></li>
</ul>
<p>The following existing endpoint has been modified:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/<type>/<volume></span></code> accepts the new source type <code class="docutils literal notranslate"><span class="pre">backup</span></code></p></li>
</ul>
</section>
<section id="backup-override-name">
<h2><code class="docutils literal notranslate"><span class="pre">backup_override_name</span></code><a class="headerlink" href="#backup-override-name" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">Name</span></code> field to <code class="docutils literal notranslate"><span class="pre">InstanceBackupArgs</span></code> to allow specifying a different instance name when restoring a backup.</p>
<p>Adds <code class="docutils literal notranslate"><span class="pre">Name</span></code> and <code class="docutils literal notranslate"><span class="pre">PoolName</span></code> fields to <code class="docutils literal notranslate"><span class="pre">StoragePoolVolumeBackupArgs</span></code> to allow specifying a different volume name
when restoring a custom volume backup.</p>
</section>
<section id="storage-rsync-compression">
<h2><code class="docutils literal notranslate"><span class="pre">storage_rsync_compression</span></code><a class="headerlink" href="#storage-rsync-compression" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">rsync.compression</span></code> configuration key to storage pools. This key can be used
to disable compression in <code class="docutils literal notranslate"><span class="pre">rsync</span></code> while migrating storage pools.</p>
</section>
<section id="network-type-physical">
<h2><code class="docutils literal notranslate"><span class="pre">network_type_physical</span></code><a class="headerlink" href="#network-type-physical" title="Link to this heading">¶</a></h2>
<p>Adds support for additional network type <code class="docutils literal notranslate"><span class="pre">physical</span></code> that can be used as an uplink for <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks.</p>
<p>The interface specified by <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:parent"><code class="docutils literal notranslate"><span class="pre">parent</span></code></a> on the <code class="docutils literal notranslate"><span class="pre">physical</span></code> network will be connected to the <code class="docutils literal notranslate"><span class="pre">ovn</span></code> network’s gateway.</p>
</section>
<section id="network-ovn-external-subnets">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_external_subnets</span></code><a class="headerlink" href="#network-ovn-external-subnets" title="Link to this heading">¶</a></h2>
<p>Adds support for <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks to use external subnets from uplink networks.</p>
<p>Introduces the <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ipv4.routes"><code class="docutils literal notranslate"><span class="pre">ipv4.routes</span></code></a> and <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ipv6.routes"><code class="docutils literal notranslate"><span class="pre">ipv6.routes</span></code></a> setting on <code class="docutils literal notranslate"><span class="pre">physical</span></code> networks that defines the external routes
allowed to be used in child OVN networks in their <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:ipv4.routes.external"><code class="docutils literal notranslate"><span class="pre">ipv4.routes.external</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:ipv6.routes.external"><code class="docutils literal notranslate"><span class="pre">ipv6.routes.external</span></code></a> settings.</p>
<p>Introduces the <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.networks.subnets"><code class="docutils literal notranslate"><span class="pre">restricted.networks.subnets</span></code></a> project setting that specifies which external subnets are allowed to
be used by OVN networks inside the project (if not set then all routes defined on the uplink network are allowed).</p>
</section>
<section id="network-ovn-nat">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_nat</span></code><a class="headerlink" href="#network-ovn-nat" title="Link to this heading">¶</a></h2>
<p>Adds support for <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv4.nat"><code class="docutils literal notranslate"><span class="pre">ipv4.nat</span></code></a> and <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv6.nat"><code class="docutils literal notranslate"><span class="pre">ipv6.nat</span></code></a> settings on <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks.</p>
<p>When creating the network if these settings are unspecified, and an equivalent IP address is being generated for
the subnet, then the appropriate NAT setting will added set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p>If the setting is missing then the value is taken as <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
</section>
<section id="network-ovn-external-routes-remove">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_external_routes_remove</span></code><a class="headerlink" href="#network-ovn-external-routes-remove" title="Link to this heading">¶</a></h2>
<p>Removes the settings <code class="docutils literal notranslate"><span class="pre">ipv4.routes.external</span></code> and <code class="docutils literal notranslate"><span class="pre">ipv6.routes.external</span></code> from <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks.</p>
<p>The equivalent settings on the <code class="docutils literal notranslate"><span class="pre">ovn</span></code> NIC type can be used instead for this, rather than having to specify them
both at the network and NIC level.</p>
</section>
<section id="tpm-device-type">
<h2><code class="docutils literal notranslate"><span class="pre">tpm_device_type</span></code><a class="headerlink" href="#tpm-device-type" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">tpm</span></code> device type.</p>
</section>
<section id="storage-zfs-clone-copy-rebase">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_clone_copy_rebase</span></code><a class="headerlink" href="#storage-zfs-clone-copy-rebase" title="Link to this heading">¶</a></h2>
<p>This introduces <code class="docutils literal notranslate"><span class="pre">rebase</span></code> as a value for <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-pool-conf:zfs.clone_copy"><code class="docutils literal notranslate"><span class="pre">zfs.clone_copy</span></code></a> causing LXD to
track down any <code class="docutils literal notranslate"><span class="pre">image</span></code> dataset in the ancestry line and then perform
send/receive on top of that.</p>
</section>
<section id="gpu-mdev">
<h2><code class="docutils literal notranslate"><span class="pre">gpu_mdev</span></code><a class="headerlink" href="#gpu-mdev" title="Link to this heading">¶</a></h2>
<p>This adds support for virtual GPUs (vGPUs). It introduces the <a class="configref reference internal" href="../reference/devices_gpu/#device-gpu-mdev-device-conf:mdev"><code class="docutils literal notranslate"><span class="pre">mdev</span></code></a> configuration key for GPU devices which takes
a supported <code class="docutils literal notranslate"><span class="pre">mdev</span></code> type, e.g. <code class="docutils literal notranslate"><span class="pre">i915-GVTg_V5_4</span></code>.</p>
</section>
<section id="resources-pci-iommu">
<h2><code class="docutils literal notranslate"><span class="pre">resources_pci_iommu</span></code><a class="headerlink" href="#resources-pci-iommu" title="Link to this heading">¶</a></h2>
<p>This adds the <code class="docutils literal notranslate"><span class="pre">IOMMUGroup</span></code> field for PCI entries in the resources API.</p>
</section>
<section id="resources-network-usb">
<h2><code class="docutils literal notranslate"><span class="pre">resources_network_usb</span></code><a class="headerlink" href="#resources-network-usb" title="Link to this heading">¶</a></h2>
<p>Adds the <code class="docutils literal notranslate"><span class="pre">usb_address</span></code> field to the network card entries in the resources API.</p>
</section>
<section id="resources-disk-address">
<h2><code class="docutils literal notranslate"><span class="pre">resources_disk_address</span></code><a class="headerlink" href="#resources-disk-address" title="Link to this heading">¶</a></h2>
<p>Adds the <code class="docutils literal notranslate"><span class="pre">usb_address</span></code> and <code class="docutils literal notranslate"><span class="pre">pci_address</span></code> fields to the disk entries in the resources API.</p>
</section>
<section id="network-physical-ovn-ingress-mode">
<h2><code class="docutils literal notranslate"><span class="pre">network_physical_ovn_ingress_mode</span></code><a class="headerlink" href="#network-physical-ovn-ingress-mode" title="Link to this heading">¶</a></h2>
<p>Adds <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ovn.ingress_mode"><code class="docutils literal notranslate"><span class="pre">ovn.ingress_mode</span></code></a> setting for <code class="docutils literal notranslate"><span class="pre">physical</span></code> networks.</p>
<p>Sets the method that OVN NIC external IPs will be advertised on uplink network.</p>
<p>Either <code class="docutils literal notranslate"><span class="pre">l2proxy</span></code> (proxy ARP/NDP) or <code class="docutils literal notranslate"><span class="pre">routed</span></code>.</p>
</section>
<section id="network-ovn-dhcp">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_dhcp</span></code><a class="headerlink" href="#network-ovn-dhcp" title="Link to this heading">¶</a></h2>
<p>Adds <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv4.dhcp"><code class="docutils literal notranslate"><span class="pre">ipv4.dhcp</span></code></a> and <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv6.dhcp"><code class="docutils literal notranslate"><span class="pre">ipv6.dhcp</span></code></a> settings for <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks.</p>
<p>Allows DHCP (and RA for IPv6) to be disabled. Defaults to on.</p>
</section>
<section id="network-physical-routes-anycast">
<h2><code class="docutils literal notranslate"><span class="pre">network_physical_routes_anycast</span></code><a class="headerlink" href="#network-physical-routes-anycast" title="Link to this heading">¶</a></h2>
<p>Adds <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ipv4.routes.anycast"><code class="docutils literal notranslate"><span class="pre">ipv4.routes.anycast</span></code></a> and <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ipv6.routes.anycast"><code class="docutils literal notranslate"><span class="pre">ipv6.routes.anycast</span></code></a> Boolean settings for <code class="docutils literal notranslate"><span class="pre">physical</span></code> networks. Defaults to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p>Allows OVN networks using physical network as uplink to relax external subnet/route overlap detection when used
with <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ovn.ingress_mode"><code class="docutils literal notranslate"><span class="pre">ovn.ingress_mode</span></code></a> set to <code class="docutils literal notranslate"><span class="pre">routed</span></code>.</p>
</section>
<section id="projects-limits-instances">
<h2><code class="docutils literal notranslate"><span class="pre">projects_limits_instances</span></code><a class="headerlink" href="#projects-limits-instances" title="Link to this heading">¶</a></h2>
<p>Adds <a class="configref reference internal" href="../reference/projects/#project-limits:limits.instances"><code class="docutils literal notranslate"><span class="pre">limits.instances</span></code></a> to the available project configuration keys. If set, it
limits the total number of instances (VMs and containers) that can be used in the project.</p>
</section>
<section id="network-state-vlan">
<h2><code class="docutils literal notranslate"><span class="pre">network_state_vlan</span></code><a class="headerlink" href="#network-state-vlan" title="Link to this heading">¶</a></h2>
<p>This adds a <code class="docutils literal notranslate"><span class="pre">vlan</span></code> section to the <code class="docutils literal notranslate"><span class="pre">/1.0/networks/NAME/state</span></code> API.</p>
<p>Those contain additional state information relevant to VLAN interfaces:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">lower_device</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vid</span></code></p></li>
</ul>
</section>
<section id="instance-nic-bridged-port-isolation">
<h2><code class="docutils literal notranslate"><span class="pre">instance_nic_bridged_port_isolation</span></code><a class="headerlink" href="#instance-nic-bridged-port-isolation" title="Link to this heading">¶</a></h2>
<p>This adds the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:security.port_isolation"><code class="docutils literal notranslate"><span class="pre">security.port_isolation</span></code></a> field for bridged NIC instances.</p>
</section>
<section id="instance-bulk-state-change">
<h2><code class="docutils literal notranslate"><span class="pre">instance_bulk_state_change</span></code><a class="headerlink" href="#instance-bulk-state-change" title="Link to this heading">¶</a></h2>
<p>Adds the following endpoint for bulk state change (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/instances</span></code></p></li>
</ul>
</section>
<section id="network-gvrp">
<h2><code class="docutils literal notranslate"><span class="pre">network_gvrp</span></code><a class="headerlink" href="#network-gvrp" title="Link to this heading">¶</a></h2>
<p>This adds an optional <code class="docutils literal notranslate"><span class="pre">gvrp</span></code> property to <code class="docutils literal notranslate"><span class="pre">macvlan</span></code> and <code class="docutils literal notranslate"><span class="pre">physical</span></code> networks,
and to <code class="docutils literal notranslate"><span class="pre">ipvlan</span></code>, <code class="docutils literal notranslate"><span class="pre">macvlan</span></code>, <code class="docutils literal notranslate"><span class="pre">routed</span></code> and <code class="docutils literal notranslate"><span class="pre">physical</span></code> NIC devices.</p>
<p>When set, this specifies whether the VLAN should be registered using GARP VLAN
Registration Protocol. Defaults to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
</section>
<section id="instance-pool-move">
<h2><code class="docutils literal notranslate"><span class="pre">instance_pool_move</span></code><a class="headerlink" href="#instance-pool-move" title="Link to this heading">¶</a></h2>
<p>This adds a <code class="docutils literal notranslate"><span class="pre">pool</span></code> field to the <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances/NAME</span></code> API,
allowing for easy move of an instance root disk between pools.</p>
</section>
<section id="gpu-sriov">
<h2><code class="docutils literal notranslate"><span class="pre">gpu_sriov</span></code><a class="headerlink" href="#gpu-sriov" title="Link to this heading">¶</a></h2>
<p>This adds support for SR-IOV enabled GPUs.
It introduces the <code class="docutils literal notranslate"><span class="pre">sriov</span></code> GPU type property.</p>
</section>
<section id="pci-device-type">
<h2><code class="docutils literal notranslate"><span class="pre">pci_device_type</span></code><a class="headerlink" href="#pci-device-type" title="Link to this heading">¶</a></h2>
<p>This introduces the <code class="docutils literal notranslate"><span class="pre">pci</span></code> device type.</p>
</section>
<section id="storage-volume-state">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volume_state</span></code><a class="headerlink" href="#storage-volume-state" title="Link to this heading">¶</a></h2>
<p>Add new <code class="docutils literal notranslate"><span class="pre">/1.0/storage-pools/POOL/volumes/VOLUME/state</span></code> API endpoint to get usage data on a volume.</p>
</section>
<section id="network-acl">
<h2><code class="docutils literal notranslate"><span class="pre">network_acl</span></code><a class="headerlink" href="#network-acl" title="Link to this heading">¶</a></h2>
<p>This adds the concept of network ACLs to API under the API endpoint prefix <code class="docutils literal notranslate"><span class="pre">/1.0/network-acls</span></code>.</p>
</section>
<section id="migration-stateful">
<h2><code class="docutils literal notranslate"><span class="pre">migration_stateful</span></code><a class="headerlink" href="#migration-stateful" title="Link to this heading">¶</a></h2>
<p>Add a new <a class="configref reference internal" href="../reference/instance_options/#instance-migration:migration.stateful"><code class="docutils literal notranslate"><span class="pre">migration.stateful</span></code></a> configuration key.</p>
</section>
<section id="disk-state-quota">
<h2><code class="docutils literal notranslate"><span class="pre">disk_state_quota</span></code><a class="headerlink" href="#disk-state-quota" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/devices_disk/#device-disk-device-conf:size.state"><code class="docutils literal notranslate"><span class="pre">size.state</span></code></a> device configuration key on <code class="docutils literal notranslate"><span class="pre">disk</span></code> devices.</p>
</section>
<section id="storage-ceph-features">
<h2><code class="docutils literal notranslate"><span class="pre">storage_ceph_features</span></code><a class="headerlink" href="#storage-ceph-features" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/storage_ceph/#storage-ceph-pool-conf:ceph.rbd.features"><code class="docutils literal notranslate"><span class="pre">ceph.rbd.features</span></code></a> configuration key on storage pools to control the RBD features used for new volumes.</p>
</section>
<section id="projects-compression">
<h2><code class="docutils literal notranslate"><span class="pre">projects_compression</span></code><a class="headerlink" href="#projects-compression" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../reference/projects/#project-specific:backups.compression_algorithm"><code class="docutils literal notranslate"><span class="pre">backups.compression_algorithm</span></code></a> and <a class="configref reference internal" href="../reference/projects/#project-specific:images.compression_algorithm"><code class="docutils literal notranslate"><span class="pre">images.compression_algorithm</span></code></a> configuration keys which
allows configuration of backup and image compression per-project.</p>
</section>
<section id="projects-images-remote-cache-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">projects_images_remote_cache_expiry</span></code><a class="headerlink" href="#projects-images-remote-cache-expiry" title="Link to this heading">¶</a></h2>
<p>Add new <a class="configref reference internal" href="../server/#server-images:images.remote_cache_expiry"><code class="docutils literal notranslate"><span class="pre">images.remote_cache_expiry</span></code></a> configuration key to projects,
allowing for set number of days after which an unused cached remote image will be flushed.</p>
</section>
<section id="certificate-project">
<h2><code class="docutils literal notranslate"><span class="pre">certificate_project</span></code><a class="headerlink" href="#certificate-project" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">restricted</span></code> property to certificates in the API as well as
<code class="docutils literal notranslate"><span class="pre">projects</span></code> holding a list of project names that the certificate has
access to.</p>
</section>
<section id="network-ovn-acl">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_acl</span></code><a class="headerlink" href="#network-ovn-acl" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">security.acls</span></code> property to OVN networks and OVN NICs, allowing Network ACLs to be applied.</p>
</section>
<section id="projects-images-auto-update">
<h2><code class="docutils literal notranslate"><span class="pre">projects_images_auto_update</span></code><a class="headerlink" href="#projects-images-auto-update" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../server/#server-images:images.auto_update_cached"><code class="docutils literal notranslate"><span class="pre">images.auto_update_cached</span></code></a> and <a class="configref reference internal" href="../server/#server-images:images.auto_update_interval"><code class="docutils literal notranslate"><span class="pre">images.auto_update_interval</span></code></a> configuration keys which
allows configuration of images auto update in projects</p>
</section>
<section id="projects-restricted-cluster-target">
<h2><code class="docutils literal notranslate"><span class="pre">projects_restricted_cluster_target</span></code><a class="headerlink" href="#projects-restricted-cluster-target" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.cluster.target"><code class="docutils literal notranslate"><span class="pre">restricted.cluster.target</span></code></a> configuration key to project which prevent the user from using –target
to specify what cluster member to place a workload on or the ability to move a workload between members.</p>
</section>
<section id="images-default-architecture">
<h2><code class="docutils literal notranslate"><span class="pre">images_default_architecture</span></code><a class="headerlink" href="#images-default-architecture" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../server/#server-images:images.default_architecture"><code class="docutils literal notranslate"><span class="pre">images.default_architecture</span></code></a> global configuration key and matching per-project key which lets user tell LXD
what architecture to go with when no specific one is specified as part of the image request.</p>
</section>
<section id="network-ovn-acl-defaults">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_acl_defaults</span></code><a class="headerlink" href="#network-ovn-acl-defaults" title="Link to this heading">¶</a></h2>
<p>Adds new <code class="docutils literal notranslate"><span class="pre">security.acls.default.{in,e}gress.action</span></code> and <code class="docutils literal notranslate"><span class="pre">security.acls.default.{in,e}gress.logged</span></code> configuration keys for
OVN networks and NICs. This replaces the removed ACL <code class="docutils literal notranslate"><span class="pre">default.action</span></code> and <code class="docutils literal notranslate"><span class="pre">default.logged</span></code> keys.</p>
</section>
<section id="gpu-mig">
<h2><code class="docutils literal notranslate"><span class="pre">gpu_mig</span></code><a class="headerlink" href="#gpu-mig" title="Link to this heading">¶</a></h2>
<p>This adds support for NVIDIA MIG. It introduces the <code class="docutils literal notranslate"><span class="pre">mig</span></code> GPU type and associated configuration keys.</p>
</section>
<section id="project-usage">
<h2><code class="docutils literal notranslate"><span class="pre">project_usage</span></code><a class="headerlink" href="#project-usage" title="Link to this heading">¶</a></h2>
<p>Adds an API endpoint to get current resource allocations in a project.
Accessible at API <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/projects/<name>/state</span></code>.</p>
</section>
<section id="network-bridge-acl">
<h2><code class="docutils literal notranslate"><span class="pre">network_bridge_acl</span></code><a class="headerlink" href="#network-bridge-acl" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:security.acls"><code class="docutils literal notranslate"><span class="pre">security.acls</span></code></a> configuration key to <code class="docutils literal notranslate"><span class="pre">bridge</span></code> networks, allowing Network ACLs to be applied.</p>
<p>Also adds <code class="docutils literal notranslate"><span class="pre">security.acls.default.{in,e}gress.action</span></code> and <code class="docutils literal notranslate"><span class="pre">security.acls.default.{in,e}gress.logged</span></code> configuration keys for
specifying the default behavior for unmatched traffic.</p>
</section>
<section id="warnings">
<h2><code class="docutils literal notranslate"><span class="pre">warnings</span></code><a class="headerlink" href="#warnings" title="Link to this heading">¶</a></h2>
<p>Warning API for LXD.</p>
<p>This includes the following endpoints (see <a class="reference internal" href="../rest-api/"><span class="std std-doc">Restful API</span></a> for details):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/warnings</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/warnings/<uuid></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/warnings/<uuid></span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/warnings/<uuid></span></code></p></li>
</ul>
</section>
<section id="projects-restricted-backups-and-snapshots">
<h2><code class="docutils literal notranslate"><span class="pre">projects_restricted_backups_and_snapshots</span></code><a class="headerlink" href="#projects-restricted-backups-and-snapshots" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.backups"><code class="docutils literal notranslate"><span class="pre">restricted.backups</span></code></a> and <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.snapshots"><code class="docutils literal notranslate"><span class="pre">restricted.snapshots</span></code></a> configuration keys to project which
prevents the user from creation of backups and snapshots.</p>
</section>
<section id="clustering-join-token">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_join_token</span></code><a class="headerlink" href="#clustering-join-token" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/cluster/members</span></code> API endpoint for requesting a join token used when adding new cluster members
without using the trust password.</p>
</section>
<section id="clustering-description">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_description</span></code><a class="headerlink" href="#clustering-description" title="Link to this heading">¶</a></h2>
<p>Adds an editable description to the cluster members.</p>
</section>
<section id="server-trusted-proxy">
<h2><code class="docutils literal notranslate"><span class="pre">server_trusted_proxy</span></code><a class="headerlink" href="#server-trusted-proxy" title="Link to this heading">¶</a></h2>
<p>This introduces support for <a class="configref reference internal" href="../server/#server-core:core.https_trusted_proxy"><code class="docutils literal notranslate"><span class="pre">core.https_trusted_proxy</span></code></a> which has LXD
parse a HAProxy style connection header on such connections and if
present, will rewrite the request’s source address to that provided by
the proxy server.</p>
</section>
<section id="clustering-update-cert">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_update_cert</span></code><a class="headerlink" href="#clustering-update-cert" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/cluster/certificate</span></code> endpoint for updating the cluster
certificate across the whole cluster</p>
</section>
<section id="storage-api-project">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_project</span></code><a class="headerlink" href="#storage-api-project" title="Link to this heading">¶</a></h2>
<p>This adds support for copy/move custom storage volumes between projects.</p>
</section>
<section id="server-instance-driver-operational">
<h2><code class="docutils literal notranslate"><span class="pre">server_instance_driver_operational</span></code><a class="headerlink" href="#server-instance-driver-operational" title="Link to this heading">¶</a></h2>
<p>This modifies the <code class="docutils literal notranslate"><span class="pre">driver</span></code> output for the <code class="docutils literal notranslate"><span class="pre">/1.0</span></code> endpoint to only include drivers which are actually supported and
operational on the server (as opposed to being included in LXD but not operational on the server).</p>
</section>
<section id="server-supported-storage-drivers">
<h2><code class="docutils literal notranslate"><span class="pre">server_supported_storage_drivers</span></code><a class="headerlink" href="#server-supported-storage-drivers" title="Link to this heading">¶</a></h2>
<p>This adds supported storage driver info to server environment info.</p>
</section>
<section id="event-lifecycle-requestor-address">
<h2><code class="docutils literal notranslate"><span class="pre">event_lifecycle_requestor_address</span></code><a class="headerlink" href="#event-lifecycle-requestor-address" title="Link to this heading">¶</a></h2>
<p>Adds a new address field to <code class="docutils literal notranslate"><span class="pre">lifecycle</span></code> requestor.</p>
</section>
<section id="resources-gpu-usb">
<h2><code class="docutils literal notranslate"><span class="pre">resources_gpu_usb</span></code><a class="headerlink" href="#resources-gpu-usb" title="Link to this heading">¶</a></h2>
<p>Add a new <code class="docutils literal notranslate"><span class="pre">USBAddress</span></code> (<code class="docutils literal notranslate"><span class="pre">usb_address</span></code>) field to <code class="docutils literal notranslate"><span class="pre">ResourcesGPUCard</span></code> (GPU entries) in the resources API.</p>
</section>
<section id="clustering-evacuation">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_evacuation</span></code><a class="headerlink" href="#clustering-evacuation" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/cluster/members/<name>/state</span></code> endpoint for evacuating and restoring cluster members.
It also adds the configuration keys <a class="configref reference internal" href="../reference/instance_options/#instance-miscellaneous:cluster.evacuate"><code class="docutils literal notranslate"><span class="pre">cluster.evacuate</span></code></a> and <a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.evacuate.origin"><code class="docutils literal notranslate"><span class="pre">volatile.evacuate.origin</span></code></a> for setting the evacuation method (<code class="docutils literal notranslate"><span class="pre">auto</span></code>, <code class="docutils literal notranslate"><span class="pre">stop</span></code> or <code class="docutils literal notranslate"><span class="pre">migrate</span></code>) and the origin of any migrated instance respectively.</p>
</section>
<section id="network-ovn-nat-address">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_nat_address</span></code><a class="headerlink" href="#network-ovn-nat-address" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv4.nat.address"><code class="docutils literal notranslate"><span class="pre">ipv4.nat.address</span></code></a> and <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv6.nat.address"><code class="docutils literal notranslate"><span class="pre">ipv6.nat.address</span></code></a> configuration keys for LXD <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks.
Those keys control the source address used for outbound traffic from the OVN virtual network.
These keys can only be specified when the OVN network’s uplink network has <a class="configref reference internal" href="../reference/network_physical/#network-physical-network-conf:ovn.ingress_mode"><code class="docutils literal notranslate"><span class="pre">ovn.ingress_mode</span></code></a> set to <code class="docutils literal notranslate"><span class="pre">routed</span></code>.</p>
</section>
<section id="network-bgp">
<h2><code class="docutils literal notranslate"><span class="pre">network_bgp</span></code><a class="headerlink" href="#network-bgp" title="Link to this heading">¶</a></h2>
<p>This introduces support for LXD acting as a BGP router to advertise
routes to <code class="docutils literal notranslate"><span class="pre">bridge</span></code> and <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks.</p>
<p>This comes with the addition to global configuration of:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-core:core.bgp_address"><code class="docutils literal notranslate"><span class="pre">core.bgp_address</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../server/#server-core:core.bgp_asn"><code class="docutils literal notranslate"><span class="pre">core.bgp_asn</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../server/#server-core:core.bgp_routerid"><code class="docutils literal notranslate"><span class="pre">core.bgp_routerid</span></code></a></p></li>
</ul>
<p>The following network configurations keys (<code class="docutils literal notranslate"><span class="pre">bridge</span></code> and <code class="docutils literal notranslate"><span class="pre">physical</span></code>):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">bgp.peers.<name>.address</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bgp.peers.<name>.asn</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bgp.peers.<name>.password</span></code></p></li>
</ul>
<p>The <code class="docutils literal notranslate"><span class="pre">nexthop</span></code> configuration keys (<code class="docutils literal notranslate"><span class="pre">bridge</span></code>):</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:bgp.ipv4.nexthop"><code class="docutils literal notranslate"><span class="pre">bgp.ipv4.nexthop</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/network_bridge/#network-bridge-network-conf:bgp.ipv6.nexthop"><code class="docutils literal notranslate"><span class="pre">bgp.ipv6.nexthop</span></code></a></p></li>
</ul>
<p>And the following NIC-specific configuration keys (<code class="docutils literal notranslate"><span class="pre">bridged</span></code> NIC type):</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:ipv4.routes.external"><code class="docutils literal notranslate"><span class="pre">ipv4.routes.external</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/devices_nic/#device-nic-bridged-device-conf:ipv6.routes.external"><code class="docutils literal notranslate"><span class="pre">ipv6.routes.external</span></code></a></p></li>
</ul>
</section>
<section id="network-forward">
<h2><code class="docutils literal notranslate"><span class="pre">network_forward</span></code><a class="headerlink" href="#network-forward" title="Link to this heading">¶</a></h2>
<p>This introduces the networking address forward functionality. Allowing for <code class="docutils literal notranslate"><span class="pre">bridge</span></code> and <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks to define
external IP addresses that can be forwarded to internal IP(s) inside their respective networks.</p>
</section>
<section id="custom-volume-refresh">
<h2><code class="docutils literal notranslate"><span class="pre">custom_volume_refresh</span></code><a class="headerlink" href="#custom-volume-refresh" title="Link to this heading">¶</a></h2>
<p>Adds support for refresh during volume migration.</p>
</section>
<section id="network-counters-errors-dropped">
<h2><code class="docutils literal notranslate"><span class="pre">network_counters_errors_dropped</span></code><a class="headerlink" href="#network-counters-errors-dropped" title="Link to this heading">¶</a></h2>
<p>This adds the received and sent errors as well as inbound and outbound dropped packets to the network counters.</p>
</section>
<section id="metrics">
<h2><code class="docutils literal notranslate"><span class="pre">metrics</span></code><a class="headerlink" href="#metrics" title="Link to this heading">¶</a></h2>
<p>This adds metrics to LXD. It returns metrics of running instances using the OpenMetrics format.</p>
<p>This includes the following endpoints:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/metrics</span></code></p></li>
</ul>
</section>
<section id="image-source-project">
<h2><code class="docutils literal notranslate"><span class="pre">image_source_project</span></code><a class="headerlink" href="#image-source-project" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">project</span></code> field to <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/images</span></code> allowing for the source project
to be set at image copy time.</p>
</section>
<section id="clustering-config">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_config</span></code><a class="headerlink" href="#clustering-config" title="Link to this heading">¶</a></h2>
<p>Adds new <code class="docutils literal notranslate"><span class="pre">config</span></code> property to cluster members with configurable key/value pairs.</p>
</section>
<section id="network-peer">
<h2><code class="docutils literal notranslate"><span class="pre">network_peer</span></code><a class="headerlink" href="#network-peer" title="Link to this heading">¶</a></h2>
<p>This adds network peering to allow traffic to flow between OVN networks without leaving the OVN subsystem.</p>
</section>
<section id="linux-sysctl">
<h2><code class="docutils literal notranslate"><span class="pre">linux_sysctl</span></code><a class="headerlink" href="#linux-sysctl" title="Link to this heading">¶</a></h2>
<p>Adds new <code class="docutils literal notranslate"><span class="pre">linux.sysctl.*</span></code> configuration keys allowing users to modify certain kernel parameters
within containers.</p>
</section>
<section id="network-dns">
<h2><code class="docutils literal notranslate"><span class="pre">network_dns</span></code><a class="headerlink" href="#network-dns" title="Link to this heading">¶</a></h2>
<p>Introduces a built-in DNS server and zones API to provide DNS records for LXD instances.</p>
<p>This introduces the following server configuration key:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-core:core.dns_address"><code class="docutils literal notranslate"><span class="pre">core.dns_address</span></code></a></p></li>
</ul>
<p>The following network configuration key:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">dns.zone.forward</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dns.zone.reverse.ipv4</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dns.zone.reverse.ipv6</span></code></p></li>
</ul>
<p>And the following project configuration key:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.networks.zones"><code class="docutils literal notranslate"><span class="pre">restricted.networks.zones</span></code></a></p></li>
</ul>
<p>A new REST API is also introduced to manage DNS zones:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/network-zones</span></code> (GET, POST)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/network-zones/<name></span></code> (GET, PUT, PATCH, DELETE)</p></li>
</ul>
</section>
<section id="ovn-nic-acceleration">
<h2><code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration</span></code><a class="headerlink" href="#ovn-nic-acceleration" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:acceleration"><code class="docutils literal notranslate"><span class="pre">acceleration</span></code></a> configuration key to OVN NICs which can be used for enabling hardware acceleration.
It takes the values <code class="docutils literal notranslate"><span class="pre">none</span></code> or <code class="docutils literal notranslate"><span class="pre">sriov</span></code>.</p>
</section>
<section id="certificate-self-renewal">
<h2><code class="docutils literal notranslate"><span class="pre">certificate_self_renewal</span></code><a class="headerlink" href="#certificate-self-renewal" title="Link to this heading">¶</a></h2>
<p>This adds support for renewing a client’s own trust certificate.</p>
</section>
<section id="instance-project-move">
<h2><code class="docutils literal notranslate"><span class="pre">instance_project_move</span></code><a class="headerlink" href="#instance-project-move" title="Link to this heading">¶</a></h2>
<p>This adds a <code class="docutils literal notranslate"><span class="pre">project</span></code> field to the <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances/NAME</span></code> API,
allowing for easy move of an instance between projects.</p>
</section>
<section id="storage-volume-project-move">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volume_project_move</span></code><a class="headerlink" href="#storage-volume-project-move" title="Link to this heading">¶</a></h2>
<p>This adds support for moving storage volume between projects.</p>
</section>
<section id="cloud-init">
<h2><code class="docutils literal notranslate"><span class="pre">cloud_init</span></code><a class="headerlink" href="#cloud-init" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">cloud-init</span></code> configuration key namespace which contains the following keys:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-cloud-init:cloud-init.vendor-data"><code class="docutils literal notranslate"><span class="pre">cloud-init.vendor-data</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-cloud-init:cloud-init.user-data"><code class="docutils literal notranslate"><span class="pre">cloud-init.user-data</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-cloud-init:cloud-init.network-config"><code class="docutils literal notranslate"><span class="pre">cloud-init.network-config</span></code></a></p></li>
</ul>
<p>It also adds a new endpoint <code class="docutils literal notranslate"><span class="pre">/1.0/devices</span></code> to <code class="docutils literal notranslate"><span class="pre">devlxd</span></code> which shows an instance’s devices.</p>
</section>
<section id="network-dns-nat">
<h2><code class="docutils literal notranslate"><span class="pre">network_dns_nat</span></code><a class="headerlink" href="#network-dns-nat" title="Link to this heading">¶</a></h2>
<p>This introduces <code class="docutils literal notranslate"><span class="pre">network.nat</span></code> as a configuration option on network zones (DNS).</p>
<p>It defaults to the current behavior of generating records for all
instances NICs but if set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, it will instruct LXD to only
generate records for externally reachable addresses.</p>
</section>
<section id="database-leader">
<h2><code class="docutils literal notranslate"><span class="pre">database_leader</span></code><a class="headerlink" href="#database-leader" title="Link to this heading">¶</a></h2>
<p>Adds new <code class="docutils literal notranslate"><span class="pre">database-leader</span></code> role which is assigned to cluster leader.</p>
</section>
<section id="instance-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">instance_all_projects</span></code><a class="headerlink" href="#instance-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for displaying instances from all projects.</p>
</section>
<section id="clustering-groups">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_groups</span></code><a class="headerlink" href="#clustering-groups" title="Link to this heading">¶</a></h2>
<p>Add support for grouping cluster members.</p>
<p>This introduces the following new endpoints:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/cluster/groups</span></code> (GET, POST)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/1.0/cluster/groups/<name></span></code> (GET, POST, PUT, PATCH, DELETE)</p></li>
</ul>
<p>The following project restriction is added:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.cluster.groups"><code class="docutils literal notranslate"><span class="pre">restricted.cluster.groups</span></code></a></p></li>
</ul>
</section>
<section id="ceph-rbd-du">
<h2><code class="docutils literal notranslate"><span class="pre">ceph_rbd_du</span></code><a class="headerlink" href="#ceph-rbd-du" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/storage_ceph/#storage-ceph-pool-conf:ceph.rbd.du"><code class="docutils literal notranslate"><span class="pre">ceph.rbd.du</span></code></a> Boolean on Ceph storage pools which allows
disabling the use of the potentially slow <code class="docutils literal notranslate"><span class="pre">rbd</span> <span class="pre">du</span></code> calls.</p>
</section>
<section id="instance-get-full">
<h2><code class="docutils literal notranslate"><span class="pre">instance_get_full</span></code><a class="headerlink" href="#instance-get-full" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">recursion=1</span></code> mode for <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/instances/{name}</span></code> which allows for the retrieval of
all instance structs, including the state, snapshots and backup structs.</p>
</section>
<section id="qemu-metrics">
<h2><code class="docutils literal notranslate"><span class="pre">qemu_metrics</span></code><a class="headerlink" href="#qemu-metrics" title="Link to this heading">¶</a></h2>
<p>This adds a new <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.agent.metrics"><code class="docutils literal notranslate"><span class="pre">security.agent.metrics</span></code></a> Boolean which defaults to <code class="docutils literal notranslate"><span class="pre">true</span></code>.
When set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, it doesn’t connect to the <code class="docutils literal notranslate"><span class="pre">lxd-agent</span></code> for metrics and other state information, but relies on stats from QEMU.</p>
</section>
<section id="gpu-mig-uuid">
<h2><code class="docutils literal notranslate"><span class="pre">gpu_mig_uuid</span></code><a class="headerlink" href="#gpu-mig-uuid" title="Link to this heading">¶</a></h2>
<p>Adds support for the new MIG UUID format used by NVIDIA <code class="docutils literal notranslate"><span class="pre">470+</span></code> drivers (for example, <code class="docutils literal notranslate"><span class="pre">MIG-74c6a31a-fde5-5c61-973b-70e12346c202</span></code>),
the <code class="docutils literal notranslate"><span class="pre">MIG-</span></code> prefix can be omitted</p>
<p>This extension supersedes old <code class="docutils literal notranslate"><span class="pre">mig.gi</span></code> and <code class="docutils literal notranslate"><span class="pre">mig.ci</span></code> parameters which are kept for compatibility with old drivers and
cannot be set together.</p>
</section>
<section id="event-project">
<h2><code class="docutils literal notranslate"><span class="pre">event_project</span></code><a class="headerlink" href="#event-project" title="Link to this heading">¶</a></h2>
<p>Expose the project an API event belongs to.</p>
</section>
<section id="clustering-evacuation-live">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_evacuation_live</span></code><a class="headerlink" href="#clustering-evacuation-live" title="Link to this heading">¶</a></h2>
<p>This adds <code class="docutils literal notranslate"><span class="pre">live-migrate</span></code> as a configuration option to <a class="configref reference internal" href="../reference/instance_options/#instance-miscellaneous:cluster.evacuate"><code class="docutils literal notranslate"><span class="pre">cluster.evacuate</span></code></a>, which forces live-migration
of instances during cluster evacuation.</p>
</section>
<section id="instance-allow-inconsistent-copy">
<h2><code class="docutils literal notranslate"><span class="pre">instance_allow_inconsistent_copy</span></code><a class="headerlink" href="#instance-allow-inconsistent-copy" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">allow_inconsistent</span></code> field to instance source on <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances</span></code>. If <code class="docutils literal notranslate"><span class="pre">true</span></code>, <code class="docutils literal notranslate"><span class="pre">rsync</span></code> will ignore the
<code class="docutils literal notranslate"><span class="pre">Partial</span> <span class="pre">transfer</span> <span class="pre">due</span> <span class="pre">to</span> <span class="pre">vanished</span> <span class="pre">source</span> <span class="pre">files</span></code> (code 24) error when creating an instance from a copy.</p>
</section>
<section id="network-state-ovn">
<h2><code class="docutils literal notranslate"><span class="pre">network_state_ovn</span></code><a class="headerlink" href="#network-state-ovn" title="Link to this heading">¶</a></h2>
<p>This adds an <code class="docutils literal notranslate"><span class="pre">ovn</span></code> section to the <code class="docutils literal notranslate"><span class="pre">/1.0/networks/NAME/state</span></code> API which contains additional state information relevant to
OVN networks:</p>
<ul class="simple">
<li><p>chassis</p></li>
</ul>
</section>
<section id="storage-volume-api-filtering">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volume_api_filtering</span></code><a class="headerlink" href="#storage-volume-api-filtering" title="Link to this heading">¶</a></h2>
<p>Adds support for filtering the result of a GET request for storage volumes.</p>
</section>
<section id="image-restrictions">
<h2><code class="docutils literal notranslate"><span class="pre">image_restrictions</span></code><a class="headerlink" href="#image-restrictions" title="Link to this heading">¶</a></h2>
<p>This extension adds on to the image properties to include image restrictions/host requirements. These requirements
help determine the compatibility between an instance and the host system.</p>
</section>
<section id="storage-zfs-export">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_export</span></code><a class="headerlink" href="#storage-zfs-export" title="Link to this heading">¶</a></h2>
<p>Introduces the ability to disable zpool export when unmounting pool by setting <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-pool-conf:zfs.export"><code class="docutils literal notranslate"><span class="pre">zfs.export</span></code></a>.</p>
</section>
<section id="network-dns-records">
<h2><code class="docutils literal notranslate"><span class="pre">network_dns_records</span></code><a class="headerlink" href="#network-dns-records" title="Link to this heading">¶</a></h2>
<p>This extends the network zones (DNS) API to add the ability to create and manage custom records.</p>
<p>This adds:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/network-zones/ZONE/records</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/network-zones/ZONE/records</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/network-zones/ZONE/records/RECORD</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/network-zones/ZONE/records/RECORD</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/network-zones/ZONE/records/RECORD</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/network-zones/ZONE/records/RECORD</span></code></p></li>
</ul>
</section>
<section id="storage-zfs-reserve-space">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_reserve_space</span></code><a class="headerlink" href="#storage-zfs-reserve-space" title="Link to this heading">¶</a></h2>
<p>Adds ability to set the <code class="docutils literal notranslate"><span class="pre">reservation</span></code>/<code class="docutils literal notranslate"><span class="pre">refreservation</span></code> ZFS property along with <code class="docutils literal notranslate"><span class="pre">quota</span></code>/<code class="docutils literal notranslate"><span class="pre">refquota</span></code>.</p>
</section>
<section id="network-acl-log">
<h2><code class="docutils literal notranslate"><span class="pre">network_acl_log</span></code><a class="headerlink" href="#network-acl-log" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/networks-acls/NAME/log</span></code> API to retrieve ACL firewall logs.</p>
</section>
<section id="storage-zfs-blocksize">
<h2><code class="docutils literal notranslate"><span class="pre">storage_zfs_blocksize</span></code><a class="headerlink" href="#storage-zfs-blocksize" title="Link to this heading">¶</a></h2>
<p>Introduces a new <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-volume-conf:zfs.blocksize"><code class="docutils literal notranslate"><span class="pre">zfs.blocksize</span></code></a> property for ZFS storage volumes which allows to set volume block size.</p>
</section>
<section id="metrics-cpu-seconds">
<h2><code class="docutils literal notranslate"><span class="pre">metrics_cpu_seconds</span></code><a class="headerlink" href="#metrics-cpu-seconds" title="Link to this heading">¶</a></h2>
<p>This is used to detect whether LXD was fixed to output used CPU time in seconds rather than as milliseconds.</p>
</section>
<section id="instance-snapshot-never">
<h2><code class="docutils literal notranslate"><span class="pre">instance_snapshot_never</span></code><a class="headerlink" href="#instance-snapshot-never" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">@never</span></code> option to <code class="docutils literal notranslate"><span class="pre">snapshots.schedule</span></code> which allows disabling inheritance.</p>
</section>
<section id="certificate-token">
<h2><code class="docutils literal notranslate"><span class="pre">certificate_token</span></code><a class="headerlink" href="#certificate-token" title="Link to this heading">¶</a></h2>
<p>This adds token-based certificate addition to the trust store as a safer alternative to a trust password.</p>
<p>It adds the <code class="docutils literal notranslate"><span class="pre">token</span></code> field to <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/certificates</span></code>.</p>
</section>
<section id="instance-nic-routed-neighbor-probe">
<h2><code class="docutils literal notranslate"><span class="pre">instance_nic_routed_neighbor_probe</span></code><a class="headerlink" href="#instance-nic-routed-neighbor-probe" title="Link to this heading">¶</a></h2>
<p>This adds the ability to disable the <code class="docutils literal notranslate"><span class="pre">routed</span></code> NIC IP neighbor probing for availability on the parent network.</p>
<p>Adds the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv4.neighbor_probe"><code class="docutils literal notranslate"><span class="pre">ipv4.neighbor_probe</span></code></a> and <a class="configref reference internal" href="../reference/devices_nic/#device-nic-routed-device-conf:ipv6.neighbor_probe"><code class="docutils literal notranslate"><span class="pre">ipv6.neighbor_probe</span></code></a> NIC settings. Defaulting to <code class="docutils literal notranslate"><span class="pre">true</span></code> if not specified.</p>
</section>
<section id="event-hub">
<h2><code class="docutils literal notranslate"><span class="pre">event_hub</span></code><a class="headerlink" href="#event-hub" title="Link to this heading">¶</a></h2>
<p>This adds support for <code class="docutils literal notranslate"><span class="pre">event-hub</span></code> cluster member role and the <code class="docutils literal notranslate"><span class="pre">ServerEventMode</span></code> environment field.</p>
</section>
<section id="agent-nic-config">
<h2><code class="docutils literal notranslate"><span class="pre">agent_nic_config</span></code><a class="headerlink" href="#agent-nic-config" title="Link to this heading">¶</a></h2>
<p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, on VM start-up the <code class="docutils literal notranslate"><span class="pre">lxd-agent</span></code> will apply NIC configuration to change the names and MTU of the instance NIC
devices.</p>
</section>
<section id="projects-restricted-intercept">
<h2><code class="docutils literal notranslate"><span class="pre">projects_restricted_intercept</span></code><a class="headerlink" href="#projects-restricted-intercept" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.containers.interception"><code class="docutils literal notranslate"><span class="pre">restricted.containers.interception</span></code></a> configuration key to allow usually safe system call interception options.</p>
</section>
<section id="metrics-authentication">
<h2><code class="docutils literal notranslate"><span class="pre">metrics_authentication</span></code><a class="headerlink" href="#metrics-authentication" title="Link to this heading">¶</a></h2>
<p>Introduces a new <a class="configref reference internal" href="../server/#server-core:core.metrics_authentication"><code class="docutils literal notranslate"><span class="pre">core.metrics_authentication</span></code></a> server configuration option to
allow for the <code class="docutils literal notranslate"><span class="pre">/1.0/metrics</span></code> endpoint to be generally available without
client authentication.</p>
</section>
<section id="images-target-project">
<h2><code class="docutils literal notranslate"><span class="pre">images_target_project</span></code><a class="headerlink" href="#images-target-project" title="Link to this heading">¶</a></h2>
<p>Adds ability to copy image to a project different from the source.</p>
</section>
<section id="cluster-migration-inconsistent-copy">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_migration_inconsistent_copy</span></code><a class="headerlink" href="#cluster-migration-inconsistent-copy" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">allow_inconsistent</span></code> field to <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances/<name></span></code>. Set to <code class="docutils literal notranslate"><span class="pre">true</span></code> to allow inconsistent copying between cluster
members.</p>
</section>
<section id="cluster-ovn-chassis">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_ovn_chassis</span></code><a class="headerlink" href="#cluster-ovn-chassis" title="Link to this heading">¶</a></h2>
<p>Introduces a new <code class="docutils literal notranslate"><span class="pre">ovn-chassis</span></code> cluster role which allows for specifying what cluster member should act as an OVN chassis.</p>
</section>
<section id="container-syscall-intercept-sched-setscheduler">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_sched_setscheduler</span></code><a class="headerlink" href="#container-syscall-intercept-sched-setscheduler" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.intercept.sched_setscheduler"><code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.sched_setscheduler</span></code></a> to allow advanced process priority management in containers.</p>
</section>
<section id="storage-lvm-thinpool-metadata-size">
<h2><code class="docutils literal notranslate"><span class="pre">storage_lvm_thinpool_metadata_size</span></code><a class="headerlink" href="#storage-lvm-thinpool-metadata-size" title="Link to this heading">¶</a></h2>
<p>Introduces the ability to specify the thin pool metadata volume size via <a class="configref reference internal" href="../reference/storage_lvm/#storage-lvm-pool-conf:lvm.thinpool_metadata_size"><code class="docutils literal notranslate"><span class="pre">lvm.thinpool_metadata_size</span></code></a>.</p>
<p>If this is not specified then the default is to let LVM pick an appropriate thin pool metadata volume size.</p>
</section>
<section id="storage-volume-state-total">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volume_state_total</span></code><a class="headerlink" href="#storage-volume-state-total" title="Link to this heading">¶</a></h2>
<p>This adds <code class="docutils literal notranslate"><span class="pre">total</span></code> field to the <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/{name}/volumes/{type}/{volume}/state</span></code> API.</p>
</section>
<section id="instance-file-head">
<h2><code class="docutils literal notranslate"><span class="pre">instance_file_head</span></code><a class="headerlink" href="#instance-file-head" title="Link to this heading">¶</a></h2>
<p>Implements HEAD on <code class="docutils literal notranslate"><span class="pre">/1.0/instances/NAME/file</span></code>.</p>
</section>
<section id="instances-nic-host-name">
<h2><code class="docutils literal notranslate"><span class="pre">instances_nic_host_name</span></code><a class="headerlink" href="#instances-nic-host-name" title="Link to this heading">¶</a></h2>
<p>This introduces the <a class="configref reference internal" href="../server/#server-miscellaneous:instances.nic.host_name"><code class="docutils literal notranslate"><span class="pre">instances.nic.host_name</span></code></a> server configuration key that can take a value of either <code class="docutils literal notranslate"><span class="pre">random</span></code> or
<code class="docutils literal notranslate"><span class="pre">mac</span></code>. The default value for the key if unspecified is <code class="docutils literal notranslate"><span class="pre">random</span></code>. If it is set to random then use the random host interface names.
If it’s set to <code class="docutils literal notranslate"><span class="pre">mac</span></code>, then generate a name in the form <code class="docutils literal notranslate"><span class="pre">lxd1122334455</span></code>.</p>
</section>
<section id="image-copy-profile">
<h2><code class="docutils literal notranslate"><span class="pre">image_copy_profile</span></code><a class="headerlink" href="#image-copy-profile" title="Link to this heading">¶</a></h2>
<p>Adds ability to modify the set of profiles when image is copied.</p>
</section>
<section id="container-syscall-intercept-sysinfo">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_sysinfo</span></code><a class="headerlink" href="#container-syscall-intercept-sysinfo" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.syscalls.intercept.sysinfo"><code class="docutils literal notranslate"><span class="pre">security.syscalls.intercept.sysinfo</span></code></a> to allow the <code class="docutils literal notranslate"><span class="pre">sysinfo</span></code> syscall to be populated with cgroup-based resource usage information.</p>
</section>
<section id="clustering-evacuation-mode">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_evacuation_mode</span></code><a class="headerlink" href="#clustering-evacuation-mode" title="Link to this heading">¶</a></h2>
<p>This introduces a <code class="docutils literal notranslate"><span class="pre">mode</span></code> field to the evacuation request which allows
for overriding the evacuation mode traditionally set through
<a class="configref reference internal" href="../reference/instance_options/#instance-miscellaneous:cluster.evacuate"><code class="docutils literal notranslate"><span class="pre">cluster.evacuate</span></code></a>.</p>
</section>
<section id="resources-pci-vpd">
<h2><code class="docutils literal notranslate"><span class="pre">resources_pci_vpd</span></code><a class="headerlink" href="#resources-pci-vpd" title="Link to this heading">¶</a></h2>
<p>Adds a new VPD struct to the PCI resource entries.
This struct extracts vendor provided data including the full product name and additional key/value configuration pairs.</p>
</section>
<section id="qemu-raw-conf">
<h2><code class="docutils literal notranslate"><span class="pre">qemu_raw_conf</span></code><a class="headerlink" href="#qemu-raw-conf" title="Link to this heading">¶</a></h2>
<p>Introduces a <a class="configref reference internal" href="../reference/instance_options/#instance-raw:raw.qemu.conf"><code class="docutils literal notranslate"><span class="pre">raw.qemu.conf</span></code></a> configuration key to override select sections of the generated <code class="docutils literal notranslate"><span class="pre">qemu.conf</span></code>.</p>
</section>
<section id="storage-cephfs-fscache">
<h2><code class="docutils literal notranslate"><span class="pre">storage_cephfs_fscache</span></code><a class="headerlink" href="#storage-cephfs-fscache" title="Link to this heading">¶</a></h2>
<p>Add support for <code class="docutils literal notranslate"><span class="pre">fscache</span></code>/<code class="docutils literal notranslate"><span class="pre">cachefilesd</span></code> on CephFS pools through a new <a class="configref reference internal" href="../reference/storage_cephfs/#storage-cephfs-pool-conf:cephfs.fscache"><code class="docutils literal notranslate"><span class="pre">cephfs.fscache</span></code></a> configuration option.</p>
</section>
<section id="network-load-balancer">
<h2><code class="docutils literal notranslate"><span class="pre">network_load_balancer</span></code><a class="headerlink" href="#network-load-balancer" title="Link to this heading">¶</a></h2>
<p>This introduces the networking load balancer functionality. Allowing <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks to define port(s) on external
IP addresses that can be forwarded to one or more internal IP(s) inside their respective networks.</p>
</section>
<section id="vsock-api">
<h2><code class="docutils literal notranslate"><span class="pre">vsock_api</span></code><a class="headerlink" href="#vsock-api" title="Link to this heading">¶</a></h2>
<p>This introduces a bidirectional <code class="docutils literal notranslate"><span class="pre">vsock</span></code> interface which allows the <code class="docutils literal notranslate"><span class="pre">lxd-agent</span></code> and the LXD server to communicate better.</p>
</section>
<section id="instance-ready-state">
<h2><code class="docutils literal notranslate"><span class="pre">instance_ready_state</span></code><a class="headerlink" href="#instance-ready-state" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">Ready</span></code> state for instances which can be set using <code class="docutils literal notranslate"><span class="pre">devlxd</span></code>.</p>
</section>
<section id="network-bgp-holdtime">
<h2><code class="docutils literal notranslate"><span class="pre">network_bgp_holdtime</span></code><a class="headerlink" href="#network-bgp-holdtime" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">bgp.peers.<name>.holdtime</span></code> configuration key to control the BGP hold time for a particular peer.</p>
</section>
<section id="storage-volumes-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volumes_all_projects</span></code><a class="headerlink" href="#storage-volumes-all-projects" title="Link to this heading">¶</a></h2>
<p>This introduces the ability to list storage volumes from all projects.</p>
</section>
<section id="metrics-memory-oom-total">
<h2><code class="docutils literal notranslate"><span class="pre">metrics_memory_oom_total</span></code><a class="headerlink" href="#metrics-memory-oom-total" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">lxd_memory_OOM_kills_total</span></code> metric to the <code class="docutils literal notranslate"><span class="pre">/1.0/metrics</span></code> API.
It reports the number of times the out of memory killer (<code class="docutils literal notranslate"><span class="pre">OOM</span></code>) has been triggered.</p>
</section>
<section id="storage-buckets">
<h2><code class="docutils literal notranslate"><span class="pre">storage_buckets</span></code><a class="headerlink" href="#storage-buckets" title="Link to this heading">¶</a></h2>
<p>This introduces the storage bucket API. It allows the management of S3 object storage buckets for storage pools.</p>
</section>
<section id="storage-buckets-create-credentials">
<h2><code class="docutils literal notranslate"><span class="pre">storage_buckets_create_credentials</span></code><a class="headerlink" href="#storage-buckets-create-credentials" title="Link to this heading">¶</a></h2>
<p>This updates the storage bucket API to return initial admin credentials at bucket creation time.</p>
</section>
<section id="metrics-cpu-effective-total">
<h2><code class="docutils literal notranslate"><span class="pre">metrics_cpu_effective_total</span></code><a class="headerlink" href="#metrics-cpu-effective-total" title="Link to this heading">¶</a></h2>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">lxd_cpu_effective_total</span></code> metric to the <code class="docutils literal notranslate"><span class="pre">/1.0/metrics</span></code> API.
It reports the total number of effective CPUs.</p>
</section>
<section id="projects-networks-restricted-access">
<h2><code class="docutils literal notranslate"><span class="pre">projects_networks_restricted_access</span></code><a class="headerlink" href="#projects-networks-restricted-access" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.networks.access"><code class="docutils literal notranslate"><span class="pre">restricted.networks.access</span></code></a> project configuration key to indicate (as a comma-delimited list) which networks can be accessed inside the project.
If not specified, all networks are accessible (assuming it is also allowed by the <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.devices.nic"><code class="docutils literal notranslate"><span class="pre">restricted.devices.nic</span></code></a> setting, described below).</p>
<p>This also introduces a change whereby network access is controlled by the project’s <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.devices.nic"><code class="docutils literal notranslate"><span class="pre">restricted.devices.nic</span></code></a> setting:</p>
<ul class="simple">
<li><p>If <code class="docutils literal notranslate"><span class="pre">restricted.devices.nic</span></code> is set to <code class="docutils literal notranslate"><span class="pre">managed</span></code> (the default if not specified), only managed networks are accessible.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">restricted.devices.nic</span></code> is set to <code class="docutils literal notranslate"><span class="pre">allow</span></code>, all networks are accessible (dependent on the <code class="docutils literal notranslate"><span class="pre">restricted.networks.access</span></code> setting).</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">restricted.devices.nic</span></code> is set to <code class="docutils literal notranslate"><span class="pre">block</span></code>, no networks are accessible.</p></li>
</ul>
</section>
<section id="storage-buckets-local">
<h2><code class="docutils literal notranslate"><span class="pre">storage_buckets_local</span></code><a class="headerlink" href="#storage-buckets-local" title="Link to this heading">¶</a></h2>
<p>This introduces the ability to use storage buckets on local storage pools by setting the new <a class="configref reference internal" href="../server/#server-core:core.storage_buckets_address"><code class="docutils literal notranslate"><span class="pre">core.storage_buckets_address</span></code></a> global configuration setting.</p>
</section>
<section id="loki">
<h2><code class="docutils literal notranslate"><span class="pre">loki</span></code><a class="headerlink" href="#loki" title="Link to this heading">¶</a></h2>
<p>This adds support for sending life cycle and logging events to a Loki server.</p>
<p>It adds the following global configuration keys:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-loki:loki.api.ca_cert"><code class="docutils literal notranslate"><span class="pre">loki.api.ca_cert</span></code></a>: CA certificate which can be used when sending events to the Loki server</p></li>
<li><p><a class="configref reference internal" href="../server/#server-loki:loki.api.url"><code class="docutils literal notranslate"><span class="pre">loki.api.url</span></code></a>: URL to the Loki server (protocol, name or IP and port)</p></li>
<li><p><a class="configref reference internal" href="../server/#server-loki:loki.auth.username"><code class="docutils literal notranslate"><span class="pre">loki.auth.username</span></code></a> and <a class="configref reference internal" href="../server/#server-loki:loki.auth.password"><code class="docutils literal notranslate"><span class="pre">loki.auth.password</span></code></a>: Used if Loki is behind a reverse proxy with basic authentication enabled</p></li>
<li><p><a class="configref reference internal" href="../server/#server-loki:loki.labels"><code class="docutils literal notranslate"><span class="pre">loki.labels</span></code></a>: Comma-separated list of values which are to be used as labels for Loki events.</p></li>
<li><p><a class="configref reference internal" href="../server/#server-loki:loki.loglevel"><code class="docutils literal notranslate"><span class="pre">loki.loglevel</span></code></a>: Minimum log level for events sent to the Loki server.</p></li>
<li><p><a class="configref reference internal" href="../server/#server-loki:loki.types"><code class="docutils literal notranslate"><span class="pre">loki.types</span></code></a>: Types of events which are to be sent to the Loki server (<code class="docutils literal notranslate"><span class="pre">lifecycle</span></code> and/or <code class="docutils literal notranslate"><span class="pre">logging</span></code>).</p></li>
</ul>
</section>
<section id="acme">
<h2><code class="docutils literal notranslate"><span class="pre">acme</span></code><a class="headerlink" href="#acme" title="Link to this heading">¶</a></h2>
<p>This adds ACME support, which allows <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> or other ACME services to issue certificates.</p>
<p>It adds the following global configuration keys:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-acme:acme.domain"><code class="docutils literal notranslate"><span class="pre">acme.domain</span></code></a>: The domain for which the certificate should be issued.</p></li>
<li><p><a class="configref reference internal" href="../server/#server-acme:acme.email"><code class="docutils literal notranslate"><span class="pre">acme.email</span></code></a>: The email address used for the account of the ACME service.</p></li>
<li><p><a class="configref reference internal" href="../server/#server-acme:acme.ca_url"><code class="docutils literal notranslate"><span class="pre">acme.ca_url</span></code></a>: The directory URL of the ACME service, defaults to <code class="docutils literal notranslate"><span class="pre">https://acme-v02.api.letsencrypt.org/directory</span></code>.</p></li>
</ul>
<p>It also adds the following endpoint, which is required for the HTTP-01 challenge:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">/.well-known/acme-challenge/<token></span></code></p></li>
</ul>
</section>
<section id="internal-metrics">
<h2><code class="docutils literal notranslate"><span class="pre">internal_metrics</span></code><a class="headerlink" href="#internal-metrics" title="Link to this heading">¶</a></h2>
<p>This adds internal metrics to the list of metrics.
These include:</p>
<ul class="simple">
<li><p>Total running operations</p></li>
<li><p>Total active warnings</p></li>
<li><p>Daemon uptime in seconds</p></li>
<li><p>Go memory stats</p></li>
<li><p>Number of goroutines</p></li>
</ul>
</section>
<section id="cluster-join-token-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_join_token_expiry</span></code><a class="headerlink" href="#cluster-join-token-expiry" title="Link to this heading">¶</a></h2>
<p>This adds an expiry to cluster join tokens which defaults to 3 hours, but can be changed by setting the <a class="configref reference internal" href="../server/#server-cluster:cluster.join_token_expiry"><code class="docutils literal notranslate"><span class="pre">cluster.join_token_expiry</span></code></a> configuration key.</p>
</section>
<section id="remote-token-expiry">
<h2><code class="docutils literal notranslate"><span class="pre">remote_token_expiry</span></code><a class="headerlink" href="#remote-token-expiry" title="Link to this heading">¶</a></h2>
<p>This adds an expiry to remote add join tokens.
It can be set in the <a class="configref reference internal" href="../server/#server-core:core.remote_token_expiry"><code class="docutils literal notranslate"><span class="pre">core.remote_token_expiry</span></code></a> configuration key, and defaults to 15 days.</p>
</section>
<section id="storage-volumes-created-at">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volumes_created_at</span></code><a class="headerlink" href="#storage-volumes-created-at" title="Link to this heading">¶</a></h2>
<p>This change adds support for storing the creation date and time of storage volumes and their snapshots.</p>
<p>This adds the <code class="docutils literal notranslate"><span class="pre">CreatedAt</span></code> field to the <code class="docutils literal notranslate"><span class="pre">StorageVolume</span></code> and <code class="docutils literal notranslate"><span class="pre">StorageVolumeSnapshot</span></code> API types.</p>
</section>
<section id="cpu-hotplug">
<h2><code class="docutils literal notranslate"><span class="pre">cpu_hotplug</span></code><a class="headerlink" href="#cpu-hotplug" title="Link to this heading">¶</a></h2>
<p>This adds CPU hotplugging for VMs.
Hotplugging is disabled when using CPU pinning, because this would require hotplugging NUMA devices as well, which is not possible.</p>
</section>
<section id="projects-networks-zones">
<h2><code class="docutils literal notranslate"><span class="pre">projects_networks_zones</span></code><a class="headerlink" href="#projects-networks-zones" title="Link to this heading">¶</a></h2>
<p>This adds support for the <a class="configref reference internal" href="../reference/projects/#project-features:features.networks.zones"><code class="docutils literal notranslate"><span class="pre">features.networks.zones</span></code></a> project feature, which changes which project network zones are
associated with when they are created. Previously network zones were tied to the value of <a class="configref reference internal" href="../reference/projects/#project-features:features.networks"><code class="docutils literal notranslate"><span class="pre">features.networks</span></code></a>,
meaning they were created in the same project as networks were.</p>
<p>Now this has been decoupled from <a class="configref reference internal" href="../reference/projects/#project-features:features.networks"><code class="docutils literal notranslate"><span class="pre">features.networks</span></code></a> to allow projects that share a network in the default project
(i.e those with <code class="docutils literal notranslate"><span class="pre">features.networks=false</span></code>) to have their own project level DNS zones that give a project oriented
“view” of the addresses on that shared network (which only includes addresses from instances in their project).</p>
<p>This also introduces a change to the network <code class="docutils literal notranslate"><span class="pre">dns.zone.forward</span></code> setting, which now accepts a comma-separated of
DNS zone names (a maximum of one per project) in order to associate a shared network with multiple zones.</p>
<p>No change to the <code class="docutils literal notranslate"><span class="pre">dns.zone.reverse.*</span></code> settings have been made, they still only allow a single DNS zone to be set.
However the resulting zone content that is generated now includes <code class="docutils literal notranslate"><span class="pre">PTR</span></code> records covering addresses from all
projects that are referencing that network via one of their forward zones.</p>
<p>Existing projects that have <code class="docutils literal notranslate"><span class="pre">features.networks=true</span></code> will have <code class="docutils literal notranslate"><span class="pre">features.networks.zones=true</span></code> set automatically,
but new projects will need to specify this explicitly.</p>
</section>
<section id="instance-nic-txqueuelength">
<h2><code class="docutils literal notranslate"><span class="pre">instance_nic_txqueuelength</span></code><a class="headerlink" href="#instance-nic-txqueuelength" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">txqueuelen</span></code> key to control the <code class="docutils literal notranslate"><span class="pre">txqueuelen</span></code> parameter of the NIC device.</p>
</section>
<section id="cluster-member-state">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_member_state</span></code><a class="headerlink" href="#cluster-member-state" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/cluster/members/<member>/state</span></code> API endpoint and associated <code class="docutils literal notranslate"><span class="pre">ClusterMemberState</span></code> API response type.</p>
</section>
<section id="storage-pool-source-wipe">
<h2><code class="docutils literal notranslate"><span class="pre">storage_pool_source_wipe</span></code><a class="headerlink" href="#storage-pool-source-wipe" title="Link to this heading">¶</a></h2>
<p>Adds support for a <code class="docutils literal notranslate"><span class="pre">source.wipe</span></code> Boolean on the storage pool, indicating
that LXD should wipe partition headers off the requested disk rather
than potentially fail due to pre-existing file systems.</p>
</section>
<section id="zfs-block-mode">
<h2><code class="docutils literal notranslate"><span class="pre">zfs_block_mode</span></code><a class="headerlink" href="#zfs-block-mode" title="Link to this heading">¶</a></h2>
<p>This adds support for using ZFS block <spellexception>filesystem</spellexception> volumes allowing the use of different file systems on top of ZFS.</p>
<p>This adds the following new configuration options for ZFS storage pools:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">volume.zfs.block_mode</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">volume.block.mount_options</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">volume.block.filesystem</span></code></p></li>
</ul>
</section>
<section id="instance-generation-id">
<h2><code class="docutils literal notranslate"><span class="pre">instance_generation_id</span></code><a class="headerlink" href="#instance-generation-id" title="Link to this heading">¶</a></h2>
<p>Adds support for instance generation ID. The VM or container generation ID will change whenever the instance’s place in time moves backwards. As of now, the generation ID is only exposed through to VM type instances. This allows for the VM guest OS to reinitialize any state it needs to avoid duplicating potential state that has already occurred:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.uuid.generation"><code class="docutils literal notranslate"><span class="pre">volatile.uuid.generation</span></code></a></p></li>
</ul>
</section>
<section id="disk-io-cache">
<h2><code class="docutils literal notranslate"><span class="pre">disk_io_cache</span></code><a class="headerlink" href="#disk-io-cache" title="Link to this heading">¶</a></h2>
<p>This introduces a new <a class="configref reference internal" href="../reference/devices_disk/#device-disk-device-conf:io.cache"><code class="docutils literal notranslate"><span class="pre">io.cache</span></code></a> property to disk devices which can be used to override the VM caching behavior.</p>
</section>
<section id="amd-sev">
<h2><code class="docutils literal notranslate"><span class="pre">amd_sev</span></code><a class="headerlink" href="#amd-sev" title="Link to this heading">¶</a></h2>
<p>Adds support for AMD SEV (Secure Encrypted Virtualization) that can be used to encrypt the memory of a guest VM.</p>
<p>This adds the following new configuration options for SEV encryption:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.sev"><code class="docutils literal notranslate"><span class="pre">security.sev</span></code></a> : (bool) is SEV enabled for this VM</p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.sev.policy.es"><code class="docutils literal notranslate"><span class="pre">security.sev.policy.es</span></code></a> : (bool) is SEV-ES enabled for this VM</p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.sev.session.dh"><code class="docutils literal notranslate"><span class="pre">security.sev.session.dh</span></code></a> : (string) guest owner’s <code class="docutils literal notranslate"><span class="pre">base64</span></code>-encoded Diffie-Hellman key</p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-security:security.sev.session.data"><code class="docutils literal notranslate"><span class="pre">security.sev.session.data</span></code></a> : (string) guest owner’s <code class="docutils literal notranslate"><span class="pre">base64</span></code>-encoded session blob</p></li>
</ul>
</section>
<section id="storage-pool-loop-resize">
<h2><code class="docutils literal notranslate"><span class="pre">storage_pool_loop_resize</span></code><a class="headerlink" href="#storage-pool-loop-resize" title="Link to this heading">¶</a></h2>
<p>This allows growing loop file backed storage pools by changing the <code class="docutils literal notranslate"><span class="pre">size</span></code> setting of the pool.</p>
</section>
<section id="migration-vm-live">
<h2><code class="docutils literal notranslate"><span class="pre">migration_vm_live</span></code><a class="headerlink" href="#migration-vm-live" title="Link to this heading">¶</a></h2>
<p>This adds support for performing VM QEMU to QEMU live migration for both shared storage (clustered Ceph) and
non-shared storage pools.</p>
<p>This also adds the <code class="docutils literal notranslate"><span class="pre">CRIUType_VM_QEMU</span></code> value of <code class="docutils literal notranslate"><span class="pre">3</span></code> for the migration <code class="docutils literal notranslate"><span class="pre">CRIUType</span></code> <code class="docutils literal notranslate"><span class="pre">protobuf</span></code> field.</p>
</section>
<section id="ovn-nic-nesting">
<h2><code class="docutils literal notranslate"><span class="pre">ovn_nic_nesting</span></code><a class="headerlink" href="#ovn-nic-nesting" title="Link to this heading">¶</a></h2>
<p>This adds support for nesting an <code class="docutils literal notranslate"><span class="pre">ovn</span></code> NIC inside another <code class="docutils literal notranslate"><span class="pre">ovn</span></code> NIC on the same instance.
This allows for an OVN logical switch port to be tunneled inside another OVN NIC using VLAN tagging.</p>
<p>This feature is configured by specifying the parent NIC name using the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:nested"><code class="docutils literal notranslate"><span class="pre">nested</span></code></a> property and the VLAN ID to use for tunneling with the <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:vlan"><code class="docutils literal notranslate"><span class="pre">vlan</span></code></a> property.</p>
</section>
<section id="oidc">
<h2><code class="docutils literal notranslate"><span class="pre">oidc</span></code><a class="headerlink" href="#oidc" title="Link to this heading">¶</a></h2>
<p>This adds support for OpenID Connect (OIDC) authentication.</p>
<p>This adds the following new configuration keys:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-oidc:oidc.issuer"><code class="docutils literal notranslate"><span class="pre">oidc.issuer</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../server/#server-oidc:oidc.client.id"><code class="docutils literal notranslate"><span class="pre">oidc.client.id</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../server/#server-oidc:oidc.audience"><code class="docutils literal notranslate"><span class="pre">oidc.audience</span></code></a></p></li>
</ul>
</section>
<section id="network-ovn-l3only">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_l3only</span></code><a class="headerlink" href="#network-ovn-l3only" title="Link to this heading">¶</a></h2>
<p>This adds the ability to set an <code class="docutils literal notranslate"><span class="pre">ovn</span></code> network into “layer 3 only” mode.
This mode can be enabled at IPv4 or IPv6 level using <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv4.l3only"><code class="docutils literal notranslate"><span class="pre">ipv4.l3only</span></code></a> and <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv6.l3only"><code class="docutils literal notranslate"><span class="pre">ipv6.l3only</span></code></a> configuration options respectively.</p>
<p>With this mode enabled the following changes are made to the network:</p>
<ul class="simple">
<li><p>The virtual router’s internal port address will be configured with a single host netmask (e.g. /32 for IPv4 or /128 for IPv6).</p></li>
<li><p>Static routes for active instance NIC addresses will be added to the virtual router.</p></li>
<li><p>A discard route for the entire internal subnet will be added to the virtual router to prevent packets destined for inactive addresses from escaping to the uplink network.</p></li>
<li><p>The DHCPv4 server will be configured to indicate that a netmask of 255.255.255.255 be used for instance configuration.</p></li>
</ul>
</section>
<section id="ovn-nic-acceleration-vdpa">
<h2><code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration_vdpa</span></code><a class="headerlink" href="#ovn-nic-acceleration-vdpa" title="Link to this heading">¶</a></h2>
<p>This updates the <code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration</span></code> API extension. The <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:acceleration"><code class="docutils literal notranslate"><span class="pre">acceleration</span></code></a> configuration key for OVN NICs can now takes the value <code class="docutils literal notranslate"><span class="pre">vdpa</span></code> to support Virtual Data Path Acceleration (VDPA).</p>
</section>
<section id="cluster-healing">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_healing</span></code><a class="headerlink" href="#cluster-healing" title="Link to this heading">¶</a></h2>
<p>This adds cluster healing which automatically evacuates offline cluster members.</p>
<p>This adds the following new configuration key:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../server/#server-cluster:cluster.healing_threshold"><code class="docutils literal notranslate"><span class="pre">cluster.healing_threshold</span></code></a></p></li>
</ul>
<p>The configuration key takes an integer, and can be disabled by setting it to 0 (default). If set, the value represents the threshold after which an offline cluster member is to be evacuated. In case the value is lower than <a class="configref reference internal" href="../server/#server-cluster:cluster.offline_threshold"><code class="docutils literal notranslate"><span class="pre">cluster.offline_threshold</span></code></a>, that value will be used instead.</p>
<p>When the offline cluster member is evacuated, only remote-backed instances will be migrated. Local instances will be ignored as there is no way of migrating them once the cluster member is offline.</p>
</section>
<section id="instances-state-total">
<h2><code class="docutils literal notranslate"><span class="pre">instances_state_total</span></code><a class="headerlink" href="#instances-state-total" title="Link to this heading">¶</a></h2>
<p>This extension adds a new <code class="docutils literal notranslate"><span class="pre">total</span></code> field to <code class="docutils literal notranslate"><span class="pre">InstanceStateDisk</span></code> and <code class="docutils literal notranslate"><span class="pre">InstanceStateMemory</span></code>, both part of the instance’s state API.</p>
</section>
<section id="auth-user">
<h2><code class="docutils literal notranslate"><span class="pre">auth_user</span></code><a class="headerlink" href="#auth-user" title="Link to this heading">¶</a></h2>
<p>Add current user details to the main API endpoint.</p>
<p>This introduces:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">auth_user_name</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">auth_user_method</span></code></p></li>
</ul>
</section>
<section id="security-csm">
<h2><code class="docutils literal notranslate"><span class="pre">security_csm</span></code><a class="headerlink" href="#security-csm" title="Link to this heading">¶</a></h2>
<p>Introduce a new <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.csm"><code class="docutils literal notranslate"><span class="pre">security.csm</span></code></a> configuration key to control the use of
<code class="docutils literal notranslate"><span class="pre">CSM</span></code> (Compatibility Support Module) to allow legacy operating systems to
be run in LXD VMs.</p>
</section>
<section id="instances-rebuild">
<h2><code class="docutils literal notranslate"><span class="pre">instances_rebuild</span></code><a class="headerlink" href="#instances-rebuild" title="Link to this heading">¶</a></h2>
<p>This extension adds the ability to rebuild an instance with the same origin image, alternate image or as empty. A new <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances/<name>/rebuild?project=<project></span></code> API endpoint has been added as well as a new CLI command <a class="reference internal" href="../reference/manpages/lxc/rebuild/#lxc-rebuild-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">rebuild</span></code></span></a>.</p>
</section>
<section id="numa-cpu-placement">
<h2><code class="docutils literal notranslate"><span class="pre">numa_cpu_placement</span></code><a class="headerlink" href="#numa-cpu-placement" title="Link to this heading">¶</a></h2>
<p>This adds the possibility to place a set of CPUs in a desired set of NUMA nodes.</p>
<p>This adds the following new configuration key:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-resource-limits:limits.cpu.nodes"><code class="docutils literal notranslate"><span class="pre">limits.cpu.nodes</span></code></a> : (string) comma-separated list of NUMA node IDs or NUMA node ID ranges to place the CPUs (chosen with a dynamic value of <a class="configref reference internal" href="../reference/instance_options/#instance-resource-limits:limits.cpu"><code class="docutils literal notranslate"><span class="pre">limits.cpu</span></code></a>) in.</p></li>
</ul>
</section>
<section id="custom-volume-iso">
<h2><code class="docutils literal notranslate"><span class="pre">custom_volume_iso</span></code><a class="headerlink" href="#custom-volume-iso" title="Link to this heading">¶</a></h2>
<p>This adds the possibility to import ISO images as custom storage volumes.</p>
<p>This adds the <code class="docutils literal notranslate"><span class="pre">--type</span></code> flag to <a class="reference internal" href="../reference/manpages/lxc/storage/volume/import/#lxc-storage-volume-import-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">storage</span> <span class="pre">volume</span> <span class="pre">import</span></code></span></a>.</p>
</section>
<section id="network-allocations">
<h2><code class="docutils literal notranslate"><span class="pre">network_allocations</span></code><a class="headerlink" href="#network-allocations" title="Link to this heading">¶</a></h2>
<p>This adds the possibility to list a LXD deployment’s network allocations.</p>
<p>Through the <a class="reference internal" href="../reference/manpages/lxc/network/list-allocations/#lxc-network-list-allocations-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">network</span> <span class="pre">list-allocations</span></code></span></a> command and the <code class="docutils literal notranslate"><span class="pre">--project</span> <span class="pre"><PROJECT></span> <span class="pre">|</span> <span class="pre">--all-projects</span></code> flags,
you can list all the used IP addresses, hardware addresses (for instances), resource URIs and whether it uses NAT for
each <code class="docutils literal notranslate"><span class="pre">instance</span></code>, <code class="docutils literal notranslate"><span class="pre">network</span></code>, <code class="docutils literal notranslate"><span class="pre">network</span> <span class="pre">forward</span></code> and <code class="docutils literal notranslate"><span class="pre">network</span> <span class="pre">load-balancer</span></code>.</p>
</section>
<section id="storage-api-remote-volume-snapshot-copy">
<h2><code class="docutils literal notranslate"><span class="pre">storage_api_remote_volume_snapshot_copy</span></code><a class="headerlink" href="#storage-api-remote-volume-snapshot-copy" title="Link to this heading">¶</a></h2>
<p>This allows copying storage volume snapshots to and from remotes.</p>
</section>
<section id="zfs-delegate">
<h2><code class="docutils literal notranslate"><span class="pre">zfs_delegate</span></code><a class="headerlink" href="#zfs-delegate" title="Link to this heading">¶</a></h2>
<p>This implements a new <a class="configref reference internal" href="../reference/storage_zfs/#storage-zfs-volume-conf:zfs.delegate"><code class="docutils literal notranslate"><span class="pre">zfs.delegate</span></code></a> volume Boolean for volumes on a ZFS storage driver.
When enabled and a suitable system is in use (requires ZFS 2.2 or higher), the ZFS dataset will be delegated to the container, allowing for its use through the <code class="docutils literal notranslate"><span class="pre">zfs</span></code> command line tool.</p>
</section>
<section id="operations-get-query-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">operations_get_query_all_projects</span></code><a class="headerlink" href="#operations-get-query-all-projects" title="Link to this heading">¶</a></h2>
<p>This introduces support for the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> query parameter for the GET API calls to both <code class="docutils literal notranslate"><span class="pre">/1.0/operations</span></code> and <code class="docutils literal notranslate"><span class="pre">/1.0/operations?recursion=1</span></code>.
This parameter allows bypassing the project name filter.</p>
</section>
<section id="metadata-configuration">
<h2><code class="docutils literal notranslate"><span class="pre">metadata_configuration</span></code><a class="headerlink" href="#metadata-configuration" title="Link to this heading">¶</a></h2>
<p>Adds the <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/metadata/configuration</span></code> API endpoint to retrieve the generated metadata configuration in a JSON format. The JSON structure adopts the structure <code class="docutils literal notranslate"><span class="pre">"configs"</span> <span class="pre">></span> <span class="pre">`ENTITY`</span> <span class="pre">></span> <span class="pre">`ENTITY_SECTION`</span> <span class="pre">></span> <span class="pre">"keys"</span> <span class="pre">></span> <span class="pre">[<CONFIG_OPTION_0>,</span> <span class="pre"><CONFIG_OPTION_1>,</span> <span class="pre">...]</span></code>.
Check the list of <a class="reference internal" href="../config-options/"><span class="doc">configuration options</span></a> to see which configuration options are included.</p>
</section>
<section id="syslog-socket">
<h2><code class="docutils literal notranslate"><span class="pre">syslog_socket</span></code><a class="headerlink" href="#syslog-socket" title="Link to this heading">¶</a></h2>
<p>This introduces a syslog socket that can receive syslog formatted log messages. These can be viewed in the events API and <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">monitor</span></code>, and can be forwarded to Loki. To enable this feature, set <a class="configref reference internal" href="../server/#server-core:core.syslog_socket"><code class="docutils literal notranslate"><span class="pre">core.syslog_socket</span></code></a> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</section>
<section id="event-lifecycle-name-and-project">
<h2><code class="docutils literal notranslate"><span class="pre">event_lifecycle_name_and_project</span></code><a class="headerlink" href="#event-lifecycle-name-and-project" title="Link to this heading">¶</a></h2>
<p>This adds the fields <code class="docutils literal notranslate"><span class="pre">Name</span></code> and <code class="docutils literal notranslate"><span class="pre">Project</span></code> to <code class="docutils literal notranslate"><span class="pre">lifecycle</span></code> events.</p>
</section>
<section id="instances-nic-limits-priority">
<h2><code class="docutils literal notranslate"><span class="pre">instances_nic_limits_priority</span></code><a class="headerlink" href="#instances-nic-limits-priority" title="Link to this heading">¶</a></h2>
<p>This introduces a new per-NIC <code class="docutils literal notranslate"><span class="pre">limits.priority</span></code> option that works with both cgroup1 and cgroup2 unlike the deprecated <code class="docutils literal notranslate"><span class="pre">limits.network.priority</span></code> instance setting, which only worked with cgroup1.</p>
</section>
<section id="disk-initial-volume-configuration">
<h2><code class="docutils literal notranslate"><span class="pre">disk_initial_volume_configuration</span></code><a class="headerlink" href="#disk-initial-volume-configuration" title="Link to this heading">¶</a></h2>
<p>This API extension provides the capability to set initial volume configurations for instance root devices.
Initial volume configurations are prefixed with <code class="docutils literal notranslate"><span class="pre">initial.</span></code> and can be specified either through profiles or directly
during instance initialization using the <code class="docutils literal notranslate"><span class="pre">--device</span></code> flag.</p>
<p>Note that these configuration are applied only at the time of instance creation and subsequent modifications have
no effect on existing devices.</p>
</section>
<section id="operation-wait">
<h2><code class="docutils literal notranslate"><span class="pre">operation_wait</span></code><a class="headerlink" href="#operation-wait" title="Link to this heading">¶</a></h2>
<p>This API extension indicates that the <code class="docutils literal notranslate"><span class="pre">/1.0/operations/{id}/wait</span></code> endpoint exists on the server. This indicates to the client
that the endpoint can be used to wait for an operation to complete rather than waiting for an operation event via the
<code class="docutils literal notranslate"><span class="pre">/1.0/events</span></code> endpoint.</p>
</section>
<section id="cluster-internal-custom-volume-copy">
<h2><code class="docutils literal notranslate"><span class="pre">cluster_internal_custom_volume_copy</span></code><a class="headerlink" href="#cluster-internal-custom-volume-copy" title="Link to this heading">¶</a></h2>
<p>This extension adds support for copying and moving custom storage volumes within a cluster with a single API call.
Calling <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/custom?target=<target></span></code> will copy the custom volume specified in the <code class="docutils literal notranslate"><span class="pre">source</span></code> part of the request.
Calling <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/<pool>/custom/<volume>?target=<target></span></code> will move the custom volume from the source, specified in the <code class="docutils literal notranslate"><span class="pre">source</span></code> part of the request, to the target.</p>
</section>
<section id="disk-io-bus">
<h2><code class="docutils literal notranslate"><span class="pre">disk_io_bus</span></code><a class="headerlink" href="#disk-io-bus" title="Link to this heading">¶</a></h2>
<p>This introduces a new <a class="configref reference internal" href="../reference/devices_disk/#device-disk-device-conf:io.bus"><code class="docutils literal notranslate"><span class="pre">io.bus</span></code></a> property to disk devices which can be used to override the bus the disk is attached to.</p>
</section>
<section id="storage-cephfs-create-missing">
<h2><code class="docutils literal notranslate"><span class="pre">storage_cephfs_create_missing</span></code><a class="headerlink" href="#storage-cephfs-create-missing" title="Link to this heading">¶</a></h2>
<p>This introduces the configuration keys <a class="configref reference internal" href="../reference/storage_cephfs/#storage-cephfs-pool-conf:cephfs.create_missing"><code class="docutils literal notranslate"><span class="pre">cephfs.create_missing</span></code></a>, <a class="configref reference internal" href="../reference/storage_cephfs/#storage-cephfs-pool-conf:cephfs.osd_pg_num"><code class="docutils literal notranslate"><span class="pre">cephfs.osd_pg_num</span></code></a>, <a class="configref reference internal" href="../reference/storage_cephfs/#storage-cephfs-pool-conf:cephfs.meta_pool"><code class="docutils literal notranslate"><span class="pre">cephfs.meta_pool</span></code></a> and <a class="configref reference internal" href="../reference/storage_cephfs/#storage-cephfs-pool-conf:cephfs.data_pool"><code class="docutils literal notranslate"><span class="pre">cephfs.data_pool</span></code></a> to be used when adding a <code class="docutils literal notranslate"><span class="pre">cephfs</span></code> storage pool to instruct LXD to create the necessary entities for the storage pool, if they do not exist.</p>
</section>
<section id="instance-move-config">
<h2><code class="docutils literal notranslate"><span class="pre">instance_move_config</span></code><a class="headerlink" href="#instance-move-config" title="Link to this heading">¶</a></h2>
<p>This API extension provides the ability to use flags <code class="docutils literal notranslate"><span class="pre">--profile</span></code>, <code class="docutils literal notranslate"><span class="pre">--no-profile</span></code>, <code class="docutils literal notranslate"><span class="pre">--device</span></code>, and <code class="docutils literal notranslate"><span class="pre">--config</span></code>
when moving an instance between projects and/or storage pools.</p>
</section>
<section id="ovn-ssl-config">
<h2><code class="docutils literal notranslate"><span class="pre">ovn_ssl_config</span></code><a class="headerlink" href="#ovn-ssl-config" title="Link to this heading">¶</a></h2>
<p>This introduces new server configuration keys to provide the SSL CA and client key pair to access the OVN databases.
The new configuration keys are <a class="configref reference internal" href="../server/#server-miscellaneous:network.ovn.ca_cert"><code class="docutils literal notranslate"><span class="pre">network.ovn.ca_cert</span></code></a>, <a class="configref reference internal" href="../server/#server-miscellaneous:network.ovn.client_cert"><code class="docutils literal notranslate"><span class="pre">network.ovn.client_cert</span></code></a> and <a class="configref reference internal" href="../server/#server-miscellaneous:network.ovn.client_key"><code class="docutils literal notranslate"><span class="pre">network.ovn.client_key</span></code></a>.</p>
</section>
<section id="init-preseed-storage-volumes">
<h2><code class="docutils literal notranslate"><span class="pre">init_preseed_storage_volumes</span></code><a class="headerlink" href="#init-preseed-storage-volumes" title="Link to this heading">¶</a></h2>
<p>This API extension provides the ability to configure storage volumes in preseed init.</p>
</section>
<section id="metrics-instances-count">
<h2><code class="docutils literal notranslate"><span class="pre">metrics_instances_count</span></code><a class="headerlink" href="#metrics-instances-count" title="Link to this heading">¶</a></h2>
<p>This extends the metrics to include the containers and virtual machines counts. Instances are counted irrespective of their state.</p>
</section>
<section id="server-instance-type-info">
<h2><code class="docutils literal notranslate"><span class="pre">server_instance_type_info</span></code><a class="headerlink" href="#server-instance-type-info" title="Link to this heading">¶</a></h2>
<p>This API extension enables querying a server’s supported instance types.
When querying the <code class="docutils literal notranslate"><span class="pre">/1.0</span></code> endpoint, a new field named <code class="docutils literal notranslate"><span class="pre">instance_types</span></code> is added to the retrieved data.
This field indicates which instance types are supported by the server.</p>
</section>
<section id="resources-disk-mounted">
<h2><code class="docutils literal notranslate"><span class="pre">resources_disk_mounted</span></code><a class="headerlink" href="#resources-disk-mounted" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">mounted</span></code> field to disk resources that LXD discovers on the system, reporting whether that disk or partition is
mounted.</p>
</section>
<section id="server-version-lts">
<h2><code class="docutils literal notranslate"><span class="pre">server_version_lts</span></code><a class="headerlink" href="#server-version-lts" title="Link to this heading">¶</a></h2>
<p>The API extension adds indication whether the LXD version is an LTS release.
This is indicated when command <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">version</span></code> is executed or when <code class="docutils literal notranslate"><span class="pre">/1.0</span></code> endpoint is queried.</p>
</section>
<section id="oidc-groups-claim">
<h2><code class="docutils literal notranslate"><span class="pre">oidc_groups_claim</span></code><a class="headerlink" href="#oidc-groups-claim" title="Link to this heading">¶</a></h2>
<p>This API extension enables setting an <a class="configref reference internal" href="../server/#server-oidc:oidc.groups.claim"><code class="docutils literal notranslate"><span class="pre">oidc.groups.claim</span></code></a> configuration key.
If OIDC authentication is configured and this claim is set, LXD will request this claim in the scope of OIDC flow.
The value of the claim will be extracted and might be used to make authorization decisions.</p>
</section>
<section id="loki-config-instance">
<h2><code class="docutils literal notranslate"><span class="pre">loki_config_instance</span></code><a class="headerlink" href="#loki-config-instance" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../server/#server-loki:loki.instance"><code class="docutils literal notranslate"><span class="pre">loki.instance</span></code></a> server configuration key to customize the <code class="docutils literal notranslate"><span class="pre">instance</span></code> field in Loki events.
This can be used to expose the name of the cluster rather than the individual system name sending
the event as that’s usually already covered by the <code class="docutils literal notranslate"><span class="pre">location</span></code> field.</p>
</section>
<section id="storage-volatile-uuid">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volatile_uuid</span></code><a class="headerlink" href="#storage-volatile-uuid" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">volatile.uuid</span></code> configuration key to all storage volumes, snapshots and buckets.
This information can be used by storage drivers as a separate identifier besides the name
when working with volumes.</p>
</section>
<section id="import-instance-devices">
<h2><code class="docutils literal notranslate"><span class="pre">import_instance_devices</span></code><a class="headerlink" href="#import-instance-devices" title="Link to this heading">¶</a></h2>
<p>This API extension provides the ability to use flags <code class="docutils literal notranslate"><span class="pre">--device</span></code> when importing an instance to override instance’s devices.</p>
</section>
<section id="instances-uefi-vars">
<h2><code class="docutils literal notranslate"><span class="pre">instances_uefi_vars</span></code><a class="headerlink" href="#instances-uefi-vars" title="Link to this heading">¶</a></h2>
<p>This API extension indicates that the <code class="docutils literal notranslate"><span class="pre">/1.0/instances/{name}/uefi-vars</span></code> endpoint is supported on the server. This endpoint allows to get the full list of UEFI variables (HTTP method GET) or replace the entire set of UEFI variables (HTTP method PUT).</p>
</section>
<section id="instances-migration-stateful">
<h2><code class="docutils literal notranslate"><span class="pre">instances_migration_stateful</span></code><a class="headerlink" href="#instances-migration-stateful" title="Link to this heading">¶</a></h2>
<p>This API extension allows newly created VMs to have their <a class="configref reference internal" href="../reference/instance_options/#instance-migration:migration.stateful"><code class="docutils literal notranslate"><span class="pre">migration.stateful</span></code></a> configuration key automatically set
through the new server-level configuration key <a class="configref reference internal" href="../server/#server-miscellaneous:instances.migration.stateful"><code class="docutils literal notranslate"><span class="pre">instances.migration.stateful</span></code></a>. If <code class="docutils literal notranslate"><span class="pre">migration.stateful</span></code> is already set at the profile or instance level then <code class="docutils literal notranslate"><span class="pre">instances.migration.stateful</span></code> is not applied.</p>
</section>
<section id="access-management">
<h2><code class="docutils literal notranslate"><span class="pre">access_management</span></code><a class="headerlink" href="#access-management" title="Link to this heading">¶</a></h2>
<p>Adds new APIs under <code class="docutils literal notranslate"><span class="pre">/1.0/auth</span></code> for viewing and managing identities, groups, and permissions.
Adds an embedded OpenFGA authorization driver for enforcing fine-grained permissions.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Prior to the addition of this extension, all OIDC clients were given full access to LXD (equivalent to Unix socket access).
This extension revokes access to all OIDC clients.
To regain access, a user must:</p>
<ol class="arabic simple">
<li><p>Make a call to the OIDC enabled LXD remote (e.g. <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">info</span></code>) to ensure that their OIDC identity is added to the LXD database.</p></li>
<li><p>Create a group: <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">auth</span> <span class="pre">group</span> <span class="pre">create</span> <span class="pre"><group_name></span></code></p></li>
<li><p>Grant the group a suitable permission.
As all OIDC clients prior to this extension have had full access to LXD, the corresponding permission is <code class="docutils literal notranslate"><span class="pre">admin</span></code> on <code class="docutils literal notranslate"><span class="pre">server</span></code>.
To grant this permission to your group, run: <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">auth</span> <span class="pre">group</span> <span class="pre">permission</span> <span class="pre">add</span> <span class="pre"><group_name></span> <span class="pre">server</span> <span class="pre">admin</span></code></p></li>
<li><p>Add themselves to the group. To do this, run: <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">auth</span> <span class="pre">identity</span> <span class="pre">group</span> <span class="pre">add</span> <span class="pre">oidc/<email_address></span> <span class="pre"><group_name></span></code></p></li>
</ol>
<p>Steps 2 to 4 above cannot be performed via OIDC authentication (access has been revoked).
They must be performed by a sufficiently privileged user, either via Unix socket or unrestricted TLS client certificate.</p>
<p>For more information on access control for OIDC clients, see <a class="reference internal" href="../explanation/authorization/#fine-grained-authorization"><span class="std std-ref">Fine-grained authorization</span></a>.</p>
</div>
</section>
<section id="vm-disk-io-limits">
<h2><code class="docutils literal notranslate"><span class="pre">vm_disk_io_limits</span></code><a class="headerlink" href="#vm-disk-io-limits" title="Link to this heading">¶</a></h2>
<p>Adds the ability to limit disk I/O for virtual machines.</p>
</section>
<section id="storage-volumes-all">
<h2><code class="docutils literal notranslate"><span class="pre">storage_volumes_all</span></code><a class="headerlink" href="#storage-volumes-all" title="Link to this heading">¶</a></h2>
<p>This API extension adds support for listing storage volumes from all storage pools via <code class="docutils literal notranslate"><span class="pre">/1.0/storage-volumes</span></code> or <code class="docutils literal notranslate"><span class="pre">/1.0/storage-volumes/{type}</span></code> to filter by volume type. Also adds a <code class="docutils literal notranslate"><span class="pre">pool</span></code> field to storage volumes.</p>
</section>
<section id="instances-files-modify-permissions">
<h2><code class="docutils literal notranslate"><span class="pre">instances_files_modify_permissions</span></code><a class="headerlink" href="#instances-files-modify-permissions" title="Link to this heading">¶</a></h2>
<p>Adds the ability for <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances/{name}/files</span></code> to modify the permissions of files that already exist via the <code class="docutils literal notranslate"><span class="pre">X-LXD-modify-perm</span></code> header.</p>
<p><code class="docutils literal notranslate"><span class="pre">X-LXD-modify-perm</span></code> should be a comma-separated list of 0 or more of <code class="docutils literal notranslate"><span class="pre">mode</span></code>, <code class="docutils literal notranslate"><span class="pre">uid</span></code>, and <code class="docutils literal notranslate"><span class="pre">gid</span></code>.</p>
</section>
<section id="image-restriction-nesting">
<h2><code class="docutils literal notranslate"><span class="pre">image_restriction_nesting</span></code><a class="headerlink" href="#image-restriction-nesting" title="Link to this heading">¶</a></h2>
<p>This extension adds a new image restriction, <code class="docutils literal notranslate"><span class="pre">requirements.nesting</span></code> which when <code class="docutils literal notranslate"><span class="pre">true</span></code> indicates that an image cannot be run without nesting.</p>
</section>
<section id="container-syscall-intercept-finit-module">
<h2><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_finit_module</span></code><a class="headerlink" href="#container-syscall-intercept-finit-module" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/instance_options/#instance-miscellaneous:linux.kernel_modules.load"><code class="docutils literal notranslate"><span class="pre">linux.kernel_modules.load</span></code></a> container configuration option. If the option is set to <code class="docutils literal notranslate"><span class="pre">ondemand</span></code>, the <code class="docutils literal notranslate"><span class="pre">finit_modules()</span></code> syscall is intercepted and a privileged user in the container’s user namespace can load the Linux kernel modules specified in the
allow list <a class="configref reference internal" href="../reference/instance_options/#instance-miscellaneous:linux.kernel_modules"><code class="docutils literal notranslate"><span class="pre">linux.kernel_modules</span></code></a>.</p>
</section>
<section id="device-usb-serial">
<h2><code class="docutils literal notranslate"><span class="pre">device_usb_serial</span></code><a class="headerlink" href="#device-usb-serial" title="Link to this heading">¶</a></h2>
<p>This adds new configuration keys <a class="configref reference internal" href="../reference/devices_usb/#device-unix-usb-device-conf:serial"><code class="docutils literal notranslate"><span class="pre">serial</span></code></a>, <a class="configref reference internal" href="../reference/devices_usb/#device-unix-usb-device-conf:busnum"><code class="docutils literal notranslate"><span class="pre">busnum</span></code></a> and <a class="configref reference internal" href="../reference/devices_usb/#device-unix-usb-device-conf:devnum"><code class="docutils literal notranslate"><span class="pre">devnum</span></code></a> for <a class="reference internal" href="../reference/devices_usb/#devices-usb"><span class="std std-ref">device type <code class="docutils literal notranslate"><span class="pre">usb</span></code></span></a>.
The feature has been added to make it possible to distinguish between devices with identical <a class="configref reference internal" href="../reference/devices_usb/#device-unix-usb-device-conf:vendorid"><code class="docutils literal notranslate"><span class="pre">vendorid</span></code></a> and <a class="configref reference internal" href="../reference/devices_usb/#device-unix-usb-device-conf:productid"><code class="docutils literal notranslate"><span class="pre">productid</span></code></a>.</p>
</section>
<section id="network-allocate-external-ips">
<h2><code class="docutils literal notranslate"><span class="pre">network_allocate_external_ips</span></code><a class="headerlink" href="#network-allocate-external-ips" title="Link to this heading">¶</a></h2>
<p>Adds the ability to use an unspecified IPv4 (<code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code>) or IPv6 (<code class="docutils literal notranslate"><span class="pre">::</span></code>) address in the <code class="docutils literal notranslate"><span class="pre">listen_address</span></code> field of the request body for <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/networks/{networkName}/load-balancers</span></code> and <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/networks/{networkName}/forwards</span></code>.
If an unspecified IP address is used, supported drivers will allocate an available listen address automatically.
Allocation of external IP addresses is currently supported by the OVN network driver.
The OVN driver will allocate IP addresses from the subnets specified in the uplink network’s <code class="docutils literal notranslate"><span class="pre">ipv4.routes</span></code> and <code class="docutils literal notranslate"><span class="pre">ipv6.routes</span></code> configuration options.</p>
</section>
<section id="explicit-trust-token">
<h2><code class="docutils literal notranslate"><span class="pre">explicit_trust_token</span></code><a class="headerlink" href="#explicit-trust-token" title="Link to this heading">¶</a></h2>
<p>Adds the ability to explicitly specify a trust token when creating a certificate
and joining an existing cluster.</p>
</section>
<section id="shared-custom-block-volumes">
<h2><code class="docutils literal notranslate"><span class="pre">shared_custom_block_volumes</span></code><a class="headerlink" href="#shared-custom-block-volumes" title="Link to this heading">¶</a></h2>
<p>This adds a configuration key <code class="docutils literal notranslate"><span class="pre">security.shared</span></code> to custom block volumes.
If unset or <code class="docutils literal notranslate"><span class="pre">false</span></code>, the custom block volume cannot be attached to multiple instances.
This feature was added to prevent data loss which can happen when custom block volumes are attached to multiple instances at once.</p>
</section>
<section id="instance-import-conversion">
<h2><code class="docutils literal notranslate"><span class="pre">instance_import_conversion</span></code><a class="headerlink" href="#instance-import-conversion" title="Link to this heading">¶</a></h2>
<p>Adds the ability to convert images from different formats (e.g. VMDK or QCow2) into RAW image format and import them as LXD instances.</p>
</section>
<section id="instance-create-start">
<h2><code class="docutils literal notranslate"><span class="pre">instance_create_start</span></code><a class="headerlink" href="#instance-create-start" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">start</span></code> field to the <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances</span></code> API which when set
to <code class="docutils literal notranslate"><span class="pre">true</span></code> will have the instance automatically start upon creation.</p>
<p>In this scenario, the creation and startup is part of a single background operation.</p>
</section>
<section id="instance-protection-start">
<h2><code class="docutils literal notranslate"><span class="pre">instance_protection_start</span></code><a class="headerlink" href="#instance-protection-start" title="Link to this heading">¶</a></h2>
<p>Enables setting the <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.protection.start"><code class="docutils literal notranslate"><span class="pre">security.protection.start</span></code></a> field which prevents instances
from being started if set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</section>
<section id="devlxd-images-vm">
<h2><code class="docutils literal notranslate"><span class="pre">devlxd_images_vm</span></code><a class="headerlink" href="#devlxd-images-vm" title="Link to this heading">¶</a></h2>
<p>Enables the <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> configuration option for virtual machines.
This controls the availability of a <code class="docutils literal notranslate"><span class="pre">/1.0/images/FINGERPRINT/export</span></code> API over <code class="docutils literal notranslate"><span class="pre">devlxd</span></code>.
This can be used by a virtual machine running LXD to access raw images from the host.</p>
</section>
<section id="disk-io-bus-virtio-blk">
<h2><code class="docutils literal notranslate"><span class="pre">disk_io_bus_virtio_blk</span></code><a class="headerlink" href="#disk-io-bus-virtio-blk" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">virtio-blk</span></code> value for <code class="docutils literal notranslate"><span class="pre">io.bus</span></code> on <code class="docutils literal notranslate"><span class="pre">disk</span></code> devices which allows
for the attached disk to be connected to the <code class="docutils literal notranslate"><span class="pre">virtio-blk</span></code> bus.</p>
</section>
<section id="metrics-api-requests">
<h2><code class="docutils literal notranslate"><span class="pre">metrics_api_requests</span></code><a class="headerlink" href="#metrics-api-requests" title="Link to this heading">¶</a></h2>
<p>Adds the following internal metrics:</p>
<ul class="simple">
<li><p>Total completed requests</p></li>
<li><p>Number of ongoing requests</p></li>
</ul>
</section>
<section id="projects-limits-disk-pool">
<h2><code class="docutils literal notranslate"><span class="pre">projects_limits_disk_pool</span></code><a class="headerlink" href="#projects-limits-disk-pool" title="Link to this heading">¶</a></h2>
<p>This introduces per-pool project disk limits, introducing a <code class="docutils literal notranslate"><span class="pre">limits.disk.pool.NAME</span></code>
configuration option to the project limits. When <code class="docutils literal notranslate"><span class="pre">limits.disk.pool.POOLNAME:</span> <span class="pre">0</span></code>
for a project, the pool is excluded from <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">storage</span> <span class="pre">list</span></code> in that project.</p>
</section>
<section id="ubuntu-pro-guest-attach">
<h2><code class="docutils literal notranslate"><span class="pre">ubuntu_pro_guest_attach</span></code><a class="headerlink" href="#ubuntu-pro-guest-attach" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/instance_options/#instance-miscellaneous:ubuntu_pro.guest_attach"><code class="docutils literal notranslate"><span class="pre">ubuntu_pro.guest_attach</span></code></a> configuration option for instances.
When set to <code class="docutils literal notranslate"><span class="pre">on</span></code>, if the host has guest attachment enabled, the guest can request a guest token for Ubuntu Pro via <code class="docutils literal notranslate"><span class="pre">devlxd</span></code>.</p>
<p>For more information, see: <a class="reference internal" href="../howto/instances_ubuntu_pro_attach/#instances-ubuntu-pro-attach"><span class="std std-ref">How to configure Ubuntu Pro guest attachment</span></a>.</p>
</section>
<section id="metadata-configuration-entity-types">
<h2><code class="docutils literal notranslate"><span class="pre">metadata_configuration_entity_types</span></code><a class="headerlink" href="#metadata-configuration-entity-types" title="Link to this heading">¶</a></h2>
<p>This adds entity type metadata to <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/metadata/configuration</span></code>.
The entity type metadata is a JSON object under the <code class="docutils literal notranslate"><span class="pre">entities</span></code> key.</p>
</section>
<section id="access-management-tls">
<h2><code class="docutils literal notranslate"><span class="pre">access_management_tls</span></code><a class="headerlink" href="#access-management-tls" title="Link to this heading">¶</a></h2>
<p>Expands APIs under <code class="docutils literal notranslate"><span class="pre">/1.0/auth</span></code> to include:</p>
<ol class="arabic simple">
<li><p>Creation of fine-grained TLS identities, whose permissions are managed via group membership.
This is performed via <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/auth/identities/tls</span></code>.
If the request body contains <code class="docutils literal notranslate"><span class="pre">{"token":</span> <span class="pre">true}</span></code>, a token will be returned that may be used by a non-authenticated caller to gain trust with the LXD server (the caller must send their certificate during the TLS handshake).
If the request body contains <code class="docutils literal notranslate"><span class="pre">{"certificate":</span> <span class="pre">"<base64</span> <span class="pre">encoded</span> <span class="pre">x509</span> <span class="pre">certificate>"}"</span></code>, the identity will be created directly.
The request body may also specify an array of group names.
The caller must have <code class="docutils literal notranslate"><span class="pre">can_create_identities</span></code> on <code class="docutils literal notranslate"><span class="pre">server</span></code>.</p></li>
<li><p>Deletion of OIDC and fine-grained TLS identities.
This is performed via <code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/auth/identities/tls/{nameOrFingerprint}</span></code> or <code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/auth/identities/oidc/{nameOrEmailAddress}</span></code>.
The caller must have <code class="docutils literal notranslate"><span class="pre">can_delete</span></code> on the identity. All identities may delete their own identity.
For OIDC identities this revokes all access but does not revoke trust (authentication is performed by the identity provider).
For fine-grained TLS identities, this revokes all access and revokes trust.</p></li>
<li><p>Functionality to update the certificate of a fine-grained TLS identity.
This is performed via <code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/auth/identities/tls/{nameOrFingerprint}</span></code> or <code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/auth/identities/tls/{nameOrFingerprint}</span></code>.
The caller must provide a base64 encoded x509 certificate in the <code class="docutils literal notranslate"><span class="pre">certificate</span></code> field of the request body.
Fine-grained TLS identities may update their own certificate.
To update the certificate of another identity, the caller must have <code class="docutils literal notranslate"><span class="pre">can_edit</span></code> on the identity.</p></li>
</ol>
</section>
<section id="network-allocations-ovn-uplink">
<h2><code class="docutils literal notranslate"><span class="pre">network_allocations_ovn_uplink</span></code><a class="headerlink" href="#network-allocations-ovn-uplink" title="Link to this heading">¶</a></h2>
<p>Includes OVN virtual routers external IPs to <code class="docutils literal notranslate"><span class="pre">/1.0/network-allocations</span></code> responses with the type <code class="docutils literal notranslate"><span class="pre">uplink</span></code>.
Introduces the <code class="docutils literal notranslate"><span class="pre">network</span></code> field on each allocation, indicating to which network each allocated address belongs.
And lastly, adds a <code class="docutils literal notranslate"><span class="pre">project</span></code> field on leases, leases can be retrieved via <code class="docutils literal notranslate"><span class="pre">/1.0/networks/<network>/leases</span></code>.</p>
</section>
<section id="network-ovn-uplink-vlan">
<h2><code class="docutils literal notranslate"><span class="pre">network_ovn_uplink_vlan</span></code><a class="headerlink" href="#network-ovn-uplink-vlan" title="Link to this heading">¶</a></h2>
<p>Adds support for using a bridge network with a specified VLAN ID as an OVN uplink.</p>
</section>
<section id="state-logical-cpus">
<h2><code class="docutils literal notranslate"><span class="pre">state_logical_cpus</span></code><a class="headerlink" href="#state-logical-cpus" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">logical_cpus</span></code> field to <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/cluster/members/{name}/state</span></code> which
contains the total available logical CPUs available when LXD started.</p>
</section>
<section id="vm-limits-cpu-pin-strategy">
<h2><code class="docutils literal notranslate"><span class="pre">vm_limits_cpu_pin_strategy</span></code><a class="headerlink" href="#vm-limits-cpu-pin-strategy" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/instance_options/#instance-resource-limits:limits.cpu.pin_strategy"><code class="docutils literal notranslate"><span class="pre">limits.cpu.pin_strategy</span></code></a> configuration option for virtual machines. This option controls the CPU pinning strategy. When set to <code class="docutils literal notranslate"><span class="pre">none</span></code>, CPU auto pinning is disabled. When set to <code class="docutils literal notranslate"><span class="pre">auto</span></code>, CPU auto pinning is enabled.</p>
</section>
<section id="gpu-cdi">
<h2><code class="docutils literal notranslate"><span class="pre">gpu_cdi</span></code><a class="headerlink" href="#gpu-cdi" title="Link to this heading">¶</a></h2>
<p>Adds support for using the Container Device Interface (CDI) specification to configure GPU passthrough in LXD containers. The <code class="docutils literal notranslate"><span class="pre">id</span></code> field of GPU devices now accepts CDI identifiers (for example, <code class="docutils literal notranslate"><span class="pre">{VENDOR_DOMAIN_NAME}/gpu=gpu{INDEX}</span></code>) for containers, in addition to DRM card IDs. This enables GPU passthrough for devices that don’t use PCI addressing (like NVIDIA Tegra iGPUs) and provides a more flexible way to identify and configure GPU devices.</p>
</section>
<section id="images-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">images_all_projects</span></code><a class="headerlink" href="#images-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for listing images across all projects using the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/images</span></code> requests.</p>
</section>
<section id="metadata-configuration-scope">
<h2><code class="docutils literal notranslate"><span class="pre">metadata_configuration_scope</span></code><a class="headerlink" href="#metadata-configuration-scope" title="Link to this heading">¶</a></h2>
<p>This adds scope metadata to <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/metadata/configuration</span></code>. Options marked with a <code class="docutils literal notranslate"><span class="pre">global</span></code> scope are applied to all cluster members. Options with a <code class="docutils literal notranslate"><span class="pre">local</span></code> scope must be set on a per-member basis.</p>
</section>
<section id="unix-device-hotplug-ownership-inherit">
<h2><code class="docutils literal notranslate"><span class="pre">unix_device_hotplug_ownership_inherit</span></code><a class="headerlink" href="#unix-device-hotplug-ownership-inherit" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:ownership.inherit"><code class="docutils literal notranslate"><span class="pre">ownership.inherit</span></code></a> configuration option for <code class="docutils literal notranslate"><span class="pre">unix-hotplug</span></code> devices. This option controls whether the device inherits ownership (GID and/or UID) from the host. When set to <code class="docutils literal notranslate"><span class="pre">true</span></code> and GID and/or UID are unset, host ownership is inherited. When set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, host ownership is not inherited and ownership can be configured by setting <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:gid"><code class="docutils literal notranslate"><span class="pre">gid</span></code></a> and <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:uid"><code class="docutils literal notranslate"><span class="pre">uid</span></code></a>.</p>
</section>
<section id="unix-device-hotplug-subsystem-device-option">
<h2><code class="docutils literal notranslate"><span class="pre">unix_device_hotplug_subsystem_device_option</span></code><a class="headerlink" href="#unix-device-hotplug-subsystem-device-option" title="Link to this heading">¶</a></h2>
<p>Adds a new <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:subsystem"><code class="docutils literal notranslate"><span class="pre">subsystem</span></code></a> configuration option for <code class="docutils literal notranslate"><span class="pre">unix-hotplug</span></code> devices. This adds support for detecting <code class="docutils literal notranslate"><span class="pre">unix-hotplug</span></code> devices by subsystem, and can be used in conjunction with <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:productid"><code class="docutils literal notranslate"><span class="pre">productid</span></code></a> and <a class="configref reference internal" href="../reference/devices_unix_hotplug/#device-unix-hotplug-device-conf:vendorid"><code class="docutils literal notranslate"><span class="pre">vendorid</span></code></a>.</p>
</section>
<section id="storage-ceph-osd-pool-size">
<h2><code class="docutils literal notranslate"><span class="pre">storage_ceph_osd_pool_size</span></code><a class="headerlink" href="#storage-ceph-osd-pool-size" title="Link to this heading">¶</a></h2>
<p>This introduces the configuration keys <a class="configref reference internal" href="../reference/storage_ceph/#storage-ceph-pool-conf:ceph.osd.pool_size"><code class="docutils literal notranslate"><span class="pre">ceph.osd.pool_size</span></code></a>, and <a class="configref reference internal" href="../reference/storage_cephfs/#storage-cephfs-pool-conf:cephfs.osd_pool_size"><code class="docutils literal notranslate"><span class="pre">cephfs.osd_pool_size</span></code></a> to be used when adding or updating a <code class="docutils literal notranslate"><span class="pre">ceph</span></code> or <code class="docutils literal notranslate"><span class="pre">cephfs</span></code> storage pool to instruct LXD to create set the replication size for the underlying OSD pools.</p>
</section>
<section id="network-get-target">
<h2><code class="docutils literal notranslate"><span class="pre">network_get_target</span></code><a class="headerlink" href="#network-get-target" title="Link to this heading">¶</a></h2>
<p>Adds optional <code class="docutils literal notranslate"><span class="pre">target</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/network</span></code>. When target is set, forward the request to the specified cluster member and return the non-managed interfaces from that member.</p>
</section>
<section id="network-zones-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">network_zones_all_projects</span></code><a class="headerlink" href="#network-zones-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for listing network zones across all projects using the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/network-zones</span></code> requests.</p>
</section>
<section id="vm-root-volume-attachment">
<h2><code class="docutils literal notranslate"><span class="pre">vm_root_volume_attachment</span></code><a class="headerlink" href="#vm-root-volume-attachment" title="Link to this heading">¶</a></h2>
<p>Adds support for virtual-machine root volumes and snapshots to be attached to other instances as disk devices. Introduces the <code class="docutils literal notranslate"><span class="pre">source.type</span></code> and <code class="docutils literal notranslate"><span class="pre">source.snapshot</span></code> keys for disk devices.</p>
</section>
<section id="projects-limits-uplink-ips">
<h2><code class="docutils literal notranslate"><span class="pre">projects_limits_uplink_ips</span></code><a class="headerlink" href="#projects-limits-uplink-ips" title="Link to this heading">¶</a></h2>
<p>Introduces per-project uplink IP limits for each available uplink network, adding <code class="docutils literal notranslate"><span class="pre">limits.networks.uplink_ips.ipv4.NETWORK_NAME</span></code> and <code class="docutils literal notranslate"><span class="pre">limits.networks.uplink_ips.ipv6.NETWORK_NAME</span></code> configuration keys for projects with <code class="docutils literal notranslate"><span class="pre">features.networks</span></code> enabled.
These keys define the maximum value of IPs made available on a network named NETWORK_NAME to be assigned as uplink IPs for entities inside a certain project. These entities can be other networks, network forwards or load balancers.</p>
</section>
<section id="entities-with-entitlements">
<h2><code class="docutils literal notranslate"><span class="pre">entities_with_entitlements</span></code><a class="headerlink" href="#entities-with-entitlements" title="Link to this heading">¶</a></h2>
<p>Adds <code class="docutils literal notranslate"><span class="pre">fine_grained</span></code> field to <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/auth/identities/current</span></code> to indicate if the current identity
interacting with the LXD API is fine-grained (that is, associated permissions are managed via group membership).
Allows LXD entities to be returned with an <code class="docutils literal notranslate"><span class="pre">access_entitlements</span></code> field if the current identity is fine-grained and the
GET request to fetch the LXD entities has the <code class="docutils literal notranslate"><span class="pre">with-access-entitlements=<comma_separated_list_of_candidate_entitlements></span></code> query parameter.</p>
</section>
<section id="profiles-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">profiles_all_projects</span></code><a class="headerlink" href="#profiles-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for listing profiles across all projects using the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/profiles</span></code> requests.</p>
</section>
<section id="storage-driver-powerflex">
<h2><code class="docutils literal notranslate"><span class="pre">storage_driver_powerflex</span></code><a class="headerlink" href="#storage-driver-powerflex" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">powerflex</span></code> storage driver which allows the consumption of storage volumes from a Dell PowerFlex storage array using NVMe/TCP and SDC.
The following new pool level configuration keys have been added:</p>
<ol class="arabic simple">
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.snapshot_copy"><code class="docutils literal notranslate"><span class="pre">powerflex.snapshot_copy</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.domain"><code class="docutils literal notranslate"><span class="pre">powerflex.domain</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.gateway"><code class="docutils literal notranslate"><span class="pre">powerflex.gateway</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.gateway.verify"><code class="docutils literal notranslate"><span class="pre">powerflex.gateway.verify</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.mode"><code class="docutils literal notranslate"><span class="pre">powerflex.mode</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.pool"><code class="docutils literal notranslate"><span class="pre">powerflex.pool</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.sdt"><code class="docutils literal notranslate"><span class="pre">powerflex.sdt</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.user.name"><code class="docutils literal notranslate"><span class="pre">powerflex.user.name</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-pool-conf:powerflex.user.password"><code class="docutils literal notranslate"><span class="pre">powerflex.user.password</span></code></a></p></li>
</ol>
<p>The following configuration keys have been added for volumes backed by PowerFlex:</p>
<ol class="arabic simple">
<li><p><a class="configref reference internal" href="../reference/storage_powerflex/#storage-powerflex-volume-conf:block.type"><code class="docutils literal notranslate"><span class="pre">block.type</span></code></a></p></li>
</ol>
</section>
<section id="storage-driver-pure">
<h2><code class="docutils literal notranslate"><span class="pre">storage_driver_pure</span></code><a class="headerlink" href="#storage-driver-pure" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">pure</span></code> storage driver which allows the consumption of storage volumes from a Pure Storage storage array using either iSCSI or NVMe/TCP.</p>
<p>The following pool level configuration keys have been added:</p>
<ol class="arabic simple">
<li><p><a class="configref reference internal" href="../reference/storage_pure/#storage-pure-pool-conf:pure.gateway"><code class="docutils literal notranslate"><span class="pre">pure.gateway</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_pure/#storage-pure-pool-conf:pure.gateway.verify"><code class="docutils literal notranslate"><span class="pre">pure.gateway.verify</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_pure/#storage-pure-pool-conf:pure.api.token"><code class="docutils literal notranslate"><span class="pre">pure.api.token</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_pure/#storage-pure-pool-conf:pure.mode"><code class="docutils literal notranslate"><span class="pre">pure.mode</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_pure/#storage-pure-pool-conf:pure.target"><code class="docutils literal notranslate"><span class="pre">pure.target</span></code></a></p></li>
</ol>
</section>
<section id="cloud-init-ssh-keys">
<h2><code class="docutils literal notranslate"><span class="pre">cloud_init_ssh_keys</span></code><a class="headerlink" href="#cloud-init-ssh-keys" title="Link to this heading">¶</a></h2>
<p>Adds support for injecting additional SSH public keys into instances through <a class="reference internal" href="../reference/instance_options/#instance-options-cloud-init"><span class="std std-ref">cloud-init</span></a> without conflicting with any configuration present on <a class="configref reference internal" href="../reference/instance_options/#instance-cloud-init:cloud-init.vendor-data"><code class="docutils literal notranslate"><span class="pre">cloud-init.vendor-data</span></code></a> or <a class="configref reference internal" href="../reference/instance_options/#instance-cloud-init:cloud-init.user-data"><code class="docutils literal notranslate"><span class="pre">cloud-init.user-data</span></code></a>.</p>
<p>To achieve this, the <code class="docutils literal notranslate"><span class="pre">cloud-init.ssh-keys.KEYNAME</span></code> configuration key is added for both instances and profiles. This key is used to define a public key to be injected. <code class="docutils literal notranslate"><span class="pre">KEYNAME</span></code> can be any arbitrary name for the injected key.</p>
<p>The value for <code class="docutils literal notranslate"><span class="pre">cloud-init.ssh-keys.KEYNAME</span></code> should be <code class="docutils literal notranslate"><span class="pre"><user>:<key></span></code>, where <code class="docutils literal notranslate"><span class="pre"><user></span></code> is the name of the user for whom to inject the key. For <code class="docutils literal notranslate"><span class="pre"><key></span></code>, provide either the public key or a <code class="docutils literal notranslate"><span class="pre">cloud-init</span></code> import ID for a key hosted elsewhere. Example valid values for <code class="docutils literal notranslate"><span class="pre">cloud-init.ssh-keys.KEYNAME</span></code> are <code class="docutils literal notranslate"><span class="pre">root:gh:githubUser</span></code> or <code class="docutils literal notranslate"><span class="pre">myUser:ssh-keyAlg</span> <span class="pre">base64PublicKey</span></code>.</p>
</section>
<section id="oidc-scopes">
<h2><code class="docutils literal notranslate"><span class="pre">oidc_scopes</span></code><a class="headerlink" href="#oidc-scopes" title="Link to this heading">¶</a></h2>
<p>This API extension enables setting an <a class="configref reference internal" href="../server/#server-oidc:oidc.scopes"><code class="docutils literal notranslate"><span class="pre">oidc.scopes</span></code></a> configuration key, which accepts a space-separated list of OIDC scopes to request from the identity provider.
This configuration option can be used to request additional scopes that might be required for retrieving <a class="reference internal" href="../explanation/authorization/#identity-provider-groups"><span class="std std-ref">identity provider groups</span></a> from the identity provider.
Additionally, the optional scopes <code class="docutils literal notranslate"><span class="pre">profile</span></code> and <code class="docutils literal notranslate"><span class="pre">offline_access</span></code> can be unset via this setting.
Note that the <code class="docutils literal notranslate"><span class="pre">openid</span></code> and <code class="docutils literal notranslate"><span class="pre">email</span></code> scopes are always required.</p>
</section>
<section id="project-default-network-and-storage">
<h2><code class="docutils literal notranslate"><span class="pre">project_default_network_and_storage</span></code><a class="headerlink" href="#project-default-network-and-storage" title="Link to this heading">¶</a></h2>
<p>Adds flags –network and –storage. The –network flag adds a network device connected to the specified network to the default profile. The –storage flag adds a root disk device using the specified storage pool to the default profile.</p>
</section>
<section id="client-cert-presence">
<h2><code class="docutils literal notranslate"><span class="pre">client_cert_presence</span></code><a class="headerlink" href="#client-cert-presence" title="Link to this heading">¶</a></h2>
<p>Adds the field <code class="docutils literal notranslate"><span class="pre">client_certificate</span></code> to <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0</span></code> to indicate if the current request has a client certificate in it. This is for informational purposes only and does not affect the behavior of the API.</p>
</section>
<section id="clustering-groups-used-by">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_groups_used_by</span></code><a class="headerlink" href="#clustering-groups-used-by" title="Link to this heading">¶</a></h2>
<p>This API extension adds a <code class="docutils literal notranslate"><span class="pre">used_by</span></code> field to the API response for a <a class="reference internal" href="../explanation/clusters/#cluster-groups"><span class="std std-ref">cluster group</span></a>.
Deletion of a cluster group is disallowed if the cluster group is referenced by project configuration (see <a class="configref reference internal" href="../reference/projects/#project-restricted:restricted.cluster.groups"><code class="docutils literal notranslate"><span class="pre">restricted.cluster.groups</span></code></a>).</p>
</section>
<section id="container-bpf-delegation">
<h2><code class="docutils literal notranslate"><span class="pre">container_bpf_delegation</span></code><a class="headerlink" href="#container-bpf-delegation" title="Link to this heading">¶</a></h2>
<p>Adds new <a class="configref reference internal" href="../reference/instance_options/#instance-security:security.delegate_bpf"><code class="docutils literal notranslate"><span class="pre">security.delegate_bpf</span></code></a>.* group of options in order to support eBPF delegation using BPF Token mechanism. See <a class="reference internal" href="../explanation/bpf/#bpf-delegation-token"><span class="std std-ref">Privilege delegation using BPF Token</span></a> for more information.</p>
</section>
<section id="override-snapshot-profiles-on-copy">
<h2><code class="docutils literal notranslate"><span class="pre">override_snapshot_profiles_on_copy</span></code><a class="headerlink" href="#override-snapshot-profiles-on-copy" title="Link to this heading">¶</a></h2>
<p>This adds a request option to set snapshot’s target profile on instance copy to be inherited from target instance.</p>
</section>
<section id="resources-device-fs-uuid">
<h2><code class="docutils literal notranslate"><span class="pre">resources_device_fs_uuid</span></code><a class="headerlink" href="#resources-device-fs-uuid" title="Link to this heading">¶</a></h2>
<p>Adds the field <code class="docutils literal notranslate"><span class="pre">device_fs_uuid</span></code> including the respective UUID to each disk and partition indicating whether or not a filesystem is located on the device.</p>
</section>
<section id="backup-metadata-version">
<span id="extension-backup-metadataversion"></span><h2><code class="docutils literal notranslate"><span class="pre">backup_metadata_version</span></code><a class="headerlink" href="#backup-metadata-version" title="Link to this heading">¶</a></h2>
<p>Adds the field <code class="docutils literal notranslate"><span class="pre">version</span></code> when exporting instances and custom storage volumes to define the backup file format.
In case the field is omitted, the server’s default version is used.
This maintains backwards compatibility with older clients.</p>
<p>When exporting an instance, the specific version can be provided using the <code class="docutils literal notranslate"><span class="pre">--export-version</span></code> flag:</p>
<p><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">export</span> <span class="pre">v1</span> <span class="pre">--export-version</span> <span class="pre">2</span></code></p>
<p>The same applies when exporting a custom storage volume:</p>
<p><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">storage</span> <span class="pre">volume</span> <span class="pre">export</span> <span class="pre">pool1</span> <span class="pre">vol1</span> <span class="pre">--export-version</span> <span class="pre">2</span></code></p>
</section>
<section id="storage-buckets-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">storage_buckets_all_projects</span></code><a class="headerlink" href="#storage-buckets-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for listing storage buckets across all projects using the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/POOL/buckets</span></code> requests.</p>
</section>
<section id="network-acls-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">network_acls_all_projects</span></code><a class="headerlink" href="#network-acls-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for listing network ACLs across all projects using the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/network-acls</span></code> requests.</p>
</section>
<section id="networks-all-projects">
<h2><code class="docutils literal notranslate"><span class="pre">networks_all_projects</span></code><a class="headerlink" href="#networks-all-projects" title="Link to this heading">¶</a></h2>
<p>This adds support for listing networks across all projects using the <code class="docutils literal notranslate"><span class="pre">all-projects</span></code> parameter in <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/networks</span></code> requests.</p>
</section>
<section id="clustering-restore-skip-mode">
<h2><code class="docutils literal notranslate"><span class="pre">clustering_restore_skip_mode</span></code><a class="headerlink" href="#clustering-restore-skip-mode" title="Link to this heading">¶</a></h2>
<p>Adds a <code class="docutils literal notranslate"><span class="pre">skip</span></code> mode to the restore request. This mode restores a cluster member’s status to <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code> without restarting any of its stopped local instances or migrating back instances that were evacuated to other cluster members.</p>
</section>
<section id="disk-io-threads-virtiofsd">
<h2><code class="docutils literal notranslate"><span class="pre">disk_io_threads_virtiofsd</span></code><a class="headerlink" href="#disk-io-threads-virtiofsd" title="Link to this heading">¶</a></h2>
<p>Adds the <a class="configref reference internal" href="../reference/devices_disk/#device-disk-device-conf:io.threads"><code class="docutils literal notranslate"><span class="pre">io.threads</span></code></a> option on <code class="docutils literal notranslate"><span class="pre">disk</span></code> devices which is used to control the <code class="docutils literal notranslate"><span class="pre">virtiofsd</span></code> thread pool size when sharing file systems into VMs. This can help improve I/O performance.</p>
</section>
<section id="oidc-client-secret">
<h2><code class="docutils literal notranslate"><span class="pre">oidc_client_secret</span></code><a class="headerlink" href="#oidc-client-secret" title="Link to this heading">¶</a></h2>
<p>This adds support for the <a class="configref reference internal" href="../server/#server-oidc:oidc.client.secret"><code class="docutils literal notranslate"><span class="pre">oidc.client.secret</span></code></a> configuration key.
If set, the LXD server will use this value in the OpenID Connect (OIDC) authorization code flow, which is used by LXD UI.
This configuration value is not shared with other LXD clients (such as the LXD CLI).</p>
</section>
<section id="pci-hotplug">
<h2><code class="docutils literal notranslate"><span class="pre">pci_hotplug</span></code><a class="headerlink" href="#pci-hotplug" title="Link to this heading">¶</a></h2>
<p>This adds PCI device hotplugging for VMs.</p>
</section>
<section id="device-patch-removal">
<h2><code class="docutils literal notranslate"><span class="pre">device_patch_removal</span></code><a class="headerlink" href="#device-patch-removal" title="Link to this heading">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/instances/{name}</span></code> endpoint allows removing an instance device by setting its value to <code class="docutils literal notranslate"><span class="pre">null</span></code> in the devices map.</p>
</section>
<section id="daemon-storage-per-project">
<span id="extension-daemon-storage-per-project"></span><h2><code class="docutils literal notranslate"><span class="pre">daemon_storage_per_project</span></code><a class="headerlink" href="#daemon-storage-per-project" title="Link to this heading">¶</a></h2>
<p>This introduces two new configuration keys <a class="configref reference internal" href="../server/#server-miscellaneous:storage.project.{name}.images_volume"><code class="docutils literal notranslate"><span class="pre">storage.project.{name}.images_volume</span></code></a> and
<a class="configref reference internal" href="../server/#server-miscellaneous:storage.project.{name}.backups_volume"><code class="docutils literal notranslate"><span class="pre">storage.project.{name}.backups_volume</span></code></a> per each project to allow for a storage volume on an existing
pool be used for storing the project-specific images and backups artifacts.</p>
</section>
<section id="ovn-internal-load-balancer">
<span id="extension-ovn-internal-load-balancer"></span><h2><code class="docutils literal notranslate"><span class="pre">ovn_internal_load_balancer</span></code><a class="headerlink" href="#ovn-internal-load-balancer" title="Link to this heading">¶</a></h2>
<p>This introduces support for internal OVN load balancers and network forwards. This approach allows <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks to define ports on internal IP addresses that can be forwarded to other internal IPs inside their respective networks.
This change removes the previous limitation on <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks that load balancers and network forwards could only use external IP addresses to forward to internal IPs.</p>
</section>
<section id="auth-bearer-devlxd">
<span id="extension-auth-bearer-devlxd"></span><h2><code class="docutils literal notranslate"><span class="pre">auth_bearer_devlxd</span></code><a class="headerlink" href="#auth-bearer-devlxd" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">bearer</span></code> authentication method and enables authentication to the DevLXD API.
See <a class="reference internal" href="../dev-lxd/#devlxd-authentication-bearer"><span class="std std-ref">DevLXD bearer tokens</span></a>.</p>
</section>
<section id="devlxd-volume-management">
<span id="extension-devlxd-volume-management"></span><h2><code class="docutils literal notranslate"><span class="pre">devlxd_volume_management</span></code><a class="headerlink" href="#devlxd-volume-management" title="Link to this heading">¶</a></h2>
<p>Enables additional DevLXD endpoints for managing custom storage volumes and instance devices when <code class="docutils literal notranslate"><span class="pre">security.devlxd.management.volumes</span></code> is set to true.
These endpoints are primarily intended for use by the LXD CSI driver.</p>
<p>Management is limited to custom storage volumes.
Additionally, the client is required to authenticate using DevLXD identity, which is used to track storage volume and instance device owner.
Volumes and instance devices created through the DevLXD are marked as owned by the authenticated identity and can later be modified or removed through DevLXD only by the same identity.</p>
<p>New DevLXD endpoints:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/{pool}</span></code> — Retrieve a storage pool.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/{pool}/volumes</span></code> — List owned custom volumes in a pool.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/storage-pools/{pool}/volumes/{volume}</span></code> — Retrieve an owned custom volume.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/{pool}/volumes</span></code> — Create a new owned custom volume in a pool.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/storage-pools/{pool}/volumes/{volume}</span></code> — Update an owned custom volume.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/storage-pools/{pool}/volumes/{volume}</span></code> — Delete an owned custom volume.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/instances/{inst}</span></code> — Retrieve an instance and its owned devices.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/instances/{inst}</span></code> — Add new instance devices or modify owned devices.</p></li>
</ul>
<p>Changes to existing DevLXD endpoints:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0</span></code> — Adds a <code class="docutils literal notranslate"><span class="pre">supported_storage_drivers</span></code> field to the response, which is populated when <code class="docutils literal notranslate"><span class="pre">security.devlxd.management.volumes</span></code> is enabled.</p></li>
</ul>
</section>
<section id="storage-driver-alletra">
<span id="extension-storage-driver-alletra"></span><h2><code class="docutils literal notranslate"><span class="pre">storage_driver_alletra</span></code><a class="headerlink" href="#storage-driver-alletra" title="Link to this heading">¶</a></h2>
<p>Adds a new <code class="docutils literal notranslate"><span class="pre">alletra</span></code> storage driver for the consumption of storage volumes from an HPE Alletra storage array.</p>
<p>The following pool-level configuration keys have been added:</p>
<ol class="arabic simple">
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.wsapi"><code class="docutils literal notranslate"><span class="pre">alletra.wsapi</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.wsapi.verify"><code class="docutils literal notranslate"><span class="pre">alletra.wsapi.verify</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.user.name"><code class="docutils literal notranslate"><span class="pre">alletra.user.name</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.user.password"><code class="docutils literal notranslate"><span class="pre">alletra.user.password</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.cpg"><code class="docutils literal notranslate"><span class="pre">alletra.cpg</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.target"><code class="docutils literal notranslate"><span class="pre">alletra.target</span></code></a></p></li>
<li><p><a class="configref reference internal" href="../reference/storage_alletra/#storage-alletra-pool-conf:alletra.mode"><code class="docutils literal notranslate"><span class="pre">alletra.mode</span></code></a></p></li>
</ol>
</section>
<section id="resources-disk-used-by">
<span id="extension-resources-disk-used-by"></span><h2><code class="docutils literal notranslate"><span class="pre">resources_disk_used_by</span></code><a class="headerlink" href="#resources-disk-used-by" title="Link to this heading">¶</a></h2>
<p>Adds the field <code class="docutils literal notranslate"><span class="pre">used_by</span></code> to potential storage disk returned by the resources end point to indicate its use by any virtual parent device, e.g. <code class="docutils literal notranslate"><span class="pre">bcache</span></code>.</p>
</section>
<section id="ovn-dhcp-ranges">
<span id="extension-ovn-dhcp-ranges"></span><h2><code class="docutils literal notranslate"><span class="pre">ovn_dhcp_ranges</span></code><a class="headerlink" href="#ovn-dhcp-ranges" title="Link to this heading">¶</a></h2>
<p>This introduces support for the <a class="configref reference internal" href="../reference/network_ovn/#network-ovn-network-conf:ipv4.dhcp.ranges"><code class="docutils literal notranslate"><span class="pre">ipv4.dhcp.ranges</span></code></a> configuration key for <code class="docutils literal notranslate"><span class="pre">ovn</span></code> networks. This key allows specifying a list of IPv4 ranges
reserved for dynamic allocation using DHCP.</p>
</section>
<section id="operation-requestor">
<span id="extension-operation-requestor"></span><h2><code class="docutils literal notranslate"><span class="pre">operation_requestor</span></code><a class="headerlink" href="#operation-requestor" title="Link to this heading">¶</a></h2>
<p>This adds a new <code class="docutils literal notranslate"><span class="pre">requestor</span></code> field to operations, which contains information about the caller that initiated the operation.</p>
</section>
<section id="import-custom-volume-tar">
<span id="extension-import-custom-volume-tar"></span><h2><code class="docutils literal notranslate"><span class="pre">import_custom_volume_tar</span></code><a class="headerlink" href="#import-custom-volume-tar" title="Link to this heading">¶</a></h2>
<p>This adds new option <code class="docutils literal notranslate"><span class="pre">tar</span></code> for parameter <code class="docutils literal notranslate"><span class="pre">--type</span></code> in <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/storage-pools/{poolName}/volumes/{type}</span></code> API call.</p>
</section>
<section id="projects-force-delete">
<span id="extension-projects-force-delete"></span><h2><code class="docutils literal notranslate"><span class="pre">projects_force_delete</span></code><a class="headerlink" href="#projects-force-delete" title="Link to this heading">¶</a></h2>
<p>Adds support for force deleting projects and their entities (instances, profiles, images, networks, network ACLs, network zones, storage volumes, and storage buckets) by setting the <code class="docutils literal notranslate"><span class="pre">force</span></code> query parameter on <code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/projects/{name}</span></code> requests.</p>
</section>
<section id="auth-oidc-sessions">
<span id="extension-auth-oidc-sessions"></span><h2><code class="docutils literal notranslate"><span class="pre">auth_oidc_sessions</span></code><a class="headerlink" href="#auth-oidc-sessions" title="Link to this heading">¶</a></h2>
<p>Adds session support for OIDC authentication. This enables compatibility with identity providers that issue opaque access tokens.</p>
<p>When a session expires, LXD will re-verify the login with the identity provider.
The duration of OIDC sessions defaults to one week and can be configured via the <a class="configref reference internal" href="../server/#server-oidc:oidc.session.expiry"><code class="docutils literal notranslate"><span class="pre">oidc.session.expiry</span></code></a> configuration key.</p>
<p>Verification of an OIDC session depends on a new, cluster-wide core secret.
The OIDC session expiry can never be greater than the expiry of the core secret.
The <a class="configref reference internal" href="../server/#server-core:core.auth_secret_expiry"><code class="docutils literal notranslate"><span class="pre">core.auth_secret_expiry</span></code></a> configuration option can set to define how long a given secret can be used for before it expires.</p>
</section>
<section id="instance-snapshots-multi-volume">
<span id="extension-instance-snapshots-multi-volume"></span><h2><code class="docutils literal notranslate"><span class="pre">instance_snapshots_multi_volume</span></code><a class="headerlink" href="#instance-snapshots-multi-volume" title="Link to this heading">¶</a></h2>
<p>Enables the creation of a multi-volume snapshot and the restoration of an instance together with its attached volumes, while ensuring crash consistency across volumes.</p>
<p>Adds <code class="docutils literal notranslate"><span class="pre">DiskVolumesMode</span></code> to <code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/instances/{name}/snapshots</span></code> and <code class="docutils literal notranslate"><span class="pre">RestoreDiskVolumesMode</span></code> to <code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/instances/{name}</span></code> to select which attached volumes are included in snapshots/restores: “root” includes only the instance’s root disk; “all-exclusive” includes the root disk and any exclusively attached (non-shared) volumes. Defaults to “root”.</p>
<p>This extension also introduces a new volatile configuration key, <a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.attached_volumes"><code class="docutils literal notranslate"><span class="pre">volatile.attached_volumes</span></code></a>, in the configuration of supported storage drivers for instance snapshots. This key contains a JSON-serialized map of attached volume UUIDs to the UUIDs of their corresponding snapshots. Example value: <code class="docutils literal notranslate"><span class="pre">{<volume1-uuid>:</span> <span class="pre"><snapshot1-uuid>,<volume2-uuid>:</span> <span class="pre"><snapshot2-uuid>}</span></code>.</p>
</section>
<section id="vm-persistent-bus">
<span id="extension-vm-persistent-bus"></span><h2><code class="docutils literal notranslate"><span class="pre">vm_persistent_bus</span></code><a class="headerlink" href="#vm-persistent-bus" title="Link to this heading">¶</a></h2>
<p>Adds support for persistently recording VM PCIe bus allocations in volatile configuration keys.</p>
<p>This introduces two new volatile VM configuration keys:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.<name>.bus"><code class="docutils literal notranslate"><span class="pre">volatile.<name>.bus</span></code></a> - records the bus number for the device.</p></li>
<li><p><a class="configref reference internal" href="../reference/instance_options/#instance-volatile:volatile.bus.mode"><code class="docutils literal notranslate"><span class="pre">volatile.bus.mode</span></code></a> - records whether “persistent” mode is being used for a VM.</p></li>
</ul>
</section>
<section id="instance-placement-groups">
<span id="extension-instance-placement-groups"></span><h2><code class="docutils literal notranslate"><span class="pre">instance_placement_groups</span></code><a class="headerlink" href="#instance-placement-groups" title="Link to this heading">¶</a></h2>
<p>Placement groups define how instances are scheduled across cluster members according to a configurable placement policy (<code class="docutils literal notranslate"><span class="pre">spread</span></code> or <code class="docutils literal notranslate"><span class="pre">compact</span></code>) and rigor (<code class="docutils literal notranslate"><span class="pre">strict</span></code> or <code class="docutils literal notranslate"><span class="pre">permissive</span></code>). They can be referenced in instance and profile configuration through the <a class="configref reference internal" href="../reference/instance_options/#instance-placement:placement.group"><code class="docutils literal notranslate"><span class="pre">placement.group</span></code></a> key to control placement behavior during instance creation and migration.</p>
<p>New API endpoints:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/placement-groups</span></code> — List all placement groups</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/1.0/placement-groups</span></code> — Create a new placement group</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0/placement-groups/{name}</span></code> — Retrieve details for a specific placement group</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/placement-groups/{name}</span></code> — Replace a placement group definition</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/placement-groups/{name}</span></code> — Update selected properties of a placement group</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/1.0/placement-groups/{name}</span></code> — Delete a placement group</p></li>
</ol>
</section>
<section id="ovn-nic-acceleration-parent">
<span id="extension-ovn-nic-acceleration-parent"></span><h2><code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration_parent</span></code><a class="headerlink" href="#ovn-nic-acceleration-parent" title="Link to this heading">¶</a></h2>
<p>Adds support for specifying the OVN NIC acceleration physical function interfaces to allocate virtual functions from.</p>
<p>This avoids the need for adding physical function interfaces to the OVN integration bridge.</p>
<p>This introduces a new <code class="docutils literal notranslate"><span class="pre">ovn</span></code> network and <code class="docutils literal notranslate"><span class="pre">ovn</span></code> NIC configuration key:</p>
<ul class="simple">
<li><p><a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:acceleration.parent"><code class="docutils literal notranslate"><span class="pre">acceleration.parent</span></code></a> - Comma separated list of physical function (PF) interfaces to allocate virtual functions (VFs) from for hardware acceleration when <a class="configref reference internal" href="../reference/devices_nic/#device-nic-ovn-device-conf:acceleration"><code class="docutils literal notranslate"><span class="pre">acceleration</span></code></a> is enabled.</p></li>
</ul>
</section>
<section id="storage-and-profile-operations">
<span id="extension-storage-and-profile-operations"></span><h2><code class="docutils literal notranslate"><span class="pre">storage_and_profile_operations</span></code><a class="headerlink" href="#storage-and-profile-operations" title="Link to this heading">¶</a></h2>
<p>Certain storage and profile endpoints that were previously synchronous now return an operation and behave asynchronously.</p>
<p>Newer LXD Go clients detect the presence of this API extension. When it is available, the client receives an operation object directly from the LXD server.
If the extension is not present, the server response is wrapped in a completed operation, allowing the caller to handle it as an operation while lacking a retrievable operation ID.</p>
<p>Older LXD Go clients are incompatible with servers that include this extension.
Instead of returning a successful response, they will receive an operation response.</p>
<p>Endpoints converted to asynchronous behavior:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/storage-pools/{pool}/volumes/{type}</span></code> - Create storage volume</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/storage-pools/{pool}/volumes/{type}/{vol}</span></code> - Update storage volume</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/storage-pools/{pool}/volumes/{type}/{vol}</span></code> - Patch storage volume</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">POST</span> <span class="pre">/storage-pools/{pool}/volumes/{type}/{vol}</span></code> - Rename storage volume</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DELETE</span> <span class="pre">/storage-pools/{pool}/volumes/{type}/{vol}</span></code> - Delete storage volume</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/storage-pools/{pool}/volumes/{type}/{vol}/snapshots/{snap}</span></code> - Update storage volume snapshot</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/storage-pools/{pool}/volumes/{type}/{vol}/snapshots/{snap}</span></code> - Patch storage volume snapshot</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PUT</span> <span class="pre">/1.0/profiles/{name}</span></code> - Update profile</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PATCH</span> <span class="pre">/1.0/profiles/{name}</span></code> - Patch profile</p></li>
</ul>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="../events/">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Events</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="../api/">
<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">Main API specification</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2014-2026 LXD contributors
</div>
<div class="last-updated">
Last updated on Feb 04, 2026</div>
<div class="show-source">
<a class="muted-link" href="../_sources/api-extensions.md.txt"
rel="nofollow">Show source</a>
</div>
</div>
<div>
<a class="display-contributors">Thanks to the 71 contributors!</a>
<div id="overlay"></div>
<ul class="all-contributors">
<li>
<a href="https://github.com/canonical/lxd/commit/e3d834e98c3aeb9c196ffc66e8db0e39d692d689" class="contributor">Adam Stephens</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/290eee27fb1bb87a820c91548f965048e32f182a" class="contributor">Alberto Donato</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/c35edba1322cd02b3316f22d384fa020f5a05894" class="contributor">Alexander Mikhalitsyn</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/4d7e5e97bf48f9fb94228ec7a1d845c7053fd358" class="contributor">Amro Kerkiz</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/8d443e3f81a36b32caed05b6339dc3168f6c1e1d" class="contributor">Andy Greene</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/11be7dc5cb4e49088428f9f67b1b36833ca936be" class="contributor">Aurutus</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/98c8e566224c0447e9b815930710a68df48af24f" class="contributor">Carlos Neira</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/b24d900b09e165a6b92e77f96ad7a2ae53c4f8f7" class="contributor">Chris Loper</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/575c24361ebae70c27eb70b54f36b7a2ceec7b68" class="contributor">Christian Brauner</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/a4c5020939963a9d0e7e7254e7778ea08d654a3e" class="contributor">Conner Crosby</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/f9b21d257a4e8deb79b36d1540d151b4d14bc242" class="contributor">D R Siddhartha</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/8a12a5b2c6f70933138cce1ff37da491d142f979" class="contributor">Daniela Sonnenschein</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/8ab662ca017681b253677b0d6ac4681a144942aa" class="contributor">David Edler</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/1abcb690101817ef9e8b14b3437ba49e1f3fff2f" class="contributor">Dillon Samra</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/743dee7dc4ee4b4fb5c06c52b5baf1abe3e0d8a4" class="contributor">Din Music</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/f3bd7c13964ca90f8510fbff7eeb08e954a5501b" class="contributor">Dinah Baum</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/97aa7910e8022de9a5f61184448da82469ec8a8a" class="contributor">Eric Fan</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/dbc0ac4883e4cfc838c4a15721300be364ddd45f" class="contributor">Fierykev</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/cefc0168f40f8c108f28f7d5250bbc380bdcc90c" class="contributor">Free Ekanayaka</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/8e080566a755d221fa76210b5e16932134683207" class="contributor">Gabriel Mougard</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/84e2feada49d78cb9bc7f218eaf6447e952479d6" class="contributor">Hiroaki Nakamura</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/100034a3e1d93e48f101384baf3434ea1b0db975" class="contributor">Igor Galić</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/cf74b05ae335a68bfe50f6a1c06a27fd8c028862" class="contributor">Jack Stenglein</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/41256e866886c678efd9ba4ff82335db8b7b7160" class="contributor">Jamiel Sharief</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/ba5ae09207948fe81622522c8f31036926aa5b92" class="contributor">Jingkui Wang</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/0966f5412367f801ce2eec2f80d690a418cfee8c" class="contributor">Jose R. Gonzalez</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/4e545854ec156eaf7afead763dd712d06dfa844b" class="contributor">Julian Pelizäus</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/0645895ee4550808f891d262bea417f716ad90e6" class="contributor">KATOH Yasufumi</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/ebc0a403c077bf5781ff234166f0f96fe9f6d019" class="contributor">Kadin Sayani</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/afb1e0dd5ec3434ec7afd824f679dce52a8145c3" class="contributor">Kevin Turner</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/6c936194d322ff56528a3cc6c5d7df8308df0802" class="contributor">Liam Nickell</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/f920f492f1b92abee0cf6e0a8d4c1e338ef77100" class="contributor">Lily</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/6f00cdbf175f3206c653ea8c0356b430d4a9d2ca" class="contributor">Louise Montalvo</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/60f0c5c8231716fe84d2356f7bc39e2ae4b9f3c9" class="contributor">Mahesh Punjabi</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/440a3287c17189f945a57c1a1940165cce6736b2" class="contributor">Maran</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9358fffbfc26598d80c30d6c9a491c904604487e" class="contributor">Marcus Haukelid Larsen</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9529cba7c274c4bfda9e1d902fa9b23f3fdeaa19" class="contributor">Mark Bolton</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9c8659742949c8bf9f0602269fd98b7a9e15eb13" class="contributor">Mark Laing</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/96dad201510ff6b0f17067ec3d4692110c2440b5" class="contributor">Matthew Anderson</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9eb329e770bc1dfaa91ddd2ff99dec6d12cc88b1" class="contributor">Max Asnaashari</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/b3418ec3f4d29fb08fef19cd051f38b950f8221b" class="contributor">Meghea Iulian</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9e62e2d493a2e3d089b82463bec2c34659808d5a" class="contributor">Minae Lee</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/4bb0fe4282d0727c62d6af6ae2312dc0ed8c047e" class="contributor">Mohamed Ilaiwi</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/c0ce8e9f9adb2361d10e44d1c2eab9f1259ff7b6" class="contributor">Nabil Zubair</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/7323631ec5ba65d866d8c28274b1ff5fc86fc6a2" class="contributor">Nikita Mezhenskyi</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/885bd7c74592888a08a4bd3d2af749ac3617a730" class="contributor">Pavel Sapezhko</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/7c80bd7cb640c6a5b6848451b6e1ae7693b74f6c" class="contributor">Piotr Resztak</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/539bda4669773a76ec922351eb75578d7bf2a0b8" class="contributor">Qian Zhang</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/dd505077024648345529ff27ea82ff240661600d" class="contributor">Ruth Fuchss</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/16738248ec75d9e4728d02d875f54a1e9adaca9c" class="contributor">Sascha Bast</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/071f58745cb276d2c33b5545a4126861a999bcaa" class="contributor">Sava Radoš</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/be9bce7d6b122ff6021779fa567857890f0992d0" class="contributor">Simon Deziel</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9fa1c8f7a0f0714289c2f5954ae8dba8d7aaa992" class="contributor">Stanislav Kozina</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/8131a4e7136e990ce8147ec915afe68de50ffb63" class="contributor">Stéphane Graber</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/70d8d2ed2094dde81a988f3553e81ccf4fe88945" class="contributor">Thomas Hipp</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/39d2843c77a38c383d858ae59d09b7d652d3c7f0" class="contributor">Thomas Parrott</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/5cc04544315522a96ce9580169199e3deca92513" class="contributor">Tom Parrott</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/bfe7296daa4f89fabf0c41c21a54009dfb05a709" class="contributor">Tycho Andersen</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/c3dc603edb8538ba309d620b644ebf3cecc4d3d1" class="contributor">Uzi Erdenebileg</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/9614ee6a1be0962538b96093f3336e70e3f1bca9" class="contributor">Vadym Khomenko</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/040955e1c1e8b00d2ad4645afd49ff515c0df041" class="contributor">Viktor-Yakovchuk</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/2e5121e83e3da92b3af9d8b301911d75f6a380ab" class="contributor">Vincent Catros</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/26bc2cc01becaee7812454cd8cc84ec8abd9156b" class="contributor">Vincent Kherbache</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/a99bd3ffebebdc7376b02c5be0ce5ceb97d48e33" class="contributor">Wesley Hershberger</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/d3be92a962cfe949ad0eded351440f600133cb96" class="contributor">anusha-paul</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/c45d87f7daf6777cc4337f4f878a431a3ea20d35" class="contributor">gary-wzl77</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/aed2fac6a5d54d884eeef7e00822f963d8b302af" class="contributor">hamistao</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/a1b5cfea1724f642012d5e73a6c94e1bce84e3ff" class="contributor">linan</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/3a56623f76321e16711eff5dd93dc28004828d7d" class="contributor">sona78</a>
</li>
<li>
<a href="https://github.com/canonical/lxd/commit/21640467833f78d1735ae7ee9fbf87b07fce09ff" class="contributor">tomponline</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: api-extensions.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/api-extensions.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="#">API extensions</a><ul>
<li><a class="reference internal" href="#storage-zfs-remove-snapshots"><code class="docutils literal notranslate"><span class="pre">storage_zfs_remove_snapshots</span></code></a></li>
<li><a class="reference internal" href="#container-host-shutdown-timeout"><code class="docutils literal notranslate"><span class="pre">container_host_shutdown_timeout</span></code></a></li>
<li><a class="reference internal" href="#container-stop-priority"><code class="docutils literal notranslate"><span class="pre">container_stop_priority</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-filtering"><code class="docutils literal notranslate"><span class="pre">container_syscall_filtering</span></code></a></li>
<li><a class="reference internal" href="#auth-pki"><code class="docutils literal notranslate"><span class="pre">auth_pki</span></code></a></li>
<li><a class="reference internal" href="#container-last-used-at"><code class="docutils literal notranslate"><span class="pre">container_last_used_at</span></code></a></li>
<li><a class="reference internal" href="#etag"><code class="docutils literal notranslate"><span class="pre">etag</span></code></a></li>
<li><a class="reference internal" href="#patch"><code class="docutils literal notranslate"><span class="pre">patch</span></code></a></li>
<li><a class="reference internal" href="#usb-devices"><code class="docutils literal notranslate"><span class="pre">usb_devices</span></code></a></li>
<li><a class="reference internal" href="#https-allowed-credentials"><code class="docutils literal notranslate"><span class="pre">https_allowed_credentials</span></code></a></li>
<li><a class="reference internal" href="#image-compression-algorithm"><code class="docutils literal notranslate"><span class="pre">image_compression_algorithm</span></code></a></li>
<li><a class="reference internal" href="#directory-manipulation"><code class="docutils literal notranslate"><span class="pre">directory_manipulation</span></code></a></li>
<li><a class="reference internal" href="#container-cpu-time"><code class="docutils literal notranslate"><span class="pre">container_cpu_time</span></code></a></li>
<li><a class="reference internal" href="#storage-zfs-use-refquota"><code class="docutils literal notranslate"><span class="pre">storage_zfs_use_refquota</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-mount-options"><code class="docutils literal notranslate"><span class="pre">storage_lvm_mount_options</span></code></a></li>
<li><a class="reference internal" href="#network"><code class="docutils literal notranslate"><span class="pre">network</span></code></a></li>
<li><a class="reference internal" href="#profile-usedby"><code class="docutils literal notranslate"><span class="pre">profile_usedby</span></code></a></li>
<li><a class="reference internal" href="#container-push"><code class="docutils literal notranslate"><span class="pre">container_push</span></code></a></li>
<li><a class="reference internal" href="#container-exec-recording"><code class="docutils literal notranslate"><span class="pre">container_exec_recording</span></code></a></li>
<li><a class="reference internal" href="#certificate-update"><code class="docutils literal notranslate"><span class="pre">certificate_update</span></code></a></li>
<li><a class="reference internal" href="#container-exec-signal-handling"><code class="docutils literal notranslate"><span class="pre">container_exec_signal_handling</span></code></a></li>
<li><a class="reference internal" href="#gpu-devices"><code class="docutils literal notranslate"><span class="pre">gpu_devices</span></code></a></li>
<li><a class="reference internal" href="#container-image-properties"><code class="docutils literal notranslate"><span class="pre">container_image_properties</span></code></a></li>
<li><a class="reference internal" href="#migration-progress"><code class="docutils literal notranslate"><span class="pre">migration_progress</span></code></a></li>
<li><a class="reference internal" href="#id-map"><code class="docutils literal notranslate"><span class="pre">id_map</span></code></a></li>
<li><a class="reference internal" href="#network-firewall-filtering"><code class="docutils literal notranslate"><span class="pre">network_firewall_filtering</span></code></a></li>
<li><a class="reference internal" href="#network-routes"><code class="docutils literal notranslate"><span class="pre">network_routes</span></code></a></li>
<li><a class="reference internal" href="#storage"><code class="docutils literal notranslate"><span class="pre">storage</span></code></a></li>
<li><a class="reference internal" href="#file-delete"><code class="docutils literal notranslate"><span class="pre">file_delete</span></code></a></li>
<li><a class="reference internal" href="#file-append"><code class="docutils literal notranslate"><span class="pre">file_append</span></code></a></li>
<li><a class="reference internal" href="#network-dhcp-expiry"><code class="docutils literal notranslate"><span class="pre">network_dhcp_expiry</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-vg-rename"><code class="docutils literal notranslate"><span class="pre">storage_lvm_vg_rename</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-thinpool-rename"><code class="docutils literal notranslate"><span class="pre">storage_lvm_thinpool_rename</span></code></a></li>
<li><a class="reference internal" href="#network-vlan"><code class="docutils literal notranslate"><span class="pre">network_vlan</span></code></a></li>
<li><a class="reference internal" href="#image-create-aliases"><code class="docutils literal notranslate"><span class="pre">image_create_aliases</span></code></a></li>
<li><a class="reference internal" href="#container-stateless-copy"><code class="docutils literal notranslate"><span class="pre">container_stateless_copy</span></code></a></li>
<li><a class="reference internal" href="#container-only-migration"><code class="docutils literal notranslate"><span class="pre">container_only_migration</span></code></a></li>
<li><a class="reference internal" href="#storage-zfs-clone-copy"><code class="docutils literal notranslate"><span class="pre">storage_zfs_clone_copy</span></code></a></li>
<li><a class="reference internal" href="#unix-device-rename"><code class="docutils literal notranslate"><span class="pre">unix_device_rename</span></code></a></li>
<li><a class="reference internal" href="#storage-rsync-bwlimit"><code class="docutils literal notranslate"><span class="pre">storage_rsync_bwlimit</span></code></a></li>
<li><a class="reference internal" href="#network-vxlan-interface"><code class="docutils literal notranslate"><span class="pre">network_vxlan_interface</span></code></a></li>
<li><a class="reference internal" href="#storage-btrfs-mount-options"><code class="docutils literal notranslate"><span class="pre">storage_btrfs_mount_options</span></code></a></li>
<li><a class="reference internal" href="#entity-description"><code class="docutils literal notranslate"><span class="pre">entity_description</span></code></a></li>
<li><a class="reference internal" href="#image-force-refresh"><code class="docutils literal notranslate"><span class="pre">image_force_refresh</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-lv-resizing"><code class="docutils literal notranslate"><span class="pre">storage_lvm_lv_resizing</span></code></a></li>
<li><a class="reference internal" href="#id-map-base"><code class="docutils literal notranslate"><span class="pre">id_map_base</span></code></a></li>
<li><a class="reference internal" href="#file-symlinks"><code class="docutils literal notranslate"><span class="pre">file_symlinks</span></code></a></li>
<li><a class="reference internal" href="#container-push-target"><code class="docutils literal notranslate"><span class="pre">container_push_target</span></code></a></li>
<li><a class="reference internal" href="#network-vlan-physical"><code class="docutils literal notranslate"><span class="pre">network_vlan_physical</span></code></a></li>
<li><a class="reference internal" href="#storage-images-delete"><code class="docutils literal notranslate"><span class="pre">storage_images_delete</span></code></a></li>
<li><a class="reference internal" href="#container-edit-metadata"><code class="docutils literal notranslate"><span class="pre">container_edit_metadata</span></code></a></li>
<li><a class="reference internal" href="#container-snapshot-stateful-migration"><code class="docutils literal notranslate"><span class="pre">container_snapshot_stateful_migration</span></code></a></li>
<li><a class="reference internal" href="#storage-driver-ceph"><code class="docutils literal notranslate"><span class="pre">storage_driver_ceph</span></code></a></li>
<li><a class="reference internal" href="#storage-ceph-user-name"><code class="docutils literal notranslate"><span class="pre">storage_ceph_user_name</span></code></a></li>
<li><a class="reference internal" href="#instance-types"><code class="docutils literal notranslate"><span class="pre">instance_types</span></code></a></li>
<li><a class="reference internal" href="#storage-volatile-initial-source"><code class="docutils literal notranslate"><span class="pre">storage_volatile_initial_source</span></code></a></li>
<li><a class="reference internal" href="#storage-ceph-force-osd-reuse"><code class="docutils literal notranslate"><span class="pre">storage_ceph_force_osd_reuse</span></code></a></li>
<li><a class="reference internal" href="#storage-block-filesystem-btrfs"><code class="docutils literal notranslate"><span class="pre">storage_block_filesystem_btrfs</span></code></a></li>
<li><a class="reference internal" href="#resources"><code class="docutils literal notranslate"><span class="pre">resources</span></code></a></li>
<li><a class="reference internal" href="#kernel-limits"><code class="docutils literal notranslate"><span class="pre">kernel_limits</span></code></a></li>
<li><a class="reference internal" href="#storage-api-volume-rename"><code class="docutils literal notranslate"><span class="pre">storage_api_volume_rename</span></code></a></li>
<li><a class="reference internal" href="#network-sriov"><code class="docutils literal notranslate"><span class="pre">network_sriov</span></code></a></li>
<li><a class="reference internal" href="#console"><code class="docutils literal notranslate"><span class="pre">console</span></code></a></li>
<li><a class="reference internal" href="#restrict-devlxd"><code class="docutils literal notranslate"><span class="pre">restrict_devlxd</span></code></a></li>
<li><a class="reference internal" href="#migration-pre-copy"><code class="docutils literal notranslate"><span class="pre">migration_pre_copy</span></code></a></li>
<li><a class="reference internal" href="#infiniband"><code class="docutils literal notranslate"><span class="pre">infiniband</span></code></a></li>
<li><a class="reference internal" href="#maas-network"><code class="docutils literal notranslate"><span class="pre">maas_network</span></code></a></li>
<li><a class="reference internal" href="#devlxd-events"><code class="docutils literal notranslate"><span class="pre">devlxd_events</span></code></a></li>
<li><a class="reference internal" href="#proxy"><code class="docutils literal notranslate"><span class="pre">proxy</span></code></a></li>
<li><a class="reference internal" href="#network-dhcp-gateway"><code class="docutils literal notranslate"><span class="pre">network_dhcp_gateway</span></code></a></li>
<li><a class="reference internal" href="#file-get-symlink"><code class="docutils literal notranslate"><span class="pre">file_get_symlink</span></code></a></li>
<li><a class="reference internal" href="#network-leases"><code class="docutils literal notranslate"><span class="pre">network_leases</span></code></a></li>
<li><a class="reference internal" href="#unix-device-hotplug"><code class="docutils literal notranslate"><span class="pre">unix_device_hotplug</span></code></a></li>
<li><a class="reference internal" href="#storage-api-local-volume-handling"><code class="docutils literal notranslate"><span class="pre">storage_api_local_volume_handling</span></code></a></li>
<li><a class="reference internal" href="#operation-description"><code class="docutils literal notranslate"><span class="pre">operation_description</span></code></a></li>
<li><a class="reference internal" href="#clustering"><code class="docutils literal notranslate"><span class="pre">clustering</span></code></a></li>
<li><a class="reference internal" href="#event-lifecycle"><code class="docutils literal notranslate"><span class="pre">event_lifecycle</span></code></a></li>
<li><a class="reference internal" href="#storage-api-remote-volume-handling"><code class="docutils literal notranslate"><span class="pre">storage_api_remote_volume_handling</span></code></a></li>
<li><a class="reference internal" href="#nvidia-runtime"><code class="docutils literal notranslate"><span class="pre">nvidia_runtime</span></code></a></li>
<li><a class="reference internal" href="#container-mount-propagation"><code class="docutils literal notranslate"><span class="pre">container_mount_propagation</span></code></a></li>
<li><a class="reference internal" href="#container-backup"><code class="docutils literal notranslate"><span class="pre">container_backup</span></code></a></li>
<li><a class="reference internal" href="#devlxd-images"><code class="docutils literal notranslate"><span class="pre">devlxd_images</span></code></a></li>
<li><a class="reference internal" href="#container-local-cross-pool-handling"><code class="docutils literal notranslate"><span class="pre">container_local_cross_pool_handling</span></code></a></li>
<li><a class="reference internal" href="#proxy-unix"><code class="docutils literal notranslate"><span class="pre">proxy_unix</span></code></a></li>
<li><a class="reference internal" href="#proxy-udp"><code class="docutils literal notranslate"><span class="pre">proxy_udp</span></code></a></li>
<li><a class="reference internal" href="#clustering-join"><code class="docutils literal notranslate"><span class="pre">clustering_join</span></code></a></li>
<li><a class="reference internal" href="#proxy-tcp-udp-multi-port-handling"><code class="docutils literal notranslate"><span class="pre">proxy_tcp_udp_multi_port_handling</span></code></a></li>
<li><a class="reference internal" href="#network-state"><code class="docutils literal notranslate"><span class="pre">network_state</span></code></a></li>
<li><a class="reference internal" href="#proxy-unix-dac-properties"><code class="docutils literal notranslate"><span class="pre">proxy_unix_dac_properties</span></code></a></li>
<li><a class="reference internal" href="#container-protection-delete"><code class="docutils literal notranslate"><span class="pre">container_protection_delete</span></code></a></li>
<li><a class="reference internal" href="#proxy-priv-drop"><code class="docutils literal notranslate"><span class="pre">proxy_priv_drop</span></code></a></li>
<li><a class="reference internal" href="#pprof-http"><code class="docutils literal notranslate"><span class="pre">pprof_http</span></code></a></li>
<li><a class="reference internal" href="#proxy-haproxy-protocol"><code class="docutils literal notranslate"><span class="pre">proxy_haproxy_protocol</span></code></a></li>
<li><a class="reference internal" href="#network-hwaddr"><code class="docutils literal notranslate"><span class="pre">network_hwaddr</span></code></a></li>
<li><a class="reference internal" href="#proxy-nat"><code class="docutils literal notranslate"><span class="pre">proxy_nat</span></code></a></li>
<li><a class="reference internal" href="#network-nat-order"><code class="docutils literal notranslate"><span class="pre">network_nat_order</span></code></a></li>
<li><a class="reference internal" href="#container-full"><code class="docutils literal notranslate"><span class="pre">container_full</span></code></a></li>
<li><a class="reference internal" href="#backup-compression"><code class="docutils literal notranslate"><span class="pre">backup_compression</span></code></a></li>
<li><a class="reference internal" href="#nvidia-runtime-config"><code class="docutils literal notranslate"><span class="pre">nvidia_runtime_config</span></code></a></li>
<li><a class="reference internal" href="#storage-api-volume-snapshots"><code class="docutils literal notranslate"><span class="pre">storage_api_volume_snapshots</span></code></a></li>
<li><a class="reference internal" href="#storage-unmapped"><code class="docutils literal notranslate"><span class="pre">storage_unmapped</span></code></a></li>
<li><a class="reference internal" href="#projects"><code class="docutils literal notranslate"><span class="pre">projects</span></code></a></li>
<li><a class="reference internal" href="#network-vxlan-ttl"><code class="docutils literal notranslate"><span class="pre">network_vxlan_ttl</span></code></a></li>
<li><a class="reference internal" href="#container-incremental-copy"><code class="docutils literal notranslate"><span class="pre">container_incremental_copy</span></code></a></li>
<li><a class="reference internal" href="#usb-optional-vendorid"><code class="docutils literal notranslate"><span class="pre">usb_optional_vendorid</span></code></a></li>
<li><a class="reference internal" href="#snapshot-scheduling"><code class="docutils literal notranslate"><span class="pre">snapshot_scheduling</span></code></a></li>
<li><a class="reference internal" href="#snapshots-schedule-aliases"><code class="docutils literal notranslate"><span class="pre">snapshots_schedule_aliases</span></code></a></li>
<li><a class="reference internal" href="#container-copy-project"><code class="docutils literal notranslate"><span class="pre">container_copy_project</span></code></a></li>
<li><a class="reference internal" href="#clustering-server-address"><code class="docutils literal notranslate"><span class="pre">clustering_server_address</span></code></a></li>
<li><a class="reference internal" href="#clustering-image-replication"><code class="docutils literal notranslate"><span class="pre">clustering_image_replication</span></code></a></li>
<li><a class="reference internal" href="#container-protection-shift"><code class="docutils literal notranslate"><span class="pre">container_protection_shift</span></code></a></li>
<li><a class="reference internal" href="#snapshot-expiry"><code class="docutils literal notranslate"><span class="pre">snapshot_expiry</span></code></a></li>
<li><a class="reference internal" href="#snapshot-expiry-creation"><code class="docutils literal notranslate"><span class="pre">snapshot_expiry_creation</span></code></a></li>
<li><a class="reference internal" href="#network-leases-location"><code class="docutils literal notranslate"><span class="pre">network_leases_location</span></code></a></li>
<li><a class="reference internal" href="#resources-cpu-socket"><code class="docutils literal notranslate"><span class="pre">resources_cpu_socket</span></code></a></li>
<li><a class="reference internal" href="#resources-gpu"><code class="docutils literal notranslate"><span class="pre">resources_gpu</span></code></a></li>
<li><a class="reference internal" href="#resources-numa"><code class="docutils literal notranslate"><span class="pre">resources_numa</span></code></a></li>
<li><a class="reference internal" href="#kernel-features"><code class="docutils literal notranslate"><span class="pre">kernel_features</span></code></a></li>
<li><a class="reference internal" href="#id-map-current"><code class="docutils literal notranslate"><span class="pre">id_map_current</span></code></a></li>
<li><a class="reference internal" href="#event-location"><code class="docutils literal notranslate"><span class="pre">event_location</span></code></a></li>
<li><a class="reference internal" href="#storage-api-remote-volume-snapshots"><code class="docutils literal notranslate"><span class="pre">storage_api_remote_volume_snapshots</span></code></a></li>
<li><a class="reference internal" href="#network-nat-address"><code class="docutils literal notranslate"><span class="pre">network_nat_address</span></code></a></li>
<li><a class="reference internal" href="#container-nic-routes"><code class="docutils literal notranslate"><span class="pre">container_nic_routes</span></code></a></li>
<li><a class="reference internal" href="#cluster-internal-copy"><code class="docutils literal notranslate"><span class="pre">cluster_internal_copy</span></code></a></li>
<li><a class="reference internal" href="#seccomp-notify"><code class="docutils literal notranslate"><span class="pre">seccomp_notify</span></code></a></li>
<li><a class="reference internal" href="#lxc-features"><code class="docutils literal notranslate"><span class="pre">lxc_features</span></code></a></li>
<li><a class="reference internal" href="#container-nic-ipvlan"><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan</span></code></a></li>
<li><a class="reference internal" href="#network-vlan-sriov"><code class="docutils literal notranslate"><span class="pre">network_vlan_sriov</span></code></a></li>
<li><a class="reference internal" href="#storage-cephfs"><code class="docutils literal notranslate"><span class="pre">storage_cephfs</span></code></a></li>
<li><a class="reference internal" href="#container-nic-ipfilter"><code class="docutils literal notranslate"><span class="pre">container_nic_ipfilter</span></code></a></li>
<li><a class="reference internal" href="#resources-v2"><code class="docutils literal notranslate"><span class="pre">resources_v2</span></code></a></li>
<li><a class="reference internal" href="#container-exec-user-group-cwd"><code class="docutils literal notranslate"><span class="pre">container_exec_user_group_cwd</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept</span></code></a></li>
<li><a class="reference internal" href="#container-disk-shift"><code class="docutils literal notranslate"><span class="pre">container_disk_shift</span></code></a></li>
<li><a class="reference internal" href="#storage-shifted"><code class="docutils literal notranslate"><span class="pre">storage_shifted</span></code></a></li>
<li><a class="reference internal" href="#resources-infiniband"><code class="docutils literal notranslate"><span class="pre">resources_infiniband</span></code></a></li>
<li><a class="reference internal" href="#daemon-storage"><code class="docutils literal notranslate"><span class="pre">daemon_storage</span></code></a></li>
<li><a class="reference internal" href="#instances"><code class="docutils literal notranslate"><span class="pre">instances</span></code></a></li>
<li><a class="reference internal" href="#image-types"><code class="docutils literal notranslate"><span class="pre">image_types</span></code></a></li>
<li><a class="reference internal" href="#resources-disk-sata"><code class="docutils literal notranslate"><span class="pre">resources_disk_sata</span></code></a></li>
<li><a class="reference internal" href="#clustering-roles"><code class="docutils literal notranslate"><span class="pre">clustering_roles</span></code></a></li>
<li><a class="reference internal" href="#images-expiry"><code class="docutils literal notranslate"><span class="pre">images_expiry</span></code></a></li>
<li><a class="reference internal" href="#resources-network-firmware"><code class="docutils literal notranslate"><span class="pre">resources_network_firmware</span></code></a></li>
<li><a class="reference internal" href="#backup-compression-algorithm"><code class="docutils literal notranslate"><span class="pre">backup_compression_algorithm</span></code></a></li>
<li><a class="reference internal" href="#ceph-data-pool-name"><code class="docutils literal notranslate"><span class="pre">ceph_data_pool_name</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-mount"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_mount</span></code></a></li>
<li><a class="reference internal" href="#compression-squashfs"><code class="docutils literal notranslate"><span class="pre">compression_squashfs</span></code></a></li>
<li><a class="reference internal" href="#container-raw-mount"><code class="docutils literal notranslate"><span class="pre">container_raw_mount</span></code></a></li>
<li><a class="reference internal" href="#container-nic-routed"><code class="docutils literal notranslate"><span class="pre">container_nic_routed</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-mount-fuse"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_mount_fuse</span></code></a></li>
<li><a class="reference internal" href="#container-disk-ceph"><code class="docutils literal notranslate"><span class="pre">container_disk_ceph</span></code></a></li>
<li><a class="reference internal" href="#virtual-machines"><code class="docutils literal notranslate"><span class="pre">virtual-machines</span></code></a></li>
<li><a class="reference internal" href="#image-profiles"><code class="docutils literal notranslate"><span class="pre">image_profiles</span></code></a></li>
<li><a class="reference internal" href="#clustering-architecture"><code class="docutils literal notranslate"><span class="pre">clustering_architecture</span></code></a></li>
<li><a class="reference internal" href="#resources-disk-id"><code class="docutils literal notranslate"><span class="pre">resources_disk_id</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-stripes"><code class="docutils literal notranslate"><span class="pre">storage_lvm_stripes</span></code></a></li>
<li><a class="reference internal" href="#vm-boot-priority"><code class="docutils literal notranslate"><span class="pre">vm_boot_priority</span></code></a></li>
<li><a class="reference internal" href="#unix-hotplug-devices"><code class="docutils literal notranslate"><span class="pre">unix_hotplug_devices</span></code></a></li>
<li><a class="reference internal" href="#api-filtering"><code class="docutils literal notranslate"><span class="pre">api_filtering</span></code></a></li>
<li><a class="reference internal" href="#instance-nic-network"><code class="docutils literal notranslate"><span class="pre">instance_nic_network</span></code></a></li>
<li><a class="reference internal" href="#clustering-sizing"><code class="docutils literal notranslate"><span class="pre">clustering_sizing</span></code></a></li>
<li><a class="reference internal" href="#firewall-driver"><code class="docutils literal notranslate"><span class="pre">firewall_driver</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-vg-force-reuse"><code class="docutils literal notranslate"><span class="pre">storage_lvm_vg_force_reuse</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-hugetlbfs"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_hugetlbfs</span></code></a></li>
<li><a class="reference internal" href="#limits-hugepages"><code class="docutils literal notranslate"><span class="pre">limits_hugepages</span></code></a></li>
<li><a class="reference internal" href="#container-nic-routed-gateway"><code class="docutils literal notranslate"><span class="pre">container_nic_routed_gateway</span></code></a></li>
<li><a class="reference internal" href="#projects-restrictions"><code class="docutils literal notranslate"><span class="pre">projects_restrictions</span></code></a></li>
<li><a class="reference internal" href="#custom-volume-snapshot-expiry"><code class="docutils literal notranslate"><span class="pre">custom_volume_snapshot_expiry</span></code></a></li>
<li><a class="reference internal" href="#volume-snapshot-scheduling"><code class="docutils literal notranslate"><span class="pre">volume_snapshot_scheduling</span></code></a></li>
<li><a class="reference internal" href="#trust-ca-certificates"><code class="docutils literal notranslate"><span class="pre">trust_ca_certificates</span></code></a></li>
<li><a class="reference internal" href="#snapshot-disk-usage"><code class="docutils literal notranslate"><span class="pre">snapshot_disk_usage</span></code></a></li>
<li><a class="reference internal" href="#clustering-edit-roles"><code class="docutils literal notranslate"><span class="pre">clustering_edit_roles</span></code></a></li>
<li><a class="reference internal" href="#container-nic-routed-host-address"><code class="docutils literal notranslate"><span class="pre">container_nic_routed_host_address</span></code></a></li>
<li><a class="reference internal" href="#container-nic-ipvlan-gateway"><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan_gateway</span></code></a></li>
<li><a class="reference internal" href="#resources-usb-pci"><code class="docutils literal notranslate"><span class="pre">resources_usb_pci</span></code></a></li>
<li><a class="reference internal" href="#resources-cpu-threads-numa"><code class="docutils literal notranslate"><span class="pre">resources_cpu_threads_numa</span></code></a></li>
<li><a class="reference internal" href="#resources-cpu-core-die"><code class="docutils literal notranslate"><span class="pre">resources_cpu_core_die</span></code></a></li>
<li><a class="reference internal" href="#api-os"><code class="docutils literal notranslate"><span class="pre">api_os</span></code></a></li>
<li><a class="reference internal" href="#container-nic-routed-host-table"><code class="docutils literal notranslate"><span class="pre">container_nic_routed_host_table</span></code></a></li>
<li><a class="reference internal" href="#container-nic-ipvlan-host-table"><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan_host_table</span></code></a></li>
<li><a class="reference internal" href="#container-nic-ipvlan-mode"><code class="docutils literal notranslate"><span class="pre">container_nic_ipvlan_mode</span></code></a></li>
<li><a class="reference internal" href="#resources-system"><code class="docutils literal notranslate"><span class="pre">resources_system</span></code></a></li>
<li><a class="reference internal" href="#images-push-relay"><code class="docutils literal notranslate"><span class="pre">images_push_relay</span></code></a></li>
<li><a class="reference internal" href="#network-dns-search"><code class="docutils literal notranslate"><span class="pre">network_dns_search</span></code></a></li>
<li><a class="reference internal" href="#container-nic-routed-limits"><code class="docutils literal notranslate"><span class="pre">container_nic_routed_limits</span></code></a></li>
<li><a class="reference internal" href="#instance-nic-bridged-vlan"><code class="docutils literal notranslate"><span class="pre">instance_nic_bridged_vlan</span></code></a></li>
<li><a class="reference internal" href="#network-state-bond-bridge"><code class="docutils literal notranslate"><span class="pre">network_state_bond_bridge</span></code></a></li>
<li><a class="reference internal" href="#resources-cpu-isolated"><code class="docutils literal notranslate"><span class="pre">resources_cpu_isolated</span></code></a></li>
<li><a class="reference internal" href="#usedby-consistency"><code class="docutils literal notranslate"><span class="pre">usedby_consistency</span></code></a></li>
<li><a class="reference internal" href="#custom-block-volumes"><code class="docutils literal notranslate"><span class="pre">custom_block_volumes</span></code></a></li>
<li><a class="reference internal" href="#clustering-failure-domains"><code class="docutils literal notranslate"><span class="pre">clustering_failure_domains</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-filtering-allow-deny-syntax"><code class="docutils literal notranslate"><span class="pre">container_syscall_filtering_allow_deny_syntax</span></code></a></li>
<li><a class="reference internal" href="#resources-gpu-mdev"><code class="docutils literal notranslate"><span class="pre">resources_gpu_mdev</span></code></a></li>
<li><a class="reference internal" href="#console-vga-type"><code class="docutils literal notranslate"><span class="pre">console_vga_type</span></code></a></li>
<li><a class="reference internal" href="#projects-limits-disk"><code class="docutils literal notranslate"><span class="pre">projects_limits_disk</span></code></a></li>
<li><a class="reference internal" href="#network-type-macvlan"><code class="docutils literal notranslate"><span class="pre">network_type_macvlan</span></code></a></li>
<li><a class="reference internal" href="#network-type-sriov"><code class="docutils literal notranslate"><span class="pre">network_type_sriov</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-bpf-devices"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_bpf_devices</span></code></a></li>
<li><a class="reference internal" href="#network-type-ovn"><code class="docutils literal notranslate"><span class="pre">network_type_ovn</span></code></a></li>
<li><a class="reference internal" href="#projects-networks"><code class="docutils literal notranslate"><span class="pre">projects_networks</span></code></a></li>
<li><a class="reference internal" href="#projects-networks-restricted-uplinks"><code class="docutils literal notranslate"><span class="pre">projects_networks_restricted_uplinks</span></code></a></li>
<li><a class="reference internal" href="#custom-volume-backup"><code class="docutils literal notranslate"><span class="pre">custom_volume_backup</span></code></a></li>
<li><a class="reference internal" href="#backup-override-name"><code class="docutils literal notranslate"><span class="pre">backup_override_name</span></code></a></li>
<li><a class="reference internal" href="#storage-rsync-compression"><code class="docutils literal notranslate"><span class="pre">storage_rsync_compression</span></code></a></li>
<li><a class="reference internal" href="#network-type-physical"><code class="docutils literal notranslate"><span class="pre">network_type_physical</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-external-subnets"><code class="docutils literal notranslate"><span class="pre">network_ovn_external_subnets</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-nat"><code class="docutils literal notranslate"><span class="pre">network_ovn_nat</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-external-routes-remove"><code class="docutils literal notranslate"><span class="pre">network_ovn_external_routes_remove</span></code></a></li>
<li><a class="reference internal" href="#tpm-device-type"><code class="docutils literal notranslate"><span class="pre">tpm_device_type</span></code></a></li>
<li><a class="reference internal" href="#storage-zfs-clone-copy-rebase"><code class="docutils literal notranslate"><span class="pre">storage_zfs_clone_copy_rebase</span></code></a></li>
<li><a class="reference internal" href="#gpu-mdev"><code class="docutils literal notranslate"><span class="pre">gpu_mdev</span></code></a></li>
<li><a class="reference internal" href="#resources-pci-iommu"><code class="docutils literal notranslate"><span class="pre">resources_pci_iommu</span></code></a></li>
<li><a class="reference internal" href="#resources-network-usb"><code class="docutils literal notranslate"><span class="pre">resources_network_usb</span></code></a></li>
<li><a class="reference internal" href="#resources-disk-address"><code class="docutils literal notranslate"><span class="pre">resources_disk_address</span></code></a></li>
<li><a class="reference internal" href="#network-physical-ovn-ingress-mode"><code class="docutils literal notranslate"><span class="pre">network_physical_ovn_ingress_mode</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-dhcp"><code class="docutils literal notranslate"><span class="pre">network_ovn_dhcp</span></code></a></li>
<li><a class="reference internal" href="#network-physical-routes-anycast"><code class="docutils literal notranslate"><span class="pre">network_physical_routes_anycast</span></code></a></li>
<li><a class="reference internal" href="#projects-limits-instances"><code class="docutils literal notranslate"><span class="pre">projects_limits_instances</span></code></a></li>
<li><a class="reference internal" href="#network-state-vlan"><code class="docutils literal notranslate"><span class="pre">network_state_vlan</span></code></a></li>
<li><a class="reference internal" href="#instance-nic-bridged-port-isolation"><code class="docutils literal notranslate"><span class="pre">instance_nic_bridged_port_isolation</span></code></a></li>
<li><a class="reference internal" href="#instance-bulk-state-change"><code class="docutils literal notranslate"><span class="pre">instance_bulk_state_change</span></code></a></li>
<li><a class="reference internal" href="#network-gvrp"><code class="docutils literal notranslate"><span class="pre">network_gvrp</span></code></a></li>
<li><a class="reference internal" href="#instance-pool-move"><code class="docutils literal notranslate"><span class="pre">instance_pool_move</span></code></a></li>
<li><a class="reference internal" href="#gpu-sriov"><code class="docutils literal notranslate"><span class="pre">gpu_sriov</span></code></a></li>
<li><a class="reference internal" href="#pci-device-type"><code class="docutils literal notranslate"><span class="pre">pci_device_type</span></code></a></li>
<li><a class="reference internal" href="#storage-volume-state"><code class="docutils literal notranslate"><span class="pre">storage_volume_state</span></code></a></li>
<li><a class="reference internal" href="#network-acl"><code class="docutils literal notranslate"><span class="pre">network_acl</span></code></a></li>
<li><a class="reference internal" href="#migration-stateful"><code class="docutils literal notranslate"><span class="pre">migration_stateful</span></code></a></li>
<li><a class="reference internal" href="#disk-state-quota"><code class="docutils literal notranslate"><span class="pre">disk_state_quota</span></code></a></li>
<li><a class="reference internal" href="#storage-ceph-features"><code class="docutils literal notranslate"><span class="pre">storage_ceph_features</span></code></a></li>
<li><a class="reference internal" href="#projects-compression"><code class="docutils literal notranslate"><span class="pre">projects_compression</span></code></a></li>
<li><a class="reference internal" href="#projects-images-remote-cache-expiry"><code class="docutils literal notranslate"><span class="pre">projects_images_remote_cache_expiry</span></code></a></li>
<li><a class="reference internal" href="#certificate-project"><code class="docutils literal notranslate"><span class="pre">certificate_project</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-acl"><code class="docutils literal notranslate"><span class="pre">network_ovn_acl</span></code></a></li>
<li><a class="reference internal" href="#projects-images-auto-update"><code class="docutils literal notranslate"><span class="pre">projects_images_auto_update</span></code></a></li>
<li><a class="reference internal" href="#projects-restricted-cluster-target"><code class="docutils literal notranslate"><span class="pre">projects_restricted_cluster_target</span></code></a></li>
<li><a class="reference internal" href="#images-default-architecture"><code class="docutils literal notranslate"><span class="pre">images_default_architecture</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-acl-defaults"><code class="docutils literal notranslate"><span class="pre">network_ovn_acl_defaults</span></code></a></li>
<li><a class="reference internal" href="#gpu-mig"><code class="docutils literal notranslate"><span class="pre">gpu_mig</span></code></a></li>
<li><a class="reference internal" href="#project-usage"><code class="docutils literal notranslate"><span class="pre">project_usage</span></code></a></li>
<li><a class="reference internal" href="#network-bridge-acl"><code class="docutils literal notranslate"><span class="pre">network_bridge_acl</span></code></a></li>
<li><a class="reference internal" href="#warnings"><code class="docutils literal notranslate"><span class="pre">warnings</span></code></a></li>
<li><a class="reference internal" href="#projects-restricted-backups-and-snapshots"><code class="docutils literal notranslate"><span class="pre">projects_restricted_backups_and_snapshots</span></code></a></li>
<li><a class="reference internal" href="#clustering-join-token"><code class="docutils literal notranslate"><span class="pre">clustering_join_token</span></code></a></li>
<li><a class="reference internal" href="#clustering-description"><code class="docutils literal notranslate"><span class="pre">clustering_description</span></code></a></li>
<li><a class="reference internal" href="#server-trusted-proxy"><code class="docutils literal notranslate"><span class="pre">server_trusted_proxy</span></code></a></li>
<li><a class="reference internal" href="#clustering-update-cert"><code class="docutils literal notranslate"><span class="pre">clustering_update_cert</span></code></a></li>
<li><a class="reference internal" href="#storage-api-project"><code class="docutils literal notranslate"><span class="pre">storage_api_project</span></code></a></li>
<li><a class="reference internal" href="#server-instance-driver-operational"><code class="docutils literal notranslate"><span class="pre">server_instance_driver_operational</span></code></a></li>
<li><a class="reference internal" href="#server-supported-storage-drivers"><code class="docutils literal notranslate"><span class="pre">server_supported_storage_drivers</span></code></a></li>
<li><a class="reference internal" href="#event-lifecycle-requestor-address"><code class="docutils literal notranslate"><span class="pre">event_lifecycle_requestor_address</span></code></a></li>
<li><a class="reference internal" href="#resources-gpu-usb"><code class="docutils literal notranslate"><span class="pre">resources_gpu_usb</span></code></a></li>
<li><a class="reference internal" href="#clustering-evacuation"><code class="docutils literal notranslate"><span class="pre">clustering_evacuation</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-nat-address"><code class="docutils literal notranslate"><span class="pre">network_ovn_nat_address</span></code></a></li>
<li><a class="reference internal" href="#network-bgp"><code class="docutils literal notranslate"><span class="pre">network_bgp</span></code></a></li>
<li><a class="reference internal" href="#network-forward"><code class="docutils literal notranslate"><span class="pre">network_forward</span></code></a></li>
<li><a class="reference internal" href="#custom-volume-refresh"><code class="docutils literal notranslate"><span class="pre">custom_volume_refresh</span></code></a></li>
<li><a class="reference internal" href="#network-counters-errors-dropped"><code class="docutils literal notranslate"><span class="pre">network_counters_errors_dropped</span></code></a></li>
<li><a class="reference internal" href="#metrics"><code class="docutils literal notranslate"><span class="pre">metrics</span></code></a></li>
<li><a class="reference internal" href="#image-source-project"><code class="docutils literal notranslate"><span class="pre">image_source_project</span></code></a></li>
<li><a class="reference internal" href="#clustering-config"><code class="docutils literal notranslate"><span class="pre">clustering_config</span></code></a></li>
<li><a class="reference internal" href="#network-peer"><code class="docutils literal notranslate"><span class="pre">network_peer</span></code></a></li>
<li><a class="reference internal" href="#linux-sysctl"><code class="docutils literal notranslate"><span class="pre">linux_sysctl</span></code></a></li>
<li><a class="reference internal" href="#network-dns"><code class="docutils literal notranslate"><span class="pre">network_dns</span></code></a></li>
<li><a class="reference internal" href="#ovn-nic-acceleration"><code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration</span></code></a></li>
<li><a class="reference internal" href="#certificate-self-renewal"><code class="docutils literal notranslate"><span class="pre">certificate_self_renewal</span></code></a></li>
<li><a class="reference internal" href="#instance-project-move"><code class="docutils literal notranslate"><span class="pre">instance_project_move</span></code></a></li>
<li><a class="reference internal" href="#storage-volume-project-move"><code class="docutils literal notranslate"><span class="pre">storage_volume_project_move</span></code></a></li>
<li><a class="reference internal" href="#cloud-init"><code class="docutils literal notranslate"><span class="pre">cloud_init</span></code></a></li>
<li><a class="reference internal" href="#network-dns-nat"><code class="docutils literal notranslate"><span class="pre">network_dns_nat</span></code></a></li>
<li><a class="reference internal" href="#database-leader"><code class="docutils literal notranslate"><span class="pre">database_leader</span></code></a></li>
<li><a class="reference internal" href="#instance-all-projects"><code class="docutils literal notranslate"><span class="pre">instance_all_projects</span></code></a></li>
<li><a class="reference internal" href="#clustering-groups"><code class="docutils literal notranslate"><span class="pre">clustering_groups</span></code></a></li>
<li><a class="reference internal" href="#ceph-rbd-du"><code class="docutils literal notranslate"><span class="pre">ceph_rbd_du</span></code></a></li>
<li><a class="reference internal" href="#instance-get-full"><code class="docutils literal notranslate"><span class="pre">instance_get_full</span></code></a></li>
<li><a class="reference internal" href="#qemu-metrics"><code class="docutils literal notranslate"><span class="pre">qemu_metrics</span></code></a></li>
<li><a class="reference internal" href="#gpu-mig-uuid"><code class="docutils literal notranslate"><span class="pre">gpu_mig_uuid</span></code></a></li>
<li><a class="reference internal" href="#event-project"><code class="docutils literal notranslate"><span class="pre">event_project</span></code></a></li>
<li><a class="reference internal" href="#clustering-evacuation-live"><code class="docutils literal notranslate"><span class="pre">clustering_evacuation_live</span></code></a></li>
<li><a class="reference internal" href="#instance-allow-inconsistent-copy"><code class="docutils literal notranslate"><span class="pre">instance_allow_inconsistent_copy</span></code></a></li>
<li><a class="reference internal" href="#network-state-ovn"><code class="docutils literal notranslate"><span class="pre">network_state_ovn</span></code></a></li>
<li><a class="reference internal" href="#storage-volume-api-filtering"><code class="docutils literal notranslate"><span class="pre">storage_volume_api_filtering</span></code></a></li>
<li><a class="reference internal" href="#image-restrictions"><code class="docutils literal notranslate"><span class="pre">image_restrictions</span></code></a></li>
<li><a class="reference internal" href="#storage-zfs-export"><code class="docutils literal notranslate"><span class="pre">storage_zfs_export</span></code></a></li>
<li><a class="reference internal" href="#network-dns-records"><code class="docutils literal notranslate"><span class="pre">network_dns_records</span></code></a></li>
<li><a class="reference internal" href="#storage-zfs-reserve-space"><code class="docutils literal notranslate"><span class="pre">storage_zfs_reserve_space</span></code></a></li>
<li><a class="reference internal" href="#network-acl-log"><code class="docutils literal notranslate"><span class="pre">network_acl_log</span></code></a></li>
<li><a class="reference internal" href="#storage-zfs-blocksize"><code class="docutils literal notranslate"><span class="pre">storage_zfs_blocksize</span></code></a></li>
<li><a class="reference internal" href="#metrics-cpu-seconds"><code class="docutils literal notranslate"><span class="pre">metrics_cpu_seconds</span></code></a></li>
<li><a class="reference internal" href="#instance-snapshot-never"><code class="docutils literal notranslate"><span class="pre">instance_snapshot_never</span></code></a></li>
<li><a class="reference internal" href="#certificate-token"><code class="docutils literal notranslate"><span class="pre">certificate_token</span></code></a></li>
<li><a class="reference internal" href="#instance-nic-routed-neighbor-probe"><code class="docutils literal notranslate"><span class="pre">instance_nic_routed_neighbor_probe</span></code></a></li>
<li><a class="reference internal" href="#event-hub"><code class="docutils literal notranslate"><span class="pre">event_hub</span></code></a></li>
<li><a class="reference internal" href="#agent-nic-config"><code class="docutils literal notranslate"><span class="pre">agent_nic_config</span></code></a></li>
<li><a class="reference internal" href="#projects-restricted-intercept"><code class="docutils literal notranslate"><span class="pre">projects_restricted_intercept</span></code></a></li>
<li><a class="reference internal" href="#metrics-authentication"><code class="docutils literal notranslate"><span class="pre">metrics_authentication</span></code></a></li>
<li><a class="reference internal" href="#images-target-project"><code class="docutils literal notranslate"><span class="pre">images_target_project</span></code></a></li>
<li><a class="reference internal" href="#cluster-migration-inconsistent-copy"><code class="docutils literal notranslate"><span class="pre">cluster_migration_inconsistent_copy</span></code></a></li>
<li><a class="reference internal" href="#cluster-ovn-chassis"><code class="docutils literal notranslate"><span class="pre">cluster_ovn_chassis</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-sched-setscheduler"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_sched_setscheduler</span></code></a></li>
<li><a class="reference internal" href="#storage-lvm-thinpool-metadata-size"><code class="docutils literal notranslate"><span class="pre">storage_lvm_thinpool_metadata_size</span></code></a></li>
<li><a class="reference internal" href="#storage-volume-state-total"><code class="docutils literal notranslate"><span class="pre">storage_volume_state_total</span></code></a></li>
<li><a class="reference internal" href="#instance-file-head"><code class="docutils literal notranslate"><span class="pre">instance_file_head</span></code></a></li>
<li><a class="reference internal" href="#instances-nic-host-name"><code class="docutils literal notranslate"><span class="pre">instances_nic_host_name</span></code></a></li>
<li><a class="reference internal" href="#image-copy-profile"><code class="docutils literal notranslate"><span class="pre">image_copy_profile</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-sysinfo"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_sysinfo</span></code></a></li>
<li><a class="reference internal" href="#clustering-evacuation-mode"><code class="docutils literal notranslate"><span class="pre">clustering_evacuation_mode</span></code></a></li>
<li><a class="reference internal" href="#resources-pci-vpd"><code class="docutils literal notranslate"><span class="pre">resources_pci_vpd</span></code></a></li>
<li><a class="reference internal" href="#qemu-raw-conf"><code class="docutils literal notranslate"><span class="pre">qemu_raw_conf</span></code></a></li>
<li><a class="reference internal" href="#storage-cephfs-fscache"><code class="docutils literal notranslate"><span class="pre">storage_cephfs_fscache</span></code></a></li>
<li><a class="reference internal" href="#network-load-balancer"><code class="docutils literal notranslate"><span class="pre">network_load_balancer</span></code></a></li>
<li><a class="reference internal" href="#vsock-api"><code class="docutils literal notranslate"><span class="pre">vsock_api</span></code></a></li>
<li><a class="reference internal" href="#instance-ready-state"><code class="docutils literal notranslate"><span class="pre">instance_ready_state</span></code></a></li>
<li><a class="reference internal" href="#network-bgp-holdtime"><code class="docutils literal notranslate"><span class="pre">network_bgp_holdtime</span></code></a></li>
<li><a class="reference internal" href="#storage-volumes-all-projects"><code class="docutils literal notranslate"><span class="pre">storage_volumes_all_projects</span></code></a></li>
<li><a class="reference internal" href="#metrics-memory-oom-total"><code class="docutils literal notranslate"><span class="pre">metrics_memory_oom_total</span></code></a></li>
<li><a class="reference internal" href="#storage-buckets"><code class="docutils literal notranslate"><span class="pre">storage_buckets</span></code></a></li>
<li><a class="reference internal" href="#storage-buckets-create-credentials"><code class="docutils literal notranslate"><span class="pre">storage_buckets_create_credentials</span></code></a></li>
<li><a class="reference internal" href="#metrics-cpu-effective-total"><code class="docutils literal notranslate"><span class="pre">metrics_cpu_effective_total</span></code></a></li>
<li><a class="reference internal" href="#projects-networks-restricted-access"><code class="docutils literal notranslate"><span class="pre">projects_networks_restricted_access</span></code></a></li>
<li><a class="reference internal" href="#storage-buckets-local"><code class="docutils literal notranslate"><span class="pre">storage_buckets_local</span></code></a></li>
<li><a class="reference internal" href="#loki"><code class="docutils literal notranslate"><span class="pre">loki</span></code></a></li>
<li><a class="reference internal" href="#acme"><code class="docutils literal notranslate"><span class="pre">acme</span></code></a></li>
<li><a class="reference internal" href="#internal-metrics"><code class="docutils literal notranslate"><span class="pre">internal_metrics</span></code></a></li>
<li><a class="reference internal" href="#cluster-join-token-expiry"><code class="docutils literal notranslate"><span class="pre">cluster_join_token_expiry</span></code></a></li>
<li><a class="reference internal" href="#remote-token-expiry"><code class="docutils literal notranslate"><span class="pre">remote_token_expiry</span></code></a></li>
<li><a class="reference internal" href="#storage-volumes-created-at"><code class="docutils literal notranslate"><span class="pre">storage_volumes_created_at</span></code></a></li>
<li><a class="reference internal" href="#cpu-hotplug"><code class="docutils literal notranslate"><span class="pre">cpu_hotplug</span></code></a></li>
<li><a class="reference internal" href="#projects-networks-zones"><code class="docutils literal notranslate"><span class="pre">projects_networks_zones</span></code></a></li>
<li><a class="reference internal" href="#instance-nic-txqueuelength"><code class="docutils literal notranslate"><span class="pre">instance_nic_txqueuelength</span></code></a></li>
<li><a class="reference internal" href="#cluster-member-state"><code class="docutils literal notranslate"><span class="pre">cluster_member_state</span></code></a></li>
<li><a class="reference internal" href="#storage-pool-source-wipe"><code class="docutils literal notranslate"><span class="pre">storage_pool_source_wipe</span></code></a></li>
<li><a class="reference internal" href="#zfs-block-mode"><code class="docutils literal notranslate"><span class="pre">zfs_block_mode</span></code></a></li>
<li><a class="reference internal" href="#instance-generation-id"><code class="docutils literal notranslate"><span class="pre">instance_generation_id</span></code></a></li>
<li><a class="reference internal" href="#disk-io-cache"><code class="docutils literal notranslate"><span class="pre">disk_io_cache</span></code></a></li>
<li><a class="reference internal" href="#amd-sev"><code class="docutils literal notranslate"><span class="pre">amd_sev</span></code></a></li>
<li><a class="reference internal" href="#storage-pool-loop-resize"><code class="docutils literal notranslate"><span class="pre">storage_pool_loop_resize</span></code></a></li>
<li><a class="reference internal" href="#migration-vm-live"><code class="docutils literal notranslate"><span class="pre">migration_vm_live</span></code></a></li>
<li><a class="reference internal" href="#ovn-nic-nesting"><code class="docutils literal notranslate"><span class="pre">ovn_nic_nesting</span></code></a></li>
<li><a class="reference internal" href="#oidc"><code class="docutils literal notranslate"><span class="pre">oidc</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-l3only"><code class="docutils literal notranslate"><span class="pre">network_ovn_l3only</span></code></a></li>
<li><a class="reference internal" href="#ovn-nic-acceleration-vdpa"><code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration_vdpa</span></code></a></li>
<li><a class="reference internal" href="#cluster-healing"><code class="docutils literal notranslate"><span class="pre">cluster_healing</span></code></a></li>
<li><a class="reference internal" href="#instances-state-total"><code class="docutils literal notranslate"><span class="pre">instances_state_total</span></code></a></li>
<li><a class="reference internal" href="#auth-user"><code class="docutils literal notranslate"><span class="pre">auth_user</span></code></a></li>
<li><a class="reference internal" href="#security-csm"><code class="docutils literal notranslate"><span class="pre">security_csm</span></code></a></li>
<li><a class="reference internal" href="#instances-rebuild"><code class="docutils literal notranslate"><span class="pre">instances_rebuild</span></code></a></li>
<li><a class="reference internal" href="#numa-cpu-placement"><code class="docutils literal notranslate"><span class="pre">numa_cpu_placement</span></code></a></li>
<li><a class="reference internal" href="#custom-volume-iso"><code class="docutils literal notranslate"><span class="pre">custom_volume_iso</span></code></a></li>
<li><a class="reference internal" href="#network-allocations"><code class="docutils literal notranslate"><span class="pre">network_allocations</span></code></a></li>
<li><a class="reference internal" href="#storage-api-remote-volume-snapshot-copy"><code class="docutils literal notranslate"><span class="pre">storage_api_remote_volume_snapshot_copy</span></code></a></li>
<li><a class="reference internal" href="#zfs-delegate"><code class="docutils literal notranslate"><span class="pre">zfs_delegate</span></code></a></li>
<li><a class="reference internal" href="#operations-get-query-all-projects"><code class="docutils literal notranslate"><span class="pre">operations_get_query_all_projects</span></code></a></li>
<li><a class="reference internal" href="#metadata-configuration"><code class="docutils literal notranslate"><span class="pre">metadata_configuration</span></code></a></li>
<li><a class="reference internal" href="#syslog-socket"><code class="docutils literal notranslate"><span class="pre">syslog_socket</span></code></a></li>
<li><a class="reference internal" href="#event-lifecycle-name-and-project"><code class="docutils literal notranslate"><span class="pre">event_lifecycle_name_and_project</span></code></a></li>
<li><a class="reference internal" href="#instances-nic-limits-priority"><code class="docutils literal notranslate"><span class="pre">instances_nic_limits_priority</span></code></a></li>
<li><a class="reference internal" href="#disk-initial-volume-configuration"><code class="docutils literal notranslate"><span class="pre">disk_initial_volume_configuration</span></code></a></li>
<li><a class="reference internal" href="#operation-wait"><code class="docutils literal notranslate"><span class="pre">operation_wait</span></code></a></li>
<li><a class="reference internal" href="#cluster-internal-custom-volume-copy"><code class="docutils literal notranslate"><span class="pre">cluster_internal_custom_volume_copy</span></code></a></li>
<li><a class="reference internal" href="#disk-io-bus"><code class="docutils literal notranslate"><span class="pre">disk_io_bus</span></code></a></li>
<li><a class="reference internal" href="#storage-cephfs-create-missing"><code class="docutils literal notranslate"><span class="pre">storage_cephfs_create_missing</span></code></a></li>
<li><a class="reference internal" href="#instance-move-config"><code class="docutils literal notranslate"><span class="pre">instance_move_config</span></code></a></li>
<li><a class="reference internal" href="#ovn-ssl-config"><code class="docutils literal notranslate"><span class="pre">ovn_ssl_config</span></code></a></li>
<li><a class="reference internal" href="#init-preseed-storage-volumes"><code class="docutils literal notranslate"><span class="pre">init_preseed_storage_volumes</span></code></a></li>
<li><a class="reference internal" href="#metrics-instances-count"><code class="docutils literal notranslate"><span class="pre">metrics_instances_count</span></code></a></li>
<li><a class="reference internal" href="#server-instance-type-info"><code class="docutils literal notranslate"><span class="pre">server_instance_type_info</span></code></a></li>
<li><a class="reference internal" href="#resources-disk-mounted"><code class="docutils literal notranslate"><span class="pre">resources_disk_mounted</span></code></a></li>
<li><a class="reference internal" href="#server-version-lts"><code class="docutils literal notranslate"><span class="pre">server_version_lts</span></code></a></li>
<li><a class="reference internal" href="#oidc-groups-claim"><code class="docutils literal notranslate"><span class="pre">oidc_groups_claim</span></code></a></li>
<li><a class="reference internal" href="#loki-config-instance"><code class="docutils literal notranslate"><span class="pre">loki_config_instance</span></code></a></li>
<li><a class="reference internal" href="#storage-volatile-uuid"><code class="docutils literal notranslate"><span class="pre">storage_volatile_uuid</span></code></a></li>
<li><a class="reference internal" href="#import-instance-devices"><code class="docutils literal notranslate"><span class="pre">import_instance_devices</span></code></a></li>
<li><a class="reference internal" href="#instances-uefi-vars"><code class="docutils literal notranslate"><span class="pre">instances_uefi_vars</span></code></a></li>
<li><a class="reference internal" href="#instances-migration-stateful"><code class="docutils literal notranslate"><span class="pre">instances_migration_stateful</span></code></a></li>
<li><a class="reference internal" href="#access-management"><code class="docutils literal notranslate"><span class="pre">access_management</span></code></a></li>
<li><a class="reference internal" href="#vm-disk-io-limits"><code class="docutils literal notranslate"><span class="pre">vm_disk_io_limits</span></code></a></li>
<li><a class="reference internal" href="#storage-volumes-all"><code class="docutils literal notranslate"><span class="pre">storage_volumes_all</span></code></a></li>
<li><a class="reference internal" href="#instances-files-modify-permissions"><code class="docutils literal notranslate"><span class="pre">instances_files_modify_permissions</span></code></a></li>
<li><a class="reference internal" href="#image-restriction-nesting"><code class="docutils literal notranslate"><span class="pre">image_restriction_nesting</span></code></a></li>
<li><a class="reference internal" href="#container-syscall-intercept-finit-module"><code class="docutils literal notranslate"><span class="pre">container_syscall_intercept_finit_module</span></code></a></li>
<li><a class="reference internal" href="#device-usb-serial"><code class="docutils literal notranslate"><span class="pre">device_usb_serial</span></code></a></li>
<li><a class="reference internal" href="#network-allocate-external-ips"><code class="docutils literal notranslate"><span class="pre">network_allocate_external_ips</span></code></a></li>
<li><a class="reference internal" href="#explicit-trust-token"><code class="docutils literal notranslate"><span class="pre">explicit_trust_token</span></code></a></li>
<li><a class="reference internal" href="#shared-custom-block-volumes"><code class="docutils literal notranslate"><span class="pre">shared_custom_block_volumes</span></code></a></li>
<li><a class="reference internal" href="#instance-import-conversion"><code class="docutils literal notranslate"><span class="pre">instance_import_conversion</span></code></a></li>
<li><a class="reference internal" href="#instance-create-start"><code class="docutils literal notranslate"><span class="pre">instance_create_start</span></code></a></li>
<li><a class="reference internal" href="#instance-protection-start"><code class="docutils literal notranslate"><span class="pre">instance_protection_start</span></code></a></li>
<li><a class="reference internal" href="#devlxd-images-vm"><code class="docutils literal notranslate"><span class="pre">devlxd_images_vm</span></code></a></li>
<li><a class="reference internal" href="#disk-io-bus-virtio-blk"><code class="docutils literal notranslate"><span class="pre">disk_io_bus_virtio_blk</span></code></a></li>
<li><a class="reference internal" href="#metrics-api-requests"><code class="docutils literal notranslate"><span class="pre">metrics_api_requests</span></code></a></li>
<li><a class="reference internal" href="#projects-limits-disk-pool"><code class="docutils literal notranslate"><span class="pre">projects_limits_disk_pool</span></code></a></li>
<li><a class="reference internal" href="#ubuntu-pro-guest-attach"><code class="docutils literal notranslate"><span class="pre">ubuntu_pro_guest_attach</span></code></a></li>
<li><a class="reference internal" href="#metadata-configuration-entity-types"><code class="docutils literal notranslate"><span class="pre">metadata_configuration_entity_types</span></code></a></li>
<li><a class="reference internal" href="#access-management-tls"><code class="docutils literal notranslate"><span class="pre">access_management_tls</span></code></a></li>
<li><a class="reference internal" href="#network-allocations-ovn-uplink"><code class="docutils literal notranslate"><span class="pre">network_allocations_ovn_uplink</span></code></a></li>
<li><a class="reference internal" href="#network-ovn-uplink-vlan"><code class="docutils literal notranslate"><span class="pre">network_ovn_uplink_vlan</span></code></a></li>
<li><a class="reference internal" href="#state-logical-cpus"><code class="docutils literal notranslate"><span class="pre">state_logical_cpus</span></code></a></li>
<li><a class="reference internal" href="#vm-limits-cpu-pin-strategy"><code class="docutils literal notranslate"><span class="pre">vm_limits_cpu_pin_strategy</span></code></a></li>
<li><a class="reference internal" href="#gpu-cdi"><code class="docutils literal notranslate"><span class="pre">gpu_cdi</span></code></a></li>
<li><a class="reference internal" href="#images-all-projects"><code class="docutils literal notranslate"><span class="pre">images_all_projects</span></code></a></li>
<li><a class="reference internal" href="#metadata-configuration-scope"><code class="docutils literal notranslate"><span class="pre">metadata_configuration_scope</span></code></a></li>
<li><a class="reference internal" href="#unix-device-hotplug-ownership-inherit"><code class="docutils literal notranslate"><span class="pre">unix_device_hotplug_ownership_inherit</span></code></a></li>
<li><a class="reference internal" href="#unix-device-hotplug-subsystem-device-option"><code class="docutils literal notranslate"><span class="pre">unix_device_hotplug_subsystem_device_option</span></code></a></li>
<li><a class="reference internal" href="#storage-ceph-osd-pool-size"><code class="docutils literal notranslate"><span class="pre">storage_ceph_osd_pool_size</span></code></a></li>
<li><a class="reference internal" href="#network-get-target"><code class="docutils literal notranslate"><span class="pre">network_get_target</span></code></a></li>
<li><a class="reference internal" href="#network-zones-all-projects"><code class="docutils literal notranslate"><span class="pre">network_zones_all_projects</span></code></a></li>
<li><a class="reference internal" href="#vm-root-volume-attachment"><code class="docutils literal notranslate"><span class="pre">vm_root_volume_attachment</span></code></a></li>
<li><a class="reference internal" href="#projects-limits-uplink-ips"><code class="docutils literal notranslate"><span class="pre">projects_limits_uplink_ips</span></code></a></li>
<li><a class="reference internal" href="#entities-with-entitlements"><code class="docutils literal notranslate"><span class="pre">entities_with_entitlements</span></code></a></li>
<li><a class="reference internal" href="#profiles-all-projects"><code class="docutils literal notranslate"><span class="pre">profiles_all_projects</span></code></a></li>
<li><a class="reference internal" href="#storage-driver-powerflex"><code class="docutils literal notranslate"><span class="pre">storage_driver_powerflex</span></code></a></li>
<li><a class="reference internal" href="#storage-driver-pure"><code class="docutils literal notranslate"><span class="pre">storage_driver_pure</span></code></a></li>
<li><a class="reference internal" href="#cloud-init-ssh-keys"><code class="docutils literal notranslate"><span class="pre">cloud_init_ssh_keys</span></code></a></li>
<li><a class="reference internal" href="#oidc-scopes"><code class="docutils literal notranslate"><span class="pre">oidc_scopes</span></code></a></li>
<li><a class="reference internal" href="#project-default-network-and-storage"><code class="docutils literal notranslate"><span class="pre">project_default_network_and_storage</span></code></a></li>
<li><a class="reference internal" href="#client-cert-presence"><code class="docutils literal notranslate"><span class="pre">client_cert_presence</span></code></a></li>
<li><a class="reference internal" href="#clustering-groups-used-by"><code class="docutils literal notranslate"><span class="pre">clustering_groups_used_by</span></code></a></li>
<li><a class="reference internal" href="#container-bpf-delegation"><code class="docutils literal notranslate"><span class="pre">container_bpf_delegation</span></code></a></li>
<li><a class="reference internal" href="#override-snapshot-profiles-on-copy"><code class="docutils literal notranslate"><span class="pre">override_snapshot_profiles_on_copy</span></code></a></li>
<li><a class="reference internal" href="#resources-device-fs-uuid"><code class="docutils literal notranslate"><span class="pre">resources_device_fs_uuid</span></code></a></li>
<li><a class="reference internal" href="#backup-metadata-version"><code class="docutils literal notranslate"><span class="pre">backup_metadata_version</span></code></a></li>
<li><a class="reference internal" href="#storage-buckets-all-projects"><code class="docutils literal notranslate"><span class="pre">storage_buckets_all_projects</span></code></a></li>
<li><a class="reference internal" href="#network-acls-all-projects"><code class="docutils literal notranslate"><span class="pre">network_acls_all_projects</span></code></a></li>
<li><a class="reference internal" href="#networks-all-projects"><code class="docutils literal notranslate"><span class="pre">networks_all_projects</span></code></a></li>
<li><a class="reference internal" href="#clustering-restore-skip-mode"><code class="docutils literal notranslate"><span class="pre">clustering_restore_skip_mode</span></code></a></li>
<li><a class="reference internal" href="#disk-io-threads-virtiofsd"><code class="docutils literal notranslate"><span class="pre">disk_io_threads_virtiofsd</span></code></a></li>
<li><a class="reference internal" href="#oidc-client-secret"><code class="docutils literal notranslate"><span class="pre">oidc_client_secret</span></code></a></li>
<li><a class="reference internal" href="#pci-hotplug"><code class="docutils literal notranslate"><span class="pre">pci_hotplug</span></code></a></li>
<li><a class="reference internal" href="#device-patch-removal"><code class="docutils literal notranslate"><span class="pre">device_patch_removal</span></code></a></li>
<li><a class="reference internal" href="#daemon-storage-per-project"><code class="docutils literal notranslate"><span class="pre">daemon_storage_per_project</span></code></a></li>
<li><a class="reference internal" href="#ovn-internal-load-balancer"><code class="docutils literal notranslate"><span class="pre">ovn_internal_load_balancer</span></code></a></li>
<li><a class="reference internal" href="#auth-bearer-devlxd"><code class="docutils literal notranslate"><span class="pre">auth_bearer_devlxd</span></code></a></li>
<li><a class="reference internal" href="#devlxd-volume-management"><code class="docutils literal notranslate"><span class="pre">devlxd_volume_management</span></code></a></li>
<li><a class="reference internal" href="#storage-driver-alletra"><code class="docutils literal notranslate"><span class="pre">storage_driver_alletra</span></code></a></li>
<li><a class="reference internal" href="#resources-disk-used-by"><code class="docutils literal notranslate"><span class="pre">resources_disk_used_by</span></code></a></li>
<li><a class="reference internal" href="#ovn-dhcp-ranges"><code class="docutils literal notranslate"><span class="pre">ovn_dhcp_ranges</span></code></a></li>
<li><a class="reference internal" href="#operation-requestor"><code class="docutils literal notranslate"><span class="pre">operation_requestor</span></code></a></li>
<li><a class="reference internal" href="#import-custom-volume-tar"><code class="docutils literal notranslate"><span class="pre">import_custom_volume_tar</span></code></a></li>
<li><a class="reference internal" href="#projects-force-delete"><code class="docutils literal notranslate"><span class="pre">projects_force_delete</span></code></a></li>
<li><a class="reference internal" href="#auth-oidc-sessions"><code class="docutils literal notranslate"><span class="pre">auth_oidc_sessions</span></code></a></li>
<li><a class="reference internal" href="#instance-snapshots-multi-volume"><code class="docutils literal notranslate"><span class="pre">instance_snapshots_multi_volume</span></code></a></li>
<li><a class="reference internal" href="#vm-persistent-bus"><code class="docutils literal notranslate"><span class="pre">vm_persistent_bus</span></code></a></li>
<li><a class="reference internal" href="#instance-placement-groups"><code class="docutils literal notranslate"><span class="pre">instance_placement_groups</span></code></a></li>
<li><a class="reference internal" href="#ovn-nic-acceleration-parent"><code class="docutils literal notranslate"><span class="pre">ovn_nic_acceleration_parent</span></code></a></li>
<li><a class="reference internal" href="#storage-and-profile-operations"><code class="docutils literal notranslate"><span class="pre">storage_and_profile_operations</span></code></a></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=46bd48cc"></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 src="../_static/js/bundle.js?v=a4d88309"></script>
<script>
const github_url = "https://github.com/canonical/lxd";
</script>
</body>
</html>