.

Adaptec RAID Controller
Command Line Utility
User's Guide
CDP-00284-06-A Rev. A
ReleasedIssue : May 2015

Adaptec RAID Controller Command Line Utility User's Guide

Copyright © 2015 PMC-Sierra, Inc. All rights reserved.
The information in this document is proprietary and confidential to
PMC-Sierra, Inc. In any event, no part of this document may be reproduced
or redistributed in any form without the express written consent of
PMC-Sierra, Inc.
CDP-00284-06-A Rev. A, Issue
None of the information contained in this document constitutes an express
or implied warranty by PMC-Sierra, Inc. as to the sufficiency, fitness or
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 information, including, but not limited to, express and implied
warranties of accuracy, completeness, merchantability, fitness for a particularuse, or non-infringement.
In no event will PMC-Sierra, Inc. be liable for any direct, indirect, special,incidental or consequential damages, including, but not limited to, lost profits,
lost business or lost data resulting from any use of or reliance upon theinformation, whether or not PMC-Sierra, Inc. has been advised of thepossibility of such damage.
For a complete list of PMC-Sierra’s trademarks and registered trademarks,
visit: http://www.pmc-sierra.com/legal/.
Other product and company names mentioned herein may be the trademarksof their respective owners.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

2

Adaptec RAID Controller Command Line Utility User's Guide

Revision History
Issue

Issue Date

Details of Change

1.08

May 2015

Adaptec RAID Controller Command Line Utility Version 1.08

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

3

Adaptec RAID Controller Command Line Utility User's Guide

Contents
Adaptec by PMC Product Support..............................................................................................................................7
Software License Agreement......................................................................................................................................8
1 Getting Started with the Command Line Utility....................................................................................................11
Installing the Command Line Utility.............................................................................................................11
Downloading the Installation Packages...........................................................................................11
Installing on Windows.....................................................................................................................12
Installing on Red Hat, Cent OS, SuSE, or Fedora Linux.....................................................................12
Installing on Debian or Ubuntu Linux..............................................................................................12
Installing on Solaris..........................................................................................................................13
Installing on FreeBSD.......................................................................................................................13
Installing on VMware.......................................................................................................................13
Installing on Citrix XenServer...........................................................................................................14
Installing on a Guest Operating System...........................................................................................14
Installing on a Windows Guest OS......................................................................................14
Installing on a Linux Guest OS.............................................................................................15
Starting the Command Line Utility...............................................................................................................15
2 Using the Command Line Utility...........................................................................................................................16
ARCCONF Commands...................................................................................................................................16
arcconf atapassword....................................................................................................................................17
arcconf backupunit.......................................................................................................................................17
arcconf consistencycheck.............................................................................................................................18
arcconf copyback.........................................................................................................................................18
arcconf create..............................................................................................................................................19
arcconf delete..............................................................................................................................................20
arcconf driverupdate....................................................................................................................................21
arcconf expanderlist.....................................................................................................................................22
arcconf expanderupgrade............................................................................................................................22
arcconf failover.............................................................................................................................................23
arcconf getconfig..........................................................................................................................................23
arcconf getlogs.............................................................................................................................................24
arcconf getperform......................................................................................................................................25
arcconf getsmartstats...................................................................................................................................26
arcconf getstatus..........................................................................................................................................26
arcconf getversion........................................................................................................................................27
arcconf identify............................................................................................................................................27
arcconf imageupdate...................................................................................................................................28
arcconf key...................................................................................................................................................29
arcconf modify.............................................................................................................................................29
arcconf phyerrorlog......................................................................................................................................30
arcconf playconfig........................................................................................................................................30
arcconf preservecache.................................................................................................................................31
arcconf rescan..............................................................................................................................................32
arcconf resetstatisticscounters.....................................................................................................................33
arcconf romupdate.......................................................................................................................................33
arcconf saveconfig........................................................................................................................................34
arcconf savesupportarchive.........................................................................................................................34
arcconf setalarm...........................................................................................................................................35
arcconf setbiosparams.................................................................................................................................36
arcconf setcache..........................................................................................................................................36
arcconf setconfig..........................................................................................................................................37
arcconf setconnectormode..........................................................................................................................38
arcconf setcontrollermode...........................................................................................................................39
arcconf setcustommode...............................................................................................................................40
arcconf setmaxcache....................................................................................................................................41
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

4Adaptec RAID Controller Command Line Utility User's Guide

arcconf setname...........................................................................................................................................43
arcconf setncq..............................................................................................................................................43
arcconf setperform.......................................................................................................................................43
arcconf setphy..............................................................................................................................................44
arcconf setpower.........................................................................................................................................45
arcconf setpriority........................................................................................................................................46
arcconf setstate............................................................................................................................................46
arcconf setstatsdatacollection.....................................................................................................................47
arcconf setvmcredential...............................................................................................................................48
arcconf task..................................................................................................................................................48
arcconf uninit...............................................................................................................................................49

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

5Adaptec RAID Controller Command Line Utility User's Guide

List of Tables
Table 1: ARCCONF Batch Environments.............................................................................................................16
Table 2: ARCCONF Commands...........................................................................................................................16

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, IssueviAdaptec RAID Controller Command Line Utility User's Guide

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.
Note: The phone numbers below are subject to change. Please visit the Support
section of www.adaptec.com for the most up to date contact information.
Self Help and Support in English• Visit our Web site at www.adaptec.com.
• Search the Adaptec Support Knowledgebase (ASK) at ask.adaptec.com for articles, troubleshooting
tips, and frequently asked questions for your product.
• For support via e-mail, submit your question at ask.adaptec.com.
• To speak with a Technical Support Specialist, call +1 408 934 7274 or +49 89 4366 5544 or +44 845
266 8773.
Technische Informationen und Support in Deutsch• Besuchen Sie unsere Webseite www.adaptec.com/de-de• Suchen Sie in der Adaptec Support Knowledgebase (ASK) unter ask-de.adaptec.com nach Artikeln,
Tipps zur Fehlerbehebung und häufig gestellten Fragen zu Ihrem Produkt.
• Support per Email erhalten Sie unter ask-de.adaptec.com.
• Für telefonischen Support wählen Sie +49 89 4366 5522.
Техническая поддержка и информация на русском языке
• Посещаете наш сайт www.adaptec.com/ru-ru/.
• База знаний Adaptec (ASK) на сайте ask-ru.adaptec.com ask-ru.adaptec.com – статьи, советы поустранению неисправностей и часто задаваемые вопросы о Вашем продукте.
• Для поддержки по электронной почте отправьте Ваш запрос на сайте ask-ru.adaptec.com• Чтобы обратиться к специалисту технической поддержки по телефону, звоните на +7 499 918
7200 или +49 89 4366 5555.
日本語での技術情報とサポート• 弊社のウェブサイト、www.adaptec.com/ja-jp をご覧ください。
• ask.adaptec.co.jp のAdaptec Support Knowledgebase (ASK)で、お使いの製品の情報 トラブルシュー
ティングのヒント、よくある質問を検索してください。

• Eメールでのサポートには ask.adaptec.co.jp から質問を送ってください。
Information Technique et d'assistance en Français• Visitez notre site Web à l'adresse www.adaptec.com/fr-fr.
• Rechercher dans le base de connaissances Adaptec (ASK) ask-fr.adaptec.com pour des articles,
conseils de dépannage et les questions fréquemment posées pour votre produit.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

7

