1 Library Inbound Methods

Request Methods

getRequest()

Returns the status of a submitted request. This method allows the client to query for the completion status of an asynchronous operational request.

Inputs Outputs Roles Errors
long requestId RequestDto All None

getRequests()

Returns a list of RequestDto ordered chronologically based on the request's createDateTime from newest to oldest. If you specify null for firstTimeStamp, the library returns the newest "count" requests, otherwise the returned requests will be before firstTimeStamp.

Inputs Outputs Roles Errors
int count

date firstTimeStamp

 List of RequestDto All None

cancelRequest()

Cancels a submitted request.

Inputs Outputs Roles Errors
long requestId RequestDto C2,S1,I NotFoundException

getLocalizedRequestMessages()

Returns an ordered set of request output messages localized to the specified locale. Output messages are in chronoligical order, oldest to newest. Use getSupportedLocales() for a list of valid locales.

Inputs Outputs Roles Errors
long requestId,

string locale

 List of RequestOutputMessageDto All NotFoundException (request, locale)

getSupportedLocales()

Returns a list of strings for the locales supported for email messages and for getLocalizedRequestMessages().

Inputs Outputs Roles Errors
None List of string supportedLocales All None

waitForRequest()

Waits for a submitted request to complete. Returns when the request completes or when the timeout expires.

Inputs Outputs Roles Errors
long requestId,

int timeout (in seconds)

 RequestDto All NotFoundException

Library Complex Methods

Use the library complex methods to manage the library complex as a whole.

getLibraries()

Returns a list of information for each library in the complex.

Inputs Outputs Roles Errors
None List of LibraryDto All Authentication Exception, Yapi Exception

getLibraryComplex()

Returns information about the library complex.

Inputs Outputs Roles Errors
None LibraryComplexDto All Authentication Exception, Yapi Exception

getLibraryComplexCartridges()

Returns a list of cartridges for the entire library complex. The LibraryComplexDto includes a count of the number of cartridges in the library complex.

Inputs Outputs Roles Errors
CellTypeSelector cellType,

int first,

int count

 List of CartridgeDto All Authentication Exception, Yapi Exception

getLibraryComplexCells()

Returns a list of cells and their contents for the entire library complex. The LibraryComplexDto includes a count of the number of cells in the library complex. The CellTypeSelector determines the type of cells returned.

Inputs Outputs Roles Errors
CellTypeSelector cellType,

int first,

int count

 List of CellDto All Authentication Exception, Yapi Exception

getLibraryComplexCleaningCartridges()

Returns a list of cleaning cartridges for the entire library complex. The LibraryComplexDto includes a count of the number of cleaning cartridges in the library complex.

Inputs Outputs Roles Errors
int first,

int count

 List of CartridgeDto C1, S1, I Authentication Exception, Yapi Exception

getLibraryComplexDevices()

Returns a list of all devices in the library complex.

Inputs Outputs Roles Errors
DeviceTypeSelector deviceType,

int first,

int count

 List of DeviceDto All Authentication Exception, Yapi Exception

getLibraryComplexDevicesByControlState()

Returns a list of all devices in the library complex with the specified control state.

Inputs Outputs Roles Errors
DeviceTypeSelector deviceType,

ControlState controlState

int first,

int count

 List of DeviceDto All Authentication Exception, Yapi Exception

getLibraryComplexDrives()

Returns a list of all drives in the library complex. The LibraryComplexDto includes a count of the number of drives in the library complex.

Inputs Outputs Roles Errors
int first,

int count

 List of DriveDto All Authentication Exception, Yapi Exception

getLibraryComplexDriveTrays()

Returns a list of all drives in the library complex. The LibraryComplexDto includes a count of the number of drive trays in the library complex.

Inputs Outputs Roles Errors
int first,

int count

 List of DriveTrayDto All Authentication Exception, Yapi Exception

getLibraryComplexModules()

Returns a list of modules for the entire library complex. The LibraryComplexDto includes a count of the number of modules in the library complex.

Inputs Outputs Roles Errors
None List of ModuleDto All Authentication Exception, Yapi Exception

getLibraryComplexSlots()

Returns a list of device slots in the library complex. If a slot contains a device, the device is also returned.

Inputs Outputs Roles Errors
DeviceTypeSelector deviceType,

int first,

int count

 List of SlotDto All Authentication Exception, Yapi Exception

setLibraryComplexName()

Updates the library complex name. Maximum length is 256 characters.

Inputs Outputs Roles Errors
string name None C2,S1,I None

setLibraryComplexBootOptions()

Sets the library startup options. These options affect the next library startup, and only the next library startup. If suppressHasBeenOpened=true,the library does not audit on startup even if you opened the door while the library was off. Only set this option to true if you did not change the cartridge inventory.

Set checkLibraryConfiguartion=true after changing the library module configuration. Set this option to true when adding or removing modules, drive array assemblies, or rotary CAPs. This will force the library to re-examine the modules and rebuild the inventory of modules, devices, and cartridges. The library will perform a full audit.

Inputs Outputs Roles Errors
boolean suppressHasBeenOpened

boolean checkLibraryConfiguartion

 None C3,S2,I Authentication Exception, Yapi Exception

resetLibraryComplexToFactoryDefault()

Resets the library complex to factory default settings. You cannot undo this operation. After performing this operation the library will be in the same state as when it left the factory. Oracle service will be required to initialize the library.

Inputs Outputs Roles Errors
None None S3,I Authentication Exception, Yapi Exception

exportLibraryComplexConfig()

Exports the complete configuration of the library complex to a file. This method uses MTOM to transfer the data to the caller. The client must implement the DataHandler to receive the data from the library.

Inputs Outputs Roles Errors
None DataHandler C1,S1,I Authentication Exception, Yapi Exception

importLibraryComplexConfig()

Imports the complete configuration of the library complex from a file. This method uses MTOM to transfer the data to the library. The client must implement the DataHandler to send data to the library. This method deletes ALL existing library configuration information. You cannot undo this operation. The physical configuration of the library doing the import operation must be identical to the library where the configuration was exported.

Inputs Outputs Roles Errors
DataHandler dataHandler None C3,S2,I Authentication Exception, Yapi Exception, InvalidConfig Exception

updateTimeSettings()

Updates time related settings for the library complex. This includes whether or not to use NTP, a list of NTP servers (at least one required if using NTP), and date and time if not using NTP.

Inputs Outputs Roles Errors
string ntpServers,

boolean ntpEnabled,

