cisco hx data platform command line - cisco - …€¦ · cisco hx data platform command line...

Cisco HX Data Platform Command Line

Interface Reference

Version 1.8 Release

Document Updated: October 25, 2016

Cisco HX Data Platform Command Line Interface Reference 2


Contents

1 stcli Commands Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Logging into the Controller VM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Command Syntax Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

stcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

stcli -h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

stcli about. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

stcli services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

2 Appliance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11stcli appliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

stcli appliance discover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

stcli appliance list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

3 Cleaner Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16stcli cleaner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

stcli cleaner info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

stcli cleaner get-schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

stcli cleaner report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

stcli cleaner set-schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

stcli cleaner start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

stcli cleaner stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

stcli cleaner stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

4 Cluster Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22stcli cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

stcli cluster create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

stcli cluster create-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

stcli cluster diag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

stcli cluster disable-data-write-thru . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

stcli cluster enable-data-write-thru . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

stcli cluster get-cluster-access-policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

stcli cluster get-data-replication-factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

stcli cluster info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

stcli cluster prepare. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

stcli cluster recreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30


stcli cluster refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

stcli cluster reregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

stcli cluster set-cluster-access-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

stcli cluster shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

stcli cluster start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

stcli cluster storage-summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

stcli cluster upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

stcli cluster upgrade-status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

stcli cluster version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

5 Datastore Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35stcli datastore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

stcli datastore create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

stcli datastore delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

stcli datastore info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

stcli datastore list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

stcli datastore mount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

stcli datastore unmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

stcli datastore update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

6 Disk Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38stcli disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

stcli disk add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

stcli disk list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

7 Node Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40stcli node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

stcli node add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

stcli node discover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

stcli node disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

stcli node disks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

stcli node info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

stcli node list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

stcli node maintenanceMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

stcli node remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

8 Rebalance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48stcli rebalance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

stcli rebalance enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

stcli rebalance disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

stcli rebalance start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

stcli rebalance status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

stcli rebalance stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

9 Security Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51


stcli security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

stcli security password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

stcli security password set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

stcli security ssh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

stcli security ssh resync. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

stcli security whitelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52

stcli security whitelist add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

stcli security whitelist clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

stcli security whitelist list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

stcli security whitelist remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

10 Services Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Services ASUP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

stcli services asup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

stcli services asup enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

stcli services asup disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

stcli services asup recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

stcli services asup recipients add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

stcli services asup recipients clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

stcli services asup recipients remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

stcli services asup recipients set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

stcli services asup show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

Services DNS Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

stcli services dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

stcli services dns add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

stcli services dns remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

stcli services dns set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

stcli services dns show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Services NTP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

stcli services ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

stcli services ntp add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

stcli services ntp remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

stcli services ntp set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60

stcli services ntp show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

Services SMTP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

stcli services smtp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

stcli services smtp clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61

stcli services smtp set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

stcli services smtp show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

Services Time Zone Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

stcli services timezone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

stcli services timezone set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

stcli services timezone show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63


11 VM Clone, Snapshot, and File Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64stcli file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

stcli file clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

stcli snapshot-schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

stcli vm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

stcli vm clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

stcli vm snapshot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66


1 stcli Commands Overview

This section introduces the HX Data Platform stcli commands.

Logging into the Controller VM

Login to the HX Data Platform Storage Controller VM command Line.

1. Click through to the storage cluster list of controller VMs.

From vSphere Web Client > Home > VMs and Templates > vCenter server > datacenter > ESX Agents > VM.

2. Locate a controller VM DNS Name.

Select a VM > Summary > DNS Name.

3. Login to the HX Data Platform Command Line Interface.

a. From a browser, enter the DNS Name and /cli path.

Example

cs002-stctlvm-a.eng.storvisor.com/cli

b. Enter the login credentials.

Default credentials are username: root, password: Cisco123

Command Syntax Usage

Items without any brackets or hyphens are required.

[ ] Items listed in square brackets are optional.

{ } Items listed in curly braces require one from the options be used.

( ) Items listed are select-one-from-list options.

-- Items leading with single or double hyphens are separate command parameters.

CAPS Items in all capitals are replaced with specific values.

stcli

HX Data Platform Command Line Interface (CLI).


Accompany the stcli command with one or more positional arguments enclosed in { }, or optional arguments, such as the -help option, enclosed in [ ].

Syntax

stcli [-h] {about, services, vm, snapshot-schedule, cluster, appliance, node, disk, cleaner, datastore, file, security, rebalance}

Parameters Required or Optional Description

about Require one from set. About Storage Manager.

appliance Require one from set. Commands supported in the Storage Appliance namespace.

cleaner Require one from set. Commands supported in the Storage cleaner namespace.

cluster Require one from set. Commands supported in the Storage cluster namespace.

datastore Require one from set. Commands supported in the Storage datastore namespace.

disk Require one from set. Commands supported in the Storage disk namespace.

file Require one from set. Commands supported in the Storage file namespace.

node Require one from set. Commands supported in the Storage node namespace. A Storage node is comprised of a hypervisor node and the storage controller and uses the hypervisor ID/IP for identification.

rebalance Require one from set. Commands supported in the Storage rebalance namespace.

security Require one from set. Commands supported in the Storage security namespace.

services Require one from set. Commands supported in the Storage system services namespace.

snapshot-schedule Require one from set. Enables / Disables Snapshot Schedules for all the objects in this cluster.

vm Require one from set. Commands supported in the Storage vm namespace.

stcli -h

Help option on all stcli commands.


Syntax

stcli <command> [-h]

Parameter Required or Optional Description

-h, --help Optional. Shows the help message relative to the listed command and exits.

stcli about

Displays information about the HX Data Platform. The controller VM service, stMgr, is the service that manages the controller VM.

Syntax

stcli about

Sample Response

serviceType: stMgr instanceUuid: ae77a625-bd3a-4fc5-9fc3-7a19ab8c3285 name: HyperFlex StorageController locale: English (United States) serialNumber: S10584723011481 apiVersion: 0.1 modelNumber: X9DRT build: 1.8.1a-19584 (master) displayVersion: 1.8(1a) fullName: HyperFlex StorageController 1.8.1a productVersion: 1.8.1a-19584

stcli services

System services related operations.

Accompany the base stcli services command with one or more positional arguments, or the optional -help option.

Syntax

stcli services [-h] {smtp, dns, ntp, asup, timezone}


asup Require one from set. Commands supported in the ASUP configuration namespace.

dns Require one from set. Commands supported in the Storage DNS configuration namespace.

ntp Require one from set. Commands supported in the Storage NTP configuration namespace.

smtp Require one from set. Required (if one of set not specified). Commands supported in the Storage SMTP configuration namespace.


timezone Require one from set. Commands supported in the Timezone configuration namespace.



2 Appliance Commands

This section lists and describes commands to list and discover appliances in storage cluster.

stcli appliance

Appliance operations.

Syntax

stcli appliance [-h] {list,discover}


list Require one from set. Lists the Storage appliances in the storage cluster.

discover Require one from set. Discover new Storage appliances in the network.

stcli appliance discover

Discover new Storage appliances in the network. If none are found, only the time spent searching is returned.

Syntax

stcli appliance discover [-h]

stcli appliance list

Lists the Storage appliances in the storage cluster.

Syntax

stcli appliance list [-h]

Sample Response

ps: ---------------------------------------- status: green name: Power Supply 2: Running/Full Power-Enabled ----------------------------------------


