Intel® RAID Controller Command Line Tool 2 User Guide Order Number: E36092-004
Disclaimer Information in this document is provided in connection with Intel® products. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this document.
Preface The Intel® RAID Controller Command Line Tool 2 utility is provided for UEFI*, DOS*, Linux*, or Microsoft Windows* to configure and view a RAID controller, physical and logical drives, initialize and perform consistency checks, and view the battery back-up status and event logs.
Contents Force: Specifies that The Intel® RAID Controller Command Line Tool 2 utility does not ask you for confirmation before it performs this command. You might lose data using this option with some commands. Silent (no messages) The AppLogFile filename command saves the command log into specified file The Nolog command disables the option to save the command log Manual Organization Chapter 1 provides a list of commands by function. The command syntax is not complete in this chapter.
Contents UEFI Command Line The following commands that are in the regular Intel® RAID Controller Command Line Tool 2 are not available in UEFI: ® AdpSetVerify AdpCcSched AdpBatTest Option ProgDsply CfgSave CfgRestore AdpGetConnectorMode AdpSetConnectorMode DirectPdMapping ShowEnclList ShowVpd EnclLocate SetFacDefault PDCpyBk AdpFwDump Intel RAID Controller Command Line Tool 2 User Guide v
Contents Contents Disclaimer ........................................................................................................... 1 Preface ............................................................................................................... iii 1 Command List by Function .......................................................................... 9 2 Alphabetical List of Commands ................................................................. 13 ? 13 AdpAllinfo ...........................
Contents CfgSscdAdd ............................................................................................................................ 37 CfgSscdDel ............................................................................................................................. 38 ChangeSecurityKey ................................................................................................................ 38 CreateSecurityKey .......................................................................
Contents -Dsbl 62 -DeleteView .................................................................................................................... 63 -Enbl 63 -GetViewInfo .................................................................................................................. 64 -Info 64 -Rollbak 65 -SetProp 65 -TakeSnapshot ............................................................................................................... 66 ShowSummary ...............................................
1 Command List by Function The commands displayed in this chapter do not include the command line with parameters. Use this chapter to determine the command you need to use, and then refer to the alphabetical list of commands in Chapter 2 for the correct parameters. Table 1.
Functional Group Command Command Function -AdpBbuCmd Show BBU information -AdpBbuStatus Show BBU status information Options for Displaying Logs Kept at the Firmware Level -AdpEventLog Event Log Management -AdpAliLog Show information of specified Controller -FwTermLog Set the firmware log and BBU terminal log Configuration-Related Options -CfgLDAdd Create RAID Drive Group -CfgSpanAdd Create RAID Drive Span -CfgClr Clear the Existing Configuration -CfgSave Save the Configuration to a file
Functional Group Command Command Function -PdOnline Set the Drive State to Online -PDOffline Set the Drive State to Offline -PDMakeGood Change the Drive State to Unconfigured Good -PDHSP Change the Hot Swap Drive State -PDClear Manage a Drive Initialization -PDRbld Manage a Drive Rebuild -PDlocate Locate the Drives and Activate LED -PDMarkMissing Mark the Configured Drive as Missing -PDGetMissing Show the Drive in Missing Status -PDReplaceMissing Replace the Configured Drives and Start
Functional Group Command Command Function -DestroySecurityKey Destroy the Security Key -CreateSecurityKey Create a Security Key -ChangeSecurityKey Change the Cecurity Key -GetKeyID Get the Security Key ID -SetKeyID Set the Security Key ID -VerifySecurityKey Verify the Security Key Recovery(Snapshot)-Related Options -Snapshot Manage Snapshot Feature Super Sized Cache (CacheCade) Related Options -CfgSscdAdd Create a Solid State Drive Cache Drive -CfgSscdDel Delete a Solid State Drive Cache
2 Alphabetical List of Commands ? Description Shows the list of available commands Syntax CmdTool2 -? Parameters None Example CmdTool2 -? AdpAllinfo Description Displays information about controller, including cluster state, BIOS, alarm, firmware version, BIOS version, battery charge counter value, ebuild rate, bus number/device number, present RAM, memory size, serial number of the board, and SAS address.
AdpAliLog Description Displays information about specified RAID controller Syntax CmdTool2 -AdpAliLog -a[controller] Parameters -a[controller]: The RAID controller affected by the command Example CmdTool2 -AdpAliLog -a0 AdpAutoRbld Description Enable or disable auto rebuild if hot spare is enabled. This command also determines whether drive insertion will cause an autostart rebuild.
AdpBatTest Description This command tests the battery back up device and is only valid if a battery back-up unit is installed. This command requires a system reboot.
-SetBbuProperties: Sets the BBU properties on the selected controller(s) after reading from the file. Note: You can change only two of these parameters: learnDelayInterval and auto LearnMode Example CmdTool2 -AdpBbuCmd -GetBbuStatus -a1 AdpBIOS Description Enables, disables, or displays the BIOS status on the selected RAID controller.
AdpBootDrive Description Set or Display Bootable Virtual Drive ID Syntax CmdTool2 -AdpBootDrive {-Set -L[drive] | -physdrv[E0:S0]} | -Get -a[controller] Parameters -a[controller]: The RAID controller affected by the command -Set: Sets the virtual drive as bootable so that during the next reboot, the BIOS will look for a boot sector in the specified virtual drive.
AdpCcSched Description Schedule a Consistency Check Syntax CmdTool2 -AdpCcSched -Dsbl | -Info| { -ModeConc | -ModeSeq [-ExcludeLD -L[drive]] [- SetStartTime yyyymmdd hh ] [-SetDelay val ] } -a[controller] Parameters Dsbl: Disables a scheduled CC for the given adapter(s). Info: Gets information about a scheduled CC for the given adapter(s). ModeConc: The scheduled CC on all of the virtual drives runs concurrently for the given adapter(s).
Parameters None Example CmdTool2 -AdpCount AdpDiag Description Run diagnostics on a RAID controller. Syntax CmdTool2 -AdpDiag [val] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -val: Indicates the time in seconds for the controller diagnostic to run. Example CmdTool2 -AdpDiag -aALL AdpEventLog Description Display settings for the event log and BBU terminal log, which are kept at the firmware level.
-GetEventInfo: Displays overall event information -GetEvents: Gets event log entry details. -GetSinceShutdown: Displays all of the events since last controller shutdown. -GetSinceReboot: Displays all of the events since last controller reboot. -IncludeDeleted: Displays all events, including deleted events. -GetLatest [number]: Displays the latest number of events, if any exist. The event data will be written to the file in reverse order.
Syntax CmdTool2 -AdpFwFlash -f [filename] {-NoSigChk} {-NoVerChk} -a[controller] Parameters -a[controller]: The RAID controller affected by the command -NoSigChk: Do not check the firmware’s signature -NoVerChk: Do not check the firmware file version -f [filename]: The name of the firmware file for the flash update. Example CmdTool2 -AdpFwFlash -f FlashUpdt -a1 AdpGetConnectorMode Description Show the connector mode.
Parameters -a[controller]: The RAID controller affected by the command -[parameter(s)]: See the following list of allowed parameters -CacheFlushInterval: Show the cash flush interval -RebuildRate: Show the rebuild rate -PatrolReadRate: Show the patrol read rate -BgiRate: Show the background initialization rate -CCRate: Show the consistency check rate -ReconRate: Show the reconstruction rate -SpinupDriveCount: Show the pinup drive count -SpinupDelay: Show the spinup delay time -CoercionMode: Show the coercio
drive is enabled. -EnblSpinDownUnConfigDrvs: Show if spindown of unconfigured drives is enabled. -EnblSSDPatrolRead: Show if the patrol read operation (media scan) on a SSD is enabled. -AutoEnhancedImportDsply: Show if the automatic enhanced import of foreign drives is enabled. -UseFDEOnlyEncrypt: Show encryption on FDE drives. PrCorrectUncfgdAreas: Show the patrol read operation correct media errors.
Parameters None Example CmdTool2 -AdpM0Flash -f filename AdpNVRAM Description Starts the NVRAM diagnostic.This option is for DOS only.
Parameters -Dsbl: Disable patrol reads -EnblAuto: Enable automatic patrol reads -EnblMan: Enable manual patrol reads -Start: Start a patrol read -Stop: Stop a patrol read -Info: See information about a patrol read -SSDPatrolReadEnbl: Enable the patrol read operation (media scan) on a SSD. -SSDPatrolReadDsbl: Disable the patrol read operation (media scan) on a SSD.
AdpSetConnectorMode Description Choose to use the internal or external connector on a RAID controller.
CCRate: Consistency check rate. Values: 0 to 100. ReconRate: Reconstruction rate. Values: 0 to 100. SpinupDriveCount: Max number of drives to spin up at one time. Values: 0 to 255. SpinupDelay: Number of seconds to delay among spinup groups. Values: 0 to 255. CoercionMode: Drive capacity Coercion mode. Values: 0 - None, 1 - 128 Mbytes, 2 - 1 Gbytes. ClusterEnable: Cluster is enabled or disabled. Values: 0 - Disabled, 1 - Enabled. PredFailPollInterval: Number of seconds between predicted fail polls.
AutoEnhancedImportEnbl: Enable the controller to import a foreign configuration automatically at boot (known as automatic enahanced import). AutoEnhancedImportDsbl: Do not allow the controller to import a foreign configuration automatically. UseFDEOnlyEncrypt: Use encryption on FDE drives only. PrCorrectUncfgdAreas: Have the patrol read operation correct media errors if the value is 1. DsblSpinDownUnConfigDrvs: Disable the automatic spindown of unconfigured drives.
AdpSetTime Description Set the date and time on a RAID controller. Syntax CmdTool2 -AdpSetTime [yyyymmdd] [hh:mm:ss] -a[controller] Parameters -a[controller]: The RAID controller affected by the command [yyyymmdd]: The date to set [hh:mm:ss]: The time to set Example CmdTool2 -AdpSetTime 20071230 24:00:00 -a1 AdpSetVerify Description Verify a RAID controller’s configuration against a file.
AdpShutDown Description Shut down the RAID controller.
-RA: Set the array to read-ahead -NORA: Set the array to no read-ahead -ADRA: Set the array to adaptive read ahead -Cached, Direct: Selects cache policy -CachedBadBBU|NoCachedBadBBU: Specifies whether to use write cache when the BBU is bad strpszM: Specifies the stripe size AfterLdX: This command is optional. By default, the application uses the first free slot available in the virtual drive. This option is valid only if the virtual disk is already used for configuration.
Syntax CmdTool2 -CfgDsply -a[controller] Parameters -a[controller]: The RAID controller affected by the command Example CmdTool2 -CfgDsply -a1 CfgEachDskRAID0 Description Configure every physical drive in an Unconfigured-Good state as RAID 0 on the RAID controller. Set the array properties. Note: You cannot span RAID 0 across a single drive.
CfgForeign Description Manage foreign configuration information. Syntax CmdTool2 -CfgForeign -Scan | [-SecurityKey password] | -Dsply [x] | -Preview [x] | -Import [x] | -Clear [x] -a[controller] Parameters -a[controller]: The RAID controller affected by the command (default is all) -Scan: Scans and displays available foreign configuration -Disply (x): Displays the foreign configuration -Import (x): Imports the foreign configuration.
Example CmdTool2 -CfgFreeSpaceinfo -a1 CfgLDAdd Description Configure RAID and determine the attributes of the RAID array. Syntax CmdTool2 -CfgLDAdd -Rx[En:Sn] [WB|WT] [NORA|RA|ADRA] [Direct|Cached] [CachedBadBBU | NOCachedBadBBU ] [ -szXXXXXXXX [-szYYYYYYYY [...]]] [-strpszM] [-Hsp[E0:S0,...]] [-afterLdX] | -Force [FDE|CtrlBased] -a[controller] Parameters -Rx[E0:Sn]: Specifies the RAID level and the drive enclosure/slot numbers used to construct a drive group.
-Force: Specifies the drive coercion is used to make the capacity of the drives compatible. NOTE: Previously -szXXX expressed capacity in Mbytes but now you can enter the capacity in your choice of units. For example, to create a virtual drive of 10 Gbytes, enter the size as sz10GB. If you do not enter a unit, by default it is considered as Mbytes. Example CmdTool2 -CfgLDAdd -R5[252:0,252:1,252:3] -WB -RA -sz10GB -a0 CfgLdDel Description Delete logical drives from a RAID controller.
-f : The data will be restored from the file specified by [filename] Example CmdTool2 -CfgRestore -f RAIDCOnfig -a1 CfgSave Description Saves the configuration and properties structure for each RAID controller(s) to a binary file.
-r50: To create RAID 50 array -r60: To create RAID 60 array -Array0[E0:S0, E1:S1]: Uing the specifid enclosure ID and slot ID drives to create Array0 -Array1[E0:Sn] [...
Example CmdTool2 -CfgSscdAdd -physdrv[252:0] -a1 CfgSscdDel Description Delete a Solid State Drive Cache Drive (SSCD) to use as secondary cache Syntax CmdTool2 -CfgSscdDel -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: The drive(s) affected by the command Example CmdTool2 -CfgSscdDel -L1 -a1 ChangeSecurityKey Description Change the sercurity key Syntax CmdTool2 -ChangeSecurityKey -OldSecurityKey sssssssssss | -SecurityKey sssssssssss | [Passp
-SecurityKey sssssssssss: Enters the new security key. The security key is case-sensitive. It must be between eight and thirty-two characters and contain at least one number, one lowercase letter, one uppercase letter, and one non-alphanumeric character (e.g. < > @ +). The space character is not permitted. -Passphrase sssssssssss: Enters the new passphrase. The pass phrase is case-sensitive.
uppercase letter, and one non-alphanumeric character (e.g. < > @ +). The space character is not permitted. -KeyID kkkkkkkkkkk: Enters the security key ID. The key ID displays when you have to enter a security key. If you have multiple security keys, the security key ID helps you determine which security key to enter.
Dsbl: Disables the direct physical drive mapping mode. Dsply: Displays the current state of the direct physical drive mapping. Example CmdTool2 - DirectPdMapping -Enbl -a1 DiscardPreservedCache Description Discard the preserved cache of a virtual drive.
EncStatus Description Show enclosure status for the RAID controller(s) specified. Syntax CmdTool2 -EncStatus -a[controller] Parameters -a[controller]: The RAID controller affected by the command Example CmdTool2 -Encstatus -aALL GetKeyID Description Get the security key ID.
Syntax CmdTool2 -FwTermLog -Bbuoff|-BbuoffTemp|-Bbuon|-BbuGet| Dsply | Clear -a[controller] Parameters -Bbuoff: Turn off BBU for the RAID firmware level term log protection -BbuoffTemp: Turn off BBU temporary -Bbuon: Turn on BBU for RAID firmware level term log protection -BbuGet: Displays the BBU setting for RAID firmware level term log protection -Dsply: Displays the RAID firmware level term log -Clear: Clears RAID firmware level term log Example CmdTool2 -FwTermLog -Dsply -a0 GetPreservedCacheList Des
Syntax CmdTool2 -h, -help Parameters None Example CmdTool2 -h CmdTool2 -help LDBI Description Manages background initialization options.
LDBBMClr Description Clear the LDBBM Talbe Entries Syntax CmdTool2 -LDBBMClr -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: The drive(s) affected by the command Example CmdTool2 -LDBBMClr -L1 -a1 LDCC Description Starts or stops the consistency check per array for each RAID controller.
Example CmdTool2 -LDCC -ProgDsply -L2 -a1 LDMakeSecure Description Secure data on a virtual drive Syntax CmdTool2 -LDMakeSecure -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: The drive(s) affected by the command Example CmdTool2 -LDMakeSecure -L2 -a1 LdExpansion Description This command is used to expand the virtual drive .
Example CmdTool2 -LDCC -ProgDsply -l2 -a1 LDGetNum Description Displays the number of virtual drives attached to the controller.
Example CmdTool2 -LDGetProp -Cache -Access -l2 LDInfo Description Displays information about the virtual drive(s) on the selected controller(s). Syntax CmdTool2 -LDInfo -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: The drive(s) affected by the command Example CmdTool2 -LDInfo -l2 -a1 LDInit Description Start, stop, or show the progress of an array initialization.
-l[drive]: The drive(s) affected by the command Example CmdTool2 -LDInit -Start -full -l0 -a1 LdPDInfo Description Display information about the present virtual drives and drives Syntax CmdTool2 -LdPDInfo -PhysDrv[E0:S0,E1:S1....] -a[controller] Parameters -a[controller]: The RAID controller affected by the command Example CmdTool2 -LdPDInfo -a1 LDRecon Description Controls and manages virtual drive reconstruction. Syntax CmdTool2 -LDRecon {-Start -RX[Add | Rmv -Physdrv[E0:S0,...
-Rmv: Remove a drive -Physdrv[E0:S0,...
Example CmdTool2 -LDSetProp -RW WB NORA Direct -DisDskCache CachedBadBBU -L0 -a0 PdFwDownload Description Flashes the firmware with the file specified. Syntax cmdTool2 -PdFwDownload -PhysDrv[E0:S0,E1:S1,...] -f [filename] a[controller] Parameters -a[controller]: The RAID controller affected by the command -PhysDrv[E0:S0,E1:S1,...
-ShowProg: Displays a snapshot of the ongoing initialization process -ProgDsply: Displays the initialization progress until completion or until a key is pressed Example CmdTool2 -PDClear -Stop -PhysDrv[252:0] -a0 PDCpyBk Description Perform the Copyback Operation on the Selected Drive Syntax CmdTool2 -PDCpyBk -Start | -Stop|-ShowProg|-ProgDsply -PhysDrv[E0:S0] -a[controller] Parameters -a[controller]: The RAID controller affected by the command Start: Initializes the copyback operation on the selected d
Parameters -a[controller]: The RAID controller affected by the command Example CmdTool2 -PDGetMissing -a1 PDGetNum Description Lists the number of physical drives either attached directly to the RAID controller or in enclosures attached to the RAID controller.
-Set: Changes the drive state to dedicated hot spare for the enclosure.
Parameters -a[controller]: The RAID controller affected by the command -PhysDrv[E0:S0,...]: Specifies the drive(s) that you want to perform the Instant Secure Erase on. Example CmdTool2 -PDInstantSecureErase -PhysDrv[252,0] -Force -a1 PDList Description Displays the size, type, serial number, and firmware version for all physical drives attached to a RAID controller.
Example CmdTool2 -PDLocate -physdrv[252,0] -a0 PDMakeGood Description Change the physical drive state from unconfigured-bad to unconfigured-good. Syntax CmdTool2 -PDMakeGood -PhysDrv[E0:Sn....] | [-Force] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -PhysDrv[E0:Sn...
PDOffline Description Sets the drive state to offline. Syntax CmdTool2 -PDOffline -PhysDrv[E0:S....] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -PhysDrv[E0:S....]: The physical drive(s) affected Example CmdTool2 -PDOffline -PhysDrv[252,0] -a0 PDOnline Description Sets the drive state to online Syntax CmdTool2 -PDOnline -PhysDrv[E0:Sn....] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -PhysDrv[E0:Sn....
PDPrpRmv Description Prepare an unconfigured physical drive(s) for removal. The drive is spun down and the drive state is set to unaffiliated, which marks it as offline even though it is not a part of the configuration. Syntax CmdTool2 -PDPrpRmv [-Undo] -PhysDrv[E0:Sn....] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -PhysDrv[E0:Sn....
Example CmdTool2 -PDRbld -Start -PhysDrv[252,0] -a0 PDReplaceMissing Description Replaces the configured physical drive, and then starts an automatic rebuild. The specified array, index and row must be a missing drive.
PhyInfo Description Displays information about the PHY of the specified port ID. Syntax CmdTool2 -PhyInfo -phyM -a[controller] Parameters -a[controller]: The RAID controller affected by the command -phyM: Specifies the PHY ID Example CmdTool2 -PhyInfo -phy3 -a1 SetKeyID Description Set the security key ID. Syntax CmdTool2 -SetKeyID -KeyID kkkkkkkkkkk -a[controller] Parameters -a[controller]: The RAID controller affected by the command -KeyID kkkkkkkkkkk: Enters the security key ID.
Snapshot -Clean Description Clean the recoverable free space on the drives in a virtual drive Syntax CmdTool2 -Snapshot -Clean -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: specifies the source LD number for the command.
CmdTool2 -snapshot -CreateView -SnapshotTime 20110401 00:00:00 -L1 -a1 -DeleteSnapshot Description Delete a snapshot Syntax CmdTool2 -Snapshot -DeleteSnapshot [SnapshotTime yyyymmdd hh:mm:ss | -all] [-force|-y] - L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: specifies the source LD number for the command. -AutoSnapshot: If the value is 0, this command disables the AutoSnapshot feature on source virtual drive.
Example CmdTool2 -snapshot -Dsbl -L1 -a1 -DeleteView Description Delete a view Syntax CmdTool2 -Snapshot -DeleteView [SnapshotTime yyyymmdd hh:mm:ss | -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: specifies the source LD number for the command.
-AutoSnapshot: Optional parameter, if specified, enables the AutoSnapshot for the source virtual drive. -AutoDeleteOldestSnapshot: Optional parameter, enables the AutoDeletOldestSnapshot for the source virtual drive.
-SnapshotTime yyyymmdd hh:mm:ss: (Optional) If specified, this displays the snapshot information for the snapshot with the time stamp yyyymmdd hh:mm:ss. -ViewTime yyyymmdd hh:mm:ss: (Optional) If specified, this displays the view information for the view with the time stamp yyyymmdd hh:mm:ss and the associated snapshot information.
Syntax CmdTool2 -Snapshot -SetProp {-AutoSnapshot -val} | {-AutoDeleteOldestSnapshot -val} -L[drive] -a[controller] Parameters -a[controller]: The RAID controller affected by the command -L[drive]: specifies the source LD number for the command. -AutoSnapshot: If the value is 0, this command disables the AutoSnapshot feature on source virtual drive.
-szXXX: Specifies the size of the view in MB where XXX is a decimal number Example CmdTool2 -snapshot -TakeSnapshot -SnapshotName Snapshot_1 -L1 -a1 ShowSummary Description Dispalys a summary of system information, controller information, drive information, virtual drive information, and enclosure information.
Example CmdTool2 -VerifySecurityKey -SecurityKey abcd1234@ -a0 v Description Displays the version of the Intel® RAID Controller Command Line Tool 2 program.
