List all Multipass instances with their current state and IP addresses.

Find available Multipass images for launching new instances.

Launch a new Multipass instance.

Args: name: Optional name for the instance. image: Image to use (e.g., '22.04', 'charm-dev', 'docker'). Defaults to latest Ubuntu LTS. cpus: Number of CPUs to allocate. memory: Amount of memory (e.g., '2G', '512M'). disk: Disk space (e.g., '10G', '40G').

Start a stopped Multipass instance.

Stop a running Multipass instance.

Restart Multipass instances.

Args: name: Name of the instance to restart. If omitted and all_instances is False, 'primary' is assumed. all_instances: If True, restart all instances.

Suspend a running Multipass instance, saving its state to disk.

Resume a suspended Multipass instance.

Delete a Multipass instance.

Args: name: Name of the instance to delete. purge: If True, immediately purge the instance (cannot be recovered).

Purge all deleted Multipass instances to free up disk space.

Execute a shell command inside a Multipass instance.

Args: name: Name of the instance. command: The command to run (e.g., 'ls -la', 'uname -a').

Get detailed information about a Multipass instance (CPU, Memory, Disk usage).

Get detailed information about a Multipass snapshot.

Args: instance: Name of the instance. snapshot: Name of the snapshot.

Get Multipass version information for the client and daemon.

List host network interfaces available for use with Multipass instances.

Get Multipass configuration settings.

Args: key: The configuration key to retrieve (e.g., 'local.driver'). If omitted, lists all available keys.

Set a Multipass configuration setting.

Args: key: The configuration key to set (e.g., 'local.driver'). value: The value to set for the key.

Clone an existing Multipass instance.

Args: source: The name of the source Multipass instance to be cloned. name: An optional custom name for the cloned instance.

Mount a local directory inside a Multipass instance.

Args: source: Path of the local directory to mount. instance: Name of the Multipass instance. target: Optional target mount point inside the instance. uid_map: Optional list of UID mappings (host:instance). gid_map: Optional list of GID mappings (host:instance). mount_type: Type of mount ('classic' or 'native').

Unmount a directory from a Multipass instance.

Args: instance: Name of the Multipass instance. path: Optional specific mount point to unmount. If omitted, all mounts are removed.

Transfer files/directories between the host and Multipass instances.

Args: source: Source path (prefix with 'name:' for Multipass instance paths). destination: Destination path (prefix with 'name:' for Multipass instance paths). recursive: Recursively copy entire directories. parents: Make parent directories as needed.

Take a snapshot of a stopped Multipass instance.

Args: instance: The name of the Multipass instance. name: Optional name for the snapshot. comment: Optional comment for the snapshot.

Restore a Multipass instance to a previously taken snapshot.

Args: instance: The name of the Multipass instance. snapshot: The name of the snapshot to restore. destructive: If True, discard the current state of the instance.

List all available Multipass snapshots.

Recover deleted Multipass instances.

Args: name: Name of the Multipass instance to recover. all_instances: If True, recover all deleted instances.

Create a Multipass alias to be executed on a given Multipass instance.

Args: instance: Name of the Multipass instance. command: Command to execute. alias_name: Optional name for the alias. Defaults to command name. map_working_directory: If True, automatically map host execution path to mounted path.

List available Multipass aliases.

Remove Multipass aliases.

Args: alias_names: Optional list of Multipass alias names to remove. all_aliases: If True, remove all aliases from current context.

Switch the current Multipass alias context.

Args: context_name: Name of the Multipass alias context to switch to.

Authenticate with the Multipass service.

Args: passphrase: Passphrase provided by a system administrator.