Adaptec RAID Controller Command Line Utility User's Guide

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 TERMSREQUIRED BY THE LICENSOR OF THAT SOFTWARE, AS SET FORTH DURING THE INSTALLATION PROCESS.
IF YOU DO NOT AGREE TO THE LICENSE TERMS APPLICABLE TO THE SOFTWARE, YOU MAY RETURN THE
ENTIRE UNUSED PRODUCT FOR A FULL REFUND.
In return for acquiring a license to use the PMC-Sierra software, which may include software from third
party licensors and patches made available by PMC-Sierra (“Software”), and the related documentation,
you agree to the following terms and conditions:
1. License. This Agreement grants you, the Licensee, a license to:a. Use the Software on a single computer system, which is not intended for use by more than five(5) users; and:b. Make one copy of the Software in machine readable form solely for back-up purposes, provided
you reproduce PMC-Sierra's copyright proprietary legends. Notwithstanding the foregoing, theSoftware may be used on the home, laptop or other secondary computer of the principal userof the Software, and an additional copy of the Software may be made to support such use. As
used in this license, the Software is “in use” when it is either loaded into RAM or installed on ahard disk or other permanent memory device. The Software may be “in use” on only one computerat any given time. (Different license terms and fees are applicable for networked or multiple user
applications.) As a specific condition of this license, you agree to use the Software in compliancewith all applicable laws, including copyright laws, and that you will not copy, transmit, perform
or distribute any audio or other content using the Software without obtaining all necessary
licenses or permissions from the owner of the content.
2. Restrictions. You may not distribute copies of the Software to others or electronically transfer the
Software from one computer to another over a network. You may not post or otherwise makeavailable the Software, or any portion thereof, in any form, on the Internet. You may not use theSoftware in a computer service business, including in time sharing applications. The Software contains
trade secrets and, in order to protect them, you may not decompile, reverse engineer, disassemble,
or otherwise reduce the Software to a human-perceivable form. YOU MAY NOT MODIFY, ADAPT,TRANSLATE, RENT, LEASE, LOAN, RESELL FOR PROFIT, DISTRIBUTE, NETWORK OR CREATE DERIVATIVEWORKS BASED UPON THE SOFTWARE OR ANY PART THEREOF.
3. Ownership of Software. As Licensee, you own the media upon which the software is recorded or
fixed, but PMC-Sierra and its licensors retain title and ownership of the Software recorded on theoriginal media and all subsequent copies of the Software, regardless of the form or media in which
or on which the original and other copies may exist. This license is not a sale of the Software or any
copy.
4. Confidentiality. You agree to maintain the Software in confidence and that you will not disclose theSoftware to any third party without the express written consent of PMC-Sierra. You further agree
to take all reasonable precautions to preclude access of unauthorized persons to the Software.
5. Term. This license is effective until January 1, 2045, unless terminated earlier. You may terminate
the license at any time by destroying the Software (including 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 Terms Applicable to Databases. Where a database is included with the Software, you
acknowledge that it is licensed only in connection with the use of the Software to perform disc
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

8Adaptec RAID Controller Command Line Utility User's Guide

creation, and that the database and all data derived therefrom must be maintained in confidencein accordance with the provisions of Section 4. This license does not grant you any rights to distributeor disclose such database or data.
7. Limited Warranty. PMC-Sierra and its Licensor warrant only that the media upon which the Software
is furnished will be free from defects in material or workmanship under normal use and service fora period of thirty (30) days from the date of delivery to you. PMC-SIERRA AND ITS LICENSORS DO
NOT AND CANNOT WARRANT THE PERFORMANCE OR RESULTS YOU MAY OBTAIN BY USING THE
SOFTWARE OR DOCUMENTATION. THE FOREGOING STATES THE SOLE AND EXCLUSIVE REMEDIESPMC-SIERRA AND ITS LICENSORS WILL PROVIDE FOR BREACH OF WARRANTY. EXCEPT FOR THE
FOREGOING LIMITED WARRANTY, PMC-SIERRA AND ITS LICENSORS MAKE NO WARRANTIES,EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED, AS TO NON-INFRINGEMENT OF THIRD PARTY
RIGHTS, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow theexclusion of implied warranties or limitations on how long an implied warranty may last, so theabove limitations may not apply to you. This warranty gives you specific legal rights and you may
also have other rights which vary from state to state.
8. The entire liability of PMC-Sierra and its licensors, and your exclusive remedy for a breach of thiswarranty, shall be:a. The replacement of any media not meeting the above limited warranty which is returned to
PMC-Sierra; or:b. if PMC-Sierra or its distributor is unable to deliver replacement media which is free from defects
in materials or workmanship, you may terminate this Agreement by returning the Software andyour money will be refunded.
9. Limitation of Liability. IN NO EVENT WILL PMC-SIERRA OR ITS LICENSORS BE LIABLE TO YOU FOR ANY
INCIDENTAL, CONSEQUENTIAL OR INDIRECT DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS,
OR LOSS OF DATA, EVEN IF PMC-SIERRA OR A LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY. Some states do not allow the exclusion
or limitation of special, incidental, or consequential damages, so the above limitation or exclusion
may not apply to you.
10. Export. You acknowledge that the laws and regulations of the United States and other countries
may restrict the export and re-export of the Software. You agree that you will not export or re-export
the Software or documentation in any form in violation of applicable United States and foreign law.
11. Government Restricted Rights. The Software is subject to restricted rights as follows. If the Softwareis acquired under the terms of a GSA contract: use, reproduction or disclosure is subject to therestrictions set forth in the applicable ADP Schedule contract. If the Software is acquired under theterms of a DoD or civilian agency contract, use, duplication or disclosure by the Government is subject
to the restrictions of this Agreement in accordance with 48 C.F.R. 12.212 of the Federal Acquisition
Regulations and its successors and 49 C.F.R. 227.7202-1 of the DoD FAR Supplement and its successors.
12. General. You acknowledge that you have read this Agreement, understand it, and that by using theSoftware 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. No additional or any different terms will be
enforceable against PMC-Sierra unless PMC-Sierra gives its express consent, including an express
waiver of the terms of 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 Agreement be declared unenforceable in any jurisdiction, then suchprovision shall be deemed severable from this Agreement and shall not affect the remainder hereof.
All rights in the Software not specifically granted in this Agreement are reserved by PMC-Sierra.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

9Adaptec RAID Controller Command Line Utility User's Guide

Should you have any questions concerning this license, contact:
PMC-Sierra, Inc.
Legal Department
1380 Bordeaux Drive
Sunnyvale, CA 94089(408) 239-8000

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

10Adaptec RAID Controller Command Line Utility User's Guide

1

Getting Started with the Command Line Utility
This chapter explains how your Adaptec by PMC® RAID controllers support the use of the ARCCONF
command line utility.
This 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
Provides access to the status and event logs of a controller
Isolate problems and determine their causes

Installing the Command Line Utility
You can install ARCCONF with the Adaptec maxView Storage Manager application. If you prefer to install
just the command line utility, without installing the maxView Storage Manager GUI, you can install justthe ARCCONF executable for your operating system.
Follow the instructions in this section to install ARCCONF on the supported operating systems with
maxView Storage Manager. (For more information about maxView Storage Manager, see the maxView
Storage Manager User's Guide.)
Note: On FreeBSD systems, you must use ARCCONF to perform storage managementtasks. FreeBSD does not support the maxView Storage Manager GUI. For more
information, see Downloading the Installation Packages on page 11 and Installing on
FreeBSD on page 13.

Downloading the Installation Packages
Complete these steps to download the installation package for your operating system(s) from the
Adaptec Web site:
1. Open a browser window, then type start.adaptec.com in the address bar.
2. Select your RAID controller family (Series 7, Series 8, and so on) and controller model.
3. Select Storage Manager Downloads, then select the appropriate installer package from the list; forinstance, maxView Storage Manager for Windows x64 or maxView Storage Manager for Linux.
Note: To install ARCCONF without the GUI, select Adaptec ARCCONF Command
Line Utility from the list of installers. This package includes the ARCCONF executable
for Windows, Linux, Solaris, and FreeBSD.
4. Click Download Now and accept the license agreement.
5. When the download completes, extract the contents of the installer archive file to a temporary
location. If the archive includes installers for multiple operating system versions (VMware, forinstance), each installer is stored in a separate folder, including one each for 32-bit and 64-bit
operating systems.
Note: If you are installing maxView Storage Manager and ARCCONF on a different
machine ̶ for instance, you downloaded the Linux installer onto a Windows machine̶ copy the installer from the download location to a temporary location on thetarget machine. Use whatever method you prefer to copy the file: USB flash drive;
network transfer; Telnet/SSH; whatever is most convenient.
6. Continue with the installation instructions for your operating system.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

11

Adaptec RAID Controller Command Line Utility User's Guide

Installing on Windows
To install ARCCONF on Windows systems:
1. Open Windows Explorer or My Computer, then change to the directory where the Windows setup
program is located (see Downloading the Installation Packages on page 11 for details).
2. Double-click the setup program for your operating system version:
Options
Description
Windows 64-bit

setup_asm_x64.exe

Windows 32-bit setup_asm_x86.exe
The Installation wizard opens.
3. Click Next to begin the installation, click I accept..., then click Next.
4. Add the following configuration settings:a) CIM Server Port: 5988.
b) Web Server Port: 8443.
c) User Name default: Administratord) Operating system password.
5. Click OK on the password verification window and on the CIM Server and Web Server port number
verification window.
6. In the Features window, select GUI, Agent, and CLI Tools. Then click Next.
7. Follow the on-screen instructions to complete the installation.

Installing on Red Hat, Cent OS, SuSE, or Fedora LinuxTo install ARCCONF on Red Hat, Cent OS, SuSE, or Fedora Linux:
1. In a shell window, change to the directory where the Linux installer package is located (seeDownloading the Installation Packages on page 11 for details).
2. Run the .bin file for your operating system version:
Options
Description
Linux 64-bit./StorMan-1.02.x86_64.binLinux 32-bit./StorMan-1.02.i386.bin

3. When prompted for configuration details, enter the following:Enter your username [default: root]
Enter your operating system password
Enter the CIM Server HTTP Port: [default:5988]
When the installation completes a confirmation message is displayed.

Installing on Debian or Ubuntu LinuxTo install ARCCONF on Debian or Ubuntu Linux:
1. In a shell window, change to the directory where the Debian or Ubuntu installer package is located(see Downloading the Installation Packages on page 11 for details).
2. Install the .deb package for your operating system version (where xxxxx=build number):
Options
Description
Linux 64-bit

dpkg -i StorMan-1.02-XXXXX_amd64.deb

Linux 32-bit

dpkg -i StorMan-1.02-XXXXX_i386.deb

3. Enter the following configuration details:
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

12Adaptec RAID Controller Command Line Utility User's Guide

Enter your username [default: root].
Enter your operating system password.
Enter the CIM Server HTTP Port: [default:5988].
When the installation completes a confirmation message is displayed.

Installing on Solaris
To install ARCCONF on Solaris:
1. On the Solaris machine, change to the directory where the Solaris installer package is located (seeDownloading the Installation Packages on page 11 for details).
2. Install maxView Storage Manager:
pkgadd -d StorMan.pkg

3. At the prompt to continue, select y, then press Enter.
4. Enter the following configuration details:
Enter your username [default: root].
Enter your operating system password.
Enter the CIM Server HTTP Port: [default:5988].
When the installation completes a confirmation message is displayed.

Installing on FreeBSD
To install ARCCONF on FreeBSD:
1. Copy the arcconf executable from the original download location to your FreeBSD system (seeDownloading the Installation Packages on page 11 for details).
2. Verify that the file has 'execute' privilege.

Installing on VMware
Use the following procedure to install the .vib files for VMware ESXi 5.5 or VMware ESXi 6.0. Performthe installation from a remote system running a Telnet/SSH client. Use a terminal emulator to accessthe ESXi server remotely.
1. Copy the following files from the installer download location to the /tmp directory on your local
ESXi server (see Downloading the Installation Packages on page 11 for details):• vmware-esx-provider-arcconf.vib• vmware-esx-provider-arcsmis.vib
The arcconf.vib is for command line communication.
The arcsmis.vib is for remote management communication.
2. Check for existing installation of arcconf.
esxcli software vib list | grep arcconf

3. Remove the existing arcconf package.
esxcli software vib remove -n arcconf

When the package is removed, you receive the message "Reboot Required: false."
4. Check for an existing installation of arc-cim-provider.
esxcli software vib list | grep arc-cim-provider

5. Remove the existing arc-cim-provider package.
esxcli software vib remove -n arc-cim-provider

When the package is removed, you receive the message "Reboot Required: true."
6. Set the installation acceptance level to either PartnerSupported or CommunitySupported:
esxcli software acceptance set –-level=PartnerSupported

7. Install the arcconf package.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

13

Adaptec RAID Controller Command Line Utility User's Guide

esxcli software vib install --no-sig-check -v/tmp/vmware-esx-provider-arcconf.vib

