Go to main content
1/9
Contents
Title and Copyright Information
Preface
WSDL URLs
Documentation Accessibility
Related Documentation
1
Library Inbound Methods
Request Methods
getRequest()
getRequests()
cancelRequest()
getLocalizedRequestMessages()
getSupportedLocales()
waitForRequest()
Library Complex Methods
getLibraries()
getLibraryComplex()
getLibraryComplexCartridges()
getLibraryComplexCells()
getLibraryComplexCleaningCartridges()
getLibraryComplexDevices()
getLibraryComplexDevicesByControlState()
getLibraryComplexDrives()
getLibraryComplexDriveTrays()
getLibraryComplexModules()
getLibraryComplexSlots()
setLibraryComplexName()
setLibraryComplexBootOptions()
resetLibraryComplexToFactoryDefault()
exportLibraryComplexConfig()
importLibraryComplexConfig()
updateTimeSettings()
Library Methods
getLibrary()
getLibraryCells()
getLibraryCartridges()
getLibraryDevices()
getLibraryDrives()
getLibraryDriveTrays()
getCell()
getCellByLrcsr()
setLibraryName()
changeLibraryState()
enableRedundantElectronics()
Module Methods
getModule()
getModuleCartridges()
getModuleCells()
getModuleDevices()
getModuleDriveTrays()
getModuleSlots()
Device Methods
getDevice()
getDeviceCartridges()
getDeviceCells()
getDeviceSensors()
getDeviceSlots()
getDeviceTelemetry()
getContainedDevices()
getFruIdData()
bringDeviceOnline()
takeDeviceOffline()
enableOnlining()
inhibitOnlining()
turnDeviceOn()
turnDeviceOff()
setLedState()
locateDevice()
pingDevice()
resetDevice()
Robot Methods
downloadRobotLog()
getCellDepth()
getRailSegmentResourceHistory()
getRobot()
getRobots()
getRobotCalibration()
getRobotHistory()
getRobotMetrics()
getRobotParameters()
getRobotRange()
getRobotStatistics()
CAP Methods
What is a capHandle?
changeCapState()
getCap()
getCaps()
getCapRange()
getCapStatistics()
lockCap()
unlockCap()
openCap()
closeCap()
setCapOwner()
freeCap()
forceFreeCap()
getCapPool()
getCapPools()
createCapPool()
deleteCapPool()
moveCapToCapPool()
Drive Methods
getCompatibleDriveTypes()
getCompatibleMediaTypes()
getDriveTray()
getDriveTypes()
getDrive()
updateDrive()
cleanDrive()
getFirmwareUpgradeActivity()
Cartridge Methods
getCartridgeByCellId()
getCartridgeByVolser()
getAllCartridgesByVolser()
getAllCartridgesByVolsers()
getCartridgeTypes()
mountCartridgeByCellId()
mountCartridgeByVolser()
moveCartridgeByCellId()
moveCartridgeByVolser()
dismountCartridgeByCellId()
dismountCartridgeByVolser()
getLostCartridges()
moveLostCartridge()
Partitioning Methods
changePartitionState()
createPartition()
deletePartition()
getPartition()
getPartitions()
getPartitionCaps()
getPartitionCartridges()
getPartitionCell()
getPartitionCells()
getPartitionDrives()
getPartitionDriveTrays()
moveCellsToPartitionByCellIdList()
moveDriveBaysToPartition()
updatePartition()
setPartitionCapPool()
clearPartitionCapPool()
SCSI Host Methods
createScsiHost()
getScsiHosts()
Audit Methods
runAuditOnLibraryComplex()
runAuditOnRange()
Media Validation Methods
validateCartridgeByCellId()
validateCartridgeByVolser()
Diagnostic Testing Methods
getDiagnosticTests()
runDiagnosticTest()
Hardware Feature Activation (HWAF) Methods
installHwaf()
removeHwaf()
removeAllHwafs()
getHwafs()
getActivtedFeatures()
getHwafActivtyLog()
Network Configuration Methods
getCustomerNetworkSettings()
getOkmNetworkSettings()
getServiceNetworkSettings()
libraryTraceRoute()
pingNetworkAddress()
resetNetworkSettings()
setPingResponse()
Library Firmware Upgrade Methods
uploadLibraryFirmware()
activateLibraryFirmware()
User Role Methods
createUser()
deleteUser()
changeUserRole()
changeUserPassword()
Fault and Library Log Methods
clearFault()
createSupportBundle()
createTestEvent()
deleteSupportBundle()
downloadSupportBundle()
getFault()
getFaults()
getLogEntries()
getLoggerLogEntries()
getLoggingLevel()
getLoggingLevels()
getSupportBundle()
getSupportBundles()
getSystemReport()
getSystemReports()
resetLoggingLevel()
setLoggingLevel()
Notification Configuration Methods
createEmailDestination()
createSciDestination()
deleteDestination()
getDestinations()
getEmailDestination()
getEmailDestinations()
getSciDestination()
getSciDestinations()
getSnmpDestination()
updateEmailDestination()
updateSciDestination()
2
Outbound Methods
auditComplete()
capacityChanged()
capClosed()
capOpened()
capOwnershipOverridden()
capReadyToOpen()
deviceControlStateChange()
deviceFailed()
deviceInstalled()
deviceRemoved()
doorClosed()
doorOpened()
driveCleaningNeeded()
faultDetected()
libraryComplexStateChange()
libraryStateChange()
lostCartridges()
moveData()
intermediateData()
mediaValidationDrivePoolModified()
partitionChanged()
ping()
railStateChange()
test()
3
SCI Objects
Primitive Types
Lists and Sets
DataHandler
Subclass of an Object
Data Transfer Objects (DTOs)
Requests, Jobs, and Resources Objects
RequestDto
RequestErrorDto
RequestOutputMessageDto
JobDto
JobParameter
ResourceDto
CellResourceDto
DeviceResourceDto
RailSegmentResourceDto
ResourceUsageDto
RailSegmentResourceUsageDto
Library Objects
LibraryComplexDto
LibraryComplexCountsDto
LibraryDto
LibraryIdentityDto
CardCageIdentityDto
LibraryCountsDto
RedStackInfoDto
ModuleDto
ModuleCountsDto
RailDto
RailCountsDto
CellDto
CellAddressDto
SlotDto
DoorStateDto
PartitionDto
PartitionCountsDto
ScsiHostDto
ScsiLunDto
TimeSettingsDto
Tape Cartridge Objects
CartridgeDto
CartridgeTypeDto
CleaningCartridgeDto
Network Objects
FcPortDto
IpAddressDto
NetworkAddressDto
NetworkInterfaceSettingsDto
NetworkPerformanceMeasurementDto
NetworkSettingsDto
TraceRouteResultsDto
Device Objects
DeviceDto
DeviceIdentityDto
LedDto
PingDeviceResultsDto
FruIdDto
SDSegmentDto
FLSegmentDto
BasePartIdentityDto
wwnRangeDto
FrudIdentityDto
ConfiguredIdentityDto
SystemIdentityDto
ProductIdentityDto
SensorDto
TelemetryDto
MeasurementDto
EnergyMeasurementDto
HotSwapMeasurementDto
TemperatureMeasurementDto
FanMeasurementDto
CAP Objects
CapDto
CapPoolDto
CapMeasurementDto
CapStatisticsDto
Drive Objects
DriveDto
DriveTypeDto
DriveTrayDto
DriveOperationDto
Robot Objects
RobotDto
RobotCalibrationDto
RobotCellDepthDto
RobotGetStatisticsDto
RobotMetricsDto
RobotMetricDataDto
RobotParametersDto
RobotPositionHistoryDto
RobotStatisticsDto
MotionRangeDto
User Objects
UserDto
GroupDto
RoleDto
Hardware Activation Objects
ActivatedFeatureDto
HwafDto
HwafActionDto
Diagnostic Test Objects
DiagnosticTestDto
DiagnosticTestParameterDto
Notification Objects
DestinationDto
EmailDestinationDto
SciDestinationDto
AsrDestinationDto
SnmpDestinationDto
AsrDto
ServiceContactDto
Logging and Fault Objects
LoggingLevelDto
SupportBundleDto
SystemReportDto
FaultDto
SuspectFruDto
Firmware Related Objects
LibraryFirmwareDto
ComponentFirmwareDto
DriveFirmwareDto
FirmwareUpgradeEventDto
Outbound SCI Objects
EventDataDto
CapMoveDto
CapMoveEventDataDto
CapOwnerOverriddenEventDataDto
CapReadyToOpenEventDataDto
CartridgeMoveEventDataDto
DeviceEventDataDto
DoorEventDataDto
DriveActivityDataDto
DriveCleanNeededEventdataDto
FaultEventDataDto
IntermediateMountDriveEventDataDto
LibraryComplexEventDataDto
LicensedCapacityChangeEventDataDto
LibraryEventDataDto
AuditEventDataDto
AuditActivityDataDto
LibraryStatisticsDto
LostCartridgesEventDataDto
MediaValidationDrivePoolModifiedEventDataDto
RailEventDataDto
PartitionEventDataDto
RobotMoveDto
TestEventDataDto
4
Enumeration Types
CellContentsState
CellState
CellType
CellTypeSelector
CommandTiming
ComponentLocationState
ControlState
CorrectiveActionsType
DestinationType
DeviceStateType
DeviceType
DeviceTypeSelector
DoorState
DriveActivityStatusCode
DriveInterfaceType
DriveOperationStatus
DriveProtocol
ErrorCode
EventCategory
EventSeverity
EventType
FanHealth
FastLoadType
FaultSymptomCodeType
FcPortState
Feature
FirmwareType
FruType
HardwareStatusCode
IpAddressType
JobType
JobStateType
LabelWindowing
LibraryComplexStateType
LibraryControllerError
LibraryProductionState
LibraryRole
LibraryStateType
LogLevel
MediumType
ModuleType
NetworkSettingsType
PartitionStateType
RequestErrorType
RequestSource
RequestStatus
ResourceName
ResourceState
ResourceType
RobotHardwareStatusCode
RobotHomeEnd
RobotSelector
RobotStatusCode
ScanType
ScsiHostState
SensorType
ServiceIndicatorName
SeviceIndicatorState
SupportBundleOriginator
SupportBundleState
SystemReportType
TopLevelDeviceStateType
A
Implementation Examples
Python
C/C++
B
Secure Development Guide
Generating Code From WSDL Specifications
Transport Layer Security
Inbound and Outbound Authentication
Authorization by Role
Scripting on this page enhances content navigation, but does not change the content in any way.