Adaptec Command Line Utility, User Manual

Page 1: ...PMC Sierra Confidential Preliminary Draft 11 3 11 User s Guide Adaptec RAID Controller Command Line Utility ...

Page 2: ... suitability for a particular purpose of any such information or the fitness or suitability for a particular purpose merchantability performance compatibility with other parts or systems of any of the products of PMC Sierra Inc or any portion thereof referred to in this document PMC Sierra Inc expressly disclaims all representations and warranties of any kind regarding the contents or use of the i...

Page 3: ...ww adaptec com Search the Adaptec Support Knowledgebase ASK at ask adaptec com for articles troubleshooting tips and frequently asked questions for your product For information about Adaptec by PMC support options call 1 408 957 2550 24 hours per day 7 days per week To speak with a Technical Support Specialist call 1 408 934 7274 For support via e mail submit your question at ask adaptec com You c...

Page 4: ...ing the related documentation together with all copies or modifications in any form PMC Sierra will have the right to terminate our license immediately if you fail to comply with any term or condition of this Agreement Upon any termination including termination by you you must destroy the Software including the related documentation together with all copies or modifications in any form 6 Special T...

Page 5: ...this Agreement in writing signed by an officer of PMC Sierra You assume full responsibility for the use of the Software and agree to use the Software legally and responsibly This Agreement shall be governed by California law except as to copyright matters which are covered by Federal law This Agreement is deemed entered into at Sunnyvale California by both parties Should any provision of this Agre...

Page 6: ...er 12 Installing Remote ARCCONF on a Windows Guest OS 13 Installing Remote ARCCONF on a Linux Guest OS 14 Managing Email Notifications on a Linux Guest OS 15 Starting the Command Line Utility 16 2 Using the Command Line Utility ARCCONF Commands 18 arcconf atapassword 18 arcconf copyback 18 arcconf create 19 arcconf datascrub 21 arcconf delete 21 arcconf driverupdate 21 arcconf failover 22 arcconf ...

Page 7: ... 28 arcconf saveconfig 29 arcconf savesupportarchive 29 arcconf setalarm 30 arcconf setcache 30 arcconf setconfig 31 arcconf setmaxcache 31 arcconf setname 32 arcconf setncq 33 arcconf setperform 33 arcconf setpower 33 arcconf setpriority 34 arcconf setstate 35 arcconf setstatsdatacollection 36 arcconf setvmcredential 36 arcconf task 36 ...

Page 8: ... utility allows you to Create and delete logical drives Display and modify configuration settings Copy configurations from one computer to another Recover from a failed physical device and rebuild an affected logical drive Flash new firmware and BIOS onto the controller Enable the controller to check the removal and connection of any disk drives Automatically update Windows drivers Provides access...

Page 9: ...dows starts insert the Adaptec Installation DVD The Installation DVD Main Menu opens 3 Select Install Adaptec Storage Manager The Installation wizard opens If it doesn t open select Browse the CD DVD then click Autorun 4 Follow the on screen instructions to complete the installation Installing on Red Hat SuSE or Fedora Linux To install ARCCONF on Red Hat SuSE or Fedora Linux 1 Start the computer 2...

Page 10: ... Refer to your operating system documentation for detailed instructions mount F hsfs o ro dev dsk c1t0d0s2 mnt 2 Install Adaptec Storage Manager pkgadd d mount point ASMCD solaris_x86 manager StorMan pkg 3 Follow the on screen instructions to complete the installation 4 Eject or unmount the Adaptec Installation DVD Refer to your operating system documentation for detailed instructions Installing o...

Page 11: ...ge and install it rpm install StorMan rpm 32 bit rpm install nodeps StorMan rpm 64 bit Note Ignore the message Application can be started by typing usr StorMan StorMan sh VMware does not support the Adaptec Storage Manager GUI 5 Change to the usr StorMan directory then enter this command chmod x arcconf Installing Remote ARCCONF Use the following procedure to install the Adaptec CIM Provider and R...

Page 12: ...p arcconf cim For VMware ESXi 4 1 scp mnt cdrom ASMCD esxi4_1 cim arcconf 18815 zip root esxi server ip tmp arcconf cim For VMware ESXi 5 0 scp mnt cdrom ASMCD esxi5_0 cim vmware esx provider arcconf vib root esxi server ip tmp arcconf cim 3 At the VMware ESXi console press ALT F1 then log in as root 4 Install the bundle For VMware ESXi 4 0 esxupdate b tmp arcconf cim vmware esx provider adaptec 1...

