Logical Volume Commands
sbctl volume --help
Aliases: lvol
Logical Volume Commands
Adds a new logical volume.
Adds a new logical volume.
sbctl volume add
<NAME>
<SIZE>
<POOL>
--snapshot
--max-size=<MAX_SIZE>
--host-id=<HOST_ID>
--encrypt
--crypto-key1=<CRYPTO_KEY1>
--crypto-key2=<CRYPTO_KEY2>
--max-rw-iops=<MAX_RW_IOPS>
--max-rw-mbytes=<MAX_RW_MBYTES>
--max-r-mbytes=<MAX_R_MBYTES>
--max-w-mbytes=<MAX_W_MBYTES>
--max-namespace-per-subsys=<MAX_NAMESPACE_PER_SUBSYS>
--ha-type=<HA_TYPE>
--fabric=<FABRIC>
--lvol-priority-class=<LVOL_PRIORITY_CLASS>
--namespace=<NAMESPACE>
--pvc-name=<PVC_NAME>
--data-chunks-per-stripe=<DATA_CHUNKS_PER_STRIPE>
--parity-chunks-per-stripe=<PARITY_CHUNKS_PER_STRIPE>
--replicate
| Argument | Description | Data Type | Required |
|---|---|---|---|
| NAME | The new logical volume name. | string | True |
| SIZE | Logical volume size: 10M, 10G, 10(bytes). | size | True |
| POOL | The storage pool id or name. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --snapshot, -s | Make logical volume with snapshot capability. Default: false. |
marker | False | False |
| --max-size | The logical volume max size. Default: 1000T. |
size | False | 1000T |
| --host-id | The primary storage node id or hostname. | string | False | - |
| --encrypt | Use inline data encryption and decryption on the logical volume. | marker | False | - |
| --crypto-key1 | The hex value of key1 to be used for logical volume encryption. | string | False | - |
| --crypto-key2 | The hex value of key2 to be used for logical volume encryption. | 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 | - |
| --max-namespace-per-subsys | The maximum Namespace per subsystem. Default: 32. |
integer | False | 32 |
| --ha-type | Logical volume HA type (single, ha), default is cluster HA type. Default: default.Available Options: - single - default - ha |
string | False | default |
| --fabric | The transport fabric type (tcp or rdma). The cluster must support the chosen fabric. Default: tcp.Available Options: - tcp - rdma - tcp,rdma |
string | False | tcp |
| --lvol-priority-class | The logical volume priority class. Default: 0. |
integer | False | 0 |
| --namespace | Sets the NVMe namespace for the logical volume (namespace must already exist). | string | False | - |
| --pvc-name, --pvc_name | Set the logical volume persistent volume claim name for Kubernetes clients. The old parameter name --pvc_name is deprecated and shouldn't be used anymore. It will eventually be removed. Please exchange the use of --pvc_name with --pvc-name. |
string | False | - |
| --data-chunks-per-stripe | The erasure coding schema parameter k (distributed raid). Default: 0. |
integer | False | 0 |
| --parity-chunks-per-stripe | The erasure coding schema parameter n (distributed raid). Default: 0. |
integer | False | 0 |
| --replicate | Replicate LVol snapshot | marker | False | - |
Changes QoS settings for an active logical volume.
Changes QoS settings for an active logical volume.
sbctl volume qos-set
<VOLUME_ID>
--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 |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --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 logical volumes.
Lists logical volumes.
sbctl volume list
--cluster-id=<CLUSTER_ID>
--pool=<POOL>
--json
--all
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --cluster-id | List logical volumes in particular cluster. | string | False | - |
| --pool | List logical volumes in particular pool id or name. | string | False | - |
| --json | Print outputs in json format. | marker | False | - |
| --all | List soft deleted logical volumes. | marker | False | - |
Gets the logical volume details.
Gets the logical volume details.
sbctl volume get
<VOLUME_ID>
--json
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id or name. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --json | Print outputs in json format. | marker | False | - |
Deletes a logical volume.
Deletes a logical volume. Attention: All data will be lost! This is an irreversible operation! Actual storage capacity will be freed as an asynchronous background task. It may take a while until the actual storage is released.
sbctl volume delete
<VOLUME_ID>
--force
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volumes id or ids. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --force | Force delete logical volume from the cluster. | marker | False | - |
Gets the logical volume's NVMe/TCP connection string(s).
Multiple connections to the cluster are always available for multi-pathing and high-availability.
sbctl volume connect
<VOLUME_ID>
--ctrl-loss-tmo=<CTRL_LOSS_TMO>
--host-nqn=<HOST_NQN>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --ctrl-loss-tmo | The control loss timeout for this volume. | integer | False | - |
| --host-nqn | Host NQN for DH-HMAC-CHAP authentication (required when volume has allowed hosts with secrets). | string | False | - |
Resizes a logical volume.
Resizes a logical volume. Only increasing a volume is possible. The new capacity must fit into the storage pool's free capacity.
sbctl volume resize
<VOLUME_ID>
<SIZE>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
| SIZE | New logical volume size size: 10M, 10G, 10(bytes). | size | True |
Creates a snapshot from a logical volume.
Creates a snapshot from a logical volume.
sbctl volume create-snapshot
<VOLUME_ID>
<NAME>
--backup
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
| NAME | The snapshot name. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --backup | Also create an S3 backup of this snapshot. | marker | False | - |
Provisions a logical volumes from an existing snapshot.
Provisions a logical volumes from an existing snapshot.
sbctl volume clone
<SNAPSHOT_ID>
<CLONE_NAME>
--resize=<RESIZE>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| SNAPSHOT_ID | The snapshot id. | string | True |
| CLONE_NAME | The clone name. | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --resize | New logical volume size: 10M, 10G, 10(bytes). Can only increase. Default: 0. |
size | False | 0 |
Gets a logical volume's capacity.
Gets a logical volume's capacity.
sbctl volume get-capacity
<VOLUME_ID>
--history=<HISTORY>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume 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 | - |
Gets a logical volume's I/O statistics.
Gets a logical volume's I/O statistics.
sbctl volume get-io-stats
<VOLUME_ID>
--history=<HISTORY>
--records=<RECORDS>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume 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 | The number of records. Default: 20. |
integer | False | 20 |
Checks a logical volume's health.
Checks a logical volume's health.
sbctl volume check
<VOLUME_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
Inflate a logical volume.
All unallocated clusters are allocated and copied from the parent or zero filled if not allocated in the parent. Then all dependencies on the parent are removed.
sbctl volume inflate
<VOLUME_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
Start snapshot replication taken from lvol
Start snapshot replication taken from lvol
sbctl volume replication-start
<LVOL_ID>
--replication-cluster-id=<REPLICATION_CLUSTER_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| LVOL_ID | Logical volume id | string | True |
| Parameter | Description | Data Type | Required | Default |
|---|---|---|---|---|
| --replication-cluster-id | Cluster ID of the replication target cluster | string | False | - |
Stop snapshot replication taken from lvol
Stop snapshot replication taken from lvol
sbctl volume replication-stop
<LVOL_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| LVOL_ID | Logical volume id | string | True |
Lists replication status
Lists replication status
sbctl volume replication-status
<CLUSTER_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| CLUSTER_ID | Cluster UUID | string | True |
Start replication for lvol
Start replication for lvol
sbctl volume replication-trigger
<LVOL_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| LVOL_ID | Logical volume id | string | True |
Suspend lvol subsystems
Suspend lvol subsystems
sbctl volume suspend
<LVOL_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| LVOL_ID | Logical volume id | string | True |
Resume lvol subsystems
Resume lvol subsystems
sbctl volume resume
<LVOL_ID>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| LVOL_ID | Logical volume id | string | True |
Create logical volume clone by taking a snapshot and then cloning it.
Create logical volume clone by taking a snapshot and then cloning it.
sbctl volume clone-lvol
<VOLUME_ID>
<CLONE_NAME>
| Argument | Description | Data Type | Required |
|---|---|---|---|
| VOLUME_ID | The logical volume id. | string | True |
| CLONE_NAME | The new logical volume clone name. | string | True |