CINXE.COM

<!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="Multipass" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://documentation.ubuntu.com/multipass" /> <meta property="og:site_name" content="Multipass" /> <meta property="og:description" content="Multipass is a tool to generate cloud-style Ubuntu VMs quickly on Linux, macOS and Windows. It provides a simple but powerful CLI that enables you to quickly access an Ubuntu command line or create..." /> <meta property="og:image" content="https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg" /> <meta property="og:image:alt" content="Multipass" /> <meta name="description" content="Multipass is a tool to generate cloud-style Ubuntu VMs quickly on Linux, macOS and Windows. It provides a simple but powerful CLI that enables you to quickly access an Ubuntu command line or create..." /> <meta property="article:modified_time" content="2025-02-20T16:33:33+00:00" /><link rel="index" title="Index" href="genindex/" /><link rel="search" title="Search" href="search/" /><link rel="next" title="Tutorial" href="tutorial/" /> <link rel="shortcut icon" href="_static/favicon.png"/> <title>Multipass documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" /> <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/contributors.css" /> <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> <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=302659d7" /> <link rel="stylesheet" type="text/css" href="_static/css/pdf.css?v=44005b5e" /> <link rel="stylesheet" type="text/css" href="_static/custom.css?v=202ba174" /> <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=9c678fc2" /> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="canonical-multipass" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> <body> <header id="header" class="p-navigation"> <div class="p-navigation__nav" role="menubar"> <ul class="p-navigation__links" role="menu"> <li> <a class="p-logo" href="https://canonical.com/multipass" aria-current="page"> <img src="_static/tag.png" alt="Logo" class="p-logo-image"> <div class="p-logo-text p-heading--4">Multipass </div> </a> </li> <li class="nav-ubuntu-com"> <a href="https://canonical.com/multipass" class="p-navigation__link">canonical.com/multipass</a> </li> <li> <a href="#" class="p-navigation__link nav-more-links">More resources</a> <ul class="more-links-dropdown"> <li> <a href="https://discourse.ubuntu.com/c/project/multipass/21" class="p-navigation__sub-link p-dropdown__link">Discourse</a> </li> <li> <a href="https://app.element.io/#/room/#Multipass:matrix.org" class="p-navigation__sub-link p-dropdown__link">Matrix</a> </li> <li> <a href="https://github.com/canonical/multipass" 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"> <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> <label class="overlay sidebar-overlay" for="__navigation"> <div class="visually-hidden">Hide navigation sidebar</div> </label> <label class="overlay toc-overlay" for="__toc"> <div class="visually-hidden">Hide table of contents sidebar</div> </label> <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> <div class="page"> <header class="mobile-header"> <div class="header-left"> <label class="nav-overlay-icon" for="__navigation"> <div class="visually-hidden">Toggle site navigation sidebar</div> <i class="icon"><svg><use href="#svg-menu"></use></svg></i> </label> </div> <div class="header-center"> <a href="#"><div class="brand">Multipass documentation</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> </header> <aside class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky"><a class="sidebar-brand" href="#"> <span class="sidebar-brand-text">Multipass documentation</span> </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 current current-page"><a class="current reference internal" href="#">Home</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial/">Tutorial</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="how-to-guides/">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of How-to guides</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="how-to-guides/install-multipass/">Install Multipass</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="how-to-guides/manage-instances/">Manage instances</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Manage instances</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/create-an-instance/">Create an instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/modify-an-instance/">Modify an instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/use-an-instance/">Use an instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/use-the-primary-instance/">Use the primary instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/use-instance-command-aliases/">Use instance command aliases</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/share-data-with-an-instance/">Share data with an instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/remove-an-instance/">Remove an instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/add-a-network-to-an-existing-instance/">Add a network to an existing instance</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/configure-static-ips/">Configure static IPs</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/use-a-blueprint/">Use a blueprint</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/use-the-docker-blueprint/">Use the Docker blueprint</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/manage-instances/run-a-docker-container-in-multipass/">Run a Docker container in Multipass</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="how-to-guides/customise-multipass/">Customise Multipass</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Customise Multipass</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/set-up-the-driver/">How to set up the driver</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/migrate-from-hyperkit-to-qemu-on-macos/">Migrate from Hyperkit to QEMU on macOS</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/authenticate-clients-with-the-multipass-service/">Authenticate clients with the Multipass service</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/build-multipass-images-with-packer/">Build Multipass images with Packer</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/set-up-a-graphical-interface/">Set up a graphical interface</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/use-a-different-terminal-from-the-system-icon/">Use a different terminal from the system icon</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/integrate-with-windows-terminal/">How to integrate with Windows Terminal</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/configure-where-multipass-stores-external-data/">Configure where Multipass stores external data</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/customise-multipass/configure-multipass-default-logging-level/">Configure Multipass鈥檚 default logging level</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="how-to-guides/troubleshoot/">Troubleshoot</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Troubleshoot</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/troubleshoot/access-logs/">Access logs</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/troubleshoot/mount-an-encrypted-home-folder/">Mount an encrypted home folder</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/troubleshoot/troubleshoot-launch-start-issues/">Troubleshoot launch/start issues</a></li> <li class="toctree-l3"><a class="reference internal" href="how-to-guides/troubleshoot/troubleshoot-networking/">Troubleshoot networking</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="reference/">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2 has-children"><a class="reference internal" href="reference/command-line-interface/">Command-line interface</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Command-line interface</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/alias/">alias</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/aliases/">aliases</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/authenticate/">authenticate</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/clone/">clone</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/delete/">delete</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/exec/">exec</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/find/">find</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/get/">get</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/help/">help</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/info/">info</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/launch/">launch</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/list/">list</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/mount/">mount</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/networks/">networks</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/prefer/">prefer</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/purge/">purge</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/recover/">recover</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/restart/">restart</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/restore/">restore</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/set/">set</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/shell/">shell</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/snapshot/">snapshot</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/start/">start</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/stop/">stop</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/suspend/">suspend</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/transfer/">transfer</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/umount/">umount</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/unalias/">unalias</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/command-line-interface/version/">version</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="reference/gui-client/">GUI client</a></li> <li class="toctree-l2"><a class="reference internal" href="reference/instance-name-format/">Instance name format</a></li> <li class="toctree-l2"><a class="reference internal" href="reference/instance-states/">Instance states</a></li> <li class="toctree-l2"><a class="reference internal" href="reference/logging-levels/">Logging levels</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="reference/settings/">Settings</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of Settings</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="reference/settings/client-apps-windows-terminal-profiles/">client.apps.windows-terminal.profiles</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/client-gui-autostart/">client.gui.autostart</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/client-gui-hotkey/">client.gui.hotkey</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/client-primary-name/">client.primary-name</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-bridged-network/">local.bridged-network</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-driver/">local.driver</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-instance-name-bridged/">local.<instance-name>.bridged</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-instance-name-cpus/">local.<instance-name>.cpus</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-instance-name-disk/">local.<instance-name>.disk</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-instance-name-memory/">local.<instance-name>.memory</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-instance-name-snapshot-name-comment/">local.<instance-name>.<snapshot-name>.comment</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-instance-name-snapshot-name-name/">local.<instance-name>.<snapshot-name>.name</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-passphrase/">local.passphrase</a></li> <li class="toctree-l3"><a class="reference internal" href="reference/settings/local-privileged-mounts/">local.privileged-mounts</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="explanation/">Explanation</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Explanation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="explanation/about-performance/">About performance</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/about-security/">About security</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/alias/">Alias</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/authentication/">Authentication</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/blueprint/">Blueprint</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/driver/">Driver</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/host/">Host</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/id-mapping/">ID mapping</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/image/">Image</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/instance/">Instance</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/mount/">Mount</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/multipass-exec-and-shells/">Multipass <code class="docutils literal notranslate"><span class="pre">exec</span></code> and shells</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/platform/">Platform</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/service/">Service</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/settings-keys-values/">Settings keys and values</a></li> <li class="toctree-l2"><a class="reference internal" href="explanation/snapshot/">Snapshot</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="contribute-to-multipass-docs/">Contribute to Multipass docs</a></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="edit-this-page"> <a class="muted-link" href="" title="Contribute to this page"> <svg><use href="#svg-pencil"></use></svg> <span class="visually-hidden">Contribute to this page</span> </a> </div><div class="theme-toggle-container theme-toggle-content"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> <article role="main" id="furo-main-content"> <section id="multipass"> <span id="index"></span><h1>Multipass<a class="headerlink" href="#multipass" title="Link to this heading">露</a></h1>  <p>Multipass is a tool to generate cloud-style Ubuntu VMs quickly on Linux, macOS and Windows. It provides a simple but powerful CLI that enables you to quickly access an Ubuntu command line or create your own local mini-cloud.</p> <p>Local development and testing can be challenging, but Multipass simplifies these processes by automating setup and teardown. Multipass has a growing library of images that you can use to launch purpose-built VMs or custom VMs you鈥檝e configured yourself through its powerful <code class="docutils literal notranslate"><span class="pre">cloud-init</span></code> interface.</p> <p>Developers can use Multipass to prototype cloud deployments and to create fresh, customised Linux dev environments on any machine. Multipass is the quickest way for Mac and Windows users to get an Ubuntu command line on their systems. You can also use it as a sandbox to try new things without affecting your host machine or requiring a dual boot.</p> <hr class="docutils" /> <section id="in-this-documentation"> <h2>In this documentation<a class="headerlink" href="#in-this-documentation" title="Link to this heading">露</a></h2> <div class="table-wrapper colwidths-auto docutils container"> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head"><p></p></th> <th class="head"><p></p></th> </tr> </thead> <tbody> <tr class="row-even"><td><p><a class="reference internal" href="tutorial/"><span class="doc std std-doc">Tutorial</span></a></br> Get started - a hands-on introduction to Multipass for new users </br></p></td> <td><p><a class="reference internal" href="how-to-guides/"><span class="doc std std-doc">How-to guides</span></a> </br> Step-by-step guides covering key operations and common tasks</p></td> </tr> <tr class="row-odd"><td><p><a class="reference internal" href="explanation/"><span class="doc std std-doc">Explanation</span></a> </br> Concepts - discussion and clarification of key topics</p></td> <td><p><a class="reference internal" href="reference/"><span class="doc std std-doc">Reference</span></a> </br> Technical information - specifications, APIs, architecture</p></td> </tr> </tbody> </table> </div> </section> <hr class="docutils" /> <section id="project-and-community"> <h2>Project and community<a class="headerlink" href="#project-and-community" title="Link to this heading">露</a></h2> <p>We value your input and contributions! Here are some ways you can join our community or get help with your Multipass questions:</p> <ul class="simple"> <li><p>Read our <a class="reference external" href="https://ubuntu.com/community/code-of-conduct">Code of Conduct</a></p></li> <li><p>Read our quick guide: <a class="reference internal" href="contribute-to-multipass-docs/"><span class="doc std std-doc">Contribute to Multipass docs</span></a></p></li> <li><p>Join the <a class="reference external" href="https://discourse.ubuntu.com/c/project/multipass/21/">Discourse forum</a></p></li> <li><p>Report an issue or contribute to the code on <a class="reference external" href="https://github.com/canonical/multipass/issues">GitHub</a></p></li> </ul> <div class="toctree-wrapper compound"> </div> </section> </section> </article> </div> <footer> <div class="related-pages"> </div> <div class="bottom-of-page"> <div class="left-details"> <div class="copyright"> Copyright © 2025 CC-BY-SA, Canonical Ltd. </div> <div class="last-updated"> Last updated on Feb 20, 2025</div> </div> <div> </div> <div class="right-details"> </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="#">Multipass</a><ul> <li><a class="reference internal" href="#in-this-documentation">In this documentation</a></li> <li><a class="reference internal" href="#project-and-community">Project and community</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=a5603611"></script> <script src="_static/doctools.js?v=9a2dae69"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/scripts/furo.js?v=5fa4622c"></script> <script src="_static/contributors.js"></script> <script src="_static/clipboard.min.js?v=a7894cd8"></script> <script src="_static/copybutton.js?v=f281be69"></script> <script src="_static/design-tabs.js?v=f930bc37"></script> <script src="_static/header-nav.js?v=e117ad08"></script> <script src="_static/github_issue_links.js?v=32bb732f"></script> <script> const github_url = "https://github.com/canonical/multipass"; </script> </body> </html>