---
title: vm-cluster
description: Canonical makes open source secure, reliable and easy to use, providing
  support for Ubuntu and a portfolio of enterprise-grade technologies. Founded in
  2004, Canonical operates globally with team members in over 80 countries.
url: https://canonical-com-2950.demos.haus/maas/docs/vm-cluster?format=md
---

*Submit*

# vm-cluster

Enter keyword arguments in the form `key=value`.

## [Deletes a VM cluster](https://canonical-com-2950.demos.haus/maas/docs/vm-cluster?format=md#p-23217-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’.](https://canonical-com-2950.demos.haus/maas/docs/vm-cluster?format=md#p-23217-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](https://canonical-com-2950.demos.haus/maas/docs/vm-cluster?format=md#p-23217-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 |

---

[Previous

vlan](https://canonical-com-2950.demos.haus/maas/docs/vlan)
[Next

vmfs-datastores](https://canonical-com-2950.demos.haus/maas/docs/vmfs-datastores)

Last updated 1 year, 4 months ago. [Help improve this document in the forum](https://discourse.maas.io/t/vm-cluster/11340).