When the package is installed, you receive the message "Reboot Required: false."
8. Install the arc-cim-provider package.
esxcli software vib install --no-sig-check -v/tmp/vmware-esx-provider-arc-cim-provider.vib

When the package is installed, you receive the message "Reboot Required: true."
9. Reboot the system.
10. Continue the installation with Installing on a Guest Operating System on page 14.

Installing on Citrix XenServer
Use the following procedure to install the maxView Storage Manager support package on a Citrix
XenServer host. This package installs and configures all the components necessary to run maxView
Storage Manager and ARCCONF from a XenServer guest operating system.
Note: Before installing the maxView support package on the XenServer host, youmust install the XenServer Integration Suite Supplemental Pack. Do not continue until
you complete this task. See your XenServer installation guide for details.
1. Copy the XenServer module rpm from the installer download location to your XenServer /tmp
directory (see Downloading the Installation Packages on page 11 for details).
2. Install the rpm package for your operating system version (xxxxx=build number).
Options
Description
XenServer 32-bit

rpm -i StorMan-1.02-XXXXX_i386.rpm

3. Continue with Installing on a Guest Operating System on page 14.

Installing on a Guest Operating System
This section describes how to install ARCCONF on a VMware or Citrix XenServer guest operating system.

Installing on a Windows Guest OS
To install ARCCONF on a Windows Guest OS running on VMware or Citrix XenServer:
1. On the VMware or XenServer guest OS, change to the directory where the Guest OS installer package
is located (see Downloading the Installation Packages on page 11 for details).
2. Double-click the setup program for your operating system:
Options
Description
Windows GOS 64- setup_maxview_gos_x64.exe (VMware only)bit
Windows GOS 32- setup_maxview_gos_x86.exe
bit
The Installation wizard opens.
3. Choose the hypervisor type (ESXi Server or XenServer), then click Next.
4. Enter the following configuration details:a) Host IP Address (ESXi or XenServer host)b) Web Server Port: 8443c) Host user name (default: root)d) Operating system password/password confirmation
5. Click Next, then click Install.
When the installation is complete you receive a confirmation message.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

14

Adaptec RAID Controller Command Line Utility User's Guide

Installing on a Linux Guest OS
To install ARCCONF on a Linux Guest OS running on VMware or Citrix XenServer:
1. On the VMware or XenServer Guest OS, change to the directory where the Linux installer package
is located (see Downloading the Installation Packages on page 11 for details).
2. Run the installer for your operating system version.
Options
Description
Linux GOS 64-bit./Storman-1.06.GOS86_64.bin (VMware only)

Linux GOS 32-bit./Storman-1.06.GOS32.bin

3. At the prompt, choose the GOS type. Enter 1 for ESXi, 2 for XenServer:
Select the GOS Type. 1.ESXi Server 2.XenServer:

4. Enter the following configuration details:
Hypervisor IP address
Hypervisor username [default: root]
Hypervisor password
Event Listener Port [default: 65500]
When the installation is complete you receive a confirmation message.

Starting the Command Line Utility
1. To start ARCCONF, enter one of the following commands:
Options
Description
Windows<install_dir>\arcconf.exeLinux/usr/<install_dir>/arcconf

Solaris/usr/StorMan/arcconf

FreeBSD/<install_dir>/arcconf

VMware/usr/StorMan/arcconf

XenServer/usr/StorMan/arcconf

where Install_dir is the directory where the utility is installed.
2. To see a list of available commands, type ARCCONF at the prompt. For help with a specific command,
type ARCCONF <command_name> help.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

15

Adaptec RAID Controller Command Line Utility User's Guide

2

Using the Command Line Utility
This chapter explains how to use the command line utility interactively or in batch mode. With interactivemode, enter commands at the prompt. In batch mode, create scripts and run the script in the appropriate
shell, as described in the table below.
Table 1: ARCCONF Batch Environments
Environment

Batch File

Run Script

Windows.bat

CMD.EXELinux/Unix.shsh / bash

In either mode, if your command fails, you immediately see an error message of Command failed. Other
script messages that 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)
To view a list of commands at the command line, type ARCCONF and press Enter.
To access the online help for a specific command, type ARCCONF <command>, then press Enter.

ARCCONF Commands
The following commands are available in ARCCONF. The commands are described on the following
pages, in alphabetical order.
Table 2: ARCCONF Commands
atapassword
backupunit
consistencycheckcopybackcreatedeletedriverupdate
expanderlist
expanderupgrade
failovergetconfig
getlogs

getperformgetsmartstats
getstatus
getversion
identify
imageupdate
key
modifyphyerrorlog
playconfig
preservecache
rescanresetstatisticscounters
romupdatesaveconfig
savesupportarchive
setalarm
setbiosparams
setcachesetconfig
setconnectormodesetcontrollermodesetcustommodesetmaxcachesetnamesetncqsetperform
setphysetpower
setpriority
setstate
setstatsdatacollection
setvmcredential
task
uninitNote: In the command syntax descriptions, <> indicates a required parameter and []indicates an optional parameter.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

16

Adaptec RAID Controller Command Line Utility User's Guide

arcconf atapassword
Description
Sets or clears the Secure Erase password for SATA drives. See arcconf task for more information about
Secure Erase.
Syntax
ARCCONF ATAPASSWORD <Controller#> SET <new password> <Channel# ID#> ...
ARCCONF ATAPASSWORD <Controller#> CLEAR <current password> <Channel# ID#> ...

Parameters

new password | current password
Channel/ID lists the space-delimited channel number and device number (ID) pairs for each drive on
which to set or clear the password.

Channel/ID
Lists the space-delimited channel 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 backupunit
Description
Resets the hard error flag on the AFM-700 Flash Backup module, and erases lifetime calculation records.
A hard error disables the backup module permanently, across power cycles, until the hard error flag iscleared. The error flag is set when any of the following events occur:
•
•
•
•
•
•
•
•
•
•

Initialization failure
Backup failure due to an uncorrectable ECC error
Backup failure due to a lack of good blocks in the AFM Flash
Backup failure due to bad meta-data
Backup failure due to a hardware failure
Restore failure due to an uncorrectable ECC error
Restore failure due to a DMA timeout
Restore failure due to a hardware failure
AFM Flash erase failure of the meta-data
AFM Flash erase failure due to a hardware failure

Syntax
ARCCONF BACKUPUNIT <Controller#> reset

Parameters

Controller#
The controller number.
Examples
ARCCONF BACKUPUNIT 1 reset

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

17

Adaptec RAID Controller Command Line Utility User's Guide

arcconf consistencycheck
Description
Toggles the background consistency check modes of the controller.
Syntax
ARCCONF CONSISTENCYCHECK <Controller#> <on [Delay]|off|period <DAYS>> [noprompt]

Parameters

Controller#
Controller number.

On [Delay]
Turns background consistency check on, with optional 1-30 second delay period. The delay period
sets the controller idle time, after which the consistency check will start. A value of 0 disables theconsistency check (effectively, the same as setting the parameter to Off). If Delay is unspecified, theconsistency check mode is set to HIGH. If Delay is specified, the consistency check mode is set to IDLE,
for specified period.

Period <DAYS>
Sets the number of days to complete the background consistency check. The minimum value is 10
days (quick), the maximum is 365 days (slow). Setting the period automatically turns backgroundconsistency check on.

Noprompt
Optional parameter that suppresses the confirmation prompt.
Examples
ARCCONF CONSISTENCYCHECK 1 PERIOD 30
ARCCONF CONSISTENCYCHECK 1 ON 20
ARCCONF CONSISTENCYCHECK 1 OFF

arcconf copyback
Description
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#
The controller number
On enables the copyback feature
Off disables the copyback feature
Examples
ARCCONF COPYBACK 1 ON
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

18

Adaptec RAID Controller Command Line Utility User's Guide

arcconf create
Description
Creates a new logical drive, maxCache Device, or JBOD and, optionally, enables logical drive read caching,write caching, and maxCache SSD caching. You must provide the channel and device ID of the physicaldevices.
On redundant logical drives, ARCCONF performs autosynchronization.
ARCCONF presents JBODs as physical devices, not logical drives.
Syntax
ARCCONF CREATE <Controller#> <LOGICALDRIVE|MAXCACHE> [Options] <Size> <RAID#><CHANNEL# DRIVE#> [CHANNEL# DRIVE#] ... [noprompt] [nologs]
ARCCONF CREATE <Controller#> LOGICALDRIVE RVOLUME <LD#> <LD#> [LD#] ...
[noprompt] [nologs]
ARCCONF CREATE <Controller#> JBOD <CHANNEL# DRIVE#> [CHANNEL# DRIVE#] ...
[noprompt] [nologs]

Parameters

Controller#
The controller number.

Logical Drive, maxCache
Indicates a logical drive or maxCache Device, 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 aresupported. The default is 256KB.
• Legs <LEG>—Optional parameters for specifying number of legs. Value is an integer.
• LEG—Number of legs for RAID level 50 or 60.
• RAID 50—2-16 legs, 3-32 drives/leg, 128 drives max.
• RAID 60—2-16 legs, 4-16 drives/leg, 128 drives max.
• Name <NAME>—Optional parameter for specifying the alias name of a logical device that isdisplayed in the utilities. Value is a string of up to 16 characters.
• Priority <PRIORITY>—Initialization Priority for logical drive to be created. Valid options are: HIGH,
MED, or LOW.
• Method <METHOD>—Initialization method for the logical drive. Valid options include: BUILD,
CLEAR, QUICK, SKIP . Use SKIP for recovery only (to skip the initialization step).
• LDcache—Sets the cache state for the logical drive:• LON - cache on• LOFF - cache off• VerifyWithOS <True | False>—(Windows only) Wait for logical devices to be exposed to WindowsOS:• True - wait for the logical device to be exposed to the OS• False - do not wait for the logical device to be exposed to the OS• Rcache—Sets the logical drive read cache mode:• RON - read cache on• ROFF - read cache off• 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:• ION - maxCache on• IOFF - maxCache off• MaxCacheWriteCache—Sets the logical drive SSD write cache mode:• ION - maxCache on
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

19

