---
title: partition
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/partition?format=md
---

*Submit*

# partition

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

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

```
maas $PROFILE partitions create [--help] [-d] [-k] system_id device_id [data ...]
```

#### Positional arguments

* system\_id
* device\_id

Create a partition on a block device.

#### Keyword “size”

Optional Int. The size of the partition in bytes. If not specified, all available space will be used.

#### Keyword “uuid”

Optional String. UUID for the partition. Only used if the partition table type for the block device is GPT.

#### Keyword “bootable”

Optional Boolean. If the partition should be marked bootable.

#### 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 partitions](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-list-partitions)

```
maas $PROFILE partitions read [--help] [-d] [-k] system_id device_id [data ...]
```

#### Positional arguments

* system\_id
* device\_id

List partitions on a device with the given system\_id and device\_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 |

## [Format a partition](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-format-a-partition)

```
maas $PROFILE partition format [--help] [-d] [-k] system_id device_id id [data ...]
```

#### Positional arguments

* system\_id
* device\_id
* id

Format the partition on machine system\_id and device device\_id with the given partition id.

#### Keyword “fstype”

Required String. Type of filesystem.

#### Keyword “uuid”

Optional String. The UUID for the filesystem.

#### Keyword “label”

Optional String. The label for the filesystem.

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

## [Mount a filesystem](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-mount-a-filesystem)

```
maas $PROFILE partition mount [--help] [-d] [-k] system_id device_id id [data ...]
```

#### Positional arguments

* system\_id
* device\_id
* id

Mount a filesystem on machine system\_id, device device\_id and partition id.

#### Keyword “mount\_point”

Required String. Path on the filesystem to mount.

#### Keyword “mount\_options”

Optional String. Options to pass to mount(8).

#### 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 partition](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-read-a-partition)

```
maas $PROFILE partition read [--help] [-d] [-k] system_id device_id id [data ...]
```

#### Positional arguments

* system\_id
* device\_id
* id

Read the partition from machine system\_id and device device\_id with the given partition 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 |

## [Remove a tag](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-remove-a-tag)

```
maas $PROFILE partition remove-tag [--help] [-d] [-k] system_id device_id id [data ...]
```

#### Positional arguments

* system\_id
* device\_id
* id

Remove a tag from a partition on machine system\_id, device device\_id and partition id.

#### Keyword “tag”

Required String. The tag being 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 |
|  |  |

## [Unformat a partition](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-unformat-a-partition)

```
maas $PROFILE partition unformat [--help] [-d] [-k] system_id device_id id [data ...]
```

#### Positional arguments

* system\_id
* device\_id
* id

Unformat the partition on machine system\_id and device device\_id with the given partition 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 |

## [Unmount a filesystem](https://canonical-com-2934.demos.haus/maas/docs/partition?format=md#p-23247-unmount-a-filesystem)

```
maas $PROFILE partition unmount [--help] [-d] [-k] system_id device_id id [data ...]
```

#### Positional arguments

* system\_id
* device\_id
* id

Unmount a filesystem on machine system\_id, device device\_id and partition 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

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

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

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