CArclib Programming Guide

Purpose

The CArclib is an API library written in C++ that manages query and configuration operations

across a range of ARECA RAID subsystem.

CArclib Members

Initialization Members

ArcInitSession

The ArcInitSession method starts the library with an interface

General Members

ArcGetLibVersion

The ArcGetLibVersion method returns the current version of CArclib

ArcGetInterface

The ArcGetInterface method returns the current interface of CArclib

System Members

ArcChkPassword

The ArcChkPassword method validates a password by checking a string to determine if it matches the current password.

Some functions need to validate password before it is allowed to work

ArcGetIdentifyString

The ArcGetIdentifyString method returns the identification string of controller

ArcGetSysInfo

The ArcGetSysInfo method returns the information about RAID subsystem

ArcGetSystemConfigInfo

The ArcGetSystemConfigInfo method returns the information about system configuration parameters

ArcIdentify

The ArcIdentify method identifies the controller

ArcLogOut

The ArcLogOut method forces the RAID subsystem to do a password checking in the next operation

ArcMuteBeeper

The ArcMuteBeeper method mutes the beeper

ArcResetController

The ArcResetController method restarts the RAID subsystem

ArcSetAutoActivate

The ArcSetAutoActivate method updates the RAID subsystem Auto Activate Incomplete Raid mode

ArcSetBeeper

The ArcSetBeeper method updates the system beeper state

ArcSetCpuFanDetection

The ArcSetCpuFanDetection method updates the RAID subsystem Controller Fan Detection mode

ArcSetDiskCache

The ArcSetDiskCache method updates the RAID subsystem Disk Write Cache mode

ArcSetEmptyHddSlotLed

The ArcSetEmptyHddSlotLed method updates the RAID subsystem Empty HDD Slot LED mode

ArcSetHddReadAhead

The ArcSetHddReadAhead method updates the RAID subsystem HDD Read Ahead Cache mode

ArcSetHddSpinDownMode

The ArcSetHddSpinDownMode method updates the RAID subsystem HDD Time to Spin Down mode

ArcSetHddLowPowerIdleMode

The ArcSetHddLowPowerIdleMode method updates the RAID subsystem HDD Time to Low Power Idle mode

ArcSetHddLowRPMMode

The ArcSetHddLowRPMMode method updates the RAID subsystem HDD Time to Low RPM mode

ArcSetHostMode

The ArcSetHostMode method updates the Host Mode of RAID subsystem

ArcSetLogo

The ArcSetLogo method updates the RAID subsystem logo

ArcSetMaxAtaMode

The ArcSetMaxAtaMode method updates the IDE speed in target mode

ArcSetModel

The ArcSetModel method updates the RAID subsystem model name

ArcSetPassword

The ArcSetPassword method updates the RAID subsystem password

ArcSetRebuildPriority

The ArcSetRebuildPriority method updates the Rebuilding Priority of the RAID subsystem

ArcSetSerial

The ArcSetSerial method updates the RAID subsystem serial number

ArcSetSMARTHddPoll

The ArcSetSMARTHddPoll method updates the RAID subsystem HDD SMART Status Polling mode

ArcSetStaggerPowerOn

The ArcSetStaggerPowerOn method updates the RAID subsystem Stagger Power On Control

ArcSetTermPort

The ArcSetTermPort method updates COM port settings of the RAID subsystem

ArcSetTime

The ArcSetTime method synchronizes the RAID subsystem date-time with the host date-time

ArcSetTruncateMode

The ArcSetTruncateMode method updates the RAID subsystem Disk Capacity Truncation mode

ArcSetVendor

The ArcSetVendor method updates the RAID subsystem Vendor Name

ArcStartCheckVolume

The ArcStartCheckVolume method starts a volumeset checking

ArcStopCheckVolume

The ArcStopCheckVolume method stops all volumesets checking

ArcUpdateFirmware

The ArcUpdateFirmware method executes the firmware updating

ArcSetReadAhead

The ArcSetReadAhead method updates the RAID subsystem read-ahead buffer size

ArcSetTLER

The ArcSetTLER method updates TLER(Time-Limited Error Recovery)

ArcSetBufferThreshold

The ArcSetBufferThreshold method updates the RAID subsystem buffer threshold

ArcSetTimeout

The ArcSetTimeout method updates the timeout value for HDD

ArcSetRetryCount

The ArcSetRetryCount method updates the RAID subsystem retry count

ArcSetAVStream

The ArcSetAVStream method updates the number of AV Streams