Adaptec RAID Controller Command Line Utility User's Guide• IOFF - maxCache off• MaxCacheWritePolicy—Sets the maxCache write cache policy:• WB - write back enabled. maxCache will store the data on the SSD and write it back to thehard 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 below the threshold.
• WT - write through enabled. Similar to instant write back, but full-stripe writes go to boththe 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 information about write cache policy, see arcconf setmaxcacheon page 41.

Size
Indicates the size of the logical drive in megabytes. Use MAX to set size to available space. Use MAXMBR
to set the size to 2TB.

RAID#
Indicates the RAID level for the new logical drive: 0, 1, 1E, 10, 5, 5EE, 50, 6, 60, and volume aresupported. For maxCache, 0, 1, 1E, 5 and Simple_Volume are supported.

Channel# Drive#
Lists the space-delimited channel number and device number pairs for each device to add to the logicaldrive or maxCache Device. For maxCache, the devices must be SSDs.

RvolumeRAID level for a RAID volume logical drive.

LD#
Logical drive numbers for two or more logical drives to be concatenated into the RAID volume. RAID
levels 0, 1, and 5 are supported for RVOLUME members. All RVOLUME members must be the same
RAID level.

Noprompt
No prompt for confirmation
Examples
ARCCONF CREATE 1 LOGICALDRIVE STRIPESIZE 64 MAX 0 1 0 2 0 3 2 NOPROMPTARCCONF CREATE 1 JBOD 0 1 NOPROMPT

arcconf delete
Description
Deletes a logical drive, JBOD,or maxCache logical device. 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 <LD#> <LD#> ...|ALL[PRESERVEPARTITION] [noprompt] [nologs]
ARCCONF DELETE <Controller#> JBOD <CHANNEL# DRIVE#> [CHANNEL# DRIVE#] ...
[nologs]
ARCCONF DELETE <Controller#> JBOD ALL [noprompt]
ARCCONF DELETE <Controller#> MAXCACHE

Parameters

Controller#
Controller# is the controller number

LD#
LogicalDrive# is the number of the logical drive to be deleted.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

20

Adaptec RAID Controller Command Line Utility User's Guide

PRESERVEPARTITION
Deletes logical drives without partitions. Applicable ONLY for ALL or multiple LD#.

LogicalDrive|JBOD ALL
Deletes all logical drives or JBODs.

MAXCACHE
Deletes the maxCache Device.

Noprompt
Optional parameter that suppresses alert messages.
Examples
ARCCONF DELETE 1 LOGICALDRIVE 1 2 3
ARCCONF DELETE 1 LOGICALDRIVE 0 1 PRESERVEPARTITION
ARCCONF DELETE 1 JBOD ALL

arcconf driverupdate
Description
Updates the Windows device driver for the controller.
Note: This command is available on Windows systems only.
Syntax
ARCCONF DRIVERUPDATE <DirName> [nologs]

Parameters

DirNameAbsolute path to directory containing the Windows driver.

Nologs
Optional parameter that suppresses log output.
Examples
ARCCONF DRIVERUPDATE C:\WINDOWSALL

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

21

Adaptec RAID Controller Command Line Utility User's Guide

arcconf expanderlist
Description
Returns a list of disk drive expanders on a controller.
Syntax
ARCCONF EXPANDERLIST <Controller#>

Parameters

Controller#
Controller number.
Examples
ARCCONF EXPANDERLIST 1

arcconf expanderupgrade
Description
Allows new firmware to be flashed to an enclosure or expander.
Note: Some controllers do not support this operation.
Syntax:
ARCCONF EXPANDERUPGRADE <Controller#> ENCLOSURE <Channel# ID#> [ChunkSize#]<UpgradeType> <Filename> [Mode#] [noprompt]

Parameters

Controller#
Controller number.

Channel#Channel number of the device to be updated.

ID#
Device number of the device to be updated.

ChunkSize#
Chunk size, in bytes, to be used to update the firmware. Default is 65536 bytes.

Filename
Name of the firmware update file.

UpgradeType
EXPANDER—update the firmware image on the expander or enclosure
MFG—update the manufacturing image (BOOT SEEPROM) on the expander or enclosure
CPLD—update the CPLD image on the expander or enclosure

Mode#
The Mode parameter applies to EXPANDER and MFG upgrade types only. Valid values are:
• 2—download microcode only; requires system reset or power cycle to activate (default )• 6—download microcode with offsets and activate• 7—download microcode with offsets, save, and activate
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

22

Adaptec RAID Controller Command Line Utility User's Guide

Noprompt
Optional parameter that suppresses alert messages.
Examplesarcconf EXPANDERUPGRADE 1 ENCLOSURE 2 0 1024 EXPANDER C:\FirmwareImage.bin 7
arcconf EXPANDERUPGRADE 1 ENCLOSURE 2 0 512 MFG C:\FirmwareImage.rom 6
arcconf EXPANDERUPGRADE 1 ENCLOSURE 2 0 256 CPLD C:\CPLDImage.bin noprompt

arcconf failover
Description
Turns automatic failover on and off.
Syntax
ARCCONF FAILOVER <Controller#> <on|off>

Parameters

Controller#
The controller number.

On
Turns the controller failover mode on.

Off
Turns the controller failover mode off.
Examples
ARCCONF FAILOVER 1 ON

arcconf getconfig
Description
Lists information about controllers, logical devices, physical drives, and flash backup systems, including:
•
•
•
•
•
•
•
•
•

Controller type, status, and mode
Cache preservation status: enabled/disabled, % of cache pages preserved
BIOS, boot block, device driver, and firmware versions
Logical drive status, RAID level and size
maxCache status, fetch and flush rate policy, read/write balance, SSD information
Device type, device ID, presence of PFA
Physical device state
Enclosure information: fan, power supply, and temperature status
Flash backup information (for AFM-700 flash backup module): status, charge level, temperature
readings, max voltage, current, estimated life, errors, and serial number
Also displays controller BIOS settings if you do not include a device-type keyword (see examples).
Syntax
ARCCONF GETCONFIG <Controller#> [AD|LD [LD#]|PD|MC|AL]

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

23

Adaptec RAID Controller Command Line Utility User's Guide

Parameters

Controller#
Controller number

LD#
Display information about the specified logical device

AD/LD/PD/AL...
•
•
•
•
•

AD—Adapter information only
LD—Logical drive information only
PD—Physical device information only
MC—maxCache information only
AL—All information

Examples
ARCCONF GETCONFIG 1-------------------------------------------------------Controller BIOS Setting Information-------------------------------------------------------Runtime BIOS
: Enabled
Array BBS Support: Enabled
Physical Drives Displayed during POST
: Disabled
Backplane Mode
: SGPIO
MissingDrvCount:8...
ARCCONF GETCONFIG 1 LD 0

arcconf getlogs
Description
Provides access to controller status, event logs, and usage statistics, including:• A log of device errors that the controller encountered• A log that records any occurrences of defunct devices• A log of special events that may have occurred (rebuilds, LDMs, etc.)• A log of controller usage statistics, including Inter-IO Read and Write times and IO Completion Read
and Write times• A log of cache statistics for one or all logical drives
Syntax
ARCCONF GETLOGS <Controller#> <Type1> [clear|tabular] [nologs]
ARCCONF GETLOGS <Controller#> <Type2> [tabular] [nologs]
ARCCONF GETLOGS <Controller#> <Type3> LOGICALDRIVE [<LD#>|ALL] [tabular][nologs]
ARCCONF GETLOGS <Controller#> DEVICE <clear> <ErrorType#> [<Channel# ID#>|ALL][nologs]

Parameters

Controller#
Controller number.

Type1
One of the following:• DEVICE—device error log• DEAD—dead (failed) drive log• EVENT—controller event log

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

24

Adaptec RAID Controller Command Line Utility User's Guide

Type2
One of the following:• STATS—controller statistics data

Type3
One of the following:• CACHE—cache statistics data for all or a single logical drive

ErrorTypeOne of the following:
•
•
•
•
•
•

1 - Parity Error Counter
2 - Link Failure Counter3 - Hardware Error Counter
4 - Aborted Commands Counter5 - Medium Error Counter
6 - SMART Warning Counter

Clear
Clears the specified log from the controller or a specific error counter for one or all physical drives on
a controller.

Channel/ID
Channel and number of the physical device on the controller.

Tabular
Displays the log or statistics in tabular format.
Examples
ARCCONF GETLOGS 1 EVENT
ARCCONF GETLOGS 1 STATS tabular
ARCCONF GETLOGS 1 DEVICE clear 3 ALL
ARCCONF GETLOGS 1 CACHE LOGICALDRIVE 0

arcconf getperform
Description
Fetches the parameters that define a logical drive performance mode. Default is the current mode.
Syntax
ARCCONF GETPERFORM <Controller#> [Performance Mode] [Save [Filename]] [Nologs]

Parameters

Controller#
Controller number.

Performance Mode
One of the following:••••

1 - Default/Dynamic mode2 - OLTP/Database
3 - Big Block Bypass mode
4 - User defined mode

Save
Saves the performance mode parameters in a file.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

25

Adaptec RAID Controller Command Line Utility User's Guide

Filename
Name of the file in which to save the parameters. If not specified, the default filename is
PerformanceMode.cfg.

NologsSuppresses creation of logs for this command.
Examples
ARCCONF GETPERFORM 1 2

arcconf getsmartstats
Description
Displays SMART statistics for the hard drives and Solid State Drives (SSDs) on a controller.
Note: For more information about SMART statistics, see the maxView Storage Manager
User's Guide.
Syntax
ARCCONF GETSMARTSTATS <Controller#> [Tabular]

Parameters

Controller#
Controller number.

TabularCreates output in tabular format.
Examples
ARCCONF GETSMARTSTATS 1
ARCCONF GETSMARTSTATS 1 TABULAR

arcconf getstatus
Description
The GETSTATUS function displays the status of any background command that is currently running,
including information about the most recent rebuild, synchronization, logical-drive migration, andcompaction/expansion. The information includes the type of operation, status, logical drive number,logical drive size, and percentage of the operation completed.
Note:
1. GETSTATUS reports currently active operations for ARCCONF commands andcommands issued from maxView Storage Manager.
2. GETSTATUS reports verify, clear, initialize, and secure erase operations on physicaldevices.
3. GETSTATUS reports the status of controller rescan operations.
4. GETSTATUS only reports active operations. It does not display information if theoperation is completed.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

