`multipass set` command

Set

The multipass set command takes an argument in the form <key>=<value> to configure a single setting. The “key” part is a dot-separated path identifying the setting in a hierarchical settings tree. The “value” part is what it should be set to:

$ multipass set client.gui.autostart=false

The following keys are currently available:

• client.apps.windows-terminal.profiles (Windows only) [Since version 1.3.0]
  • A string describing what profiles Multipass should enable in Windows Terminal (when installed)
  • Allowed values (for the time being):
    • primary to enable a profile for the primary instance. Note that this value is independent of what primary name is configured.
    • none to disable any profiles.
  • Default: primary (a profile for primary is added when Windows Terminal is found)
• client.gui.autostart
  • A boolean that identifies whether or not the Multipass GUI should automatically launch on startup.
  • Allowed values: any case variations of on|off, yes|no, 1|0, and true|false.
  • Default: true (on Linux and macOS it only takes effect after the client (CLI or GUI) is run a first time).
• client.primary-name
  • The name of the instance that is launched/recognized as primary.
  • Allowed values: any valid instance name (see launch).
  • Default: primary.
• local.driver
  • A string identifying the hypervisor back-end in use.
  • Allowed values:
    • qemu and libvirt on Linux.
    • hyperv and virtualbox on Windows.
    • hyperkit and virtualbox on macOS.
  • Default:
    • qemu on Linux.
    • hyperv on Windows.
    • hyperkit on macOS.

To find what the configured value is at any moment, see get.

multipass help set output explains the available options:

$ multipass help set
Usage: multipass set [options] <key>=<value>
Set, to the given value, the configuration setting corresponding to the given key.

Keys:
  client.gui.autostart
  client.primary-name
  local.driver

Options:
  -h, --help     Display this help
  -v, --verbose  Increase logging verbosity, repeat up to three times for more
                 detail

Arguments:
  keyval         A key-value pair. The key specifies a path to the setting to
                 configure. The value is its intended value.

Last updated 21 days ago.