Document Outline

• Table of Contents
• About this CLI Guide
• Introduction to the 3ware Command Line Interface
  • Features of the CLI
  • Supported Operating Systems
  • Installing the 3ware CLI
    • Installing the 3ware CLI on Windows
      • Permissions Required to Run CLI
    • Installing the 3ware CLI on Linux
  • Working with 3ware CLI
    • Using the command interface interactively
    • Using a single command with output
    • Using an input file to execute a script
      • Scripting examples
    • Outputting the CLI to a Text File
    • Conventions
  • Understanding RAID Levels and Concepts
    • RAID Concepts
    • Available RAID Configurations
      • RAID 0
      • RAID 1
      • RAID 5
      • RAID 6
      • RAID 10
      • RAID 50
      • Single Disk
      • JBOD
      • Hot Spare
    • Determining What RAID Level to Use
    • Using Drive Capacity Efficiently
    • Support for Over 2 Terabytes
• CLI Syntax Reference
  • Common Tasks Mapped to CLI Commands
  • Terminology
  • Syntax Overview
  • Shell Object Commands
    • focus Object
    • commit
    • flush
    • rescan
    • show
    • show alarms [reverse]
    • show events [reverse]
    • show AENs [reverse]
    • show diag
    • show rebuild
    • show selftest
    • show ver
    • show verify
    • update fw=filename_with_path [force]
  • Controller Object Commands
    • /cx show
    • /cx show attribute [attribute ...]
    • /cx show all
    • /cx show alarms [reverse]
    • /cx show events [reverse]
    • /cx show AENs [reverse]
    • /cx show diag
    • /cx show phy
    • /cx show rebuild
    • /cx show rebuildmode
    • /cx show rebuildrate
    • /cx show selftest
    • /cx show verify
    • /cx show verifymode
    • /cx show verifyrate
    • /cx add type=<RaidType> disk=<p:-p> [stripe=size] [noscan] [group=<3|4|5|6|7|8|9|10|11|12/ 13|14|15|16>] [nocache|nowrcache] [no...
    • /cx rescan [noscan]
    • /cx commit
    • /cx flush
    • /cx update fw=filename_with_path [force]
    • /cx add rebuild=ddd:hh:duration
      • Setting Up a Rebuild Schedule
    • /cx add verify=ddd:hh:duration
      • Setting Up a Verify Schedule
    • /cx add selftest=ddd:hh
      • Setting Up a Selftest Schedule
    • /cx del rebuild=slot_id
    • /cx del verify=slot_id
    • /cx del selftest=slot_id
    • /cx set dpmstat=on|off
    • /cx set rebuild=enable|disable|1..5
    • /cx set rebuildmode=<adaptive|lowlatency>
    • /cx set rebuildrate=<1...5>
    • /cx set verify=enable|disable|1..5
    • /cx set verify=advanced|basic|1..5
    • /cx set verify=basic [pref=ddd:hh]
    • /cx set verifymode=<adaptive|lowlatency>
    • /cx set verifyrate=<1..5>
    • /cx set selftest=enable|disable [task=UDMA|SMART]
    • /cx set ondegrade=cacheoff|follow
    • /cx set spinup=nn
    • /cx set stagger=nn
    • /cx set autocarve=on|off
    • /cx set carvesize=[1024..32768]
    • /cx set autorebuild=on|off
    • /cx set autodetect=on|off disk=<p:-p>|all
    • /cx start mediascan
    • /cx stop mediascan
  • Unit Object Commands
    • /cx/ux show
    • /cx/ux show attribute [attribute ...]
    • /cx/ux show all
    • /cx/ux remove [noscan] [quiet]
    • /cx/ux del [noscan] [quiet]
    • /cx/ux start rebuild disk=<p:-p...> [ignoreECC]
    • /cx/ux start verify
    • /cx/ux pause rebuild
    • /cx/ux resume rebuild
    • /cx/ux stop verify
    • /cx/ux flush
    • /cx/ux set autoverify=on|off
    • /cx/ux set cache=on|off [quiet]
    • /cx/ux set wrcache=on|off [quiet]
    • /cx/ux set rdcache=basic|intelligent|off
    • /cx/ux set identify=on|off
    • /cx/ux set ignoreECC=on|off
    • /cx/ux set name=string
    • /cx/ux set qpolicy=on|off
    • /cx/ux set rapidrecovery all|rebuild|disable [quiet]
    • /cx/ux set storsave=protect|balance|perform [quiet]
    • /cx/ux migrate type=RaidType [disk=p:-p] [group=3|4|5|6|7|8|9|10|11|12|13|14|15|16] [stripe=size] [noscan] [nocache] [autoverify]
      • Migration Process
      • Example of splitting a mirror
      • Example of capacity expansion
      • Example of migrate output
      • Example of migrate output for Single to RAID-1
  • Port Object Commands
    • /cx/px show
    • /cx/px show attribute [attribute ...]
    • /cx/px show all
    • /cx/px show dpmstat type=inst|ra|lct|histdata|ext
    • /cx/px remove [noscan] [quiet]
    • /cx/px set identify=on|off
    • /cx/px set dpmstat=clear [type=ra|lct|ext]
  • Phy Object Commands
    • /cx/phyx show
    • /cx/phyx set link=auto|1.5|3.0|6.0
  • BBU Object Commands
    • /cx/bbu show
    • /cx/bbu show attribute [attribute ...]
    • /cx/bbu show all
    • /cx/bbu test [quiet]
    • /cx/bbu enable
    • /cx/bbu disable [quiet]
  • Enclosure Object and Element Commands
    • /cx/ex show
    • /cx/ex show attribute [attribute ...]
    • /cx/ex show all
    • /cx/ex/slotx show
    • /cx/ex/slotx show identify
    • /cx/ex/slotx set identify=on|off
    • /cx/ex/fanx show
    • /cx/ex/fanx show identify
    • /cx/ex/fanx set identify=on|off
    • /cx/ex/fanx set speed=<0..7>
    • /cx/ex/pwrsx show
    • /cx/ex/pwrsx show identify
    • /cx/ex/pwrsx set identify=on|off
    • /cx/ex/tempx show
    • /cx/ex/tempx show identify
    • /cx/ex/tempx set identify=on|off
    • /cx/ex/almx show
    • /cx/ex/almx set alarm=mute|unmute|off
  • Help Commands
    • Help with specific commands
    • Help with attributes
    • help
    • help show
    • help flush
    • help rescan
    • help update
    • help commit
    • help focus
    • help /cx
    • help /cx/phyx
    • help /cx/ux
    • help /cx/px
    • help /cx/bbu
    • help /cx/ex
    • help /cx/ex/slotx
    • help /cx/ex/fanx
    • help /cx/ex/tempx
    • help /cx/ex/pwrsx
    • help /cx/ex/almx
  • Command Logging
    • Location of the Log File
    • Disabling and enabling command logging
      • For Linux
      • For Windows
  • Return Code