status: green name: Power Supply 1 PS1 Status: Power Supply AC lost - Deassert ---------------------------------------- status: green name: Power Supply 2 PS2 Status: Failure status - Deassert ---------------------------------------- status: green name: Power Supply 2 PS2 Status: Predictive failure - Deassert ----------------------------------------serialNumber: S10584723011481disks: EntityRef(type=10, id=' ', name=' '): status: online serialNumber: capacity: 447.1G slotNumber: 1.1.1 logicalname: /dev/sdb modelNumber: entityRef: type: pdisk id: name: /dev/sdb version: vendor:

EntityRef ...modelNumber: pnics: EntityRef(type=3, id=' ', name=' '): ---------------------------------------- device: vmnic1 mac: pci: speedMb: 1000 ---------------------------------------- device: vmnic3 mac: pci: speedMb: 10000 ---------------------------------------- device: vmnic0 mac: pci: speedMb: 1000 ---------------------------------------- device: vmnic2 mac: pci: speedMb: 10000 ----------------------------------------

EntityRef ...nodes: A: upgradeState: ok state: online


storfsIp: addr: stService: vlanId: gateway: subnetMask: method: static pNode:

about:serviceType: instanceUuid: name: locale:serialNumber: apiVersion: modelNumber: build: displayVersion: fullName: HproductVersion:

retired: Falsecompression: Trueip:disks:

---------------------------------------- blacklistCount: 0 medium: rotational capacity: 931.5G state: ready version: 0 entityRef: type: disk id: 5 usage: persistence path: /dev/sde lastModifiedTime: usedCapacity: 9.2G

----------------------------------------...

dedup: True nsPrimary: False dataWriteThruEnabled: True state: ready bootTime: 0 master: True entityRef: type: pnode id: name: version: 0 lastModifiedTime: name:

host: state: online


about: serviceType: HostAgent instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build: fullName: productVersion: stctlvm: name: storageClusterIp: ip: guestHostname: mgmtClusterIp: storageNetworkIp: moid: role: storage entityRef: type: id: name: version: passthrough: guestState: mgmtNetworkIp: name: ip: addr: stService: vlanId: gateway: subnetMask: method: static moid: ipmiSettings: addr: stService: gateway: subnetMask: method: ioVisor: about: serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build: fullName:


productVersion: state: online bootTime: entityRef: type: node id: name: vMotionIp: addr: vlanId: gateway: subnetMask: method: static enclosureSerialNumber: entityRef: type: node id: name: progress: ---------------------------------------- completion: 100 parent: type: node id: name: name: state: succeeded entity: type: disk id: description: ----------------------------------------

progress ... upgradeVersion: C: upgradeState: state: online storfsIp: addr: stService: vlanId: gateway: subnetMask: method: static

pNode ...


3 Cleaner Commands

This section lists and describes the commands that remove stale data and release storage for storage storage cluster availability.

The stcli cleaner command typically runs in the background continuously. cleaner goes into sleep mode when it is not needed and wakes when policy defined conditions are met. These conditions include:

• Number of flushes since the last cleaner run.

• Amount of data written since the last cleaner run.

• Amount of data deleted since the last cleaner run.

• Storage cluster space usage. See capacity status.

Priority levels are:

• Normal Priority. The cleaner generates minimum I/O.

• High Priority. The cleaner I/O is increased.

If your storage cluster is experiencing ENOSPC condition, the cleaner automatically runs at High Priority.

Priority is determined by:

• Time of Day (TOD) - Default is 6 AM UTC to 6 AM UTC, which disables the TOD-based High Priority cleaner. Use stcli cleaner set-schedule.

• Cluster Space Usage - If the storage cluster reaches an ENOSPC WARN condition, the cleaner increases its intensity by increasing the number of I/O to garbage collect. With an ENOSPC set condition, it runs at highest priority.

Note: Deleting data alone does not trigger cleaner to run and recover space. The properties and settings govern the cleaner.

stcli cleaner

Storage cluster cleaner operations.

Syntax

stcli cleaner [-h] {info, start, stop, stats, report, get-schedule, set-schedule}


info Require one from set. Provides information about the specified Storage cleaner.


stcli cleaner info

Returns information about the Storage cleaner for the specified node. Default applies to all nodes in cluster.

Syntax

stcli cleaner info [-h] [ --id ID | --ip NAME]


--id ID Optional. ID of storage cluster node. The ID is listed in the stcli cluster info command.

--ip NAME Optional. IP address of storage cluster node. The IP is listed in the stcli cluster info command

Sample Response

{ 'type': 'node', 'id': '73ab5aa5-cf6e-ef4c-a566-9ec180c2cd9c', 'name': '10.65.10.192' }: ONLINE{ 'type': 'node', 'id': '9d772ab3-9992-ce44-8b8a-fd66a970f91b', 'name': '10.65.10.193' }: ONLINE{ 'type': 'node', 'id': '1dfc7bd3-0a8c-1547-b0fe-5f7425ca44fc', 'name': '10.65.10.194' }: ONLINE

ONLINE - The cleaner (garbage collector) is running as expected in background.

OFFLINE - There is no garbage collection on the referenced node.

stcli cleaner get-schedule

Returns the cleaner priority schedule state for all the nodes in the storage cluster. Default applies to all nodes in cluster.

get-schedule Require one from set. Reports cleaner high priority schedule.

report Require one from set. Reports space reclaimed from cleaner.

set-schedule Require one from set. Sets cleaner high priority schedule

start Require one from set. Starts Storage cleaner.

stats Require one from set. Collects cleaner stats.

stop Require one from set. Stops Storage cleaner.



Syntax

stcli cleaner get-schedule [-h] [--id ID | --ip NAME]




Sample Response

{ 'type': 'node', 'id': '73ab5aa5-cf6e-ef4c-a566-9ec180c2cd9c', 'name': '10.65.10.192' }:policyActive: FalseendTime: 6startTime: 6{ 'type': 'node', 'id': '9d772ab3-9992-ce44-8b8a-fd66a970f91b', 'name': '10.65.10.193' }:policyActive: FalseendTime: 6startTime: 6{ 'type': 'node', 'id': '1dfc7bd3-0a8c-1547-b0fe-5f7425ca44fc', 'name': '10.65.10.194' }:policyActive: FalseendTime: 6startTime: 6

policyActive:False - The cleaner is running at normal Priority.

policyActive:True - The cleaner is running at high Priority.

stcli cleaner report

Reports space reclaimed from cleaner. Default applies to all nodes in the cluster.

This command reports the deduplication and compression savings for each of the nodes in the storage cluster, and an aggregate summary of the deduplication and compression savings for the storage cluster. Relevant fields include:

{ 'type': 'cluster', 'id': '' }:dedupSavings: 0.0compressionSavings: 0.0

Compute only nodes show a dedupSavings of -1.0. This means that the node is not contributing to the managed storage.

Syntax

stcli cleaner report [-h] [--id ID | --ip NAME] [--start]




Sample Response

{ 'type': 'node', 'id': '00000000-0000-0000-0000-002590d42388', 'name': '10.104.48.26' }: dedupSavings: 0.0 totalNodeSavings: 0.0 compressionSavings: 0.0 totalUniqueAddressableBytes: 26.2K estimated: False totalUniqueBytes: 0 totalAddressableBytes: 26.2K{ 'type': 'cluster', 'id': '' }: dedupSavings: 0.0 totalNodeSavings: 100.0 compressionSavings: 100.0 totalUniqueAddressableBytes: 78.0K estimated: False totalUniqueBytes: 0 totalAddressableBytes: 78.0K

stcli cleaner set-schedule

Sets the cleaner schedule for all the nodes in the storage cluster. Default is 6 PM UTC to 6 AM UTC, in 24 hours clock that is from 21:00 to 06:00. The default disables the High Priority TOD-based cleaning.

