Skip to content

Storage pool commands

sbcli-pre storage-pool --help

Aliases: pool

Storage pool commands

Adds a new storage pool

Adds a new storage pool

sbcli-pre storage-pool add
    <NAME>
    <CLUSTER_ID>
    --pool-max=<POOL_MAX>
    --lvol-max=<LVOL_MAX>
    --max-rw-iops=<MAX_RW_IOPS>
    --max-rw-mbytes=<MAX_RW_MBYTES>
    --max-r-mbytes=<MAX_R_MBYTES>
    --max-w-mbytes=<MAX_W_MBYTES>
Argument Description Data Type Required
NAME New pool name string True
CLUSTER_ID Cluster id string True
Parameter Description Data Type Required Default
--pool-max Pool maximum size: 20M, 20G, 0. Default: 0 string False 0
--lvol-max Logical volume maximum size: 20M, 20G, 0. Default: 0 string False 0
--max-rw-iops Maximum Read Write IO Per Second integer False -
--max-rw-mbytes Maximum Read Write Megabytes Per Second integer False -
--max-r-mbytes Maximum Read Megabytes Per Second integer False -
--max-w-mbytes Maximum Write Megabytes Per Second integer False -

Sets a storage pool's attributes

Sets a storage pool's attributes

sbcli-pre storage-pool set
    <POOL_ID>
    --pool-max=<POOL_MAX>
    --lvol-max=<LVOL_MAX>
    --max-rw-iops=<MAX_RW_IOPS>
    --max-rw-mbytes=<MAX_RW_MBYTES>
    --max-r-mbytes=<MAX_R_MBYTES>
    --max-w-mbytes=<MAX_W_MBYTES>
Argument Description Data Type Required
POOL_ID Pool id string True
Parameter Description Data Type Required Default
--pool-max Pool maximum size: 20M, 20G string False -
--lvol-max Logical volume maximum size: 20M, 20G string False -
--max-rw-iops Maximum Read Write IO Per Second integer False -
--max-rw-mbytes Maximum Read Write Megabytes Per Second integer False -
--max-r-mbytes Maximum Read Megabytes Per Second integer False -
--max-w-mbytes Maximum Write Megabytes Per Second integer False -

Lists all storage pools

Lists all storage pools

sbcli-pre storage-pool list
    --json
    --cluster-id=<CLUSTER_ID>
Parameter Description Data Type Required Default
--json Print outputs in json format marker False -
--cluster-id Cluster id string False -

Gets a storage pool's details

Gets a storage pool's details

sbcli-pre storage-pool get
    <POOL_ID>
    --json
Argument Description Data Type Required
POOL_ID Pool id string True
Parameter Description Data Type Required Default
--json Print outputs in json format marker False -

Deletes a storage pool

It is only possible to delete a pool if it is empty (no provisioned logical volumes contained).

sbcli-pre storage-pool delete
    <POOL_ID>
Argument Description Data Type Required
POOL_ID Pool id string True

Set a storage pool's status to Active

Set a storage pool's status to Active

sbcli-pre storage-pool enable
    <POOL_ID>
Argument Description Data Type Required
POOL_ID Pool id string True

Sets a storage pool's status to Inactive.

Sets a storage pool's status to Inactive.

sbcli-pre storage-pool disable
    <POOL_ID>
Argument Description Data Type Required
POOL_ID Pool id string True

Gets a storage pool's capacity

Gets a storage pool's capacity

sbcli-pre storage-pool get-capacity
    <POOL_ID>
Argument Description Data Type Required
POOL_ID Pool id string True

Gets a storage pool's I/O statistics

Gets a storage pool's I/O statistics

sbcli-pre storage-pool get-io-stats
    <POOL_ID>
    --history=<HISTORY>
    --records=<RECORDS>
Argument Description Data Type Required
POOL_ID Pool id string True
Parameter Description Data Type Required Default
--history (XXdYYh), list history records (one for every 15 minutes) for XX days and YY hours (up to 10 days in total). string False -
--records Number of records, default: 20 integer False 20