26

Adaptec RAID Controller Command Line Utility User's Guide

Syntax
ARCCONF GETSTATUS <Controller#> [nologs]

Parameters

Controller#
Controller# is the controller number
Examples
ARCCONF GETSTATUS 1

arcconf getversion
Description
Lists version information for all controllers or a specific controller's software components, including
information about the BIOS, driver, firmware currently running, and firmware that will run after a reboot.
Note: The firmware version that will run after a reboot is called the “staged” firmware.
Syntax
ARCCONF GETVERSIONARCCONF GETVERSION <Controller#>

Parameters

Controller#
Controller# is the controller number
Examples
ARCCONF GETVERSIONARCCONF GETVERSION 1

arcconf identify
Description
Identifies a physical device, logical device, or maxCache device by blinking its LEDs.
Syntax
ARCCONF IDENTIFY <Controller#> LOGICALDRIVE <LogicalDrive#> [START|STOP][nologs]
ARCCONF IDENTIFY <Controller#> DEVICE <Channel# ID#> ... [START|STOP] [nologs]
ARCCONF IDENTIFY <Controller#> MAXCACHE [START|STOP] [nologs]

Parameters

Controller#
Controller number

LogicalDrive#
Number of the logical drive to be identified
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

27

Adaptec RAID Controller Command Line Utility User's Guide

Channel# ID#
Channel number and ID number for the physical device(s) to be identified

START
Starts blinking the device until the STOP command is issued

STOP
Stops blinking the device
Examples
ARCCONF IDENTIFY 1 DEVICE 0 0
ARCCONF IDENTIFY 1 DEVICE 0 1 START
ARCCONF IDENTIFY 1 DEVICE 0 1 STOP
ARCCONF IDENTIFY 1 MAXCACHE START

arcconf imageupdate
Description
Allows new firmware to be flashed to the hard drive.
Syntax:
ARCCONF IMAGEUPDATE <Controller#> DEVICE <Channel# ID# ChunkSize# Filename>[Mode#] [noprompt]

Parameters

Controller#
Controller number.

Channel#Channel number of the device to be updated.

ID#
Device number of the device to be updated.

ChunkSize#
Chunk size, in bytes, to be used to update the firmware.
Note: For SATA drives, the chunk size must be a multiple of 512.

Filename
Name of the firmware update file.

Mode#
Firmware update mode. Valid values for physical drives are:• 3-(SATA) Download with offsets and save image for immediate and future use• 7-(SAS) Download microcode with offsets, save, and activate

Noprompt
Optional parameter that suppresses alert messages.
Examples
ARCCONF IMAGEUPDATE 1 DEVICE 0 0 16384 ados.lod 3

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

28

Adaptec RAID Controller Command Line Utility User's Guide

arcconf key
Description
Loads a feature key onto an Adaptec controller.
Syntax
ARCCONF KEY <Controller#> SET <Key#>

Parameters

Controller#
The controller number.

Key#The key number provided by PMC.
Examples
ARCCONF KEY 1 SET ABCD EFGH IJKL MNOP QRST UVWX

arcconf modify
Description
Morphs a logical device from one raid level to another (RAID Level Migration). Expands a logical device
from original size to one with larger capacity (Online Capacity Expansion).
Syntax
ARCCONF MODIFY <Controller#> FROM <LogicalDrive#>
TO [Options] <Size> <RAID#> <CHANNEL# ID#> [CHANNEL# ID#] ... [noprompt]

Parameters

Controller#
The controller number

LogicalDrive#
The logical drive number to be modified

Options
One of the following:• Stripesize <size>—indicates the stripe size in KB. Options are 16, 32, 64, 128, 256, 512, and 1024.
the default is 256KB.
• Init_priority <priority>—is the priority level of the modification. Options are low, med, and high.
• Legs <leg>— is the number of sub-arrays for a RAID level-50 or RAID level 60 array. Possible values
are 2-16 legs and 3-16 drives/leg (to 48 drives maximum).

Size• Size in MB.
• MAX indicates that you want to use all available space on the disk.

RAID#
RAID level for the logical drive: 0, 1, 10, 5, 6, 50, 60, and simple_volume.

Channel# ID#
Channel number and device ID for the device

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

29

Adaptec RAID Controller Command Line Utility User's Guide

Note: The CHANNEL# and ID# parameters are the list of devices that will containthe target modification object. Channel and ID are repeatable parameters. For RAID
1 to Simple Volume migration, CHANNEL# and ID# parameters are ignored.

noprompt
Suppresses the user prompt
Examples
ARCCONF MODIFY 1 FROM 2 TO 2048 0 0 123 0 124 0 117

arcconf phyerrorlog
Description
Displays PHY error logs for physical devices on a controller or expander PHYs.
Syntax
ARCCONF PHYERRORLOG <Controller#> DEVICE <Channel# ID#>
ARCCONF PHYERRORLOG <Controller#> DEVICE ALL
ARCCONF PHYERRORLOG <Controller#> EXPANDER <ExpanderID#> <PHY#>
ARCCONF PHYERRORLOG <Controller#> EXPANDER <ExpanderID#> ALL

Parameters

Controller#
Controller number.

Channel/ID
Channel and number of the physical device on the controller.

ExpanderID#
Expander identifier.

PHY#
PHY identifier.

ALL
Displays PHY error log for all physical devices or expander PHYs.
Examples
ARCCONF PHYERRORLOG 1 DEVICE 0 0
ARCCONF PHYERRORLOG 1 DEVICE ALL
ARCCONF PHYERRORLOG 1 EXPANDER 1 ALL

arcconf playconfig
Description
Note: This command is supported on Windows systems only.
Configures a controller using a XML server template file produced by the SAVECONFIG command (seearcconf saveconfig on page 34). Use this command to deploy the same controller configuration on
multiple servers in your storage space.
Note:
1. The XML server template file (default, saveconfig.xml) is editable. For example,
you may need to change the disk drive capacity, logical drive size, or RAID level.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

30

Adaptec RAID Controller Command Line Utility User's Guide

2. Drives from the same vendor with slightly different capacities (147GB vs 150GB,
for instance) are considered interchangeable. If the interchange results in a change
in logical drive capacity, the drive is scaled, as needed. For example, if the newdrives have 4% more capacity due to vendor or model changes, then all logicaldrives are increased in size by 4%.
3. Be sure to check the log file to verify that the controller was configured successfully.
The exit codes, shown below, indicate the success or failure of the operation andif the system needs to be rebooted.
Code

Value

Meaning

SUCCESS0

Configuration succeeded, no reboot is required.

FAILURE_GENERAL

1

An error occurred and the configuration
could not be completed.

SUCCESS_REBOOT

2

Configuration succeeded, but a reboot is required.

Syntax
ARCCONF PLAYCONFIG <Input XML File> [LogFile] [FORCE ALL|LOGICALSIZE] [SLOTID]

Parameters

Input XML File
The pathname of the server template file. The default server template file is available at
C:\PMCS\Logs\saveconfig.xml.

LogFileSets the pathname of the error log file. By default, the error log is available at
C:\PMCS\Logs\playconfig.log.

FORCE
Forces deployment of the server even if the controller does not support all features, or the drive
capacity does not match the configuration in the input XML file. Use FORCE ALL to force deploymentof all features; use FORCE LOGICALSIZE to force deployment of just the logical drives.

SLOTID
Apply the configuration based on Slot ID instead of Device ID.
Examples
ARCCONF PLAYCONFIG server1_config.xml playconfig.log FORCE ALL

arcconf preservecache
Description
Toggles the controller's cache preservation policy; clears the preserved cache for one or more logicaldrives; and lists the logical drives with cache preservation enabled.
This command preserves the controller's DDR cache to prevent data loss in the event of a power failure
or unsafe shutdown. "Dirty pages" (data that have not been committed to disk) are restored to thecache when power is restored and the logical drives on the controller are back online. Once the preserved
cache is restored, the controller flushes the data to disk using its normal scheduling mechanism. You
can clear the preserved dirty cache for one or more logical drives if you expect a failed enclosure or
logical drive to remain offline.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

31

Adaptec RAID Controller Command Line Utility User's Guide