Use the stcli cleaner set-schedule to specify non-default --starttime and --endtime. These two parameters cannot both be zero.

Changes are applied immediately. Restarting the server is not needed. Default applies to all nodes in the cluster.

Syntax

stcli cleaner set-schedule [-h] [--id ID | --ip NAME] --starttime begin_hour --endtime end_hour


--endtime Required. Set running time end time. UTC (hours in 24 hour format).

--starttime Required. Sets running time start time. UTC (hours in 24 hour format).




--start Optional. Start the cleaner.



Example

# stcli cleaner set-schedule --starttime 20 --endtime 5

This example command starts the cleaner at 8PM UTC and stops the cleaner at 5AM UTC.

stcli cleaner start

Restarts the cleaner. Default applies to all nodes in the cluster.

cleaner starts automatically with the HX Data Platform. This stcli cleaner start command is used only if the cleaner is manually stopped. When it is manually stopped, it can be manually restarted.

Syntax

stcli cleaner start [-h] [--id ID | --ip NAME]




stcli cleaner stats

Collects cleaner stats. Default applies to all nodes in the cluster.

Syntax

stcli cleaner stats [-h] [--id ID | --ip NAME] [--start]




--start Optional. Start cleaner.

Example

{ 'type': 'node', 'id': '00000000-0000-0000-0000-002590d42388', 'name': '10.104.48.26' }: ---------------------------------------- curNumDeadKeys: 0 deletedNumSegments: 0 curNumSegments: 0 priorNumSegments: 0 ftVnodeNumber: 44 uniqueBytes: 0 uniqueVBABytes: 912 curNumLiveKeys: 0


priorNumDeadKeys: 0 totalAddressedVBABytes: 624 priorNumLiveKeys: 0 uniqueVBAs: 4 ----------------------------------------. . .

stcli cleaner stop

Stops the cleaner processes. Default applies to all nodes in the cluster.

If the cleaner is manually stopped:

• The cleaner starts automatically after a reboot or restart of a storage cluster node.

• The cleaner can be manually restarted.

Syntax

stcli cleaner stop [-h] [--id ID | --ip NAME]





4 Cluster Commands

This section lists and describes related to starting, stopping, and using HX Data Platform storage clusters. A storage cluster is a group of nodes. When you add a node to a storage cluster, the node’s resources become a part of the storage cluster’s resources. The storage cluster manages the resources of all nodes that it contains.

stcli cluster

HX Data Platform storage cluster operations.

Accompany the base stcli cluster command with one or more of the positional arguments or the optional -help option.

Syntax

stcli cluster [-h] {prepare,create,info,diag,refresh,shutdown,start,upgrade,upgrade-status,version,create-config,recreate,reregister,get-data-replication-factor,get-cluster-access-policy,set-cluster-access-policy,enable-data-write-thru,disable-data-write-thru,storage-summary}


create Require one from set. Creates a storage cluster with the name and the given nodes identified by IP addresses.

create-config Require one from set. Creates a storage cluster from a configuration file.

diag Require one from set. Provides diagnostic messages about the cluster.

disable-data-write-thru Require one from set. Disable data write through on the storage cluster.

enable-data-write-thru Require one from set. Enable data write through on the storage cluster.

get-cluster-access-policy Require one from set. Gets storage cluster Cluster Access Policy.

get-data-replication-factor Require one from set. Gets storage Data Replication Factor.

info Require one from set. Provides information about the currently configured Storage cluster.


stcli cluster create

Creates a storage cluster with the name and the given nodes identified by IP addresses.

Syntax

stcli cluster create [-h] --name NAME --ip IP --mgmt-ip MGMTIP --vcenter-datacenter DATACENTER [--vcenter-cluster VCENTERCLUSTER] [--vcenter-url VCENTERURL] [--vcenter-sso-url VCENTERSSOURL] --vcenter-user VCENTERUSER [--vcenter-password VCENTERPASSWORD][--controller-root-password CONTROLLERPASSWORD] --node-ips NODEIPS [NODEIPS ...][--data-replication-factor {2,3}] [--cluster-access-policy {strict,lenient}][--vdi-only-deployment] [-f] [--dryrun] [--esx-username ESXUSERNAME] [--esx-password ESXPASSWORD]

prepare Require one from set. Prepares network configuration for Storage cluster for the set of nodes identified by IP addresses.

recreate Require one from set. Recreates an existing cluster with force option.

refresh Require one from set. Refreshes cluster status.

reregister Require one from set. Reregister an existing cluster from one vCenter to another.

set-cluster-access-policy Require one from set. Sets storage cluster Cluster Access Policy.

shutdown Require one from set. Shuts down cluster.

start Require one from set. Starts cluster.

storage-summary Require one from set. Provides storage summary about the currently configured storage cluster.

upgrade Require one from set. Upgrades cluster.

upgrade-status Require one from set. Provides transitional information about cluster upgrade status.

version Require one from set. Provides information about cluster version.


--ip IP Required. IP of storage cluster.

--mgmt-ip MGMTIP Required. IP of management server.

--name NAME Required. Name of storage cluster.

--node-ips NODEIPS [NODEIPS ...] Required. IPs of all converged nodes to add to storage cluster.

--vcenter-datacenter DATACENTER Required. Name of vCenter datacenter.



stcli cluster create-config

Creates a storage cluster from a configuration file.

Syntax

stcli cluster create-config [-h] [-f] [--dryrun] --vcenter-user VCENTERUSER[--vcenter-password VCENTERPASSWORD][--controller-root-password CONTROLLERPASSWORD][--esx-username ESXUSERNAME][--esx-password ESXPASSWORD] config

--vcenter-user VCENTERUSER Required. User name of vCenter administrator.

--cluster-access-policy {strict,lenient}

Optional. Default lenient.

Cluster Access Policy (strict or lenient).

--controller-root-password CONTROLLERPASSWORD

Optional. Default is Cisco123.

Password of controller VM's root user. All nodes must have the same password.

--data-replication-factor {2,3} Optional. Default is 3. Data Replication Factor (2 or 3). This can only be set during initial storage cluster creation.

--dryrun Optional. Only validate input parameters.

--esx-password ESXPASSWORD Optional. Password of ESX administrator.

--esx-username ESXUSERNAME Optional. User name of ESX administrator.

-f, --force Optional. Force to create storage cluster.

--vcenter-cluster VCENTERCLUSTER Optional. Name of vCenter cluster.

--vcenter-password VCENTERPASSWORD Optional. Password of vCenter administrator.

--vcenter-sso-url VCENTERSSOURL Optional. URL of vCenter SSO server. This is inferred from --vcenter-url, if not specified.

--vcenter-url VCENTERURL Optional. URL of vCenter, <vcentername>. Where <vcentername> can be FQDN or IP.

--vdi-only-deployment Optional. Default is VSI.

Set Workload Type as VDI.


config Required. Configuration of storage cluster.


[--controller-root-password CONTROLLERPASSWORD]

Optional. Password of controller VM's root user.



stcli cluster diag

Provides diagnostic messages about the cluster. Default applies to all nodes in the storage cluster.

Syntax

stcli cluster diag



--ip NAME Optional. IP address of storage cluster node. The IP is listed in the stcli cluster info command.

--type TYPE Optional. Type of storage cluster node. Options are: converged or compute

[-h] [--id ID | --ip NAME ] [ --type TYPE]

stcli cluster disable-data-write-thru

Disable data write through on the storage cluster. Default applies to all nodes in the storage cluster.

Syntax

stcli cluster disable-data-write-thru [-h] [--id ID | --ip NAME]




stcli cluster enable-data-write-thru

Enable data write through on the storage cluster. Default applies to all nodes in the storage cluster.




