Logical volume commands

sbcli-pre volume --help

Aliases: lvol

Adds a new logical volume

sbcli-pre 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>
    --ha-type=<HA_TYPE>
    --lvol-priority-class=<LVOL_PRIORITY_CLASS>
    --namespace=<NAMESPACE>
    --pvc-name=<PVC_NAME>

Argument	Description	Data Type	Required
NAME	New logical volume name	string	True
SIZE	Logical volume size: 10M, 10G, 10(bytes)	string	True
POOL	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	Logical volume max size	string	False	1000T
--host-id	Primary storage node id or Hostname	string	False	-
--encrypt	Use inline data encryption and decryption on the logical volume	marker	False	-
--crypto-key1	Hex value of key1 to be used for logical volume encryption	string	False	-
--crypto-key2	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	-
--ha-type	Logical volume HA type (single, ha), default is cluster HA type Available Options: - single - default - ha	string	False	default
--lvol-priority-class	Logical volume priority class	integer	False	0
--namespace	Set logical volume namespace for k8s clients	string	False	-
--pvc-name, --pvc_name	Set the logical volume persistent volume claim name for Kubernetes clients.

Warning

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

Changes QoS settings for an active logical volume

sbcli-pre 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	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

sbcli-pre 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

sbcli-pre volume get
    <VOLUME_ID>
    --json

Argument	Description	Data Type	Required
VOLUME_ID	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.

sbcli-pre volume delete
    <VOLUME_ID>
    --force

Argument	Description	Data Type	Required
VOLUME_ID	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.

sbcli-pre volume connect
    <VOLUME_ID>

Argument	Description	Data Type	Required
VOLUME_ID	Logical volume id	string	True

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.

sbcli-pre volume resize
    <VOLUME_ID>
    <SIZE>

Argument	Description	Data Type	Required
VOLUME_ID	Logical volume id	string	True
SIZE	New logical volume size size: 10M, 10G, 10(bytes)	string	True

Creates a snapshot from a logical volume

sbcli-pre volume create-snapshot
    <VOLUME_ID>
    <NAME>

Argument	Description	Data Type	Required
VOLUME_ID	Logical volume id	string	True
NAME	Snapshot name	string	True

Provisions a logical volumes from an existing snapshot

sbcli-pre volume clone
    <SNAPSHOT_ID>
    <CLONE_NAME>
    --resize=<RESIZE>

Argument	Description	Data Type	Required
SNAPSHOT_ID	Snapshot id	string	True
CLONE_NAME	Clone name	string	True

Parameter	Description	Data Type	Required	Default
--resize	New logical volume size: 10M, 10G, 10(bytes). Can only increase.	string	False	-

Gets a logical volume's capacity

sbcli-pre volume get-capacity
    <VOLUME_ID>
    --history=<HISTORY>

Argument	Description	Data Type	Required
VOLUME_ID	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

sbcli-pre volume get-io-stats
    <VOLUME_ID>
    --history=<HISTORY>
    --records=<RECORDS>

Argument	Description	Data Type	Required
VOLUME_ID	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	Number of records, default: 20	integer	False	20

Checks a logical volume's health

sbcli-pre volume check
    <VOLUME_ID>

Argument	Description	Data Type	Required
VOLUME_ID	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.

sbcli-pre volume inflate
    <VOLUME_ID>

Argument	Description	Data Type	Required
VOLUME_ID	Cloned logical volume id	string	True