Note: You cannot enable maxCache read and/or write caching on a controller withcache preservation enabled. The following operations are not permitted on a controller
in the Cache Preserved state:• Creating a logical drive• Changing the Performance mode
• Running a consistency check• Changing the RAID Level of a logical drive• Forcing a logical drive online or offline• Changing the cache page size
Syntax
ARCCONF PRESERVECACHE <Controller#> <ENABLE|DISABLE>
ARCCONF PRESERVECACHE <Controller#> CLEAR LOGICALDRIVE <LD#|ALL> [noprompt]
ARCCONF PRESERVECACHE LD [LD#]Parameters

Controller#
Controller number.

LD#
The logical drive number. Use ALL to clear preserved dirty cache for all logical drives on the controller.

noprompt
No prompt for confirmation.
Examples
ARCCONF PRESERVECACHE 1 ENABLE
ARCCONF PRESERVECACHE 1 CLEAR LOGICALDRIVE ALL
ARCCONF PRESERVECACHE 1 LD 1

arcconf rescan
Description
Enables the controller to check for the removal of any disk drives in the ready state and to check forthe connection of any new disk drives to the controller. Controller rescan runs in the background,asynchronously. When rescan is started, a message is displayed stating that the process is running in
the background and may take 10 minutes to complete. Another message is displayed if a rescan is started
while one is already in progress. Rescan status can be obtained with ARCCONF getstatus; see arcconf
getstatus on page 26 for more information.
Syntax
ARCCONF RESCAN <Controller#> [nologs]
ARCCONF RESCAN ALL [nologs]

Parameters

Controller#
The controller number

ALL
Rescans all controllers in the system
Examples
ARCCONF RESCAN 1
ARCCONF RESCAN ALL
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

32

Adaptec RAID Controller Command Line Utility User's Guide

arcconf resetstatisticscounters
Description
Resets statistics counters for a controller. Use this command to clear the counters and create fresh
statistics.
Syntax
ARCCONF RESETSTATISTICSCOUNTERS <Controller#>

Parameters

Controller#
The controller number
Examples
ARCCONF RESETSTATISTICSCOUNTERS 1

arcconf romupdate
Description
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 command is supported in Windows and Linux
only.
Syntax
ARCCONF ROMUPDATE <Controller#|ALL> <BaseName> [Newversion <build#> [Force]][noprompt]

Parameters

Controller# | ALL
The controller number. Use ALL to apply the update to all controllers of the same type.

BaseName
For a single update file, the path to the controller ROM image. If you have a set of controller ROM
images, fully qualified name of the ROM image file basename.
Note: All update files must be in the same directory prior to starting ARCCONF.

Newversion <build#>
Specifies the version of the firmware build.

Force
An optional parameter used to force a down-level firmware update.

Noprompt
An optional parameter that suppresses the confirmation prompt.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

33

Adaptec RAID Controller Command Line Utility User's Guide

Examples
ARCCONF ROMUPDATE 1 AC2200
ARCCONF ROMUPDATE 1 AC220001.UFI
ARCCONF ROMUPDATE 1 AS483C newversion 12345 force noprompt

arcconf saveconfig
Description
Note: This command is supported on Windows systems only.
Saves the controller configuration to a XML server template file, including the controller type, operationalsettings, physical drive size, logical drive size, RAID level, and more. Use this file with the PLAYCONFIG
command to deploy the same controller configuration to other servers in your storage space; see arcconf
playconfig on page 30 for more information.
Note: Be sure to check the log file to verify that the configuration XML file was createdsuccessfully. The exit codes, shown below, indicate the success or failure of theoperation.
Code

Value

Meaning

SUCCESS0

Configuration XML generated successfully.

FAILURE_GENERAL

1

An error occurred and the configuration XML
could not be generated.

Syntax
ARCCONF SAVECONFIG [Input XML File] [LogFile]

Parameters

Input XML File
The pathname of the server template file. The default name (if you omit this parameter) is
C:\PMCS\Logs\saveconfig.xml.

LogFileThe pathname of the error log file. By default, the error log is available at C:\PMCS\Logs\saveconfig.log.
Examples
ARCCONF SAVECONFIG server1_config.xml C:\LOGS\SERVER1.LOG

arcconf savesupportarchive
Description
Saves configuration and status information to help Adaptec Customer Support diagnose a problem withyour system. Saved information includes (but is not limited to) device logs, drive logs, event logs, error
logs, controller logs, history logs, and SSD SMART statistics. (For more information about SMART statistics,
see arcconf getsmartstats on page 26.)
By default, the log files are saved in the Support folder in the standard logs directory for your operating
system (/var/log for Linux, the maxView Storage Manager install directory on Windows, and so on).

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

34

Adaptec RAID Controller Command Line Utility User's Guide

Note: Unlike the Save Support Archive feature in maxView Storage Manager, thiscommand does not create a zip (“archive”) file. It simply saves the support files andlogs in the Support folder.
Syntax
ARCCONF SAVESUPPORTARCHIVE [Path] [Firmware|GUI|CIM|Arcconf|Storlib|Agent]Parameters

Path
Path to store the log files.

Log type:
One of these log files:• Firmware: saves Firmware logs
• GUI: saves GUI logs
• CIM: saves CIM logs
• Arcconf: saves Arcconf logs
• Storlib: saves StorLib logs
• Agent: saves Agent logs
Examples
ARCCONF SAVESUPPORTARCHIVE
ARCCONF SAVESUPPORTARCHIVE Firmware
ARCCONF SAVESUPPORTARCHIVE /var/log/maxView Storlib

arcconf setalarm
Description
Sets the state of the controller audible alarm, if present.
Syntax
ARCCONF SETALARM <Controller#> <on|off|silence|test>

Parameters

Controller#
The controller number

On
Enables the alarm

Off
Disables the alarm

Silence
Quiets the currently sounding alarm

Test
Triggers the alarm
Examples
ARCCONF SETALARM 1 TEST
ARCCONF SETALARM 1 SILENCE

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

35

Adaptec RAID Controller Command Line Utility User's Guide

arcconf setbiosparams
Description
Changes select BIOS settings, including:• Array BBS support (BIOS Boot Specification)• Runtime BIOS mode
• Drives displayed on POST
• Backplane mode
• Missing drive count
The command sub-functions are mutually exclusive; you can set only one option at a time.
Syntax
ARCCONF SETBIOSPARAMS <Controller#> RUNTIMEBIOS [enable | disable]
ARCCONF SETBIOSPARAMS <Controller#> ARRAYBBSSUPPORT [enable | disable]
ARCCONF SETBIOSPARAMS <Controller#> DISPLAYEDONPOST [enable | disable]
ARCCONF SETBIOSPARAMS <Controller#> BACKPLANEMODE <mode>
ARCCONF SETBIOSPARAMS <Controller#> BIOSHALTONMISSINGDRIVECOUNT <count>

Parameters

Controller#
Controller number

Subfunction
OptionDescription

RUNTIMEBIOS [enable|dis- When enabled, allows the controller to act as a bootable device. When disabled,able]
allows another controller to act as a bootable device. Default is enable.
ARRAYBBSSUPPORT [enable|disable]

When enabled in systems that support BBS, the controller presents attachedbootable devices up to the BIOS for boot device selection. Default is disable.

DISPLAYEDONPOST [enable|disable]

When enabled, connected disk drives are displayed during system Power On Self
Test (POST). Displaying the disk drives adds a few seconds to the overall POST time.
Default is disable.

BACKPLANEMODE <mode> Sets the backplane mode to 0-IBPI, 1-SGPIO, or 3-Disabled. Default is IBPI.
BIOSHALTONMISSINGDRIVE- The number of missing drives during POST. If => "count", halt. Count can have a
COUNT <count>value between 1-255; default is 8.

Examples
ARCCONF SETBIOSPARAMS 1 RUNTIMEBIOS disable
ARCCONF SETBIOSPARAMS 1 BACKPLANEMODE 1
ARCCONF SETBIOSPARAMS 1 BIOSHALTONMISSINGDRIVECOUNT 5
ARCCONF SETBIOSPARAMS 1 ARRAYBBSSUPPORT enablearcconf setcache
Description
Changes the cache mode for a logical drive, or the write cache mode for all drives or a single physicaldrive on a controller.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

36

Adaptec RAID Controller Command Line Utility User's Guide

Syntax
ARCCONF SETCACHE <Controller#> LOGICALDRIVE <LogicalDrive#> <logical mode>[noprompt] [nologs]
ARCCONF SETCACHE <Controller#> DEVICE <Channel> <ID> <physical mode> [nologs]
ARCCONF SETCACHE <Controller#> DEVICEALL <policy> [noprompt] [nologs]

Parameters

Controller#
The controller number

LogicalDrive#
The number of the logical drive whose cache will be altered

Logical mode
Logical drive cache mode:
•
•
•
•
•

RON - read cache on
ROFF - read cache off
WT - write through disabled
WB - write back enabled
WBB - write back enabled (when protected by battery or flash backup module)

Channel/ID
Lists the space-delimited channel number and device number pairs for each device.

Physical mode
• WT - write through disabled• WB - write back enabled

Policy• Enable - write through for all physical drives• Disable - write back for all physical drives• drivespecific - set policy for individual physical drives
Examples
ARCCONF SETCACHE 1 LOGICALDRIVE 1 RONARCCONF SETCACHE 1 DEVICE 0 0 WB
ARCCONF SETCACHE 1 DEVICEALL Enablearcconf setconfig
Description
Resets the controller configuration. Logical drives are deleted, hard disks are reset to the READY state,cache contents are lost, and controller settings are reset to default values.
Syntax
ARCCONF SETCONFIG <Controller#> DEFAULT [noprompt]

Parameters

Controller#
The controller number

Default
Restores the controller's default configuration.

Noprompt
No prompt for confirmation.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

37

Adaptec RAID Controller Command Line Utility User's Guide

Examples
ARCCONF SETCONFIG 1 DEFAULT

arcconf setconnectormode
Description
Sets the connector operating mode to one of the following:• RAID: Expose RAW (default)—All RAID functions of the controller are enabled. Attached drives
without Adaptec meta-data are surfaced to the host operating system as RAW Pass Through devices(similar to JBODs on legacy Adaptec controllers).
• HBA Mode—Allows the controller to act and be used as a Host Bus Adapter. RAID functions of thecontroller are disabled. All attached drives are surfaced as RAW devices.
Note:
1. Changing into HBA mode is allowed only if there are no drives with Adaptec
meta-data attached to the controller. Uninitialize the drives before changing
to HBA mode (see arcconf uninit on page 49). Uninitialized drives are also
compatible with any HBA and can be exchanged with drives on themotherboard's SATA interface.
2. Before you can change to HBA mode, you must delete existing hot spare drives(if any).
3. In HBA mode, a hot-plugged drive is automatically configured as a RAW device.
When a RAW device is pulled from the system, the controller does not delete
the internal data structures associated with the drive. However, the missing
RAW device is not remembered across re-scans.
Note: Use arcconf setcontrollermode to change the operating mode of all portson the controller.
Syntax:
ARCCONF SETCONNECTORMODE <Controller#> <Connector #> <Functional Mode#><Connector#> <Functional Mode#> ... [noprompt] [nologs]

Parameters

Controller#
Controller number.

Connector#
Connector number.

Functional Mode#
One of the following values:• 0 - RAID: Expose RAW• 1 - HBA Mode

nologsSuppresses log output for the command.
Examples
ARCCONF SETCONNECTORMODE 1 1 1
ARCCONF SETCONNECTORMODE 1 1 0

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

38

Adaptec RAID Controller Command Line Utility User's Guide

arcconf setcontrollermode
Description
Sets the controller operating mode to any of the following:• RAID: Expose RAW (default)—All RAID functions of the controller are enabled. Attached drives
without Adaptec meta-data are surfaced to the host operating system as RAW Pass Through devices(similar to JBODs on legacy Adaptec controllers).
• Auto Volume Mode—Attached drives without Adaptec meta-data, but with an OS partition, aresurfaced to the host operating system as RAW devices, where the RAID layer of the controller
firmware is bypassed when the host issues commands to the device. Attached drives without
Adaptec meta-data and without OS partitions, are automatically configured as Simple Volumes(single drives with Adaptec meta-data), with these settings:• Controller read caching is set to “Enabled” for rotating media.
• Controller write caching is set to “Enabled (write-back) when protected by battery/ZMM” forrotating media.
• Caching for non-rotating media is disabled.
In Auto Volume Mode, you can create up to a maximum of 128 Simple Volumes; no other RAID
types are supported.
Note: Before you can change to Auto Volume mode, you must delete redundant
RAID arrays, maxCache Devices, and hot spare drives (if any).
Auto-Volume Mode enables DRAM caching on rotating media to help reduce latency and accelerate
performance, especially if combined with a custom performance mode, such as Big Block Bypass(see arcconf setperform on page 43 for more information).
• HBA Mode—The intent of this mode is to allow the RAID controller to act and be used as a Host
Bus Adapter. All attached drives are surfaced as RAW devices. Changing into HBA mode is allowed
only if there are no drives with Adaptec meta-data attached to the controller. Uninitialize the drives
before changing to HBA mode (see arcconf uninit on page 49). Uninitialized drives are also
compatible with any HBA and can be exchanged with drives on the motherboard's SATA interface.
Note:
1. Before you can change to HBA mode, you must delete existing hot spare drives(if any).
2. In HBA mode, a hot-plugged drive is automatically configured as a RAW device.
When a RAW device is pulled from the system, the controller does not deleteinternal data structures associated with the drive. However, the missing RAW
device is not remembered across rescans.
• RAID: Hide RAW—All RAID functions of the controller are enabled, but RAW devices are not exposedto the operating system.
• Simple Volume Mode—Allows you to create Simple Volumes only, up to a maximum of 128 volumes;
no other RAID types are supported.
Note: Before you can change to Simple Volume mode, you must delete existing
RAID arrays, maxCache Devices, and hot spare drives (if any).
Syntax:
ARCCONF SETCONTROLLERMODE <Controller#> <Controller Mode> [nologs]

Parameters

Controller#
Controller number.

Controller Mode
One of the following values:• 0 - RAID: Expose RAW• 1 - Auto Volume Mode
• 2 - HBA Mode
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

39

Adaptec RAID Controller Command Line Utility User's Guide• 3 - RAID: Hide RAW• 4 - Simple Volume Mode

nologsSuppresses log output for the command.
Examples
ARCCONF SETCONTROLLERMODE 1 2
ARCCONF SETCONTROLLERMODE 1 0
ARCCONF SETCONTROLLERMODE 1 4

arcconf setcustommode
Description
Sets the parameters for a user-defined performance mode. Contact Adaptec Support for more information
about using this command to set up a custom performance mode. See also arcconf setperform on page
43.
Syntax
ARCCONF SETCUSTOMMODE <Controller#> ENABLE <Flag1> [Flag2 ... ] [DISABLE Flag1
Flag2 ...] [PARAMS <Field1 Value1> [Field2 Value2] ..] [nologs]
ARCCONF SETCUSTOMMODE <Controller#> DISABLE <Flag1> [Flag2 ... ] [nologs]
ARCCONF SETCUSTOMMODE <Controller#> PARAMS <Field1 Value1> [Field2 Value2] ..
[nologs]
ARCCONF SETCUSTOMMODE <Controller#> FILE [File name] [nologs]

