stcli Commands
HX Data Platform Command Line Interface (CLI) commands all begin with stcli .
stcli [-h] {about | services | vm | dp | snapshot-schedule | cluster | appliance | node | disk | cleaner | datastore | file | security | license | rebalance}
Syntax Description
Option |
Required or Optional |
Description |
---|---|---|
about |
One of set required. |
About controller VM service, the storage manager, |
appliance |
One of set required. |
Commands supported in the storage cluster appliance namespace. |
cleaner |
One of set required. |
Commands supported in the storage cluster cleaner namespace. |
cluster |
One of set required. |
Commands supported in the storage cluster namespace. |
datastore |
One of set required. |
Commands supported in the storage cluster datastore namespace. |
disk |
One of set required. |
Commands supported in the storage cluster disk namespace. |
file |
One of set required. |
Commands supported in the storage cluster VM file namespace. |
license |
One of set required. |
Commands supported in the Smart License namespace. |
node |
One of set required. |
Commands supported in the storage cluster node namespace. A storage cluster node is comprised of a hypervisor node and the storage controller. The storage cluster node uses the hypervisor ID/IP for identification. |
rebalance |
One of set required. |
Commands supported in the storage cluster rebalance namespace. |
recovery |
Not supported. |
|
security |
One of set required. |
Commands supported in the storage cluster security namespace. |
services |
One of set required. |
Commands supported in the storage cluster system services namespace. |
snapshot-schedule |
One of set required. |
Enables / disables snapshot schedules for all the objects in this storage cluster. |
vm |
One of set required. |
Commands supported in the storage cluster VM namespace. |
Command Default
None. One option from the set is required.
Usage Guidelines
Accompany the stcli
command with one of the positional arguments enclosed in { } or optionally, arguments enclosed in [ ].
stcli about Command
Displays information about the HX controller VM's service, storage manager, stMgr
. This is the service that manages the controller VM.
stcli about
Command Default
None.
Usage Guidelines
Run the stcli about
command.
# stcli about
serviceType: stMgr
instanceUuid:
name: HyperFlex StorageController
locale: English (United States)
serialNumber:
apiVersion: 0.1
modelNumber: X9DRT
build: 2.0.1a-19584 (master)
displayVersion: 2.0(1a)
fullName: HyperFlex StorageController 2.0.1a
productVersion: 2.0.1a-19584
stcli -help Command
Help option on all stcli
commands.
stcli [COMMAND] [-h]
Syntax Description
Option |
Required or Optional |
Description |
---|---|---|
-h, --help |
Required |
Shows the help message relative to the listed command and exits. |
Command Default
None.
Usage Guidelines
Accompany the stcli
command with one of the positional commands or arguments and the --help
option.