Back to Multipass

Settings

docs/reference/settings/index.md

2018.12.12.3 KB
Original Source

(reference-settings-index)=

Settings

See also: Settings keys and values, get, set, GUI client

Multipass can be configured with a number of settings that are read and written by the get and set CLI commands, respectively. Some settings are also available in the GUI client.

<!-- Moved explanation of settings keys and values to a separate page, and added link to "See also" above -->

Available settings

At any given time, the available settings depend on the state of the system. Some settings are only available on some platforms, while daemon settings can only be accessed when the Multipass daemon itself can be reached.

Some instance properties are also exposed as settings.

See also: {ref}set-the-cpu-ram-or-disk-of-an-instance

The command multipass get --keys shows what settings are available at any given time.

As of now, this is the total set of settings available:

{caution}
Starting from Multipass version 1.14, the following settings have been removed from the CLI and are only available in the [GUI client](/reference/gui-client):
- [`client.gui.autostart`](client-gui-autostart)
- [`client.gui.hotkey`](client-gui-hotkey)
<!-- keeping the documentation pages for now, since not everyone will update their Multipass package immediately -->
{toctree}
:hidden:
:titlesonly:
:maxdepth: 2
:glob:

*