Parameters

Controller#
Controller number

ENABLE <Flag>, DISABLE <Flag>
A list of flags to enable or disable:• REPPREFET (CACHE_REPRESSPREFETCHING)• IOSORT (CACHE_IO_SORTING)• INSLRU (CACHE_INSERT_LRU)• DYNSHARE (CACHE_DYNAMIC_SHARING)• RLOADBYPASS (CACHE_READ_LOAD_BYPASS_VALID)• WLOADBYPASS (CACHE_WRITE_LOAD_BYPASS_VALID)• WRITEBYPASS (CACHE_LARGE_WRITE_BYPASS)• IOCOAL (IO_COALESCING)

PARAMS
A list of field/value pairs:• MAXDIRTY (CACHE_MAX_DIRTY)• DMDFLUSHTHR (CACHE_DEMAND_FLUSH_THRESHOLD)• PAGESIZE (CACHE_PAGE_SIZE)• RFINACTIVE (CACHE_RESERVED_FOR_INACTIVE)• ADDWRITES (CACHE_ADDITIONAL_WRITES)• MINFLUSHSTRIPE (CACHE_MIN_FLUSH_STRIPE)• BYPASSWRIOSIZE (CACHE_BYPASS_WRITE_IO_SIZE)• IOLIMSASHDD (IO_LIMIT_SAS_HDD)• IOLIMSASSSD (IO_LIMIT_SAS_SSD)• IOLIMSATAHDD (IO_LIMIT_SATA_HDD)• IOLIMSATASSD (IO_LIMIT_SATA_SSD)

FILE <File name>Path to parameter definition file. The default parameter file is PerformanceMde.cfg.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

40

Adaptec RAID Controller Command Line Utility User's Guide

Examples
ARCCONF SETCUSTOMMODE 1 ENABLE IOSORT DISABLE INSLRU
ARCCONF SETCUSTOMMODE 1 DISABLE REPPREFET
ARCCONF SETCUSTOMMODE 1 PARAMS PAGESIZE 3
ARCCONF SETCUSTOMMODE 1 FILE C:\Adaptec

arcconf setmaxcache
Description
Enables/disables maxCache SSD caching for one or more logical drives; updates the maxCache write
cache policy and “dirty page” threshold (data not committed to disk); adds Solid State 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: Before you can enable maxCache SSD caching, you must assign at least one
SSD to the maxCache pool.
Syntax: Read Caching
ARCCONF SETMAXCACHE <Controller#> LOGICALDRIVE <LogicalDrive#> READCACHE<ENABLE|DISABLE>

Syntax: Write Caching
ARCCONF SETMAXCACHE <Controller#> LOGICALDRIVE <LogicalDrive#> WRITECACHE<ENABLE|DISABLE> [WRITEPOLICY <policy>]
ARCCONF SETMAXCACHE <Controller#> LOGICALDRIVE ALL WRITECACHE DISABLE[WRITEPOLICY <policy>]
ARCCONF SETMAXCACHE <Controller#> LOGICALDRIVE <LogicalDrive#> WRITEPOLICY<policy>
ARCCONF SETMAXCACHE <Controller#> DIRTYPAGETHRESHOLD <dirtyPageThreshold#>
ARCCONF SETMAXCACHE <Controller#> WBCVALID <ENABLE|DISABLE>

General Usage
ARCCONF SETMAXCACHE <Controller#> <ADDTOPOOL|REMOVEFROMPOOL> <Channel# Device#>
ARCCONF SETMAXCACHE <Controller#> RWBALANCE <Read#> <Write#>
ARCCONF SETMAXCACHE <Controller#> FLUSHANDFETCHRATE <FlushAndFetchRate#>
ARCCONF SETMAXCACHE <Controller#> CLEAR

Parameters

Controller#
The controller number.

LogicalDrive#
The number of the logical drive. You can specify one or more logical drives.

Channel#The channel number for the SSD.

Device#The device number for the SSD.

Read#/Write#
The read/write ratio for invalidating data on the SSD. When the ratio is reached, the page is removed
from the cache. Values range from 1-10 for each parameter.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

41

Adaptec RAID Controller Command Line Utility User's Guide

FlushAndFetchRate#
The read cache fetch rate from 1 to 1000: 1-50=Low, 51-100=Medium, 101-1000=High. The default is
100.
Note: The lower the rate the longer the page is kept on the SSD before it is flushedfrom the cache.

dirtyPageThreshold#Controls the amount cache space allocated to “dirty” data; that is, data that has not been committed
to disk. The threshold value ranges from 1-100 (percent). Once the percentage of dirty pages crosses
the threshold, the data are flushed to disk.

WBCVALID ENABLE|DISABLE
Enables and disables write caching in non-redundant maxCache. Applies to all logical drives.

PolicymaxCache write cache policy:• WB - write back enabled. maxCache will store the data on the SSD and write it back to the harddisks 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 below the threshold.
• WT - write through enabled. Similar to instant write back, but full-stripe writes go to both thecache and hard disk and no dirty pages are created on-the-fly.

Clear
Clears the maxCache pool.
Examples
ARCCONF SETMAXCACHE 1 LOGICALDRIVE 1 READCACHE ENABLE
ARCCONF SETMAXCACHE 1 LOGICALDRIVE 1 WRITECACHE ENABLE WRITEPOLICY WTARCCONF SETMAXCACHE 1 DIRTYPAGETHRESHOLD 50
ARCCONF SETMAXCACHE 1 ADDTOPOOL 0 1
ARCCONF SETMAXCACHE 1 REMOVEFROMPOOL 0 1 0 2
ARCCONF SETMAXCACHE 1 RWBALANCE 4 1
ARCCONF SETMAXCACHE 1 FLUSHANDFETCHRATE 200
ARCCONF SETMAXCACHE 1 CLEAR

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

42

Adaptec RAID Controller Command Line Utility User's Guide

arcconf setname
Description
Renames a logical drive.
Syntax
ARCCONF SETNAME <Controller#> LOGICALDRIVE <LogicalDrive#> <New Name>

Parameters

Controller#
Controller number

LogicalDrive#
The number of the logical drive to be renamed

New Name
The new name of the logical drive
Examples
ARCCONF SETNAME 1 LOGICALDRIVE 1 BACKUP_A

arcconf setncq
Description
Changes the controller’s Native Command Queuing (NCQ) setting to enabled or disabled. This setting
affects the SATA disk drives on the controller. It takes effect when the SATA drives are restarted.
Syntax
ARCCONF SETNCQ <Controller#> ENABLE|DISABLE

Parameters

Controller#
The controller number
Examples
ARCCONF SETNCQ 1 ENABLE

arcconf setperform
Description
Changes controller settings based on the application type.
Syntax
ARCCONF SETPERFORM <Controller#> <Performance Mode> [nologs]

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

43

Adaptec RAID Controller Command Line Utility User's Guide

Parameters

Controller#
The controller number

Performance Mode
Setting

Behavior

1 (DYNAMIC/Default)

Performance criteria adjusts automatically basedon controller usage, RAID level, and disk drivetype.

