Multipass settings

Errors or typos? Topics missing? Hard to read? Let us know or open an issue on GitHub.

See also: 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.

Settings are organized in a tree structure, where each individual setting is identified by a unique key and takes on a single value at any given time.

Settings keys

A settings key is a string in the form of a dot-separated path through the settings tree (such as client.primary-name). It specifies a path along the settings tree, from the root to a leaf. Thus, individual settings correspond to the leaves of the settings tree.

Conceptually, branches of the tree can be singled out with wildcards, to refer to multiple settings at once. For instance, local.<instance-name>.* designates the settings that affect a specific instance. Wildcards can also be used to select separate branches. For example local.*.cpus refers to the number of CPUs of Multipass instances.

Settings values

A settings value is a string whose syntax (allowed values/representations) and semantics (their interpretation) is determined by the setting in question.

Values often express common concepts (such as true, false, 42, etc.) and are interpreted internally using the corresponding data types (such as boolean, integer, etc.). They can also be more complex (such as a key combination), but they are always specified and displayed through a string representation (for example: Ctrl+Alt+U).

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: 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:

Starting from Multipass version 1.14, the following settings have been removed from the CLI and are only available in the GUI client:

Last updated 3 days ago. Help improve this document in the forum.