Page 13: ...llation DVD 2 Start the Remote Desktop Connection utility then connect to the Windows Guest OS on VMware You will be asked for credentials when you connect 3 Navigate to the ASMCD remote_arcconf windows directory on the installation DVD then copy the setup program setup_remote_arcconf_x32 exe to a local directory on the Windows Guest OS 4 Double click setup_remote_arcconf_x32 exe The installation ...

Page 14: ... a Linux Guest OS on page 15 for more information Note The following instructions assume that you have already created a virtual machine in VMware and installed the Linux Guest OS You must have root privilege on the Linux Guest OS to install Remote ARCCONF Note To copy the installer from the installation DVD to the Linux Guest OS in Step 2 below you must have access to a remote copy utility such a...

Page 15: ... time press Enter after each prompt Do you want to add Recipients yes no default no yes Enter Recipient e mail address client pmc sierra com Enter Notification Type I W E default E I Do you want to add Recipients yes no default no Note For Notification Type I Error Warning Informational W Error Warning E Error 10 When you see the message Installation Completed Successfully reboot the system 11 Ver...

Page 16: ...tion 9 to exit 5 Restart the arcaend daemon if you made any changes etc init d arcaend restart Note Alternatively to start stop restart arcaend run service arcaend start stop restart Starting the Command Line Utility To start ARCCONF enter one of the following commands Windows install_dir arcconf exe Linux usr install_dir arcconf Solaris usr StorMan arcconf FreeBSD install_dir arcconf VMware ESX u...

Page 17: ... you can get are Command completed successfully or Command aborted The return values for each command are the same 0x00 SUCCESS 0x01 FAILURE The requested command failed 0x02 ABORT The command was aborted because parameters failed validation 0x03 INVALID_ARGUMENTS The arguments are incorrect Displays COMMAND help Available commands are described on the following pages in alphabetical order To acce...

Page 18: ...hannel number and device number ID pairs for each drive on which to set or clear the password Examples ARCCONF ATAPASSWORD 1 SET uR8ryx 0 1 ARCCONF ATAPASSWORD 1 CLEAR uR8ryx 0 1 arcconf copyback Enables or disables the copyback feature which attempts to keep drives in the original slot order after rebuilds Syntax ARCCONF COPYBACK Controller ON OFF Parameters Controller is the controller number On...

Page 19: ...E noprompt nologs Parameters Controller is the controller number Logical Drive indicates the logical drive stripe size with the following options Stripesize STRIPE Allows the logical drive stripe size to be built Optional parameters for specifying a stripe size STRIPE is specified in kilobytes 16 32 64 128 256 512 and 1024 are supported The default is 256KB Legs LEG Optional parameters for specify...

Page 20: ... the SSD and the number of dirty pages is below the threshold WT write through enabled Similar to instant write back but full stripe writes go to both the cache and hard disk and no dirty pages are created on the fly This argument is valid only if MaxCacheWriteCache is ION Note For more informattion about write cache policy see setmaxcache on page 31 Size indicates the size of the logical drive in...

Page 21: ...F arcconf delete Deletes a logical drive or JBOD All data stored on the logical drive or JBOD will be lost Spanned drives cannot be deleted with this function Syntax ARCCONF DELETE Controller LOGICALDRIVE LogicalDrive LD LD noprompt ARCCONF DELETE Controller JBOD CHANNEL DRIVE CHANNEL DRIVE noprompt ARCCONF DELETE Controller LOGICALDRIVE JBOD ALL noprompt Parameters Controller is the controller nu...

Page 22: ...lers logical drives and physical devices This information can include but is not limited to the following items Controller type BIOS boot block device driver and firmware versions Logical drive status RAID level and size maxCache status enabled disabled fetch and flush rate policy low medium high and read write balance Device type device ID presence of PFA SSD status SSD or not part of maxCache po...

Page 23: ...d rebuilds LDMs etc STATS A log of controller usage statistics Syntax ARCCONF GETLOGS Controller Type clear tabular Parameters Controller is the controller number Type is one of the following DEVICE DEAD EVENT STATS Clear clears the specified log Note This option is valid only for the DEVICE DEAD and EVENT log types Tabular displays the log or statistics in tabular format Examples ARCCONF GETLOGS ...

Page 24: ...the Adaptec Storage Manager 2 GETSTATUS reports verify clear initialize and secure erase operations on physical devices 3 GETSTATUS only reports active operations It does not display information if the operation is completed Syntax ARCCONF GETSTATUS Controller Parameters Controller is the controller number Example ARCCONF GETSTATUS 1 arcconf getversion Lists version information for all controllers...