2 (OLTP/Database)

Performance criteria is optimized for transactionoriented applications such as data entry and retrieval.

3 (Big Block Bypass)

DRAM write cache is bypassed based on IO write
size; performance is optimized for serving Web
pages and retrieving data.

4 (User-Defined)

User-defined performance mode. See arcconf
setcustommode on page 40.

Examples
ARCCONF SETPERFORM 1 2
ARCCONF SETPERFORM 1 3

arcconf setphy
Description
Sets the maximum connection speed for SAS devices to 6Gb/s or 12Gb/s.
Syntax
ARCCONF SETPHY <Controller#> MAXSASPHYLINKRATE <MaxSASPhylinkrate#> [noprompt][nologs]

Parameters

Controller#
The controller number

MaxSASPhylinkrate#
The Phy link rate. Valid values are 6 and 12 (for 6Gb/s and12Gb/s, respectively).

Noprompt
No prompt for confirmation.
Examples
ARCCONF SETPHY 1 MAXSASPHYLINKRATE 6
ARCCONF SETPHY 1 MAXSASPHYLINKRATE 12

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

44

Adaptec RAID Controller Command Line Utility User's Guide

arcconf setpower
Description
Changes power management settings for disk drives on a controller or logical drive.
Syntax
ARCCONF SETPOWER <Controller#> Stayawake DISABLE | <startime> <endtime> [DAYS] [nologs]
ARCCONF SETPOWER <Controller#> Spinup <internal#> <external#>
ARCCONF SETPOWER <Controller#> LD <LD#> <disable | [slowdown st#] |[verify vt#]> [nologs][poweroff pt#] |Parameters

Controller#
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.

DisableIs a keyword that disables the stayawake period for the disk drives on a controller.

starttime
Specifies the beginning of the stayawake period, in the form HHMM (24-hour format)

endtimeSpecifies the end of the stayawake period, in the form HHMM (24-hour format).

DAYS
Days of the week on which the stayawake period is enabled; default is all days.

Spinup
Sets the spin-up limits for the controller—the maximum number of drives that the controller may spin
up at one time.

internal#
The maximum number of internal drives that the controller may spin up at one time, from 0-20.

external#
The maximum number of external drives (such as the drives in a JBOD) that the controller may spin
up at one time, from 0-20.

LD#
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 operating condition. Once the check is completed, the drive is powered
down and returns to its inactive state. Valid values are 0 (never), 1, 2, 3, 8, 12, 24.
Note: For the Slowdown, Poweroff, and Verify timers, st# must be less than pt#,
and pt# must be less than vt#. You can set one or more timers, in any order, in asingle command. Keep in mind that the Verify timer, vt#, is specified in hours; theother two timers are specified in minutes.

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

45

Adaptec RAID Controller Command Line Utility User's Guide

Examples
ARCCONF SETPOWER 1 STAYAWAKE DISABLE
ARCCONF SETPOWER 1 SPINUP 4 4
ARCCONF SETPOWER 1 LD 2 POWEROFF 60
ARCCONF SETPOWER 1 LD 2 SLOWDOWN 20 POWEROFF 60 VERIFY 12

arcconf setpriority
Description
Changes a task's execution priority or a controller's global background task priority.
Syntax
ARCCONF SETPRIORITY <Controller#> [TASK ID] <New Priority> [current]

Parameters

Controller#
The controller number

Task ID
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.

New Priority
LOW, MEDIUM, or HIGH.

Current
Applies a global task priority change to running tasks. By default, a global priority change does not
apply to running tasks.
Examples
ARCCONF SETPRIORITY 1 <task_id> HIGH
ARCCONF SETPRIORITY 1 LOW CURRENT

arcconf setstate
Description
Changes the state of a physical device or logical device from its current state to the designated state.
Syntax
ARCCONF SETSTATE <Controller#> DEVICE <Channel#> <Device#> <State> [MAXCACHE][LOGICALDRIVE <LD#>[LD#] ... ] [noprompt]
ARCCONF SETSTATE <Controller#> LOGICALDRIVE <LD#> OPTIMAL [ADVANCED <option>][noprompt]

Parameters

Controller#
The controller number

Channel#The channel number for the drive.

Device#Device number for the device.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

46

Adaptec RAID Controller Command Line Utility User's Guide

LD#
Logical drive number.

State• HSP—Create a hot spare from a ready drive.
• RDY—Remove a hot spare designation. To remove a dedicated HSP from one or more logicaldevices, use the optional LOGICALDRIVE <LD#> <LD#> ... parameter.
• DDD—Force a drive offline (to Failed).
• EED—Enable the erased drive.

MAXCACHE
Optional keyword for maxCache devices only. Include if State is HSP or RDY, and the hot spare is fora maxCache device.

ADVANCED <option>
Optional keyword/option pair. Set option to Nocheck to force a logical drive to the Optimal state
without performing a consistency check.
Caution: Using Advanced options may result in data loss!

Noprompt:
No prompt for confirmation.
Examples
ARCCONF SETSTATE 1 DEVICE 0 0 HSP LOGICALDRIVE 1 2 3
ARCCONF SETSTATE 1 DEVICE 0 0 RDY LOGICALDRIVE 2
ARCCONF SETSTATE 1 LOGICALDRIVE 1 OPTIMAL ADVANCED nocheck
ARCCONF SETSTATE 1 DEVICE 0 0 DDD
ARCCONF SETSTATE 1 DEVICE 0 0 RDY

arcconf setstatsdatacollection
Description
Enables or disables statistics collection for a controller. To display the statistics, seearcconf getlogs on
page 24 .
Syntax
ARCCONF SETSTATSDATACOLLECTION <Controller#> Enable|Disable

Parameters

Controller#
The controller number

EnableTurns statistics collection on.

DisableTurns statistics collection off.
Examples
ARCCONF SETSTATSDATACOLLECTION 1 ENABLE

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

47

Adaptec RAID Controller Command Line Utility User's Guide

arcconf setvmcredential
Description
Resets the Hypervisor login credentials for VMware Guest OSs.
SyntaxSETVMCREDENTIAL <Esxip> <Esxcimomport> <Esxuserid> <Esxpassword> [noprompt]

Parameters

Esxip
Hypervisor IP address.

Esxcimomport
Hypervisor CiMOM port number.

Esxuserid
Hypervisor user name.

Esxpassword
Hypervisor password.
Examples
ARCCONF SETVMCREDENTIAL 172.18.46.101 5989 root passwd

arcconf task
Description
Performs a task on a logical drive, physical drive, or maxCache logical device.
Syntax: General Usage
ARCCONF TASKTASK START <Controller#> LOGICALDRIVE <LogicalDrive#> <options> [noprompt]
TASK STOP <Controller#> LOGICALDRIVE <LogicalDrive#>
TASK START <Controller#> DEVICE <Channel> <ID> <options> [noprompt]
TASK STOP <Controller#> DEVICE <Channel> <ID>

Syntax: maxCache Usage
ARCCONF TASKTASK START <Controller#> MAXCACHE COHERENCYCHECK [ONCE|ALWAYS]TASK START <Controller#> MAXCACHE <VERIFY_FIX|VERIFY>TASK STOP <Controller#> MAXCACHE

Parameters

Controller#
The controller number

LogicalDrive#
Number of the logical drive in which the task is to be performed

Options:• Logical drive options:
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

48

Adaptec RAID Controller Command Line Utility User's Guide• verify_fix (Verify with fix)—verifies the logical drive redundancy and repairs the drive if baddata is found.
• verify—verifies the logical drive redundancy without repairing bad data.
• clear—removes all data from the drive.
• Physical device options:• verify_fix—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] [PATTERN <pattern>]—removes all data from the drive in a secure
fashion to prevent any possible recovery of the erased data. (See arcconf atapassword on
page 17 for details about setting the password.) Erase patterns:• 1 : Zero - Initializes all blocks to zero.
• 2 : Random Zero - Initializes block to random value then zero.
• 3: Random Random Zero - Initializes block to random value, next block to random value,then zero.

MAXCACHE options:• coherencycheck—compares valid pages of the maxCache Device with their corresponding logicaldrive storage. Once is the default.
• verify_fix (Verify with fix)—verifies the maxCache Device redundancy and repairs the logical drive
if bad data is found.
• verify—verifies the maxCache Device redundancy without repairing bad data.
Examples
ARCCONF TASK START 1 LOGICALDRIVE 1 VERIFY
ARCCONF TASK START 1 DEVICE 0 0 SECUREERASE <password> PATTERN 1
ARCCONF TASK START MAXCACHE COHERENCYCHECK ONCE
ARCCONF TASK STOP 1 DEVICE 0 0

arcconf uninit
Description
Uninitializes one or more physical drives. The uninitialize command clears Adaptec meta-data and any
OS partitions from a drive; existing data on the drive is destroyed. Drives can uninitialized only if they
are in the Raw or Ready state (that is, not part of any logical drive). A drive in the Raw state has no
Adaptec meta-data but may or may not have an OS partition.
Note: Uninitialized drives are compatible with any HBA and can be exchanged withdrives on the motherboard's SATA interface. For more information about uninitialized
devices, see arcconf setcontrollermode on page 39.
Syntax:
ARCCONF UNINIT <Controller#> <Channel# Drive#> [Channel# Drive#] ... [nologs]
ARCCONF UNINIT <Controller#> ALL [nologs]

Parameters

Controller#
Controller number.

Channel#The channel number of the device to be uninitialized.

Drive#The drive number of the device to be uninitialized.

ALL
Uninitializes all physical devices in the Raw or Ready state.
Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

49

Adaptec RAID Controller Command Line Utility User's Guide

nologsSuppresses log output for the command.
Examples
ARCCONF UNINIT 1 0 12 0 13
ARCCONF 1 ALL

Proprietary and Confidential to PMC-Sierra, Inc., and for its customers.
Document No.: CDP-00284-06-A Rev. A, Issue

50

PMC-Sierra, Inc.
1380 Bordeaux Drive
Sunnyvale, CA 94089 USA© Copyright PMC-Sierra, Inc. 2015
All rights reserved. Adaptec and the Adaptec by PMC logo
are trademarks of PMC-Sierra, Inc.
Part Number: CDP-00284-06-A Rev. A
JB 12/10