Skip to main content

Your submission was sent successfully! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates from Canonical and upcoming events where you can meet our team.Close

Thank you for contacting us. A member of our team will be in touch shortly. Close

An error occurred while submitting your form. Please try again or file a bug report. Close

vm-cluster

Enter keyword arguments in the form key=value.

Deletes a VM cluster

maas $PROFILE vm-cluster delete [--help] [-d] [-k] id [data ...] 

Positional arguments

  • id

Deletes a VM cluster with the given ID.

Keyword “decompose”

Optional Boolean. Whether to also decompose all machines in the VM cluster on removal. If not provided, machines will not be removed.

Command-line options

Option Effect
–help, -h Show this help message and exit
-d, --debug Display more information about API responses
-k, --insecure Disable SSL certificate check

This operation has been deprecated in favor of ‘Virtual-machine-host read’.

maas $PROFILE vm-cluster read [--help] [-d] [-k] id [data ...] 

Positional arguments

  • id

Command-line options

Option Effect
–help, -h Show this help message and exit
-d, --debug Display more information about API responses
-k, --insecure Disable SSL certificate check

Update a VM cluster

maas $PROFILE vm-cluster update [--help] [-d] [-k] id [data ...] 

Positional arguments

  • id

Update a specific VM cluster by ID.

Keyword “name”

Optional String. The VM cluster’s name.

Keyword “pool”

Optional String. The name of the resource pool associated with this VM Cluster – this change is propagated to VM hosts

Keyword “zone”

Optional String. The VM cluster’s zone.

Command-line options

Option Effect
–help, -h Show this help message and exit
-d, --debug Display more information about API responses
-k, --insecure Disable SSL certificate check

Last updated a month ago. Help improve this document in the forum.