boolean forceEnabled

 TimeSettingsDto C2,S1,I Authentication Exception, Yapi Exception, InvalidConfig Exception

Library Methods

Use these methods to view and set the configuration for a library.

getLibrary()

Returns a information for the specified library.

Inputs Outputs Roles Errors
long libraryId LibraryDto All Authentication Exception, Yapi Exception

getLibraryCells()

Returns a list of cells and their contents for the specified library. The list starts at 0. The first parameter allows the user to page through the list by providing a different starting element in the list.

Inputs Outputs Roles Errors
long libraryId

CellTypeSelector cellType,

int first,

int count

 List of CellDto for the library All Authentication Exception, Yapi Exception

getLibraryCartridges()

Returns a list of cartridges for a library. The list starts at 0. The first parameter allows the user to page through the list by providing a different starting element in the list.

Inputs Outputs Roles Errors
long libraryId

CellTypeSelector cellType,

int first,

int count

 List of CartridgeDto for the library All Authentication Exception, Yapi Exception

getLibraryDevices()

Returns a list of devices in the specified library. The list starts at 0. The first parameter allows you to page through the list by providing a different starting element in the list.

Inputs Outputs Roles Errors
long libraryId

DeviceTypeSelector deviceType,

int first,

int count

 List of DeviceDto for the library All Authentication Exception, Yapi Exception

getLibraryDrives()

Returns a list of drives in the library. The list starts at 0. The first parameter allows you to page through the list by providing a different starting element in the list.

Inputs Outputs Roles Errors
long libraryId

int first,

int count

 List of DriveDto for the library All None

getLibraryDriveTrays()

Returns a list of drive trays for a library. The list starts at 0. The first parameter allows you to page through the list by providing a different starting element in the list.

Inputs Outputs Roles Errors
long libraryId

int first,

int count

 List of DriveTrayDto for the library All Authentication Exception, Yapi Exception

getCell()

Returns a single cell and its contents.

Inputs Outputs Roles Errors
long cellId CellDto All Authentication Exception, Yapi Exception

getCellByLrcsr()

Returns a single cell based on the library, rail, column, side, row numbers.

Inputs Outputs Roles Errors
int libraryNumber,

int railNumber,

int columnNumber,

int sideNumber,

int rowNumber

 CellDto All Authentication Exception, Yapi Exception

setLibraryName()

Updates the library name. Maximum name length is 256 characters.

Inputs Outputs Roles Errors
long libraryId

string name

 None C3,S2,I Authentication Exception, Yapi Exception

changeLibraryState()

Takes the library offline or brings the library online. If the library cannot change state immediately, the call returns a RequestDto so you can track the state of the request. When taking the library offline, the library completes any in-progress moves, but rejects new moves.

Inputs Outputs Roles Errors
long libraryId

ControlState state

 RequestDto C2,S1,I Authentication Exception, Yapi Exception

enableRedundantElectronics()

Informs the library to use dual controller cards. If you enable RE with only one controller installed, the library will assume one controller has failed and will generate a fault. If there are two controllers installed and you do not enable RE, the library only uses the card in library controller slot 1.

Inputs Outputs Roles Errors
boolean enable None S1,I None

Module Methods

Most module methods require a moduleId. You can use the output of getLibraryComplexModules() to obtain the moduleId.

getModule()

Returns module information for a specific moduleId.

Inputs Outputs Roles Errors
long moduleId ModuleDto All None

getModuleCartridges()

Returns a list of cartridges for a module. The ModuleDto includes a count of the number of cartridges in the module.

Inputs Outputs Roles Errors Status
long moduleId,

int first,

int count

 List of CartridgeDto for the module All None Functional. returns empty list

getModuleCells()

Returns a list of cells and their contents for a module. The ModuleDto includes a count of the number of cells in the module. The CellTypeSelector determines the type of cells returned.

Inputs Outputs Roles Errors Status
long moduleId,

CellTypeSelector cellType,

int first,

int count

 List of CellDto for the module All NotFoundException (module) Functional. returns empty list

getModuleDevices()

Returns a list of devices in the module.

Inputs Outputs Roles Errors Status
long moduleId,

DeviceTypeSelector deviceType,

int first,

int count

 List of DeviceDto for the module All NotFoundException (module) Functional. Missing Service

getModuleDriveTrays()

Returns a list of drive trays present in the specified module.

Inputs Outputs Roles Errors Status
long moduleId,

int first,

int count

 List of DriveTrayDto for the module All NotFoundException (module) Functional. returns empty list

getModuleSlots()

Returns a list of device slots in the module. If a slot contains a device, this method also returns the device.

Inputs Outputs Roles Errors
long moduleId,

DeviceTypeSelector deviceType,

int first,

int count

 List of SlotDto for the module All NotFoundException (module)

Device Methods

Most device methods require a deviceId. You can use getLibraryComplexDevices(), getLibraryDevices(), or getModuleDevices() to obtain a deviceId.

getDevice()

Returns a DeviceDto for a specific deviceId.

Inputs Outputs Roles Errors
long deviceId DeviceDto All None

getDeviceCartridges()

Returns a list of cartridges for a device.

Inputs Outputs Roles Errors
long deviceId,

int first,

int count

 List of CartridgeDto for the device All NotFountException (device)

getDeviceCells()

Returns a list of cells and their contents for the device. The type parameter determines the type of cells returned

Inputs Outputs Roles Errors
long deviceId,

CellTypeSelector cellType,

int first,

int count

 List of CellDto for the device All NotFountException (device)

getDeviceSensors()

Inputs Outputs Roles Errors
long deviceId List of SensorDto All NotFountException (device)

getDeviceSlots()

Returns a list of slots in the device. If a slot contains a device, the method also returns the device.

Inputs Outputs Roles Errors
long deviceId,

int first,

int count

 List of SlotDto for the slots in the device All NotFountException (device)

getDeviceTelemetry()

Returns device telemetry for the specified deviceId. Returns count measurements taken after the timestamp.

Inputs Outputs Roles Errors
long deviceId,

long sensorId,

date timestamp,

int count

 TelemetryDto All NotFountException (device)

getContainedDevices()

Returns a list of devices contained within a device. For instance, the card cage in the Base module will contain multiple devices. The deviceId you input corresponds to the parentDeviceId that returns in the DeviceDto.

Inputs Outputs Roles Errors
long deviceId,

DeviceTypeSelector deviceType,

int first,

int count

 List of DeviceDto contained in the device All NotFountException (device)

getFruIdData()

Returns FRU data for a specific device.

Inputs Outputs Roles Errors
long deviceId FruIdDto S1, I None