-f, --force Optional. Force to create storage cluster.

--vcenter-password VCENTERPASSWORD

Optional. Password of vCenter administrator.



Syntax

stcli cluster enable-data-write-thru [-h] [--id ID | --ip NAME]




stcli cluster get-cluster-access-policy

Gets storage cluster Cluster Access Policy.

Syntax

stcli cluster get-cluster-access-policy [-h]

Sample Response

lenient

stcli cluster get-data-replication-factor

Gets storage cluster Data Replication Factor.

Syntax

stcli cluster get-data-replication-factor [-h]

Sample Response

3

stcli cluster info

Displays detailed information about the storage cluster and each node in the storage cluster.

Syntax

stcli cluster info [-h] [--summary]


--summary Optional. Display summary only.

Example

# stcli cluster info

Sample Response

about:


serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build:

displayVersion: fullName: productVersion: vCluster: state: boottime: entityRef: type: id: name: c virtNodes: ---------------------------------------- type: virtnode id: ---------------------------------------- . . .virtDatastores:upgradeState: cluster:healthState: healthy capacity: 3.3T state: online compliance: 1 resiliencyInfo: nodeFailuresTolerable: 1 state: healthy messages: Storage cluster is healthy. ssdFailuresTolerable: 2 hddFailuresTolerable: 2 activeNodes: 3 uptime: 15 days, 19:44:09 boottime: 1473220191 entityRef: type: cluster id: 518859da42c5b03b:603c85e65473cd7b downtime: 0:00:00 healingInfo: inProgress: False freeCapacity: 3.3T usedCapacity: 36.8G config: clusterUuid: 518859da42c5b03b:603c85e65473cd7b ip: 10.104.48.28 dataReplicationFactor: 3 clusterAccessPolicy: lenient


size: 3 nodes:

---------------------------------------- type: id: name: ---------------------------------------- . . .rawCapacity: state: stNodes: ---------------------------------------- type: id: name: ---------------------------------------- . . .entityRef: type: id: progress: ---------------------------------------- completion:

name: state: entity:

type:id:name:

---------------------------------------- . . . ----------------------------------------

completion: parent:

type: id: name:

name: state: entity: type: id:

description: ---------------------------------------- . . . ----------------------------------------config: clusterUuid: name: mgmtIp: addr:

method: vCenterDatacenter: ip:


addr: method: vCenterClusterName: dataReplicationFactor: workloadType: vCenterClusterId: nodeIPSettings: cs-002d: cs-002c: cs-002a: vCenterDatacenterId: clusterAccessPolicy: vCenterURL: dnsServers: size: upgradeVersion:

stcli cluster prepare

Prepares network configuration for the storage cluster for the set of nodes identified by IP addresses.

Note: This is an advanced command. Do not use without TAC assistance.

Syntax

stcli cluster prepare [-h] (--node-ips NODEIPS [NODEIPS ...] | --config CONFIG)[--hypervisor-ips HYPERVISORIPS [HYPERVISORIPS ...]][--storfs-ips STORFSIPS [STORFSIPS ...]] [--ipmi-ips IPMIIPS [IPMIIPS ...]][--vmotion-ips VMOTIONIPS [VMOTIONIPS ...]] [--netmask NETMASK] [--gateway GATEWAY][--vlan VLAN] [--netmask1 NETMASK1] [--gateway1 GATEWAY1] [--vlan1 VLAN1] [--dns DNS [DNS ...]] [--ntp NTP [NTP ...]] [--timezone TIMEZONE] [--smtp SMTPSERVER] [--fromaddress FROMADDRESS] [--dryrun]


--config CONFIG Require one from set. Network configuration file.

--node-ips NODEIPS [NODEIPS ...]

Require one from set. IPs of storage cluster nodes to add to configure.

--dns DNS [DNS ...] Optional. IPs of DNS server.


--fromaddress FROMADDRESS Optional. Address to send Auto Support emails from.

--gateway GATEWAY Optional. Default gateway.

--gateway1 GATEWAY1 Optional. Default gateway1.

--hypervisor-ips HYPERVISORIPS [HYPERVISORIPS ...]

Optional. IPs of hypervisor to be applied.

--ipmi-ips IPMIIPS [IPMIIPS ...]

Optional. IPs of IPMI to be applied.


stcli cluster recreate

Recreates an existing storage cluster with force option.

Syntax

stcli cluster recreate [-h] --vcenter-user VCENTERUSER [--vcenter-password VCENTERPASSWORD] [--controller-root-password CONTROLLERPASSWORD]




Optional. Default Cisco123.

Password of controller VM's root user. All nodes must have the same password.



stcli cluster refresh

Refreshes storage cluster status.

Syntax

stcli cluster refresh [-h]

stcli cluster reregister

Reregister an existing storage cluster from one vCenter to another.

Syntax

stcli cluster reregister [-h] [--vcenter-datacenter NEWDATACENTER]

--netmask NETMASK Optional. Subnet mask.

--netmask1 NETMASK1 Optional. Subnet mask1.

--ntp NTP [NTP ...] Optional. IPs of NTP server.

--smtp SMTPSERVER Optional. SMTP server.

--storfs-ips STORFSIPS [STORFSIPS ...]

Optional. IPs of storage cluster to be applied.

--timezone TIMEZONE Optional. Timezone.

--vlan VLAN Optional. VLAN Tag.

--vlan1 VLAN1 Optional. VLAN Tag1.

--vmotion-ips VMOTIONIPS [VMOTIONIPS ...]

Optional. IPs of vMotion to be applied.



[--vcenter-cluster NEWVCENTERCLUSTER] --vcenter-url NEWVCENTERURL[--vcenter-sso-url NEWVCENTERSSOURL] --vcenter-user NEWVCENTERUSER[--vcenter-password NEWVCENTERPASSWORD]


--vcenter-url NEWVCENTERURL

Required. Required. URL of the NEW vCenter, <vcentername>. Where <vcentername> can be FQDN or IP.

--vcenter-user NEWVCENTERUSER

Required. Required. User name of the NEW vCenter administrator.

--vcenter-cluster NEWVCENTERCLUSTER

Optional. Name of the NEW vCenter cluster.

--vcenter-datacenter NEWDATACENTER

Optional. Name of the NEW vCenter datacenter.

--vcenter-password NEWVCENTERPASSWORD

Optional. Password of the NEW vCenter administrator.

--vcenter-sso-url NEWVCENTERSSOURL

Optional. URL of the NEW vCenter SSO server. This is inferred from --vcenter-url, if not specified.

stcli cluster set-cluster-access-policy

Sets storage cluster Cluster Access Policy.

Syntax

stcli cluster set-cluster-access-policy [-h] --name {strict,lenient}


--name {strict,lenient}

Required. Name of the storage cluster Cluster Access Policy (strict or lenient).

Sample Response

strict

stcli cluster shutdown

Stops storage cluster operations and shuts it down.

Note: This is an advanced command. Do not use without TAC assistance.

Syntax

stcli cluster shutdown [-h] [--formatchange] [--maintenance]


--formatchange Optional. Enable disk format change.


stcli cluster start

Starts the storage cluster.

Syntax

stcli cluster start [-h]

stcli cluster storage-summary

Provides storage summary about the currently configured the storage cluster.

Syntax

stcli cluster storage-summary [-h]

Sample Response

address: 10.104.48.28name: cs002-clstate: onlineuptime: 15 days 19 hours 56 minutes 15 secondsactiveNodes: 3 of 3compressionSavings: 100.0deduplicationSavings: 0.0freeCapacity: 3.3ThealingInfo: inProgress: FalseresiliencyInfo: messages: Storage cluster is healthy. state: healthy hddFailuresTolerable: 2 nodeFailuresTolerable: 1 ssdFailuresTolerable: 2spaceStatus: normaltotalCapacity: 3.3TtotalSavings: 100.0usedCapacity: 36.8GclusterAccessPolicy: lenientdataReplicationCompliance: compliant

