`multipass set` command

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)
    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.gui.hotkey [Since version 1.4.0]
    A keyboard shortcut for the GUI to open a shell into the primary instance.

    Allowed values:

    • A single case-insensitive sequence of keys, containing:
      • zero or more modifiers (e.g. Ctrl, Alt, Cmd, Command, Opt, etc.)
      • one non-modifier key (e.g. u, 4, ., Space, Tab, Pause, F3). When key names have multiple words, quote and use spaces (e.g. "Print Screen").
      • [On macOS] alternatively, utf-8 characters for the mac keys (e.g. ⌘, ⌥, ⇧, ⌃)
      • A plus (+) sign separating each alphabetic word (but not key symbols) from the next
    • The empty string (""), to disable the hotkey.
      Examples:
      • multipass set client.gui.hotkey="Ctrl+Print Screen".
      • multipass set client.gui.hotkey="⌃⇧Y".
      • multipass set client.gui.hotkey=option+space.
      • multipass set client.gui.hotkey=""

    Caveats:

    • There are some limitations on what keys and combinations are supported, depending on multiple factors such as keyboard, mapping, and OS (e.g. AltGr, numpad, or media keys may or may not work; shift+enter is rejected).
    • Some combinations may be grabbed by the OS before they reach multipass (e.g. meta+a may open the Applications, ctrl+alt+f3 may move ttys).

    Default:

    • Ctrl+Alt+U on Linux and Windows
    • ⌥⌘U on macOS

  • 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, libvirt, and lxd on Linux.
    • hyperv and virtualbox on Windows.
    • hyperkit and virtualbox on macOS.
      Default:
    • qemu on Linux.
    • hyperv on Windows.
    • hyperkit on macOS.

  • local.bridged-interface (Since 1.7.0)
    The name of the interface used when launch --bridged is issued.

    Allowed value: any name from multipass networks. Note validation is deferred to multipass launch.

  • local.privileged-mounts (Since 1.7.0)
    Controls whether multipass mount is allowed. Because mounts are performed as privileged users (root on Linux and macOS, SYSTEM on Windows), they allow write access to the whole host operating system. On Linux and macOS, only privileged users (members of sudo, wheel, admin groups) can use Multipass, so this isn’t a concern.

    On Windows mounts are disabled by default, as anyone with TCP access to localhost (127.0.0.1) can use Multipass, and by extension, gets access to the whole file system.

    Allowed values: any case variations of on|off, yes|no, 1|0, and true|false.

    Default:

    • true on Linux and macOS
    • false on Windows

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.gui.hotkey
  client.primary-name
  local.bridged-interface
  local.driver
  local.privileged-mounts

Options:
  -h, --help     Display this help
  -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.

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

Last updated 5 months ago.

Help improve this document in the forum.