bringDeviceOnline()

Brings a device online (changes the control state). When using this method to bring a rotational CAP online, all CAPs upstream (closer to the Base) of the specified CAP must be online. After the specified CAP is online, the library brings all CAPs downstream (farther from the Base) of the specified CAP online.

Inputs Outputs Roles Errors
long deviceId RequestDto C2,S1,I None

takeDeviceOffline()

Takes a device offline (changes the control state). You cannot take an FC port offline.

Inputs Outputs Roles Errors
long deviceId,

boolean force

 RequestDto C2,S1,I None

enableOnlining()

Enables the device in the specified slot to change to the "online" control state. When you insert a device into a slot that has onlining enabled, the library will automatically bring the device online. This is the default behavior for all slots.

Inputs Outputs Roles Errors
DeviceTypeSelector deviceType,

int moduleNumber,

int slotNumber

 None C2,S1,I None

inhibitOnlining()

Prevents the device in the specified slot from changing to the "online" control state. When you insert a device into a slot that has onlining inhibited, the library will hold the device offline. You must manually bring the device online.

Inputs Outputs Roles Errors
DeviceTypeSelector deviceType,

int moduleNumber,

int slotNumber

 None C2,S1,I None

turnDeviceOn()

Turns on a device.

Inputs Outputs Roles Errors
long deviceId RequestDto C2,S1,I None

turnDeviceOff()

Turns off a device.

Inputs Outputs Roles Errors
long deviceId RequestDto C2,S1,I None

setLedState()

Sets the state of an LED.

Inputs Outputs Roles Errors
long deviceId,

ServiceIndicatorName ledName,

SeviceIndicatorState ledState

 DeviceDto C2,S1,I None

locateDevice()

Enables or disables the flashing LED on a FRU. The OK to remove LED flashes. If the device does not have an OK to remove LED, the service LED flashes.

Inputs Outputs Roles Errors
long deviceId,

boolean enabled

 None C1,S1,I NotFountException (device)

pingDevice()

This method attempts to communicate with the specified device to verify the device is not only on the internal network, but also that the device is functioning property. You can only successfully ping devices that communicate on the internal network.

Inputs Outputs Roles Errors
long deviceId PingDeviceResultsDto C2,S1,I NotFountException (device)

resetDevice()

Resets a device and returns a request. This method may not complete immediately if the device has in-progress work to complete. The force option overrides any delays and immediately resets the device. You can reset the library controllers, root switches, storage, video, dc converter, rail controller, drive switch, drive controller, robot controller, feature card, robot, and encryption card.

Inputs Outputs Roles Errors
long deviceId,

boolean force

 RequestDto C2,S1,I NotFountException (device)

DeviceNotResettableException

Robot Methods

downloadRobotLog()

Returns device log for the specified robot. The client must provide a DataHandler to receive and store the contents of the log file.

Inputs Outputs Roles Errors
long deviceId DataHandler C2,S1,I NotFoundException (robot)

getCellDepth()

Returns the cell depth from the last reach operation. Depth of cells is in mils (thousandths of an inch.)

Inputs Outputs Roles Errors
long deviceId RobotCellDepthDto S2,I NotFoundException (robot)

getRailSegmentResourceHistory()

Returns a list of rail segment resource history.

Inputs Outputs Roles Errors
int first,

int count

 List of RailSegmentResourceUsageDto S1,I Authentication Exception, Yapi Exception

getRobot()

Returns information about a robot. This method is similar to getDevice() for a robot device, but RobotDto has more details than DeviceDto.

Inputs Outputs Roles Errors
long robotId RobotDto All None

getRobots()

Returns information for all robots in a library.

Inputs Outputs Roles Errors
long libraryId List of RobotDto All None

getRobotCalibration()

Returns robot calibration data for a given cell. Even though the method takes a cellId, calibration actually refers to the cell array that contains the specified cell.

Inputs Outputs Roles Errors
long deviceId,

long cellId

 RobotCalibrationDto S2,I NotFoundException (robot, cell)

getRobotHistory()

Returns a list of robot movement records.

Inputs Outputs Roles Errors
RobotSelector robot,

int first,

int count

 List of RobotPositionHistoryDto S1,I Authentication Exception, Yapi Exception

getRobotMetrics()

Returns metrics for the robot. The direction can be LEFT or RIGHT. Returns a list with one element for each mechanism.

Inputs Outputs Roles Errors
long deviceId,

string direction

 List of RobotMetricsDto S1,I NotFoundException (robot)

getRobotParameters()

Returns robot parameters. These are set by the library during initialization.

Inputs Outputs Roles Errors
long deviceId RobotParametersDto S1,I NotFoundException (robot)

getRobotRange()

Returns range data for the robot. Returns a list with one element for each mechanism.

Inputs Outputs Roles Errors
long deviceId List of MotionRangeDto S1,I NotFoundException (robot)

getRobotStatistics()

Returns robot telemetry data.

Inputs Outputs Roles Errors
long deviceId RobotStatisticsDto S1,I NotFoundException (robot)

CAP Methods

The CAP methods apply to rotational and AEM CAPs.

See Also

What is a capHandle?

Before sending any of the CAP operational methods (open, close, and so on), use setCapOwner() to acquire a capHandle and reserve the CAP. Even if the CAP is dedicated to a partition, you must use setCapOwner() to acquire a capHandle.

changeCapState()

Places the CAP online or offline.

Inputs Outputs Roles Errors
long capId

ControlState state

 RequestDto C2, S1, I NotFoundException (CAP)

getCap()

Returns information about a specific CAP.

Inputs Outputs Roles Errors
long capId CapDto All None

getCaps()

Returns information about a all CAPs in the library complex.

Inputs Outputs Roles Errors
None List of CapDto All None

getCapRange()

Returns range data for a CAP.

Inputs Outputs Roles Errors
long capId MotionRangeDto S2,I NotFoundException (CAP)

getCapStatistics()

Returns CAP telemetry data.

Inputs Outputs Roles Errors
long capId CapStatisticsDto S1,I NotFoundException (CAP)

lockCap()

Logically locks a CAP. While in the locked state, the library disables all means of opening the CAP, allowing the robot to safely access the CAP. To lock a CAP, it must be closed, online, and owned by a non-SCSI partition.

Inputs Outputs Roles Errors
long capHandle CapDto C1,S1,I InvalidCapHandle, NotClosedException

unlockCap()

Unlocks a CAP so that an operator can open it. When unlocked, the robot cannot access the CAP cells. To unlock a CAP, it must be closed, online, owned by a partition (or controlled by the UI), and not currently in use by the robot.

