Adaptec Command Line Utility User Manual

Raid controller
Hide thumbs Also See for Command Line Utility:

Advertisement

Quick Links

Adaptec RAID Controller
Command Line Utility
User's Guide
PMC-Sierra Confidential — Preliminary Draft 11/3/11

Advertisement

Table of Contents
loading

Summary of Contents for Adaptec Command Line Utility

  • Page 1 Adaptec RAID Controller Command Line Utility User’s Guide PMC-Sierra Confidential — Preliminary Draft 11/3/11...
  • Page 2 Sierra, Inc. Trademarks PMC, PMC-Sierra, and Adaptec are registered trademarks of PMC-Sierra, Inc. “Adaptec by PMC” is a trademark of PMC-Sierra, Inc. Other product and company names mentioned herein may be trademarks of their respective owners. For a complete list of PMC-Sierra trademarks, see www.pmc-sierra.com/legal.
  • Page 3 Adaptec by PMC Product Support If you have questions about installing or using your Adaptec by PMC product, check this document first—you will find answers to most of your questions. If you need further assistance, use the support options listed below. To expedite your service, have your computer in front of you.
  • Page 4 ● Software License Agreement PLEASE READ CAREFULLY: THE USE OF THIS SOFTWARE IS SUBJECT TO THE SOFTWARE LICENSE TERMS OF PMC-SIERRA, INC. AND OTHER LICENSORS WHOSE SOFTWARE MAY BE BUNDLED WITH THIS PRODUCT. BY YOUR USE OF THE SOFTWARE INCLUDED WITH THIS PRODUCT YOU AGREE TO THE LICENSE TERMS REQUIRED BY THE LICENSOR OF THAT SOFTWARE, AS SET FORTH DURING THE INSTALLATION PROCESS.
  • Page 5 ● 12. General. You acknowledge that you have read this Agreement, understand it, and that by using the Software you agree to be bound by its terms and conditions. You further agree that it is the complete and exclusive statement of the agreement between PMC-Sierra and you, and supersedes any proposal or prior agreement, oral or written, and any other communication between PMC-Sierra and you relating to the subject matter of this Agreement.
  • Page 6: Table Of Contents

    Contents Getting Started with the Command Line Utility Installing the Command Line Utility..............9 Installing on Windows.................. 9 Installing on Red Hat, SuSE, or Fedora Linux ..........9 Installing on Debian or Ubuntu Linux............10 Installing on Solaris ..................10 Installing on FreeBSD.................
  • Page 7 Contents ● arcconf key ....................26 arcconf modify .................... 26 arcconf playconfig..................27 arcconf rescan ..................... 28 arcconf resetstatisticscounters..............28 arcconf romupdate ..................28 arcconf saveconfig..................29 arcconf savesupportarchive................ 29 arcconf setalarm..................30 arcconf setcache ..................30 arcconf setconfig ..................31 arcconf setmaxcache ...................
  • Page 8 Getting Started with the Command Line Utility In this chapter... Installing the Command Line Utility ..................9 Installing Remote ARCCONF....................11 Starting the Command Line Utility ..................16 ™ ® This chapter explains how your Adaptec by PMC RAID controllers support the use of the ARCCONF command line utility.
  • Page 9: Getting Started With The Command Line Utility

    Adaptec Storage Manager and must remain there. Note: To install the command line utility on VMware ESX 4.x systems, follow the instructions in Installing on VMware on page 11. To install the command line utility on VMware ESXi systems,...
  • Page 10: Installing On Debian Or Ubuntu Linux

    Install Adaptec Storage Manager: pkgadd -d/<mount point>/ASMCD/solaris_x86/manager/StorMan.pkg Follow the on-screen instructions to complete the installation. Eject or unmount the Adaptec Installation DVD. Refer to your operating system documentation for detailed instructions. Installing on FreeBSD To install ARCCONF on FreeBSD systems: Insert the Adaptec Installation DVD.
  • Page 11: Installing On Vmware

    +x arcconf Installing Remote ARCCONF Use the following procedure to install the Adaptec CIM Provider and Remote ARCCONF on a VMware ESXi 5.0 system or VMware ESXi 4.x system. Remote ARCCONF provides native command line support on VMware Windows and Linux Guest OSs. Optionally, you can enable email notifications when you install Remote ARCCONF on a Linux Guest OS.
  • Page 12: Installing The Adaptec Cim Provider

    Using a remote copy utility, copy the CIM Provider VIB file for your operating system version from the Adaptec Installation DVD to a local directory on the ESXi server. This example uses Linux scp to copy the driver to the /tmp/arcconf-cim directory: For VMware ESXi 4.0:...
  • Page 13: Installing Remote Arcconf On A Windows Guest Os

    Chapter 1: Getting Started with the Command Line Utility ● If the package installed successfully, you should see a line like this: arcconf 1.00-1 Adaptec unknown 2011-08-26 Continue the installation with Installing Remote ARCCONF on a Windows Guest OS on...
  • Page 14: Installing Remote Arcconf On A Linux Guest Os

    WinSCP , putty, or Linux scp. To install Remote ARCCONF on a Linux Guest OS: On a Windows or Linux machine, insert the Adaptec Installation DVD. Navigate to the ASMCD/remote_arcconf/linux directory then, using a remote copy utility (such as WinSCP or Linux scp), copy the 32-bit or 64-bit installer to a local directory on the Linux Guest OS.
  • Page 15: Managing Email Notifications On A Linux Guest Os

    Chapter 1: Getting Started with the Command Line Utility ● Enter the Hypervisor login credentials (or use the default credentials), one prompt at a time; press Enter after each prompt: Enter Hypervisor IP address [default:127.0.0.1]:172.18.46.101 Enter Hypervisor User name [default:root]:...
  • Page 16: Starting The Command Line Utility

    Chapter 1: Getting Started with the Command Line Utility ● Run configUtil.sh: ./configUtil.sh Choose any of the following options from the menu: ----------------------------------------------------------------------------- 1) Get SMTP Server Details 2) Set SMTP Server Details 3) Get Event Listener Port 4) Set Event Listener Port...
  • Page 17 In this chapter... ARCCONF Commands ......................18 This chapter explains how to use the command line utility interactively or in batch mode. With interactive mode, enter commands at the prompt. In batch mode, create scripts and run the script in the appropriate shell. For example:...
  • Page 18: Using The Command Line Utility

    Chapter 2: Using the Command Line Utility ● ARCCONF Commands Perform the following functions from the command line: ARCCONF COMMANDS atapassword getsmartstats resetstatisticscounters setncq copyback getstatus romupdate setperform create getversion saveconfig setpower datascrub identify savesupportarchive setpriority delete imageupdate setalarm setstate...
  • Page 19: Arcconf Create

    On redundant logical drives, ARCCONF performs autosynchronization. ARCCONF presents JBODs as physical devices, not logical drives. Note: maxCache write caching can be enabled only with the assistance of Adaptec by PMC support. Contact your service representative for information about enabling the maxCache write caching feature.
  • Page 20 Chapter 2: Using the Command Line Utility ● Wcache—Sets the logical drive write cache mode: ● WT - write-through disabled ● WB - write-back enabled ● WBB - write-back enabled (when protected by battery or flash backup module) ● MaxCacheReadCache—Sets the logical drive SSD read cache mode: ●...
  • Page 21: Arcconf Datascrub

    Chapter 2: Using the Command Line Utility ● arcconf datascrub Toggles the background consistency check modes of the controller. Syntax ARCCONF DATASCRUB <Controller#> <on|off|period <DAYS>> [noprompt] Parameters Controller# is the controller number. On turns background consistency check on. Off turns background consistency check off.
  • Page 22: Arcconf Failover

    Chapter 2: Using the Command Line Utility ● Syntax ARCCONF DRIVERUPDATE <DirName> Parameters Driverupdate <DirName> is the directory path containing the driver that you want to update. Example ARCCONF DRIVERUPDATE C:\WINDOWSALL arcconf failover Turns automatic failover on and off. Syntax ARCCONF FAILOVER <Controller#>...
  • Page 23: Arcconf Getlogs

    ARCCONF GETLOGS 1 STATS Tabular arcconf getsmartstats Displays SMART statistics for the hard drives and Solid State Drives (SSDs) on a controller. Note: For more information about SMART statistics, see the Adaptec Storage Manager User’s Guide. Syntax ARCCONF GETSMARTSTATS <Controller#> [Tabular]...
  • Page 24: Arcconf Getstatus

    Chapter 2: Using the Command Line Utility ● Parameters Controller# is the controller number. Tabular creates output in tabular format. Examples ARCCONF GETSMARTSTATS 1 ARCCONF GETSMARTSTATS 1 TABULAR arcconf getstatus The GETSTATUS function displays the status of any background command that is currently running.
  • Page 25: Arcconf Identify

    Chapter 2: Using the Command Line Utility ● arcconf identify Identifies a physical or logical device by blinking its LEDs. Syntax ARCCONF IDENTIFY <Controller#> LOGICALDRIVE <LogicalDrive#> ARCCONF IDENTIFY <Controller#> DEVICE <Channel#> <ID> Parameters Controller# is the controller number LogicalDrive# is the number of the logical drive to be identified...
  • Page 26: Arcconf Key

    Chapter 2: Using the Command Line Utility ● arcconf key Loads a feature key onto an Adaptec controller. Syntax ARCCONF KEY <Controller#> SET <Key#> Parameters Controller# is the controller number Key# is the key number provided by Adaptec Example ARCCONF KEY 1 SET ABCD EFGH IJKL MNOP QRST UVWX arcconf modify Morphs a logical device from one raid level to another (RAID Level Migration).
  • Page 27: Arcconf Playconfig

    Chapter 2: Using the Command Line Utility ● Example ARCCONF MODIFY 1 FROM 2 TO 2048 0 0 123 0 124 0 117 arcconf playconfig Configures a controller using a XML server template file produced by the SAVECONFIG command (see page 29).
  • Page 28: Arcconf Rescan

    Chapter 2: Using the Command Line Utility ● arcconf rescan Enables the controller to check for the removal of any disk drives in the ready state and to check for the connection of any new disk drives to the controller. The command returns when the rescan is complete.
  • Page 29: Arcconf Saveconfig

    ARCCONF SAVECONFIG server1_config.xml C:\LOGS\SERVER1.LOG arcconf savesupportarchive Saves configuration and status information to help Adaptec Customer Support diagnose a problem with your system. Saved information includes (but is not limited to) device logs, drive logs, event logs, error logs, controller logs, and SSD SMART statistics. (For more information...
  • Page 30: Arcconf Setalarm

    Chapter 2: Using the Command Line Utility ● Parameters None. Example ARCCONF SAVESUPPORTARCHIVE arcconf setalarm Sets the state of the controller audible alarm, if present. Syntax ARCCONF SETALARM <Controller#> <on|off|silence|test> Parameters Controller# is the controller number On enables the alarm...
  • Page 31: Arcconf Setconfig

    Drives to the maxCache pool and removes SSDs from the pool; sets the maxCache read/write balance and cache fetch/flush rate; clears the maxCache pool. Note: maxCache write caching can be enabled only with the assistance of Adaptec by PMC support. Contact your service representative for information about enabling the maxCache write caching feature.
  • Page 32: Arcconf Setname

    Chapter 2: Using the Command Line Utility ● Parameters Controller# is the controller number. LogicalDrive# is the number of the logical drive. You can specify one or more logical drives. Channel# is the channel number for the SSD. Device# is the device number for the SSD.
  • Page 33: Arcconf Setncq

    Chapter 2: Using the Command Line Utility ● LogicalDrive# is the number of the logical drive to be renamed New Name is the new name of the logical drive Example ARCCONF SETNAME 1 LOGICALDRIVE 1 BACKUP_A arcconf setncq Changes the controller’s Native Command Queuing (NCQ) setting to enabled or disabled.
  • Page 34: Arcconf Setpriority

    Chapter 2: Using the Command Line Utility ● ARCCONF SETPOWER <Controller#> LD <LogicalDrive#> DISABLE|[SLOWDOWN <st#>] [POWEROFF <pt#>] [VERIFY <vt#>] Parameters Controller# is the controller number. Stayawake sets the stayawake period for the disk drives on the controller. During the stayawake period, the disk drives always operate at their peak spin rate.
  • Page 35: Arcconf Setstate

    Chapter 2: Using the Command Line Utility ● Parameters Controller# is the controller number. Task ID is the number of the task to be changed. Use arcconf getstatus to obtain the task ID. Omit this parameter to set the controller’s global background task priority; that is, the execution priority for all tasks on the controller.
  • Page 36: Arcconf Setstatsdatacollection

    Chapter 2: Using the Command Line Utility ● arcconf setstatsdatacollection Enables or disables statistics collection for a controller. To display the statistics, use the arcconf getlogs command (see page 23). Syntax ARCCONF SETSTATSDATACOLLECTION <Controller#> Enable|Disable Parameters Controller# is the controller number.
  • Page 37 Chapter 2: Using the Command Line Utility ● Logical drive options: ● verify_fix (Verify with fix)—verifies the logical drive redundancy and repairs the drive if ● bad data is found. verify—verifies the logical drive redundancy without repairing bad data. ●...
  • Page 38 PMC-Sierra, Inc. 1380 Bordeaux Drive Sunnyvale, CA 94089 USA © Copyright PMC-Sierra, Inc. 2011 All rights reserved. Adaptec and the Adaptec by PMC logo are trademarks of PMC-Sierra, Inc. Part Number: CDP-00269-01-A Rev A JPB 03/11...

Table of Contents