Cisco HX Data Platform Command Line
Interface Reference
Version 1.7.1 Release
Cis
Copyright© 2014-2016 Cisco Systems, Inc.— All rights reserved.
The contents of this document may not be copied or duplicated in any form, in whole or in part, without the prior written permission of Cisco Systems, Inc..
The information in this document is subject to change without notice. Cisco Systems, Inc. shall not be liable for any damages resulting from technical errors or omissions which may be present in this document, or from use of this document.
This document is an unpublished work protected by the United States copyright laws and is proprietary to Cisco Systems, Inc. Disclosure, copying, reproduction, merger, translation, modification, enhancement, or use of this document by anyone other than authorized employees, authorized users, or licensees of Cisco Systems, Inc.without the prior written consent of Cisco Systems, Inc.is prohibited.
TrademarksCisco HyperFlex Systems, Cisco HX Data Platform, and the Cisco logo are trademarks of Cisco Systems, Inc. Inc.
All other trademarked names used in this document are the properties of their respective owners and are used for identification purposes only.
Company Information
Document InformationProduct Name: Cisco HX Data Platform
Product Version: 1.7.1
Document Name: Cisco HX Data Platform Command Line Interface Reference
Document Updated: April 21, 2016
co HX Data Platform Command Line Interface Reference 2
Contents
1 Welcome to Cisco HX Data Platform! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Contacting Technical Assistance Center (TAC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Downloading Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
2 stcli Commands Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Login to the HX Data Platform Storage Controller VM Command Line . . . . . . . . . . . . . . . . . . . . . . . . .9
Command Syntax Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
stcli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
stcli -h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
stcli about. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
stcli services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
3 Appliance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12stcli appliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
stcli appliance discover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
stcli appliance list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
4 Cleaner Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16stcli cleaner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
stcli cleaner info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
stcli cleaner get-schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
stcli cleaner report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
stcli cleaner set-schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
stcli cleaner start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
stcli cleaner stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
stcli cleaner stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
5 Cluster Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21stcli cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
stcli cluster create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
stcli cluster create-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
stcli cluster disable-data-write-thru . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Cisco HX Data Platform Command Line Interface Reference 3
stcli cluster enable-data-write-thru . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
stcli cluster get-cluster-access-policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
stcli cluster get-data-replication-factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
stcli cluster info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
stcli cluster prepare. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
stcli cluster recreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
stcli cluster refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
stcli cluster reregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
stcli cluster set-cluster-access-policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
stcli cluster shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
stcli cluster start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
stcli cluster storage-summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
stcli cluster upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
stcli cluster upgrade-status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
stcli cluster version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
6 Datastore Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34stcli datastore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
stcli datastore create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
stcli datastore delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
stcli datastore info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
stcli datastore list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
stcli datastore mount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
stcli datastore unmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
stcli datastore update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
7 Disk Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37stcli disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
stcli disk add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
stcli disk list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
8 File ReadyClone Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39stcli file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
stcli file clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
9 Node Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40stcli node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
stcli node add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
stcli node discover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
stcli node disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
stcli node disks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
stcli node identify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
stcli node info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
stcli node list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
stcli node maintenanceMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Cisco HX Data Platform Command Line Interface Reference 4
stcli node remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
stcli node replace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
10 Rebalance Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45stcli rebalance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
stcli rebalance enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
stcli rebalance disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
stcli rebalance start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
stcli rebalance status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
stcli rebalance stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
11 Security Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48stcli security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
stcli security password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
stcli security password set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
stcli security ssh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
stcli security ssh resync. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
stcli security whitelist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49
stcli security whitelist add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
stcli security whitelist clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
stcli security whitelist list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
stcli security whitelist remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
12 Services ASUP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52stcli services asup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
stcli services asup enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
stcli services asup disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
stcli services asup recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
stcli services asup recipients add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
stcli services asup recipients clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
stcli services asup recipients remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
stcli services asup recipients set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
stcli services asup show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
13 Services DNS Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56stcli services dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
stcli services dns add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
stcli services dns remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
stcli services dns set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
stcli services dns show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
14 Services NTP Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59stcli services ntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
stcli services ntp add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
stcli services ntp remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Cisco HX Data Platform Command Line Interface Reference 5
stcli services ntp set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
stcli services ntp show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
15 Services SMTP Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62stcli services smtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
stcli services smtp clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
stcli services smtp set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
stcli services smtp show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
16 Services Time Zone Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64stcli services timezone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
stcli services timezone set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
stcli services timezone show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
17 VM Clone and Snapshot Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66stcli vm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
stcli vm clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
stcli vm snapshot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Cisco HX Data Platform Command Line Interface Reference 6
1 Welcome to Cisco HX Data Platform!
The Cisco HX Data Platform enables seamless interoperability between computing and storage in virtual environments. The HX Data Platform reduces storage complexity in virtual environments by providing administrative actions that are natural extensions to hypervisor management. The HX Data Platform provides a highly fault-tolerant distributed storage system that preserves data integrity and optimizes performance for virtual machine (VM) storage workloads.
About This Guide
•
This document describes how to administer, monitor, and manage your storage cluster using the Cisco HX Data Platform command line interface. It assumes that you have installed the Cisco HX Data Platform and created the storage cluster.
Any cluster, including the storage cluster, is a group of nodes (hosts). The HX Data Platform manages the storage resources of all nodes contained in the storage cluster.
Intended Audience
This guide is written for network, storage, and VM administrators, as well as, others familiar with virtualization, networking, and storage setup and configuration.
Contacting Technical Assistance Center (TAC)
Downloading Documentation
You can download the latest version of the following Cisco documents from:
https://support.cisco.com
See the listed Cisco document for the associated tasks.
To perform the following See the document
Review a list of new features, known issues, and workarounds. Release Notes for Cisco HX Data Platform
Cisco HX Data Platform Command Line Interface Reference 7
Conventions
Throughout the HX Data Platform documentation the following visual and text conventions are used.
Install and complete initial setup of your HX Data Platform. Cisco HyperFlex Systems Getting Started Guide
Administer, manage, and monitor your storage cluster using the HX Data Platform plug-in on your VMware vSphere Web Client.
Cisco HyperFlex Systems Administration Guide
Administer, manage, and monitor your storage cluster using the HX Data Platform command line interface on a controller VM.
Cisco HX Data Platform Command Line Interface Reference
Format Use
code For command line content.
code input Commands you enter.
code variable Placeholder for a name that varies depending upon your environment. You provide the actual value in the command string.
interface Items in a graphical user interface (GUI) that you select or click. Items can include menus, menu options, fields, pages, tabs, or panel names, and areas of pages or panels. Typically used when part of a step.
interface variable Placeholder for the names of items you select. For example, cluster for the name of your specific storage cluster. Typically used when part of a step.
term. The item being described in a definition.
emphasis Title of a section or boot, item for emphasis, or plain text variable.
Path > name > Object1 | Object2
Breadcrumb style is used to list a sequence of selections in the GUI. Selections can be pages, tabs, menus, widgets, portlets, panes, panels, or fields. Actions used to select an object in a path can include click, drag, highlight, expand, open, or scroll.
The right caret (>) indicates go to next in sequence. The pipe (|) character indicates choices.
Command syntax For the context of this guide:
square brackets [ ] list optional parameters.
curly braces { } list positional parameters. One or more of these are required to run the command.
parenthesis ( ) list of options, where at least one option that is required.
ellipses . . . means that additional information is required to support the positional parameters or multiple iterations allowed.
To perform the following See the document
Cisco HX Data Platform Command Line Interface Reference 8
2 stcli Commands Overview
This section lists and describes the HX Data Platform stcli commands.
• Login to the HX Data Platform Storage Controller VM Command Line
• stcli
• stcli -h
• stcli about
• stcli services
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 optional.
Cisco HX Data Platform Command Line Interface Reference 9
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, cluster, appliance, node, disk, cleaner, datastore, file, security, rebalance}
stcli -h
Help option on all stcli commands.
Syntax
stcli <command> [-h]
Parameters Description
about About HX Data Platform.
appliance Commands supported in the HX Data Platform appliance namespace.
cleaner Commands supported in the HX Data Platform cleaner namespace.
cluster Commands supported in the HX Data Platform cluster namespace.
datastore Commands supported in the HX Data Platform datastore namespace.
disk Commands supported in the HX Data Platform disk namespace.
file Commands supported in the HX Data Platform file namespace.
node Commands supported in the HX Data Platform node namespace. A HX Data Platform node is comprised of a hypervisor node and the controller VM and uses the hypervisor ID/IP for identification.
rebalance Commands supported in the HX Data Platform rebalance namespace.
security Commands supported in the HX Data Platform security namespace.
services Commands supported in the HX Data Platform system services namespace.
vm Commands supported in the HX Data Platform vm namespace.
Parameter Description
-h, --help Shows the help message relative to the listed command and exits.
Cisco HX Data Platform Command Line Interface Reference 10
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: bb1856be-6732-442d-8a8d-20fb9a4d6896
name: StorageController
locale: English (United States)
serialNumber:
apiVersion: 0.1
modelNumber: HX220C-M4S
build: 1.7.1.0-14778 (RC2)
fullName: HX Data Platform StorageController 1.7.1productVersion: 1.7.1-14778
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}
Parameter Description
asup Commands supported in the HX Data Platform ASUP configuration namespace.
dns Commands supported in the HX Data Platform DNS configuration namespace.
ntp Commands supported in the HX Data Platform NTP configuration namespace.
smtp Commands supported in the HX Data Platform SMTP configuration namespace.
timezone Commands supported in the HX Data Platform Timezone configuration namespace.
Cisco HX Data Platform Command Line Interface Reference 11
3 Appliance Commands
This section lists and describes commands to list and discover appliances in storage cluster.
This section describes the following appliance commands:
• stcli appliance
• stcli appliance discover
• stcli appliance list
stcli appliance
Appliance operations.
Syntax
stcli appliance [-h] {list,discover} ...
stcli appliance discover
Discover new HX Data Platform 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 HX Data Platform appliances in the storage cluster.
Syntax
stcli appliance list [-h]
Parameter Description
list Lists the HX Data Platform appliances in the storage cluster.
discover Discover new HX Data Platformappliances in the network.
Cisco HX Data Platform Command Line Interface Reference 12
Sample Response
ps:
----------------------------------------
status: green
name: Power Supply 1: Running/Full Power-Enabled
----------------------------------------
status: green
name: Power Supply 1 PS1 Status: Power Supply AC lost - Deassert
----------------------------------------
status: green
name: Power Supply 1 PS1 Status: Failure status - Deassert
----------------------------------------
status: green
name: Power Supply 1 PS1 Status: Predictive failure - Deassert
----------------------------------------
serialNumber: S10584723011481
disks:
EntityRef(type=10, id='55cd2e404b403e4b:0000000000000000', name='/dev/sdb'):
status: online
serialNumber: BTWL330107SA480QGN
capacity: 447.1G
slotNumber: 1.1.1
logicalname: /dev/sdb
modelNumber: INTEL_SSDSC2BB480G4
entityRef:
type: pdisk
id: 55cd2e404b403e4b:0000000000000000
name: /dev/sdb
version: D2010355
vendor: Intel
EntityRef ...
nodes:
A:
upgradeState: ok
state: online
storfsIp:
addr: 10.104.48.24
stService: stctl
vlanId: 311
gateway: 10.104.48.1
subnetMask: 255.255.240.0
method: static
pNode:
about:
serviceType: sysmAgent
instanceUuid: e1ce07f0564d6079:dc5e56461d30755f
name: company
locale: en-US
serialNumber: unset
apiVersion: 0.0.1
modelNumber: unset
build: 1.7-release-13996
fullName: companyCluster-1.7.0
Cisco HX Data Platform Command Line Interface Reference 13
productVersion: 1.7.0-13996
retired: False
compression: True
ip: 10.104.48.24
disks:
----------------------------------------
medium: rotational
capacity: 931.5G
state: ready
version: 0
entityRef:
type: disk
id: 5000c500642de6db:0000000000000000
usage: persistence
path: /dev/sde
lastModifiedTime: 1448936785000
usedCapacity: 8.9G
----------------------------------------
...
host:
about:
serviceType: HostAgent
instanceUuid: 00000000-0000-0000-0000-002590d423b2
name: VMware ESXi
locale: English (United States)
serialNumber: 0123456789
apiVersion: 5.5
modelNumber: X9DRT
build: 2105019
fullName: VMware ESXi 5.5.0 build-2105019
productVersion: 5.5.0
stctlvm:
name: stCtlVM-cs-002a
ip: 10.104.48.24
guestHostname: cs002-stctlvm-a.eng.storvisor.com
mgmtClusterIp: 10.104.32.32
storageNetworkIp: 10.104.48.24
moid: vm-761
role: storage
entityRef:
type: virtmachine
id: vm-761
name: stCtlVM-cs-002a
version: 2.1.1
passthrough: pci
guestState: running
mgmtNetworkIp: 10.104.32.20
name: cs-002a
state: online
ip:
addr: 10.104.32.21
stService: hypervisor
vlanId: 0
gateway: 10.104.32.1
Cisco HX Data Platform Command Line Interface Reference 14
subnetMask: 255.255.240.0
method: static
moid: host-755
ipmiSettings:
addr: 10.104.32.20
stService: ipmi
gateway: 10.104.32.1
subnetMask: 255.255.240.0
method: dhcp
ioVisor:
about:
serviceType: scvmclient
instanceUuid:
name: company I/O Visor
locale:
serialNumber:
apiVersion:
modelNumber:
build:
fullName: company I/O Visor
productVersion: 1.7.0-13996
state: online
bootTime: 0
entityRef:
type: node
id: 00000000-0000-0000-0000-002590d423b2
name: cs-002a
vMotionIp:
addr: 10.104.48.20
vlanId: 311
gateway: 10.104.32.1
subnetMask: 255.255.240.0
method: static
enclosureSerialNumber: S10584723011481
entityRef:
type: node
id: 00000000-0000-0000-0000-002590d423b2
name: cs-002a
progress:
----------------------------------------
completion: 100
parent:
type: node
id: 00000000-0000-0000-0000-002590d423b2
name: 10.104.48.24
name: Disk Prepare /dev/sdf
state: succeeded
entity:
type: disk
id: 5000c500642dd345:0000000000000000
description: Used magnetic disk /dev/sdf
----------------------------------------
progress ...
nodes ...
Cisco HX Data Platform Command Line Interface Reference 15
4 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.
Topics include:
• stcli cleaner
• stcli cleaner info
• stcli cleaner get-schedule
• stcli cleaner report
• stcli cleaner set-schedule
• stcli cleaner start
• stcli cleaner stats
Cisco HX Data Platform Command Line Interface Reference 16
• stcli cleaner stop
stcli cleaner
Storage cluster cleaner operations.
Syntax
stcli cleaner [-h] {info, start, stop, stats, report, get-schedule, set-schedule}
stcli cleaner info
Returns information about the HX Data Platform cleaner for the specified node.
Syntax
stcli cleaner info [-h] [--id ID | --ip NAME]
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.
Parameter Description
info Provides information about the specified HX Data Platform cleaner.
get-schedule Reports cleaner high priority schedule
report Reports space reclaimed from cleaner.
set-schedule Sets cleaner high priority schedule
start Starts HX Data Platform cleaner.
stats Collects cleaner stats.
stop Stops HX Data Platform cleaner.
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Cisco HX Data Platform Command Line Interface Reference 17
stcli cleaner get-schedule
Returns the cleaner priority schedule state for all the nodes in the storage cluster.
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: False
endTime: 6
startTime: 6
{ 'type': 'node', 'id': '9d772ab3-9992-ce44-8b8a-fd66a970f91b', 'name': '10.65.10.193' }:
policyActive: False
endTime: 6
startTime: 6
{ 'type': 'node', 'id': '1dfc7bd3-0a8c-1547-b0fe-5f7425ca44fc', 'name': '10.65.10.194' }:
policyActive: False
endTime: 6
startTime: 6
policyActive:False: The cleaner is running at normal Priority.
policyActive:True: The cleaner is running at high Priority.
stcli cleaner report
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.0
compressionSavings: 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]
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Parameter Description
--id ID ID of storage cluster node
Cisco HX Data Platform Command Line Interface Reference 18
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.
Syntax
stcli cleaner set-schedule [-h] [--id ID | --ip NAME] --starttime begin_hour --endtime end_hour
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.
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]
--ip NAME IP address of storage cluster node
--start Start the cleaner
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
--starttime Sets running time start time. UTC (hours in 24 hour format)
--endtime Set running time end time. UTC (hours in 24 hour format)
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Parameter Description
Cisco HX Data Platform Command Line Interface Reference 19
stcli cleaner stats
Collects cleaner stats.
Syntax
stcli cleaner stats [-h] [--id ID | --ip NAME] [--start]
stcli cleaner stop
Stops the cleaner processes.
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. See stcli cleaner start.
Syntax
stcli cleaner stop [-h] [--id ID | --ip NAME]
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
--start Start cleaner
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Cisco HX Data Platform Command Line Interface Reference 20
5 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.
This section describes the following cluster commands:
• stcli cluster
• stcli cluster create
• stcli cluster create-config
• stcli cluster disable-data-write-thru
• stcli cluster enable-data-write-thru
• stcli cluster get-cluster-access-policy
• stcli cluster get-data-replication-factor
• stcli cluster info
• stcli cluster prepare
• stcli cluster recreate
• stcli cluster refresh
• stcli cluster reregister
• stcli cluster set-cluster-access-policy
• stcli cluster shutdown
• stcli cluster start
• stcli cluster storage-summary
• stcli cluster upgrade
• stcli cluster upgrade-status
• stcli cluster version
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.
Cisco HX Data Platform Command Line Interface Reference 21
Syntax
stcli cluster [-h] {prepare,create,info,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}
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
Parameter Description
create Creates a storage cluster with the name and the given nodes identified by IP addresses.
create-config Creates a storage cluster from a configuration file.
disable-data-write-thru Disable data write through on the storage cluster.
enable-data-write-thru Enable data write through on the storage cluster.
get-cluster-access-policy Gets storage cluster Cluster Access Policy.
get-data-replication-factor Gets storage cluster Data Replication Factor.
info Provides information about the currently configured storage cluster.
prepare Prepares network configuration for storage cluster for the set of nodes identified by IP addresses.
recreate Recreates an existing storage cluster with force option.
refresh Refreshes storage cluster status.
reregister Reregister an existing storage cluster from one vCenter to another.
set-cluster-access-policy Sets storage cluster Cluster Access Policy.
shutdown Shuts down storage cluster.
start Starts storage cluster.
storage-summary Provides storage summary about the currently configured storage cluster.
upgrade Upgrades storage cluster.
upgrade-status Provides information about storage cluster upgrade status.
version Provides information about storage cluster version.
Cisco HX Data Platform Command Line Interface Reference 22
[--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]
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]
config
Parameter Description
--name NAME Name of storage cluster.
--ip IP IP of storage cluster.
--mgmt-ip MGMTIP IP of management server.
--vcenter-datacenter DATACENTER Name of vCenter datacenter.
--vcenter-cluster VCENTERCLUSTER Name of vCenter cluster.
--vcenter-url VCENTERURL URL of vCenter, https://vcserver/sdk.
--vcenter-sso-url VCENTERSSOURL URL of vCenter SSO server. This is inferred from --vcenter-url if not specified.
--vcenter-user VCENTERUSER User name of vCenter administrator.
--vcenter-password VCENTERPASSWORD Password of vCenter administrator.
--controller-root-password CONTROLLERPASSWORD Password of controller VM's root user. All nodes must have the same password.
--node-ips NODEIPS [NODEIPS ...] IPs of storage cluster nodes to add to storage cluster.
--data-replication-factor {2,3} Data Replication Factor (2 or 3).
--cluster-access-policy {strict,lenient} Cluster Access Policy (strict or lenient).
--vdi-only-deployment Set Workload Type as VDI.
-f, --force Force to create storage cluster.
--dryrun Only validate input parameters.
Parameter Description
config Configuration of storage cluster.
-f, --force Force to create storage cluster.
Cisco HX Data Platform Command Line Interface Reference 23
stcli cluster disable-data-write-thru
Disable data write through on 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.
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
strict
--dryrun Only validate input parameters.
--vcenter-user VCENTERUSER User name of vCenter administrator.
--vcenter-password VCENTERPASSWORD Password of vCenter administrator.
[--controller-root-password CONTROLLERPASSWORD]
Password of controller VM's root user
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Parameter Description
Cisco HX Data Platform Command Line Interface Reference 24
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]
Example
# stcli cluster info
Sample Response
about:
serviceType:
instanceUuid:
name:
locale:
serialNumber:
apiVersion:
modelNumber:
build:
fullName:
productVersion:
vCluster:
state:
boottime:
entityRef:
type:
id:
name: c
virtNodes:
----------------------------------------
type: virtnode
id:
----------------------------------------
. . .
virtDatastores:
Parameter Description
--summary Display summary only.
Cisco HX Data Platform Command Line Interface Reference 25
upgradeState:
cluster:
healthState:
capacity:
compliance:
state:
activeNodes:
uptime:
resiliencyDetails:
current ensemble size:
# of ssd failures before cluster shuts down:
minimum cache copies remaining:
minimum data copies availble for some user data:
minimum metadata copies available for cluster metadata:
# of unavailable nodes:
# of nodes failure tolerable for cluster to be available:
health state reason:storage cluster is healthy.
# of node failures before cluster shuts down:
# of node failures before cluster goes into readonly:
# of hdd failures tolerable for cluster to be available:
# of node failures before cluster goes to enospace warn trying to move the existing data:
# of hdd failures before cluster shuts down:
# of hdd failures before cluster goes into readonly:
# of ssd failures before cluster goes into readonly:
# of ssd failures tolerable for cluster to be available:
boottime:
entityRef:
type: cluster
id:
downtime:
freeCapacity:
usedCapacity:
config:
clusterUuid:
ip:
dataReplicationFactor:
clusterAccessPolicy:
size:
nodes:
----------------------------------------
type:
id:
name:
----------------------------------------
. . .
rawCapacity:
state:
stNodes:
----------------------------------------
type:
id:
name:
----------------------------------------
Cisco HX Data Platform Command Line Interface Reference 26
. . .
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:
stService:
vlandId:
gateway:
subnetMask:
method:
vCenterDatacenter:
ip:
addr:
stService:
vlandId:
gateway:
subnetMask:
method:
vCenterClusterName:
dataReplicationFactor:
workloadType:
vCenterSSOURL:
vCenterClusterId:
nodeIPSettings:
Cisco HX Data Platform Command Line Interface Reference 27
node-002d:
----------------------------------------
addr:
stService:
vlanId:
gateway:
subnetMask:
method:
----------------------------------------
node-002b:
. . .
node-002c:
. . .
node-002a:
. . .
vCenterDatacenterId:
clusterAccessPolicy:
vCenterURL:
dnsServers:
size:
stcli cluster prepare
Prepares network configuration for the storage cluster for the set of nodes identified by IP addresses.
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]
Parameter Description
--node-ips NODEIPS [NODEIPS ...] IPs of storage cluster nodes to add to configure. Required if --config not used.
--config CONFIG Network configuration file. Required if --node-ips is not used.
--hypervisor-ips HYPERVISORIPS [HYPERVISORIPS ...]
IPs of hypervisor to be applied.
--storfs-ips STORFSIPS [STORFSIPS ...] IPs of storFS to be applied.
--ipmi-ips IPMIIPS [IPMIIPS ...] IPs of IPMI to be applied.
--vmotion-ips VMOTIONIPS [VMOTIONIPS ...] IPs of vMotion to be applied.
--netmask NETMASK Subnet mask.
Cisco HX Data Platform Command Line Interface Reference 28
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]
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.
--gateway GATEWAY Default gateway.
--vlan VLAN VLAN Tag.
--netmask1 NETMASK1 Subnet mask1.
--gateway1 GATEWAY1 Default gateway1.
--vlan1 VLAN1 VLAN Tag1.
--dns DNS [DNS ...] IPs of DNS server.
--ntp NTP [NTP ...] IPs of NTP server.
--timezone TIMEZONE Timezone.
--smtp SMTPSERVER SMTP server.
--fromaddress FROMADDRESS Address to send Auto Support emails from.
--dryrun Only validate input parameters.
Parameter Description
--vcenter-user VCENTERUSER User name of vCenter administrator.
--vcenter-password VCENTERPASSWORD Password of vCenter administrator.
--controller-root-password CONTROLLERPASSWORD Password of controller VM's root user. All nodes must have the same password.
Parameter Description
Cisco HX Data Platform Command Line Interface Reference 29
Syntax
stcli cluster reregister [-h] [--vcenter-datacenter NEWDATACENTER]
[--vcenter-cluster NEWVCENTERCLUSTER]
--vcenter-url NEWVCENTERURL
[--vcenter-sso-url NEWVCENTERSSOURL]
--vcenter-user NEWVCENTERUSER
[--vcenter-password NEWVCENTERPASSWORD]
stcli cluster set-cluster-access-policy
Sets storage cluster Cluster Access Policy.
Syntax
stcli cluster set-cluster-access-policy [-h] --name {strict,lenient}
Sample Response
strict
stcli cluster shutdown
Stops storage cluster operations and shuts it down
Syntax
stcli cluster shutdown [-h] [--formatchange] [--maintenance]
Parameter Description
--vcenter-datacenter NEWDATACENTER Name of the NEW vCenter datacenter.
--vcenter-cluster NEWVCENTERCLUSTER Name of the NEW vCenter cluster.
--vcenter-url NEWVCENTERURL URL of the NEW vCenter, https://newvc/sdk
--vcenter-sso-url NEWVCENTERSSOURL URL of the NEW vCenter SSO server. Default infers from --vcenter-url if not specified.
--vcenter-user NEWVCENTERUSER User name of the NEW vCenter administrator.
--vcenter-password NEWVCENTERPASSWORD Password of the NEW vCenter administrator.
Parameter Description
--name {strict,lenient} Name of the storage cluster Cluster Access Policy (strict or lenient)
Parameter Description
--formatchange Enable disk format change.
--maintenance Enter maintenance mode.
Cisco HX Data Platform Command Line Interface Reference 30
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.28
name: cs002-cl
state: online
uptime: 6 days 22 hours 16 minutes 46 seconds
activeNodes: 4 of 4
compressionSavings: 0.0
deduplicationSavings: 0.0
freeCapacity: 449.4G
resiliencyDetails:
# of nodes failure tolerable for cluster to be available:1
health state reason:storage cluster is healthy.
spaceStatus: normal
totalCapacity: 496.8G
totalSavings: 0.0
usedCapacity: 47.4G
clusterAccessPolicy: strict
dataReplicationCompliance: compliant
dataReplicationFactor: 3
stcli cluster upgrade
Upgrades HX Data Platform software to the latest version.
Syntax
stcli cluster upgrade [-h] (--location LOCATION | --status)
[--info] [--vcenter-user VCENTERUSER]
[--vcenter-password VCENTERPASSWORD] [--checksum CHECKSUM]
Cisco HX Data Platform Command Line Interface Reference 31
Example
$ stcli cluster upgrade --location /tmp/upgrade/storfs-packages-1.7.0-13996.tgz --vcenter-user root --vcenter-password vmware
Sample Response
Cluster is upgrading to version 1.7.0-13996
You may be disconnected from this session during upgrade
Upgrading nodes: [10.65.13.12]
Waiting for Node 10.65.13.12 ... ['Upgrading Storage Node 10.65.13.12']
Nodes waiting to upgrade: [10.65.13.10, 10.65.13.11, 10.65.13.13]
Upgrading nodes: [10.65.13.12]
................ output truncated.......................
stcli cluster upgrade-status
Displays the status of the HX Data Platform software upgrade.
Syntax
stcli cluster upgrade-status [-h]
Example
# stcli cluster upgrade-status
Sample Response
Cluster upgraded
stcli cluster version
Displays the version number of each node in the storage cluster
Parameter Description
--location LOCATION Location of the upgrade package.
• 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 Check for upgrade status.
--info Check for upgrade information.
--vcenter-user VCENTERUSER User name of vCenter administrator.
--vcenter-password VCENTERPASSWORD Password of vCenter administrator.
--checksum CHECKSUM Checksum of the installer.
Cisco HX Data Platform Command Line Interface Reference 32
Syntax
stcli cluster version [-h]
Example
# stcli cluster version
Sample Response
Cluster version: 1.7.1-14778
Node cs-002c version: 1.7.1-14778
Node cs-002a version: 1.7.1-14778
Node cs-002d version: 1.7.1-14778
Node cs-002b version: 1.7.1-14778
Cisco HX Data Platform Command Line Interface Reference 33
6 Datastore Commands
This section lists and describes commands to add, remove, mount, unmount, update, and list datastores in the storage cluster.
This section describes the following datastore commands:
• stcli datastore
• stcli datastore create
• stcli datastore delete
• stcli datastore info
• stcli datastore list
• stcli datastore mount
• stcli datastore unmount
• stcli datastore update
stcli datastore
Operations for storage cluster datastores.
Syntax
stcli datastore [-h] {list, create, info, update, delete, mount, unmount}
Parameter Description
create Creates a storage cluster datastore with the name and size.
delete Deletes a storage cluster datastore.
info Provides information about the specified storage cluster datastore.
list Lists the storage cluster datastores.
mount Mounts a storage cluster datastore.
unmount Unmounts a storage cluster datastore.
update Updates a storage cluster datastore's name and/or size.
Cisco HX Data Platform Command Line Interface Reference 34
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}]
stcli datastore delete
Deletes a storage cluster datastore.
Syntax
stcli datastore delete [-h] (--id ID | --name NAME)
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]
Parameter Description
--name NAME Name of storage cluster datastore
--size SIZE Size of storage cluster datastore
--unit {kb,mb,gb,tb} Unit of size
Parameter Description
--id ID ID of storage cluster datastore
--name NAME Name of storage cluster datastore
Parameter Description
--id ID ID of storage cluster datastore
--name NAME Name of storage cluster datastore
Cisco HX Data Platform Command Line Interface Reference 35
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}]
Parameter Description
--id ID ID of storage cluster datastore
--name NAME Name of storage cluster datastore
Parameter Description
--id ID ID of storage cluster datastore
--name NAME Name of storage cluster datastore
Parameter Description
--id ID ID of storage cluster datastore
--name NAME Name of storage cluster datastore
--newname NEWNAME New name of storage cluster datastore
--size SIZE New size of storage cluster datastore
--unit {kb,mb,gb,tb} Unit of size
Cisco HX Data Platform Command Line Interface Reference 36
7 Disk Commands
This section lists and describes commands to add and list disks in the storage cluster.
This section describes the following disk commands:
• stcli disk
• stcli disk add
• stcli disk list
stcli disk
Operations on the storage cluster disks.
Syntax
stcli disk [-h] {list,add}
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 ...]]
Parameter Description
add Adds discovered new disks and specified blacklisted disks to the storage cluster.
list Lists the storage cluster disks in the node.
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
--blacklisted-disk-ids [DISKIDS [DISKIDS ...]] Blacklisted disks to add to storage cluster
Cisco HX Data Platform Command Line Interface Reference 37
stcli disk list
Lists the storage cluster disks in the node.
Syntax
stcli disk list [-h] (--id ID | --ip NAME) [--rescan]
Parameter Description
--id ID ID of storage cluster node. local defaults to the local node
--ip NAME IP address of storage cluster node. localhost defaults to the local node
--rescan Rescan disks
Cisco HX Data Platform Command Line Interface Reference 38
8 File ReadyClone Commands
This section lists and describes commands to create ReadyClones of VMs in the storage cluster.
This section describes the following file commands:
• stcli file
• stcli file clone
stcli file
Operations on storage cluster files. This includes VM files.
Syntax
stcli file [-h] {clone}
stcli file clone
Creates a clone for the given file.
Syntax
stcli file clone [-h] --name NAME --clone CLONE [--readonly] [--thick]
Parameter Description
{clone} Commands supported in the storage cluster file namespace.
clone Creates a clone for the given file.
Parameter Description
--name NAME Name of the file to be cloned
--clone CLONE Name of the clone
--readonly Read only clone
--thick Thick clone
Cisco HX Data Platform Command Line Interface Reference 39
9 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.
This section describes the following node commands:
• stcli node add
• stcli node discover
• stcli node disk
• stcli node disks
• stcli node identify
• stcli node info
• stcli node list
• stcli node maintenanceMode
• stcli node remove
• stcli node replace
stcli node
Operations performed on the storage cluster nodes.
Syntax
stcli node [-h] {discover, list, info, identify, disks, disk, add, remove, replace, maintenanceMode}
Parameter Description
add Adds the set of nodes to the storage cluster.
discover Lists the storage cluster nodes discoverable on the same subnet as this node.
disk Locate a physical disk in the node.
disks Provides information about the physical disks of the storage cluster node.
identify Turns on/off the node beacon to identify a node.
Cisco HX Data Platform Command Line Interface Reference 40
stcli node add
Adds the specified nodes to the storage cluster.
Syntax
stcli node add [-h] --node-ips NODEIPS [NODEIPS ...]
[--controller-root-password CONTROLLERPASSWORD] [--dryrun]
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. For details about rebalancing, see Rebalance Commands.
stcli node discover
Lists the storage cluster nodes discoverable on the same subnet as this node.
Syntax
stcli node discover [-h]
stcli node disk
Locate a physical disk in the node.
info Provides information about the specified storage cluster node.
list Lists the storage cluster nodes in the storage cluster.
maintenanceMode Enter or exit maintenance mode.
remove
Unsupported.
replace Replaces a node in the storage cluster.
Parameter Description
--node-ips NODEIPS [NODEIPS ...] IP addresses of nodes to add to the storage cluster
--controller-root-password CONTROLLERPASSWORD Password of the added controller's root user
--dryrun Only validate input parameters
Parameter Description
Cisco HX Data Platform Command Line Interface Reference 41
Syntax
stcli node disk [-h] (--id ID | --ip NAME) [--lighton | --lightoff]
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 identify
Turns on/off the node beacon to identify a node.
Syntax
stcli node identify [-h] --ipmiIp IPMIIP [--interval INTERVAL] [--user USER] [--password PASSWORD]
stcli node info
Provides information about the specified storage cluster node.
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
--lighton Turn the ID light on the disk on.
--lightoff Turn the ID light on the disk off.
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
Parameter Description
--ipmiIp IPMIIP IPMI port IP address
--interval INTERVAL Number of seconds to turn the beacon on. If not specified, turns the beacon off
--user USER The IPMI Administrator user name
--password PASSWORD The IPMI Administrator password
Cisco HX Data Platform Command Line Interface Reference 42
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]
stcli node maintenanceMode
Puts the ESX server in the storage cluster into maintenance mode.
Syntax
stcli node maintenanceMode [-h] (--id ID | --ip NAME)
[--mode MODE (enter | exit)] [--timeout TIMEOUT]
stcli node remove
Unsupported. Internal use only.
stcli node replace
Replaces a node in the storage cluster with the node you specify.
Parameter Description
--id ID ID of storage cluster node
--ip NAME IP address of storage cluster node
--summary Display summary only
Parameter Description
--summary Display summary only
Parameter Description
--id ID ID of hypervisor to update and put into maintenance mode
--ip NAME IP address of hypervisor
--mode MODE Mode to set (enter | exit)
--timeout TIMEOUT Set timeout in seconds for maintenance mode
Cisco HX Data Platform Command Line Interface Reference 43
Syntax
stcli node replace [-h] (--id ID | --ip NAME) --node-ip NODEIP [--controller-root-password CONTROLLERPASSWORD] [--dryrun]
Parameter Description
--id ID ID of storage cluster node to replace
--ip NAME IP address of storage cluster node to replace
--node-ip NODEIP IP address of storage cluster node to add
--controller-root-password CONTROLLERPASSWORD Password of the replaced controller VM's root user
--dryrun Only validate input parameters
Cisco HX Data Platform Command Line Interface Reference 44
10 Rebalance Commands
This section lists and describes rebalance commands. Rebalancing enables load distribution across resources in the storage cluster.
This section describes the following rebalance commands:
• stcli rebalance
• stcli rebalance enable
• stcli rebalance disable
• stcli rebalance start
• stcli rebalance status
• stcli rebalance stop
stcli rebalance
Rebalance related operations.
Syntax
stcli rebalance [-h] {enable, disable, start, stop, 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]
Parameter Description
enable Enables storage cluster rebalance.
disable Disables storage cluster rebalance.
start Starts storage cluster rebalance.
stop Stops storage cluster rebalance.
status Gets storage cluster rebalance status.
Cisco HX Data Platform Command Line Interface Reference 45
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]
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 status
rebalanceStatus:
rebalanceState: online
percentComplete: 10
rebalanceEnabled: True
The following example shows the status when rebalance is enabled, but it is not running.
# stcli rebalance status
rebalanceStatus:
rebalanceState: offline
Parameter Description
-f, --force Force to start rebalance
Cisco HX Data Platform Command Line Interface Reference 46
rebalanceEnabled: True
The following example shows the status when rebalance is disabled, and it is not running.
# stcli rebalance status
rebalanceStatus:
rebalanceState: offline
rebalanceEnabled: 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]
Cisco HX Data Platform Command Line Interface Reference 47
11 Security Commands
This section lists and describes commands to set the controller VM password in the storage cluster.
Topic include:
• stcli security
• stcli security password
• stcli security password set
• stcli security ssh
• stcli security ssh resync
• stcli security whitelist
• stcli security whitelist add
• stcli security whitelist clear
• stcli security whitelist list
• stcli security whitelist remove
stcli security
Security related operations.
Syntax
stcli security [-h] {password,whitelist,ssh}
stcli security password
SSH key management operations
Parameter Description
password Commands supported in the controller VM security password manipulation namespace.
ssh Commands supported in the storage cluster security ssh namespace.
whitelist Commands supported in the storage cluster security IP whitelist namespace.
Cisco HX Data Platform Command Line Interface Reference 48
Syntax
stcli security password [-h] {set}
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]
stcli security ssh
SSH key management operations
Syntax
stcli security ssh [-h] {resync} ...
stcli security ssh resync
Resyncs SSH keys in storage cluster.
Syntax
stcli security ssh resync [-h]
stcli security whitelist
IP tables white-listing operations.
Parameter Description
set Sets user password for all the controller VMs in the storage cluster.
Parameter Description
--user USER Optional user. Must be either admin or root. User root is assumed if not specified.
--password PASSWORD Optional password. If not supplied, it will be prompted for without echoing keystrokes.
Parameter Description
resync Resyncs SSH keys in storage cluster.
Cisco HX Data Platform Command Line Interface Reference 49
Syntax
stcli security whitelist [-h] {list, add, remove, clear}
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]
Parameter Description
add Adds IP addresses to IP table white-list.
clear Clears IP addresses from IP table white-list.
list List IP table white-listed entries.
remove Removes IP addresses from IP table white-list.
Parameter Description
--ips IP [IP ...] The IP addresses to add to white list.
Cisco HX Data Platform Command Line Interface Reference 50
Example
# stcli security whitelist list
Sample Response
----------------------------------------
10.1.1.2
----------------------------------------
10.1.2.3
----------------------------------------
stcli security whitelist remove
Deletes the specified IP addresses from the IP table white list
Syntax
stcli security whitelist remove [-h] [--ips IP [IP ...]]
Example
# stcli security whitelist remove --ips 10.1.2.3
Parameter Description
--ips IP [IP ...] IP addresses to remove from white list
Cisco HX Data Platform Command Line Interface Reference 51
12 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.
• stcli services asup
• stcli services asup enable
• stcli services asup disable
• stcli services asup recipients
• stcli services asup recipients add
• stcli services asup recipients clear
• stcli services asup recipients remove
• stcli services asup recipients set
• stcli services asup show
Note: ASUP relies on SMTP. Before you enable ASUP, ensure that you configure SMTP in your network. For details, see Services SMTP Commands.
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}
Parameter Description
disable Disables ASUP.
enable Enables ASUP.
recipients Commands to support ASUP recipients list configuration.
show Shows the ASUP configuration.
Cisco HX Data Platform Command Line Interface Reference 52
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. See stcli services smtp set.
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} ...
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 ...]
Parameter Description
add Adds recipients to the ASUP recipient list.
clear Clears the ASUP recipient list.
remove Removes recipients from the ASUP recipient list.
set Sets the ASUP recipient list.
Parameter Description
--recipients RECIPIENTS [RECIPIENTS ...] ASUP recipient list to add.
Cisco HX Data Platform Command Line Interface Reference 53
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 ...]
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 ...]
Example
# stcli services asup recipients set --recipients [email protected] [email protected]
stcli services asup show
Displays ASUP recipient list and whether ASUP is enabled or disabled.
Parameter Description
--recipients RECIPIENTS [RECIPIENTS ...] ASUP recipient list to remove.
Parameter Description
--recipients RECIPIENTS [RECIPIENTS ...] ASUP recipient list to set. Separate email recipients with a space.
Cisco HX Data Platform Command Line Interface Reference 54
Syntax
stcli services asup show [-h]
Example
# stcli services asup show
Sample Response
enabled: False
Cisco HX Data Platform Command Line Interface Reference 55
13 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.
This section describes the following DNS commands:
• stcli services dns
• stcli services dns add
• stcli services dns remove
• stcli services dns set
• stcli services dns show
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}
stcli services dns add
Adds servers to the DNS server list.
Parameter Description
add Adds servers to the DNS server list.
set Sets the DNS server list.
show Shows the DNS server list.
remove Sets the DNS server list.
Cisco HX Data Platform Command Line Interface Reference 56
Syntax
stcli services dns add [-h] --dns DNSSERVER [DNSSERVER ...]
Example
# stcli services DNS add --DNS 10.60.8.9
stcli services dns remove
Removes servers from the DNS server list.
Syntax
stcli services dns remove [-h] --dns DNSSERVER [DNSSERVER ...]
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 ...]
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]
Parameter Description
--dns DNSSERVER [DNSSERVER ...] DNS server list to add.
Parameter Description
--dns DNSSERVER [DNSSERVER ...] DNS server list to remove.
Parameter Description
--dns DNSSERVER [DNSSERVER ...] DNS server list to set.
Cisco HX Data Platform Command Line Interface Reference 57
Example
# stcli services dns show
Sample Response
----------------------------------------
10.64.1.8
----------------------------------------
10.64.1.9
----------------------------------------
Cisco HX Data Platform Command Line Interface Reference 58
14 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).
This section includes:
• stcli services ntp
• stcli services ntp add
• stcli services ntp remove
• stcli services ntp set
• stcli services ntp show
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}
stcli services ntp add
Adds NTP servers to the NTP server list in your network
Parameter Description
add Adds servers to the NTP server list.
set Sets the NTP server list.
show Shows the NTP server list.
remove Removes servers from the NTP server list.
Cisco HX Data Platform Command Line Interface Reference 59
Syntax
stcli services ntp add [-h] --ntp NTPSERVER [NTPSERVER ...]
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
Syntax
stcli services ntp remove [-h] --ntp NTPSERVER [NTPSERVER ...]
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 ...]
Example
# stcli services NTP set --NTP 10.1.2.3
stcli services ntp show
Displays the NTP server list.
Parameter Description
-h Displays help on the command and exits
--ntp NTPSERVER Specify the NTP server name
Parameter Description
-h Displays help on the command and exits
--ntp NTPSERVER Specify the NTP server name
Parameter Description
--ntp NTPSERVER [NTPSERVER ...] NTP server list to set.
Cisco HX Data Platform Command Line Interface Reference 60
Syntax
stcli services ntp show [-h]
Example
# stcli services ntp show
Sample Response
----------------------------------------
0.company.pool.ntp.org
----------------------------------------
1.company.pool.ntp.org
----------------------------------------
2.company.pool.ntp.org
----------------------------------------
3.company.pool.ntp.org
----------------------------------------
ntp.ubuntu.com
----------------------------------------
Cisco HX Data Platform Command Line Interface Reference 61
15 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.
This chapter describes the following SMTP configuration operations.
• stcli services smtp
• stcli services smtp clear
• stcli services smtp set
• stcli services smtp show
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}
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.
Parameter Description
clear Clears the SMTP configuration.
set Sets the SMTP configuration.
show Shows the SMTP configuration.
Cisco HX Data Platform Command Line Interface Reference 62
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
# smtpServer: mailhost.eng.mycompany.com
# fromAddress: [email protected]
Parameter Description
--smtp SMTPSERVER SMTP server.
--fromaddress FROMADDRESS Address to send Auto Support emails from. The address used by the SMTP server to send email notifications to the recipients.
Cisco HX Data Platform Command Line Interface Reference 63
16 Services Time Zone Commands
This section lists and describes the following HX Data Platform timezone commands:
• stcli services timezone
• stcli services timezone set
• stcli services timezone show
stcli services timezone
Timezone configuration operations.
Accompany the base stcli services timezone command with one of the positional arguments or the optional -help option.
Syntax
stcli services timezone [-h] {show,set}
stcli services timezone set
Specifies the time zone for the controller VMs.
Syntax
stcli services timezone set [-h] --timezone TIMEZONE
Parameter Description
set Sets the time zone.
show Shows the time zone.
Cisco HX Data Platform Command Line Interface Reference 64
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
Parameter Description
--timezone TIMEZONE 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.
Cisco HX Data Platform Command Line Interface Reference 65
17 VM Clone and Snapshot Commands
This section lists and describes commands to create and schedule snapshots and clones of VMs on storage cluster nodes.
This section describes the following vm commands:
• stcli vm
• stcli vm clone
• stcli vm snapshot
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}
stcli vm clone
Creates a specified number of clones 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]
Parameter Description
clone Creates a specified number of clones for the given VM.
snapshot Creates a native snapshot for the given VM.
Cisco HX Data Platform Command Line Interface Reference 66
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] [--memory | --quiesce] [--retention RETENTION]
Parameter Description
--id ID ID of the VM to be cloned. Required if --name not specified.
--name NAME Name of the VM to be cloned. Required if --id not specified.
--clone CLONE Name of the clone. Required.
--number NUMBER Number of clones required. Required.
--poweron Power on after cloning.
--custspec CUSTSPEC Guest Customization spec for the cloned VM(s).
--guestname GUESTNAME Guest name for the cloned VM(s) if different from VM name.
--startnumber STARTNUMBER Start number suffix for the VM clone name.
--increment INCREMENT Increment of the suffix for the VM clones.
--resourcepool-id RP-ID ID of the Resource pool to place the cloned VM(s) on.
--resourcepool-name RP-NAME Name of the Resource pool to place the cloned VM(s) on.
Parameter Description
--id ID ID of the VM to take a snapshot.
--name NAME Name of the VM to take a snapshot.
--folder-id FOLDER-ID ID of the VM folder to take a snapshot.
--folder-name FOLDER-NAME Name of the VM folder to take a snapshot.
--resourcepool-id RP-ID ID of the resource pool to take a snapshot.
--resourcepool-name RP-NAME Name of the resource pool to take a snapshot.
--snapshot SNAPSHOT Name of the snapshot. Required.
--desc DESC Description of the snapshot.
--memory Memory snapshot.
--quiesce Quiesce the file system in the virtual machine.
--retention RETENTION This option is deprecated. Do not use.
Cisco HX Data Platform Command Line Interface Reference 67