`multipass suspend` command

Multipass Documentation
,
1

The multipass suspend command without any argument will suspend the primary instance (and fail, if it doesn’t exist). You can also pass one or more instance names or the --all option to suspend more instances at the same time.

Only instances in Running status can be suspended.

For example:

multipass stop boisterous-tortoise
multipass suspend boisterous-tortoise

If check your instances with multipass list, you’ll see that its status is now set to Suspended:

Name                    State             IPv4             Image
boisterous-tortoise     Suspended         --               Ubuntu 22.04 LTS

Suspended instances can be resumed with the multipass start command.

The full multipass help suspend output explains the available options:

Usage: multipass suspend [options] [<name> ...]
Suspend the named instances, if running. Exits with
return code 0 if successful.

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.
  --all          Suspend all instances

Arguments:
  name           Names of instances to suspend. If omitted, and without the
                 --all option, 'primary' will be assumed.

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

2

it would be great to mention how to resume a stopped instance, as there is no resume command.

3

Good point @dirkjot, thanks for the suggestion. Suspended instances can be resumed with the start command.

We should say this systematically for all commands that change the state of an instance. And we need to add a little to the documentation of this command in particular. I am adding tasks for us to do that later on.

1 Like