ArcSetOptimizeAVRecording

The ArcSetOptimizeAVRecording method updates the AV Recording Mode

ArcSetOptimizeAVEdition

The ArcSetOptimizeAVEdition method updates the AV Edition Mode

ArcSetVolumeDataReadAhead

The ArcSetVolumeDataReadAhead method updates the Volume Data Read-Ahead

ArcGetAdvancedFeaturesInfo

The ArcGetAdvancedFeaturesInfo method returns the information about system advanced feature configurations

ArcSetHddQueueDepth

The ArcSetHddQueueDepth method updates the HDD Queue Depth

ArcSetSataNCQ

The ArcSetSataNCQ method updates SATA NCQ Support

ArcSetSASMux

The ArcSetSASMux method updates SAS Mux

ArcSetSES2Support

The ArcSetSES2Support method updates SES 2 Support

ArcSetMaxCmdLen

The ArcSetMaxCmdLen method updates the Max Command Length mode

ArcSetSATA150Support

The ArcSetSATA150Support method updates SATA150 Support

ArcSetReadPerformanceMargin

The ArcSetReadPerformanceMargin method updates the Read Performance Margin

ArcSetWritePerformanceMargin

The ArcSetWritePerformanceMargin method updates the Write Performance Margin

ArcSetReadAndDiscardParityData

The ArcSetReadAndDiscardParityData method updates Read And Discard Parity Data Mode

ArcSetSataHddSpeed

The ArcSetSataHddSpeed method updates SATA HDD Speed

ArcSetSMARTOptionForHDD

The ArcSetSMARTOptionForHdd method updates the RAID subsystem SMART Option mode

ArcSetSMARTPollingInterval

The ArcSetSMARTPollingInterval method updates the RAID subsystem SMART Polling Interval mode

ArcSetWriteSameForInit

The ArcSetWriteSameForInit method updates the RAID subsystem Write Same For Initialization mode

ArcSetHotPluggedDiskForRebuilding

The ArcSetHotPluggedDiskForRebuilding method updates the RAID subsystem Hot Plugged Disk For Rebuilding mode

Disk Members

ArcGetPhysicalDriveInfo

The ArcGetPhysicalDriveInfo method returns the information about a device (disk)

ArcCreatePassthroughDisk

The ArcCreatePassthroughDisk method creates a pass-through device (disk)

ArcDelPassthroughDisk

The ArcDelPassthroughDisk method deletes a pass-through device (disk)

ArcModifyPassthroughDisk

The ArcModifyPassthroughDisk method modifies a pass-through device (disk)

ArcIdentifyDisk

The ArcIdentifyDisk method identifies one or more devices (disks)

ArcAtaPassthroughCmd

The ArcAtaPassthroughCmd method executes the ATA commands for a device (disk)

ArcScsiPassthroughCmd

The ArcScsiPassthroughCmd method executes the SCSI commands for a device (disk)

RaidSet Members

ArcGetRaidSetInfo

The ArcGetRaidSetInfo method returns the information about a raidset

ArcCreateRaidSet

The ArcCreateRaidSet method creates a raidset with a group of devices (disks)

ArcDelRaidSet

The ArcDelRaidSet method deletes a raidset

ArcExpandRaidSet

The ArcExpandRaidSet method expands a raidset with or without modifying volumesets

ArcActivateRaidSet

The ArcActivateRaidSet method activates an incomplete raidset

ArcCreateHotSpare

The ArcCreateHotSpare method creates one or more Hot-Spare devices (disks)

ArcDeleteHotSpare

The ArcDeleteHotSpare method deletes one or more Hot-Spare devices (disks)

ArcOfflineRaidSet

The ArcOfflineRaidSet method offlines a raidset

ArcFailDisk

The ArcFailDisk method makes one disk failed

VolumeSet Members

ArcGetVolSetInfo

The ArcGetVolSetInfo method returns the information about a volumeset

ArcCreateVolumeSet

The ArcCreateVolSet method creates a volumeset

ArcDelVolSet

The ArcDelVolSet method deletes a volumeset

ArcModifyVolumeSet

The ArcModifyVolSet method modifies a volumeset

ArcGenerateAESKeyBuffer

The ArcGenerateAESKeyBuffer method creates AES key for the volume(s) with encryption capability

ArcSetScheduleVolumeCheck

The ArcSetScheduleVolumeCheck method updates scheduled volume checking

Network Members

ArcGetOnBoardNetInfo

The ArcGetOnBoardNetInfo method returns the information about a network