Inputs Outputs Roles Errors
long capHandle CapDto C1,S1,I InvalidCapHandle, NotClosedException

openCap()

Opens an unlocked CAP. Equivalent to pressing the button on a closed CAP.

Inputs Outputs Roles Errors
long capHandle RequestDto C1,S1,I InvalidCapHandle, NotLockedException

closeCap()

Closes an open CAP. Equivalent to pressing the button on an open CAP. Once closed, the library audits the CAP cells and adds the cartridges to the partition that owns the CAP. The library moves any cleaning cartridges to system cells.

Inputs Outputs Roles Errors
long capHandle RequestDto C1,S1,I InvalidCapHandle, NotLockedException

setCapOwner()

Assigns ownership of a CAP to a specific partition and provides a capHandle. A partition must own a CAP to export or import cartridges with the CAP.

Note:

Even if the CAP is dedicated to a partition, you must use setCapOwner() to acquire a capHandle.

Any moves to or from a CAP not owned by the partition will fail. A partition can only own CAPs in the CAP pool assigned to the partition. If a CAP pool is assigned to only one partition, the partition automatically owns the CAPs in that pool. setCapOwner() returns capHandle, which you can use as input on operations that require an owned CAP.

Inputs Outputs Roles Errors
long capId,

long partitionId

 long capHandle C1,S1,I NotFoundException (partition, cap), OwnedException, NotLockedException

freeCap()

Removes ownership of the CAP from a partition. The CAP must be locked and empty. An application should free a shared CAP after completing CAP operations so that the CAP is available for other partitions. This method has no effect on CAPs in a dedicated CAP pool.

Inputs Outputs Roles Errors
long capHandle CapDto C1,S1,I InvalidCapHandle, NotLockedException, NotEmptyException

forceFreeCap()

Removes ownership of the CAP from a partition. An administrator can remove ownership of a CAP from a partition in the event the library or an application fails to properly release the CAP. This will result in a call to the capOwnershipOverridden() outbound method.

Inputs Outputs Roles Errors
long capId CapDto C2,S1,I NotFoundException (CAP), NotLockedException, NotEmptyException

getCapPool()

Returns the CAPs in the CAP pool.

Inputs Outputs Roles Errors
long CapPoolId CapPoolDto All None

getCapPools()

Returns a list of all CAP pools, including the CAPs in each pool.

Inputs Outputs Roles Errors
None List of CapPoolDto All None

createCapPool()

Creates a CAP pool. The partitioning hardware activation file (HWAF) must be installed to create CAP pools.

Inputs Outputs Roles Errors
string name CapPoolDto C2, S1, I HwafNotPresentException

deleteCapPool()

Deletes a CAP pool if there are no CAPs in the pool.

Inputs Outputs Roles Errors
long capPoolId None C2, S1, I NotFoundException (CAP)

moveCapToCapPool()

Moves a CAP from its current CAP pool to another CAP pool.

Inputs Outputs Roles Errors
long capId

long capPoolId

 CapPoolDto C2, S1, I NotFoundException (CAP, CAP pool), CapErrorException

Drive Methods

Drive trays contain a tape drive, an LOD card, an LOID card, a power supply for the drive, and (in some cases) an encryption card. Drive trays slide into drive slots at the back of the library. Drive tray and drive are sometimes used interchangeably.

getCompatibleDriveTypes()

Returns a list of drive types that are compatible with the cartridge family and generation. The inLibrary parameter determines if the method returns all compatible drive types or only those drive types currently found in the library.

Inputs Outputs Roles Errors
string cartridgeFamily

string cartridgeGeneration

boolean inLibrary

 List of DriveTypeDto All None

getCompatibleMediaTypes()

Returns a list of cartridges types compatible with the specified drive family and generation. The inLibrary parameter determines if the method returns all compatible cartridge types or only the cartridge types currently in the library.

Inputs Outputs Roles Errors
string driveFamily

string driveGeneration

boolean inLibrary

 List of CartridgeTypeDto All None

getDriveTray()

Returns information about a tray and its contents. This is similar to getDevice() for a drive tray device, but returns a DriveTrayDto which has additional, drive tray specific information.

Inputs Outputs Roles Errors
long driveTrayId DriveTrayDto All None

getDriveTypes()

Returns a list of DriveTypeDto, each with info about one drive type. The inLibrary parameter determines if the method returns all supported drive types or only those drive types currently found in the library.

Inputs Outputs Roles Errors
boolean inLibrary List of DriveTypeDto All None

getDrive()

Returns information about a drive. This is similar to getDevice() for a drive tray device, but returns a DriveDto which has additional, drive specific information.

Inputs Outputs Roles Errors
long driveId DriveDto All None

updateDrive()

Updates attributes of a drive. The drive ID from the input drive object is used to locate a drive in the database. All updated attributes in the drive object are then updated into the database.

Inputs Outputs Roles Errors
DriveDto DriveDto C2,S1,I NotFoundException (drive)

cleanDrive()

Cleans the specified drive using a compatible cleaning tape from a system cell.

Inputs Outputs Roles Errors
long driveId RequestDto C1, S1, I None

getFirmwareUpgradeActivity()

Display a history of firmware upgrade operations for a drive.

Inputs Outputs Roles Errors
long driveId List of FirmwareUpgradeEventDto C3,S1,I None

Cartridge Methods

The async parameter determines when the method returns. If async=false, the method does not return until the cartridge mounts. If async=true, the method returns once the request is submitted. If you submit the request asynchronously, you can use getRequest()to determine when the move completes.

getCartridgeByCellId()

Returns information about a single cartridge in the specified a cellId.

Inputs Outputs Roles Errors
long cellId CartridgeDto All Authentication Exception, Yapi Exception

getCartridgeByVolser()

Returns information about one cartridge for the given volser. Only use this method when you know there is only one cartridge with that volser. If multiple results are possible, use getAllCartridgesByVolser() instead.

Inputs Outputs Roles Errors
string volser CartridgeDto All Authentication Exception, Yapi Exception

getAllCartridgesByVolser()

Returns information about all cartridges for the given volser (use if there are duplicate volsers).

Inputs Outputs Roles Errors
string volser List of CartridgeDto All Authentication Exception, Yapi Exception

getAllCartridgesByVolsers()

Returns information about all cartridges for the given set of volsers.

Inputs Outputs Roles Errors
Set of string volsers List of CartridgeDto All Authentication Exception, Yapi Exception

getCartridgeTypes()