dataReplicationFactor: 3

stcli cluster upgrade

Upgrades HX Data Platform software to the latest version.

--maintenance Optional. Enter HX maintenance mode.



Syntax

stcli cluster upgrade [-h] (--location LOCATION | --status) [--info] [--vcenter-user VCENTERUSER] [--vcenter-password VCENTERPASSWORD] [--checksum CHECKSUM] [--ucsm-host UCSMHOST][--ucsm-user UCSMUSER] [--ucsm-pwd UCSMPWD][--dryrun]


--location LOCATION Require one from set. Location of the upgrade package. Best case use /tmp on the controller VM.

• Download the upgrade package to your computer.

• Upload it (using scp or a similar tool) to the controller VM of the appliance on which you run the upgrade command.

--status Require one from set. Check for upgrade status.

--checksum CHECKSUM Optional. Checksum of the installer.

--dryrun Optional. Validate cluster upgrade can be possible.

--info Optional. Check for upgrade information.

--ucsm-host UCSMHOST Optional. User name of UCS Manager server.

--ucsm-pwd UCSMPWD Optional. Password of UCS Manager server.

--ucsm-user UCSMUSER Optional. User name of UCS Manager server.



--vcenter-user VCENTERUSER

Optional. User name of vCenter administrator.

stcli cluster upgrade-status

Displays the last known upgrade status of the HX Data Platform software. If the upgrade is in progress, transitional status is listed. Once the upgrade is complete, the status lists this most recent upgrade. This does list if an upgrade is available or you are due for an upgrade.

Syntax

stcli cluster upgrade-status [-h]

Example

# stcli cluster upgrade-status

Sample Response

Cluster upgrade succeeded. Cluster version:<version>


stcli cluster version

Displays the version number of each node in the storage cluster.

Syntax

stcli cluster version [-h]

Example

# stcli cluster version

Sample Response

Cluster version: 1.8(1a)Node ucs-161 version: 1.8(1a)Node ucs-160 version: 1.8(1a)Node ucs-162 version: 1.8(1a)


5 Datastore Commands

This section lists and describes commands to add, remove, mount, unmount, update, and list datastores in the storage cluster.

stcli datastore

Operations for storage cluster datastores.

Syntax

stcli datastore [-h] {list, create, info, update, delete, mount, unmount}


create Require one from set. Creates a storage cluster datastore with the name and size.

delete Require one from set. Deletes a storage cluster datastore.

info Require one from set. Provides information about the specified storage cluster datastore.

list Require one from set. Lists the storage cluster datastores.

mount Require one from set. Mounts a storage cluster datastore.

unmount Require one from set. Unmounts a storage cluster datastore.

update Require one from set. Updates a storage cluster datastore's name and/or size.

stcli datastore create

Creates a storage cluster datastore with the name and size.

Syntax

stcli datastore create [-h] --name NAME --size SIZE [--unit {kb,mb,gb,tb}]


--name NAME Required. Name of storage cluster datastore.

--size SIZE Required. Size of storage cluster datastore.

--unit {kb,mb,gb,tb} Optional. Unit of size.


stcli datastore delete

Deletes a storage cluster datastore.

Syntax

stcli datastore delete [-h] (--id ID | --name NAME)


--id ID Require one from set. ID of storage cluster node. The ID is listed in the stcli cluster info command.

--ip NAME Require one from set. IP address of storage cluster node. The IP is listed in the stcli cluster info command.

stcli datastore info

Provides information about the specified storage cluster datastore.

Syntax

stcli datastore info [-h] (--id ID | --name NAME)




stcli datastore list

Lists the storage cluster datastores.

Syntax

stcli datastore list [-h]

stcli datastore mount

Mounts a storage cluster datastore.

Syntax

stcli datastore mount [-h] (--id ID | --name NAME)




stcli datastore unmount

Unmounts a storage cluster datastore.

Syntax

stcli datastore unmount [-h] (--id ID | --name NAME)




stcli datastore update

Updates a storage cluster datastore's name and/or size.

Syntax

stcli datastore update [-h] (--id ID | --name NAME) [--newname NEWNAME] [--size SIZE] [--unit {kb,mb,gb,tb}]




--newname NEWNAME

Optional. New name of storage cluster datastore.

--size SIZE Optional. New size of storage cluster datastore.

--unit {kb,mb,gb,tb}

Optional. Unit of size.




6 Disk Commands

This section lists and describes commands to add and list disks in the storage cluster.

stcli disk

Operations on the storage cluster disks.

Syntax

stcli disk [-h] {list,add}


add Require one from set. Adds discovered new disks and specified blacklisted disks to the storage cluster.

list Require one from set. Lists the storage cluster disks in the node.

stcli disk add

Adds discovered new disks and specified blacklisted disks to the storage cluster.

Syntax

stcli disk add [-h] (--id ID | --ip NAME) --blacklisted-disk-ids [DISKIDS [DISKIDS ...]]




--blacklisted-disk-ids [DISKIDS [DISKIDS ...]]

Required. Blacklisted disks to add to storage cluster.

stcli disk list

Lists the storage cluster disks in the node.


Syntax

stcli disk list [-h] (--id ID | --ip NAME) [--rescan]


--id ID Require one from set. ID of storage cluster node. The ID is listed in the stcli cluster info command. local defaults to the local node.

--ip NAME Require one from set. IP address of storage cluster node. The IP is listed in the stcli cluster info command. localhost defaults to the local node.

--rescan Optional. Rescan disks.


7 Node Commands

This section lists and describes commands to add, remove, replace and identify storage cluster nodes.

The host or node is the physical hardware on which the VM runs. It provides computing and storage resources such as disk space, memory, processing, power, and network I/O.

This document uses the terms host and node interchangeably.

stcli node

Operations performed on the storage cluster nodes.

Syntax

stcli node [-h] {discover, list, info, identify, disks, disk, add, remove,maintenanceMode}


add Require one from set. Adds the set of nodes to the storage cluster.

discover Require one from set. Lists the storage cluster nodes discoverable on the same subnet as this node.

disk Require one from set. Locate a physical disk in the node.

disks Require one from set. Provides information about the physical disks of the storage cluster node.

identify Require one from set. Turns on/off the node beacon to identify a node.

info Require one from set. Provides information about the specified storage cluster node.

list Require one from set. Lists the storage cluster nodes in the storage cluster.

maintenanceMode Require one from set. Enter or exit maintenance mode.

remove Require one from set. Removes the node from the storage cluster.

stcli node add

Adds the specified nodes to the storage cluster.


Note: Only use the stcli node add command when the storage cluster is online and healthy.

Syntax

stcli node add [-h] --node-ips NODEIPS [NODEIPS ...] [--controller-root-password CONTROLLERPASSWORD][--esx-username ESXUSERNAME]

[--esx-password ESXPASSWORD] [--dryrun]


--node-ips NODEIPS [NODEIPS ...]

Required. IP addresses of nodes to add to the storage cluster.


Optional. Password of the added controller's root user.




Note: When you add a new node to a storage cluster, if the storage cluster is in an Out of Space condition, the system automatically rebalances the storage cluster. Otherwise, it schedules a nightly rebalance.

stcli node discover

Lists the storage cluster nodes discoverable on the same subnet as this node.

Syntax

stcli node discover [-h]

Sample Response

state: storfsIp: addr: stService: gateway: subnetMask: method: host: state: about: serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber:


