TS3500 Command Line Interface

Downloadable files

Abstract

The IBM TS3500 Command Line Interface (CLI) program can be used to access the TS3500 library from a CLI. This is in addition to the TS3500’s Web Specialist.

Download Description

The IBM TS3500 CLI provides the ability to access library functions through a command line interface. All view commands create a comma-separated value (csv) style output. The output is directed to the command prompt window by default, but can also be redirected to a file. To redirect the output to a file, you can add "> output_filename" to the end of the command.

In order to use the TS3500 Tape Library CLI, the following prerequisites apply:

The TS3500 Tape Library must be at a firmware level 8xxx (or higher).

The Advanced Library Management System (ALMS) must be installed and enabled.

Java 5.0 or later must be installed.

Cartridge movement using the TS3500 CLI is generally performed based on the current cartridge location:

Moving to storage

If currently in storage, then use prestageDataCartridges only if library contains a High Density frame

If currently in drive, then use moveFromDrive

If currently in I/O with Virtual I/O disabled, then use moveFromIo

If currently in I/O with Virtual I/O enabled, then use assignDataCartridges

If currently in shuttle, then use moveFromShuttle

Moving to drive

If currently in storage, then use moveToDrive

If currently in drive, then use moveFromDrive, followed by moveToDrive

If currently in I/O with Virtual I/O disabled, then use moveFromIo followed by moveToDrive

If currently in I/O with Virtual I/O enabled, then use assignDataCartridges followed by moveToDrive

If currently in shuttle, then use moveFromShuttle followed by moveToDrive

Moving to I/O

If currently in storage, then use removeDataCartridges

If currently in drive, then use moveFromDrive followed by removeDataCartridges

If currently in I/O with Virtual I/O disabled, then use moveFromIo followed by removeDataCartridges

If currently in I/O with Virtual I/O enabled, then use removeDataCartridges

If currently in shuttle, then use moveFromShuttle followed by removeDataCartridges

Some move commands allow you to specify which cartridge to move by either its 8-character volser or its current location in the library. By supporting moves by location, cartridges with an Unknown volser can be moved via the CLI.

Moves from a storage slot location are supported by:

assignDataCartridges

bulkAssignDataCartridges

bulkAssignDataCartridgesByLogicalLibrary

destageDataCartridges

moveToDrive

prestageDataCartridges

removeDataCartridges

Moves from an I/O slot location are supported by:

moveFromIo

The format for storage locations is F#,C#,R# for a library without a High Density frame and F#,C#,R#,T# for a library with a High Density frame. The format for I/O locations is F#,R#. As shown, the fields must be separated by commas without spaces.

Example: For a removeDataCartridges input file in a High Density library, you could have the following:
F1,C2,R8,T0
F2,C1,R25,T3
F1,C1,R10,T1

-? : Shows help
- : -Action, REQUIRED
-a : Tape library DNS name or ip address, REQUIRED
-d : Turns on extra debug tracing and stores in local file named "TS3500CLI.log" (used for problem determination)
-f : Specified frame #
-h : Shows help
-k : <keystore>, Full path and file name of keystore holding the public/private keypair used with SSL. Required if SSL is enabled
-ll : Specified logical library
-p : Tape Library Password (used only if Web Security is enabled)
-r : Drive row #
-s : <Storepass>, Keystore password used with SSL. Required if SSL is enabled
-setMaxSocketExceptionRetries : <number of retries>, Sets the maximum number of socket exception retry attempts
-t : Sets timeout value in milliseconds (default is to never timeout which may cause CLI to appear hung)
-u : Tape Library User ID (used only if Web Security is enabled)
-v or –verbose : The default mode for the CLI is “quiet”. In quiet mode, progress messages are not included in the output. When the –v or --verbose parameters is added, the progress messages are included in the output. When using the CLI with scripting, you probably will not want the progress messages included in the output
-w : The last 2 characters of the drive's WWNN to specify the drive (ie. instead of using -f and -r)

Download package

The TS3500 CLI tool is provided on an "as is" basis, without warranties or conditions of any kind.

The TS3500 CLI is licensed under the IBM License Agreement for Machine Code (IBM TS3500 CLI License (pdf) see below). Your use of this code indicates your acceptance of that agreement.

DOWNLOAD TERMS & CONDITIONS:

AS A PRECONDITION TO DOWNLOADING THE PROGRAM CODE, SAMPLES, UPDATES, AND FIXES ("CODE") BELOW, YOU MUST AGREE THAT (1) THE CODE IS SUBJECT TO THE TERMS OF THE LICENSE AGREEMENT WHICH ACCOMPANIED, OR IS CONTAINED IN, THE PROGRAM FOR WHICH YOU ARE OBTAINING THE CODE AND (2) YOU READ AND ACCEPTED THOSE TERMS WHEN YOU OBTAINED THE PROGRAM. YOU ARE NOT AUTHORIZED TO INSTALL OR USE THE CODE, EXCEPT AS PART OF A PROGRAM FOR WHICH YOU HAVE A VALID PROOF OF ENTITLEMENT. SUBJECT TO ANY STATUTORY WARRANTIES THAT CANNOT BY LAW BE EXCLUDED, IBM MAKES NO WARRANTIES OR CONDITIONS EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, REGARDING THE CODE OR TECHNICAL SUPPORT PROVIDED IN CONNECTION WITH THE CODE, IF ANY.

BY CLICKING ON THE LINKS BELOW, YOU INDICATE YOUR ACCEPTANCE OF THESE TERMS & CONDITIONS.