3ware® Serial ATA
RAID Controller
Command Line Interface
Supports the 9000 Series
(9500S, 9550SX, 9590SE, 9650SE)
PN: 720-0145-00
October 2006
Table of Contents
About this CLI Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installing the 3ware CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installing the 3ware CLI on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installing the 3ware CLI on Linux and FreeBSD . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Working with 3ware CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Using the command interface interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Using a single command with output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Using an input file to execute a script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Outputting the CLI to a Text File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Understanding RAID Levels and Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
RAID Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Available RAID Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Determining What RAID Level to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Chapter 2. CLI Syntax Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Common Tasks Mapped to CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Syntax Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
focus Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
show ver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
show diag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
show rebuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
show verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
show selftest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
rescan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
update fw=filename_with_path [force] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Controller Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
/cx show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
/cx show attribute [attribute ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
/cx show driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
/cx show model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
/cx show firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
/cx show bios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
/cx show monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
/cx show serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
/cx show pcb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
/cx show pchip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
/cx show achip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
www.3ware.com
iii
/cx show numdrives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
/cx show numports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
/cx show numunits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
/cx show ctlbus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
/cx show exportjbod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
/cx show spinup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
/cx show stagger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
/cx show ondegrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
/cx show autocarve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
/cx show carvesize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
/cx show memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
/cx show autorebuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
/cx show unitstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
/cx show allunitstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
/cx show drivestatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
/cx show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
[nocache] [autoverify] [noqpolicy][ignoreECC] [name=string]
[storsave=<protect|balance|perform>] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
/cx rescan [noscan] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
/cx commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
/cx flush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
/cx update fw=filename_with_path [force] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
/cx show alarms [reverse] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
/cx show diag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
/cx show rebuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
/cx show verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
/cx show selftest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
/cx add rebuild=ddd:hh:duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
/cx add verify=ddd:hh:duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
/cx add selftest=ddd:hh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
/cx del rebuild=slot_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
/cx del verify=slot_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
/cx del selftest=slot_id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
/cx set rebuild=enable|disable|1..5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
/cx set verify=enable|disable|1..5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
/cx set exportjbod=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
/cx set ondegrade=cacheoff|follow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
/cx set spinup=nn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
/cx set stagger=nn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
/cx set autocarve=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
/cx set carvesize=[1024..2048] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
/cx set autorebuild=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
/cx start mediascan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
/cx stop mediascan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
/cx/ux show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
/cx/ux show attribute [attribute ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
/cx/ux show status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
/cx/ux show rebuildstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
/cx/ux show verifystatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
/cx/ux show initializestatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
/cx/ux show name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
iv
3ware Serial ATA RAID Controller CLI Guide
/cx/ux show serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
/cx/ux show qpolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
/cx/ux show storsave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
/cx/ux show identify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
/cx/ux show autoverify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
/cx/ux show cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
/cx/ux show ignoreECC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
/cx/ux show volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
/cx/ux show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
/cx/ux remove [noscan] [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
/cx/ux del [noscan] [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
/cx/ux start rebuild disk=p<p:-p...> [ignoreECC] . . . . . . . . . . . . . . . . . . . . . . . . . . 66
/cx/ux start verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
/cx/ux pause rebuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
/cx/ux resume rebuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
/cx/ux stop verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
/cx/ux flush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
/cx/ux set autoverify=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
/cx/ux set cache=on|off [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
/cx/ux set identify=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
/cx/ux set ignoreECC=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
/cx/ux set name=string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
/cx/ux set qpolicy=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
/cx/ux set storsave=protect|balance|perform [quiet] . . . . . . . . . . . . . . . . . . . . . . . 70
[group=3|4|5|6|7|8] [stripe=Stripe] [noscan] [nocache] [autoverify] . . . . . . . . . 72
Port Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
/cx/px show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
/cx/px show attribute [attribute ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
/cx/px show status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
/cx/px show model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
/cx/px show serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
/cx/px show firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
/cx/px show identify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
/cx/px show ncq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
/cx/px show lspeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
/cx/px show capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
/cx/px show smart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
/cx/px show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
/cx/px remove [noscan] [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
/cx/px set identify=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
BBU Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
/cx/bbu show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
/cx/bbu show attribute [attribute ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
/cx/bbu show status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
/cx/bbu show batinst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
/cx/bbu show lasttest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
/cx/bbu show volt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
/cx/bbu show temp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
/cx/bbu show cap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
/cx/bbu show serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
/cx/bbu show fw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
/cx/bbu show pcb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
/cx/bbu show bootloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
/cx/bbu show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
www.3ware.com
v
/cx/bbu test [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
/cx/bbu enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
/cx/bbu disable [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
/ex show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
/ex show attribute [attribute ...] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
/ex show controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
/ex show slots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
/ex show fans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
/ex show temp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
/ex show all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
/ex/slotx show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
/ex/slotx show identify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
/ex/slotx set identify=on|off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
/ex/fanx show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
/ex/tempx show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Help with specific commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Help with attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
help show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
help flush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
help rescan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
help update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
help commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
help focus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /cx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /cx/ux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /cx/px . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /cx/bbu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /ex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /ex/slotx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
help /ex/fanx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
help /ex/tempx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Command Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Return Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
vi
3ware Serial ATA RAID Controller CLI Guide
About this CLI Guide
3ware Serial ATA Controller CLI Guide provides instructions for configuring
and maintaining your 3ware controller using 3ware’s command line interface
(CLI).
Table 1: Sections in this CLI Guide
Chapter
Description
1. Introduction to 3ware
Command Line Interface
Installation, features, concepts
2. CLI Syntax Reference
Describes individual commands using the
primary syntax
There are often multiple ways to accomplish the same configuration and
maintenance tasks for your 3ware controller. While this manual includes
instructions for performing tasks using the command line interface, you can
also use the following applications:
•
•
3ware BIOS Manager
®
3DM 2 (3ware Disk Manager)
For details, see the user guide or the 3ware HTML Bookshelf.
www.3ware.com
1
1
Introduction to the 3ware
Command Line Interface
The 3ware SATA RAID Controller Command Line Interface (CLI) for Linux,
Windows, and FreeBSD is provided to manage 7000, 8000, and 9000-series
3ware ATA and Serial ATA RAID controllers. Multiple 3ware RAID
controllers can be managed using the CLI via a command line or script.
Note: Some CLI commands are supported only for particular models of 3ware
RAID controllers. Wherever possible, commands are labeled to indicate when they
are supported for only a subset of controllers. For example, commands that apply
only to 3ware 9000 series controllers are labeled as such and are not supported for
3ware 7000/8000 controllers. Within the 9000 series, some commands apply to
only to models 9550SX, 9590SE, and 9650SE and not to 9500S, and are so
labeled. A few commands apply only to models 9500S, and are labeled as such.
Important!
For all of the functions of the 3ware CLI to work properly, you must have the proper
latest versions and upgrade instructions.
This chapter includes the following sections:
•
•
•
•
Features of the CLI
3ware CLI is a command line interface for managing 3ware RAID
Controllers. It provides controller, logical unit, drive, enclosure, and BBU
(Battery Backup Unit) management. It can be used in both interactive and
batch mode, providing higher level API (application programming interface)
functionalities.
2
3ware Serial ATA RAID Controller CLI Guide
Supported Operating Systems
You can use the CLI to view unit status and version information and perform
maintenance functions such as adding or removing drives. 3ware CLI also
includes advanced features for creating and deleting RAID units online.
For a summary of what you can do using the CLI, see “Common Tasks
Supported Operating Systems
The 3ware CLI is supported under the following operating systems:
•
Windows®. Windows 2000, Windows XP, and Windows Server 2003,
both 32-bit and 64-bit.
•
•
Linux®. Redhat, SuSE, both 32-bit and 64-bit.
FreeBSD®, both 32-bit and 64-bit.
For specific versions of Linux and FreeBSD that are supported for the 3ware
CLI, see the Release Notes.
Terminology
This document uses the following terminology:
Logical Units. Usually shortened to “units.” These are block devices
presented to the operating system. A logical unit can be a one-tier, two-tier, or
three-tier arrangement. JBOD, Spare, and Single logical units are examples of
one-tier units. RAID 1 and RAID 5 are examples of two-tier units and as such
will have sub-units. RAID 10 and RAID 50 are examples of three-tier units
and as such will have sub-sub-units.
Port. A controller has one or many ports (typically 4, 8, 12, 16). Each port can
be attached to a single disk drive. On a controller such as the 9590SE-4ME,
with a multilane serial port connector, one connector supports four ports.
For additional information about 3ware controller concepts and terminology,
see the user guide that came with your 3ware RAID controller or the user
guide portions of the 3ware HTML Bookshelf.
www.3ware.com
3
Chapter 1. Introduction to the 3ware Command Line Interface
Installing the 3ware CLI
Warning!
If you are using 3DM, as opposed to 3DM2, AMCC does not recommend installing
both 3DM and CLI on the same system. Conflicts may occur. For example, if both
are installed, alarms will be captured only by 3DM. You should use either CLI or
3DM to manage your 3ware RAID controllers.
This is not an issue for 3DM2. It can be installed with CLI.
(3DM was an earlier version of the software, which worked with 7/8000 model
3ware controllers. 3DM 2 works with the 9000-series.)
Installing the 3ware CLI on Windows
3ware CLI can be installed or run directly from the 3ware software CD, or the
latest version can be downloaded from the 3ware web site,
http://www.3ware.com. Online manual pages are also available in nroff and
html formats. These are located in /packages/cli/tw_cli.8.htmlor
tw_cli.8.nroff.
To install 3ware CLI on Windows
•
Copy the file tw_cli.exeto the directory from which you want to run the
program.
CLI is located on the 3ware CD in the directory \packages\cli\windows
Note: CLI comes in both 32-bit and 64-bit versions. Be sure to copy the correct
version for the version of the operating system you are using.
Permissions Required to Run CLI
To run CLI, you can be logged onto Windows with one of the following sets
of permissions:
•
•
•
•
Administrator
User with administrator rights
Domain administrator
Domain user with Domain Admin or Administrator membership
Without the correct privileges, CLI will prompt and then exit when the
application is executed.
4
3ware Serial ATA RAID Controller CLI Guide
Installing the 3ware CLI
If you are uncertain whether you have the correct permissions, contact your
network administrator.
To start CLI, do one of the following:
•
•
Start the 3ware CD and at the 3ware Escalade menu, click Run CLI.
Or, open a console window, change to the directory where tw_cli is
located, and at the command prompt, enter
tw_cli
•
OR, double-click the CLI icon in a folder.
The CLI prompt is displayed in a DOS console window.
Installing the 3ware CLI on Linux and FreeBSD
3ware CLI can be installed or run directly from the 3ware software CD, or the
latest version can be downloaded from the 3ware web site,
To install the 3ware CLI, copy tw_cli to the directory from which you want to
run the program. CLI is located on the 3ware CD in /packages/cli/freebsd
or /packages/cli/linux.
Online manual pages are also available in nroff and html formats. These are
located in /packages/cli/tw_cli.8.htmlor tw_cli.8.nroff.
You will need to be root or have root privileges to install the CLI to
/usr/sbinand to run the CLI.
Filename: tw_cli
To install the CLI to a different location, change /usr/sbin/to the desired
location.
Notes:
The installation location needs to be in the environment path for root to execute the
CLI without using complete paths (i.e., if installed to /usr/sbin/, you can type tw_cli
on the command line, otherwise you will have to type the complete path:
/home/user/tw_cli
The 3ware CLI comes in both 32-bit and 64-bit versions. Be sure to copy the correct
version for the version of the operating system you are using.
www.3ware.com
5
Chapter 1. Introduction to the 3ware Command Line Interface
Working with 3ware CLI
You can work with the 3ware CLI in different ways:
•
•
•
Interactively, entering commands at the main prompt
As a series of single commands
By creating a script—an input file with multiple commands
The next few topics shows examples of these different methods.
•
•
•
•
method.
Using the command interface interactively
You can use 3ware CLI interactively, entering commands at the main prompt
and observing the results on the screen.
To use the CLI interactively
1
Enter the following command:
# tw_cli
The main prompt is displayed, indicating that the program is awaiting a
command.
//localhost>
2
At the CLI prompt, you can enter commands to show or act on 3ware
controllers, units, and drives.
For example,
//localhost> show
displays all controllers in the system and shows details about them, like
this:
Ctl Model Ports Drives Units NotOpt RRate VRate BBU
------------------------------------------------------------
c0 9650SE-4 4
c1 7500-12 12
4
8
1
3
0
1
3
2
5 TESTING
-
-
6
3ware Serial ATA RAID Controller CLI Guide
Working with 3ware CLI
Using a single command with output
You can use 3ware CLI with line arguments, processing a single command at
a time. To do so, simply enter the command and the arguments.
Single commands can be useful when you want to perform a task such as
redirecting the output of the command to a file. It also allows you to use the
command line history to eliminate some typing.
Syntax
tw_cli <command_line_arguments>
Example
tw_cli /c0 show diag > /tmp/3w_diag.out
Using an input file to execute a script
You can operate 3ware CLI scripts by executing a file. The file is a text file
containing a list of CLI commands which you have entered in advance. Each
command must be on a separate line.
Syntax
tw_cli -f <filename>
Where <filename>is the name of the text file you want to execute.
Example
tw_cli -f clicommand.txt
This example executes the file clicommand.txt, and runs the CLI commands
included in that file.
Scripting example
Following is a scripting example using a text file called config_unit.txt,
containing three commands. This example sets up a 12-port controller with
two units: one with the first 2 drives mirrored, and another with the remaining
drives in a RAID 5 array. It then prints the configurations for verification. The
commands included in the script file are:
/c0 add type=raid1 disk=0-1
/c0 add type=raid5 disk=2-11
/c0 show
To run the script, enter:
tw_cli -f config_unit.txt
www.3ware.com
7
Chapter 1. Introduction to the 3ware Command Line Interface
Outputting the CLI to a Text File
You can have the output of the 3ware CLI, including errors, sent to a text file
by adding 2>&1 to the end of the line. This could be useful, for example, if
you want to email the output to AMCC Technical Support.
Examples
tw_cli /c2/p0 show >> controller2port0info.txt 2>&1
or
tw_cli /c0 show diag >> Logfile.txt 2>&1
Conventions
The following conventions are used through this guide:
•
•
In text, monospace fontis used for code and for things you type.
In descriptions and explanations of commands, a bold font indicates the
name of commands and parameters, for example, /c0/p0 show all.
•
In commands, an italic font indicates items that are variable, but that you
must specify, such as a controller ID, or a unit ID, for example, /c0/p0
show attribute, and /cx/px show all
•
•
In commands, brackets around an item indicates that it is optional.
In commands, ellipses (...) indicate that more than one parameter at a time
can be included, for example, /c0/p0 show attribute [attribute ...], or that
there is a range between two values from which you can pick a value, for
example, /cx set carvesize=[1024...2048].
•
In commands, a vertical bar (|) indicates an 'or' situation where the user
has a choice between more than one attribute, but only one can be
specified.
Example: In the command to rescan all ports and reconstitute all units, the
syntax appears as /cx rescan [noscan]. The brackets [ ] indicate that you may
omit the noscan parameter, so that the operation will be reported to the
operating system.
8
3ware Serial ATA RAID Controller CLI Guide
Understanding RAID Levels and Concepts
Understanding RAID Levels and Concepts
3ware RAID controllers use RAID (Redundant Array of Inexpensive Disks)
to increase your storage system’s performance and provide fault tolerance
(protection against data loss).
This section organizes information about RAID concepts and configuration
levels into the following topics:
•
•
•
“RAID Concepts” on page 1
“Available RAID Configurations” on page 1
“Determining What RAID Level to Use” on page 1
RAID Concepts
The following concepts are important to understand when working with a
RAID controller:
•
Arrays and Units. In the storage industry, the term “array” is used to
describe two or more disk drives that appear to the operating system as a
single unit. When working with a 3ware RAID controller, “unit” is the
term used to refer to an array of disks that is configured and managed
through the 3ware software. Single-disk units can also be configured in
the 3ware software.
•
Mirroring. Mirrored arrays (RAID 1) write data to paired drives
simultaneously. If one drive fails, the data is preserved on the paired
drive. Mirroring provides data protection through redundancy. In
addition, mirroring using a 3ware RAID controller provides improved
performance because 3ware’s TwinStor technology reads from both
drives simultaneously.
•
•
•
Striping. Striping across disks allows data to be written and accessed on
more than one drive, at the same time. Striping combines each drive’s
capacity into one large volume. Striped disk arrays (RAID 0) achieve
highest transfer rates and performance at the expense of fault tolerance.
Distributed Parity. Parity works in combination with striping on RAID 5,
RAID 6, and RAID 50. Parity information is written to each of the striped
drives, in rotation. Should a failure occur, the data on the failed drive can
be reconstructed from the data on the other drives.
Hot Swap. The process of exchanging a drive without having to shut
down the system. This is useful when you need to exchange a defective
drive in a redundant array.
www.3ware.com
9
Chapter 1. Introduction to the 3ware Command Line Interface
•
Array Roaming. The process of removing a unit from a controller and
putting it back later, either on the same controller, or a different one, and
having it recognized as a unit. The disks may be attached to different ports
than they were originally attached to, without harm to the data.
For definitions of other terms used throughout the documentation, see the
“Glossary”.
Available RAID Configurations
RAID is a method of combining several hard drives into one unit. It offers
fault tolerance and higher throughput levels than a single hard drive or group
of independent hard drives. RAID levels 0, 1, 10 and 5 are the most popular.
AMCC's 3ware controllers support RAID 0, 1, 5, 6, 10, 50, JBOD and Single
Disk. The information below provides a more in-depth explanation of the
different RAID levels.
For how to configure RAID units, see “Configuring a New Unit” on page 96.
RAID 0
RAID 0 provides improved performance, but no fault tolerance. Since the
data is striped across more than one disk, RAID 0 disk arrays achieve high
transfer rates because they can read and write data on more than one drive
simultaneously. The stripe size is configurable during unit creation. RAID 0
requires a minimum of two drives.
When drives are configured in a striped disk array (see Figure ?), large files
are distributed across the multiple disks using RAID 0 techniques.
Striped disk arrays give exceptional performance, particularly for data
intensive applications such as video editing, computer-aided design and
geographical information systems.
RAID 0 arrays are not fault tolerant. The loss of any drive results in the loss of
all the data in that array, and can even cause a system hang, depending on
your operating system. RAID 0 arrays are not recommended for high
availability systems unless additional precautions are taken to prevent system
hangs and data loss.
Figure 1. RAID 0 Configuration Example
10
3ware Serial ATA RAID Controller CLI Guide
Understanding RAID Levels and Concepts
RAID 1
RAID 1 provides fault tolerance and a speed advantage over non-RAID disks.
RAID 1 is also known as a mirrored array. Mirroring is done on pairs of
drives. Mirrored disk arrays write the same data to two different drives using
RAID 1 algorithms (see Figure ?). This gives your system fault tolerance by
preserving the data on one drive if the other drive fails. Fault tolerance is a
basic requirement for critical systems like web and database servers.
3ware uses a patented technology, TwinStor®, on RAID 1 arrays for
improved performance during sequential read operations. With TwinStor
technology, read performance is twice the speed of a single drive during
sequential read operation.
The adaptive algorithms in TwinStor technology boost performance by
distinguishing between random and sequential read requests. For the
sequential requests generated when accessing large files, both drives are used,
with the heads simultaneously reading alternating sections of the file. For the
smaller random transactions, the data is read from a single optimal drive head.
Figure 2. RAID 1 Configuration Example
RAID 5
RAID 5 provides performance, fault tolerance, high capacity, and storage
efficiency. It requires a minimum of three drives and combines striping data
with parity (exclusive OR) to restore data in case of a drive failure.
Performance and efficiency increase as the number of drives in a unit
increases.
Parity information is distributed across all of the drives in a unit rather than
being concentrated on a single disk (see Figure ?). This avoids throughput
loss due to contention for the parity drive.
RAID 5 is able to tolerate 1 drive failure in the unit.
www.3ware.com
11
Chapter 1. Introduction to the 3ware Command Line Interface
Figure 3. RAID 5 Configuration Example
RAID 6
RAID 6 requires a 3ware 9650SE RAID controller.
RAID 6 provides greater redundancy and fault tolerance than RAID 5. It is
similar to RAID 5, but has two blocks of parity information (P+Q) distributed
across all the drives of a unit, instead of the single block of RAID 5.
Due to the two parities, a RAID 6 unit can tolerate two hard drives failing
simultaneously. This also means that a RAID 6 unit may be in two different
states at the same time. For example, one sub-unit can be degraded, while
another may be rebuilding, or one sub-unit may be initializing, while another
is verifying.
RAID 6 requires a minimum of five drives. Performance and storage
efficiency also increase as the number of drives increase.
12
3ware Serial ATA RAID Controller CLI Guide
Understanding RAID Levels and Concepts
Figure 4. RAID 6 Configuration Example
RAID 10
RAID 10 is a combination of striped and mirrored arrays for fault tolerance
and high performance.
When drives are configured as a striped mirrored array, the disks are
configured using both RAID 0 and RAID 1 techniques, thus the name RAID
10 (see Figure ?). A minimum of four drives are required to use this
technique. The first two drives are mirrored as a fault tolerant array using
RAID 1. The third and fourth drives are mirrored as a second fault tolerant
array using RAID 1. The two mirrored arrays are then grouped as a striped
RAID 0 array using a two tier structure. Higher data transfer rates are
achieved by leveraging TwinStor and striping the arrays.
In addition, RAID 10 arrays offer a higher degree of fault tolerance than
RAID 1 and RAID 5, since the array can sustain multiple drive failures
without data loss. For example, in a twelve-drive RAID 10 array, up to six
drives can fail (half of each mirrored pair) and the array will continue to
function. Please note that if both halves of a mirrored pair in the RAID 10
array fail, then all of the data will be lost.
www.3ware.com
13
Chapter 1. Introduction to the 3ware Command Line Interface
Figure 5. RAID 10 Configuration Example
RAID 50
RAID 50 is a combination of RAID 5 with RAID 0. This array type provides
fault tolerance and high performance. RAID 50 requires a minimum of six
drives.
Several combinations are available with RAID 50. For example, on a 12-port
controller, you can have a grouping of 3, 4, or 6 drives. A grouping of 3 means
that the RAID 5 arrays used have 3 disks each; four of these 3-drive RAID 5
arrays are striped together to form the 12-drive RAID 50 array. On a 16-port
controller, you can have a grouping of 4 or 8 drives.
In addition, RAID 50 arrays offer a higher degree of fault tolerance than
RAID 1 and RAID 5, since the array can sustain multiple drive failures
without data loss. For example, in a twelve-drive RAID 50 array, up to one
drive in each RAID 5 set can fail and the array will continue to function.
Please note that if two or more drives in a RAID 5 set fail, then all of the data
will be lost.
14
3ware Serial ATA RAID Controller CLI Guide
Understanding RAID Levels and Concepts
Figure 6. RAID 50 Configuration Example
Single Disk
A single drive can be configured as a unit through 3ware software. (3BM,
3DM 2, or CLI). Like disks in other RAID configurations, single disks
contain 3ware Disk Control Block (DCB) information and are seen by the OS
as available units.
Single drives are not fault tolerant and therefore not recommended for high
availability systems unless additional precautions are taken to prevent system
hangs and data loss.
JBOD
A JBOD (acronym for “Just a Bunch of Disks”) is an unconfigured disk
attached to your 3ware RAID controller. JBOD configuration is no longer
supported in the 3ware 9000 series. AMCC recommends that you use Single
Disk as a replacement for JBOD, to take advantage of advanced features such
as caching, OCE, and RLM.
JBOD units are not fault tolerant and therefore not recommended for high
availability systems unless additional precautions are taken to prevent system
hangs and data loss.
www.3ware.com
15
Chapter 1. Introduction to the 3ware Command Line Interface
Hot Spare
A hot spare is a single drive, available online, so that a redundant unit can be
automatically rebuilt in case of drive failure.
Determining What RAID Level to Use
Your choice of which type of RAID unit (array) to create will depend on your
needs. You may wish to maximize speed of access, total amount of storage, or
redundant protection of data. Each type of RAID unit offers a different blend
of these characteristics.
The following table provides a brief summary of RAID type characteristics.
Table 2: RAID Configuration Types
RAID Type
Description
RAID 0
RAID 1
Provides performance, but no fault tolerance.
Provides fault tolerance and a read speed advantage over non-
RAID disks.
RAID 5
RAID 6
This type of unit provides performance, fault tolerance, and high
storage efficiency. RAID 5 units can tolerate one drive failing
before losing data.
Provides very high fault tolerance with the ability to protect
against two consecutive drive failures. Performance and
efficiency increase with higher numbers of drives.
RAID 10
A combination of striped and mirrored units for fault tolerance
and high performance.
RAID 50
A combination of RAID 5 and RAID 0. It provides high fault
tolerance and performance.
Single Disk
Not a RAID type, but supported as a configuration.
Provides for maximum disk capacity with no redundancy.
You can create one or more units, depending on the number of drives you
have installed.
Table 3: Possible Configurations Based on Number of Drives
# Drives
Possible RAID Configurations
1
2
Single disk or hot spare
RAID 0 or RAID 1
16
3ware Serial ATA RAID Controller CLI Guide
Understanding RAID Levels and Concepts
Table 3: Possible Configurations Based on Number of Drives
# Drives
Possible RAID Configurations
3
RAID 0
RAID 1 with hot spare
RAID 5
4
5
RAID 5 with hot spare
RAID 10
Combination of RAID 0, RAID 1, single disk
RAID 6
RAID 5 with hot spare
RAID 10 with hot spare
Combination of RAID 0, RAID 1, hot spare, single disk
6 or more
RAID 6
RAID 6 with hot spare
RAID 50
Combination of RAID 0, 1, 5, 6,10, hot spare, single disk
Using Drive Capacity Efficiently
To make the most efficient use of drive capacity, it is advisable to use drives
of the same capacity. This is because the capacity of each drive is limited to
the capacity of the smallest drive in the unit.
The total array capacity is defined as follows:
Table 4: Drive Capacity
RAID Level
Capacity
Single Disk
RAID 0
Capacity of the drive
(number of drives) X (capacity of the smallest drive)
Capacity of the smallest drive
RAID 1
RAID 5
(number of drives - 1) X (capacity of the smallest drive)
Storage efficiency increases with the number of disks:
storage efficiency = (number of drives -1)/(number of drives)
RAID 6
(number of drives - 2) x (capacity of the smallest drive)
(number of drives / 2) X (capacity of smallest drive)
RAID 10
www.3ware.com
17
Chapter 1. Introduction to the 3ware Command Line Interface
Table 4: Drive Capacity
RAID Level
Capacity
RAID 50
(number of drives - number of groups of drives) X (capacity of the
smallest drive)
Through drive coercion, the capacity used for each drive is rounded down so
that drives from differing manufacturers are more likely to be able to be used
as spares for each other. The capacity used for each drive is rounded down to
the nearest GB for drives under 45 GB (45,000,000,000 bytes), and rounded
down to the nearest 5 GB for drives over 45 GB. For example, a 44.3 GB
drive will be rounded down to 44 GB, and a 123 GB drive will be rounded
down to 120 GB. For more information, see the discussion of drive coercion
under “Creating a Hot Spare” on page 108.
Support for Over 2 Terabytes
Windows 2000, Windows XP (32-bit), Linux 2.4, and FreeBSD 4.x, do not
currently recognize unit capacity in excess of 2 TB.
If the combined capacity of the drives to be connected to a unit exceeds 2
Terabytes (TB), you can enable auto-carving when you configure your units.
Auto-carving divides the available unit capacity into multiple chunks of 2 TB
or smaller that can be addressed by the operating systems as separate
volumes. The carve size is adjustable from 1024 MB to 2048 MB (default)
prior to unit creation.
If a unit over 2 TB was created prior to enabling the auto-carve option, its
capacity visible to the operating system will still be 2TB; no additional
capacity will be registered. To change this, the unit has to be recreated.
For more information, see “Using Auto-Carving for Multi LUN Support” on
page 91.
18
3ware Serial ATA RAID Controller CLI Guide
2
CLI Syntax Reference
This chapter provides detailed information about using the command syntax
for the 3ware CLI.
Throughout this chapter the examples reflect the interactive method of
executing 3ware CLI.
Common Tasks Mapped to CLI Commands
The table below lists many of the tasks people use to manage their RAID
controllers and units, and lists the primary CLI command associated with
those tasks.
Table 5: Common Tasks Mapped to CLI Commands
Task
CLI Command
Page
Controller Configuration Tasks
View information about a controller /cx show
View controller policies
/cx show [attribute] [attribute]
Set policies for a controller
•
•
•
Export JBODs
/cx set exportjbod
Modify staggered spinup
Disable write cache on unit
degrade
/cx set ondegrade
•
•
•
Enable/disable autocarving
Enable/disable autorebuild
/cx set autocarve
/cx set autorebuild
Set the autocarve volume size /cx set carvesize
Unit Configuration Tasks
Create a new unit
Create a hot spare
/cx add
/cx add
www.3ware.com
19
Chapter 2. CLI Syntax Reference
Table 5: Common Tasks Mapped to CLI Commands
Task
CLI Command
Page
Enable/disable unit write cache
Set the queue policy
/cx/ux set cache
/cx/ux set qpolicy
/cx/ux set storsave
Set the storsave profile
Unit Configuration Changes
Change RAID level
Change stripe size
Expand unit capacity
Delete a unit
/cx/ux migrate
/cx/ux migrate
/cx/ux migrate
/cx/ux del
Remove a unit (export)
Name a unit
/cx/ux remove
/cx/ux set name
Controller Maintenance Tasks
Update controller with new
firmware
/cx update
Add a time slot to a rebuild
schedule
/cx add rebuild
/cx add verify
/cx add selftest
/cx set rebuild
/cx set verify
/cx set selftest
/cx show alarms
Add a time slot to a verify
schedule
Add a time slot to a selftest
schedule
Enable/disable the rebuild/migrate
schedule and set the task rate
Enable/disable the verify schedule
and set the task rate
Enable/disable the selftest
schedule
View Alarms
Unit Maintenance Tasks
Start a rebuild
/cx/ux start rebuild
/cx/ux start verify
Start a verify
Pause/resume rebuild
/cx/ux pause rebuild and /cx/ux
resume rebuild
Stop verify
/cx/ux stop verify
20
3ware Serial ATA RAID Controller CLI Guide
Syntax Overview
Table 5: Common Tasks Mapped to CLI Commands
Task
CLI Command
Page
Enable/disable autoverify
/cx/ux set autoverify
/cx/ux set identify
64
Identify all drives that make up a
unit by blinking associated LEDs
Port Tasks
Locate drive by blinking an LED
Check if LED is set to on or off
View information for specific drive
View the status of specific drive
/cx/px set identify
/cx/px show identify
/cx/px show
/cx/px show status
BBU Tasks
/cx/bbu/ show status
/cx/bbu test [quiet]
Check on charge and condition of
battery
Start a test of the battery
Enclosure Tasks
View information about an
enclosure
/ex show
Locate a particular drive slot in an
enclosure by blinking an LED
/ex/slotx set identify
Syntax Overview
The command syntax uses the general form:
Object Command Attributes
Objects are shell commands, controllers, units, ports (drives), BBUs (battery
backup units), and enclosures.
Commands can either select (show, get, present, read) attributes or alter (add,
change, set, write) attributes.
www.3ware.com
21
Chapter 2. CLI Syntax Reference
Attributes are either Boolean Attributes or Name-Value Attributes.
•
The value of a boolean attribute is deduced by presence or lack of—that
is, the attribute is either specified, or not. For example, the command
show alarms by default lists alarms with the most recent alarm first. If
you include the attribute reverse, as in the command show alarms
reverse, alarms are listed in reverse order.
•
The value of name-value attributes are expressed in the format
attribute=value.
Example: When adding (creating) a unit to the controller with the following
command string,
/c1 add type=raid1 disk=0-1
c1is the object, addis the command, type(for type of array) is an attribute
with raid1as the value of the attribute, and diskis another attribute with
0-1as the value (ports 0 through 1).
Information about commands is organized by the object on which the
commands act:
Shell Object Commands. Shell object commands set the focus or provide
information (such as alarms, diagnostics, rebuild schedules, and so forth)
about all controllers in the system. For details, see “Shell Object Commands”
Controller Object Commands. Controller object commands provide
information and perform actions related to a specific controller. For example,
you use controller object commands for such tasks as seeing alarms specific
to a controller, creating schedules during which background tasks are run, and
setting policies for the controller. You also use the controller object command
Unit Object Commands. Unit object commands provide information and
perform actions related to a specific unit on a specific controller. For example,
you use unit object commands for such tasks as seeing the rebuild, verify, or
initialize status of a unit, starting, stopping, and resuming verifies, starting
and stopping rebuilds, and setting policies for the unit. You also use the
controller object command /cx/ux migrate to change the configuration of a
Port Object Commands. Port object commands provide information and
perform actions related to a drive on a specific port. For example, you use port
object commands for such tasks as seeing the status, model, or serial number
BBU Object Commands. BBU object commands provide information and
perform actions related to a Battery Backup Unit on a specific controller. For
22
3ware Serial ATA RAID Controller CLI Guide
Shell Object Commands
Enclosure Object Commands. Enclosure object commands provide
information and perform actions related to a particular enclosure. For
example, you can use enclosure object commands to see information about an
enclosure and its elements (slots, fan, and temperature sensor elements).
Help Commands. Help commands allow you to display help information for
all commands and attributes. For details, see “Help Commands” on page 91.
Shell Object Commands
Shell object commands are either applicable to all the controllers in the
system (such as show, rescan, flush, commit), or redirect the focused object.
Syntax
focus object
show [attribute [modifier]]
ver
alarms [reverse]
diag
rebuild
verify
selftest
rescan
flush
commit
update fw=filename_with_path [force]
focus Object
The focus command is active in interactive mode only and is provided to
reduce typing.
The focus command will set the specified object in focus and change the
prompt to reflect this. This allows you to enter a command that applies to the
focus, instead of having to type the entire object name each time.
For example, where normally you might type:
//hostname/c0/u0 show
if you set the focus to //hostname/c0/u0, the prompt changes to reflect that,
and you only have to type show. The concept is similar to being in a particular
location in a file system and requesting a listing of the current directory.
object can have the following forms:
//hostname/cx/uxspecifies the fully qualified URI (Universal Resource
Identifier) of an object on host hostname, controller cx, unit ux.
www.3ware.com
23
Chapter 2. CLI Syntax Reference
//hostnamespecifies the root of host hostname.
..specifies one level up (the parent object).
/ specifies the root at the current focused hostname.
./object specifies the next level of the object.
/c0/bbu specifies a relative path with respect to the current focused
hostname.
Example:
//localhost> focus /c0/u0
//localhost/c0/u0>
//localhost/c0/u0> focus..
//localhost/c0>
//localhost> focus u0
//localhost/c0/u0>
//localhost/c0> focus /
//localhost>
The focus command is available by default. You can disable focus by setting
show
This command shows a general summary of all detected controllers.
Note that the device drivers for the appropriate operating system should be
loaded for the list to show all controllers. The intention is to provide a global
view of the environment.
Example:
Typical output of the Show command looks like the following:
//localhost> show
Ctl
-----------------------------------------------------------------------
c0 9590SE-4ME
Model
Ports
Drives Units
NotOpt
RRate
VRate
BBU
4
4
1
0
2
5
-
The output above indicates that Controller 0 is a 9590SE model with 4 Ports,
with 4 Drives detected (attached), total of 1 Unit, with no units in a NotOpt
(Not Optimal) state, RRate (Rebuild Rate) of 2, VRate (Verify Rate) of 5,
BBU of '-' (Not Applicable). Not Optimal refers to any state except OK and
VERIFYING. Other states include VERIFY-PAUSED, INITIALIZING, INIT-
PAUSED, REBUILDING, REBUILD-PAUSED, DEGRADED,
MIGRATING, MIGRATE-PAUSED, RECOVERY, INOPERABLE, and
UNKNOWN. RRate also applies to initializing, migrating, and recovery
24
3ware Serial ATA RAID Controller CLI Guide
Shell Object Commands
background tasks. (Definitions of the unit statuses are available in the 3ware
Serial ATA RAID Controller User Guide.)
For a system with an enclosure unit that includes support for an EPCT
(Enclosure Port Configuration Table), applicable firmware and software, and
an appropriate controller (9550SX, 9590SE, or 9650SE), a global view of the
environment also includes summary information about detected enclosures.
Example:
Typical output of the Show command for a system with an enclosure looks
like the following:
//localhost> show
Ctl
Model
Ports
Drives Units
NotOpt
RRate
VRate
BBU
---------------------------------------------------------------------------
c0
9650SE-4LPML
Slots Drives Fans
4
2
1
0
4
4
-
Encl
TSUnits
Ctls
---------------------------------------------------
e0
4
2
1
1
1
The output above shows the enclosure summary information with the name of
the enclosure, the protocol used, the number of drive slots, the number of
drives, the number of fans, the number of temperature sensors, and the
number of controllers that are associated with the enclosure.
show ver
This command will show the CLI and API version.
Example:
//localhost> show ver
CLI Version = 2.00.03.0xx
API Version = 2.01.00.xx
In the above example, “xx” stands for the actual version. See the Release
Notes for details.
www.3ware.com
25
Chapter 2. CLI Syntax Reference
show alarms [reverse]
This command shows the alarms or AEN messages of all controllers in the
system. The default is to display the most recent message first. The reverse
attribute displays the most recent message last.
show diag
This command shows the diagnostic information of all controllers in the
system.
show rebuild
This command displays all rebuild schedules for the 9000 controllers in the
system.
The rebuild rate is also applicable for initializing, migrating, and recovery
background tasks.
Example:
//localhost> show rebuild
Rebuild Schedule for Controller /c0
========================================================
Slot
Day
Hour
Duration
Status
--------------------------------------------------------
1
Sun
Mon
Tue
Wed
Thu
Fri
Sat
12:00am
12:00am
12:00am
12:00am
12:00am
12:00am
12:00am
24 hr(s)
24 hr(s)
24 hr(s)
24 hr(s)
24 hr(s)
24 hr(s)
24 hr(s)
disabled
disabled
disabled
disabled
disabled
disabled
disabled
2
3
4
5
6
7
For additional information about rebuild schedules, see “/cx add
rebuild=ddd:hh:duration” on page 50, and see the discussion of background
tasks and schedules in 3ware Serial ATA RAID Controller User Guide.
26
3ware Serial ATA RAID Controller CLI Guide
Shell Object Commands
show verify
This command displays all verify schedules for the 9000 controllers in the
system.
Example:
//localhost> show verify
Verify Schedule for Controller /c0
========================================================
Slot
Day
Hour
Duration
Status
--------------------------------------------------------
1
2
3
4
5
6
7
Sat
-
-
-
-
11:00pm
4 hr(s)
enabled
enabled
enabled
enabled
enabled
enabled
enabled
-
-
-
-
-
-
-
-
For additional information about verify schedules, see “/cx add
verify=ddd:hh:duration” on page 51, and see the discussion of background
tasks and schedules in 3ware Serial ATA RAID Controller User Guide.
show selftest
This command displays all selftest schedules for the 9000 controllers in the
system.
Example:
//localhost> show selftest
Selftest Schedule for Controller /c0
========================================================
Slot
Day
Hour
UDMA
SMART
--------------------------------------------------------
1
2
3
4
5
6
7
Sun
Mon
Tue
Wed
Thu
Fri
Sat
12:00am
12:00am
12:00am
12:00am
12:00am
12:00am
12:00am
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
For additional information about selftest schedules, see “/cx add
selftest=ddd:hh” on page 52, and see the discussion of background tasks and
schedules in 3ware Serial ATA RAID Controller User Guide.
www.3ware.com
27
Chapter 2. CLI Syntax Reference
flush
This command sends a flush command to all 3ware controllers in the system.
For more information, see “/cx flush” on page 44.
rescan
commit
This command sends a rescan command to all 3ware controllers in the system.
For more information, see “/cx rescan [noscan]” on page 43.
This command sends a commit command to all 3ware controllers in the
system. For more information, see “/cx commit” on page 44.
update fw=filename_with_path [force]
This command downloads the specified firmware image to the controllers that
are compatible with it and iterates through all the controllers in the system,
updating the firmware. For more information, see “/cx update
28
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
Controller Object Commands
Controller object commands provide information and perform actions related
to a specific controller, such as /c0. For example, you use controller object
commands to see alarms specific to a controller, to create schedules for when
background tasks are run, and to set policies for the controller. You also use
the controller object command /cx add type to create RAID arrays.
Syntax
/cx show
/cx show attribute [attribute ...] where attributes are:
achip|alarms|allunitstatus|autocarve (9000 series)|
autorebuild(9550SX, 9590SE, 9650SE)|bios|
carvesize(9000 series)|ctlbus(9550SX, 9590SE, 9650SE)|
diag|driver| drivestatus|exportjbod(9000 series)|
firmware|memory|model|monitor|ondegrade(9500S series)
|pcb|pchip|numdrives|numports|numunits|
rebuild(9000 series)|selftest(9000 series)|serial|
spinup|stagger|unitstatus|verify(9000 series)
/cx show all (where all means attributes and configurations)
/cx show diag
/cx show alarms [reverse]
/cx show rebuild
/cx show verify
/cx show selftest
(9000 series)
(9000 series)
(9000 series)
/cx add type=<RaidType> disk=<p:-p..> [stripe=<Stripe>]
[noscan][nocache][group=<3|4|5|6|7|8>]
[autoverify][noqpolicy][ignorECC]
[name=string](9000 series) RaidType={raid0,raid1,raid5,
raid6(9650SE only),raid10,raid50,single,spare,JBOD
(7000/8000 only)}[storsave=<protect|balance|perform>]
(9550SX, 9590SE, 9650SE)
/cx add rebuild=ddd:hh:duration
/cx add verify=ddd:hh:duration
/cx add selftest=ddd:hh
(9000 only)
(9000 only)
(9000 only)
/cx del rebuild=slot_id
/cx del verify=slot_id
/cx del selftest=slot_id
(9000 only)
(9000 only)
(9000 only)
/cx set exportjbod=on|off
(9000 only)
/cx set ondegrade=cacheoff|follow (9500S only)
/cx set spinup=nn
/cx set stagger=nn
/cx set autocarve=on|off
/cx set carvesize=[1024...2048]
(9000 only)
(9000 only)
(9000 only)
(9000 only)
/cx set rebuild=enable|disable|1..5 (9000 only)
www.3ware.com
29
Chapter 2. CLI Syntax Reference
/cx set autorebuild=on|off
(9550SX, 9590SE, 9650SE)
/cx set autodetect=on|off disk=<p:-p>|all
/cx set verify=enable|disable|1..5 (9000 only)
/cx set selftest=enable|disable [task=UDMA|SMART](9000 only)
/cx flush
/cx update fw=filename_with_path [force] (9000 only)
/cx commit
(Windows only. Also known as shutdown)
/cx start mediascan (7000/8000 only)
/cx stop mediascan (7000/8000 only)
/cx rescan [noscan] (Does not import non-JBOD on 7000/8000
models.
/cx show
This command shows summary information on the specified controller /cx.
This information is organized into a report containing two to three parts:
•
•
•
A Unit summary listing all present units
A Port summary section listing of all ports and disks attached to them.
A BBU summary section listing, if a BBU is installed on the controller.
The Unit summary section lists all present unit and specifies their unit
number, unit type (such as RAID 5), unit status (such as INITIALIZING), %R
(percent completion of rebuilding), % V/I/M (percent completion of
verifying, initializing, or migrating), stripe size, size (usable capacity) in
gigabytes or terabytes, and the auto-verify policy status (on/off)
Possible unit statuses include OK, RECOVERY, INOPERABLE,
UNKNOWN, DEGRADED, INITIALIZING, INIT-PAUSED, VERIFYING,
VERIFY-PAUSED, REBUILDING, REBUILD-PAUSED, MIGRATING, and
MIGRATE-PAUSED. Definitions of the unit statuses are available in the
3ware Serial ATA RAID Controller User Guide.
Note: If an asterisk (*) appears next to the status of a unit, there is an error on one
of the drives in the unit. This feature provides a diagnostic capability for potential
problem drives. The error may not be a repeated error, and may be caused by an
ECC error, SMART failure, or a device error. Rescanning the controller will clear the
drive error status if the condition no longer exists.
The Port summary section lists all present ports and specifies the port
number, disk status, unit affiliation, size (in gigabytes) and blocks (512 bytes),
and the serial number assigned by the disk vendor.
The BBU summary lists details about the BBU, if one is installed. It includes
a few important attributes such as hours left (in which the current BBU can
30
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
backup the controller cache in the event of power loss), temperature, voltage,
readiness, and so forth.
Additional attributes about controllers, units, ports and disks can be obtained
by querying for them explicitly. For details, see the other show subcommands.
Typical output looks like:
//localhost> /c2 show
Unit UnitType Status
%RCmpl %V/I/M Stripe Size(GB) Cache AVrfy
---------------------------------------------------------------------------
u0
u1
u2
u3
RAID-5
RAID-0
SPARE
OK
OK
OK
OK
-
-
-
-
-
-
-
-
64K
64K
-
596.004
298.002
149.042
149.001
ON
ON
-
OFF
OFF
OFF
OFF
RAID-1
-
ON
Port
Status
Unit
Size
Blocks
Serial
---------------------------------------------------------------
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
OK
OK
OK
OK
OK
OK
OK
OK
u0
u0
u0
u0
u2
u3
u0
u3
-
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
-
312581808
312581808
312581808
312581808
312581808
312581808
312581808
312581808
312581808
-
WD-WCANM1771318
WD-WCANM1757592
WD-WCANM1782201
WD-WCANM1753998
WD-WCANM1766952
WD-WCANM1882472
WD-WCANM1883862
WD-WCANM1778008
WD-WCANM1770998
-
OK
NOT-PRESENT
OK
OK
-
u1
u1
149.05 GB
149.05 GB
312581808
312581808
WD-WCANM1869003
WD-WCANM1762464
Name OnlineState BBUReady Status
Volt
Temp
Hours LastCapTest
-------------------------------------------------------------------------
bbu On Yes OK OK OK 241 22-Jun-2004
/cx show attribute [attribute ...]
This command shows the current setting of the specified attributes on the
specified controller. One or many attributes can be specified. Specifying an
invalid attribute will terminate the loop. Possible attributes are: achip,
allunitstatus, autocarve (9000 series), autorebuild (9550SX, 9590SE, and
9650SE only), bios, carvesize (9000 series), driver, drivestatus, exportjbod
(9000 series), firmware, memory, model, monitor, numdrives, numports,
numunits, ctlbus (9550SX, 9590SE, and 9650SE only), ondegrade (9500S),
pcb, pchip, qpolicy, serial, spinup (9000 series), stagger (9000 series), and
unitstatus.
Example: To see the driver and firmware installed on controller 0, enter the
following:
//localhost> /c0 show driver firmware
/c0 Driver Version = 2.x
/c0 Firmware Version = FE9X 3.x
(In the sample output above, “x” will be replaced with the actual version
number.)
www.3ware.com
31
Chapter 2. CLI Syntax Reference
/cx show driver
This command reports the device driver version associated with controller
/cx.
Example:
//localhost> /c0 show driver
/c0 Driver Version = 2.x
/cx show model
This command reports the controller model of controller /cx.
Example:
//localhost> /c0 show model
/c0 Model = 9500-x
/cx show firmware
This command reports the firmware version of controller /cx.
Example:
//localhost> /c0 show firmware
/c0 Firmware Version = FE9X 3.03.06.X03
/cx show bios
This command reports the BIOS version of controller /cx.
Example:
//localhost> /c0 show bios
/c0 BIOS Version = BG9X 2.x
/cx show monitor
This command reports the monitor (firmware boot-loader) version of
controller /cx.
Example:
//localhost> /c0 show monitor
/c0 Monitor Version = BLDR 2.x
32
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx show serial
This command reports the serial number of the specified controller /cx.
Example:
//localhost> /c0 show serial
/c0 Serial Number = F12705A3240009
/cx show pcb
This command reports the PCB (Printed Circuit Board) version of the
specified controller /cx.
Example:
//localhost> /c0 show pcb
/c0 PCB Version = RevX
/cx show pchip
This command reports the PCHIP (PCI Interface Chip) version of the
specified controller /cx.
Example:
//localhost> /c0 show pchip
/c0 PCHIP Version = 1.x
/cx show achip
This command reports the ACHIP (ATA Interface Chip) version of the
specified controller /cx.
Example:
//localhost> /c0 show achip
/c0 ACHIP Version = 3.x
/cx show numdrives
This command reports the number of drives currently managed by the
specified controller /cx. This report does not include (logically) removed or
exported drives.
On 9500S and earlier controllers, physically-removed disk(s) will still be
Example:
//localhost> /c0 show numdrives
/c0 Number of Drives = 5
www.3ware.com
33
Chapter 2. CLI Syntax Reference
/cx show numports
This command reports the port capacity (number of physical ports) of the
specified controller /cx.
Example:
//localhost> /c0 show numports
/c0 Number of Ports = 12
/cx show numunits
This command reports the number of units currently managed by the specified
controller /cx. This report does not include off-line units (or removed units).
Example:
//localhost> /c0 show numunits
/c0 Number of Units = 1
/cx show ctlbus
This feature only applies to 9550SX, 9590SE, and 9650SE controllers.
This command reports the controller host bus type, bus speed, and bus width.
Example:
//localhost> /c0 show ctlbus
/c0 Controller Bus Type = PCIX
/c0 Controller Bus Width = 64 bits
/c0 Controller Bus Speed = 133 Mhz
/cx show exportjbod
This feature only applies to 9000 series controllers.
This command reports the current JBOD Export Policy: on, off, or Not
Supported.
Example:
//localhost> /c0 show exportjbod
/c0 JBOD Export Policy = Not Supported.
//localhost> /c1 show exportjbod
/c1 JBOD Export Policy = on
34
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx show spinup
This feature only applies to 9000 series controllers.
This command reports the number of concurrent disks that will spin up when
the system is powered on, after waiting for the number of seconds specified
with the set staggercommand.
Example:
//localhost> /c0 show spinup
/c0 Disk Spinup Policy = 1
/cx show stagger
This feature only applies to 9000 series controllers.
This command reports the time delay between each group of spinups at the
power on.
Example:
//localhost> /c0 show stagger
/c0 Spinup Stagger Time Policy (sec) = 2
/cx show ondegrade
This feature only applies to 9500S controllers.
This command reports the cache policy for degraded units. If the ondegrade
policy is “Follow Unit Policy,” a unit cache policy stays the same when the
unit becomes degraded. If the ondegrade policy is off, a unit cache policy will
be forced to “off” when the unit becomes degraded.
Example:
//localhost> /c0 show ondegrade
/c0 Cache on Degraded Policy = Follow Unit Policy
/cx show autocarve
This feature only applies to 9000 series controllers.
This command reports the Auto-Carve policy. If the policy is on, all newly
created or migrated units larger than the carvesize will be automatically
carved into multiples of carvesize volumes plus one remainder volume. Each
volume can be treated as an individual drive with its own file system. The
default carvesize is 2TB. For more information see, “/cx show carvesize”,
below.
www.3ware.com
35
Chapter 2. CLI Syntax Reference
For operating systems that support units larger than 2TB, there is no need to
set the policy to on unless you want the operating system to have multiple
smaller volumes.
If you use a 32-bit operating system, it is recommended that you keep the
policy on unless you know that your operating system supports disks that are
larger than 2 TB.
When the autocarve policy is off, all newly created units will consist of one
single volume.
Example:
//localhost> /c0 show autocarve
/c0 Auto-Carving Policy = on
/cx show carvesize
This feature only applies to 9000 series controllers.
This command shows the maximum size of the volumes that will be created if
the autocarve policy is set to on. The carvesize can be set between 1024 GB
and 2048 GB. Default carvesize is 2048 GB (2 TB). For more information
Example:
//localhost> /c0 show carvesize
/c0 Auto-Carving Size = 2000 GB
/cx show memory
This command reports the size of the memory installed on the controller.
Note: The 9500S controllers ship with 128 MBytes of cache, yet only 112MB
shows as memory installed. The other 16 MB is reserved for use by the controller.
Example:
//localhost> /c0 show memory
/c0 Memory Installed = 112MB
36
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx show autorebuild
This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
This command shows the Auto-Rebuild policy. If the policy is enabled, the
firmware will select drives to use for rebuilding a degraded unit using the
following priority order. For more information, see “/cx set
1. Smallest usable spare.
2. Smallest usable unconfigured (available) drive.
3. Smallest usable failed drive.
If the policy is disabled, only spare drives will be used for an automatic
rebuild operation.
Example:
//localhost> /c0 show autorebuild
/c0 Auto-Rebuild Policy = on
/cx show unitstatus
This command presents a list of units currently managed by the specified
controller /cx, and shows their types, capacity, status, and unit policies.
Possible statuses include: OK, VERIFYING, VERIFY-PAUSED,
INITIALIZING, INIT-PAUSED, REBUILDING, REBUILD-PAUSED,
DEGRADED, MIGRATING, MIGRATE-PAUSED, RECOVERY,
INOPERABLE, and UNKNOWN. (Definitions of the unit statuses are
available in the 3ware Serial ATA RAID Controller User Guide.)
Note: If an asterisk (*) appears next to the status of a unit, there is an error on one
of the drives in the unit. This feature provides a diagnostic capability for potential
problem drives. The error may not be a repeated error, and may be caused by an
ECC error, SMART failure, or a device error. Rescanning the controller will clear the
drive error status if the condition no longer exists.
Example:
//localhost> /c2 show unitstatus
Unit UnitType Status
%RCmpl %V/I/M Stripe Size(GB) Cache AVrfy
-------------------------------------------------------------------------
u0
u1
u2
u3
RAID-5
RAID-0
SPARE
OK
OK
OK
OK
-
-
-
-
-
-
-
-
64K
64K
-
596.004
298.002
149.042
149.001
ON
ON
-
OFF
OFF
OFF
OFF
RAID-1
-
ON
www.3ware.com
37
Chapter 2. CLI Syntax Reference
/cx show allunitstatus
This command presents a count of total and Not Optimal units managed by
the specified controller /cx. For more about the meaning of Not Optimal, see
Example:
//localhost> /c0 show allunitstatus
/c0 Total Optimal Units = 2
/c0 Not Optimal Units = 0
/cx show drivestatus
This command reports a list of drives and their port assignment, status, the
unit with which they are associated, their size in gigabytes and blocks, and the
serial number assigned by the drive manufacturer. (Definitions of the drive
statuses are available in the 3ware Serial ATA RAID Controller User Guide.)
Example:
//localhost> /c0 show drivestatus
Port Status
Unit Size
Blocks
Serial
--------------------------------------------------------------
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
OK
OK
OK
OK
OK
OK
OK
OK
u0
u0
u1
u1
u1
u2
-
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
149.05 GB 312581808
3JS0TF14
3JS0TETZ
3JS0VG85
3JS0VGCY
3JS0VGGQ
3JS0VH1P
3JS0TF0P
3JS0VF43
3JS0VG8D
-
-
-
OK
NOT-PRESENT
NOT-PRESENT
NOT-PRESENT
-
-
-
-
-
-
-
-
-
-
-
38
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx show all
This command shows the current setting of all of the following attributes on
the specified controller: driver, model, memory, firmware, bios, monitor,
serial, pcb, pchip, achip, numports, numunits, numdrives, unitstatus,
drivestatus, allunitstatus, exportjbod, ondegrade, spinup, stagger and
autocarve.
Example: (where x represents the actual version number)
//localhost> /c0 show all
/c0 Driver Version = 3.x
/c0 Model = 9550SX-12
/c0 Memory Installed = 112MB
/c0 Firmware Version = FE9X 3.x
/c0 Bios Version = BE9X 3.x
/c0 Monitor Version = BL9X 3.x
/c0 Serial Number = xxxxx
/c0 PCB Version = Rev 0xx
/c0 PCHIP Version = 1.xx
/c0 ACHIP Version = 3.xx
/c0 Number of Ports = 12
/c0 Number of Units = 2
/c0 Number of Drives = 12
/c0 Total Optimal Units = 2
/c0 NotOptimalUnits = 0
/c0 Total Units = 2
/c0 JBOD Export Policy = off
/c0 Disk Spinup Policy = 7
/c0 Spinup Stagger Time Policy (sec) = 4
/c0 Cache on Degrade Policy = Follow Unit Policy
/c0 Auto-Carving Policy = off
/c0 Auto-Carving Size = 2047 GB
/c0 Auto-Rebuild Policy = enable
Unit UnitType Status
%RCmpl %V/I/M Stripe Size(GB) Cache AVerify
--------------------------------------------------------------------------
u0
u1
RAID-5
RAID-5
OK
OK
-
-
-
-
256K
256K
148.99
595.961
ON
ON
ON
OFF
Port
Status
Unit
Size
Blocks
Serial
---------------------------------------------------------------
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
u0
u0
u0
u1
u1
u1
u1
u1
u1
u1
u1
u1
74.53 GB
74.53 GB
74.53 GB
74.53 GB
74.53 GB
74.53 GB
74.53 GB
111.79 GB
111.79 GB
111.79 GB
111.79 GB
111.79 GB
156301488
156301488
156301488
156301488
156301488
156301488
156301488
234441648
234441648
234441648
234441648
234441648
3JV3MV1C
3JV3MK6B
3JV3LW52
3JV49S77
3JV3MVTA
5JV980Z0
5JV9820G
WD-WMAEL10275
WD-WMAEL10274
WD-WMAEL10281
WD-WMAEL10273
WD-WMAEL10274
Name OnlineState BBUReady Status
Volt
Temp
Hours LastCapTest
---------------------------------------------------------------------------
bbu On Yes OK OK OK 165 06-Nov-2004
www.3ware.com
39
Chapter 2. CLI Syntax Reference
/cx add type=<RaidType> disk=<p:-p>
[stripe=Stripe] [noscan] [group=<3|4|5|6|7|8>]
[nocache] [autoverify] [noqpolicy][ignoreECC]
[name=string]
[storsave=<protect|balance|perform>]
This command allows you to create a new unit on the specified controller. You
specify type, disks, and optional stripe size. By default the host operating
system will be informed of the new block device, write cache will be enabled,
and a storsave policy of protect will be set. In case of RAID 50, you can also
specify the layout of the unit by specifying the number of disks per disk group
with the groupattribute.
/cx is the controller name, for example /c0, /c1, and so forth.
type=RaidType specifies the type of RAID unit to be created. Possible unit
types include raid0, raid1, raid5, raid6 (9650SE only), raid10, raid50, single,
spare, and JBOD.
Example: type=raid5
When a new unit is created, it is automatically assigned a unique serial
number. In addition, users can assign the unit a name.
Note: The unit’s serial number cannot be changed.
The following table shows supported types and controller models.
Table 6: Supported RAID Types
Model
R0
R1
R5
R6
R10
R50 Single JBOD Spare
7K/8K
Yes
Yes
Yes
Yes
Yes
Yes
No
No
Yes
Yes
No
No
Yes
Yes
Yes
Yes
a
Yes
Yes
9000
9650SE Yes
Yes
Yes
Yes Yes
Yes
Yes
Yes
Yes
a. Models 9500S, 9550SX, and 9590SE
disk=p:-p consists of a list of ports (disks) to be used in the construction of
the specified unit type. One or more ports can be specified. Multiple ports can
be specified using a colon (:) or a dash (-) as port index separators. A dash
indicates a range and can be mixed with colons. For example disk=0:1:2-
5:9:12indicates port 0, 1, 2 through 5 (inclusive), 9 and 12.
40
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
stripe=Stripe consists of the stripe size to be used. The following table
illustrates the supported and applicable stripes on unit types and controller
models. Stripe size units are in K (kilobytes). If no stripe size is specified,
64K is used by default, if applicable. If you need to change the stripe size after
the unit is created, you can do so my migrating the unit.
Table 7: Supported Stripe Sizes (KB)
Model
R0
R1
R5
R6
R10
JBOD Spare
R50
Single
7K/8K
64
N/A
64
N/S
64
N/A
N/A
N/S
N/S
128
256
512
128
256
512
1024
16
1024
a
N/A
N/A
16
N/S 16
64
N/A
N/A
N/A
N/A
16
N/A
N/A
9000
64
64
64
256
16
256
16
256
256
16
9650SE
16
64
64
64
64
64
256
256
256
256
a. Models 9500S, 9550SX, and 9590SE
group=3|4|5|6|7|8 indicates the number of disks per group for a RAID 50
type. (This attribute can only be used when type=raid50.) Recall that a RAID
50 is a multi-tier array. At the bottom-most layer, N number of disks per group
are used to form the RAID 5 layer. These RAID 5 arrays are then integrated
into a RAID 0. This attribute allows you to specify the number of disks in the
RAID 5 level. Valid values are 3, 4, 5, 6, 7, and 8.
Note that a sufficient number of disks are required for a given pattern or disk
group. For example, given 6 disks, specifying 3 will create two RAID 5
arrays. With 12 disks, specifying 3 will create four RAID 5 arrays under the
RAID 0 level. With only 6 disks a grouping of 6 is not allowed, as you would
basically be creating a RAID 5.
The default RAID 50 grouping varies, based on number of disks. For 6 and 9
disks, default grouping is 3. For 8 disks, the default grouping is 4. For 10
disks, the default grouping is 5, and for 12 disks, the disks can be grouped into
groups of 3, 4, or 6 drives (the group of 4 drives is set by default as it provides
the best of net capacity and performance). For 15 disks, the disks can be
www.3ware.com
41
Chapter 2. CLI Syntax Reference
grouped into groups of 3 or 5 drives. For 16 disks, the disks can be grouped
into groups of 4 or 8 drives.
noscan attribute instructs CLI not to notify the operating system of the
creation of the new unit. By default CLI will inform the operating system.
One application of this feature is to prevent the operating system from
creating block special devices such as /dev/sdb and /dev/sdc as some
implementations might create naming fragmentation and a moving target.
nocache attribute instructs CLI to disable the write cache on the newly
created unit. Enabling write cache increases write performance at the cost of
potential data loss in case of sudden power loss (unless a BBU or UPS is
installed). By default the cache is enabled. To avoid the possibility of data loss
in the event of a sudden power loss, it is recommended not to set nocache
unless there is a BBU (battery backup unit) or UPS (uninterruptible power
supply) installed.
autoverify attribute enables the autoverify attribute on the unit that is to be
created. For more details on this feature, see “/cx/ux set autoverify=on|off” on
page 68. This feature is not supported on model 7000/8000. On model 9000,
the JBOD autoverify attribute is not persistent (does not survive reboots).
noqpolicy attribute instructs CLI to disable the qpolicy (drive queuing) on the
newly created unit. The default is for the qpolicy to be on (in other words,
noqpolicy is not specified). For a spare unit, specifying noqpolicy has no
effect and the default remains. If the spare unit becomes a true unit, it would
adopt the qpolicy of the “new” unit. For JBOD, the qpolicy cannot be set
during unit creation, and specifying noqpolicy returns an error. For more
ignoreECC attribute enables the ignoreECC/OverwriteECC attribute on the
unit that is to be created. For more details on this feature, see “/cx/ux set
ignoreECC=on|off” on page 69. The following table illustrates the supported
Model-Unit Types. This table only applies to setting this feature at unit
creation time. IgnoreECC only applies to redundant units. For the 7/8000
series, this setting is only applicable during rebuild; it is not applicable
during creation.
Table 8: Supported Model-Unit Types for ignoreECC
Model
R-0
R-1
R-5
R-6
R-10
R-50
Single JBOD Spare
7K/8K
No
No
No
No
N/A
N/A
No
No
No
No
No
No
No
No
a
Yes
Yes
Yes
Yes
9000
9650SE No
Yes
Yes
Yes
Yes
Yes
No
No
No
a. Models 9500S, 9550SX, and 9590SE
42
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
name=string attribute allows you to name the new unit. (This feature is for
9000 series and above controllers.) The string can be up to 21 characters and
cannot contain spaces. In order to use reserved characters (‘<‘, ‘>’, ‘!’, ‘&’,
etc.) put double quotes (" ") around the name string. The name can be changed
after the unit has been created. For more information, see “/cx/ux set
storsave=protect|balance|perform attribute allows user to set the storsave
policy of the new unit. This feature is only for 9550SX, 9590SE, and 9650SE
controllers. For more information, see “/cx/ux set
/cx rescan [noscan]
This command instructs the controller to rescan all ports and reconstitute all
units. The controller will update its list of ports (attached disks), and attempts
to read every DCB (Disk Configuration Block) in order to re-assemble its
view and awareness of logical units. Any newly found unit(s) or drive(s) will
be listed.
noscan is used to not inform the operating system of the unit discovery. The
default is to inform the operating system.
Note: If you are adding new drives, add them physically before issuing the rescan
commands. Hot swap carriers are required unless you first power-down the system
to prevent system hangs and electrical damage.
Example:
//localhost> /c1 rescan
Rescanning controller /c1 for units and drives ...Done
Found following unit(s): [/c1/u3]
Found following drive(s): [/c1/p7, /c1/p8]
Note: Rescanning does not import non-JBOD on 7000/8000 models.
www.3ware.com
43
Chapter 2. CLI Syntax Reference
/cx commit
This command only applies to the Windows operating system. It commits all
changes if a faster shutdown method is needed when running certain database
applications. Linux and FreeBSD file systems do not require this command
since they have their own ways of notifying the controller to do clean up for
shut down.
/cx flush
This command forces the controller to write all cached data to disk for the
specified controller.
/cx update fw=filename_with_path [force]
This command is only for 9000 series controllers.
This command allows the downloading of the specified firmware image to the
corresponding controller.
Note: Before issuing this command, you must have already obtained the
firmware image and placed it on your system. You can obtain the firmware
image from the 3ware website: http:www.3ware.com/downloads.
fw=filename_with_path attribute allows you to specify the firmware image
file name along with its absolute path. The new image specified by this
filename_with_path is checked for compatibility with the current controller,
current driver, and current application versions. A recommendation is then
made as to whether an update is needed, and you are asked to confirm whether
you want to continue. If you confirm that you want to continue, the new
firmware image is downloaded to the specified controller.
A reboot is required for the new firmware image to take effect.
Example:
//localhost> /c0 update fw=/tmp/prom0006.img
Warning: We strongly recommend backing up your data before
updating the firmware. Updating the firmware can render the
device driver and/or management tools incompatible. It is
recommended to have a copy of current firmware image for
rollbacks.
Examining compatibility data from firmware image and /c0 ...
Done.
New-Firmware
----------------------------------------------------------------------
FE9X 3.05.00.005 FE9X 3.05.00.005 2.26.04.007 2.01.00.008
Current-Firmware
Current-Driver
Current-API
Current firmware version is the same as the new firmware.
Recommendation: No need to update.
44
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
Given the above recommendation...
Do you want to continue ? Y|N [N]: y
Downloading the firmware from file /tmp/prom0006.img ... Done.
The new image will take effect after reboot.
force attribute is optional. If you include it, the compatibility checks are
bypassed.
/cx show alarms [reverse]
Asynchronous events (also referred to as AENs or alarms) are originated by
firmware and captured by their respective device drivers. These events reflect
warning, debugging, and/or informative messages for the end user. These
events are kept in a finite queue inside the kernel, awaiting extraction by user
space programs such as CLI and/or 3DM.
The /cx show alarms command displays all available alarms on a given
controller. The default is to display the most recent alarm or AEN message
first. The user can also use the [reverse] attribute to display the most recent
alarm or AEN message last.
Alarms generated on 7000/8000 controllers do not have dates, so you will see
a '-' in the Date column. This means that it is not applicable. In addition,
alarm messages on 7000/8000 controllers contain the severity in the message
text, so the Severity column also shows a '-'.
Typical output looks like:
tw_cli> /c1 show alarms reverse
Ctl Date
--------------------------------------------------------------------------------------------
Severity Message
c1 [Fri Nov 28 04:26:31 2003] ERROR
c1 [Fri Nov 28 06:13:54 2003] INFO
c1 [Fri Nov 28 06:30:35 2003] INFO
c1 [Fri Nov 28 06:33:00 2003] ERROR
c1 [Fri Nov 28 06:33:04 2003] ERROR
c1 [Fri Nov 28 06:33:46 2003] INFO
c1 [Fri Nov 28 06:37:58 2003] INFO
c1 [Fri Nov 28 07:51:34 2003] INFO
c1 [Fri Nov 28 07:59:43 2003] INFO
c1 [Mon Dec 1 02:26:12 2003] ERROR
(0x04:0x0002): Degraded unit detected:unit=0, port=2
(0x04:0x000B): Rebuild started: unit=0
(0x04:0x003B): Background rebuild paused:unit=0
(0x04:0x0002): Degraded unit detected:unit=0, port=0
(0x04:0x0002): Degraded unit detected:unit=0, port=4
(0x04:0x000B): Rebuild started: unit=0
(0x04:0x000B): Rebuild started: unit=0
(0x04:0x0005): Background rebuild done:unit=0
(0x04:0x0005): Background rebuild done:unit=0
(0x04:0x0002): Degraded unit detected:unit=0, port=3
www.3ware.com
45
Chapter 2. CLI Syntax Reference
/cx show diag
This command extracts controller diagnostics suitable for technical support
usage. Note that some characters might not be printable or rendered correctly
(human readable). It is recommended to save the output from this command to
a file, where it can be communicated to technical support or further studied
with Linux utilities such as od(1).
In order to redirect the output you must run the following command from a
command line, not from within the tw_cli shell.
tw_cli /c0 show diag > diag.txt
/cx show rebuild
9000 series controllers support background tasks and allow you to schedule a
regular time when they occur.
Rebuild is one of the supported background tasks. Migrate and initialize are
other background tasks that follow the same schedule as rebuild. Other
background tasks for which there are separate schedules are verify and
selftest. For each background task, up to 7 time periods can be registered,
known as slots 1 through 7. Each task schedule can be managed by a set of
commands including add, del, show and set a task. Background task
schedules have a slot id, start-day-time, duration, and status attributes.
For details about setting up a schedule for background rebuild tasks, see
Rebuild activity attempts to (re)synchronize all members of redundant units
such as RAID-1, RAID-10, RAID-5 and RAID-50. Rebuild can be started
manually or automatically if a spare has been defined. Scheduled rebuilds will
take place during the scheduled time slot, if enabled the schedules are
enabled. For in depth information about rebuild and other background tasks,
see “About Background Tasks” in the 3ware Serial ATA RAID Controller
User Guide.
The show rebuild command displays the current rebuild background task
schedule as illustrated below.
//localhost> /c1 show rebuild
Rebuild Schedule for Controller /c1
========================================================
Slot
Day
Hour
Duration
Status
--------------------------------------------------------
1
2
3
4
5
6
7
Mon
Thu
-
-
-
2:00pm
7:00pm
-
-
10 hr(s)
18 hr(s)
-
-
disabled
disabled
disabled
disabled
disabled
disabled
disabled
-
-
Mon
Sun
1:00am
12:00am
4 hr(s)
1 hr(s)
46
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
A status of “disabled” indicates that the task schedule is disabled. In this case,
the controller will not use the defined schedule timeslots. If the rebuild
command is entered manually, rebuilding will start within 10 to 15 minutes. It
will begin automatically if a rebuild is needed and a proper spare drive is set
up.
If the rebuild schedule is enabled while a rebuild process is underway, the
rebuild will pause until a scheduled time slot.
Example:
If a unit is in the initialization state at noon on Wednesday and the rebuild
schedule shown above is in use (with schedules disabled), you would see the
following status using the show command:
$ tw_cli /c1 show
Unit UnitType Status
%RCmpl %V/I/M Stripe Size(GB) Cache AVrfy
--------------------------------------------------------------------------
u0
RAID-5
Status
INITIALIZING
Unit
0
-
64K
521.466
ON
OFF
Port
Size
Blocks
Serial
---------------------------------------------------------------
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
NOT-PRESENT
OK
NOT-PRESENT
OK
NOT-PRESENT
OK
NOT-PRESENT
OK
OK
OK
OK
OK
-
u0
-
u0
-
u0
-
u0
u0
u0
u0
u0
-
-
-
76.33 GB
-
76.33 GB
-
76.33 GB
-
76.33 GB
74.53 GB
74.53 GB
74.53 GB
74.53 GB
160086528
-
160086528
-
160086528
-
160086528
156301488
156301488
156301488
156301488
Y2NXL7FE
-
Y2NXLB9E
-
Y2NXQPZE
-
Y2NXM4VE
3JV3WTSE
3JV3WRHC
3JV3WQLQ
3JV3WQLZ
Name OnlineState BBUReady Status
Volt
Temp
Hours LastCapTest
--------------------------------------------------------------------------
bbu On Yes OK OK OK xx-xxx-xxxx
0
If you then enable the rebuild schedules, the unit initialization will be paused
until the next scheduled time slot, as reflected in the examples below:
//localhost> /c1 set rebuild=enable
Enabling scheduled rebuilds on controller /c1 ...Done.
//localhost> /c1 show rebuild
Rebuild Schedule for Controller /c1
========================================================
Slot
Day
Hour
Duration
Status
--------------------------------------------------------
1
2
3
4
5
6
7
Mon
Thu
-
-
-
2:00pm
7:00pm
-
-
10 hr(s)
18 hr(s)
-
-
enabled
enabled
-
-
-
-
-
Mon
Sun
1:00am
12:00am
4 hr(s)
1 hr(s)
enabled
enabled
$ tw_cli /c1 show
Unit UnitType Status
%RCmpl %V/I/M Stripe Size(GB) Cache AVrfy
www.3ware.com
47
Chapter 2. CLI Syntax Reference
--------------------------------------------------------------------------
u0
RAID-5
INITIALIZING 0
-
64K
521.466
ON
OFF
Port
Status
Unit
Size
Blocks
Serial
---------------------------------------------------------------
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
NOT-PRESENT
OK
NOT-PRESENT
OK
NOT-PRESENT
OK
NOT-PRESENT
OK
OK
OK
OK
OK
-
u0
-
u0
-
u0
-
u0
u0
u0
u0
u0
-
-
-
76.33 GB
-
76.33 GB
-
76.33 GB
-
76.33 GB
74.53 GB
74.53 GB
74.53 GB
74.53 GB
160086528
-
160086528
-
160086528
-
160086528
156301488
156301488
156301488
156301488
Y2NXL7FE
-
Y2NXLB9E
-
Y2NXQPZE
-
Y2NXM4VE
3JV3WTSE
3JV3WRHC
3JV3WQLQ
3JV3WQLZ
Name OnlineState BBUReady Status
Volt
Temp
Hours LastCapTest
---------------------------------------------------------------------------
bbu
On
Yes
OK
OK
OK
0
xx-xxx-xxxx
/cx show verify
9000 series controllers support background tasks and allow you to schedule a
regular time when they occur.
Verify is one of the supported background tasks. Rebuild and selftest are other
background tasks for which there are separate schedules. Migrate and
initialize are additional background tasks that follow the same schedule as
rebuild. For each background task, up to 7 time periods can be registered,
known as slots 1 through 7. Each task schedule can be managed by a set of
commands including add, del, show and set a task. Background task
schedules have a slot id, start-day-time, duration, and status attributes.
For details about setting up a schedule for background verify tasks, see
Verify activity verifies all units based on their unit type. Verifying RAID 1
involves checking that both drives contain the exact data. On RAID 5 and
RAID 6, the parity information is used to verify data integrity. RAID 10 and
50 are composite types and follow their respective array types. On 9000
series, non-redundant units such as RAID 0, JBOD, single, and spare, are also
verified (by reading and reporting un-readable sectors). If any parity
mismatches are found, the array will be automatically background initialized.
(For information about the initialization process, see the user guide that came
with your 3ware RAID controller.)
The show verify command displays the current verify background task
schedule as illustrated below.
48
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
//localhost> /c1 show verify
Verify Schedule for Controller /c1
========================================================
Slot Day Hour Duration Status
--------------------------------------------------------
1
2
3
4
5
6
7
Mon
-
2:00am
-
4 hr(s)
-
disabled
disabled
disabled
disabled
disabled
disabled
disabled
Tue
Wed
Thu
Fri
Sat
12:00am
12:00am
12:00am
12:00am
12:00am
24 hr(s)
24 hr(s)
24 hr(s)
24 hr(s)
24 hr(s)
A status of “disabled” indicates that the controller will not use the defined
schedule timeslots and will start verifying immediately (within 10 to 15
minutes), if the verify command is entered manually, or it will begin
automatically if the autoverify option is set. Rebuilds, migrations, and
initializations will take priority over verifies.
/cx show selftest
9000 series controllers support background tasks and allow you to schedule a
regular time when they occur.
Selftest is one of the supported background tasks. Rebuild and verify are other
background tasks for which there are separate schedules. Migrate and
initialize are additional background tasks that follow the same schedule as
rebuild. For each background task, up to 7 time periods can be registered,
known as slots 1 through 7. Each task schedule can be managed by a set of
commands including add, del, show and set a task. Background task
schedules have a slot id, start-day-time, duration, and status attributes.
For details about setting up a schedule for background selftest tasks, see
Selftest activity provides two types of selftests; UDMA (Ultra Direct
Memory Access) and SMART (Self Monitoring Analysis and Reporting).
Both self tests are checked once each day by default.
UDMA self test entails checking the current ATA bus speed (between
controller and attached disk), which could have been throttled down during
previous operations and increase the speed for best performance (usually one
level higher). Possible speeds include 33, 66, 100 and 133 Mhz (at this
writing). Note that UDMA selftest is not applicable (or required) with SATA
drives, but is left enabled by default.
SMART activity instructs the controller to check certain SMART supported
thresholds by the disk vendor. An AEN is logged to the alarms page if a drive
reports a SMART failure.
www.3ware.com
49
Chapter 2. CLI Syntax Reference
The show selftest command displays the current selftest background task
schedule as illustrated below. Selftests do not have a time duration since they
are completed momentarily.
//localhost> /c1 show selftest
Selftest Schedule for Controller /c1
========================================================
Slot
Day
Hour
UDMA
SMART
--------------------------------------------------------
1
2
3
4
5
6
7
Sun
Mon
Tue
Wed
Thu
Fri
Sat
12:00am
12:00am
12:00am
12:00am
12:00am
12:00am
12:00am
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
enabled
/cx add rebuild=ddd:hh:duration
This command adds a new background rebuild task to be executed on the day
ddd (where ddd is Sun, Mon, Tue, Wed, Thu, Fri, and Sat), at the hour hh
(range 0 .. 23), for a duration of duration (range 1 .. 24) hours. A maximum of
seven rebuild tasks can be scheduled. This command will fail if no (empty)
task slot is available.
Example:
//localhost> /c1 add rebuild=Sun:16:3
adds a rebuild background task schedule to be executed on Sundays at 16
hours (4:00 PM) for a duration of 3 hours.
Setting Up a Rebuild Schedule
Setting up a rebuild schedule requires several steps, and several different CLI
commands in addition to /cx add rebuild.
To set up the rebuild schedule you want to use, follow this
process:
1
Use the /cx show rebuild command to display the current schedule for
2
If any of the scheduled tasks do not match your desired schedule, use the
50
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
3
4
Use the /cx add rebuild command to create the rebuild schedule slots you
want (described above.)
Use the /cx set rebuild=enable command to enable the schedule (this
enables all rebuild schedule slots). (For details, see page 53.)
Warning: If all time slots are removed, be sure to also disable the schedule.
Otherwise the applicable background task will never occur.
/cx add verify=ddd:hh:duration
This command adds a new background verify task to be executed on the day
ddd (where ddd is Sun, Mon, Tue, Wed, Thu, Fri, and Sat), at hour hh
(range 0 .. 23), for a duration of duration (range 1 .. 24) hours. A maximum of
seven verify tasks can be scheduled. This command will fail if no (empty)
task slot is available.
Example:
//localhost> /c1 add verify=Sun:16:3
adds a verify background task schedule to be executed on Sundays at 16
hours (4:00 PM) for a duration of 3 hours.
Setting Up a Verify Schedule
Setting up a verify schedule requires several steps, and several different CLI
commands in addition to /cx add verify.
To set up the verify schedule you want to use, follow this
process:
1
2
3
4
5
Use the /cx show verify command to display the current schedule for
verify tasks. (For details, see page 48.)
If any of the scheduled tasks do not match your desired schedule, use
Use the /cx add verify command to create the verify schedule slots you
want (described above.)
Use the /cx set verify=enable command to enable the schedule (this
enables all rebuild schedule slots). (For details, see page 54.)
Use the /cx/ux set autoverify=on command to turn on autoverify for each
www.3ware.com
51
Chapter 2. CLI Syntax Reference
Note: If you do not enable autoverify for units or start a verification manually, your
verify schedule will not run, even if it is enabled with the
/cx set verify=enable command.
Warning: If all time slots are removed, be sure to also disable the schedule.
Otherwise the applicable background task will never occur
/cx add selftest=ddd:hh
This command adds a new background selftest task to be executed on the day
ddd (where ddd is Sun, Mon, Tue, Wed, Thu, Fri, and Sat), at hour hh
(range 0 .. 23). Notice that selftest runs to completion and as such no duration
is provided. A maximum of seven selftest tasks can be scheduled. This
command will fail if no (empty) task slot is available.
Example:
//localhost> /c1 add selftest=Sun:16
adds a selftest background task schedule to be executed on Sundays at 16
hours (4:00 PM).
Setting Up a Selftest Schedule
Setting up a selftest schedule requires several steps, and several different CLI
commands in addition to /cx add selftest.
To set up the selftest schedule you want to use, follow this
process:
1
2
3
4
Use the /cx show selftest command to display the current schedule for
selftest tasks. (For details, see page 49.)
If any of the scheduled tasks do not match your desired schedule, use
Use the /cx add selftest command to create the selftest schedule slots you
want (described above.)
Use the /cx set selftest=enable command to enable the schedule (this
enables all selftest schedule slots). (For details, see page 54.)
52
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx del rebuild=slot_id
This command removes the rebuild background task in slot slot_id.
Example:
//localhost> /c1 del rebuild=2
removes the rebuild background task in slot 2.
Warning: If all time slots are removed, be sure to also disable the schedule.
Otherwise the applicable background task will never occur
/cx del verify=slot_id
This command removes the verify background task in slot slot_id.
Example:
//localhost> /c1 del verify=3
removes verify background task in slot 3.
Warning: If all time slots are removed, be sure to also disable the schedule.
Otherwise the applicable background task will never occur
/cx del selftest=slot_id
This command removes (or unregisters) the selftest background task in slot
slot_id.
Example:
//localhost> /c1 del selftest=3
Will remove selftest background task in slot 3.
Warning: If all time slots are removed, be sure to also disable the schedule.
Otherwise the selftest background task will never occur.
/cx set rebuild=enable|disable|1..5
This command enables or disables all rebuild background task slots on
controller /cx and sets the priority of rebuild versus I/O operations. When
enabled, rebuild tasks will only be run during the time slots scheduled for
rebuilds. If a rebuild is taking place when the schedule is enabled, it will be
paused until the next scheduled time.
www.3ware.com
53
Chapter 2. CLI Syntax Reference
The priority of rebuild versus I/O operations is specified with 1..5, where 1 is
more resources and 5 the least. Setting the value to 1 gives maximum
processing time to rebuilds rather than I/O. Setting the value to 5 gives
maximum processing time to I/O rather than rebuilds.
Enabling and disabling rebuild schedules is only for 9000 models, however
the rebuild rate (1..5) applies to all controllers.
7000- and 8000-series controllers have only one setting for Task Rate; it
applies to both rebuild and verify rates. This rate is not persistent following a
reboot for 7000- and 8000-series controllers.
/cx set verify=enable|disable|1..5
This command enables or disables all verify background task slots on
controller /cx and (when enabled) sets the priority of verification versus I/O
operations. When enabled, verify tasks will only be run during the time slots
scheduled for verifies. If a verify is taking place when the schedule is enabled,
it will be paused until the next scheduled time.
The priority of verify versus I/O operations is specified with 1..5, where 1 is
more resources and 5 the least. Setting this value to 1 implies fastest verify,
and 5 implies fastest I/O.
Enabling and disabling verify schedules is only for 9000 models, however the
verify rate (1..5) applies to all controllers.
Note: When enabling the verify schedule you must also remember to enable the
autoverify setting for the units to be verified. For more information see
/cx set selftest=enable|disable
[task=UDMA|SMART]
This command enables or disables all selftest tasks or a particular
selftest_task (UDMA or SMART).
Enabling and disabling selftest is only for 9000 models. 7/8000 models have
the same internal schedule, but it is not viewable or changeable.
Example:
//localhost> /c0 selftest=enable task=UDMA
enables UDMA selftest on controller c0.
54
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx set exportjbod=on|off
This command allows you to set the JBOD Export Policy to on or off. By
default, exportjbod is off.
If the JBOD export policy is off, CLI will not be able to create JBODs. During
reboot, firmware will not export JBOD units to the operating system.
The JBOD Export Policy is only supported on 9000-series controllers.
Previous models did not have such a policy enforcement feature.
A JBOD is an unconfigured disk attached to your 3ware RAID controller.
AMCC recommends that you use Single Disk as a replacement for JBOD, to
take advantage of features such as RAID level migration.
/cx set ondegrade=cacheoff|follow
This command is only for 9500S controllers.
This command allows you to set a controller-based write cache policy. If the
policy is set to cacheoff and a unit degrades, the firmware will disable the
write-cache on the degraded unit, regardless of what the unit-based write
cache policy is. If the policy is set to follow and a unit degrades, firmware will
follow whatever cache policy has been set for that unit. (For details about the
/cx set spinup=nn
This command is only for 9000 series controllers.
This command allows you to set a controller-based Disk Spinup Policy that
specifies how many drives can spin up at one time. The value must be a
positive integer between 1 and the number of disks/ports supported on the
controller (4, 8, or 12). The default is 1.
This policy is used to stagger spinups of disks at boot time in order to spread
the power consumption on the power supply. For example, given a spinup
policy of 2, the controller will spin up two disks at a time, pause, and then spin
up another 2 disks. The amount of time to pause can be specified with the
Spinup Stagger Time Policy (/cx set stagger).
Not all drives support staggered spinup. If you enable staggered spinup and
have drives that do not support it, the setting will be ignored.
www.3ware.com
55
Chapter 2. CLI Syntax Reference
/cx set stagger=nn
This command is only for 9000 series controllers.
This command allows you to set a controller-based Disk Spinup Stagger Time
Policy that specifies the delay between spin-ups. The value must be a positive
integer between 0 to 60 seconds. This policy, in conjunction with Disk Spinup
Policy, specifies how the controller should spin up disks at boot time. The
default is 6 seconds.
/cx set autocarve=on|off
This command is only for 9000 series controllers.
This command allows you to set the auto-carve policy to on or off. By default,
autocarve is off.
When the auto-carve policy is set to on, any unit larger than the carvesize is
created or migrated into one or more carvesize volumes and a remaining
volume. Each volume can then be treated as an individual disk with its own
file system. The default carvesize is 2 TB.
This feature is useful for operating systems limited to 2TB file systems.
For example, using the 2 TB default carvesize, a 3 TB unit will be configured
into one 2 TB volume and one 1 TB volume. A 5 TB unit will be configured
into two 2 TB volumes and one 1 TB volume.
When auto-carve policy is set to off, all new units are created as a single large
volume. If the operating system can only recognize up to 2 TBs, space over 2
TB will not be available.
Example:
//localhost> /c0 set autocarve=on
Setting Auto-Carving Policy on /c0 to on ... Done.
/cx set carvesize=[1024..2048]
This command is only for 9000 series controllers.
This command allows you to set the carve size in GB. This feature works
together with autocarve. See “/cx set autocarve=on|off” above for details.
Example:
//localhost> /c0 set carvesize=2000
Setting Auto-Carving Size on /c0 to 2000 GB ... Done.
56
3ware Serial ATA RAID Controller CLI Guide
Controller Object Commands
/cx set autorebuild=on|off
This command is only for 9550SX , 9590SE, and 9650SE controllers.
This command turns the Auto-Rebuild policy on or off. By default,
autorebuild is on.
If the policy is on the firmware will select drives to use for rebuilding a
degraded unit using the following priority order.
1. Smallest usable spare.
2. Smallest usable unconfigured (available) drive.
3. Smallest usable failed drive.
Note: Failed drives can be drives that have mechanically failed, or they can be
drives that have been disconnected from the controller long enough for the
controller to classify them as failed.
Enabling Auto-Rebuild allows you to add a drive to the controller and have it
be available for a rebuild as soon as you tell the controller to rescan, without
having to specify it as a spare. It also means that if you accidentally
disconnect a drive (causing the controller to see it as a failed drive) and then
reconnect it, the controller will automatically try to use it again.
If the policy is off, spares are the only candidates for rebuild operations.
Example:
//localhost> /c0 set autorebuild=enable
Setting Auto-Rebuild Policy on /c0 to enable ... Done.
/cx set autodetect=on|off disk=<p:-p>|all
This command is only for 9000 series controllers.
This command is associated with the staggered spin-up feature when hot-
swapping drives. When staggered spin-up is enabled (see command /cx set
spinup and /cx set stagger), during a reset or power on, the controller will spin
up all detected drives with a delay between each spinup, allowing the spread
of power consumption on the power supply. When a drive is hot-swapped, (as
opposed to when it has just been powered on or reset), the default behavior of
the system is immediate spin-up. This command can change the default
behavior and set the controller to do a staggered spinup for hot-swapped
drives.
Note: The autodetect setting cannot be shown in CLI or displayed in 3DM or 3BM.
This feature may be added in a future release.
www.3ware.com
57
Chapter 2. CLI Syntax Reference
autodetect=on|off enables or disables automatic detection of drives on the
controller’s ports for staggered spin-up.
disk=<p:-p>|all specifies one or many disks (that is, drives or ports). If a port
is empty (no drive is inserted), this feature is disabled for that port and its port
number is shown. The example below shows that autodetect has been set to
off to initiate staggered spin-up during hot-swapping, where port 3 was empty
and ports 5 and 6 had drives inserted.
Example:
//localhost>> /c0 set autodetect=off disk=3:5-6
Setting Auto-Detect on /c0 to [off] for port [3] and for disk
[5,6]... Done
If “disk=all,” then all of the drives or ports for that controller are specified.
For example:
//localhost>> /c0 set autodetect=off disk=all
Setting Auto-Detect on /c2 to [off] for all disks/ports... Done.
Usage Scenario:
If you are hot-plugging a large number of drives at the same time and are
concerned that you might overload the power supply, you might use this
command as follows:
1
Issue the command (set autodetect=off) to disable automatic detection of
the ports for staggered spin-up.
2
3
4
If the ports are not emply, pull the drives out of the specified ports.
Insert (or replace) the drives at the ports specified.
Issue the command (set autodetect=on) to enable auto detect of the ports
with the newly inserted drives.
The preceding steps would spin up the newly inserted drives in a staggered
manner. Please note that the command takes longer for ports that do not have
drives inserted, since the controller allows time for the empty ports to
respond.
/cx start mediascan
This command applies only to 7000/8000 controllers. For 9000 series
controllers, use the verify command.
This command provides media scrubbing for validating the functionality of a
disk, including bad block detection, remapping, and so forth. The command
starts a media scan operation on the specified controller /cx.
58
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
/cx stop mediascan
This command applies only to 7000/8000 controllers.
This commands stops a media scan operation on the specified controller /cx.
(Media scans are started using /cx start mediascan.)
Unit Object Commands
Unit Object commands provide information and perform actions related to a
specific unit, such as /c0/u1 (unit 1 on controller 0). For example, you use
logical disk object commands for such tasks as seeing the rebuild, verify, or
initialize status of a unit, starting, stopping, and resuming rebuilds and
verifies, and setting policies for the unit.
Syntax
/cx/ux show
/cx/ux show attribute [attribute ...] where attributes are:
initializestatus|cache|name(9000 series)|
qpolicy(9550SX, 9590SE, 9650SE)|rebuildstatus|
serial(9000 series)|status|verifystatus|
storsave(9550SX, 9590SE, 9650SE)|volumes(9000 series)|
ignoreECC (9000 series)|identify (9550SX, 9590SE,
9650SE)
/cx/ux show all
/cx/ux start rebuild disk=<p:-p...> [ignoreECC]
/cx/ux start verify
/cx/ux pause rebuild
/cx/ux resume rebuild
(7000/8000 only)
(7000/8000 only)
/cx/ux stop verify
/cx/ux flush
/cx/ux del [noscan] [quiet]
/cx/ux set autoverify=on|off
/cx/ux set cache=on|off [quiet]
/cx/ux set identify=on|off
/cx/ux set ignoreECC=on|off
/cx/ux set qpolicy=on|off
/cx/ux set name=string
(9550SX, 9590SE, 9650SE only)
(9550SX, 9590SE, 9650SE only)
(9000 series)
/cx/ux set storsave=protect|balance|perform [quiet](9550SX,
9590SE, 9650SE)
/cx/ux migrate type=RaidType [disk=p:-p] [group=3|4|5|6|7|8]
[stripe=Stripe] [noscan] [nocache] [autoverify]
(9000 series) RaidType = {raid0, raid1, raid5,
raid6(9650SE only), raid10, raid50, single}
/cx/ux remove [noscan] [quiet]
www.3ware.com
59
Chapter 2. CLI Syntax Reference
/cx/ux show
This command shows summary information about the specified unit /cx/ux. If
the unit consists of sub-units as with the case of RAID-1, RAID-5, RAID-10,
RAID-50, then each sub-unit is further presented. If the Auto-Carving policy
was on at the time the unit was created and the unit is over the carve size,
multiple volumes were created and are displayed at the end of the summary
information. Similarly, if the unit was created using the 3ware BIOS utility
3BM and a size was entered in the Boot Volume Size field, multiple volumes
were created and will be displayed. (Note that a volume created using the
Boot Volume Size feature does not have to be used as a boot volume.)
One application of the /cx/ux show command is to see which sub-unit of a
degraded unit has caused the unit to degrade and which disk within that sub-
unit is the source of degradation. Another application is to see the source and
destination units during a migration.
Example:
//localhost> /c0/u0 show
Unit
UnitType Status
%RCmpl %V/I/M Port Stripe Size(GB)
------------------------------------------------------------------------
u0
u0-0
RAID-50
RAID-5
DISK
DISK
DISK
RAID-5
DISK
DISK
OK
OK
OK
OK
OK
OK
OK
OK
OK
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
64K
64K
-
-
-
64K
-
-
596.05
-
149.10
149.10
149.10
-
149.10
149.10
149.10
u0-0-0
u0-0-1
u0-0-2
u0-1
u0-1-0
u0-1-1
u0-1-2
p0
p2
p3
-
p4
p5
p6
DISK
-
//localhost> /c0/u1 show
Unit
UnitType Status
%RCmpl %V/I/M Port Stripe Size(GB)
------------------------------------------------------------------------
u1
RAID-0
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
Volume
Volume
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
64K
-
-
-
-
-
-
-
-
-
-
-
-
-
-
3576.06
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
2047.00
1529.06
u1-0
u1-1
u1-2
u1-3
u1-4
u1-5
u1-6
u1-7
u1-8
u1-9
u1-10
u1-11
u1/v0
u1/v1
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
-
-
-
60
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
/cx/ux show attribute [attribute ...]
This command shows the current setting of the specified attributes. One or
many attributes can be requested. Specifying an invalid attribute will
terminate the loop. Possible attributes are: initializestatus, name (9000 series),
qpolicy (9550SX, 9590SE, and 9650SE only), rebuildstatus, serial (9000
series), status, storsave (9550SX, 9590SE, and 9650SE only), verifystatus,
volumes (9000 series), autoverify (9000 series), cache, ignoreECC (9000
series), and identify (9550SX, 9590SE, and 9650SE only).
/cx/ux show status
This command reports the status of the specified unit.
Possible statuses include: OK, VERIFYING, VERIFY-PAUSED,
INITIALIZING, INIT-PAUSED, REBUILDING, REBUILD-PAUSED,
DEGRADED, MIGRATING, MIGRATE-PAUSED, RECOVERY,
INOPERABLE, and UNKNOWN. (Definitions of the unit statuses are
available in the 3ware Serial ATA RAID Controller User Guide.)
Example:
//localhost> /c0/u0 show status
/c0/u5 status = OK
/cx/ux show rebuildstatus
This command reports the rebuildstatus (if any) of the specified unit.
Example:
//localhost> /c0/u5 show rebuildstatus
/c0/u5 is not rebuilding, its current state is OK
If the unit is in the process of migrating, the command will return the
following:
//localhost> /c0/u5 show rebuildstatus
/c0/u5 is not rebuilding, its current state is MIGRATING
/cx/ux show verifystatus
This command reports the verifystatus (if any) of the specified unit.
Example:
//localhost> /c0/u5 show verifystatus
/c0/u5 is not verifying, its current state is OK
www.3ware.com
61
Chapter 2. CLI Syntax Reference
/cx/ux show initializestatus
This command reports the initializestatus (if any) of the specified unit.
Example:
//localhost> /c0/u5 show initializestatus
/c0/u5 is not initializing, its current state is OK
/cx/ux show name
This feature only applies to 9000 series controllers.
This command reports the name (if any) of the specified unit.
Example:
//localhost> /c0/u5 show name
/c0/u5 name = Joe
/cx/ux show serial
This feature only applies to 9000 series controllers.
This command reports the unique serial number of the specified unit.
Example:
//localhost> /c0/u5 show serial
/c0/u5 Serial Number = 12345678901234567890
/cx/ux show qpolicy
This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
This command reports the queue policy of the firmware. If the queue policy is
on, the firmware utilizes the drive queueing policy. If some drives in the unit
do not support a queueing policy, this policy will have no effect on those
drives.
Note that currently only NCQ will be enabled, not tag-queueing.
Example:
//localhost> /c0/u5 show qpolicy
/c0/u5 Command Queuing Policy = on
62
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
/cx/ux show storsave
This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
This command reports the storsave policy on the unit.
Example:
//localhost> /c0/u5 show storsave
/c0/u5 Command Storsave Policy = protect
/cx/ux show identify
This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
This command is related to the /cx/ux set identify command. It shows the
identify status of the specified unit (either on or off).
Example:
//localhost> /c0/u0 show identify
/c0/u0 Identify status = on
/cx/ux show autoverify
This feature only applies to 9000 series controllers.
This command shows the current autoverify setting of the specified unit.
Example:
//localhost> /c0/u0 show autoverify
/c0/u0 Auto Verify Policy = off
/cx/ux show cache
This command shows the current write cache state of the specified unit.
Example:
//localhost> /c0/u0 show cache
/c0/u0 Cache State = on
www.3ware.com
63
Chapter 2. CLI Syntax Reference
/cx/ux show ignoreECC
This feature only applies to 9000 series controllers.
This command shows the current setting of the ignoreECC policy for the
specified unit.
Example:
//localhost> /c0/u0 show ignoreECC
/c0/u0 Ignore ECC policy = off
/cx/ux show volumes
This feature only applies to 9000 series controllers.
This command reports the number of volumes in the specified unit. The
number of volumes will normally be “1” unless the drive capacity exceeds
2TB and auto-carving is enabled.
Example:
//localhost> /c0/u0 show volumes
/c0/u0 volume(s) = 1
/cx/ux show all
This command shows the current setting of all above attributes.
If the auto-carve policy was on at the time the unit was created and the unit is
over the carve size, multiple volumes were created and are displayed at the
end of the summary information. Similarly, if the unit was created using the
3ware BIOS utility 3BM and a size was entered in the Boot Volume Size field,
multiple volumes were created and will be displayed. (Note that a volume
created using the Boot Volume Size feature does not have to be used as a boot
volume.)
Example:
//localhost> /c0/u1 show all
/c0/u1 status = OK
/c0/u1 is not rebuilding, its current state is OK
/c0/u1 is not verifying, its current state is OK
/c0/u1 is not initializing, its current state is OK
/c0/u1 Cache State = on
/c0/u1 volume(s) = 2
/c0/u1 name = myarray
/c0/u1 serial number = C6CPR7JMF98DA8001DF0
/c0/u1 Ignore ECC policy = on
/c0/u1 Auto Verify Policy = on
64
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
Unit
UnitType Status
%RCmpl %V/I/M Port Stripe Size(GB)
------------------------------------------------------------------------
u1
RAID-0
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
DISK
Volume
Volume
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
OK
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
64K
-
3576.06
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
298.01
2047.00
1529.06
u1-0
u1-1
u1-2
u1-3
u1-4
u1-5
u1-6
u1-7
u1-8
u1-9
u1-10
u1-11
u1/v0
u1/v1
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
/cx/ux remove [noscan] [quiet]
This command allows you to remove (previously called “export”) a unit.
Removing a unit instructs the firmware to remove the specified unit from its
poll of managed units, but retains the DCB (Disk Configuration Block)
metadata. A removed unit can be moved to a different controller.
noscan is used to not inform the operating system of this change. The default
is to inform the operating system.
quiet is used for non-interactive mode. No confirmation is given and the
command is executed immediately. This is useful for scripting purposes.
Example of interactive mode:
//localhost> /c0/u0 remove
Removing /c0/u0 will take the unit offline.
Do you want to continue?
Y|N [N]:
Note: After the unit is removed through the CLI, the unit can be physically
removed. Hot swap carriers are required to do this while the system is online.
Otherwise you must power down the system to prevent system hangs and damage.
www.3ware.com
65
Chapter 2. CLI Syntax Reference
/cx/ux del [noscan] [quiet]
This command allows you to delete a unit. Deleting a unit not only removes
the specified unit from the controller's list of managed units, but also destroys
the DCB (Disk Configuration Block) metadata. After deleting a unit, ports (or
disks) associated with the unit will be part of the free pool of managed disks.
Warning: This is a destructive command and should be used with care. All data on
the specified unit will be lost after executing this command.
noscan is used to not inform the operating system of this change. The default
is to inform the operating system.
quiet is used for non-interactive mode. No confirmation is given and the
command is executed immediately. This is useful for scripting purposes.
Example of interactive mode:
//localhost> /c0/u0 del
Deleting /c0/u0 will cause the data on the unit to be
permanently lost.
Do you want to continue ? Y|N [N]:
/cx/ux start rebuild disk=p<p:-p...> [ignoreECC]
This command allows you to rebuild a degraded unit using the specified
disk=p. Rebuild only applies to redundant arrays such as RAID 1, RAID 5,
RAID 6, RAID 10, and RAID 50.
During rebuild, bad sectors on the source disk will cause the rebuild to fail.
RAID 6 arrays are less susceptible to failing since two copies of the data exist.
You can allow the operation to continue by using ignoreECC.
The rebuild process is a background task and will change the state of a unit to
REBUILDING. Various show commands also show the percent completion as
rebuilding progresses.
Note that the disk used to rebuild a unit (specified with disk=p) must be a
SPARE or a unconfigured disk. You must first remove the degraded drive(s)
before starting the rebuild. Refer to the command “/cx/px remove [noscan]
[noscan]” on page 43 to add new drives or to retry the original drive.
If you are rebuilding a RAID 50, RAID 6, or RAID 10 unit, multiple drives
can be specified if more than one sub-array is degraded.
When you issue this command, the specified rebuild will begin if schedules
are disabled; otherwise it will pause until the next scheduled rebuild. A file
system check is recommended following rebuild when using the ignoreECC
option.
66
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
/cx/ux start verify
This command starts a background verification process on the specified unit
/cx/ux. The following table shows the supported matrix as a function of the
controller model and logical unit type.
N/A (Not Applicable) refers to cases where the given logical unit type is not
supported on that controller model.
Table 9: Supported RAID (Logical Unit) Types for Verification
Model
R0
R1
R5
R6
R10
R50
Single JBOD
Spare
7K/8K
No
Yes
Yes
Yes
Yes
N/A Yes
N/A Yes
N/A
Yes
N/A
Yes
No
No
a
Yes
Yes
Yes
9000
9650SE Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
a. Models 9500S, 9550SX, and 9590SE
When you issue this command, the specified verify will begin if schedules are
disabled; otherwise it will pause until the next scheduled verify. Verify will
also pause if a rebuild or initialization is currently in progress.
/cx/ux pause rebuild
This command allows you to pause the rebuild operation on the specified unit
/cx/ux.
This feature is only supported on the 7000/8000 series controllers. 9000 series
controllers have an on-board scheduler where rebuild operations can be
scheduled to take place at specified start and stop times. The /cx/ux pause
rebuild command is provided to enable 7000/8000 users to achieve similar
functionality with use of Linux-provided schedulers such as cron(8) or at(1),
or user-supplied programs.
/cx/ux resume rebuild
This command allows you to resume the rebuild operation on the specified
unit /cx/ux.
This feature is intended only for 7000/8000 series controllers. 9000 series
controllers have an on-board scheduler where rebuild operations can be
scheduled to take place at specified start and stop times. The /cx/ux resume
rebuild function is provided to enable 7000/8000 users to achieve similar
www.3ware.com
67
Chapter 2. CLI Syntax Reference
functionality with use of Linux-provided schedulers such as cron(8) or at(1),
or user supplied programs.
/cx/ux stop verify
This command stops a background verification process on the specified unit
/cx/ux. Table 9 on page 67 shows the supported matrix as a function of the
controller model and logical unit type.
/cx/ux flush
This command allows you to flush the write cache on the specified unit /ux
associated with controller /cx. Note that this command does not apply to spare
unit types.
/cx/ux set autoverify=on|off
This feature only applies to 9000 series controllers.
This command allows you to turn on and off the autoverify operation on a
specified unit /cx/ux during allocated schedule windows.
You can use the show verify command to display the existing schedule
windows. By default, autoverify is off.
Auto-verify allows the controller to run the verify function once every 24
hours. If verify schedule windows are set up and enabled, then the controller
will ony start an automatic verify task during the schedule time slots. If the
verify takes longer than the schedule window, the verify process will be
paused and restarted during the next verify schedule window. For additional
/cx/ux set cache=on|off [quiet]
This command allows you to turn on or off the write cache for a specified unit
/cx/ux. This feature is supported on both 7000/8000 and 9000 models.
By default, cache is on.
Write cache includes the disk drive cache and controller cache. Note that for
some configuration types, there is only disk drive cache and no controller
cache (for example, JBOD).
The following table shows the supported RAID types for caching as a
function of controller model and logical unit type. N/A (Not Applicable)
refers to cases where the given logical unit type is not supported on a
particular controller model.
68
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
Table 10: Supported RAID Types for Caching
Model
R0
R1
R5
R6
R10
R50
Single JBOD
Spare
7K/8K
Yes
Yes
Yes
Yes
Yes
Yes
N/A
N/A
Yes
Yes
N/A
Yes
N/A
Yes
Yes
Yes
No
No
a
9000
9650SE Yes
Yes
Yes
Yes Yes
Yes
Yes
Yes
No
a. Models 9500S, 9550SX, and 9590SE
The quiet attribute turns off interactive mode.
/cx/ux set identify=on|off
This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
This feature requires an enclosure that uses an integrated AMCC/3ware CCU
(chassis control unit). (Check the 3ware web site for a list of chassis vendors
that support enclosure services, as they become available.) For additional
information about enclosure-related commands, see “Enclosure Object
This command allows you to identify a unit within an enclosure by blinking
the LEDs associated with the drive slots of the specified unit.
Example:
//localhost> /c0/u0 set identify=on
Sending Identify request for unit /c0/u0 to [on] ... Done.
/cx/ux set ignoreECC=on|off
This feature only applies to 9000 series controllers.
This command allows you to set the ignoreECC policy for a given unit.
When ignoreECC policy is set to off, if a rebuild process encounters bad
sectors on the source disk, the rebuild will fail. When ignoreECC is set to on,
such errors are ignored, and the rebuild will continue. When you use
ignoreECC, a file system check is recommended following the rebuild, to
insure data integrity.
By default, ignoreECC is off.
www.3ware.com
69
Chapter 2. CLI Syntax Reference
/cx/ux set name=string
This command allows you to name the unit with an arbitrary name. You can
use this name in conjunction with the unit serial number to cross-reference
with the unit. The system does not check to ensure uniqueness of names, so be
careful to assign different names to each unit.
Note: The unit’s serial number is automatically assigned when the unit is created
and is not changeable.
/cx/ux set qpolicy=on|off
This command applies only to 9550SX, 9590SE, and 9650SE controllers.
This command sets the queue policy of the firmware. If the queue policy is
on, the firmware utilizes the drive queueing policy. If some of the drives in
the unit do not support any queueing policy, this policy will have no effect on
those drives.
By default, qpolicy is on.
Example:
//localhost> /c0/u5 set qpolicy = on
Setting Command Queuing Policy for unit /c0/u5 to [on] ... Done.
/cx/ux set storsave=protect|balance|perform [quiet]
This command applies only to 9550SX, 9590SE, and 9650SE model
controllers.
This command sets the storsave policy to be either protect, balance, or
perform when the unit write cache is enabled. The default setting is protect.
The storsave policy adjusts several factors that control the balance between
protection and performance on a unit. There is a trade-off among the available
settings. The following description about the settings should help you to
decide which one is suitable to you and your application. You will find further
discussion of this setting in the 3ware Serial ATA RAID Controller User
Guide, under “About StorSave Profile Levels” on page 117.
70
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
protect provides the maximum data protection among the controller settings.
When storsave is set to protect mode, it means:
•
•
When the unit becomes degraded, the write cache will be disabled.
Write journaling is enabled. All data flushing from controller cache will
be flushed to media.
•
Incoming FUA (Force Unit Access) host requests will be honored unless
a BBU is installed and enabled, in which case, they will be ignored.
perform provides the maximum performance and least data protection of the
three controller settings. When storsave is set to perform mode, it means:
•
•
When the unit becomes degraded, the write cache will not be disabled.
Write journaling is disabled. All data flushing from controller cache will
be flushed to disk. If a BBU is present, this essentially disables the BBU
for this unit.
•
Incoming FUA (Force Unit Access) host requests will be honored.
If you set the storsave policy to perform, a confirmation message will warn
you that there could be data loss in the event of a power failure.
balance provides more data protection than perform mode but less data
protection than protect mode, and provides better performance than protect
mode but less performance than perform mode. When storsave is set to the
balance mode, it means:
•
•
When the unit becomes degraded, the write cache will not be disabled.
Write journaling is disabled, if no BBU is present, and is enabled, if a
BBU is present. All data flushing from controller cache will be flushed to
media if a BBU is installed and enabled. Otherwise, data will be flushed
to disk only.
•
Incoming FUA (Force Unit Access) host requests will be honored unless
a BBU is installed and enabled, in which case, they will be ignored.
quiet is used for non-interactive mode. No confirmation is given and the
command is executed immediately. This is useful for scripting purposes.
For additional information, see “Setting the StorSave Profile for a Unit” in the
3ware Serial ATA RAID Controller User Guide.
Example:
//localhost> /c0/u5 set storsave=protect
Setting Command Storsave Policy for unit /c0/u5 to [protect] ...
Done.
www.3ware.com
71
Chapter 2. CLI Syntax Reference
/cx/ux migrate type=RaidType [disk=p:-p]
[group=3|4|5|6|7|8] [stripe=Stripe] [noscan]
[nocache] [autoverify]
This feature only applies to 9000 series controllers.
This command allows you to change the existing configuration of a unit with
type=RaidType. You can make three types of changes:
•
•
•
Increase the capacity
Change the RAID level (with the same or increased capacity)
Change the stripe size
The unit that results from the migration is subject to the same rules and
policies that apply when creating a new unit with the /cx add command. For
example, a valid number of disks and parameters must be specified.
The unit to be migrated must be in a normal state (not degraded, initializing,
or rebuilding) before starting the migration.
The destination unit must use all source disks and potentially augment the
number of disks in the disk=p:-p disk list. Unspecified parameters are
assigned the default values (stripe size of 64K, write cache enabled,
autoverify disabled, and ignoreECC disabled). Both source name and serial
number will be carried over to the destination unit.
A special case of this command is when the source unit has a type of RAID1
and destination unit has a type of single. In this case, the migrate command
splits both drives into two identical single disks. The disk name will be
duplicated on the destination units, but the source unit serial number will not
be carried over to the new unit. The new destination unit will have its own
serial number.
type=RaidType specifies the RAID type of the destination unit. Possible unit
types include raid0, raid1, raid5, raid6, raid10, raid50, or single.
For example, type=raid5 indicates the destination unit is RAID-5. The
type=single is a special case of the migrate command. It splits the source unit
RAID-1 or TWINSTOR into multiple Single units.
Note: You can only migrate a unit to a RAID level that has the same or more
capacity as the existing one. A four-drive RAID 5 unit can migrate to a four-drive
RAID 0, but a four-drive RAID 0 unit cannot migrate to a four-drive RAID 5, without
adding another drive, due to the need for additional storage capacity for parity bits.
The following table illustrates valid migration paths:
72
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
:
Table 11: Valid Migration Paths
Destination
Source
R0
R0
R1
R5
R6
R10
R50
Single JBOD
Spare
Yes
No
Yes
Yes
Yes
Yes
No
Yes
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
No
No
Yes
No
No
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
No
Yes
Yes
Yes
Yes
Yes
Yes
No
No
No
No
No
No
No
No
No
R1
R5
R6
R10
R50
Single
JBOD
Spare
No
No
No
No
No
disk=p:-p.. consists of a list of ports (disks) to be used in addition to the
source disks in the construction of the destination unit. One or more ports can
be specified. Multiple ports can be specified using a colon (:) or a dash (-) as
port index separators. A dash indicates a range and can be mixed with colons.
For example disk=0:1:2-5:9:12 indicates port 0, 1, 2 through 5 (inclusive), 9
and 12.
group=3|4|5|6|7|8 indicates the number of disks per group for a RAID 50
type. (This attribute can only be used when type=raid50.) Recall that a RAID
50 is a multi-tier array. At the bottom-most layer, N number of disks per group
are used to form the RAID 5 layer. These RAID 5 arrays are then integrated
into a RAID 0. This attribute allows you to specify the number of disks in the
RAID 5 level. Valid values are 3, 4, 5, 6, 7, and 8. For example group=3
indicates 3 disks of RAID 5 at the bottom layer of RAID 50.
Note that a sufficient number of disks are required for a given pattern or disk
group. For example, given 6 disks, specifying 3 will create two RAID 5
arrays. With 12 disks, specifying 3 will create four RAID 5 arrays under the
RAID 0 level. With only 6 disks a grouping of 6 is not allowed, as you would
basically be creating a RAID 5.
The default RAID 50 grouping varies, based on number of disks. For 6 and 9
disks, default grouping is 3. For 8 disks, the default grouping is 4. For 10
disks, the default grouping is 5, and for 12 disks, the disks can be grouped into
groups of 3, 4, or 6 drives (the group of 4 drives is set by default as it provides
www.3ware.com
73
Chapter 2. CLI Syntax Reference
the best of net capacity and performance). For 15 disks, the disks can be
grouped into groups of 3 or 5 drives. For 16 disks, the disks can be grouped
into groups of 4 or 8 drives.
Note that RAID-10 always has group=2, so an attribute specifying it’s group
is not necessary.
stripe=Stripe consists of the stripe size to be used. The following table
illustrates the supported and applicable stripes on unit types and controller
models. Stripe size units are in KB (kilobytes).
Table 12: Supported Stripe Sizes
Model
R0
R1
R5
R6
R10
64
JBOD Spare
R50
Single
7/8000
64
N/A 64
N/S
N/A
N/A
N/S
N/S
128
256
512
1024
16
128
256
512
1024
16
a
N/A 16
64
N/S
N/A
N/A
N/A
N/A
16
N/S
N/S
9000
64
N/S
N/S
64
64
256
256
256
16
256
16
9650SE 16
64
N/A 16
64
64
64
64
256
256
256
256
a. Models 9500S, 9550SX, and 9590SE
noscan attribute instructs CLI not to notify the operating system of the
creation of the new unit. By default CLI will inform the operating system.
One application of this feature is to prevent the operating system from
creating block special devices such as /dev/sdb and /dev/sdc as some
implementations might create naming fragmentation and a moving target.
nocache attribute instructs CLI to disable the write cache on the migrated
unit. Enabling write cache increases write performance at the cost of potential
data loss in case of sudden power loss (unless a BBU or UPS is installed). By
default the cache is enabled. To avoid the possibility of data loss in the event
of a sudden power loss, it is recommended not to set nocache unless there is a
BBU (battery backup unit) or UPS (uninterruptibleuninterruptible power
supply) installed..
74
3ware Serial ATA RAID Controller CLI Guide
Unit Object Commands
autoverify attribute enables the autoverify attribute on the unit that is to be
migrated. For more details on this feature, see “/cx/ux set autoverify=on|off”
Migration Process
In all cases of migration, the background migration process must be
completed before the newly sized unit is available for use. You can continue
using the original unit during this time. Once the migration is finished, a
reboot will be required if you are booted from the unit. For secondary storage,
depending on your operating system, you may need to first unmount the unit,
then use CLI commands to ‘remove’ and ‘rescan’ the unit so that the
operating system can see the new capacity, and then remount the unit. For
You may also need to resize the file system or add a new partition. For
instructions, consult the documentation for your operating system.
Warning: It is important that you allow migration to complete before adding drives
to the unit. Making physical changes to the unit during migration may cause the
migration process to stop, and can jeopardize the safety of your data.
Example of splitting a mirror
//localhost> /c1/u3 migrate type=single
Indicates that u3 should be split into Single units. In this case, u3 is a RAID-1
and the Migrate command splits u3 into u3 and ux, each with a RAID type of
Single.
Warning: Make sure that no I/O is pending before splitting a mirror. If the Raid 1 is
the boot device, you should boot from a different device before splitting the mirror.
Example of capacity expansion
//localhost> /c0/u3 migrate type=raid10 disk=10-11 stripe=16
Indicates that the destination unit has a RAID type of raid10 and has added
the disks 10 and 11 to the disks in the existing unit u3.
www.3ware.com
75
Chapter 2. CLI Syntax Reference
Example of migrate output
The following is an example of how migrating units will be displayed. In this
example, the report indicates that /c0/u3 is a migrating unit with 39%
completion. The report also indicate that Source Unit su0 is of type RAID-1
and Destination Unit du0is of type RAID-10.
3ware CLI> /c0 show
Unit UnitType Status
%RCmpl %V/I/M Stripe Size(GB) Cache AVrfy
---------------------------------------------------------------------------
u0
u2
u3
RAID-5
SPARE
Migrator MIGRATING
OK
OK
-
-
-
-
-
39
64K
-
-
596.004
149.042
149.001
ON
-
ON
OFF
OFF
OFF
Port
Status Unit
Size
Blocks
Serial
---------------------------------------------------------------
p0
p1
p2
p3
p4
p5
p6
p7
p8
p9
p10
p11
OK
OK
OK
OK
OK
OK
OK
OK
u0
u0
u0
u0
u2
u3
u0
u3
-
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
149.05 GB
-
312581808
312581808
312581808
312581808
312581808
312581808
312581808
312581808
312581808
-
WD-WCANM1771318
WD-WCANM1757592
WD-WCANM1782201
WD-WCANM1753998
WD-WCANM1766952
WD-WCANM1882472
WD-WCANM1883862
WD-WCANM1778008
WD-WCANM1770998
-
OK
NOT-PRESENT
OK
OK
-
u3
u3
149.05 GB
149.05 GB
312581808
312581808
WD-WCANM1869003
WD-WCANM1762464
3ware CLI> /c0/u0 show
Unit
UnitType Status
%RCmpl %V/I/M Port Stripe Size(GB)
------------------------------------------------------------------------
u3
Migrator MIGRATING
-
39
-
-
-
su3
RAID-1
DISK
DISK
OK
OK
OK
-
-
-
-
-
-
-
-
-
-
-
-
-
-
149.001
149.001
149.001
149.001
su3-0
su3-1
su3/v0
p5
p7
-
Volume
du3
du3-0
du3-0-0 DISK
du3-0-1 DISK
du3-1
du3-1-0 DISK
du3-1-1 DISK
du3/v0
RAID-10
RAID-1
OK
OK
OK
OK
OK
OK
OK
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
16K
-
-
-
-
-
-
-
298.002
-
149.001
149.001
-
149.001
149.001
149.001
p5
p7
-
p10
p11
-
RAID-1
Volume
76
3ware Serial ATA RAID Controller CLI Guide
Port Object Commands
Port Object Commands
Port Object Messages are commands that provide information and perform
actions related to a specific disk, attached to a port, such as /c0/p0. You use
port object commands for such tasks as seeing the status, model, or serial
number of the drive.
Syntax
/cx/px show
/cx/px show attribute [attribute ...] where attributes are:
capacity|firmware|identify (9550SX, 9590SE, 9650SE)|
lspeed (9550SX, 9590SE, 9650SE)|model|
ncq (9550SX, 9590SE, 9650SE)|serial|smart|status
/cx/px show all
/cx/px remove [noscan][quiet]
/cx/px set identify=on|off (9550SX, 9590SE, 9650SE)
/cx/px show
This command shows summary information about the specified disk attached
to port /cx/px. Typical information looks like:
Example:
//localhost> /c1/p5 show
Port Status
---------------------------------------------------------
p5 OK u0 149.05 GB 312581808 3JS0L9QW
Unit Size
Blocks
Serial
The above report indicates that port 5 of controller 1 is attached to one l disk
with status OK participating in unit 0.
/cx/px show attribute [attribute ...]
This command shows the current setting of the given attributes on the
specified port or drive. One or many attributes can be requested. Specifying
an invalid attribute will terminate the loop. Possible attributes are: capacity,
firmware, identify (9550SX, 9590SE, and 9650SE only), lspeed (9550SX,
9590SE, and 9650SE only), model, ncq (9550SX, 9590SE, and 9650SE only),
serial, smart, and status.
www.3ware.com
77
Chapter 2. CLI Syntax Reference
/cx/px show status
This command displays the status of the drive attached to the specified port.
(Definitions of the drive statuses are available in the 3ware Serial ATA RAID
Controller User Guide.)
Example:
//localhost> /c0/p5 show status
/c0/p5 Status = OK
/cx/px show model
This command displays the model of the drive attached to the specified port.
Example:
//localhost> /c0/p5 show model
/c0/p5 Model = WDC WD1600BB-00DAA0
/cx/px show serial
This command displays the serial number of the drive attached to the
specified port.
Example:
//localhost> /c0/p5 show serial
/c0/p5 Serial = WD-WMACK140649
/cx/px show firmware
This command displays the firmware version of the drive attached to the
specified port.
Example:
//localhost> /c0/p5 show firmware
/c0/p5 Firmware Version = 65.13G65
/cx/px show identify
This command applies only to 9550SX, 9590SE, and 9650SE model
controllers that have chassis control hardware (enclosure services) attached.
This command shows whether the LED of the drive attached to the specified
Example:
//localhost> /c0/p5 show identify
/c0/p5 Identify Status = on
78
3ware Serial ATA RAID Controller CLI Guide
Port Object Commands
/cx/px show ncq
This command applies only to 9550SX, 9590SE, and 9650SE model
controllers.
This command displays the NCQ (Native Command Queueing) information
for the drive attached to the specified port, including whether NCQ is
supported by the drive, and whether it is enabled at the drive.
For queuing to be used, it must be enabled for the unit and supported by the
drive.
Example:
//localhost> /c0/p5 show ncq
/c0/p5 NCQ Supported = No
/c0/p5 NCQ Enabled = No
/cx/px show lspeed
This command applies only to 9550SX, 9590SE, and 9650SE model
controllers.
This command displays the maximum SATA link speed supported by the
drive attached to the port and the present SATA link speed setting.
Example:
//localhost> /c0/p5 show lspeed
/c0/p5 SATA Link Speed Supported = 3.0 Gb/s
/c0/p5 SATA Link Speed = 3.0 Gb/s
/cx/px show capacity
This command displays the capacity of the drive attached to the specified port
in two formats—GB and blocks. Note that of this version, the GB format is
computed based on division by 1000 (not 1024).
Example:
//localhost> /c0/p5 show capacity
149.05 GB (312581808 Blocks)
/cx/px show smart
This command extracts SMART (Self Monitoring Analysis and Reporting)
data from the specified disk. Because the data is extracted live from the disk,
this command can be used to get the most recent data about the presence or
absence of a disk.
The SMART data is displayed in hexadecimal form.
www.3ware.com
79
Chapter 2. CLI Syntax Reference
Example:
//localhost> /c0/p5 show smart
/c0/p5 Drive SMART Data:
10 00 01 0B 00 C8 C8 00 00 00 00 00 00 00 03 07
00 9A 96 BC 14 00 00 00 00 00 04 32 00 64 64 7A
00 00 00 00 00 00 05 33 00 C8 C8 00 00 00 00 00
...
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 2C
Note: The SMART data is not decoded. If the drive attached to the specified port is
not present or if there are cabling problems reaching the drive, CLI will return an
error. This can be one way of detecting whether or not a drive is present.
/cx/px show all
This command shows the current setting for all port-related attributes: status,
model, serial, firmware, capacity, and smart.
Example:
//localhost> /c0/p0 show all
/c0/p0 Status = OK
/c0/p0 Model = Maxtor 7B300S0
/c0/p0 Firmware Version = BANC1980
/c0/p0 Serial = B605X31H
/c0/p0 Capacity = 279.48 GB (586114704 Blocks)
/c0/p0 Identify Status - NA
/c0/p0 SATA Link Speed Supported = 1.5 Gb/s
/c0/p0 SATA Link Speed = 1.5 Gb/s
/c0/p0 NCQ Supported = No
/c0/p0 NCQ Enabled = No
/c0/p0 Belongs to Unit = u1
/c0/p0 Drive Smart Data:
0A 00 01 0F 00 3D 33 25 8C BA 03 00 00 00 03 03
00 61 60 00 00 00 00 00 00 00 04 32 00 64 64 00
00 00 00 00 00 00 05 33 00 64 64 00 00 00 00 00
00 00 07 0F 00 4E 3E 05 13 D8 03 00 00 00 09 32
...
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 8D
80
3ware Serial ATA RAID Controller CLI Guide
Port Object Commands
/cx/px remove [noscan] [quiet]
This command allows you to remove (or export) a port (or drive) /cx/px.
Exporting a port instructs the firmware to remove the specified port from its
pool of managed ports, but does not retain the DCB (Disk Configuration
Block) metadata on the attached disk. You can import (or re-introduce) the
port by rescanning the controller.
noscan is used to not inform the operating system of this change. The default
is to inform the operating system.
quiet is for non-interactive mode.
Warning: Use caution when using this command as this operation will degrade
any redundant units. This command will fail if you attempt to remove a drive from a
non-redundant unit. After the drive is removed in CLI it can be removed physically,
without powering down the system if a hot swap carrier is available. System hangs
and damage can occur if a hot swap carrier is not used.
/cx/px set identify=on|off
This command applies only to 9550SX, 9590SE, and 9650SE model
controllers.
This command sets the LED status of the port to on or off. If identify is set to
on, the firmware activates the setting of the corresponding LED of the port on
the controller and causes it to blink.
Note: This feature requires an enclosure that uses an integrated AMCC/3ware
CCU (chassis control unit). (Check the 3ware web site for a list of chassis vendors
that support enclosure services, as they become available.) For additional
information about enclosure-related commands, see “Enclosure Object
Example:
//localhost> /c0/p5 set identify=on
Setting Port Identify on /c0/p5 to [on] ... Done.
www.3ware.com
81
Chapter 2. CLI Syntax Reference
BBU Object Commands
BBU (Battery Backup Unit) Object Commands are commands that provide
information and perform actions related to a specific BBU installed on a
specific controller, such as /c0/bbu.
This object is only available on 9000 series controllers on which a BBU is
actually installed. (The BBU is not supported on 9590SE-4ME.)
Syntax
/cx/bbu show
(9000 only)
/cx/bbu show attribute [attribute ...] where attributes are:
batinst|bootloader|cap|fw|lasttest|pcb|ready|serial|
status|temp|volt
/cx/bbu show all
(9000 only)
/cx/bbu test [quiet]
(9000 only)
Warning: May take up to 24 hours to complete. Write cache
will be disabled during the test.
/cx/bbu enable
/cx/bbu disable [quiet]
(9000 only)
(9000 only)
/cx/bbu show
This command presents a summary report on the specified BBU object.
Example:
//localhost> /c0/bbu show
Name OnlineState BBUReady Status
---------------------------------------------------------------------------
bbu ON No Testing OK OK 72 01-Jul-2004
Volt
Temp
Hours LastCapTest
The command output indicates that the battery capacity was last measured on
01-Jul-2004. The battery is estimated to last for 72 hours from the last tested
date. In this example, the BBU unit is currently testing the battery. Both
voltage and temperature are normal. The BBU is not ready to backup the write
cache on the controller (due to the testing). (For complete information about
the BBU, see the user guide that came with your 3ware RAID controller).
Note: If the BBU is either not present or disabled, the following will be displayed
after the command //localhost> /c0/bbu show.
Error: (CLI:053) Battery Backup Unit is not present.
82
3ware Serial ATA RAID Controller CLI Guide
BBU Object Commands
/cx/bbu show attribute [attribute ...]
This command shows the current setting of the given attribute(s) on the BBU
board. One or many attributes can be specified. Specifying an invalid attribute
will terminate the loop. Possible attributes are: batinst, bootloader, cap, fw,
lasttest, pcb, ready, status, serial, temp, volt.
/cx/bbu show status
This command shows the status of the BBU. Possible values are:
Testing. A battery test is currently in progress. This test may take up to 24
hours to complete. During the test, the BBU is not capable of backup
operation and the write cache of the RAID controller is also disabled. If the
test is completed with no error and the BBU status changes to WeakBat or
OK, the write cache will be re-enabled. If a Fault, Failed or Error occurs
during the test, the write cache remains in the disabled state until the problem
is fixed.
Charging. The BBU is currently charging the battery. Charging is started
automatically by the BBU whenever necessary. During charging, the BBU is
not capable of backup operation and the write cache is disabled. Once the test
is completed with no error and the BBU status changes to OK, the write cache
will be re-enabled. If a FAULT or ERROR occurs during the test, the write
cache remains in the disabled state until the problem is fixed.
Fault. A battery fault is detected. The BBU is not capable of backup operation
and the write cache is disabled. Replace the battery and/or the BBU board as
soon as possible so that the write cache will be enabled again.
Error. A BBU error is detected. The BBU is not capable of backup operation
and the write cache is disabled. Replace the battery and/or the Battery Backup
Unit as soon as possible so that the write cache will be enabled again.
Failed. The battery failed a test. In this state, the BBU is not capable of
backup operation and the write cache is disabled. We recommend you replace
the battery and/or the Battery Backup Unit as soon as possible so that the
write cache will be enabled again.
WeakBat. The BBU is functioning normally and is online and capable of
backing up the write cache. However, the battery is weak and should be
replaced.
OK. The BBU is ready, online and capable of backing up the write cache.
- (dash) A battery is not present or a Battery Backup Unit is not installed
www.3ware.com
83
Chapter 2. CLI Syntax Reference
/cx/bbu show batinst
This command shows the date when the current battery was installed.
/cx/bbu show lasttest
This command shows the date the battery capacity was last measured. If the
battery capacity test has never been run, then 'xx-xxx-xxxx' will be displayed.
Note: The estimated BBU capacity hours displayed is based on the measurement
taken during the last test. If you have not run the BBU test command for some time,
this number can be misleading. For information about running a test, see “/cx/bbu
/cx/bbu show volt
This command shows the voltage status of the battery. The status can be OK,
HIGH, LOW, TOO-HIGH, and TOO-LOW. The HIGH and LOW are in
warning range. TOO-HIGH and TOO-LOW are out of the operating range
and indicate that it is time to replace the battery. (Contact AMCC to obtain a
replacement battery.)
/cx/bbu show temp
This command shows the temperature status of the battery. The status can be
OK, HIGH, LOW, TOO-HIGH, and TOO-LOW. The HIGH and LOW are in
warning range. TOO-HIGH and TOO-LOW are out of the operating range
and indicate that it may be time to replace the battery. (Contact AMCC to
obtain a replacement battery.)
/cx/bbu show cap
This command shows the battery capacity in hours.
A value of '0 hours' will be displayed if the battery capacity test has never
been run.
Note: The estimated BBU capacity hours displayed is based on the measurement
taken during the last test. If you have not run the BBU test command for some time,
this number can be misleading. You can use the command /cx/bbu show lasttest
to check the date of the last test. For information about running a test, see “/cx/bbu
84
3ware Serial ATA RAID Controller CLI Guide
BBU Object Commands
/cx/bbu show serial
This command shows the BBU serial number.
/cx/bbu show fw
This command shows the BBU firmware version number.
/cx/bbu show pcb
This command shows the PCB revision number on the BBU.
/cx/bbu show bootloader
This command shows the BBU's boot loader version.
/cx/bbu show all
This command shows the current settings of all BBU-related attributes: ready,
status, batinst, lasttest, volt, temp, cap, serial, fw, pcb, bootloader.
Example:
//localhost> /c1/bbu show all
/c1/bbu Firmware Version
/c1/bbu Serial Number
/c1/bbu BBU Ready
/c1/bbu BBU Status
/c1/bbu Battery Voltage
/c1/bbu Battery Temperature
= BBU: 1.04.00.007
= Engineering Sample.
= Yes
= OK
= OK
= OK
/c1/bbu Estimated Backup Capacity = 241 Hours
/c1/bbu Last Capacity Test = 22-Jun-2004
/c1/bbu Battery Installation Date = 20-Jun-2004
/c1/bbu Bootloader Version
/c1/bbu PCB Revision
//localhost>
= BBU 0.02.00.002
= 65
www.3ware.com
85
Chapter 2. CLI Syntax Reference
/cx/bbu test [quiet]
This command starts the battery capacity test. The test may take up to 24
hours to complete. During the test, the BBU is not capable of backup
operation and the write cache of all units attached to that controller is
disabled. Once the test is completed with no error and the BBU status returns
to OK, the write cache will be re-enabled.
Note: Once started, the test can not be terminated before it completes. Write
cache cannot be enabled until the test completes.
AEN (Asynchronous Event Notification) messages are also generated by
controllers to notify the user of the command status.
Check for AENs with the alarms command /cx show alarms [reverse]. Using
the “reverse” attribute displays the most recent AEN message at the bottom of
the list. (For a list of all AENs, see the user guide that came with your 3ware
RAID controller.)
/cx/bbu enable
This command enables BBU detection on the controller. If the BBU is Ready,
the controller will utilize BBU functionality in the event of a power failure.
/cx/bbu disable [quiet]
This command disables BBU detection on the controller. When disabled, the
controller ignores the existence of the BBU and will show no BBU is installed
even if a BBU is physically attached.
86
3ware Serial ATA RAID Controller CLI Guide
Enclosure Object Commands
Enclosure Object Commands
Enclosure object commands provide information and perform actions related
to a specific enclosure, such as /e0 and its elements, such as /e0/slot0.
Enclosure object elements include slot, fan, and temperature sensor elements.
These commands are supported on the 9550SX, 9590SE, and 9650SE
controllers, when an appropriate enclosure is used. The enclosure must use an
integrated AMCC/3ware CCU (chassis control unit). (Check the 3ware web
site for a list of chassis vendors that support enclosure services, as they
become available.) If you purchased an enclosure directly from a third-party
vendor, the appropriate EPCT (Enclosure Port Configuration Table) must
have been downloaded to the controller in order to take advantage of these
commands.
Note. Not all enclosure features may be available on enclosures that use an
integrated AMCC/3ware CCU.
Syntax
/ex show
(9550SX, 9590SE, 9650SE only)
/ex show attribute [attribute ...] where attributes are:
controllers|slots|fans|temp
/ex show all
(9550SX, 9590SE, 9650SE only)
/ex/slotx show
/ex/slotx show identify
(9550SX, 9590SE, 9650SE only)
(9550SX, 9590SE, 9650SE only)
/ex/slotx set identify=on|off (9550SX, 9590SE, 9650SE only)
/ex/fanx show
/ex/tempx show
(9550SX, 9590SE, 9650SE only)
(9550SX, 9590SE, 9650SE only)
/ex show
This command shows summary information on the specified enclosure /ex.
This report consists of four parts; the Enclosure summary listing the present
elements, a Fan summary section listing of all present fans, a Temperature
Sensor summary section listing of all present temperature sensors and a Slot
summary section listing of slots and associated information for the specified
enclosure.
www.3ware.com
87
Chapter 2. CLI Syntax Reference
Typical output looks like:
//localhost> /e0 show
Encl
Controllers
-------------------------
e0
/c0
Fan
Status
----------------------
fan0
OK
TempSensor
Temperature
-------------------------------
temp0
Slot
24~C(75~F)
Port
Status
Identify
----------------------------------------------------
slot0
slot1
slot2
slot3
OK
OK
/c0/p0
/c0/p1
-
-
No
Yes
No
NO-DEVICE
NO-DEVICE
No
/ex show attribute [attribute ...]
This command shows the current setting of the given attribute(s). One or
many attributes can be requested. An invalid attribute will terminate the loop.
Possible attributes are: controllers, protocol, slots, fans, and temp.
/ex show controllers
This command lists the controller associated with enclosure /ex.
Example:
//localhost> /e0 show controllers
/e0 Connected to /c0 controller.
88
3ware Serial ATA RAID Controller CLI Guide
Enclosure Object Commands
/ex show slots
This command reports the slots in enclosure /ex and their associated
information.
Example:
//localhost> /e0 show slots
Slot
Status
Port
Identify
----------------------------------------------------
slot0
slot1
slot2
slot3
OK
OK
/c0/p0
/c0/p1
-
-
No
Yes
No
NO-DEVICE
NO-DEVICE
No
/ex show fans
This command lists the fans in enclosure /ex and shows their status. Possible
statuses are OK and Unknown.
Example:
//localhost> /e0 show fans
Fan
----------------------
fan0 OK
Status
/ex show temp
This command lists the temperature sensors in enclosure /ex and the current
temperature.
The maximum temperature for successful use of a drive should be noted in the
documentation for the drive.
Example:
//localhost> /e0 show temp
TempSensor
-------------------------------
temp0 24~C(75~F)
Temperature
/ex show all
This command shows the current settings of all attributes for enclosure /ex.
www.3ware.com
89
Chapter 2. CLI Syntax Reference
/ex/slotx show
This command shows information about the specified /slotx on the specified
enclosure /ex. The slot name is followed by its status. If a slot has been
inserted with a drive and no fault has been detected, the status is OK. If the
slot is empty the status would indicate NO-DEVICE. The port that is
correlated to the slot is indicated in the next column. If no device is found in
the slot, that is indicated with a dash (-) in the Port column. The final column
shows whether “identify” is currently set for the specified slot.
Example:
//localhost> /e0/slot1 show
Slot
----------------------------------------------------
slot1 OK /c0/p1 Yes
Status
Port
Identify
/ex/slotx show identify
This command shows the identify status of the specified slot. The status can
be either on or off.
Example:
//localhost> /e0/slot1 show identify
/e0/slot1 Identify status = on
/ex/slotx set identify=on|off
This command causes the slot to be identified by blinking the LED associated
with it, or turns off identification of the LED for this slot.
Setting identify to on will cause the LED associated with that slot to blink,
provided that the EPCT has been set to associate “identify” with “blinking,”
as is the case in the 3ware Sidecar.
Example:
//localhost> /e0/slot1 set identify=on
Sending Identify request to Drive Slot /e0/slot0 to [on] ...
Done.
90
3ware Serial ATA RAID Controller CLI Guide
Help Commands
/ex/fanx show
This command shows the information about the specified fan element /fanx in
the specified enclosure /ex. The fan name is followed by its status. If a fan is
on and no fault has been detected, the status would indicate OK.
Example:
//localhost> /e0/fan0 show
Fan
Status
-------------------
fan0
OK
/ex/tempx show
This command shows the information about the specified temperature sensor
element /fanx in the specified enclosure /ex. The temperature sensor name is
followed by the temperature sensed in the enclosure unit.
Example:
//localhost> /e0/temp0 show
TempSensor
Temperature
-------------------------------
temp0
24~C(75~F)
Help Commands
The Help commands provides brief on-line help.
You can get overview help by typing Help at the top-level prompt. This
displays a brief definition of commands. (For an example, see the discussion
You can also get help with specific commands, by entering help before an
object name, or by typing a question mark (?) at the point in a command
where you are uncertain what the attributes are.
Help with specific commands
If you enter the help command at the top level, you are considered to be in the
Shell Object, and the help command will provide help on the Shell commands
focus, show, flush, rescan, and commit. Using the help command on objects
(such as /cx, /cx/ux, /cx/px, /cx/bbu, /ex, /ex/slotx, /ex/fanx, and /ex/tempx),
displays all possible sub-commands associated with the object.
For example: help on the controller object /cx, will display all the sub-
commands associated with the controller /cx, like this:
www.3ware.com
91
Chapter 2. CLI Syntax Reference
//localhost> help /cx
/cx show
/cx show attribute [attribute ...] where attribute is:
achip|allunitstatus|autocarve|autorebuild (9550SX,
9590SE, 9650SE only)|bios|carvesize(9000 series)|
ctlbus (9550SX, 9590SE, 9650SE)|driver|drivestatus|
exportjbod|firmware|memory|model|monitor|numdrives|
numports|numunits|pcb|pchip|serial|spinup|stagger|
unitstatus|ondegrade(9000S only)
/cx show all where all means attributes and configurations.
/cx show diag
/cx show alarms [reverse]
/cx show rebuild
/cx show verify
/cx show selftest
(9000 only)
(9000 only)
(9000 only)
/cx add type=<RaidType> disk=<p:-p..> [stripe=<Stripe>]
[noscan] [nocache][group=<3|4|5|6|7|8>] [autoverify]
[ignoreECC] [name=string (9000 only)]
[storsave=<protect|balance|perform[quiet]>(9550SX,
9590SE, 9650SE)] RaidType={raid0, raid1, raid5, raid6
(9650SE), raid10, raid50, single, spare, JBOD(7000/8000
only)}
/cx add rebuild=ddd:hh:duration
/cx add verify=ddd:hh:duration
/cx add selftest=ddd:hh
(9000 only)
(9000 only)
(9000 only)
/cx del rebuild=slot_id
/cx del verify=slot_id
/cx del selftest=slot_id
(9000 only)
(9000 only)
(9000 only)
/cx set exportjbod=on|off
/cx set ondegrade=cacheoff|follow
/cx set spinup=nn
/cx set stagger=nn
/cx set autocarve=on|off
/cx set rebuild=enable|disable|<1..5>
(9000 only)
(9500S only)
(9000 only)
(9000 only)
(9000 only)
(enable|disable for 9000 only)
/cx set verify=enable|disable|<1..5>
(enable|disable for 9000 only)
/cx set selftest=enable|disable [task=UDMA|SMART](9000 only)
/cx set autorebuild=on|off (9550SX, 9590SE, and 9650SE only)
/cx update fw=filename_with_path [force] (9000 only)
/cx flush
/cx commit
/cx start mediascan
/cx stop mediascan
(Windows only) (Also known as shutdown)
(7000/8000 only)
(7000/8000 only)
/cx rescan [noscan] NOTE: Does not import non-JBOD on 7/8000
models.
//localhost>
92
3ware Serial ATA RAID Controller CLI Guide
Help Commands
Help with attributes
As you work with specific objects or commands, you can also use ? to get
help.
For example: If you enter the command /c0 showand then need help on what
specific attribute syntax is possible, you can use ? to get help as following:
//localhost> /c0 show ?
/cx show
/cx show attribute [attribute ...]
where attribute is:
achip|allunitstatus|autocarve(9000 series)|
autorebuild(9550SX only)|bios|carvesize(9000series)|
driver|drivestatus|exportjbod|firmware|memory|model|
monitor|numdrives|numports|numunits|ctlbus(9550SX,
9590SE, 9650SE only)serial|ondegrade (9000S only)|pcb|
pchip|spinup|stagger|unitstatus|
/cx show all where all means attributes and configurations.
/cx show diag
/cx show alarms [reverse]
/cx show rebuild
/cx show verify
/cx show selftest
//localhost>
(9000 only)
(9000 only)
(9000 only)
help
This help command provide a table of contents, providing help with the
overall navigation of the CLI commands. Typical output looks like the
following.
//localhost> help
Copyright(c) 2004-2006 Applied Micro Circuits Corporation
(AMCC). All rights reserved.
AMCC/3ware CLI (version 2.x)
Commands Description
--------------------------------------------------------------
show
Displays information about controller(s), unit(s) and port(s).
Flush write cache data to units in the system.
Rescan all empty ports for new unit(s) and disk(s).
Update controller firmware from an image file
flush
rescan
update
commit Commit dirty DCB to storage on controller(s).
(Windows only)
/cx
Controller specific commands.
Unit specific commands.
Port specific commands.
BBU specific commands.
/cx/ux
/cx/px
/cx/bbu
/ex
(9000 only)
(9550SX, 9590SE, and 9650SE only)
Enclosure specific commands.
/ex/slotx Slot specific commands.
/ex/fanx Fan specific commands.
/ex/tempx Enclosure Temperature Sensor specific commands.
www.3ware.com
93
Chapter 2. CLI Syntax Reference
Certain commands are qualified with constraints of controller type/model
support. Please consult the tw_cli documentation for explanation of the
controller-qualifiers.
The controller-qualifiers of the Enclosure commands (/ex) also apply to
Enclosure Element specific commands (e.g., /ex/elementx).
Type help <command> to get more details about a particular command. For more
detail information see tw_cli's documentation.
help show
This command provides specific show-related help, illustrating various ways
to use the show command. It provides reports on Controllers, Units and
information.
help flush
This command provides specific flush-related help, illustrating various ways
to use the flush command. See the section “Shell Object Commands” on
help rescan
This command provides specific rescan related help, illustrating various ways
to use the rescan command. See the section “Shell Object Commands” on
help update
This command provides specific update-related help. See “Shell Object
Commands” on page 23 for more information.
help commit
This command provides specific commit related help, illustrating various
ways to use the commit command. See the section “Shell Object Commands”
on page 23 for more information.
94
3ware Serial ATA RAID Controller CLI Guide
Help Commands
help focus
help /cx
This command provides specific focus related help, illustrating various ways
to use the focus command. See the section “Shell Object Commands” on
This command provides specific controller /cx related help, illustrating
various commands associated with the controller /cx. See the section
“Controller Object Commands” on page 29 for more information.
help /cx/ux
help /cx/px
help /cx/bbu
help /ex
This command provides specific unit /cx/ux related help, illustrating various
on page 59 for more information.
This command provides specific /cx/px related help, illustrating various ways
This command provides specific /cx/bbu related help, illustrating various
on page 82 for more information.
This command provides specific enclosure /ex related help, illustrating
various commands associated with the enclosure /ex. See the section
help /ex/slotx
This command provides specific slot /ex/slotx related help, illustrating
on page 87 for more information.
www.3ware.com
95
Chapter 2. CLI Syntax Reference
help /ex/fanx
This command provides specific fan /ex/fanx related help, illustrating various
Commands” on page 87 for more information.
help /ex/tempx
This command provides specific temperature sensor /ex/tempx related help,
illustrating various ways to use the /ex/tempx command. See the section
Command Logging
This feature logs controller commands from both CLI and 3DM2 into a file.
You may be asked to supply this logfile to tech support for troubleshooting.
Set the environment variable TW_CLI_LOG to ON or OFF to enable or
disable logging of controller commands into a log file called tw_mgmt.log.
By default, TW_CLI_LOG is set to OFF. The command to start command
logging varies by operating system.
•
•
•
For FreeBSD, Redhat and SuSE, (bash, ksh, or sh), enter
export TW_CLI_LOG=ON
For Linux (chs C-shell), enter
setenv TW_CLI_LOG ON
For Windows, enter
set TW_CLI_LOG=O
In Linux, and FreeBSD, the log file is in /var/log directory.
In Windows, the log file is in the 3DM2 installation directory if 3DM2 is
installed in the system. Otherwise, it is in the current user home directory.
Return Code
While informative messages are written to standard output, error messages are
written to standard error. On success, 0 is returned. On failure, 1 is returned.
To view the return code for Linux:
At the shell command prompt type:
echo $?
The screen prints either a 0 or a 1, depending on whether the command was
successful or not.
96
3ware Serial ATA RAID Controller CLI Guide
Return Code
For example, if you had a 3ware controller with an ID of 0, you could type
this command:
tw_cli /c0 show
(c0 information displayed here)
echo $?
0
If you type:
tw_cli /c7 show
error: (CLI003) specified controller does not exist.
echo $?
1
This example fails (returns 1) because there is no controller 7.
To view the return code for Windows, in a command window type
tw_cli /c0 show
(c0 info displayed here)
if errorlevel 0 echo 0
0
tw_cli /c7 show
error....
if errorlevel 1 echo 1
1
This example fails (returns 1) because there is no controller 7.
www.3ware.com
97
|