TS4500 Command Line Interface

Downloadable files


Abstract

The IBM TS4500 Command Line Interface (CLI) program can be used to access the TS4500 tape library from a CLI. It is an addition to TS4500 management user interface commands.

Download Description

The IBM TS4500 CLI provides the ability to access tape 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 TS4500 Tape Library CLI, the following prerequisites apply:

  • Java 6.0 or later must be installed.

Cartridge movement using the TS4500 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 enabled, then use assignDataCartridges
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 enabled, then use assignDataCartridges 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 enabled, then use 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
The format for storage locations 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 

or using volser:

For an assignDataCartridges input file to the logical library testltolib:
AAA000L4, testltolib 
ABC001L4, testltolib 
ZZZ000L4, testltolib

You can run the CLI from any directory. However, it is simplest to run it from the directory where the TS4500CLI.jar file is stored. Running it from that directory enables you to execute the CLI commands without entering the path name of the TS4500CLI.jar file. However, if you run the CLI from any other directory, you must include the entire path name of the TS4500CLI.jar file as a part of the command.
Running the CLI from the directory where the TS4500CLI.jar file is stored,
Your command looks like this:

java -jar TS4500CLI.jar -ip [LCC ip] -u [username] -p [password] --[cli_command] 

Supported Actions

- assignDataCartridges
Use the assignDataCartridges command to assign or reassign data cartridges to a logical library.

-batch
Use the batch command to instruct the system to perform multiple commands that are specified in a file.

-bulkAssignDataCartridges
Use the bulkAssignDataCartridges command to assign cartridges in bulk, rather than assigning cartridges one at a time. You can bulk-assign up to 100 cartridges to a common logical library.

- bulkAssignDataCartridgesByLL
Use the bulkAssignDataCartridgesByLL command to assign, in bulk, cartridges from a common logical library source to multiple logical library destinations.

- codeUpdate
Use the codeUpdate command to update the library firmware.

- createBEP
Use the createBEP command to create a bar code encryption policy.

- createKeyLabelMapping
Use the createKeyLabelMapping command to create a key label mapping.

- createVolserRanges
Use the createVolserRanges command to create one or more new VOLSER ranges.

-deleteBEP
Use the deleteBEP command to delete a bar code encryption policy.

- deleteKeyLabelMapping
Use the deleteKeyLabelMapping command to delete a key label mapping.

- deleteVolserRanges
Use the deleteVolserRanges command to delete VOLSER ranges.

- destageDataCartridges
Use the destageDataCartridges command to move cartridges from their cartridge cache locations (as specified in a text file) to a high-density slot.

- downloadLog
Use the downloadLog command to download a .zip file with the logs from all of the node cards. This command is useful for troubleshooting.

- downloadPropertiesFile
Use the downloadPropertiesFile command to download the properties file (TSSC file) if exists in the card.

- downloadSnapshot
Use the downloadSnapshot command to download a specific snapshot from the library.

- driveCodeUpdate
Use the driveCodeUpdate command to update the firmware in a specified drive or specified list of drives.

-editBEP
Use the editBEP command to edit a bar code encryption policy.

- editKeyLabelMapping
Use the editKeyLabelMapping command to edit a key label mapping.

- getVIOStatus
Use the getVIOStatus command to shows the status of the virtual I/O (VIO) flag on the library.

- modifyAdvancedEncSettings
Use the modifyAdvancedEncSettings command to make the advanced encryption settings more or less restrictive for data that is stored in a library.

- modifyFibreChannelSettings
Use the modifyFibreChannelSettings command to set ports speed and topology for a specified drive. Speed and topology are the same for both ports in the drive.

- modifyVolserRanges
Use the modifyVolserRanges command to modify existing VOLSER ranges.

- modifyVolserReporting
Use the modifyVolserReporting command to set whether the VOLSER is reported to the host in a six-character format or an eight-character format.

- moveFromAllDrives
Use the moveFromAllDrives command to eject all cartridges from all full drives

- moveFromDrive
Use the moveFromDrive command to eject a single cartridge from a drive and move it to the home storage location.

- moveToDrive
Use the moveToDrive command to move a cartridge from a storage location to a specified drive location.

- prestageDataCartridges
Use the prestageDataCartridges command to move cartridges from the high-density slots to cartridge cache locations specified in a text file.

- removeDataCartridges
Use the removeDataCartridges command to remove the data cartridges from a storage location to the I/O station.

- resetDrive
Use the resetDrive command to power cycle a specific drive.