Returns a list of supported cartridge types. The inLibrary parameter determines if the call retrieves information on all supported cartridge types (false) or only those currently in the library (true).

Inputs Outputs Roles Errors
boolean inLibrary List of CartridgeTypeDto All Authentication Exception, Yapi Exception

mountCartridgeByCellId()

Mounts a cartridge on a tape drive by specifying the cell id of the cartridge source (cellId) and the cell id of the destination drive (destinationCellId). The destinationCellId is the cell id for the drive, not the drive id. If readOnly is true, the drive makes the cartridge read-only.

Inputs Outputs Roles Errors
long sourceCellId,

long destinationCellId,

boolean readOnly,

boolean async

 RequestDto C2Foot 1 ,S1,I IllegalArgumentException if source is a drive or destination is not a drive.

NotFoundException (source cell/cartridge (if volser), drive),

InvalidMoveException (source empty, destination full)

Footnote 1 C2 users can only mount cartridges to drives within the same partition, while C3, service, and installation roles can mount cartridges to any drive.

mountCartridgeByVolser()

Mounts a cartridge on a tape drive by specifying the volume serial number (volser) of the cartridge and the cell id of the destination drive (destinationCellid). The destinationCellId is the cell id for the drive, not the drive id. If readOnly is true, the drive makes the cartridge read-only.

Inputs Outputs Roles Errors
string volser,

long destinationCellId,

boolean readOnly,

boolean async

 RequestDto C2Foot 1 ,S1,I IllegalArgumentException if source is a drive or destination is not a drive.

NotFoundException (source cell/cartridge (if volser), drive),

InvalidMoveException (source empty, destination full)

Footnote 1 C2 users can only mount cartridges to drives within the same partition, while C3, service, and installation roles can mount cartridges to any drive.

moveCartridgeByCellId()

Moves a cartridge from the source cell (cellId) to the destination cell (destinationCellId). Neither source nor destination can be a tape drive.

Caution:

Moving cartridges between partitions may confuse some applications requiring you to re-sync the application with the library.
Inputs Outputs Roles Errors
long sourceCellId,

long destinationCellId,

boolean async

 RequestDto C1Foot 1 ,S1,I IllegalArgumentException if source or destination is a drive.

NotFoundException (source cell/cartridge (if volser), destination cell),

InvalidMoveException (source empty, destination full)

Footnote 1 C1 users can only move cleaning cartridges to and from a CAP. C2 users can only move cartridges to cells within the same partition, while C3, service, and installation roles can move cartridges to any cell.

moveCartridgeByVolser()

Moves a cartridge by specifying the volume serial number (volser) of the cartridge and a destination cell id (destinationCellId). Neither source nor destination can be a tape drive.

Caution:

Moving cartridges between partitions may confuse some applications requiring you to re-sync the application with the library.
Inputs Outputs Roles Errors
string volser,

long destinationCellId,

boolean async

 RequestDto C1Foot 1 ,S1,I IllegalArgumentException if source or destination is a drive.

NotFoundException (source cell/cartridge (if volser), destination cell),

InvalidMoveException (source empty, destination full)

Footnote 1 C1 users can only move cleaning cartridges to and from a CAP. C2 users can only move cartridges to cells within the same partition, while C3, service, and installation roles can move cartridges to any cell.

dismountCartridgeByCellId()

Dismounts a tape cartridge from the drive specified by cellId and moves the tape to the cell specified by destinationCellId. The cellId is the cell id for the drive, not the drive id. If force is true, the library issues a rewind/unload command to the drive before removing the tape.

Caution:

Moving tapes between partitions may confuse some applications requiring you to re-sync the application with the library.
Inputs Outputs Roles Errors
long sourceCellId,

long destinationCellId,

boolean force,

boolean async

 RequestDto C2Foot 1 ,S1,I IllegalArgumentException if source is not a drive or destination is a drive.

NotFoundException (drive, destination cell),

InvalidMoveException (source empty, destination full)

Footnote 1 C2 users can only dismount cartridges to cells within the same partition, while C3, service, and installation roles can dismount cartridges to any cell.

dismountCartridgeByVolser()

Dismounts a tape cartridge from a tape drive. The volser specifies the tape to be dismounted and destinationCellId specifies the destination. When drive dismounts a tape, the library returns it to the specified cell. If force is true, the library issues a rewind/unload command to the drive before removing the tape.

Inputs Outputs Roles Errors
string volser,

long destinationCellId,

boolean force,

boolean async

 RequestDto C2Foot 1 ,S1,I IllegalArgumentException if source is not a drive or destination is a drive.

NotFoundException (drive, destination cell),

InvalidMoveException (source empty, destination full)

Footnote 1 C2 users can only dismount the cartridges to cells within the same partition, while C3, service, and installation roles can dismount cartridges to any cell.

getLostCartridges()

Returns a list of cartridge information for the lost cartridges.

Lost cartridges can occur when the library finds a cartridges in a robot hand during library startup and the library cannot determine the proper location for the cartridge. The library will examine jobs that were in progress when the library went down to attempt to find the source cell for the cartridge. It it cannot find the source cell, the library will leave the cartridge in system a cell and notify all connected applications using the lostCartridges() outbound SCI method.

Inputs Outputs Roles Errors
None List of CartridgeDto C1,S1,I None

moveLostCartridge()

Moves a lost cartridge by specifying the ID of the cartridge and a destination cell. The destination cannot be a tape drive. The lostCartridgeId is from the CartridgeDto returned by getLostCartridges().

Inputs Outputs Roles Errors
long lostCartridgeId,

long destinationCellId

boolean async

 RequestDto C1,S1,I NotFoundException (cartridge, cell)

Partitioning Methods

The initial configuration of a library complex has a single default physical partition that contains all drive bays, all drives, all active storage cells, and all cartridges. You can create additional partitions if partitioning is enabled for the library complex. The output of getLibraryComplex() contains a list of partitionIds. Most partition methods take a partitionId as an input.

changePartitionState()

Sets the partition ONLINE or OFFLINE. If offline, the partition will reject any host commands. If online, the partition will accept and process host commands.

The library automatically takes a partition offline if you modify the partition and then brings the partition back online when the modification completes. This can result in many state changes. To limit the number of state changes, you can use changePartitionState() before performing a series of modifications to a partition. If the state change cannot happen immediately, a RequestDto returns so that you can track the state of the request.

Inputs Outputs Roles Errors
long partitionId,

ControlState state

 RequestDto C3,S2,I NotFoundException (partition)

createPartition()

