Caching node commands

sbctl caching-node --help

Aliases: cn

Deploys a caching node on this machine (local run)

sbctl caching-node deploy
    --ifname=<IFNAME>

Parameter	Description	Data Type	Required	Default
--ifname	Management interface name, e.g. eth0	string	False	-

Adds a new caching node to the cluster

sbctl caching-node add-node
    <CLUSTER_ID>
    <NODE_IP>
    <IFNAME>
    --vcpu-count=<VCPU_COUNT>
    --namespace=<NAMESPACE>
    --multipathing=<MULTIPATHING>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True
NODE_IP	Node IP address	string	True
IFNAME	Management interface name	string	True

Parameter	Description	Data Type	Required	Default
--vcpu-count	Number of vCPUs used for SPDK. Remaining CPUs will be used for Linux system, TCP/IP processing, and other workloads. The default on non-Kubernetes hosts is 80%.	integer	False	-
--namespace	k8s namespace to deploy on	string	False	-
--multipathing	Enable multipathing for logical volume connection, default: on Available Options: - on - off	string	False	True

Lists all caching nodes

sbctl caching-node list

Lists all connected logical volumes

sbctl caching-node list-lvols
    <NODE_ID>

Argument	Description	Data Type	Required
NODE_ID	Caching node id	string	True

Removes a caching node from the cluster

sbctl caching-node remove
    <NODE_ID>
    --force

Argument	Description	Data Type	Required
NODE_ID	Caching node id	string	True

Parameter	Description	Data Type	Required	Default
--force	Force remove	marker	False	-

Connects a logical volume to the caching node

sbctl caching-node connect
    <NODE_ID>
    <LVOL_ID>

Argument	Description	Data Type	Required
NODE_ID	Caching node id	string	True
LVOL_ID	Logical volume id	string	True

Disconnects a logical volume from the caching node

sbctl caching-node disconnect
    <NODE_ID>
    <LVOL_ID>

Argument	Description	Data Type	Required
NODE_ID	Caching node id	string	True
LVOL_ID	Logical volume id	string	True

Recreate a caching node's bdevs

sbctl caching-node recreate
    <NODE_ID>

Argument	Description	Data Type	Required
NODE_ID	Caching node id	string	True

Gets a logical volume's statistics

sbctl caching-node get-lvol-stats
    <LVOL_ID>
    --history=<HISTORY>

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