build: fullName: productVersion: stctlvm: name: ip: guestHostname: storageNetworkIp: moid: role: entityRef: type: id: v name: version: passthrough: guestState: mgmtNetworkIp: name: ip: addr: stService: vlanId: gateway: subnetMask: method: moid: ipmiSettings: addr: stService: gateway: subnetMask: method: ioVisor: about: serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build: fullName: productVersion: state: bootTime: entityRef: type: id: name: vMotionIp: addr: vlanId:


gateway: subnetMask: method: enclosureSerialNumber: entityRef: type: id: name: progress:

stcli node disk

Locate a physical disk in the node.

Syntax

stcli node disk [-h] (--id ID | --ip NAME) [--lighton | --lightoff]




--lighton Optional. Turn the ID light on the disk on.

--lightoff Optional. Turn the ID light on the disk off.

stcli node disks

Provides information about the physical disks of the storage cluster node.

Syntax

stcli node disks [-h] (--id ID | --ip NAME)




stcli node info

Provides information about the specified storage cluster node.


Syntax

stcli node info [-h] (--id ID | --ip NAME) [--summary]





stcli node list

Lists the nodes in the storage cluster.

Syntax

stcli node list [-h] [--summary]



Sample Response

----------------------------------------upgradeState: state: storfsIp: addr: stService: vlanId: gateway: subnetMask: method: pNode: about: serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build: displayVersion: fullName: productVersion: retired: compression: ip:


dedup: nsPrimary: dataWriteThruEnabled: state: bootTime: master: entityRef: type: id: name: version: lastModifiedTime: name: host: state: about: serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build: fullName: productVersion: stctlvm: name: storageClusterIp: ip: guestHostname: mgmtClusterIp: storageNetworkIp: moid: role: entityRef: type: id: name: version: passthrough: guestState: mgmtNetworkIp: name: ip: addr: stService: vlanId: gateway: subnetMask: method: moid: ipmiSettings: addr:


stService: gateway: subnetMask: method: ioVisor: about: serviceType: instanceUuid: name: locale: serialNumber: apiVersion: modelNumber: build: fullName: productVersion: state: bootTime: entityRef: type: id: name: vMotionIp: addr: vlanId: gateway: subnetMask: method: enclosureSerialNumber: entityRef: type: id: name: upgradeVersion: ----------------------------------------

stcli node maintenanceMode

Puts the ESX server in the storage cluster into HX maintenance mode.

Syntax

stcli node maintenanceMode [-h] (--id ID | --ip NAME)

[--mode MODE (enter | exit)] [--timeout TIMEOUT]


--id ID Require one from set. ID of hypervisor to update and put into maintenance mode. The ID is listed in the stcli cluster info command.

--ip NAME Require one from set. IP address of hypervisor. The IP is listed in the stcli cluster info command.


stcli node remove

Removes up to two specified nodes from the storage cluster.

• Before you remove a node from a storage cluster, ensure that DRS is enabled. DRS migrates only powered-on VMs.

• If your network has powered-off VMs, you must manually migrate them to the storage cluster. Otherwise, they are inaccessible after you remove the node.

• If DRS is not enabled, manually migrate the VMs.

• Removing a node requires that the storage cluster is healthy and that removing the node will not reduce the number of available nodes below the minimum 3 nodes which would make the storage cluster unhealthy.

Syntax

stcli node remove [-h] (--id-1 ID1 | --ip-1 NAME1) [-id-2 ID2 | --ip-2 NAME2] [-f]


--id-1 ID 1 Require one from set. ID of first storage cluster node to remove. The ID is listed in the stcli cluster info command.

--id-2 ID 2 Require one from set. ID of second storage cluster node to remove. The ID is listed in the stcli cluster info command.

--ip-1 NAME 1 Require one from set. IP address of first storage cluster node. The IP is listed in the stcli cluster info command.

--ip-2 NAME 2 Require one from set. IP address of second storage cluster node. The IP is listed in the stcli cluster info command.

-f, --force Optional. Forcibly remove storage cluster nodes.

Example

stcli node remove --name esx.SVHOST144A.complab.lab

After the stcli node remove command completes successfully, the system rebalances the storage cluster until the storage cluster state is Healthy. Do not perform any failure tests during this time. The storage cluster health remains Average.

--mode MODE Required. Mode to set (enter | exit).

--timeout TIMEOUT Optional. Set timeout in seconds for maintenance mode.



8 Rebalance Commands

This section lists and describes rebalance commands. Rebalancing enables load distribution across resources in the storage cluster.

stcli rebalance

Rebalance related operations.

Syntax

stcli rebalance [-h] {enable, disable, start, stop, status}


enable Require one from set. Enables storage cluster rebalance.

disable Require one from set. Disables storage cluster rebalance.

start Require one from set. Starts storage cluster rebalance.

stop Require one from set. Stops storage cluster rebalance.

status Require one from set. Gets storage cluster rebalance status.

stcli rebalance enable

Enables you to rebalance the storage cluster. The default value is enabled. You can use this option if you want to enable the storage cluster after you disable it.

Syntax

stcli rebalance enable [-h]

stcli rebalance disable

Disables storage cluster rebalancing so that the system ignores events, cron jobs, or commands that trigger rebalance.

If there is a rebalance process in progress when you run this command, then the system does not stop the current rebalancing. To stop rebalancing, use the stcli rebalance stop command.


The impact of the stcli rebalance disable command persists even after a storage cluster or node power cycle, until you enable it again using the stcli rebalance enable command.

Syntax

stcli rebalance disable [-h]

stcli rebalance start

Starts rebalancing storage cluster resources immediately instead of waiting for events or other schedules.

This command attempts to restore storage cluster availability (if there are storage cluster failures and the storage cluster is not healthy) or balance space utilization evenly across all nodes in the storage cluster.

However, if the storage cluster is in an ENOSPACE condition, the rebalance does not start. Analyze and correct the ENOSPACE condition, then run the stcli rebalance start command.

Syntax

stcli rebalance start [-h] [-f]


-f, --force Optional. Force to start rebalance

stcli rebalance status

Displays the status of the storage cluster rebalance process.

Syntax

stcli rebalance status [-h]

Examples and Sample Responses

The following example shows the status when rebalance is enabled and running.

# stcli rebalance statusrebalanceStatus:rebalanceState: online

percentComplete: 10rebalanceEnabled: True

The following example shows the status when rebalance is enabled, but it is not running.

# stcli rebalance statusrebalanceStatus:rebalanceState: cluster_rebalance_not_runningrebalanceEnabled: True

The following example shows the status when rebalance is disabled, and it is not running.

# stcli rebalance statusrebalanceStatus:rebalanceState: offlinerebalanceEnabled: False


stcli rebalance stop

Halts any ongoing rebalance that you start using the stcli rebalance start command or the system starts due to rebalancing events or schedules. The rebalance process might not stop immediately.

Use the stcli rebalance status command to find the current status or progress of the rebalance process.

If there is no rebalance in progress, this command does not have any impact.

Syntax

stcli rebalance stop [-h]


9 Security Commands

This section lists and describes commands to set the controller VM password in the storage cluster.

stcli security

Security related operations.

Syntax

stcli security [-h] {password,whitelist,ssh}


password Require one from set. Commands supported in the Storage security password manipulation namespace.

ssh Require one from set. Commands supported in the Storage security ssh namespace.

whitelist Require one from set. Commands supported in the Storage security ip whitelist namespace.

stcli security password

SSH key management operations

Syntax

stcli security password [-h] {set}


set Required. Sets user password for all the controller VMs in the storage cluster.

stcli security password set

Sets user password for all the controller VMs in the storage cluster.


Syntax