Creates a partition. The partition can be a SCSI medium changer device, which means you can access it as a SCSI medium changer device over the FC interfaces. The resulting partition will not contain any cells or drives.

To use this method, you enable partitioning on the library complex.

Inputs Outputs Roles Errors
string partitionName,

boolean scsiAllowed,

boolean driveSpoofing,

boolean libraryAutoCleaningEnabled,

LabelWindowing labelWindowSetting,

int capPoolId

FastLoadType fastLoadType

 PartitionDto C3,S2,I HwafNotFoundException

deletePartition()

Deletes a partition if there are no cartridges and no drive slots in the partition.

Inputs Outputs Roles Errors
long partitionId None C3,S2,I NotFoundException (partition)

getPartition()

Returns information for a specific partition.

Inputs Outputs Roles Errors
long partitionId PartitionDto All Authentication Exception, Yapi Exception

getPartitions()

Returns a list of all partitions.

Inputs Outputs Roles Errors
None List of PartitionDto All Authentication Exception, Yapi Exception

getPartitionCaps()

Returns a list of CAPs available to the partition. These are the CAPs in the CAP pool assigned to the partition.

Inputs Outputs Roles Errors
long partitionId List of CapDto All NotFoundException (partition)

getPartitionCartridges()

Returns a list of cartridges for a partition. getPartition() includes a count of the number of cartridges in the partition.

Inputs Outputs Roles Errors
long partitionId,

int first,

int count

 List of CartridgeDto All Authentication Exception, Yapi Exception, NotFoundException (partition)

getPartitionCell()

Returns a single cell and its contents.

Inputs Outputs Roles Errors
long partitionId,

long cellId

 CellDto All Authentication Exception, Yapi Exception

getPartitionCells()

Returns a list of cells and their contents for a partition. getPartition() returns PartitionDto, which includes a count of the number of cells in the partition. The optional CellTypeSelector parameter determines the type of cells returned. If cellType is omitted, the method returns all cells.

Inputs Outputs Roles Errors
long partitionId,

CellTypeSelector cellType,

int first,

int count

 List of CellDto All Authentication Exception, Yapi Exception, NotFoundException (partition)

getPartitionDrives()

Returns a list of drives present in the specified partition.

Inputs Outputs Roles Errors
long partitionId,

int first,

int count

 List of DriveDto All NotFoundException (partition)

getPartitionDriveTrays()

Returns a list of drive trays present in the specified partition.

Inputs Outputs Roles Errors
long partitionId,

int first,

int count

 List of DriveTrayDto All Authentication Exception, Yapi Exception, NotFoundException (partition)

moveCellsToPartitionByCellIdList()

Moves cells and cartridges from one partition to another partition. One variant of this method takes a list of cells in the source partition and moves them to the destination partition. If you move a storage cell containing a cartridge, the cartridge also moves to the destination partition. If you move a cartridge, the cell that contains it will also move to the destination partition.

Inputs Outputs Roles Errors
long sourcePartitionId,

long destinationPartitionId

Set of long cellIds

 None C3,S2,I NotFoundException (source partition, destination partition — only if source is valid, cell/cartridge — if volsers used)

moveDriveBaysToPartition()

Moves drive slots from one partition to another partition. If you move a drive slot containing a drive tray, the drive also moves to the destination partition. The drive must be empty before you move it to a new partition. Only one partition can own a drive slot. The drive slot ids are the cellIds for cells of type "Drive".

Inputs Outputs Roles Errors
long sourcePartitionId,

long destinationPartitionId

Set of long cellIds

 None C3,S2,I NotFoundException (source partition, destination partition — only if source is valid, cell)

updatePartition()

Updates settings for the partition.

Inputs Outputs Roles Errors
long partitionId

string partitionName,

boolean scsiAllowed,

boolean driveSpoofing,

boolean libraryAutoCleaningEnabled,

LabelWindowing labelWindowSetting,

int capPoolId

FastLoadType fastLoadType

 PartitionDto C3,S2,I None

setPartitionCapPool()

Sets the CAP pool for a partition.

Inputs Outputs Roles Errors Status
long partitionId,

long capPoolId

 None C2,S1,I None Not implemented.

Not in WSDL

clearPartitionCapPool()

Unassociates all CAP pools from the partition. When complete, the partition has no access to any CAPs.

Inputs Outputs Roles Errors
long partitionId None C2, S1, I ValidationException, NotFoundException, CapErrorException

SCSI Host Methods

createScsiHost()

Creates a SCSI host. This is useful when adding a host to the library before adding the actual host to the SAN.

Inputs Outputs Roles Errors
long wwnn,

long wwpn,

string name

 ScsiHostDto C3, S2, I Authentication Exception, Yapi Exception

getScsiHosts()

Returns a list of known ScsiHostDto, which include hosts automatically detected by the library or hosts added explicitly by a user.

Inputs Outputs Roles Errors
None List of ScsiHostDto All Authentication Exception, Yapi Exception

Audit Methods

An audit verifies cartridge locations and updates the library database. During a physical audit the robot to scans the barcode labels cartridges. The library automatically performs an audit if you open and then close a door, after a restart if you opened a door while the library was powered off, or if you closed a CAP. A user can also initiate an audit.

runAuditOnLibraryComplex()

Initiates a physical audit of the entire library. The robot scans the barcode on all cartridges, and then updates the database. This method always runs asynchronously. Use getRequest() for status of the audit and waitForRequest() to wait for completion or update.

Inputs Outputs Roles Errors
None RequestDto C1,S1,I None

runAuditOnRange()

Initiates a physical audit on a range of cells. The robot scans the barcode on the cartridges in the range, and then updates the database. This method always runs asynchronously. Use getRequest()for the status of the audit and waitForRequest() to wait for completion or update.

The inputs are a upper and lower limits on the library, rail, column, side and row values which define the start and end of the range to be audited, and a set of CellTypeSelector values. The set of CellTypeSelector values filters the result to only the specified type of cells.

Inputs Outputs Roles Errors
int startLibraryNumber,

int startRailNumber,

int startColumnNumber,

int startSideNumber,

int startRowNumber,

int endLibaryNumber,

int endRailNumber,

int endColumnNumber,

int endSideNumber,

int endRowNumber,

Set of CellTypeSelector cellTypes

 RequestDto C2,S1,I NotFoundException (cell - first cell address pair to fail)

Media Validation Methods

During media validation, the library mounts a specified cartridge into a drive from the media validation pool (MV pool). The drive reads all or part of the tape and evaluates its quality. You can only use drives in the MV pool for media validation.