Page 25: ...e to be flashed to the hard drive Syntax ARCCONF IMAGEUPDATE Controller DEVICE Channel ID ChunkSize Filename Mode noprompt Parameters Controller is the controller number Channel is the channel number of the device to be updated ID is the device number of the device to be updated ChunkSize is the chunk size in bytes to be used to update the firmware Note For SATA drives the chunk size must be a mul...

Page 26: ...ive is the logical drive number TO indicates that the modifications will follow Options Stripesize indicates the stripe size in KB Options are 16 32 64 128 256 512 and 1024 the default is 256KB init_priority is the priority level of the modification Options are low med and high Legs is the number of subarrays for a RAID level 50 or RAID level 60 array Possible values are 2 16 legs and 3 16 drives ...

Page 27: ... verify that the controller was configured successfully The exit codes shown below indicate the success or failure of the operation and if the system needs to be rebooted Syntax ARCCONF PLAYCONFIG Input XML File LogFile FORCE ALL LOGICALSIZE Parameters Input XML File is the pathname of the server template file The default server template file is available at C PMCS Logs saveconfig xml LogFile is t...

Page 28: ...ler number Example ARCCONF RESETSTATISTICSCOUNTERS 1 arcconf romupdate Allows new firmware and BIOS to be flashed to the controller A reboot is required for the new firmware to take effect Note 1 This function is only supported in Windows and Linux 2 Be sure to copy the UFI update files from the DVD and not from the BIOS Firmware update diskettes Syntax ARCCONF ROMUPDATE Controller BaseName Newver...

Page 29: ...plate file The default name if you omit this parameter is C PMCS Logs saveconfig xml LogFile is the pathname of the error log file By default the error log is available at C PMCS Logs saveconfig log Example 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 syst...

Page 30: ...s a logical drive s cache mode Syntax ARCCONF SETCACHE Controller LOGICALDRIVE LogicalDrive logical mode noprompt nologs ARCCONF SETCACHE Controller DEVICE Channel ID physical mode nologs Parameters Controller is the controller number LogicalDrive is the number of the logical drive whose cache will be altered Logical drive cache modes RON read cache on ROFF read cache off WT write through disabled...

Page 31: ...om 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 Note Before you can enable maxCache SSD caching you must assign at least one SSD to the maxCache pool S...

Page 32: ...axCache write cache policy WB write back enabled maxCache will store the data on the SSD and write it back to the hard disks when there is little or no impact on performance This is the default policy INSTWB instant write back enabled In addition to the default policy maxCache will create dirty pages on the fly for full stripe writes if there is room on the SSD and the number of dirty pages is bel...

Page 33: ...ORM Controller Performance Mode nologs Parameters Controller is the controller number Performance Mode is 1 DYNAMIC Default 2 OLTP Database or 3 Big Block Bypass When set to Dynamic performance criteria adjusts automatically based on controller usage RAID level and disk drive type When set to OLTP Database performance criteria is optimized for transaction oriented applications such as data entry a...

Page 34: ...LogicalDrive is the logical drive number Slowdown st sets the disk drive slow down timer in minutes Valid values are 0 never 3 5 10 20 30 60 120 180 Poweroff pt sets the disk drive power off timer in minutes Valid values are 0 never 3 5 10 20 30 60 120 180 Verify vt sets the period of inactivity in hours after which an inactive drive a drive that s already powered down is restarted to verify its o...

Page 35: ...ts current state to the designated state Syntax ARCCONF SETSTATE Controller DEVICE Channel Device State LOGICALDRIVE LD LD noprompt ARCCONF SETSTATE Controller LOGICALDRIVE LD OPTIMAL ADVANCED option noprompt Parameters Controller is the controller number Channel is the channel number for the drive Device is the device number for the device LD is the logical drive number State HSP Create a hot spa...

Page 36: ...or VMware Guest OSs running Remote ARCCONF only Syntax SETVMCREDENTIAL Esxip Esxcimomport Esxuserid Esxpassword noprompt Parameters Esxip is the Hypervisor IP address Esxcimomport is the Hypervisor CiMOM port number Esxuserid is the Hypervisor user name Esxpassword is the Hypervisor password Example ARCCONF SETVMCREDENTIAL 172 18 46 101 5989 root passwd arcconf task Performs a task on a logical dr...

Page 37: ...verifies the disk media and repairs the disk if bad data is found verify verifies the disk media without repairing bad data clear removes all data from the drive initialize returns a drive to the READY state erases the metadata secureerase password removes all data from the drive in a secure fashion to prevent any possible recovery of the erased data See arcconf atapassword on page 18 for details ...

Page 38: ...a 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 ...