`multipass get` command

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

See also: set, Settings

The multipass get command retrieves the value of a single setting specified by a “key” argument. This key takes the form of a dot-separated path in a hierarchical settings tree:

$ multipass get client.gui.autostart
true

In order to get a list of all available keys, the --keys option can be used:

$ multipass get --keys
client.primary-name
local.bridged-network
local.driver
local.image.mirror
local.passphrase
local.privileged-mounts

To set the value of a particular setting, see set.

You can read more about the available settings in the Settings reference page.


The full multipass help get output explains the available options:

$ multipass help get
Usage: multipass get [options] [<arg>]
Get the configuration setting corresponding to the given key, or all settings if no key is specified.
(Support for multiple keys and wildcards coming...)

Some common settings keys are:
  - client.gui.autostart
  - local.driver
  - local.privileged-mounts

Use `multipass get --keys` to obtain the full list of available settings at any given time.

Options:
  -h, --help     Displays help on commandline options
  -v, --verbose  Increase logging verbosity. Repeat the 'v' in the short option
                 for more detail. Maximum verbosity is obtained with 4 (or more)
                 v's, i.e. -vvvv.
  --raw          Output in raw format. For now, this affects only the
                 representation of empty values (i.e. "" instead of "<empty>").
  --keys         List available settings keys. This outputs the whole list of
                 currently available settings keys, or just <arg>, if provided
                 and a valid key.

Arguments:
  arg            Setting key, i.e. path to the intended setting.

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