validateCartridgeByCellId()

Initiates media validation on the specified tape cartridge. Select a scan type using the ScanType — EDGE (drive scans the edges of a cartridge for readability), FULL (drive scans the full cartridge for readability), and DIV (T10000C drive scans a cartridge for DIV checksum integrity). This method always runs asynchronously.

Inputs Outputs Roles Errors
long driveId,

long cellId,

ScanType scanType

 RequestDto C1,S1,I NotFoundException (drive, cell/cartridge)

validateCartridgeByVolser()

Initiates media validation on the specified tape cartridge. Select a scan type using the ValidationScanType — EDGE (drive scans the edges of a cartridge for readability), FULL (drive scans the full cartridge for readability), and DIV (T10000C drive scans a cartridge for DIV checksum integrity). This method always runs asynchronously.

Inputs Outputs Roles Errors
long driveId,

string volser,

ScanType scanType

 RequestDto C1,S1,I NotFoundException (drive, cell/cartridge (when using volser))

Diagnostic Testing Methods

getDiagnosticTests()

Returns a list of diagnostic test definitions that a user can execute using runDiagnosticTest(). Refer to the SL4000 Library Guide for a description of available diagnostic tests.

Inputs Outputs Roles Errors
None List of DiagnosticTestDto C2,S1,I None

runDiagnosticTest()

Starts a diagnostic test based on the testName (which you can get from getDiagnosticTests()). You supply the test parameters using two sting lists. One list is the names of the parameters and the second list contains the values.

The async parameter determines when the method returns. If async=false, the method does not return until the test completes. If async=true, the method returns once the request is submitted. You can then use getRequest()to determine when the test completes.

Inputs Outputs Roles Errors
string testName,

List of string paramNames,

List of string paramValues,

boolean async

 RequestDto C2,S1,IFoot 1  NotFoundException (diagnostic test) InvalidTestParameters

Footnote 1 Only S2 and I users can run robot related diagnostic tests.

Hardware Feature Activation (HWAF) Methods

installHwaf()

Installs a hardware activation file (HWAF). HWAFs activate optional library features such as dual TCP/IP feature and active capacity.

Inputs Outputs Roles Errors
String of HAWF contents in BASE64 format HwafDto C2, S1, I  

removeHwaf()

Removes a hardware activation file (HWAF) and its corresponding feature.

Inputs Outputs Roles Errors
long id None C2, S1, I InvalidConfigException (malformed hwaf)

removeAllHwafs()

Removes all installed hardware activation files (HWAFs).

Inputs Outputs Roles Errors
None None C3, S1, I  

getHwafs()

Returns a list of installed hardware activation files (HWAFs).

Inputs Outputs Roles Errors
None List of HwafDto All NotFoundException (hwaf)

getActivtedFeatures()

Returns a list the features enabled by hardware activation files (HWAFs).

Inputs Outputs Roles Errors
None List of ActivatedFeatureDto All  

getHwafActivtyLog()

Displays a log of hardware activation file (HWAF) activity, listing the date and type of every hardware activation file installed or removed.

Inputs Outputs Roles Errors
None List of HwafActionDto C2, S1, I  

Network Configuration Methods

getCustomerNetworkSettings()

Returns all configuration settings of the customer network interfaces for the library complex.

Inputs Outputs Roles Errors
long libraryId NetworkSettingsDto All None

getOkmNetworkSettings()

Returns all configuration settings of the OKM network interfaces for the library complex.

Inputs Outputs Roles Errors
long libraryId NetworkSettingsDto All None

getServiceNetworkSettings()

Returns all configuration settings of the Service network interfaces for the library complex.

Inputs Outputs Roles Errors
long libraryId NetworkSettingsDto All None

libraryTraceRoute()

Traces the route to a specified network address or hostname from the library.

Inputs Outputs Roles Errors
string destinationIPAddress (IP address or Hostname) TraceRouteResultsDto C2,S1,I TraceRouteResultsDto

pingNetworkAddress()

Performs a ping from the library to a specified network address or hostname.

Inputs Outputs Roles Errors
string destinationIpAddress (IP address or Hostname) List of string pingResults C2,S1,I None

resetNetworkSettings()

Resets all the network settings to factory defaults.

Inputs Outputs Roles Errors
None None C2,S2,I None

setPingResponse()

Enables or disables responding to ping protocol on the library interfaces. You can optionally specify a specific network to disable/enable.

Inputs Outputs Roles Errors
boolean enable None C2,S2,I None

Library Firmware Upgrade Methods

The getLibraryComplex() and getLibrary() outputs include information about the current and available versions of library firmware. All libraries have two versions of code: active and inactive.

See Also

uploadLibraryFirmware()

Uploads and validates the firmware upgrade. The uploaded firmware replaces the inactive version. The library will block installation of a software version if it is incompatible with the hardware.

Inputs Outputs Roles Errors
DataHandler LibraryFirmwareDto C2,S1,I IO Exception

activateLibraryFirmware()

Activates a firmware upgrade and causes the library to restart. The force parameter skips checking the version compatibility, which wipes out all configuration data on the library.

Inputs Outputs Roles Errors
boolean force RequestDto C2,S1,I None

User Role Methods

createUser()

Creates a new user.

Inputs Outputs Roles Errors
string username,

string password

string description

 None C3, S2, I None

deleteUser()

Deletes a user.

Inputs Outputs Roles Errors
string username None C3, S1, I None

changeUserRole()

Changes the role of a user.

Inputs Outputs Roles Errors
string username,

LibraryRole role

 None C3, S2, I None

changeUserPassword()

Changes the password of a user.

Inputs Outputs Roles Errors
string username,

string oldPassword

string newPassword

 None C3, S1, I None

Fault and Library Log Methods

clearFault()

Sets the fault status to "cleared". This does not delete the fault, but acknowledges you have seen it.

Inputs Outputs Roles Errors
long id FaultDto S1,I NotFoundException (fault)

createSupportBundle()

Creates a support bundle manually (which includes a snapshot of the library log). If async=true, the bundle generates asynchronously and you will have to query for the status of the support bundle using the requestId. If async=false, the method returns when it completes.

Inputs Outputs Roles Errors
boolean async SupportBundleDto C2,S1,I None

createTestEvent()

Generates a "test event". You can use this to verify the event sends properly to notification destinations. See also test().

Inputs Outputs Roles Errors
None RequestDto C2,S1,I NotFoundException (fault)

deleteSupportBundle()

Deletes a support bundle from the library complex.

