block-device¶
add-tag¶
Add a tag to block device on a given machine.
maas $PROFILE block-device add-tag [--help] [-d] [-k] system_id id [data ...]
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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. |
Keywords¶
Keyword “tag”¶
Optional String. The tag being added.
Note: This command accepts JSON.
delete¶
Delete block device on a given machine.
maas $PROFILE block-device delete [--help] [-d] [-k] system_id id
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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¶
Format block device with filesystem.
maas $PROFILE block-device format [--help] [-d] [-k] system_id id [data ...]
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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. |
Keywords¶
Keyword “fstype”¶
Optional String. Type of filesystem.
Keyword “uuid”¶
Optional String. UUID of the filesystem.
Note: This command accepts JSON.
mount¶
Mount the filesystem on block device.
maas $PROFILE block-device mount [--help] [-d] [-k] system_id id [data ...]
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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. |
Keywords¶
Keyword “mount_point”¶
Optional String. Path on the filesystem to mount.
Keyword “mount_options”¶
Optional String. Options to pass to mount(8).
Note: This command accepts JSON.
read¶
Read a block device on a given machine.
maas $PROFILE block-device read [--help] [-d] [-k] system_id id
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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-tag¶
Remove a tag from block device on a given machine.
maas $PROFILE block-device remove-tag [--help] [-d] [-k] system_id id [data ...]
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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. |
Keywords¶
Keyword “tag”¶
Optional String. The tag being removed.
Note: This command accepts JSON.
set-boot-disk¶
Set a block device as the boot disk for the machine.
maas $PROFILE block-device set-boot-disk [--help] [-d] [-k] system_id id
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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¶
Unformat a previously formatted block device.
maas $PROFILE block-device unformat [--help] [-d] [-k] system_id id
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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¶
Unmount the filesystem on block device.
maas $PROFILE block-device unmount [--help] [-d] [-k] system_id id
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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¶
Update block device on a given machine. Machines must have a status of Ready to have access to all options. Machines with Deployed status can only have the name, model, serial, and/or id_path updated for a block device. This is intended to allow a bad block device to be replaced while the machine remains deployed.
maas $PROFILE block-device update [--help] [-d] [-k] system_id id [data ...]
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
id |
The ID of the resource (e.g., |
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. |
Keywords¶
Keyword “name”¶
Optional String. (Virtual devices) Name of the block device.
Keyword “model”¶
Optional String. (Physical devices) Model of the block device.
Keyword “serial”¶
Optional String. (Physical devices) Serial number of the block device.
Keyword “id_path”¶
Optional String. (Physical devices) Only used if model and serial cannot be provided. This should be a path that is fixed and doesn’t change depending on the boot order or kernel version.
Keyword “size”¶
Optional String. (Virtual devices) Size of the block device. (Only allowed for logical volumes.)
Keyword “block_size”¶
Optional String. (Physical devices) Block size of the block device.
Keyword “uuid”¶
Optional String. (Virtual devices) UUID of the block device.
Note: This command accepts JSON.
block-devices create¶
Create a physical block device.
maas $PROFILE block-devices create [--help] [-d] [-k] system_id [data ...]
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
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. |
Keywords¶
Keyword “name”¶
Optional String. Name of the block device.
Keyword “model”¶
Optional String. Model of the block device.
Keyword “serial”¶
Optional String. Serial number of the block device.
Keyword “id_path”¶
Optional String. Only used if model and serial cannot be provided. This should be a path that is fixed and doesn’t change depending on the boot order or kernel version.
Keyword “size”¶
Optional String. Size of the block device.
Keyword “block_size”¶
Optional String. Block size of the block device.
Note: This command accepts JSON.
block-devices read¶
List all block devices belonging to a machine.
maas $PROFILE block-devices read [--help] [-d] [-k] system_id
Positional arguments¶
Argument |
Effect |
|---|---|
system_id |
The system ID of the machine/device (e.g., |
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. |