- resetNodeCards
Use the resetNodeCards command to reset one or more specified node cards.

- restoreConfiguration
Use the restoreConfiguration command to restore the configuration database to the library.

- saveConfiguration
Use the saveConfiguration command save the configuration database to the user computer.

- setAutoEjectCleaningCarts
Use the setAutoEjectCleaningCarts command to set the enabled or disabled flag for the auto eject expired cleaning cartridges function in the library.

- setDrivePortsId
Use the setDrivePortsId command to set the ports IDs for a specified drive (Port 1 and Port 2).

- setMaximumVIOCartridges
Use the setMaximumVIOCartridges command to update the number of virtual I/O slots for the logical library.

- setNMADetection
Use the setNMADetection command to sets (to on or off) the NMA detection flag in the library.

- setRolePermissions
Use the setRolePermissions command with the output from the viewRolePermissions command. This command instructs the system to change the permissions for a specified role.

-setScannerSpeed
Use the setScannerSpeed command to set the speed of the scanner.

-setSlotOffline
Set offline a given slot

-setSlotOnline
Set online a given slot

- setSSL
Use the setSSL command to set the SSL flag to enabled or disabled.

- showQueuedExports
Sets flag to Show/Hide (true, false) queued exports

- viewAccessor
Use the viewAccessor command to show the accessor's status and usage statistics.

- viewBEP
Use the viewBEP command to show a list of all VOLSER ranges showing the BEP settings.

- viewCleaningCartridges
Use the viewCleaningCartridges command to view high-level information for all cleaning cartridges in a library.

- viewDataCartridges
Use the viewDataCartridges command to view high-level information for all data cartridges in a library.

- viewDriveDetails
The viewDriveDetails provides a display of several aspects of the drive that are useful for troubleshooting.
- viewDriveSummary
Use the viewDriveSummary command to show all of the drives in the library.

- viewDriveVPD
Use the viewDriveVPD command to show vital product data (VPD) information for all drives.

- viewFibreChannel
Use the viewFibreChannel command to show the Fibre Channel settings for both ports in each drive.

. viewIoStation
Use the viewIoStation command to view a summary of information for all cartridges in the I/O station.

- viewKeyLabelMapping
Use the viewKeyLabelMapping command to view the list of available key labels.

- viewLogicalLibraries
Use the viewLogicalLibraries command to list the high-level information for all logical libraries.

- viewLogicalLibraryDetails
Use the viewLogicalLibraryDetails command to show the name, type, maximum cartridges, the number of virtual I/0 slot addresses, and the number of drive addresses in a specified logical library.

- viewNodeCards
Use the viewNodeCards command to show a summary of information about the node cards.

- viewOfflineComponents
Shows all slots currently offline

- viewRolePermissions
Use the viewRolePermissions command to display a list of all the permissions for a specified role.

- viewRoles
Use the viewRoles command to display a list of all the defined roles in the library.

- viewSnapshots
Use the viewSnapshots command to display a list of all available snapshots in the library.

- viewSystemSummary
Use the viewSystemSummary command to view the physical library system summary.

- viewSystemSummaryDetails
Use the viewSystemSummaryDetails command to view detailed information about a specified frame.

- viewUsers
Use the viewUsers command to display a list of all the users in the library.

- viewVolserRanges
Use the viewVolserRanges to list all of the VOLSER ranges in the physical library.

- viewVolserRangesByLL
Use the viewVolserRangesByLL to list all of the VOLSER ranges for each logical library in the physical library.

Command Parameters

The following CLI parameters are supported.

-? : Shows help
-- : -Action, REQUIRED
-ip : Tape library ip address, REQUIRED
-f : Specified frame #
-h : Shows help
-p : Tape Library Password
-r : Drive row #
--ssl: Use this flag when using a library with SSL enabled
-u : Tape Library User ID
-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

Download package

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


The TS4500 CLI is licensed under the IBM License Agreement for Machine Code
(IBM TS4500 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.



TS4500 CLI Downloads

DESCRIPTION DOCUMENTATION LABEL Download Options
Platform Open Systems Version Independent
English
Byte Size 1363149
Date 11 Jun 2014

IBM TS4500 CLI Instructions
IBM TS4500 CLI License

IBM TS4500 CLI FTP

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Tape Libraries

Version:

Version Independent

Operating system(s):

AIX, Linux, Open Systems, Windows

Reference #:

S4001255

Modified date:

2014-06-10

Translate my page

Machine Translation

Content navigation