stcli security password set [-h] [--user USER] [--password PASSWORD]


--user USER Optional. Must be either admin or root. User root is assumed if not specified.

--password PASSWORD Optional. If not supplied, it will be prompted for without echoing keystrokes.

stcli security ssh

SSH key management operations

Syntax

stcli security ssh [-h] {resync} ...


resync Optional. Resyncs SSH keys in storage cluster.

stcli security ssh resync

Resyncs SSH keys in storage cluster.

Syntax

stcli security ssh resync [-h]

stcli security whitelist

IP tables white-listing operations.

Syntax

stcli security whitelist [-h] {list, add, remove, clear}


add Require one from set. Adds IP addresses to IP table white-list.

clear Require one from set. Clears IP addresses from IP table white-list.

list Require one from set. List IP table white-listed entries.

remove Require one from set. Removes IP addresses from IP table white-list.


stcli security whitelist add

Adds IP addresses to the IP table white list.

Adding devices to whitelist

1. Add one device to the whitelist at a time.

2. Wait until the device is repaired and claimed.

3. Add another device to the whitelist.

Syntax

stcli security whitelist add [-h] [--ips IP [IP ...]]

Example

# stcli security whitelist add --ips 10.1.2.3 10.3.4.5

stcli security whitelist clear

Deletes the entire list of IP addresses in the IP table white list.

Syntax

stcli security whitelist clear [-h]

stcli security whitelist list

Displays the list of white list entries in the IP table.

Syntax

stcli security whitelist list [-h]

Example

# stcli security whitelist list

Sample Response

10.1.1.210.1.2.3

stcli security whitelist remove

Deletes the specified IP addresses from the IP table white list.


--ips IP [IP ...] Required. The IP addresses to add to white list.


Syntax

stcli security whitelist remove [-h] [--ips IP [IP ...]]


--ips IP [IP ...] Required. IP addresses to remove from white list

Example

# stcli security whitelist remove --ips 10.1.2.3


10 Services Commands

This section describes the stcli services commands. These apply configuration settings for services associated with the storage cluster.

Services ASUP Commands

This section lists and describes the Cisco Automatic Support (ASUP) commands. ASUP enables you to proactively obtain information about failures and responds immediately. It also helps in planning system performance and capacity.

Note: ASUP relies on SMTP. Before you enable ASUP, ensure that you configure SMTP in your network.

stcli services asup

ASUP configuration operations.

Accompany the base stcli services asup command with one of the positional arguments, or the optional -help option.

Syntax

stcli services asup [-h] {enable, disable, show, recipients}


disable Require one from set. Disables ASUP.

enable Require one from set. Enables ASUP.

recipients Require one from set. Commands to support ASUP recipients list configuration.

show Require one from set. Shows the ASUP configuration.

stcli services asup enable

Enables ASUP support.

Enable ASUP to proactively obtain information about failures and respond immediately. ASUP helps you plan your system performance and capacity.

Configure SMTP before you enable ASUP.


Syntax

stcli services asup enable [-h]

stcli services asup disable

Disables ASUP support.

Syntax

stcli services asup disable [-h]

stcli services asup recipients

ASUP recipient configuration operations.

Accompany the base stcli services asup recipients command with one of the positional arguments, or the optional -help option.

Syntax

stcli services asup recipients [-h] {set,clear,add,remove}


add Require one from set. Adds recipients to the ASUP recipient list.

clear Require one from set. Clears the ASUP recipient list.

remove Require one from set. Removes recipients from the ASUP recipient list.

set Require one from set. Sets the ASUP recipient list.

stcli services asup recipients add

Adds ASUP email recipients to an existing list of ASUP recipients.

Syntax

stcli services asup recipients add [-h] --recipients RECIPIENTS [RECIPIENTS ...]


--recipients RECIPIENTS [RECIPIENTS ...] Required. ASUP recipient list to add.

Example

# stcli services asup recipients add --recipients [email protected] [email protected]

stcli services asup recipients clear

Deletes the entire ASUP recipient list. To remove individual recipients, use asup recipients remove.

Syntax

stcli services asup recipients clear [-h]


stcli services asup recipients remove

Deletes the specified ASUP email recipients from an existing list.

Syntax

stcli services asup recipients remove [-h] --recipients RECIPIENTS [RECIPIENTS ...]


--recipients RECIPIENTS [RECIPIENTS ...]

Required. ASUP recipient list to remove.

Example

# stcli services asup recipients remove --recipients [email protected] [email protected]

stcli services asup recipients set

Sets the ASUP recipient list. Replaces previously set recipients. To add recipients to an existing list, use asup recipients add.

Syntax

stcli services asup recipients set [-h] --recipients RECIPIENTS [RECIPIENTS ...]


--recipients RECIPIENTS [RECIPIENTS ...]

Required. ASUP recipient list to set. Separate email recipients with a space.

Example

# stcli services asup recipients set --recipients [email protected] [email protected]

stcli services asup show

Shows the ASUP configuration, this includes the ASUP recipient list and whether ASUP is enabled or disabled.

Syntax

stcli services asup show [-h]

Example

# stcli services asup show

Sample Response

recipientList: enabled: False


Services DNS Commands

This section lists and describes HX Data Platform Domain Name Server (DNS) commands. DNS is a hierarchical distributed naming system for computers, services, or any resource connected to the Internet or a private network.

stcli services dns

Domain Name Server (DNS) server configuration operations.

Accompany the base stcli services dns command with one of the positional arguments, or the optional -help option.

Syntax

stcli services dns [-h] {show, set, add, remove}


add Require one from set. Adds servers to the DNS server list.

set Require one from set. Sets the DNS server list.

show Require one from set. Shows the DNS server list.

remove Require one from set. Sets the DNS server list.

stcli services dns add

Adds servers to the DNS server list.

Syntax

stcli services dns add [-h] --dns DNSSERVER [DNSSERVER ...]


--dns DNSSERVER [DNSSERVER ...]

Required. DNS server list to add.

Example

# stcli services DNS add --DNS 10.60.8.9

stcli services dns remove

Removes servers from the DNS server list. Default removes all DNS servers.

Syntax

stcli services dns remove [-h] --dns DNSSERVER [DNSSERVER ...]


--dns DNSSERVER [DNSSERVER ...] Optional. DNS server to remove.


Example

# stcli services DNS remove --DNS 10.60.6.7

stcli services dns set

Sets the DNS server list. Replaces previously set DNS servers. To add servers to an existing list, use dns add.

Syntax

stcli services dns set [-h] --dns DNSSERVER [DNSSERVER ...]


--dns DNSSERVER [DNSSERVER ...] Required. DNS server to add to set.

Example

# stcli services DNS set --DNS 10.60.1.1

stcli services dns show

Displays the DNS server list.

Syntax

stcli services dns show [-h]

Example

# stcli services dns show

Sample Response

10.64.1.8 10.64.1.9

Services NTP Commands

This section lists and describes the HX Data Platform Network Time Protocol (NTP) commands.

NTP is a protocol that is used to synchronize computer clock times in a network of computers so that you can correlate events when you receive system logs and other time-specific events from multiple network devices. NTP uses the User Datagram Protocol (UDP) as its transport protocol. All NTP communications use Coordinated Universal Time (UTC).

stcli services ntp

NTP configuration operations.

Accompany the base stcli services ntp command with one of the positional arguments, or the optional -help option.


Syntax

stcli services ntp [-h] {show, set, add, remove}


add Require one from set. Adds servers to the NTP server list.

set Require one from set. Sets the NTP server list.

show Require one from set. Shows the NTP server list.

remove Require one from set. Removes servers from the NTP server list.

stcli services ntp add

Adds NTP servers to the NTP server list in your network.

