---
title: volume-group
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-2934.demos.haus/maas/docs/volume-group?format=md
---

*Submit*

# volume-group

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

## [Create a logical volume](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-create-a-logical-volume)

```
maas $PROFILE volume-group create-logical-volume [--help] [-d] [-k] system_id id
```

Create a logical volume

#### Positional arguments

* system\_id
* id

Create a logical volume in the volume group with the given id on the machine with the given system\_id.

#### Keyword “name”

Required String. Name of the logical volume.

#### Keyword “uuid”

Optional String. (optional) UUID of the logical volume.

#### Keyword “size”

Optional String. (optional) Size of the logical volume. Must be larger than or equal to 4,194,304 bytes. E.g. `4194304`. Will default to free space in the volume group if not given.

#### 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 |

## [Delete volume group](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-delete-volume-group)

```
maas $PROFILE volume-group delete [--help] [-d] [-k] system_id id [data ...]
```

#### Positional arguments

* system\_id
* id

Delete a volume group with the given id from the machine with the given system\_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 |

## [Delete a logical volume](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-delete-a-logical-volume)

```
maas $PROFILE volume-group delete-logical-volume [--help] [-d] [-k] system_id id
```

Delete a logical volume

#### Positional arguments

* system\_id
* id

Delete a logical volume in the volume group with the given id on the machine with the given system\_id.

Note: this operation returns HTTP status code 204 even if the logical volume id does not exist.

#### Keyword “id”

Required Int. The logical volume 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 |

## [Read a volume group](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-read-a-volume-group)

```
maas $PROFILE volume-group read [--help] [-d] [-k] system_id id [data ...]
```

#### Positional arguments

* system\_id
* id

Read a volume group with the given id on the machine with the given system\_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 volume group](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-update-a-volume-group)

```
maas $PROFILE volume-group update [--help] [-d] [-k] system_id id [data ...]
```

#### Positional arguments

* system\_id
* id

Update a volume group with the given id on the machine with the given system\_id.

#### Keyword “name”

Optional String. Name of the volume group.

#### Keyword “uuid”

Optional String. UUID of the volume group.

#### Keyword “add\_block\_devices”

Optional String. Block devices to add to the volume group.

#### Keyword “remove\_block\_devices”

Optional String. Block devices to remove from the volume group.

#### Keyword “add\_partitions”

Optional String. Partitions to add to the volume group.

#### Keyword “remove\_partitions”

Optional String. Partitions to remove from the volume group.

#### 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 |

## [Create a volume group](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-create-a-volume-group)

```
maas $PROFILE volume-groups create [--help] [-d] [-k] system_id [data ...]
```

#### Positional arguments

* system\_id

Create a volume group belonging to a machine with the given system\_id.

Note that at least one valid block device or partition is required.

#### Keyword “name”

Required String. Name of the volume group.

#### Keyword “uuid”

Optional String. (optional) UUID of the volume group.

#### Keyword “block\_devices”

Optional String. Block devices to add to the volume group.

#### Keyword “partitions”

Optional String. Partitions to add to the volume group.

#### 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 |

## [List all volume groups](https://canonical-com-2934.demos.haus/maas/docs/volume-group?format=md#p-23216-list-all-volume-groups)

```
maas $PROFILE volume-groups read [--help] [-d] [-k] system_id [data ...]
```

#### Positional arguments

* system\_id

List all volume groups belonging to a machine with the given system\_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 |

---

[Previous

vm-host](https://canonical-com-2934.demos.haus/maas/docs/vm-host)
[Next

zone](https://canonical-com-2934.demos.haus/maas/docs/zone)

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