______________________________________________ Command Line Interface The IBM® TS3310 Command Line Interface (CLI) program can be used to access the TS3310 library from a CLI. This is in addition to the TS3310’s Web User Interface. The TS3310 CLI can be downloaded from url: https://www-01.ibm.com/support/docview.wss?uid=ssg1S4000981
The IBM TS3310 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 TS3310 tape library CLI, the following prerequisites apply: The TS3310 tape library must be at a firmware level 587G.GS003 (or higher). Java 5.0 or later must be installed
Cartridge movement using the TS3310 CLI is generally performed based on the current cartridge location: 1. Moving to storage If currently in drive, use either unloadDrive or unloadAllDrives 2. Moving to I/O If currently in storage, then use removeDataCartridges
Supported Actions
-bulkMoveCartridgesToAnotherLogicalLibrary Description: Assigns multiple cartridges at the same time instead of 1 at a time
-captureLibraryLog Description: Downloads the library log file directly to the local directory
-cleanDrive Description: Cleans a drive at the given location, designated by enclosure and row.
-moveCartridgesToAnotherLogicalLibrary Description: Assigns data cartridges to a logical library
-removeDataCartridges Description: Removes the data cartridges (cartridges moved to the IO station)
-removeExpiredCleaningCartridges Description: Removes all expired cleaning cartridges
-resetDrive Description: Power cycle the drive at the given location, designated by enclosure and row.
-restartLibrary Description: Restarts the tape library
-shutdownLibrary Description: Powers down the tape library
-unloadAllDrives Description: Unloads all full drives -unloadDrive Description: Unloads a cartridge from a specific drive, designated by enclosure and row.
-version Description: Displays version information about the TS3310 CLI
-viewCleaningCartridges Description: Views all cleaning cartridges
-viewDataCartridges Description: Views all data cartridges
-viewDriveFirmwareLevels Description: Views the drive VPD information and firmware levels
-viewDriveSummary Description: Views the drive summary
-viewFibreChannelPorts Description: Views the fibre channel settings
-viewIOStation Description: Views the I/O station
-viewLibraryFirmwareLevel Description: Views the library VPD information and firmware level
-viewLoggedInUsers Description: View logged in users
-viewLogicalLibraries Description: Views the logical library settings
-viewOperatorInterventions Description: View operator interventions for all states
-viewSystemSummary Description: Views the physical library system summary
-viewUsers Description: Views all of the user IDs, and Roles
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 "TS3310CLI.log" (used for problem determination) -e : Specified enclosure # -h : Shows help -p : Tape library Password, REQUIRED -r : Drive row # -t : Sets timeout value in milliseconds (default is to never timeout which may cause CLI to appear hung) -u : Tape library User ID, REQUIRED -v or –verbose : The default mode for the CLI is “quiet”. In quiet mode, progress messages are not included in the out- put. When the –v or --verbose parameters is added, the progress messages are included in the output. When us- ing the CLI with scripting, you probably will not want the progress messages included in the output
Command Format
bulkMoveCartridgesToAnotherLogicalLibrary
java -jar TS3310CLI.jar -a <dns or ip addr of your library> --
bulkMoveCartridgesToAnotherLogicalLibrary <full path and filename of input file> -u <user id> -p <password>
For the bulkMoveCartridgesToAnotherLogicalLibrary action, the input file would take the format of:
volser #1, Logical Library name
volser #2, Logical Library name etc.
Example. If you wanted to assign three cartridges to the logical library named testltolib, you might create a text file named volsers.txt containing:
C:\$User\Applications\TS3310_CLI\>java -jar TS3310CLI.jar -a <dns or ip addr of
your library> --bulkMoveCartridgesToAnotherLogicalLibrary C:\$User\Applications\TS3310_CLI\volsers.txt -u <user id> -p <password>
With bulkMoveCartridgesToAnotherLogicalLibrary, it moves a group of cartridges at a time. The advantage is that it
is faster than moveCartridgesToAnotherLogicalLibrary and even tells you which ones succeeded (but only when there are no failures). The disadvantage is that if there is an error, the web/CLI doesn't tell you which ones failed, only that they failed.
captureLibraryLogs
java -jar TS3310CLI.jar -a <dns or ip addr of your library> --captureLibraryLog
-u <user id> -p <password>
cleanDrive
java -jar TS3310CLI.jar -a <dns or ip addr of your library> --cleanDrive -e
java -jar TS3310CLI.jar -a <dns or ip addr of your library> --
moveCartridgesToAnotherLogicalLibrary <full path and filename of input file> -u <user id> -p <password>
For the moveCartridgesToAnotherLogicalLibrary action, the input file would take the format of: volser #1, Logical Library name volser #2, Logical Library name etc.
Example. If you wanted to assign three cartridges to the logical library named testltolib, you might create a text file named volsers.txt containing:
C:\$User\Applications\TS3310_CLI\>java -jar TS3310CLI.jar -a <dns or ip addr of
your library> --moveCartridgesToAnotherLogicalLibrary C:\$User\Applications\TS3310_CLI\volsers.txt -u <user id> -p <password>
moveCartridgesToAnotherLogicalLibrary moves 1 single cartridge at a time. The advantage is that you get to know the actual status result of each individual cartridge. The disadvantage is that it takes longer than bulkMove- CartridgesToAnotherLogicalLibrary.
removeDataCartridges
java -jar TS3310CLI.jar -a <dns or ip addr of your library> --
removeDataCartridges <full path and filename of input file> -u <user id> -p <password>
The input file has the format of:
volser #1 volser #2 etc.
removeExpiredCleaningCartridges
java -jar TS3310CLI.jar -a <dns or ip addr of your library> --