Syntax

stcli services ntp add [-h] --ntp NTPSERVER [NTPSERVER ...]


--ntp NTPSERVER Required. Specify the NTP server name

Example

# stcli services NTP add --NTP 136.158.1.0

stcli services ntp remove

Deletes NTP servers from the list of servers in your network. Default removes all NTP servers from the list.

Syntax

stcli services ntp remove [-h] --ntp NTPSERVER [NTPSERVER ...]


--ntp NTPSERVER Optional. Specify the NTP server name

Example

# stcli services ntp remove --ntp 136.158.1.0

stcli services ntp set

Sets the NTP server list. Replaces previously set NTP servers. To add servers to an existing list, use ntp add.

Syntax

stcli services ntp set [-h] --ntp NTPSERVER [NTPSERVER ...]


--ntp NTPSERVER [NTPSERVER ...] Required. NTP server to add to the list.


Example

# stcli services NTP set --NTP 10.1.2.3

stcli services ntp show

Displays the NTP server list.

Syntax

stcli services ntp show [-h]

Example

# stcli services ntp show

Sample Response

0.company.pool.ntp.orgntp.ubuntu.com

Services SMTP Commands

This section lists and describes HX Data Platform Simple Mail Transfer Protocol (SMTP) commands. SMTP is an Internet standard for email transmission.

stcli services smtp

SMTP configuration operations. Accompany the base stcli services smtp command with one of the positional arguments, or the optional -help option.

Syntax

stcli services smtp [-h] {show, set, clear}


clear Require one from set. Clears the SMTP configuration.

set Require one from set. Sets the SMTP configuration.

show Require one from set. Shows the SMTP configuration.

stcli services smtp clear

Deletes your current SMTP configuration.

Syntax

stcli services smtp clear [-h]

Example

# stcli services smtp clear


Response

This can be verified by absence of file /etc/msmtprc.

stcli services smtp set

Configures SMTP settings in your network. These SMTP settings overwrite the current settings.

Syntax

stcli services smtp set [-h] --smtp SMTPSERVER --fromaddress FROMADDRESS

Example

# stcli services smtp set --smtp mailhost.eng.mycompany.com --fromAddress [email protected]

Response

This can be verified by checking file /etc/msmtprc.

stcli services smtp show

Displays the SMTP configuration in your network.

Syntax

stcli services smtp show [-h]

Example

# stcli services smtp show

Sample Response

smtpServer: mailhost.eng.mycompany.comfromAddress: [email protected]

Services Time Zone Commands

This section lists and describes the following HX Data Platform timezone commands.

stcli services timezone

Timezone configuration operations.

Accompany the base stcli services timezone command with one of the positional arguments or the optional -help option.


--smtp SMTPSERVER Required. SMTP server.

--fromaddress FROMADDRESS Required. Address to send Auto Support emails from. The address used by the SMTP server to send email notifications to the recipients.


Syntax

stcli services timezone [-h] {show,set}


set Require one from set. Sets the time zone.

show Require one from set. Shows the time zone.

stcli services timezone set

Specifies the time zone for the controller VMs.

Syntax

stcli services timezone set [-h] --timezone TIMEZONE

Example

# stcli services timezone set --timezone America/Los_Angeles

stcli services timezone show

Displays the system time zone that is currently set.

Syntax

stcli services timezone show [-h]

Example

# stcli services timezone show

Sample Response

America/New_York


--timezone TIMEZONE Required. Specify a value for the time zone.

For a list of valid time zone values, go to:

http://manpages.ubuntu.com/manpages/jaunty/man3/DateTime::TimeZone::Catalog.3pm.html

• Ensure that you specify a (case-sensitive) value for the time zone only from this list; for example: Europe/Paris or America/Los_Angeles.

• Any value that is not in this list is invalid.

• If you specify an invalid time zone, the system reverts to GMT.




11 VM Clone, Snapshot, and File Commands

This section lists and describes commands to create and schedule snapshots and clones of VMs on storage cluster nodes.

stcli file

Operations on storage cluster files. This includes VM files.

Syntax

stcli file [-h] {clone}


clone Require one from set. Creates a clone for the given file.

stcli file clone

Creates a clone for the given file.

Syntax

stcli file clone [-h] --name NAME --clone CLONE [--readonly] [--thick]


--name NAME Required. Name of the file to be cloned.

--clone CLONE Required. Name of the clone.

--readonly Optional. Read only clone.

--thick Optional. Thick clone.

stcli snapshot-schedule

Enables or disables Snapshot Schedules for all the objects in this cluster.


Syntax

stcli snapshot-schedule [-h] (--enable | --disable)


--enable Require one from set. Enable the snapshot schedule.

--disable Require one from set. Disable the snapshot schedule.

stcli vm

HX Data Platform VM clone and snapshot operations.

Accompany the base stcli vm command with one of the positional arguments or the optional -help option.

Syntax

stcli vm [-h] {clone,snapshot}


clone Require one from set. Creates a specified number of clones for the given VM.

snapshot Require one from set. Creates a native snapshot for the given VM.

stcli vm clone

Creates a specified number of ReadyClones for the given VM.

Syntax

stcli vm clone [-h] (--id ID | --name NAME) --clone CLONE --number NUMBER [--poweron] [--custspec CUSTSPEC] [--guestname GUESTNAME] [--startnumber STARTNUMBER][--increment INCREMENT] [--resourcepool-id RP-ID | --resourcepool-name RP-NAME]


--clone CLONE Required. Name of the clone.

--id ID Require one from set. ID of the VM to be cloned. The ID is listed in the stcli cluster info command.

--name NAME Require one from set. Name of the VM to be cloned. The IP is listed in the stcli cluster info command.

--number NUMBER Required. Number of clones required.

--custspec CUSTSPEC Optional. Guest Customization spec for the cloned VM(s).


stcli vm snapshot

Creates a native snapshot for the given VM.

Syntax

stcli vm snapshot [-h] (--id ID | --name NAME | --folder-id FOLDER-ID | --folder-name FOLDER-NAME |--resourcepool-id RP-ID | --resourcepool-name RP-NAME)

--snapshot SNAPSHOT [--desc DESC] [--snapshot-for-backup] [--memory | --quiesce]


--snapshot SNAPSHOT Required. Name of the snapshot.

--folder-id FOLDER-ID Require one from set. ID of the VM folder to take a snapshot.

--folder-name FOLDER-NAME Require one from set. Name of the VM folder to take a snapshot.

--id ID Require one from set. ID of the VM to take a snapshot. The ID is listed in the stcli cluster info command.

--name NAME Require one from set. Name of the VM to take a snapshot.

--resourcepool-id RP-ID Require one from set. ID of the resource pool to take a snapshot.

--resourcepool-name RP-NAME

Require one from set. Name of the resource pool to take a snapshot.

--desc DESC Optional. Description of the snapshot.

--memory Optional. Memory snapshot.

--quiesce Optional. Quiesce the file system in the virtual machine.

--snapshot-for-backup Optional. Snapshot for backup purposes.

--guestname GUESTNAME Optional. Specify a guest name for the cloned VM(s) to be different from VM name.

Default is the DNS name for the host. This name must be DNS resolvable before specifying it.

--increment INCREMENT Optional. Increment of the suffix for the VM clones.

--poweron Optional. Power on after cloning.

--resourcepool-id RP-ID

Optional. ID of the Resource pool to place the cloned VM(s) on.

--resourcepool-name RP-NAME

Optional. Name of the Resource pool to place the cloned VM(s) on.

--startnumber STARTNUMBER

Optional. Start number suffix for the VM clone name.


cisco hx data platform command line - cisco - …€¦ · cisco hx data platform command line...

Documents