Inputs Outputs Roles Errors
long supportBundleId None C2,S1,I NotFoundException (support bundle)

downloadSupportBundle()

Returns the contents of a support bundle. The client application must create a DataHandler to receive the data and store locally.

Inputs Outputs Roles Errors
long supportBundleId DataHandler C2,S1,I NotFoundException (support bundle)

getFault()

Returns a specific Device Event object.

Inputs Outputs Roles Errors
long id FaultDto C2,S1,I IllegalArgumentException

getFaults()

Returns a list of device event objects where event type is FAULT, limited by count. The library sorts faults chronologically, from newest to oldest. You can optional use firstTimestamp to specify the starting timestamp of the faults retrieved. If you specify firstTimestamp, this method returns faults before this time. To retrieve a long list of faults, use multiple calls with the time from the last fault for the newest parameter on the next call.

Inputs Outputs Roles Errors
int count,

date firstTimeStamp

 List of FaultDto C2,S1,I None

getLogEntries()

Returns a list of log entries, limited by count. You can optional use firstLine to specify the starting line number the log entries retrieved. To retrieve a long list of entries, use multiple calls with the next line number from the last log entry for the firstLine parameter on the next call.

Use the filter string to select only matching entries from the log. Initially, filtering is limited to specifying a single value for a specific parameter. The method only returns entries containing that value.

Inputs Outputs Roles Errors
sting filter (optional),

int firstLine,

int count

 List of logs as string All None

getLoggerLogEntries()

Returns a list of logger log entries, limited by count. The library sorts log entries chronologically, from newest to oldest. You can optional use firstLine to specify the starting timestamp of the entries retrieved. To retrieve a long list of entries, use multiple calls with the time from the last fault for the newest parameter on the next call.

Use the filter string to select only matching entries from the log. Initially, filtering is limited to specifying a single value for a specific parameter. The method only returns entries containing that value.

Inputs Outputs Roles Errors
int firstLine,

int count

sting filter (optional),

 List of logs as string All None

getLoggingLevel()

Returns the current log level settings for a specific SL4000 logger.

Inputs Outputs Roles Errors
string loggerName LogLevel loggingLevel All NotFoundException (logger)

getLoggingLevels()

Returns the current log level settings for all SL4000 loggers.

Inputs Outputs Roles Errors
None List of LoggingLevelDto All None

getSupportBundle()

Returns a Support Bundle object with information about a specific support bundle (does not return the actual support bundle). Use downloadSupportBundle() to retrieve the actual support bundle.

Inputs Outputs Roles Errors
long supportBundleId SupportBundleDto C2,S1,I None

getSupportBundles()

Returns the support bundles present in the library complex (does not return the actual support bundle). Use downloadSupportBundle() to retrieve the actual support bundle.

Inputs Outputs Roles Errors
None List of SupportBundleDto C2,S1,I None

getSystemReport()

Returns a specific system report object.

Inputs Outputs Roles Errors
long id SystemReportDto C2,S1,I IllegalArgumentException

getSystemReports()

Returns a list of system report objects, limited by count. The library sorts system reports chronologically, from newest to oldest. You can optional use firstTimestamp to specify the starting timestamp of the reports retrieved. To retrieve a long list of reports, use multiple calls with the time from the last system report for the newest parameter on the next call.

Inputs Outputs Roles Errors
int count,

date firstTimeStamp

 List of SystemReportDto C2,S1,I None

resetLoggingLevel()

Resets all logging levels to the defaults.

Inputs Outputs Roles Errors
None None C2,S1,I None

setLoggingLevel()

Changes which log messages the library retains in the logs.

Inputs Outputs Roles Errors
string loggerName,

LogLevel loggingLevel

 None C2,S1,I NotFoundException (logger)

Notification Configuration Methods

createEmailDestination()

Creates a new email destination.

Inputs Outputs Roles Errors
List of EventCategory eventCategories,

string emailAddress,

string localeId

 EmailDestinationDto C2,S2,I InvalidConfigException

createSciDestination()

Creates a new outbound SCI destination. See also Outbound Methods. The destinationPath should start with a slash "/". An empty string for destinationPath is not permitted. Protocol is "http" or "https". Username and password are allowed, but optional, with https protocol. If the library cannot connect to a SCI destination it retains un-sent events up to retentionTimeLimit. Later, if the library can communication with the destination, it will send all unsent events in the order they occurred. If the library cannot communicate with the detestation within retentionTimeLimit, the library discards all unsent and new events until communication is restored.

Inputs Outputs Roles Errors
List of EventCategory eventCategories,

string destinationProtocol,

string destinationIpAddress,

string destinationPort,

string destinationPath,

string username,

string password,

int retentionTimeLimit

 SciDestinationDto C2,S2,I InvalidConfigException

deleteDestination()

Deletes the notification destination.

Inputs Outputs Roles Errors
long destinationId None C2,S2,I NotFoundException (destination)

getDestinations()

Returns a list of notification destination's currently configured in the library.

Inputs Outputs Roles Errors
None List of DestinationDto All None

getEmailDestination()

Returns the email destination as specified by the destinationId.

Inputs Outputs Roles Errors
long id EmailDestinationDto All None

getEmailDestinations()

Returns a list of defined email destinations.

Inputs Outputs Roles Errors
None List of EmailDestinationDto All None

getSciDestination()

Returns a SCI destinations. SCI destinations must implement the outbound SCI specification. The library will invoke the outbound SCI methods when the specified list of events occur.

Inputs Outputs Roles Errors
long id SciDestinationDto All None

getSciDestinations()

Returns a list of SCI destinations. SCI destinations must implement the outbound SCI specification. The library will invoke the outbound SCI methods when the specified list of events occur.

Inputs Outputs Roles Errors
None List of SciDestinationDto All None

getSnmpDestination()

Returns the snmp destination as specified by the id.

Inputs Outputs Roles Errors
long id SnmpDestinationDto All None

updateEmailDestination()

Modifies an existing email destination.

Inputs Outputs Roles Errors
long destinationId

List of EventCategory eventCategories,

DestinationType type,

string emailAddress,

string locale

 EmailDestinationDto C2,S2,I NotFoundException (email destination)

updateSciDestination()

Modifies an existing outbound SCI destination. The path should start with a slash "/". An empty string for path is not permitted.

Inputs Outputs Roles Errors
long destinationId,

List of EventCategory eventCategories,

string protocol,

string host,

string port,

sting path,

string userName,

string password,

int retentionTimeLimit

 SciDestinationDto C2,S2,I NotFoundException (osci destination)