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:
  1. 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
  2. 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
  3. 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

For an assignDataCartridges input file in a non-High Density library, the logical library testltolib is included:
F1,C2,R8, testltolib
F2,C1,R25, testltolib
ZZZ000L4, testltolib

For a moveFromIo command, you could have the following:
java -jar TS3500CLI.jar -a <ip address> --moveFromIo F1,R4 -u <user id> -p <password>


Supported Actions

-assignDataCartridges
Description: Assigns data cartridges to a logical library

-assignShuttleStation
Description: Assigns the shuttle station at the given frame to a logical library

-batch
Description: Execute actions specified within a file

-bulkAssignDataCartridges
Description: Assigns multiple cartridges at the same time instead of 1 at a time

-bulkAssignDataCartridgesByLogicalLibrary
Description: Giving a logical library, assigns multiple cartridges at the same time instead of 1 at a time.

-cleanDrive
Description: Cleans a drive at the given location, designated by frame and row.

-createCapRanges
Description: Creates a new Cartridge Assignment Policy (CAP)

-createRoleModifyAny
Description: Creates/modifies a role to have modify any permissions

-createRoleViewOnly
Description: Creates/modifies a role to have view only permissions

-deleteCapRanges
Description: Deletes all existing CAP ranges

-destageDataCartridges
Description: Destages cartridges based on a list of volsers or locations in a file

-downloadLogs
Description: Downloads library logs specified by log type

-libraryFirmwareUpdate
Description: Updates the library firmware

-moveFromAllDrives
Description: Demounts all full drives

-moveFromDrive
Description: Demounts a cartridge from a specific drive, designated by frame and row.

-moveFromIo
Description: Moves the specified cartridge from the I/O station into a storage slot

-moveFromShuttle
Description: Moves a cartridge from a shuttle station specified by either volser or frame.

-moveToDrive
Description: Mounts a cartridge to a specific drive

-powerCycleDrive
Description: Power cycle the drive at the given location, designated by frame and row.

-prestageDataCartridges
Description: Prestages cartridges to cache based on a list of volsers or locations in a file

-removeDataCartridges
Description: Removes the data cartridges (cartridges moved to the IO station)

-removeExpiredCleaningCartridges
Description: Removes all expired cleaning cartridges

-resetNodeCards
Description: Resets all specified node cards

-setLibraryTime
Description: Sets the Library date/time to that of the CLI host

-setShuttleBeaconLightBlink
Description: Sets the shuttle station beacon LED to blink at the given frame

-setShuttleBeaconLightOff
Description: Sets the shuttle station beacon LED off at the given frame

-setShuttleBeaconLightOn
Description: Sets the shuttle station beacon LED on at the given frame

-setShuttleStationOffline
Description: Sets the shuttle station offline at the given frame

-setShuttleStationOnline
Description: Sets the shuttle station online at the given frame

-shuttleCarFirmwareUpdate
Description: Updates the shuttle car firmware

-shuttleDiscoverConnections
Description: Runs discover connections at the given shuttle frame

-shuttleDistributeConnections
Description: Runs distribute connections at the given shuttle frame

-unassignShuttleStation
Description: Unassigns the shuttle station at the given frame

-version
Description: Displays version information about the TS3500 CLI

-viewAccessor
Description: Views the accessor status and usage statistics

-viewAvailableLibraryLogs
Description: Views all downloadable library logs

-viewBepRanges
Description: Views the encryption policy ranges

-viewCapRanges
Description: Views all Cartridge Assignment Policy ranges in the physical library

-viewCleaningCartridges
Description: Views all cleaning cartridges

-viewDataCartridges
Description: Views all data cartridges

-viewDriveDetails
Description: Views detailed information about a drive at the given frame and row

-viewDriveSummary
Description: Views the drive summary

-viewDriveVPD
Description: Views the drive VPD information

-viewFibreChannel
Description: Views the fibre channel settings

-viewIoStation
Description: Views the I/O station

-viewLibraryVPD
Description: Views the library VPD information

-viewLogicalLibraries
Description: Views the logical library settings

-viewLogicalLibraryDetails
Description: Views the detailed information about a given logical library

-viewNodeCards
Description: Views the node card information

-viewRolePermissions
Description: View the role permissions

-viewRoles
Description: View the roles and their permissions

-viewShuttleStations
Description: Views the shuttle station settings

-viewSystemSummary
Description: Views the physical library system summary

-viewSystemSummaryDetails
Description: View physical library system summary for the specified frame


Command Parameters

The following CLI parameters are supported.

-? : 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.



TS3500 CLI Downloads

DESCRIPTION DOCUMENTATION LABEL Download Options
Platform Open Systems Version Independent
English
Byte Size 1136458
Date 15 Jul 2014

IBM TS3500 CLI Instructions

IBM TS3500 CLI License
IBM TS3500 CLI FTP

Rate this page:

(0 users)Average rating

Document information


More support for:

Tape Libraries

Version:

Version Independent

Operating system(s):

AIX, Linux, Open Systems, UNIX, Windows

Reference #:

S4000854

Modified date:

2014-07-15

Translate my page

Machine Translation

Content navigation