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.
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 8.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
- 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
- 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:
Moves from an I/O slot location are supported by:
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:
For an assignDataCartridges input file in a non-High Density library, the logical library testltolib is included:
For a moveFromIo command, you could have the following:
java -jar TS3500CLI.jar -a <ip address> --moveFromIo F1,R4 -u <user id> -p <password>
Description: Assigns data cartridges to a logical library
Description: Assigns the shuttle station at the given frame to a logical library
Description: Execute actions specified within a file
Description: Assigns multiple cartridges at the same time instead of 1 at a time
Description: Giving a logical library, assigns multiple cartridges at the same time instead of 1 at a time
Description: Unassigns multiple cartridges at the same time
Description: Cleans a drive at the given location, designated by frame and row.
Description: Creates a new Cartridge Assignment Policy (CAP)
Description: Creates/modifies a role to have modify any permissions
Description: Creates a user account
Description: Creates/modifies a role to have view only permissions
Description: Deletes all existing CAP ranges
Description: Deletes a user account
Description: Changes the default delimiter in viewDataCartridges, IoStation, and CleaningCartridges to a user specified character
Description: Destages cartridges based on a list of volsers or locations in a file
Description: Downloads library logs specified by log type
Description: Reads in a password and outputs an obfuscated password
Description: Perform key path diagnostics on all or specified logical libraries
Description: Updates the library firmware
Description: Modifies a user's account
Description: Demounts all full drives
Description: Demounts a cartridge from a specific drive, designated by frame and row.
Description: Moves the specified cartridge from the I/O station into a storage slot
Description: Moves a cartridge from a shuttle station specified by either volser or frame.
Description: Mounts a cartridge to a specific drive
Description: Power cycle the drive at the given location, designated by frame and row.
Description: Prestages cartridges to cache based on a list of volsers or locations in a file
Description: Removes the data cartridges (cartridges moved to the IO station)
Description: Removes all expired cleaning cartridges
Description: Resets all specified node cards
Description: Sets the Library date/time to that of the CLI host
Description: Sets the shuttle station beacon LED to blink at the given frame
Description: Sets the shuttle station beacon LED off at the given frame
Description: Sets the shuttle station beacon LED on at the given frame
Description: Sets the shuttle station offline at the given frame
Description: Sets the shuttle station online at the given frame
Description: Updates the shuttle car firmware
Description: Runs discover connections at the given shuttle frame
Description: Runs distribute connections at the given shuttle frame
Description: Unassigns the shuttle station at the given frame
Description: Displays version information about the TS3500 CLI
Description: Views the accessor status and usage statistics
Description: Views all downloadable library logs
Description: Views the encryption policy ranges
Description: Views all Cartridge Assignment Policy ranges in the physical library
Description: Views all cleaning cartridges
Description: Views all data cartridges
Description: Views detailed information about a drive at the given frame and row
Description: Views the drive summary
Description: Views the drive VPD information
Description: Displays the library error log information for a certain time period
Description: Views the fibre channel settings
Description: Views the I/O station
Description: Views the library VPD information
Description: Views the logical library settings
Description: Views the detailed information about a given logical library
Description: Views the node card information
Description: View the role permissions
Description: View session timeout value
Description: View the roles and their permissions
Description: Views the shuttle station settings
Description: Views the physical library system summary
Description: View physical library system summary for the specified frame
Description: Views all of the user IDs, roles, and comments
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)
-ep : Tape library encrypted password
-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)
--id: Used to modify /delete a user account
--ep: Used for encrypted password if web security is enabled
--newID: Used to modify/create a user account
--pw: Used to modify or creates the password for a user account
--role: Used to modify or create the role for a user account
--cmt: Used to modify or create a comment for a user account
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
15 June 2018