Disk Management (CLI)

Introduction

The CloudBD CLI can create, list, and destroy CloudBD disks on configured storage remotes.

If you are using CloudBD on AWS we recommend managing your CloudBD disks directly from CloudFormation templates. See the AWS S3 CloudFormation Setup Guide for more info.

CloudBD CLI Commands

Create

• Create a new CloudBD disk on a configured storage remote

  cloudbd create <remote>:<disk> <size>
  

  • <remote>   Name of a configured storage remote.
  • <disk>   Name of the new disk to create on <remote>. Allowed disk name pattern ([A-Za-z0-9_-]{1,48}).
  • <size>   Size of the new disk. IEC Unit suffix letters are supported (k, M, G, T, P). For example, using the value "1T" for size would result in a 1 terabyte (2^40 bytes) capacity disk being created. Allowed disk sizes (8GiB <= SIZE <= 2PiB)

  To attach a new disk to a server, add the disk to the server's cbdtab and start the disk with the cbddisks_start command (see Attach/Detach Disks for more info).

  CloudBD disks created manually (using the CLI instead of AWS CloudFormation) MUST also be deleted using the CloudBD CLI. Removing the CloudBD disk objects from your object storage buckets/containers outside of the CLI can result in an orphaned disk state. Disks in the oprhaned state will continue to incur CloudBD usage charges. If this situation arises please contact CloudBD support ASAP so that we can correct your CloudBD account.

Destroy

• Destroy a CloudBD disk and remove all disk objects from the storage remote

  cloudbd destroy <remote>:<disk>
  

  • <remote>   Name of a configured storage remote.
  • <disk>   Name of a disk on <remote> to destroy.

Destroying a CloudBD disk is a non-reversible action and will delete all of that disk's data from your storage remote. Before destroying a CloudBD disk, make sure the disk is stopped and unconfigured from your server's cbdtab file (see Attach/Detach Disks for more info).

List

• List all configured storage remotes

  cloudbd list
  

• List all disks on a storage remote

  cloudbd list <remote>
  

  • <remote>   Name of a configured storage remote.

Info

• Show the details of a configured storage remote

  cloudbd info <remote>
  

  • <remote>   Name of a configured storage remote.

• Show the device details of a CloudBD disk

  cloudbd info <remote>:<disk>
  

  • <remote>   Name of a configured storage remote.
  • <disk>   Name of a disk on <remote>.