ArcSetMacAddr

The ArcSetMacAddr method updates the RAID subsystem MAC (Media Access Control) address if Ethernet supported

ArcSetGetwayIp

The ArcSetGatewayIp method updates gateway IP address of the RAID subsystem

ArcSetEthernetMask

The ArcSetEthe0netMask method updates Ethernet Mask IP address of the RAID subsystem.

ArcHttp

The ArcHttp method transfers the HTTP data between the web browser and the RAID subsystem

ArcSNMPWithOid

The ArcSNMPWithOid method returns the information about SNMP OID

ArcSNMP

The ArcSNMP method returns the information about SNMP OID

ArcSetDhcpIp

The ArcSetDhcpIp method updates DHCP function and static IP address of the RAID subsystem

ArcSetHTTPPort

The ArcSetHTTPPort method updates HTTP Port# of the RAID subsystem

ArcSetTelnetPort

The ArcSetTelnetPort method updates Telnet Port# of the RAID subsystem

ArcSetSMTPPort

The ArcSetSMTPPort method updates SMTP Port# of the RAID subsystem

ArcSetMailSmtpIp

The ArcSetMailSmtpIp method updates SMTP server's IP address for email notification

ArcSetMailSmtpLoginAccount

The ArcSetMailSmtpLoginAccount method updates SMTP server's account for email notification

ArcSetMailEvtLevel

The ArcSetMailEvtLevel method updates event level for email notification

ArcSetMailAddr

The ArcSetMailAddr method updates email addresses for email notification

ArcGetMailInfo

The ArcGetMailInfo method returns the information about email notification parameters

ArcSetMailNoEvtFor24Hours

The ArcSetMailNoEvtFor24Hours method updates the option of sending email if no event occurs within 24 hours

ArcSetSnmpTrapIp

The ArcSetSnmpTrapIp method updates trap ip addresses for SNMP notification

ArcSetSnmpTrapPort

The ArcSetSnmpTrapPort method updates SNMP trap port number for SNMP notification

ArcSetSnmpCommunity

The ArcSetSnmpCommunity method updates community string for SNMP notification

ArcSetSnmpContact

The ArcSetSnmpContact method updates contact string for SNMP notification

ArcSetSnmpName

The ArcSetSnmpName method updates name string for SNMP notification

ArcSetSnmpLocation

The ArcSetSnmpLocation method updates location string for SNMP notification

ArcSetSnmpEvtLevel

The ArcSetSnmpEvtLevel method updates event level for SNMP notification

ArcGetSnmpInfo

The ArcGetSnmpInfo method returns the information about SNMP notification parameters

ArcSetTimeZone

The ArcSetTimeZone method updates Time Zone setting

ArcSetDayLightSaving

The ArcSetDayLightSaving method updates the Daylight Saving setting

ArcSetNtpIp

The ArcSetNtpIp method updates IP addresses for NTP Server

ArcGetNtpInfo

The ArcGetNtpInfo method returns the information about NTP parameters

Hardware Monitor Members

ArcGetHWMon5010

The ArcGetHWMon5010 method returns the H/W monitor information for ARC-5010 & ARC-6010

ArcGetHWMon

The ArcGetHWMon method returns the information about a H/W monitor

Event Members

ArcClearEvent

The ArcClearEvent method clears all event objects of the RAID subsystem

ArcPollEvent

The ArcPollEvent method returns the position of the current event object

ArcGetEventObject

The ArcGetEventObject method returns individual event object

ArcGetReqEventPage

The ArcGetReqEventPage method returns number of event objects

SAS Members

ArcCreateVolSetR5060

The ArcCreateVolSetR5060 method creates a Raid30/50/60 volumeset with a group of raidsets

ArcGetEnclosureHwMonitor

The ArcGetEnclosureHwMonitor method returns the H/W monitor information about a SAS enclosure

ArcGetEnclosureProperty

The ArcGetEnclosureProperty method returns the property about a SAS enclosure

ArcSASIdentifyDisk

The ArcSASIdentifyDisk method identifies an enclosure or a device (disk)

Helper Members

ArcHelpBuildDeviceMap

The ArcHelpBuildDeviceMap method enumerates devices (disks) that connected to raid subsystem

ArcHelpBuildRaidSetMap

The ArcHelpBuildRaidSetMap method enumerates raidsets that exists in the raid subsystem

ArcHelpBuildVolumeSetMap

The ArcHelpBuildVolumeSetMap method enumerates volumesets that exists in the raid subsystem