American Megatrends MAN-STOR-ITX27-CLI manual

StorTrend s® iTX Softw are CLI (Comm and Line I nterface) (Version 2. 7) User’s Guide MAN-STOR-IT X27-CLI 06/07/2010[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide ii © Cop yright 1985-20 10 Americ an Megatrend s, Inc. All rights reser ved. American Me gatrends, I nc. 5555 Oakbrook P arkway Norcro ss, GA 3009 3 This publica tion contain s proprieta ry infor mation which is p rotected by cop yright. No par t of this public a[...]

Preface iii 01/25 /10 Updated the iSCSI co mmands a nd corre cted wrong for mat upda tion 03/30 /10 Corrected the Create Vo lume usa ge and Get Eve ntlog Usa ge. 04/11 /10 Update the create re plication comma nds 06/07 /10 Corrected the output of ‘cli main’. 06/07 /10 Removed the term apple 06/07 /10 Corrected set -t nfs co mmand. 06/07 /10 Cor[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide iv Table of Contents Revision Hist ory .................................. ........................................................................................ ............... ii Table of Cont ents ...............................................................[...]

Preface v Limited Warra nty The buyer ag rees that if this pro duct prov es to be de fective, American M egat rends is only o bligated to repa ir or replac e this product at Amer ican M egatrends’ discretio n according to the t erms and condit ions of t he warr anty registr ation softw are that a ccompanies this product. A merican M egatre nds sh[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide vi Disclaimer This manual de scribes the opera tion o f the A merican Mega trends StorTrends ® iTX So ftwar e. Althoug h effort s have bee n made to assure the accura cy o f the infor mation contained here, A merica n M egatrends expressly disc laims liab ility f[...]

Chapter One: Ove rview of CLI 1 Chapter 1 Overvie w of CLI Preface Our fea ture rich St orTrends® iTX comes w ith a built- in co mmand line int erface (CLI) that provides extensive opt ions to monitor a nd control “managed o bjects”. Wherever applicable, CLI f ollow s industry standards and uses e xtensible ‘tag s’ for new fe atures and ob[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 2 Initial Setup Netwo rk Configura tion Once the StorTrends® iTX is installe d in a new syst em, please ensure that t he initial n etw ork configura tion is proper. The sy stem fact ory def aults to DHCP set up. The co nfigured net wor k settings ca n be verif ie[...]

Chapter One: Ove rview of CLI 3 Volume Configura tion Initial volu me configur ation ca n be done in three stag es. 1. RAID Dis k Creation At the ba se level is the RAID C ONTROLLE R. CLI> list –-type or –t controller raid <Enter> Example: list – t contr oller ra id This will list the av ailable RAID controlle rs in the syste m. By d[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 4 2. Cont ainer and V olume Conf iguratio n Next step is the AMI D VM container cre ation. This ca n be done by the fo llowing commands: CLI>create –-type or -t container –-contai nername or -c containe r1 –-chunksize or –k 64 –-ldname or –l /dev/md[...]

Chapter One: Ove rview of CLI 5 Similarly a SAN volu me can be create d as follow s: CLI>create –-type or –t volume –-contai nername or -c containe r1 –-volumename or -v sanvol0 –-volumesize or -z 1000 –-provisiontype or -p 0 –-volumetype or -e 0 –-voldialect or -f 0 --chunksize or –k (8 or 64 for 8KB and 64KB chunk sized volum[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 6 Then, to ena ble the ta rget, use the syntax below : CLI>enable –-type or –t tgt –-targetname or -n sanvol0 iscsi <Enter> Example: enable –t tgt –n sanvol0 iscsi Next step is to activ ate a port f or iSCSI tra ffic. CLI>activate –-type or[...]

Chapter Two: Command Set 7 Chapter 2 Command Set Command Se t The CLI de sign being s imilar to the DMTF SM ASH specifica tions follo ws the standard to a great e xtent. The commands supporte d can be repr esented gra mmatically as fo llows: <verb> <option> … <property> <target> The CLI prov ides a w ide rang e of co mmand[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 8 For exa mple: To find o ut how the show command wo rks, ty pe: CLI>show -h <Enter> This will display the many w ays the sho w co mmand can be used. (this is redu ndant) For exa mple: To displa y the a vailable targets/ver bs, the user ha s to ente r: CL[...]

Chapter Two: Command Set 9 Alert Configuration These comma nds configur e the way alerts are generated. Command Argument Description get alert -t/--type snmp For example: get –t snmp alert Gives the SNMP alert configuration. get alert -t/--type email For example: get –t email alert Gives the Email alert configuration. delete alert -t/--type snm[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 10 Date/Time Configuration These comma nds configur e the time zone an d date. Command Argument Description set timezone -z/--zone <zone n ame> -x/--xml For example: set –z America/Ne w_York timezone Sets the time zone of Sto rTrends® iTX to given ti me z[...]

Chapter Two: Command Set 11 Event log Commands These comma nds displa y or clea r the ev ent log. Command Argument Description get eventlog -s/--section {v/s/o/h} -o/--offset <record-offset> -n/--recordcount <record -count> -i/--info -f/--fatal -w/--warning or -a – all eventlog -x/--xml For example: get –s vs –o 2 –n 20 –f –[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 12 Firewall Configura tion These comma nds configur e the netwo rk firewa ll options. Command Argument Description add firewall -a/--allow or -b/--block -i/--ip <ipadd ress> -m/--mask <netmask> -p/--proto {icmp} -x/--xml Add allowed or b locked firewal[...]

Chapter Two: Command Set 13 General Server Confi guration These comma nds retriev e the general server info rmation, such a s build versio n, build date a nd so on. It also allow s configuratio n of a new serve r name. Command Argument Description get serverinfo For example: get serverinfo Displays the server information such as server name, bui ld[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 14 iSCSI Configura tion Note: Targetname input: Only the su ffix por tion of the targetname is required. For exa mple: “iqn.19 91-10. com.ami:itx00 1a2b3 c4d5e2006: test1” . The user needs t o input only “test1 ”. Command Argument Description get iscsi -t/[...]

Chapter Two: Command Set 15 Command Argument Description -c/--containern ame <containername> -m/--mode {0/1/2 } For example: set –t lu nwritecachemode –v v1 –c c1 –m 0 iscsi 0 – Write through 1 – Write b ack add iscsi -t/--type {processor} -n/--targetname <target suffix> Adds the processor to the specified target (used for b[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 16 Command Argument Description For example: set –t tgtop timizations –n t1 –p y –g 10 iscsi enable iscsi -t/--type { iSNSservice} Enables the iSNS Service. disable iscsi -t/--type { iSNSservice} Disables the iSNS Service. get iscsi -t/--type {iSNS} Gives [...]

Chapter Two: Command Set 17 Network Controlle r Configuration These comma nds configur e the netwo rk ports. They c an also be used to cr eate v irtual bonding net work port s (tea ms) for high av ailability and/o r load ba lancing. Command Argument Description get network -t/--type {port} -c/--count -x/--xml For example: get –t po rt –c count [...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 18 Command Argument Description -p/--port <adap ter name> remove network -t/--type alias -n/--name <alias name> Removing an alias adapter NAS Quota Configura tion These comma nds configur e quot as for the NAS v olumes of y our iTX bo x. Command Argume[...]

Chapter Two: Command Set 19 NAS User / Group Configuration These comma nds allow viewing and conf iguratio n of the NAS U sers and g roups acco unts. Note: Known Iss ue: As iTX software supports enab ling of ADS and NI S simultaneo usly, the us er/group list retrieved will be give n for b oth instead of singly. Command Argument Description add ug -[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 20 set ug -t/--type {group} -g/--groupname <groupn ame> -u/--username <username> -x/--xml Adds the given user to the specified group. Multip le users can be added using –u/--u sername switch. (maximum of 8 users at a time) Protocol Configura tion The[...]

Chapter Two: Command Set 21 RAID & Disk Manage ment Commands These comma nds allow manag ement of dis ks and RAID crea tion. For Ha rdware R AID please ente r the Slot index (For e xample: 1 , 2,3 , and so on) instead of diskname (Fo r example: /dev/ sda, /dev /sdb) in the option f or -d / --diskname <Dis kInfo_OSNa me or slo tindex> Comm[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 22 Command Argument Description expand raid -t/--type {ld} -l/ -- ldname <ldname > -d/ --diskname <diskname or slo tindex(optional)> -s/--disksize <disksize in GB> -b/--subdisk <subdi skcount (Required only for RAID10N and RAID50)> -e/--dis[...]

Chapter Two: Command Set 23 Command Argument Description -l / --ldname <ldname> -m/--cachemode <cache mode> Cache Modes - ld 0 - None 1 - Read 2 - Write 3 - Read-Write rescan raid -n/--controll erno <controller number> Initiates rescannin g of the storage bus connected to the controller. remove raid -t/--type {spare} -d / --diskna[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 24 Share, Directory & ACL Configuration These comma nds wor k on NAS shar es and dir ectory . Command Argument Description create dir -p/--path <dir ectory path> -x/--xml For example: create –p c0_nas0/new dir Creates a subdirectory with the given comp[...]

Chapter Two: Command Set 25 LEVEL FOR NT 0 - Apply to all l evels 1 – Apply to first level PERMISSIONS FOR P OSIX 0 - Read Write 1 - Read Only 2 - Deny PERMISSIONS FOR NT : The 14 bits in following ord er A - Traverse Folder / Execute file B - List Folder / Read Data C - Read Attribu tes D - Read Extend ed Attributes E - Create files/ Write Data [...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 26 System Control Configura tion These comma nds configur e the System co ntrols. Command Argument Description shutdown system For example: shutdo wn system Shuts the system down. get system For exa mple: cli get -x system Gets the auto shu tdown information. set [...]

Chapter Two: Command Set 27 Command Argument Description -L/--localsnap used, then onl y the local snapshot will be created. By default, without the switches –L and –R, it will create th e local snapshot only. delete volume -t/--type {container} -c/--containern ame<c ontain ername> -f/--force (optional) -r/--recursive (option al) Deletes [...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 28 Command Argument Description -c/ --contain ernam e <con tainername> -v/--volumename <volumena me> get volume -t/--type {snap} -c/--containern ame <containername> -v/--volumename <volumena me> -u/--schedule Gets the snapshot schedule sett[...]

Chapter Two: Command Set 29 UPS Configuration These comma nds configur e the UPS for powe r management. Command Argument Description get UPS -i/--info -x/--xml Displays the existing UP S configuration. get UPS -i/--info -m/--monitor -x/--xml Display the monito ring configuration for the co nfigured UPS devices. set UPS -d/--disable -x/--xml Disable[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 30 Synchronous replic ation These comma nds configur e synchr onous rep lication and H igh Ava ilability using Window s DSM (iTX 2.7v 2.x). Command Argument Description create syncreplica –l/--local < cont_vol_n ame> -r/--remote < cont_vol_n ame> -p/[...]

Chapter Two: Command Set 31 High Availability (iTX 27 v3.x and u p ) These comma nds configure High Availabilit y w hich is OS A gnostic Command Argument Description syncparams syncreplica -r/--remoteip < remote ipad dress > -x/--xmlflag For exa mple: syncparams -r 172.16 .70.148 syncreplica Syncparams is used to sync the iscsi base target na[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 32 Command Argument Description -g/--rgname <rgname> -x/--xmlflag <xml flag> For exa mple: update -l c0 _v0 -p 50 -m 172.1 6.70.1 02 -x syncreplica update -l c0_ v0 -g rg0 s yncreplic a Update command is u sed to move a replication volume pair from Res[...]

Chapter Two: Command Set 33 Asynchronous Repl ication These comma nds configur e asy nchronous replic ation. Command Argument Description create asyncreplica -t/--type <sar/jar/hasar> -n/--name <snap assisted repli cation name> -f/--volumedialect -a/--primarycontain er <primary contName> -l/--primaryvolume <primary volNa me>[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 34 Command Argument Description Example: list -c c0 asyncreplica container. This command can b e issued on both Primary and Second ary storage systems. list asyncreplica -c/--containername <container name> -n/--name <asynchron ous replication name> Exa[...]

Chapter Two: Command Set 35 Command Argument Description -c/- -containername <container name> -d/--index <system assigned n ame> Example: failback -n name -c c0 –d 1 asyncreplica replication to the origin al primary. This command can b e issued only in the original pri mary ac ting as a secondary. rollbackjoin asyncreplica -n/--name &[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 36 Command Argument Description update asyncreplica -n/--name <asynchron ous replication name> -c/--containern ame <container name> -d/--index <system assigned n ame> -z/--secsnapcoun t <secondary snap count> Example: update -n myname -d 1 [...]

Chapter Two: Command Set 37 Command Argument Description -s/-- schedule> -d/--index <system assigned n ame> Example: add -n myname -c Cont0 -s "0-24 0-7" -d 1 asyncreplica add -n myname -c Cont0 -s "* 0-7" -d 1 asyncreplica add -n myname -c Cont0 -s "0-24 *" -d 1 asyncreplica add -n myname -c Cont0 -s "* [...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 38 Command Argument Description -n/--cgname <cgname> -s/--schedulesnap <scheduledur ation:maxsnapshots> -d/--description <descrip tion> -b/--backuptargetname <backup targetname> -p/--scheduleType <0-Windo ws,1-Local> Example: set -t s[...]

Chapter Two: Command Set 39 Journal V olume Management These comma nds configur e a journal a nd journa l file. create journal -t/--type journal -j/--journaln ame <journalname> -l/--ldname <ldname> Example: create -t journ al -j jour0 -l /dev/sdb journal Creates journal. Minimum LD size for jou rnal creation is 10GB create journal -t/--[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 40 get -t snaptable -c c0 -f cg0 -n 10 journal list journal -t/ --type journ al List journal information. list journal -t/ --type journ alfile -c/--contain ernam e <con tainername List journal file in formation. list journal -t/ --type snaptable -c/--containern[...]

Chapter Two: Command Set 41 Continuous Data P rotection These comma nds are to view c dp for jo urnal file. rollback cdp -c/--container <contain ername> -f/--journalfile <jfname> Example: rollback -c c0 -f jf0 cdp Performs rollback on journal file. review cdp -c/--container <contain ername> -f/--journalfile <jfname> -s/--bas[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 42 remove recoverywizard -c/--container <contain er name> -v/--volume<volumename> -s/--snap<snapn ame> -t/--tgt_name<tgt_name> -x/--xml (optional) Example: remove -c c0 -v vol1 -s snap1 -t iqn.1991- 10.com.ami:itx00c09f2164 459105:t08212006[...]

Chapter Two: Command Set 43 Local and Replicated Snapshot validation These co mmands are used as par t of snap validatio n. enable snapvalidation -t/--type local -c/--containern ame <containername> -v/--volumename<volumena me> -x/--xml Example: enable -t local -c Cont0 -v Volume0 snapvalidation This will enable local NAS snap validation[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 44 -v/--volumename<volumena me> -x/--xml Example: pause -t SRP -c Cont0 -v Vo lume0 snapvalidation pause -t HA -c Cont 0 -v Volume0 snapvalidation set. SRP – Sync replica module HA – High availabilit y module get snapvalidation t/--type (SRP/HA) -c/--con[...]

Index 45 Appendix A Error Codes Code Description 0 Command Succeeded 1 Command Failed 2 Invalid Parameter 3 Insufficient buffer 4 Insufficient memory 5 Invalid Operation 6 Error in opening file 10 User does not exist 11 User already exists 12 Selected user is a NIS user 13 User type did not match ADS NIS and LOCAL 14 User Count in UserList is not s[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 46 Code Description 70 Null parameter 71 Invalid disk channel 72 Invalid Disk 73 Invalid Username 74 Invalid password 75 Invalid groupname 76 Invalid Network port 77 Invalid Path 78 Invalid Volume Name 79 Invalid share name 80 Invalid server name 81 Invalid member[...]

Index 47 Code Description 175 Error in moun ting the share 200 Upgrade version erro r 201 Upgrade package alread y installed 202 Upgrade package depen dency failure 203 Upgrade package install ation failed 204 Upgrade requ ires more disk space 205 Invalid p ackage name 220 Error in upgrade operation 230 Duplicate IP address 231 Invalid IP address 2[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 48 Code Description 338 License file read write error 350 Duplicate Alias Name 351 Alias not foun d 352 Invalid Alias Name 353 DHCP is not supported for Alias Adapters 354 Maximum Alias Adapter count exceeded 355 Maximum Alias per NIC exceeded 500 No Target found [...]

Index 49 Code Description 610 No spare su pport 611 Max limit reached 612 No MD d evice available 613 MD creation failed 614 Add entry to con figuration file failed 615 disk is not free 616 Minimum disk coun t 617 Error in upd ating configuration file 618 Error in read ing from configuration file read error 619 Raid hot r emove failed 620 Disk part[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 50 Code Description 725 Error in moun ting file system 726 Error in gettin g snap info 727 Error in creatin g writable snap 728 Error in gettin g volume info 729 Max space reached 730 Invalid d ialect 731 Invalid Snap 732 Error in rolli ng back Snap 734 Error in u[...]

Index 51 Code Description 876 Error in BIND 877 License - HA pair creation license expired/disabled 878 License - Unable to Read the License File 879 License - License Valid ation Failure 880 License - New Moth erboard or New Motherbo ard with Some External NIC cards found, For service key generation, remove all External NIC cards from the system 8[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 52 Code Description 1029 Replication - Volume is not in sync 1030 Replication - Box owns RG bu t volumes are secondary 1031 Replication - Box is not th e orignal owner of the RG 1032 Replication - Box does not own RG but volumes are primary 1101 Asy nch ronous Rep[...]

Index 53 Code Description 1306 Snap Validation – Local snapsh ot not available 1307 Snap Validation – User snapshot validatio n pending 1308 Snap Validation – Snapshot already valid ated 1325 Read only snap count max rea ched 1326 Snap count per volume max reached 1327 Snap count per system max reached 1345 Duplicate Frequency/Level entered f[...]

StorTrends® iTX Softw are CLI (Command Line I nterface) (Version 2.7) User’s Guide 54 Code Description 4099 DVM - Device open error 4100 DVM - Device access error 4101 DVM - general error 4102 DVM - Lib DM suspend error 4103 DVM - Lib DM resume error 8192 DVM - generic error 8193 DVM - memory allocation errors 8194 DVM - IOCTL Parameter passing [...]