Command-line interface
This chapter describes the TS4500 command-line interface (CLI) in the following areas: CLI installation, CLI commands that are categorized by management function, and commands.
This chapter includes the following topics:
5.1 TS4500 command-line interface summary
The TS4500 CLI program enables access to TS4500 tape library functions through commands.
The following TS4500 tape library CLI commands are available:
•completeDriveService
•showQueuedExports
•startDriveService
•startDiscoverHW
•startLibraryVerify
•viewFibreChannel
•viewPasswordAndSessionPolicy
CLI commands instruct the system to perform specific data cartridge management, cleaning cartridge management, and service-oriented procedures.
Many of the procedures that are started with CLI commands cannot be started through the TS4500 management GUI.
5.2 Install the CLI
Download the license and CLI from the IBM TS4500 Command Line Interface web page:
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. By running the CLI from that directory, you can run 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.
If you run the CLI from the directory where the TS4500CLI.jar file is stored, your command looks like the following example:
java -jar TS4500CLI.jar -ip [LCC ip] -u [username] -p [password] --[cli_command]
If you run the CLI from any other directory, your command looks like the following example:
java -jar TS4500CLI.jar "C:[pathname_of_ts4500cli.jar]TS4500CLI.jar" -ip [LCC ip] -u [username] -p [password] --[cli_command]
|
Note: If Secure Sockets Layer (SSL) is enabled on the TS4500 tape library, you must add the --ssl parameter to the command after the password, as shown in the following example:
java -jar TS4500CLI.jar -ip [LCC ip] -u [username] -p [password] --ssl --[CLI_command]
|
The latest TS4500 CLI information and commands can be found at IBM Knowledge Center:
|
Note: For Library code R1.5, the CLI version 1.32f or higher is required. The following CLI command is used to check the version:
java -jar TS4500CLI_forR15_code.jar --version
The following output is generated:
CLI GEN 4 Version: 1.32g
Build: 09/10/2018
|
|
Note: Some commands require service or an admin user to run. If you see error ****ERROR: User name or password incorrect or password expired, and the user ID and password are correct, wrong user ID is being used.
This is the list for V1.5 CLI and might differ from previous versions.
|
Commands that are categorized by management function
The TS4500 tape library commands are categorized by management function and listed in Table 5-1.
Table 5-1 TS4500 CLI commands that are categorized by management function
|
Management function
|
Command usage
|
Command
|
|
Data cartridges
|
Assigns data cartridges to a logical library.
|
assignDataCartridges
|
|
Assigns drive to a logical library.
|
assignDriveToLL
|
|
|
Assigns cartridges in bulk instead of one at a time.
|
bulkAssignDataCartridges
|
|
|
Assigns cartridges from the same logical library in bulk instead of one at a time.
|
bulkAssignDataCartridgesByLL
|
|
|
Moves cartridges from cartridge cache locations to high-density slots.
|
destageDataCartridges
|
|
|
Ejects all cartridges.
|
moveFromAllDrives
|
|
|
Ejects a cartridge from a drive.
|
moveFromDrive
|
|
|
Mounts a specified cartridge to the specified drive.
|
moveToDrive
|
|
|
Moves cartridges from high-density slots to cartridge cache locations.
|
prestageDataCartridges
|
|
|
Removes the data cartridges to and from the I/O station.
|
removeDataCartridges
|
|
|
Lists high-level information for all of the data cartridges in the library.
|
viewDataCartridges
|
|
|
Cleaning cartridges
|
Sets the auto eject expired cleaning cartridges flag in the library.
|
setAutoEjectCleaningCarts
|
|
Lists high-level information for all of the cleaning cartridges in the library.
|
viewCleaningCartridges
|
|
|
CLI
|
Performs actions that are specified within a file.
|
batch
|
|
Creates an encrypted password that can be used with any other CLI command.
|
encrypy
|
|
|
Used to view the current version of the Web Interface CLI program.
|
version
|
|
|
Fibre Channel Drives
|
Cleans a specific drive.
|
cleanDrive
|
|
Finish the Drive Service actions. Drive will initialize and eventually go online.
|
completeDriveService
|
|
|
Sets ports’ speed and topology for the specific drive.
|
modifyFibreChannelSettings
|
|
|
Power-cycles a specified drive.
|
resetDrive
|
|
|
Sets the ports’ IDs for a specified drive.
|
setDrivePortsId
|
|
|
Sets the drive usage configuration.
|
setDriveuse
|
|
|
Prepare drive for Service and take it offline.
|
startDriveService
|
|
|
Unassign a given drive.
|
unassignDrive
|
|
|
Lists the high-level details of a specific drive.
|
viewDriveDetails
|
|
|
Show drive statistic similar to the pod in the bottom of the Systems page.
|
viewDrivePod
|
|
|
Lists the high-level details of all of the drives in the library.
|
viewDriveSummary
|
|
|
Displays vital product data (VPD) information for all drives.
|
viewDriveVPD
|
|
|
Displays the Fibre Channel (FC) settings for both ports in each drive.
|
viewFibreChannel
|
|
|
Ethernet Drives
|
Sets the network configuration settings for a single Ethernet drive or to change the name and alias of the drive.
|
setISCSI
|
|
Sets the MAC address for an Ethernet port or both ports.
|
setMacAddress
|
|
|
Displays the configuration settings for a specific Ethernet drive.
|
viewISCSI
|
|
|
Displays the MAC addresses for a drive’s Ethernet ports.
|
viewMacAddress
|
|
|
Encryption Key Managers/bar code encryption policy (BEP)
|
Creates a bar code encryption policy.
|
createBEP
|
|
Edits a bar code encryption policy.
|
modifyBEP
|
|
|
Deletes a bar code encryption policy.
|
deleteBEP
|
|
|
Displays a list of all of the VOLSER ranges, showing the BEP settings.
|
viewBEP
|
|
|
Key label mapping
|
Creates a key label mapping.
|
createKeyLabelMapping
|
|
Edits a key label mapping.
|
editKeyLabelMapping
|
|
|
Deletes a key label mapping.
|
deleteKeyLabelMapping
|
|
|
Displays the list of available key labels.
|
viewKeyLabelMapping
|
|
|
Logical libraries
|
Create a logical library name and associated Drive type (LTO, JAG).
|
createLL
|
|
Delete logical library. No drives have to be assigned.
|
deleteLL
|
|
|
Modifies the advanced encryption settings for a logical library.
|
modifyAdvancedEncSettings
|
|
|
Modifies the VOLSER reporting value to the host in a six-character format or an eight-character format (6 or 8).
|
modifyVolserReporting
|
|
|
Updates the maximum number of virtual I/O slots for the logical library.
|
setMaximumVIOCartridges
|
|
|
Sets flag to Show/Hide (true or false) queued exports.
|
showQueuedExports
|
|
|
Lists all of the logical libraries.
|
viewLogicalLibraries
|
|
|
Views the detailed information about a specific logical library.
|
viewLogicalLibraryDetails
|
|
|
Shows the encryption settings for a certain logical library.
|
viewAdvancedEncryptionSettings
|
|
|
Security
|
Sets the SSL flag to Enabled or Disabled.
|
setSSL
|
|
Service
|
Updates the library firmware.
|
codeUpdate
|
|
Used to finish the library verification process for I/O stations.
|
continueCloseLibraryVerify
|
|
|
Used to perform the second step of the library verification process for I/O stations.
|
continueLibraryVerify
|
|
|
Downloads a .csv file that contains events.
|
downloadEvents
|
|
|
Downloads the .zip file with all of the logs.
|
downloadLog
|
|
|
Downloads the .zip file with all of the logs.
|
downloadDrivesLog
|
|
|
Downloads the properties file (IBM TotalStorage System Console (TSSC) file).
|
downloadPropertiesFile
|
|
|
Create a .csv file with information about resources, specified as drive, logical libraries, and so on.
|
downloadResources
|
|
|
Downloads snapshots.
|
downloadSnapshot
|
|
|
Updates the drive firmware.
|
driveCodeUpdate
|
|
|
The command displays the Library firmware version installed.
|
getFWVersion
|
|
|
Restores the configuration database to the library.
|
restoreConfiguration
|
|
|
Saves the configuration database to the user’s computer.
|
saveConfiguration
|
|
|
Sets scanner speed.
|
setScannerSpeed
|
|
|
Sets a specific slot offline.
|
setSlotOffline
|
|
|
Sets a specific slot online.
|
SetSlotOnline
|
|
|
Starts the calibration process on selected components of the library.
|
startCalibration
|
|
|
Start to detect new hardware with the option to delete or keep the current data.
|
startDiscoverHW
|
|
|
Starts the inventory process in the library.
|
startInventory
|
|
|
Starts the library verification process for I/O stations.
|
startLibraryVerify
|
|
|
Displays the list of available snapshots.
|
viewSnapshots
|
|
|
System
|
Resets all specified node cards.
|
resetNodeCards
|
|
Sets which tape drives and I/O stations are served by which accessor or can also be used to inactivate an accessor.
|
setAccessorZones
|
|
|
Sets the library date, time, and time zone to that of the server on which the CLI is running.
|
setLibraryTime
|
|
|
Sets the No Motion Allowed (NMA) detection flag in the library.
|
setNMADetection
|
|
|
Sets value to Capacity Utilization and Dual Accessor Utilization thresholds.
|
setUtilThreshold
|
|
|
Shows the accessor’s status and usage statistics.
|
viewAccessor
|
|
|
Displays which tape drives and I/O stations (within sets of frames) are being served by which accessor.
|
viewAccessorZones
|
|
|
Lists the high-level details of all of the cartridges in the I/O station.
|
viewIoStation
|
|
|
Displays the vital product data (VPD) for the library.
|
viewLibraryVPD
|
|
|
Displays the information about the node cards.
|
viewNodeCards
|
|
|
Views offline slots.
|
viewOfflineComponents
|
|
|
Display Storage slots used for the
appropriate media type (Jag / LTO).
|
viewStorageCapacity
|
|
|
Displays the physical library system summary.
|
viewSystemSummary
|
|
|
Displays the physical library system summary for the specified frame.
|
viewSystemSummaryDetails
|
|
|
Show information about Capacity Utilization and Dual Accessor Utilization thresholds.
|
viewUtilThreshold
|
|
|
Users and roles
|
Create User, Role, and initial password.
|
createUser
|
|
Delete local user. Cannot be the same user who issued the command.
|
deleteUser
|
|
|
Show information about session definition and password characteristics.
|
viewPasswordAndSessionPolicy
|
|
|
Revises the existing permissions for a specified role.
|
setRolePermissions
|
|
|
Displays a list of all of the permissions for a specified role.
|
viewRolePermissions
|
|
|
Displays a list of all of the defined roles in the library.
|
viewRoles
|
|
|
Displays a list of all of the users in the library.
|
viewUsers
|
|
|
Volume serial number (VOLSER) ranges
|
Creates VOLSER ranges.
|
createVolserRanges
|
|
Deletes all of the VOLSER ranges with the file.
|
deleteVolserRanges
|
|
|
Provides the capability to modify the logical library, media type, and the flag to enable the VOLSER range only for new cartridges.
|
modifyVolserRanges
|
|
|
Shows all of the VOLSER ranges in the physical library.
|
viewVolserRanges
|
|
|
Shows all of the VOLSER ranges in a specific logical library.
|
viewVolserRangesByLL
|
5.3 Commands
The command syntax and examples are described in this section.
If the CLI is run from the directory where the TS4500CLI.jar file is stored, the command looks like the following example:
java -jar TS4500CLI.jar -ip [LCC ip] -u [username] -p [password] --[cli_command]
If the command is run from any other directory, the command looks like the following example:
java -jar TS4500CLI.jar "C:[pathname_of_ts4500cli.jar]TS4500CLI.jar" -ip [LCC ip] -u [username] -p [password] --[cli_command]
We show only the [cli_command] section of the command in the following section. An example of a full command is shown in Example 5-1.
Example 5-1 Command example
C:TS4500>java -jar TS4500CLI.jar -ip 10.1.1.37 -u Redbooks -p RedB00ks --viewSystemSummary
|
Note: If SSL is enabled in the TS4500 tape library, you must add the --ssl parameter to the command after the password. Also, the server must have the correct SSL certificates, as shown in the following example:
java -jar TS4500CLI.jar -ip [LCC ip] -u [username] -p [password] --ssl --[CLI_command]
|
assignDataCartridges
Use the assignDataCartridges command to assign or reassign data cartridges to a logical library.
The command uses the following syntax:
assignDataCartridges filename.txt
The assignDataCartridges command receives a text file with one or more assign operations as input. Each line in the text file is interpreted as an assign operation. In the text file, the data cartridge location can be specified with the format: [F,C,R,T], where F = frame, C = column, R = row, and T = tier, as shown in Example 5-2, or the VOLSER, as shown in Example 5-3.
Example 5-2 Using assign_by_location_DataCartridges.txt
F1,C2,R8,T0, testltolib1
F2,C2,R8,T0, testltolib2
Example 5-3 shows the VOLSER format.
Example 5-3 Using assign_by_volser_DataCartridges.txt
A57654L7, testltolib1
A56654L7, testltolib2
Example 5-4 shows an example of this command using the defined .txt files.
Example 5-4 The assignDataCartridges command
assignDataCartridges assign_by_location_DataCartridges.txt
assignDataCartridges assign_by_volser_DataCartridges.txt
assignDriveToLL
Use the assignDriveToLL command to assign drives to a logical library.
The command uses the following syntax:
assignDriveToLL logicalLibraryname,driveF#C#R#
Specify the drive locations of the drives, that must be assigned to the logical library. The number sign (#) variables in the syntax have the following values:
F# Frame number of the drive to update
C# Column number of the drive to update
R# Row number of the drive to update
When the assignDriveToLL command runs successfully, the system returns output to the display, as shown in Example 5-5.
Example 5-5 The assignDriveToLL command
assignDriveToLL TestLib,F1C2R1
The drive was assigned successfully
batch
Use the batch command to instruct the system to perform multiple commands that are specified in a file.
The command uses the following syntax:
batch filename.txt
The batch command receives a text file with one or more command operations as input. The text file is in the following format:
commandName [commandParameters]
next commandName [commandParameters]
Each line in the text file is interpreted as a command. When the batch command runs successfully, the system returns output that corresponds to the successful execution of each command that is listed in the input file to your display.
Example 5-6 instructs the system to run all of the commands that are contained in the todays_batch.txt file.
Example 5-6 The batch command
batch todays_batch.txt
bulkAssignDataCartridges
Use the bulkAssignDataCartridges command to assign cartridges in bulk to a logical library, rather than assigning cartridges one at a time. You can bulk-assign up to 100 cartridges to a common logical library.
The command uses the following syntax:
bulkAssignDataCartridges filename.txt, Logical_library_name
This command receives a text file with one or more assign operations as input. Each line in the file is interpreted as an assign operation. The input file is in the following format, [F,C,R,T] #1 or VOLSER, as shown in Example 5-7. F = frame, C = column, R = row, and
T = tier.
T = tier.
Example 5-7 Todays_bulk_assigns.txt file
F1,C2,R8,T0
F2,C2,R8,T0
F3,C2,R8,T0
BT1956L7
BT1957L7
The logical library name (assignment destination) is the same for all of the entries.
Example 5-8 instructs the system to execute the assignment of the cartridges that are contained in the todays_bulk_assigns.txt file.
Example 5-8 The bulkAssignDataCartridges command
bulkAssignDataCartridges todays_bulk_assigns.txt, LibTest
bulkAssignDataCartridgesByLL
Use the bulkAssignDataCartridgesByLL command to assign, in bulk, cartridges from a common logical library source to multiple logical library destinations. The bulkAssignDataCartridgesByLL command is faster than the bulkAssignDataCartridges command because the system needs to search in only one logical library source.
The command uses the following syntax:
bulkAssignDataCartridgesByLL filename.txt
This command receives a text file with one or more assign operations as input. Each line in the file is interpreted as an assign operation. The input file is in the following format: [F,C,R,T] #1, or VOLSER and the destination logical library name, as shown in Example 5-9.
Example 5-9 Input file todays_bulk_assignsLL.txt
F1,C2,R8,T0, testltolib1
F2,C2,R8,T0, testltolib2
F3,C2,R8,T0, testltolib1
BT1957L7, testltolib1
BA1955L7, testltolib2
Example 5-10 shows an example of this command.
Example 5-10 Command bulkAssignDataCartridgesByLL
bulkAssignDataCartridgesByLL todays_bulk_assignsLL.txt
cleanDrive
Use the cleanDrive command to clean a specific drive.
The command uses the following syntax:
cleanDrive -f# -c# -r#
Each drive location must be delimited by a comma. However, do not insert commas between the frame #, column #, and row #. The number sign (#) variables in the syntax have the following values, a space is required between the delimiter:
-f# Frame number of the drive to update
-c# Column number of the drive to update
-r# Row number of the drive to update
When the cleanDrive command runs successfully, the system returns output to your display as shown in Example 5-11.
Example 5-11 The cleanDrive command
cleanDrive -f3 -c2 -r1
The drive was cleaned successfully
codeUpdate
Use the codeUpdate command to update the library firmware. (To update the firmware in a specific drive, use the driveCodeUpdate command or use the TS4500 management GUI.)
The command uses the following syntax:
codeUpdate filename of firmware image
When the codeUpdate command executes successfully, the system returns output to your display, as shown in Example 5-12.
Example 5-12 The codeUpdate command
codeUpdate TS4500_1100-O4Q.afwz
Example codeUpdate output
Name: TS4500_1100-04Q.afwz
>>>Uploading file...
............................................................
Done
completeDriveService
Use the completeDriveService command to finish the drive service action. The drive will initialize and go online. The drive location need to be specified and had to be set to service earlier. A task is created and Progress could be monitored at the GUI.
The command uses the following syntax:
completeDriveService -f# -c# -r#
The number sign (#) variables specify the location of the drive, and have the following values:
•-f# Frame number of the drive
•-c# Column number of the drive
•-r# Row number of the drive
When the completeDriveService command executes successfully, the system returns output to your display, as shown in Example 5-13.
Example 5-13 The completeDriveService command
completeDriveService -f3 -c2 -r1
The drive service has completed
continueCloseLibraryVerify
Use the continueCloseLibraryVerify command to finish the library verification process for I/O stations. Before you run this command, you must run the continueLibraryVerify command and then close all of the I/O station doors. (Library verification is a three-step process in which the following commands must be run in this order: startLibraryVerify, continueLibraryVerify, and continueCloseLibraryVerify.)
The command uses the following syntax:
continueCloseLibraryVerify
When the continueCloseLibraryVerify command executes successfully, the system returns output to your display, as shown in Example 5-14.
Example 5-14 The continueCloseLibraryVerify command
continueCloseLibraryVerify
IO doors closed.
Library verify continues now...The test has been completed successfully
continueLibraryVerify
Use the continueLibraryVerify command to perform the second step of the library verification process for I/O stations. Before you run this command, you must run the startLibraryVerify command and then open all of the I/O station doors. (Library verification is a three-step process in which the following commands must be run in this order: startLibraryVerify, continueLibraryVerify, and continueCloseLibraryVerify.)
The command uses the following syntax:
continueLibraryVerify
When the continueLibraryVerify command executes successfully, the system returns output to your display, as shown in Example 5-15.
Example 5-15 The continueLibraryVerify command
continueLibraryVerify
IO doors opened. Library verify continues now.......Done!
Next step: CLOSE all IO doors, and then use "continueCloseLibraryVerify" command to continue the test. 
createBEP
Use the createBEP command to create the cartridges’ bar code encryption policy (BEP). You must run the viewKeyLabelMapping command before you run the createBEP command to see the key label mapping index number of the cartridges for the encryption policy.
The command uses the following syntax:
createBEP VOLSER_start,VOLSER_end,logical_library_name, media_type, klm_index_1,klm_index_2
The command includes the following syntax:
VOLSER_start The volume serial number that starts the series of cartridges for the encryption policy.
VOLSER_end The volume serial number that ends the series of cartridges for the encryption policy.
logical_library_name The name of the logical library that contains the series of cartridges for the encryption policy.
media_type The media type of the cartridges for the encryption policy. The following values are valid values for media type: LTO or 3592.
klm_index_1 The key label mapping index number of the cartridges for the encryption policy.
klm_index_2 Optional: This parameter is an optional value to use if you want to create encryption policies for cartridges in a second index.
createBEP When the createBEP command executes successfully, the system returns output to your display.
Example 5-16 creates the cartridges’ bar code encryption policy for the VOLSER range TT2000 - TT3000 in the test1 logical library for the 3592 cartridges, which are referenced in index 1.
Example 5-16 The createBEP command
createBEP TT2000,TT3000,test1,3592,1
The cartridge encryption policy was created successfully
createKeyLabelMapping
Use the createKeyLabelMapping command to create a key label mapping.
The command uses the following syntax:
createKeyLabelMapping keyLabelFrom,keyModeFrom,keyLabelTo
Consider the following points regarding the command syntax:
•keyLabelFrom is a string that cannot be repeated in the list of key labels. The maximum length of this string is 50 characters.
•keyModeFrom is a parameter with the following possible values:
– Wrapped-Hash
– Wrapped-Default (Specifying this value for the keyModeFrom parameter disables the keyLabelTo parameter, and it is not necessary to specify a string value for the keyLabelTo parameter.)
– Wrapped-Clear
•keyLabelTo is a string. The maximum length of this string is 50 characters.
When the createKeyLabelMapping command runs successfully, the system returns output to your display. See Example 5-17, which instructs the system to create a mapping from the key label START to the key label END by using the wrapped-hash key mode.
Example 5-17 The createKeyLabelMapping command
createKeyLabelMapping START,Wrapped-Hash,END
The Key Label Mapping was created successfully
createLL
Use the createLL command to create a new logical library. Library name and the Drive Media Type associated with the Library to be specified.
The command includes the following parameters:
•Name: Name of the new logical library
•Media type: LTO or JAG
The command uses the following syntax:
createLL NewLibname,DriveMediaType
When the createLL command runs successfully, the system returns output to the display, as shown in Example 5-18
Example 5-18 The createLL command
createLL NewLib,JAG
The logical library was created successfully
createUser
Use the createUser command to create user names, roles, and a temporary password, if required.
The command uses the following parameters:
•name: User name
•role: Access level, Admin, Service, Superuser, Monitor
•sentoemail: Email notification yes/no
•tempPass: Set temporary password yes / no
Consider the following points:
•The email parameter is required if –sendToEmail is ‘yes’ and optional if –sendToEmail is ‘no’.
•The –tempPass parameter is required if –sendToEmail is ‘no’ and not allowed if –sendToEmail is ‘yes’.
•The –name and –role parameters always are required.
•Only the Administrator and Super User are authorized to use this command.
The command uses the following syntax:
createUser -name <name> -role <role> -sendToEmail [yes {-email <email> | no -tempPass <password> }
When the createUser command runs successfully, the system returns output to the display, as shown in Example 5-19.
Example 5-19 The createUser command
createUser –name RobRoy123 –role Administrator –sendToEmail no –tempPass L0gM3InN0w
createUser –name RobRoy123 –role Service –sendToEmail yes –email [email protected]
User RobRoy123 was created successfully.
createVolserRanges
Use the createVolserRanges command to create one or more VOLSER ranges. This task is a long-running task. The CLI shows the percentage of task completion while the task progresses.
The command uses the following syntax:
createVolserRanges filename.txt
The createVolserRanges command receives a text file with one or more VOLSER ranges as input. Each line of the input file is interpreted as a VOLSER range. The input file is in the following format:
startRange,endRange,LLName,mediaType,Enable
The following parameter information is required:
•startRange is the starting VOLSER in the range to create.
•endRange is the ending VOLSER in the range to create.
•LLName is the name of the logical library.
•mediaType is LTO or 3592.
•Enable:
– TRUE = Enable this range for new cartridges only.
– FALSE = Do not enable this range for new cartridges only.
While each line of the input file runs successfully and each VOLSER range is created, the system returns the results to your display.
Example 5-20 is an example of the createVolserRanges input file.
Example 5-20 The volser_ranges.txt input file
UAA9RH,UBB9RH,Library1,3592,FALSE
Example 5-21 uses the input file to instruct the system to create the VOLSER range that starts with UAA9RH and ends with UBB9RH in logical library 1 for the 3592 frame. This VOLSER range is not enabled for new cartridges.
Example 5-21 The createVolserRanges command
createVolserRanges volser_ranges.txt
The Volser Range was created successfully
Done
deleteBEP
Use the deleteBEP command to delete a cartridge bar code encryption policy. You must run the viewBEP command before you run this command to see the list of valid indexes.
The command uses the following syntax:
deleteBEP index
Example 5-22 shows a command that instructs the system to delete the BEP for index 1. It is necessary to run the viewBEP command before you run the deleteBEP command to see the index number.
Example 5-22 The deleteBEP command
deleteBEP 1
The cartridge encryption policy was deleted successfully
deleteKeyLabelMapping
Use the deleteKeyLabelMapping command to delete a key label mapping. You must run the viewKeyLabelMapping command before you run this command to see the index of the key label mapping that you want to delete.
The command uses the following syntax:
deleteKeyLabelMapping index
When the deleteKeyLabelMapping command executes successfully, the system returns output to your display, as shown in Example 5-23.
Example 5-23 The deleteKeyLabelMapping command
deleteKeyLabelMapping 1
The Key Label Mapping was deleted successfully
deleteLL
The command deleteLL deletes a specific logical library
The command uses the following syntax:
deleteLL Libraryname
The Name parameter name of the logical library
When the deleteLL command runs successfully, the system returns output to the display, as shown in Example 5-24
Example 5-24 The deleteLL command
deleteLL TestLib
The logical library was deleted successfully
deleteUser
The deleteUser command delete local user accounts. After deletion, the account cannot be used for authentication to the TS4500 management GUI or CLI.
The command uses the following syntax:
deleteUser -username
Consider the following points:
•This action behaves like the matching GUI action and follows all its rules. This behavior includes not being able to delete the user account that initiated this command.
•Only the Administrator and Super User are authorized to use this command.
When the deleteUser command runs successfully, the system returns output to the display, as shown in Example 5-25
Example 5-25 The deleteUser command
deleteUser test_admin
The user was deleted successfully
deleteVolserRanges
Use the deleteVolserRanges command to delete VOLSER ranges. This task is a long-running task.
The command uses the following syntax:
deleteVolserRanges filename.txt
The deleteVolserRanges command receives a text file with one or more VOLSER ranges as input. Each line of the input file is interpreted as a VOLSER range to delete. The input file is in the following format: LLName,startRange,endRange. Consider the following points regarding the input file:
•LLName is the name of the logical library.
•startRange is the starting VOLSER in the range to delete.
•endRange is the ending VOLSER in the range to delete.
Example 5-26 shows an example of a deleteVolserRanges input file. The example input file instructs the system to delete the VOLSER that starts with TUU9RH and ends with TXX9RH from logical library 1.
Example 5-26 The ranges_to_delete.txt file
Library 1,TUU9RH,TXX9RH
Example 5-27 show the command. As each line of the input file executes successfully and each VOLSER range is deleted, the system returns the results to your display.
Example 5-27 The deleteVolserRanges command
deleteVolserRanges ranges_to_delete.txt
The Volser Range was removed successfully
Done
destageDataCartridges
Use the destageDataCartridges command to move cartridges from their cartridge cache locations as specified in a text file or by using a list of VOLSERs to a high-density slot. This command requires that all data cartridges that are being destaged are in tier 0.
The command uses the following syntax:
destageDataCartridges filename.txt or
destageDataCartridges [VOLSER1],[VOLSER2],[VOLSERX],...
The destageDataCartridges function can use a text file with one or more destage operations as input. The filename.txt variable specifies the file name of the input file. The text file is in one of the following formats:
•From a storage location: [F,C,R,T]
•VOLSER: [VOLSER]
Each line in the text file is interpreted as a prestage operation. In the text file, the data cartridge location can be specified with the [F,C,R,T] location or the VOLSER.
|
Note: All source cartridges that are being destaged must be in tier 0 (T0).
|
Example 5-28 shows a destageDataCartridges input file with the F,C,R,T reference.
Example 5-28 Input file with F,C,R,T reference
F1,C2,R8,T0
F1,C3,R18,T5
Example 5-29 shows a destageDataCartridges input file with a VOLSER reference.
Example 5-29 Input file with VOLSER reference
VOLSER UAA9RHL7
VOLSER UBB9RHL7
Example 5-30 shows an example of the destageDataCartridges command. When the destageDataCartridges command runs successfully, the system returns output to your display. The destageDataCartridges command instructs the system to destage the data cartridges from the correct library location based on the information in the destage.txt input file.
Example 5-30 The destageDataCartridges command
destageDataCartridges destage.txt
The cartridge [location] was moved successfully. Next element...
...
Done
downloadEvents
Use the downloadEvents command to export detailed information about all error, warning, and informational events saved in the library. It is sorted first by severity and second by time. This information is saved as a .csv file in the same directory in which the command was run.
The command uses the following syntax:
downloadEvents
When the downloadEvents command runs successfully, the system returns output to the display, as shown in Example 5-31.
Example 5-31 The downloadEvents command
downloadEvents
Downloading...536220/536220 bytes
The events file: TS4500_Events_2018-10-02_12.14.44.csv has been downloaded.
downloadLog
Use the downloadLog command to download a .zip file with the logs from all node cards. This command is useful for troubleshooting.
The command uses the following syntax:
downloadLog
The downloadLog command does not have any required parameters. It downloads all of the logs for all of the libraries. When the command runs successfully, the system returns output to your display, as shown in Example 5-32.
Example 5-32 The downloadLog command
downloadLog
Downloading... [completed] / [totalSize] has been downloaded.
The log file: "TS4500_FWLOGS_[yyyy-MM-dd_hh.mm.ss].zip has been downloaded.
downloadDrivesLog
Use the downloadDrivesLog command to download a .zip file containing the logs from the specified (or all) drives This command is useful for troubleshooting.
The command uses the following syntax:
downloadDrivesLog
driveCodeUpdate F#C#R#,F#C#R#, / ALL
Specify the drive locations of the drives, that you want to retrieve logs from. You can select to download all drives at the same time. Each drive location must be delimited by a comma. However, do not insert commas between the frame #, column #, and row #. The number sign (#) variables in the syntax have the following values:
F# Frame number of the drive to update
C# Column number of the drive to update
R# Row number of the drive to update
All All drives
The downloadDrivesLog command does not have any required parameters. It downloads the logs for all the drives requested, or using the All option will download from all drives. When the command executes successfully, the system returns output to your display, as shown in Example 5-33.
Example 5-33 The downloadDrivesLog command
downloadDrivesLog F1C1R1,F1C2R2
Gathering logs...
Downloading...3638135/3638135 bytes
The drivelog file: TS4500_DRIVELOGS_2017-06-06_11.41.58.zip has been downloaded 
downloadPropertiesFile
Use the downloadPropertiesFile command to download the properties file (IBM TotalStorage System Console (TSSC) file).
The command uses the following syntax:
downloadPropertiesFile
The downloadPropertiesFile does not have any required parameters. When the command executes successfully, the system returns output to your display, as shown in Example 5-34.
Example 5-34 The downloadPropertiesFile command
downloadPropertiesFile
Downloading... [completed] / [totalSize] has been downloaded.
The file: ""LIBLG_01_VP_[yyyy-MM-dd_hh.mm.ss] has been downloaded.
downloadResources
Use the downloadResoruces command to export detailed information about all resources of a specific type for this library. This information is saved as a .csv file. The format of this file matches the exported table information from the management GUI.
The command uses the following syntax:
downloadResources <LogicalLibraries,Drives,FibreChannelPorts,iSCSIPorts,Slots,Cartridges,VOLSERRanges,Users,Roles,ManagementEthernetPorts>
The file that is generated by microcode is saved to the working directory where the CLI is running. The name of this file should use the following format:
<lib name>_<lib S/N>_<resource_type>_<timestamp>.csv
In the case where “All” is selected, the filename is <library_name>_LibrarySummary_<timestamp>.csv. Otherwise, <resource_type> matches what is put into the command, as shown in Example 5-35.
Example 5-35 The downloadResources command
downloadResources LogicalLibraries
Downloading...372/372 bytes
The resources file: PFETS4500MZ_78AA004_LogicalLibraries_20181002T033045.csv has beeen downloaded.
Figure 5-1 shows output from the .csv file.
Figure 5-1 downloadResources .csv file example
downloadSnapshot
Use the downloadSnapshot command to display a list of all available snapshots in the library. You must run the viewSnapshots command before you run the downloadSnapshot command to display a current list of indexes.
The command uses the following syntax:
downloadSnapshot index
The index is the index number of the snapshot to download. (The index numbers are displayed with the viewSnapshots command.)
The snapshot file is downloaded to the same directory where the CLI is running. When the downloadSnapshot command runs successfully, the system returns output to your display, as shown in Example 5-36.
Example 5-36 The downloadSnapshot command
downloadSnapshot 1
Downloading... [completed] / [totalSize] has been downloaded.
..
The snapshot file: "TS4500_Snapshot_01122013.zip has been downloaded.
driveCodeUpdate
Use the driveCodeUpdate command to update the firmware in a specified drive or specified list of drives.
The command uses the following syntax:
driveCodeUpdate Filename of firmware image -l F#C#R#, F#C#R# --reset reset_option
The list of drives that you want to update must be preceded by an -l. Specify the drive locations of the drives that you want to update. Each drive location must be delimited by a comma. However, do not insert commas between the frame #, column #, and row #. The number sign (#) variables in the syntax have the following values:
F# Frame number of the drive to update
C# Column number of the drive to update
R# Row number of the drive to update
--reset Reset method for the drive after the code is updated
The following values are the valid values for the reset parameter:
IMMEDIATE The reset occurs immediately after the code is on the drive. The drive must be empty before the update. If the drive has a tape before you perform an IMMEDIATE reset, execute the moveFromDrive command to eject a cartridge from the drive.
UNLOAD The reset occurs after the drive is unloaded.
MANUAL A manual reset must be performed to activate the code.
When the command runs successfully, the driveCodeUpdate command instructs the system to update the drives in the list. The system returns output to your display. Example 5-37 shows that the system is instructed to update the drives in frame 1, column 4, row 2, and frame 1, column 4, row 3 by using the code update that is contained in the TS4500_1100-O4Q.afwz file.
Example 5-37 The driveCodeUpdate command
driveCodeUpdate TS4500_1100-O4Q.afwz -l F1C4R2,F1C4R3 --reset IMMEDIATE
The code update has started
Name: LTO6_DAQM.fcp_fh.fmrz
>>>Uploading file...
............................................................
Done
editKeyLabelMapping
Use the editKeyLabelMapping command to edit a key label mapping. You must run the viewKeyLabelMapping command before you run this command to see the index of the key label mapping that you want to edit. The command uses this syntax:
editKeyLabelMapping index,keyLabelFrom,keyModeFrom,keyLabelTo
Consider the following points regarding the command syntax:
•index is the index number of the key label to edit. You must run the viewKeyLabelMapping command to see the index number.
•keyLabelFrom is a string that cannot repeat in the list of key labels. The maximum length of this string is 50 characters.
•keyModeFrom is a parameter with the following possible values:
– Wrapped-Hash
– Wrapped-Default: Specifying this value for the keyModeFrom parameter disables the keyLabelTo parameter. Also, you do not need to specify a string value for the keyLabelTo parameter.
– Wrapped-Clear
– Direct-Default-Set
– Direct-Specific
•keyLabelTo is a string. The maximum length of this string is 50 characters.
When the editKeyLabelMapping command runs successfully, the system returns output to your display, as shown in Example 5-38. The editKeyLabelMapping command instructs the system to edit the key label mapping for index 1. The revised mapping is from the key label START to the key label END by using the Wrapped-Hash key mode.
Example 5-38 The editKeyLabelMapping command
editKeyLabelMapping 1,START,Wrapped-Hash,END
The Key Label Mapping was edited successfully
encrypt
Use the encrypt command to create an encrypted password that can be used with any other CLI command. When using an encrypted password in a command, use -ep instead of -p before the password.
The command uses the following syntax:
encrypt [PlainTextPassword] -ssl
Consider the following points:
•<PlainTextPassword> is a required field and is the plain text password that should be encrypted.
•-ssl is required if SSL (HTTPS) is enabled.
The encrypt command is shown in Example 5-39.
Example 5-39 The encrypt command
encrypt AdminPW1
xEeUtEr9
In this example, the command encrypted the password AdminPW1 and the TS4500 responded with an encrypted version of this password; therefore, any command after this can use the encrypted version. As shown in Example 5-40, the encrypted password xEeUtEr9 is used with the -ep parameter to run the viewSystemSummary command.
Example 5-40 Using the encrypted PW
java -jar TS4500CLI.jar -ip 10.129.251.127 -u admin -ep xEeUtEr9 --viewSystemSummary
getFWVersion
Use the getFWVersion command to return the FW version installed in the library.
The command uses the following syntax:
getFWVersion
When the getFWVersion command runs successfully, the system returns output to the display that is shown in Example 5-41
Example 5-41 Using the getFWVersion 
getFWVersion
Firmware Version: 1.5.0.1-601.00
modifyAdvancedEncSettings
Use the modifyAdvancedEncSettings command to make the advanced encryption settings more or less restrictive to data stored in a library.
The command uses the following syntax:
modifyAdvancedEncSettings <Logical Library Name>, <Advanced Method> [TRUE / FALSE], <Advanced Policy>, <Density code>, <keypath>
The following values are valid for Advanced Policy:
•No advanced setting = 0
•Do not encrypt if no policy = 1
•Encrypt if no policy = 2
•Policy required = 3
•Never encrypt (policy override) = 4
•Always encrypt (policy override) = 5
•Internal label: selective encryption = 6
•Internal label: encrypt all = 7
The following values are valid for the Density code setting:
•No advanced setting = 0
•Show encryption = 1
•Mask encryption = 2
The following values are valid for the keypath setting:
•No advanced setting = 1
•System = 2
•Application (IBM) = 3
•Application (T10) = 4
•Library = 6
In Example 5-42, the modifyAdvancedEncSettings operation modifies the encryption settings for Library1 by using the advanced policy that the system must encrypt the data if the data is not already attached to an encryption policy. The density code of 2 instructs the system to mask the encryption. The key path of 2 is an instruction that the path to the encryption key to encrypt the incoming data is stored in the system, rather than in the specific library or specific application.
Example 5-42 The modifyAdvancedEncSettings command
modifyAdvancedEncSettings Library1,TRUE,2,2,2
The advanced encryption settings for Logical Library Library1 were updated successfully
modifyBEP
Use the modifyBEP command to edit the cartridges’ bar code encryption policy. You must run the viewKeyLabelMapping and the viewBEP commands before you run this command to see the list of valid indexes.
The command uses the following syntax:
modifyBEP index -KLM1 # -BEP true/false -KLM2 #
Consider the following points regarding the command’s syntax:
index The index number of the cartridges’ encryption policy to edit. You must run the viewBEP command to see a current list of valid index numbers.
-KLM1 The index number of the key label mapping that contains the encryption policy to edit. You must run the viewKeyLabelMapping command to see a current list of valid index numbers.
-KLM2 Optional: An optional parameter to use if you want to edit encryption policies in a second key label mapping index.
-BEP A flag to enable BEP (value is true or false).
When the modifyBEP command runs successfully, the system returns output to your display. Example 5-43 shows the command that updates the cartridges’ bar code encryption policy in BEP index 1 and key label mapping index 3 with BEP not enabled.
Example 5-43 The modifyBEP command
modifyBEP 1 –KLM1 3 –BEP false
The cartridge encryption policy was updated successfully
modifyFibreChannelSettings
Use the modifyFibreChannelSettings command to set the ports’ speed and topology for a specified drive. The speed and topology are the same for both ports in the drive.
The command uses the following syntax:
modifyFibreChannelSettings speed,topology -f# -c# -r#
The following values are valid for speed:
•1
•2
•4
•8
•16 (for TS1160)
The following values are valid for topology:
•Auto-L
•L
•N
•Auto-N
|
Note: TS1160 does not support Loop mode.
|
The number sign (#) variables in the syntax have the following values:
-f# Frame number of the drive that contains ports 1 and 2
-c# Column number of the drive that contains ports 1 and 2
-r# Row number of the drive that contains ports 1 and 2
In Example 5-44, the modifyFibreChannelSettings operation sets the port speeds to 4 and the topology to N for both ports in the drive at frame 1, column 1, row 1.
Example 5-44 The modifyFibreChannelSettings command
modifyFibreChannelSettings 4,N -f1 -c1 -r1
The Fibre Channel settings were updated successfully
modifyVolserRanges
Use the modifyVolserRanges command to modify VOLSER ranges.
The command uses the following syntax:
modifyVolserRanges filename.txt
The modifyVolserRanges command receives a text file with one or more VOLSER ranges as input. Each line of the input file is interpreted as a VOLSER range to modify.
The input file is in the following format:
startRange,endRange,LLName,mediaType,Enable
The following parameter information is required:
•startRange is the starting VOLSER in the range to modify.
•endRange is the ending VOLSER in the range to modify.
•LLName is the name of the logical library that contains the VOLSER to modify.
•mediaType is LTO or 3592.
•Enable:
– TRUE = Enable this range for new cartridges only.
– FALSE = Do not enable this range for new cartridges only.
The startRange parameter and the endRange parameter are used to get the range index in the logical library table. These values cannot be modified.
Example 5-45 shows an input file that instructs the system to modify the VOLSER that starts with UAA9RH and ends with UBB9RH in logical library 1 for the 3592 frame. As a result of the TRUE flag for the Enable parameter, the VOLSER range is enabled for new cartridges.
Example 5-45 The volser_ranges.txt input file
UAA9RH,UBB9RH,Library 1,3592,TRUE
Example 5-46 shows an example of the modifyVolserRanges command. Although each line of the input file runs successfully and each VOLSER range is created, the system returns the results to your display.
Example 5-46 The modifyVolserRanges command
modifyVolserRanges volser_ranges.txt
The Volser Range was modified successfully
Done
modifyVolserReporting
Use the modifyVolserReporting command to set whether the VOLSER is reported to the host in a 6-character format or an 8-character format.
The command uses the following syntax:
modifyVolserReporting logical library name, flag value [6/8]
When this command runs successfully, the system returns the results of the modifyVolserReporting operation to your display. In Example 5-47, the modifyVolserReporting operation instructs the system to modify the VOLSER reporting to the host for the cartridges in Library1 to a 6-character format.
Example 5-47 The modifyVolserReporting command
modifyVolserReporting Library1,6
Volser Reporting flag was updated successfully
moveFromAllDrives
Use the moveFromAllDrives command to eject all cartridges from all full drives and move them to the home storage location. If the home storage location is unavailable, the moveFromAllDrives command moves the cartridge to the first empty slot. (If you want to eject a cartridge from a specific drive, use the moveFromDrive command.)
The command uses the following syntax:
moveFromAllDrives
This command does not require any parameters. It performs the eject function for all of the cartridges in all of the drives where cartridges are mounted.
When the moveFromAllDrives command runs successfully, the system returns output to your display, as shown in Example 5-48.
Example 5-48 The moveFromAllDrives command
moveFromAllDrives
The drive [location] is empty now. Moving to next drive...
...
Done. All drives are empty.
moveFromDrive
Use the moveFromDrive command to eject a single cartridge from a drive and move it to the home storage location. If the home storage location is unavailable, the moveFromDrive command moves the cartridge to the first empty slot. (If you want to eject a cartridge from the drive, and move it to a specific location, use the moveToDrive command.)
The command uses the following syntax:
moveFromDrive -f# -c# -r#
The number sign (#) variables in the syntax specify the drive where the cartridge is located before you eject it. The variables have the following values:
-f# Frame number of the moveFrom location
-c# Column number of the moveFrom location
-r# Row number of the moveFrom location
When the moveFromDrive command successfully executes, and the cartridge is successfully unmounted from the drive, the system returns output to your display. Example 5-49 shows that the system is instructed to eject the cartridge from the drive in frame 1, column 4, row 1, and place it in a storage slot.
Example 5-49 The moveFromDrive command
moveFromDrive -f1 -c4 -r1
The cartridge was ejected successfully
moveToDrive
Use the moveToDrive command to move a cartridge from a specified location to another specified location.
The command uses the following syntax:
moveToDrive F#,C#,R#,T# -f# -c# -r#
You must first specify the drive location of the cartridge that you want moved. Then, specify the destination where you want to move the cartridge.
The number sign (#) variables in the syntax have the following values:
F# Frame number of the drive for the moveFrom location
C# Column number of the drive for the moveFrom location
R# Row number of the drive for the moveFrom location
T# Tier number of the drive for the moveFrom location
-f# Frame number of the drive for the moveTo location
-c# Column number of the drive for the moveTo location
-r# Row number of the drive for the moveTo location
|
Note: The CLI is not case-sensitive. In the moveToDrive command, uppercase and lowercase letters are used to distinguish between the moveFrom location and the moveTo location.
|
When the moveToDrive command successfully runs and the cartridge is successfully mounted in the new location, the system returns output to your display.
Example 5-50 shows the command that instructs the system to move the cartridge in drive F1, C5, R1, T1 to the drive in f1, c4, r1. If the cartridge destination is in the same tier as the moveFrom location, you do not need to specify the tier number in the moveTo location.
Example 5-50 The moveToDrive command
moveToDrive F1,C5,R1,T1 -f1 -c4 -r1
The cartridge was mounted successfully
prestageDataCartridges
Use the prestageDataCartridges command to move cartridges from the high-density slots to cartridge cache locations, as specified in a text file or by using a list of VOLSERs. All data cartridges that are being prestaged must be in tier 3 or higher.
The command uses the following syntax:
prestageDataCartridges filename.txt or
prestageDataCartridges [VOLSER1],[VOLSER2],[VOLSERX],...
The prestageDataCartridges command can use a text file with one or more prestage operations as input. The filename variable specifies the file name of the input file.
The text file is in one of the following formats:
•From a storage location: [F,C,R,T]
•VOLSER: [VOLSER]
Each line in the text file is interpreted as a prestage operation. In the text file, the data cartridge location can be specified with the [F,C,R,T] location or the VOLSER.
|
Note: All cartridges that are being prestaged must be in tier 3 or higher.
|
Example 5-51 The prestageDataCartridges input file with the F,C,R,T reference
F1,C2,R8,T3
F1,C3,R18,T5
Example 5-52 The prestageDataCartridges input file with the VOLSER reference
UAA9RHL7
UBB9RHL7
When the prestageDataCartridges command runs successfully, the system returns output to your display.
Example 5-53 shows the command that instructs the system to prestage the data cartridges to the correct library location based on the information that is specified in the prestage.txt file.
Example 5-53 The prestageDataCartridges command
prestageDataCartridges prestage.txt
The cartridge [location] was moved successfully. Next element...
...
Done
removeDataCartridges
Use the removeDataCartridges command to remove the data cartridges from a storage location to the I/O station. If VIO is enabled for a particular cartridge, the removeDataCartridges command does not move the cartridge to the I/O station. It marks the cartridge as a cartridge that is ready for export. The cartridge appears as unassigned. If VIO is disabled, the cartridge moves to the I/O station.
The command uses the following syntax:
removeDataCartridges filename.txt
The removeDataCartridges command receives a text file with one or more remove operations as input. The text file is in the following format:
•[F,C,R,T]
•VOLSER
Each line in the text file is interpreted as a remove operation.
Example 5-54 shows a removeDataCartridges input file. In the first line of the text file, the data cartridge in storage slot location frame 1, column 2, row 8, tier 0 is moved to the I/O station. In the second line of the text file, the data cartridge in storage slot location frame 1, column 3, row 18, tier 5 is moved to the I/O station.
Example 5-54 The removeDataCartridges input file
F1,C2,R8,T0
F1,C3,R18,T5
UBB9RHL7
Example 5-55 shows the command that instructs the system to remove the data cartridges from a storage slot to the I/O station based on the information in the todays_removes.txt file. Example 5-55 shows the removeDataCartridges output.
Example 5-55 The removeDataCartridges output
removeDataCartridges todays_removes.txt
The cartridge [FCRT] has been removed successfully
...
Done
resetDrive
Use the resetDrive command to power-cycle a specific drive.
The command uses the following syntax:
resetDrive -f# -c# -r#
The number sign (#) variables specify the location of the drive and feature the following values:
-f# Frame number of the drive
-c# Column number of the drive
-r# Row number of the drive
When the resetDrive command runs successfully, the system returns output to your display, as shown in Example 5-56 on page 355.
Example 5-56 The resetDrive command output
resetDrive -f1 -c4 -r1
The drive was reset successfully
resetNodeCards
Use the resetNodeCards command to reset one or more specified node cards.
|
Note: There is no warning to cancel; therefore, use this command with care because running this command immediately resets the selected node card.
|
The command uses the following syntax:
resetNodeCards node_name_1, node_name_2, . . .
The parameters for this command are items in a list of comma-separated names of nodes to reset.
The following list shows the possible values of node names:
•ALL
•ALLLCA
•ALLACC
•ALLSMC
•ALLXYC
•ALLPLUS
•XYCPLUS
•ACCPLUS
•LCAPLUS
•XYA
•XYB
•OPC1
•SMC[2-16]
•ACCA
•ACCB
•LCA[1-31]
•LCAB[1-31]
When the resetNodeCards command runs successfully, the system returns output to your display. Example 5-57 shows the command where the system is instructed to reset the node cards in nodes LCA1, LCAB3, and ACCA.
Example 5-57 The resetNodeCards command
resetNodeCards LCA1,LCAB3,ACCA
The command was executed successfully
restoreConfiguration
Use the restoreConfiguration command to restore the configuration database to the library. The configuration file (configuration.db) is uploaded to the library.
The command uses the following syntax:
restoreConfiguration the_name_of_the configuration_file.db
You must specify the name of a configuration file to upload. The file name can be any name that you choose, but the file must have a .db extension. If the file is stored in the same directory where you are running the CLI, you do not need to enter a path name for the file. However, if the file is stored in a different directory, it is necessary to enter a path name for
the file.
the file.
When the restoreConfiguration command runs successfully, the system returns the result of the operation to your display, as shown in Example 5-58.
Example 5-58 The restoreConfiguration command
restoreConfiguration myconfig.db
Name: myconfig.db
>>>Uploading file...
Done
..
The configuration database has been restored successfully.
saveConfiguration
Use the saveConfiguration command to save the configuration database to the user’s computer. The configuration file (configuration_backup.db) is saved in the same directory in which the CLI is running. This command requires a service user and password.
The command uses the following syntax:
saveConfiguration
No parameters are necessary. When the saveConfiguration command runs successfully, the system returns the result of the operation to your display, as shown in Example 5-59.
Example 5-59 The saveConfiguration command
saveConfiguration
Downloading... [completed] / [totalSize] has been downloaded.
..
The configuration file: configuration_backup.db has been downloaded.
setAccessorZones
This command is for use on Dual accessor libraries on and used to specify which tape drives and I/O stations (within sets of frames) are served by which accessor. This command can also be used to deactivate an accessor.
By default, each accessor is zoned to serve half of the frames in the library. Therefore, in a 12-frame library, Accessor A serves frames 1 - 6 and Accessor B serves frames 7 - 12.
You can view the current accessor zone settings by using the viewAccessorZones command. You can also view these settings in the TS4500 management GUI in the Settings → Library → Cartridges and Accessors page. The Accessor Preferred Zones graphic is refreshed to reflect changes made both through the GUI and with the setAccessorZones command.
Elastic capacity settings made through the Cartridges and Accessors page are unaffected by zone changes made with the setAccessorZones command.
Use the no parameter to specify a different zone setting for an accessor, or to inactivate an accessor. The use of this command to inactivate an accessor is the same as inactivating it in the Cartridges and Accessors GUI page.
The command uses the following syntax:
setAccessorZones no,[frameNumber|0|255]
The parameters in the syntax have the following values:
•no: Do not use the default zone setting. Instead, use the setting specified here.
•frame Number from 1 to 18: Defines the last frame served by Accessor A. All remaining frames in the library are served by Accessor B:
– 0: Inactivate Accessor A.
– 255: Inactivate Accessor B.
The example that is shown in Example 5-60 restricts Accessor A to frames 1, 2, 3, 4, and 5. Accessor B serves the rest of the frames in the library.
Example 5-60 setAccessorZones to frame 5
setAccessorZones No,5
The accessor zones was updated successfully
The example that is shown in Example 5-61 restricts Accessor A to frames 1, 2, 3, 4, and 5. Accessor B serves the rest of the frames in the library.
Example 5-61 setAccessorZones default
setAccessorZones Yes,255
The accessor zones was updated successfully
setAutoEjectCleaningCarts
Use the setAutoEjectCleaningCarts command to set the enabled or disabled flag for the auto eject expired cleaning cartridges function in the library.
The command uses the following syntax:
setAutoEjectCleaningCarts enabled or disabled
Set the auto eject expired cleaning cartridges function flag:
•enabled = on
•disabled = off
When the setAutoEjectCleaningCarts command runs successfully, the system returns output to your display, as shown in Example 5-62.
Example 5-62 The setAutoEjectCleaningCarts command
setAutoEjectCleaningCarts enabled
The auto eject cleaning cartridges flag was set successfully
setDrivePortsId
Use the setDrivePortsId command to set the ports’ IDs for a specified drive (Port 1 and
Port 2).
Port 2).
The command uses the following syntax:
setDrivePortsIdPort1ID,Port2ID -f# -c# -r#
The number sign (#) variables in the syntax have the following values:
-f# Frame number of the drive that contains ports 1 and 2.
-c# Column number of the drive that contains ports 1 and 2.
-r# Row number of the drive that contains ports 1 and 2.
When the setDrivePortsId command runs successfully, the system returns the result of the operation to your display, as shown in Example 5-63.
Example 5-63 The setDrivePortsId command
setDrivePortsId 18,21 -f1 -c1 -r1
The ports IDs were updated successfully
setDriveUse
Use the setDriveuse command to set and configure the drive for media access, control path with media access, or media verification.
The command uses the following syntax:
setDriveUse -use [useaccess, controlPath, verification] -f# -c# -r#
The number sign (#) variables in the syntax have the following values:
-f# Frame number of the drive.
-c# Column number of the drive.
-r# Row number of the drive.
When the setDriveUse command runs successfully, the system returns the result of the operation to the display, as shown in Example 5-64.
Example 5-64 The setDrivePortsId command
--setDriveUse -use controlPath -f1 -C4 -R1
The drive was successfully updated
setISCSI
The setISCSI command updates the network configuration settings for a single Ethernet drive and to optionally change the name and alias of the drive. Each port can be configured separately with this command, whereas network changes that are made through the TS4500 management GUI are always applied to both ports.
To look up a drive’s current settings, use the viewISCSI command or refer to the Drives → Ethernet Ports GUI page
The command uses the following syntax:
setISCSI -portxAddress DHCP|[ip-address] -subnet [subnet-mask] -gateway [gateway-address] -name DEFAULT|[iSCSI-name] -alias [iSCSI-alias] -f# -c# -r#
The parameters have the following values:
•portxAddress DHCP | [ip-address]
Both ports can be modified at the same time. portxAddress is port0Address for port 0 or port1Address for port 1.
DHCP enables DHCP for the port selected.
•[ip-address] disables DHCP and assigns this value as the IP address for the specified port. (IPv4 format). You can specify the settings for one port or both ports in the same command.
•subnet [subnet-mask]. This is required if DHCP is being disabled. This is the subnet mask for the specified port.
•gateway [gateway-address]. This is required if DHCP is being disabled.This is the gateway for the specified port.
•name DEFAULT|[iSCSI-name]. This is optional. The name for the drive.
DEFAULT restores the drive name to the system-assigned name.
SCSI-name is the new name for the drive. A port ID is required when specifying this parameter, even though the name is applied to the drive. You can specify either port.
•alias [iSCSI-alias] is an optional parameter and sets a new alias for the drive. A port ID is required when specifying this parameter, even though the alias is applied to the drive. You can specify either port.
•[-f# -c# -r#] Is a required field and is the location of the drive, where:
– -f# = frame number
– -c# = column number
– -r# = row number
As shown in Example 5-65, the use of the command enables DHCP for port 0 of the drive in F1C4R1 and renames the drive to new-drive-name.
Example 5-65 setISCSI default command
setISCSI -port0Address DHCP -name new-drive-name -f1 -c4 -r1
The iSCSI Drive Port Settings were updated. 
As shown in Example 5-66, the use of the command disables DHCP for port 0 of the drive in F1C4R1. It also assigns the address 9.1.2.4 to port 0 and also assigns the provided subnet mask and gateway to the port.
Example 5-66 setISCSI set IP command
setISCSI -port0Address 9.1.2.4 -subnet 255.255.255.0 -gateway 9.1.0.100 -f1 -c4 -r1
The iSCSI Drive Port Settings were updated. 
As shown in Example 5-67 on page 360, the use of the command enables DHCP for port 0 and disables DHCP for port 1 of the drive in F1C4R1, and changes the alias for the drive to new-drive-alias.
Example 5-67 setISCSI alias command
setISCSI -port0Address DHCP -port1Address 9.1.2.5 -subnet 255.255.255.1 -gateway 9.1.0.100 -alias new-drive-alias -f1 -c4 -r1
The iSCSI Drive Port Settings were updated. 
setLibraryTime
The setLibraryTime command takes the date, time, and time zone in the server where the CLI is running and sets the library with those parameters.
The command uses the following syntax:
setLibraryTime
No parameters are necessary. When the setLibraryTime command runs successfully, the system returns the result of the operation to your display, as shown in Example 5-68.
Example 5-68 The setLibraryTime command
setLibraryTime
The library date and time were updated successfully
setMacAddress
The setMacAddress command changes the MAC address for an Ethernet port (or both ports). To look up a port’s current MAC address, use the viewMacAddress command or refer to the Drives → Ethernet Ports GUI page.
The command uses the following syntax:
setMacAddress -portxAddress DEFAULT|[MAC-address]} -portxAddress DEFAULT|[MAC-address] <-f# -c# -r#>
The parameters have the following values:
•portxAddress, Both ports can be modified at the same time. portxAddress is port0Address for port 0 or port1Address for port 1.
•DEFAULT returns the MAC address to its default setting.
•[MAC-address] is the new MAC address, expressed as a 12-digit hexadecimal number. It can be entered either with or without colons for example, 00:1a:64:eb:04:83 and 001a64eb0483 are both acceptable.
•-f# -c# -r# is required and is the location of the drive:
– -f# is the frame number
– -c# is the column number
– -r# is the row number
When the setMacAddress command runs successfully, the system returns the result of the operation to your display, as shown in Example 5-69. This example shows both accepted formats of the MAC address.
Example 5-69 The setMacAddress command
setMacAddress -port0Address 00:1a:64:eb:04:83 -port1Address 001a64eb0484 -f1 -c4 -r1
MAC address(es) updated.
setMaximumVIOCartridges
Use the setMaximumVIOCartridges command to update the number of virtual I/O slots for the logical library.
The command uses the following syntax:
setMaximumVIOCartridges logical library name, value [32-255]
The maximum number of cartridges can be any value 32 - 255. When this command runs successfully, the system returns the results of the setMaximumVIOCartridges operation to your display.
Example 5-70 The setMaximumVIOCartridges command
setMaximumVIOCartridges Library1,200
The MAX VIO was updated successfully
setNMADetection
Use the setNMADetection command to set (on or off) the No Motion Allowed (NMA) detection flag in the library.
The command uses the following syntax:
setNMADetection TRUE or FALSE
The parameter can have either of the following values:
TRUE NMA detection is on.
FALSE NMA detection is off.
When the setNMADetection command runs successfully, the system returns the result of the operation to your display, as shown in Example 5-71.
Example 5-71 The setNMADetection command
setNMADetection TRUE
The NMA detection flag was updated successfully
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.
The command uses the following syntax:
setRolePermissions filename_of_role_permissions.txt -role role name
The setRolePermissions command receives a text file (which was created by the viewRolepermissions command) as input. Each line in the text file is interpreted as an instruction to set a permission. The text file can be edited to change any of the access levels for the listed pages.
The following access levels are valid:
Read only The user has read-only access to the web page.
Modify The user can run the edit operation for the web page.
No Access The user cannot view the web page.
You can edit the text file to contain only the names of the web pages and permissions to change.
Example 5-72 shows the input file that was originally generated by the viewRolePermissions command. In this case, the input file is unchanged. However, you can edit the input file to contain only the specific permissions to change with the setRolePermissions command.
Example 5-72 The setRolePermissions input file
Action, Access Level
AIT, No Access
Cartridges, Modify
Cartridges by Logical Library, Modify
Cleaning Cartridges, Modify
Debug Messages, No Access
Drives, Modify
Drives by Logical Library, Modify
Email Notifications, Read Only
Email Recipients, Read Only
Encryption Internal, Read Only
Encryption Key Manager, Modify
Ethernet Ports, Modify
Events, Modify
Library Information, Modify
Licensed Functions, Modify
Logical Libraries, Modify
Management GUI Behavior, Modify
Master Console, No Access
Password Rules, Modify
Position Control, No Access
Remote Authentication, Modify
Roles, Modify
SNMP Destinations, Modify
SNMP Notifications, Modify
Scan Speed, No Access
Secure Socket Layer, Modify
Service Port, No Access
Syslogs Notifications, Modify
System, Modify
System, Modify
System Date and Time, Modify
Tasks, Modify
Users, Modify
VOLSER Ranges, Modify
VOLSER Ranges by Logical Library, Modify
When the setRolePermissions command runs successfully, the system returns output to your display. Example 5-73 shows the command that instructs the system to set the role permissions for the administrator role, according to information in the administrator_permissions.txt file.
Example 5-73 The setRolePermissions command
setRolePermissions administrator_permissions.txt role administrator
The permissions were updated successfully
setScannerSpeed
Use the setScannerSpeed command to set the speed of the scanner.
The command uses the following syntax:
setScannerSpeed speed
The following values for the speed variable are valid:
•0 (nominal speed)
•30
•40
•50
•60
•70
•80
•90
•100
When the setScannerSpeed command runs successfully, the system returns output to your display. Example 5-74 shows the command that instructs the system to set the scanner speed to 100.
Example 5-74 The setScannerSpeed command
setScannerSpeed 100
The scanner speed was updated successfully
setSlotOffline
Use the setSlotOffline command to set a storage slot offline.
The command uses the following syntax:
setSlotOffline -f# -c# -r#
The number sign (#) variables are defined in the following manner:
-f# Frame number of the slot
-c# Column number of the slot
-r# Row number of the slot
|
Note: When you use r =0, all rows for the specific column are set offline.
|
When the setSlotOffline command runs successfully, the system returns output to your display. Example 5-75 shows that the command was successful.
Example 5-75 The setSlotOffline command
setSlotOffline -f1 -c4 -r3
Storage Slot was set offline
setSlotOnlineUse the setSlotOnline command to set a storage slot online.
The command uses the following syntax:
setSlotOnline -f# -c# -r#
The number sign (#) variables are defined in the following manner:
-f# Frame number of the slot
-c# Column number of the slot
-r# Row number of the slot
|
Note: When you use r =0, all rows for the specific column are set online.
|
When the setSlotOnline command runs successfully, the system returns output to your display. Example 5-76 shows that the command was successful.
Example 5-76 The setSlotOnline command
setSlotOnline -f1 -c4 -r3
Storage Slot was set online
setSSL
Use the setSSL command to set the Secure Sockets Layer (SSL) flag to enabled or disabled.
The command uses the following syntax:
setSSL enabled or disabled
When the setSSL command runs successfully, the system returns output to your display. Example 5-77 shows the command that instructs the system to set the SSL flag to enabled.
Example 5-77 The setSSL command
setSSL enabled
The SSL flag was updated successfully
setUtilThreshold
Use the setUtilThreshold command to change the default values of the Capacity Utilization Threshold and the Dual Accessor Utilization Threshold.
If the number of cartridges exceeds the defined capacity utilization threshold, the Capacity POD in the monitor system page turns yellow. If this scenario occurs, it is possible to remove cartridges, increase capacity threshold, or purchase more capacity. By using this command, you can increase or decrease the value where the alert occurs.
The dual accessor utilization threshold (-daut) option is only applicable to the dual accessor libraries with elastic capacity enabled. It determines the threshold at which cartridges are moved to accessor service areas in the end frames. The default for DAUT is 98% and CUT is 99%.
The command uses the following syntax:
setUtilThreshold -daut # -cut #
The -cut, -daut, or both options can be used. Consider the following points:
•-daut values must be 90 - 100. Decimal places are not supported.
•The following -cut values can be used:
– 50, 55, 60, 65, 70, 75, 80, 85, and 90
– 91, 92, 93, 94, 95, 96, 97, and 98
– 99.0, 99.1, 99.2, 99.3, 99.4, 99.5, 99.6, 99.7, 99.8, and 99.9
When the setUtilThreshold command runs successfully, the system returns output to the display, as shown in Example 5-78.
Example 5-78 The setUtilThreshold command
setUtilThreshold -cut 97 -daut 97 
Use the viewUtilityThreshold command to display current settings.
showQueuedExports
Use the showQueuedExports command to set a flag to show or hide the list of queued exports. This command is useful to view the status of the recent export jobs, cancel active jobs, or remove any recent jobs from the list.
The command uses the following syntax:
showQueuedExports logical library name, flag value [true / false]
A flag value of true shows the queued exports list. A flag value of false hides the queued exports list.
When this command runs successfully, the system returns the results of the showQueuedExports operation to your display. Example 5-79 shows the command that shows the queued exports list for the Library1 logical library.
Example 5-79 The showQueuedExports command
showQueuedExports Library1, true
Queued exports flag was updated successfully
startInventory
Use the startInventory command to start the library inventory process.
The command uses the following syntax:
startInventory --library SINGLE|NO --audit FIRST|ALL> --frame ALL|<frameIdx>
To only audit tier 0 and 1 select --audit FIRST parameter. The --audit ALL parameter will do an inventory with full audit, so take care when to use this as it can take up to 45 minutes per frame to complete.
When the startInventory command runs successfully, the system returns output to the display, as shown in Example 5-80.
Example 5-80 The startInventory command
startInventory --library SINGLE --audit FIRST --frame 1
Inventory has started 
startCalibration
Use the startCalibration command to start calibration of the library, or components inside the library.
The command uses the following syntax:
startCalibration FRAME,<frame number>
DRIVE, <f#r#c#>
IO, <frameIndex,IOIndex>
ACCESSOR,<1=A,2=B>
When the startCalibration command runs successfully, the system returns output to the display, as shown in Example 5-81.
Example 5-81 The startCalibration command
startCalibration DRIVE,f2c3r1
Calibration has started 
startDriveService
Use the startDriveService command to prepare a drive service action. The drive will be not usable for applications. The drive location needs to be specified. A task is created and Progress can be monitored at the GUI.
The command uses the following syntax:
startDriveService -f# -c# -r#
The number sign (#) variables specify the location of the drive, and have the following values:
•-f# Frame number of the drive
•-c# Column number of the drive
•-r# Row number of the drive
When the startDriveService command executes successfully, the system returns output to your display, as shown in Example 5-82.
Example 5-82 The startDriveService command
startDriveService -f3 -c2 -r1
The drive Service has started
startDiscoverHW
Use the startDiscoverHW command to start the library hardware discovery. There are two options available:
•OVERWRITE <frames> deletes all existing configuration data for the specified frames and re-creates the data.
•<frames> saves the existing configuration data for the specified frames and adds information for any new hardware that is discovered.
The command uses the following syntax:
startDiscoverHW OVERWRITE,f#,f#,f#
or
startDiscoverHW f#,f#,f#
When the startDiscoverHW command runs successfully, the system returns output to the display, as shown in Example 5-83.
Example 5-83 The startDiscoverHW command
startDiscoverHW 1,2,3
Discover HW has started
startLibraryVerify
Use the startLibraryVerify command to start the library verification process for I/O stations. When the command completes, you are prompted to open all I/O station doors and then run the continueLibraryVerify command. Library verification is a three-step process in which the following commands must be run in the order in which they are listed:
•startLibraryVerify
•continueLibraryVerify
•continueCloseLibraryVerify
The command uses the following syntax:
startLibraryVerify
When the startLibraryVerify command runs successfully, the system returns output to the display, as shown in Example 5-84.
Example 5-84 The startLibraryVerify command
startLibraryVerify
Library verify - IO stations - has started...Library verify in progress
............................................................................................Done!
Next step: OPEN all IO doors , and then use "continueLibraryVerify" command to continue the test 
unassignDrive
Use the unassignDrive command to unassign a specific drive.
The command uses the following syntax:
unassignDrive F#C#R#
The number sign (#) variables are defined in the following manner:
-f# Frame number of the drive
-c# Column number of the drive
-r# Row number of the drive
When the unassignDrive command runs successfully, the system returns output to the display, as shown in Example 5-85.
Example 5-85 The unassignDrive command
unassignDrive F2C3R4
The drive was unassigned successfully
version
Use the version command to view the current version of the Gen 4 TS4500 Web Interface CLI program.
The command uses the following syntax:
version
When the version command runs successfully, the system returns output to your display, as shown in Example 5-86.
Example 5-86 The version command
version
CLI GEN 4 Version: 1.29
Build: 05/15/2017 
viewAccessor
Use the viewAccessor command to show the accessor’s status and usage statistics. This command has no parameters.
When the viewAccessor command runs successfully, the system returns output to your display, as shown in Example 5-87.
Example 5-87 The viewAccessor command
viewAccessor
Availability
, Accessor A
Accessor, OK - Online
Gripper 1, OK - Online
Gripper 2, OK - Online
Usage Statistics
, Accessor A Component
Pivots, 195
Gripper 1 gets, 5
Gripper 1 puts, 5
Gripper 2 gets, 1
Gripper 2 puts, 1
Bar code scans, 9355
X travel (meters), 112
Y travel (meters), 138
viewAccessorZones
Use the viewAccessorZones command to view which tape drives and I/O stations (within sets of frames) are served by which accessor. You can also view these settings in the TS4500 management GUI in the Settings → Library → Cartridges and Accessors page.
The command uses the following syntax:
viewAccessorZones > outputfilename.csv
Use the viewAccessorZones > outputilename.csv command to instruct the system to generate a .csv file from the output by entering a name as a parameter to the command for the file that is generated, as shown in the following example:
viewNodeCards > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-88.
Example 5-88 The viewAccessorZones command
viewAccessorZones
Accessor A: 1 - 12
Accessor B: 13 - 16
viewAdvancedEncryptionSettings
Use the viewAdvancedEncryptionSettings command to view high-level information for the encryption settings for a specific logical library.
The command uses the syntax:
viewAdvancedEncryptionSettings [Logical Library Name]
The viewAdvancedEncryptionSettings command displays information for all of the encryption settings for a specific logical library that is named Redbooks, as shown in Example 5-89.
Example 5-89 The viewAdvancedEncryptionSettings command
viewAdvancedEncryptionSettings Redbooks
Name: Redbooks
Advanced Method: No advanced setting
Advanced Policy: No advanced setting
Density Code: No advanced setting
Key Path: No advanced setting
viewBEP
Use the viewBEP command to show a list of all VOLSER ranges that shows the bar code encryption policy (BEP) settings. This command has no parameters.
When the viewBEP command runs successfully, the system returns output to your display, as shown in Example 5-90.
Example 5-90 The viewBEP command
viewBEP
Index,Volser Start, Volser End, Logical Library, Media Type, KLM1, KLM2, BEP
1, JK0000, JK0009, SLS_JAG1, 3592, 0, 0, 0
2, RBD000, RBD099, Redbooks_custom, 3592, 0, 0, 0
3, RBA000, RBA999, LTFS_redbooks, 3592, 0, 0, 0
4, DF0000, DF9999, Redbooks_custom, 3592, 0, 0, 0
viewCleaningCartridges
Use the viewCleaningCartridges command to view high-level information for all cleaning cartridges in a library.
The command uses the following syntax:
viewCleaningCartridges
The viewCleaningCartridges command does not require any parameters. It instructs the system to display information for all of the cleaning cartridges in the library. When the viewCleaningCartridges command runs successfully, the system returns output to your display.
The output file sorts the names of the cleaning cartridges by VOLSER, as shown in Example 5-91.
Example 5-91 The viewCleaningCartridges command
viewCleaningCartridges
Volume Serial, Logical Library,Element Address, Media Type, Location(F,C,R),Cleans remaining, Most Recent use
CLN305L1, 255, null, LTO, Slot(F1,C6,R16,T0), 0, 04/25/2014 00:50:04
CLN510L1, 255, null, LTO, Slot(F1,C6,R12,T0), 25, 05/08/2014 05:35:54
The same command can generate a .csv file that is downloaded into the directory of the TS4500CLI.jar file. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewCleaningCartridges > any_name_you_want.csv
No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command. The command is shown in Example 5-92.
Example 5-92 Use viewCleaningCartridges to generate a .csv file
viewCleaningCartridges > C:CLICVSFilescleaning_cartridges.csv
|
Note: All view commands can generate a .csv file by adding the > any_name_you_want.csv parameter at the end of the command.
|
viewDataCartridges
Use the viewDataCartridges command to view the high-level information for all data cartridges in a library.
The command uses the following syntax:
viewDataCartridges
The viewDataCartridges command does not require any parameters. It lists the information for all data cartridges in the library. When the viewDataCartridges command runs successfully, the system returns output to your display. The output file sorts the names of the data cartridges by VOLSER, as shown in Example 5-93.
Example 5-93 The viewDataCartridges command
viewDataCartridges
Volume Serial, Logical Library,Element Address, Media Type, Location(F,C,R),Encryption, Most Recent use
IM1338L7, Unassigned, Unknown, LTO, Slot(F1,C3,R1,T2), Unknown, 04/24/2014 08:39:34
IM1364L7, FC_LTO6_5856, 1054, LTO,Slot(F4,C8,R38,T0), Not Encrypted, 05/07/2014 15:24:24
IM1364L7, FC_LTO6_5856, 1265, LTO,Slot(F4,C8,R38,T0), Not Encrypted, 05/07/2014 15:24:24
You can use the viewDataCartridges command to instruct the system to generate a .csv file from the output by typing a name as a parameter to the command for the file that is generated.
The command uses the following syntax:
viewDataCartridges > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-94.
Example 5-94 The viewDataCartridges command with a .csv file
viewDataCartridges > C:CLICVSFiles odays_data_cartridges.csv
|
Note: All view commands can generate a .csv file by adding the > any_name_you_want.csv parameter at the end of the command.
|
viewDriveDetails
The viewDriveDetails command provides a display of key information about the drive that is useful for troubleshooting. It displays the contents of the drive, name of the logical library, worldwide node numbers (WWNNs), port ID information, and so on.
The command uses the following syntax:
viewDriveDetails -f# -c# -r#
The number sign (#) variables specify the location of the drive, and have the following values:
-f# Frame number of the drive
-c# Column number of the drive
-r# Row number of the drive
When the viewDriveDetails command runs successfully, the system returns output to your display, as shown in Example 5-95 on page 372.
Example 5-95 The viewDriveDetails command
viewDriveDetails -f 1 -c 4 -r 1
Location(F,C,R) F1, C4, R1
State ONLINE
Type 3592-E07
Logical Library Redbooks_custom
Control Path Enabled
Contents Empty
Firmware 38A7
WWNN 50050763001a000c
Element Address 257
Drive Display ND
Port 0
Loop ID 13
WWPN 005a000c
Port 1
Loop ID 77
WWPN 009a000c
The viewDriveDetails command includes a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewDriveDetails > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to the display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-96.
Example 5-96 The viewDriveDetails command with a .csv file
viewDriveDetails -f1 -c1 -r3 > C:CLICVSFilesdrive_details.csv
|
Note: All view commands generate a .csv by adding the > any_name_you_want.csv parameter at the end of the command.
|
viewDrivePod
Use the viewDrivePod command to display the drive portion of the status Pods. Pods in the bottom of the GUI System page show a quick view of capacity, drive utilization, and library health status. This pod is for drive status. The command uses the following syntax:
viewDrivePod
This command does not require any parameters. It lists a summary of information for all drives in the library. When the viewDrivePod runs successfully, the system returns output to the display, as shown in Example 5-97.
Example 5-97 The viewDrivePod command
viewDrivePod
[{"clazz":"com.ibm.storage.anaconda.events.DriveStationEvent","drivesInUse":0,"libraryIdx":-1,"libraryName":"","podStatus":"HEALTHY","totalDrives":12,"topic":"DRIVE_STATION","id":70800,"arguments":null,"timestamp":1538729795448,"topic":"DRIVE_STATION"}]
|
Note: All view commands generate a .csv by adding the > any_name_you_want.csv parameter at the end of the command.
|
viewDriveSummary
Use the viewDriveSummary command to show all of the drives in the library. This summary information is useful to network administrators who decide where to mount a cartridge. If you want to list detailed information about a specific drive, use the viewDriveDetails command.
The command uses the following syntax:
viewDriveSummary
This command does not require any parameters. It lists a summary of information for all drives in the library. When the viewDriveSummary runs successfully, the system returns output to your display, as shown in Example 5-98.
Example 5-98 The viewDriveSummary command
viewDriveSummary
Location(F,C,R), State, Type, Contents, Firmware, Serial, WWWNN,Element Address,Logical Library
F1, C4, R1, ONLINE,3592-E07, Empty, 38A7 , 0000013B008E, , 257,Redbooks_custom
F1, C4, R4, ONLINE,3592-E07, Empty, 38A7 , 0000013B006F, , 258,Redbooks_custom
The viewDriveSummary command can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewDriveSummary > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-99.
Example 5-99 The viewDriveSummary command with a .csv file
viewDriveSummary > C:CLICVSFilesdrive_summary.csv
viewDriveVPD
Use the viewDriveVPD command to show vital product data (VPD) information for all drives. The viewDriveVPD command is useful if an administrator or IBM service support representative (SSR) needs to see information, such as a product model number, product release level, or other information that is specific to the device type.
The command uses the following syntax:
viewDriveVPD
The viewDriveVPD command does not require any parameters. It lists all of the vital product data for all of the drives in the library.
When the viewDriveVPD command runs successfully, the system returns output to your display, as shown in Example 5-100.
Example 5-100 The viewDriveVPD command
viewDriveVPD
Location(F,C,R), Drive Type,Firmware Version, Machine Type, Serial number
F1, C4, R1, 3592-E07, 38A7 , 3592, 00013B008E
F1, C4, R4, 3592-E07, 38A7 , 3592, 00013B006
The viewDriveVPD command can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewDriveVPD > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-101.
Example 5-101 The viewDriveVPD command with a .csv file
viewDriveVPD > C:CLICVSFilesdrive_VPD.csv
viewFibreChannel
|
Note: All view commands generate a .csv by adding the > any_name_you_want.csv parameter at the end of the command.
|
Use the viewFibreChannel command to show the Fibre Channel settings for both ports in each drive. This command is useful to view the configuration of the ports for the Fibre Channel switch and to ensure that the ports are configured correctly to be compatible with the type of network in use.
The command uses the following syntax:
viewFibreChannel
The viewFibreChannel command does not require any parameters. When the viewFibreChannel command runs successfully, the system returns output to your display. The output file sorts the information by drive name, as shown in Example 5-102.
Example 5-102 The viewFibreChannel command
viewFibreChannel
Drive,Location(F,C,R),Logical Library, Type, Port(1,2), Link Status,Configured Link Speed,Configured Topology,Actual Link Speed,Actual Topology
0000013B008E, F1, C4, R1,Redbooks_custom, 3592-E07, 13, No light, Auto, Auto (L Port), Auto, L Port
, , , , 77, No light, Auto, Auto (L Port), Auto, L Port
0000013B006F, F1, C4, R4,Redbooks_custom, 3592-E07, 16, No light, Auto, Auto (L Port), Auto, L Port
, , , , 80, No light, Auto, Auto (L Port), Auto, L Port
The viewFibreChannel command can include a parameter that instructs the system to generate a .csv file from the output. Type a name, as a parameter to the command, for the file that is generated:
viewFibreChannel > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-103.
Example 5-103 The viewFibreChannel command with a .csv file
viewFibreChannel > C:CLICVSFilesfibre_channel_settings.csv
viewIoStation
Use the viewIoStation command to view a summary of information for all cartridges in the I/O station. The command uses the following syntax:
viewIoStation
The viewIoStation command does not require any parameters. It lists the high-level information for all cartridges in the I/O station. When the viewIoStation command runs successfully, the system returns output to your display, as shown in Example 5-104.
Example 5-104 The viewIoStation command
viewIoStation
Volume Serial,Logical Library,Element Address,Media Type,Location(F,C,R),Encryption
M000NTJL, Logical Library 1, 1046, JAG, I/O Slot(F1,C5,R4,T1), Not Encrypted
M001NTJL, Logical Library 1, 1294, JAG, I/O Slot(F1,C6,R29,T0), Not Encrypted
Use the viewIoStation command (and all view commands) to instruct the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewIoStation > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-105.
Example 5-105 The viewIoStation command with a .csv file
viewIoStation > C:CLICVSFilesviewIoStation.csv
viewISCSI
Use the viewISCSI command to configuration settings for a specific Ethernet drive.
The command uses the following syntax:
viewISCSI -f# -c# -r#
The number sign (#) variables specify the location of the drive, and have the following values:
-f# Frame number of the drive
-c# Column number of the drive
-r# Row number of the drive
When the viewISCSI command runs successfully, the system returns output to your display, as shown in Example 5-106.
Example 5-106 The viewiCSI command
viewISCSI -f4 -c3 -r1
iSCSI name: naa.032165478954
iSCSI alias: Drive05
DHCP: Disabled
Port 0 address: 9.1.2.3
Port 1 address: 9.1.2.4
Gateway: 9.1.0.100
Subnet mask: 255.255.255.0
viewKeyLabelMapping
Use the viewKeyLabelMapping command to view the list of available key labels. The command uses the following syntax:
viewKeyLabelMapping
When the viewKeyLabelMapping command runs successfully, the system returns output to the display, as shown in Example 5-107.
Example 5-107 The viewKeyLabelMapping command
viewKeyLabelMapping
Index, Map From Key Label, Key Mode, Map To Key Label
1, REDB, Wrapped-Hash, END
2, REDB1, Direct-Default-Set, 0
3, REDB1, Direct-Specific, Red1
The values in the Index column are referenced when you run the editKeyLabelMapping and deleteKeyLabelMapping commands.
viewLibraryVPD
Use the viewLibraryVPD command to show VPD for the library. This command is useful if an administrator or service engineer must see the model or serial number or other information specific to the library. This command requires a service user to run.
The command uses the following syntax:
viewLibraryVPD
When the viewLibraryVPD command runs successfully, the system returns output to your display, as shown in Example 5-108.
Example 5-108 The viewLibraryVPD command
viewLibraryVPD
Location, Machine Type, Model, Serial Number,Media Type
Frame 1, 3584, D25, 78CAFFF, 3592
Frame 2, 3584, L25, 78AAFFD, 3592
Frame 3, 3584, D55, 78DFFDS LTO
The viewLibraryVPD command (and all view commands) can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewLibraryVPD > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-109.
Example 5-109 The viewLibraryVPD command with a .csv file
viewLibraryVPD > C:CLICVSFilesloglib_VPD.csv
viewLogicalLibraries
Use the viewLogicalLibraries command to list the high-level information for all logical libraries. If you must list detailed information for a specific library, use the viewLogicalLibraryDetails command.
The command uses the following syntax:
viewLogicalLibraries
The viewLogicalLibraries command does not require any parameters. It lists the information for all logical libraries. When this command runs successfully, the system returns output to your display, as shown in Example 5-110.
Example 5-110 The viewLogicalLibraries command
viewLogicalLibraries
Name, Type, Assigned Cartridges, Virtual I/O cartridges, Drives,Encryption Method, Queued Exports,VOLSER Reporting (6/8 characters)
LTFS_redbooks, 3592, 23, 0, 4, No, Show, 8
Redbooks_custom, 3592, 235, 0, 2, Application managed, Show, 8
SLS_JAG1, 3592, 197, 0, 3, No, Show, 8
|
Note: The Queued Exports information and the VOLSER Reporting information are available only through the viewLogicalLibraryDetails command at the CLI. This information is not available through the TS4500 management GUI.
|
The viewLogicalLibraries command can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewLogicalLibraries > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-111.
Example 5-111 The viewLogicalLibraries command
viewLogicalLibraries > C:CLICVSFilesviewLogicalLibraries.csv
viewLogicalLibraryDetails
Use the viewLogicalLibraryDetails command to show the name, type, maximum number of cartridges, number of virtual I/O slot addresses, and number of drive addresses in a specified logical library.
The command uses the following syntax:
viewLogicalLibraryDetails "logical library name"
|
Important: Parameters for the viewLogicalLibraryDetails command must be enclosed in double quotation marks.
|
When the viewLogicalLibraryDetails command runs successfully, the system returns output to your display, as shown in Example 5-112.
Example 5-112 The viewLogicalLibraryDetails command
viewLogicalLibraryDetails "library 1"
Name, Type, Max Cartridges, Virtual I/O slot addresses,Drive Addresses,
Library1, 3592, 1000, 130(768-897), 68(257-321)
The viewLogicalLibraryDetails command (and all view commands) can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewLogicalLibraryDetails > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-113.
Example 5-113 The viewLogicalLibraryDetails command with a .csv file
viewLogicalLibraryDetails "library 1" > C:CLICVSFilesloglib_details.cs
viewMacAddress
Use the viewMacAddress command to look up the MAC addresses for a drive’s Ethernet ports.
The command uses the following syntax:
viewMacAddress -f# -c# -r#
The number sign (#) variables specify the location of the drive, and have the following values:
-f# Frame number of the drive
-c# Column number of the drive
-r# Row number of the drive
When the viewMacAddress command runs successfully, the system returns output to your display, as shown in Example 5-114.
Example 5-114 The viewMacAddress command
viewMacAddress -f4 -c3 -r1
Port 0 MAC Address: 00:1a:64:eb:04:83
Port 1 MAC Address: 00:1a:64:eb:04:84 
viewNodeCards
Use the viewNodeCards command to show a summary of information about the node cards.
The command uses the following syntax:
viewNodeCards
The viewNodeCards command does not require any parameters. It lists the high-level information for all node cards in the system. When the viewNodeCards command runs successfully, the system returns output to your display, as shown in Example 5-115.
Example 5-115 The viewNodeCards command
viewNodeCards
Card name, Location,Part number,Serial number, Firmware version
XY Card A, Accessor A, 95P8618, YN11MA42NF87,
XY Card B, Accessor B, 95P8618, YN11MA57SGZD,
Accessor Controller Card A, Accessor A, 46X5961, YN10MA42WFLT,
Accessor Controller Card B, Accessor B, 46X5961, YN10MA5AH03L,
LCC A, Frame 1, 12X5001, Y1Y0103CK628, 1.4.0.1-A02.00
LCC A, Frame 2, 12X5001, Y1Y01055B01N, 1.4.0.1-A02.00
LCC A, Frame 3, 12X5001, Y1Y01077761G, 1.4.0.1-A02.00
Use the viewNodeCards command to instruct the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewNodeCards > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-116.
Example 5-116 The viewNodeCards command with a .csv file
viewNodeCards > C:CLICVSFiles
ode_cards.csv
viewOfflineComponents
Use the viewOfflineComponents command to show a list of offline slots.
The command uses the following syntax:
viewOfflineComponents
The viewOfflineComponents command does not require any parameters. It lists all offline storage slots. When the viewOfflineComponents command runs successfully, the system returns output to your display, as shown in Example 5-117.
Example 5-117 The viewOfflineComponents command
viewOfflineComponents
Frame, Column ,Row , Status
1 , 3 , 1 , Offline
1 , 3 , 2 , Offline
1 , 3 , 3 , Offline
Use the viewOfflineComponents command to instruct the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewOfflineComponents > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-118.
Example 5-118 The viewOfflineComponents command with a .csv file
viewOfflineComponents > C:CLICVSFilesOffline_Slots.csv
viewPasswordAndSessionPolicy
Use the viewPasswordAndSessionPolicy command to display the settings for GUI Sessions and the password characteristics set.
The command uses the following syntax:
viewPasswordAndSessionPolicy
When the viewPasswordAndSessionPolicy command runs successfully, the system returns output to the display, as shown in Example 5-119.
Example 5-119 The viewPasswordAndSessionPolity command
viewPasswordAndSessionPolicy
Automatic logout: 60
Password lock: 10 attempts
Automatic IMC (local GUI) login at power on: Disabled
Minimum number of characters: 8
Minimum number of upper case characters: 1
Minimum number of lower case characters: 1
Minimum number of numeric characters: 1
Minimum number of special characters: 0
Maximum identical consecutive characters: 2
Maximum password age: 90 day(s)
Minimum password age: 1 day(s)
Number of unique passwords before reusing: 8
viewRolePermissions
Use the viewRolePermissions command to display a list of all of the permissions for a specified role. The output shows a list of the web pages in the library that are available to that role, and the corresponding access level.
The command uses the following syntax:
viewRolePermissions role name filename.txt
The filename.txt variable is optional. When you specify a file name, you instruct the system to generate a .txt file that can be used with the setRolePermissions command. The system generates the .txt file and stores it in the directory that contains the TS4500CLI.jar file. The text file can be edited to change any of the access levels for the listed pages.
The following access levels are valid:
Read only The user has read-only access to the web page.
Modify The user can execute the edit operation for the web page.
No Access The user cannot view the web page.
When the viewRolePermissions command runs successfully, the system returns output to your display, as shown in Example 5-120.
Example 5-120 The viewRolePermissions command
viewRolePermissions Redbooks name role.txt
Action, Access Level
AIT, No Access
Cartridges, Modify
Cartridges by Logical Library, Modify
Cleaning Cartridges, Modify
Debug Messages, No Access
Drives, Modify
Drives by Logical Library, Modify
Email Notifications, Modify
Email Recipients, Modify
Encryption Internal, Modify
Encryption Key Manager, Modify
Ethernet Ports, Modify
Events, Modify
Library Information, Modify
Licensed Functions, Modify
Logical Libraries, Modify
Management GUI Behavior, Modify
Master Console, No Access
Password Rules, Modify
Position Control, No Access
Remote Authentication, Modify
Roles, Modify
SNMP Destinations, Modify
SNMP Notifications, Modify
Scan Speed, No Access
Secure Socket Layer, Modify
Service Port, No Access
Syslogs Notifications, Modify
System, Modify
System Date and Time, Modify
Tasks, Modify
Users, Modify
VOLSER Ranges, Modify
VOLSER Ranges by Logical Library, Modify
viewRoles
Use the viewRoles command to display a list of all of the defined roles in the library.
The command uses the following syntax:
viewRoles
The viewRoles command does not require any parameters. It instructs the system to display information for all roles in the library. When the viewRoles command runs successfully, the system returns output to your display, as shown in Example 5-121.
Example 5-121 The viewRoles command
viewRoles
Role,Mapped users
Administrator, 5
Superuser, 0
Service, 2
Monitor, 1
Custom1, 0
Redbooks, 0
RemoteAcc, 0
The viewRoles command can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated.
The command uses the following syntax:
viewRoles > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-122.
Example 5-122 The viewRoles command with a .csv file
viewRoles > C:CLICVSFilesRoles.csv
viewSnapshots
Use the viewSnapshots command to display a list of all available snapshots in the library. The files in the list can be used with the downloadSnapshot command.
The command uses the following syntax:
viewSnapshots
The viewSnapshots command does not require any parameters. It instructs the system to display information for all available snapshots in the library. When the viewSnapshots command runs successfully, the system returns output to your display, as shown in Example 5-123.
Example 5-123 The viewSnapshots command
viewSnapshots
1 - TS4500_SS_FA010_20140515124107.zip
2 - TS4500_SS_FA010_20140519105428.zip
3 - TS4500_SS_FA010_20140519105917.zip
4 - TS4500_SS_FA010_20140519110938.zip
5 - TS4500_SS_FA010_20140520213407.zip
6 - TS4500_SS_FA010_20140520213706.zip
The viewSnapshots command (and all view commands) can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated:
viewSnapshots > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-124.
Example 5-124 The viewSnapshots command with a .csv file
viewSnapshots > C:CLICVSFilesSnapshots.csv
viewStorageCapacity
Use the viewStorageCapacity command to view the licensed media types. It provides more information about how each slot type (LTO / JAG) is licensed and how many slots are in use.
The command uses the following syntax:
viewStorageCapacity
The viewStorageCapacity command does not require any parameters. When the command runs successfully, the system returns output to your display, as shown in Example 5-125.
Example 5-125 The viewStorageCapacity command
viewStorageCapacity
[{"librarymediatype":"2","licensed_jag_used":"453","licensed_lto":"970","licensed_jag":"1210","licensed_lto_used":"5"}]
viewSystemSummary
Use the viewSystemSummary command to view the physical library system summary. The viewSystemSummary command is useful for users who want to view information about each frame, or see a summary of the total storage capacity.
The command uses the following syntax:
viewSystemSummary
The viewSystemSummary command does not require any parameters. It lists the information about each frame in ascending order by frame number. When the viewSystemSummary command runs successfully, the system returns output to your display, as shown in Example 5-126.
Example 5-126 The viewSystemSummary command
viewSystemSummary
Frame: 1
State: Door Closed
Media Type: 3592
Data Cartridges: 0
Storage Slots: 660
Drives: 2
MTM: 3584L25
S/N: 13FA010
--------------------------------------------
Frame: 2
Accessors: OK - Online
State: Door Closed
Media Type: 3592
Data Cartridges: 15
Storage Slots: 875
Drives: 0
MTM: 3584D25
S/N: 13FA107
--------------------------------------------
Total storage slots: 1535
Total storage cartridges 15
Total IO slots: 0
Total IO cartridges 13
Total Drives: 2
Total Frames 2
The viewSystemSummary command can instruct the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewSystemSummary > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-127.
Example 5-127 The viewSystemSummary command with a .csv file
viewSystemSummary > C:CLICVSFilessystem_summary.csv
viewSystemSummaryDetails
Use the viewSystemSummaryDetails command to view detailed information about a specified frame. The viewSystemSummaryDetails command does not instruct the system to list summary information about all frames in the library. If you must view summary information about all frames in the library, use the viewSystemSummary command.
The command uses the following syntax:
viewSystemSummaryDetails frame#
The pound sign (#) variable in the command specifies the frame number of the frame for which you want more information. If the input frame is not available in the library, the system displays an error message.
When the viewSystemSummaryDetails command runs successfully, the system returns output to your display, as shown in Example 5-128.
Example 5-128 The viewSystemSummaryDetails command
viewSystemSummaryDetails 2
Frame: 2
State: Door Closed
Media Type: 3592
Data Cartridges: 206
Storage Slots: 550
Drives: 4
Upper IO cartridges: 0
Upper IO door slots: 16
Upper IO door media type: 3592
Lower IO cartridges: 0
Lower IO door slots: 16
Lower IO door media type: 3592
MTM: 3584D25
S/N: 78D3746
The viewSystemSummaryDetails command can instruct the system to generate a .csv file from the output. Enter a name, as a parameter to the command for the file that is generated, as shown in the following example:
viewSystemSummaryDetails > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-129.
Example 5-129 The viewSystemSummaryDetails command with a .csv file
viewSystemSummaryDetails > C:CLICVSFilessystem_summary_Detail.csv
|
Note: The system does not display any information about accessors if the specified frame does not have accessors.
|
viewUsers
Use the viewUsers command to display a list of all of the users in the library.
The command uses the following syntax:
viewUsers
The viewUsers command does not require any parameters. It instructs the system to display information for all users in the library. When the viewUsers command runs successfully, the system returns output to your display, as shown in Example 5-130.
Example 5-130 The viewUsers command
viewUsers
Name,Locked, State, Role, Email, Last login
admin, , Disconnected, Administrator,,Wednesday, May 14, 2014, 06:20:16 AM MST
admin2, , Disconnected, Administrator,, Tuesday, April 8, 2014, 07:02:48 AM MST
LocalGUI, , Disconnected, Monitor,, Tuesday, May 20, 2014, 02:43:50 PM MST
Redbooks, , Connected, Administrator,,Wednesday, May 21, 2014, 09:33:06 AM MST
Service, , Disconnected, Service,, Tuesday, May 20, 2014, 02:42:36 PM MST
The viewUsers command can include a parameter that instructs the system to generate a .csv file from the output. Enter a name as a parameter to the command, for the file that
is generated, as shown in the following example:
is generated, as shown in the following example:
viewUsers > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-131.
Example 5-131 The viewUsers command with a .csv file
viewUsers > C:CLICVSFilesviewUsers.csv
viewUtilThreshold
Use the viewUtilThreshold command to see more information about the defined Capacity Utilization Threshold and the Dual Accessor Utilization Threshold.
If the number of cartridges exceeds the defined capacity utilization threshold, the Capacity POD in the monitor system page turns yellow. If this scenario occurs, remove the cartridges, increase the capacity threshold, or purchase more capacity.
The dual accessor utilization threshold (-daut) option is applicable to dual accessor libraries only with elastic capacity enabled. It determines the threshold in which cartridges are moved to accessor service areas in the end frames. The default is 98%.
The command uses the following syntax:
viewUtilThreshold
The viewUtilThreshold command does not require any parameters. When the viewUtilThreshold command runs successfully, the system returns output to the display, as shown in Example 5-132.
Example 5-132 The viewUtilThreshold command
viewUtilThreshold
Capacity Utilization Threshold: 99.0
Dual Accessor Utilization Threshold: 98
viewVolserRanges
Use the viewVolserRanges command to list all of the VOLSER ranges in the physical library. To list all of the VOLSER ranges that are assigned to each logical library, use the viewVolserRangesByLL command.
The command uses the following syntax:
viewVolserRanges
The viewVolserRanges command does not require any parameters. It lists the information for all of the VOLSER ranges in the physical library. When the viewVolserRanges command executes successfully, the system returns output to your display, as shown in Example 5-133.
Example 5-133 The viewVolserRanges command
viewVolserRanges
Volser start - Volser end,Logical Library, Media Type,Number of cartridges
DF0000 - DF9999,Redbooks_custom, 3592, 0
JK0000 - JK0009, SLS_JAG1, 3592, 2
RBA000 - RBA999,LTFS_redbooks, 3592, 0
RBD000 - RBD099,Redbooks_custom, 3592, 0
The viewVolserRanges command can include a parameter that instructs the system to generate a .csv file from the output. Enter a name, as a parameter to the command, for the file that is generated, as shown in the following example:
viewVolserRanges > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-134.
Example 5-134 The viewVolserRanges command with a .csv file
viewVolserRanges > C:CLICVSFilesvolser_ranges.csv
viewVolserRangesByLL
Use the viewVolserRangesByLL command to list all of the VOLSER ranges for each logical library in the physical library. To list all of the VOLSER ranges for the physical library, use the viewVolserRanges command.
The command uses the following syntax:
viewVolserRangesByLL
The viewVolserRangesByLL command does not require any parameters. It lists the information for all of the VOLSER ranges in each logical library in the physical library. When the viewVolserRangesByLL command runs successfully, the system returns output to your display, as shown in Example 5-135.
Example 5-135 The viewVolserRangesByLL command
viewVolserRangesByLL
Logical Library, Cartridges, Media Type
LTFS_redbooks, 0, 3592
RBA000 - RBA999, 0
Redbooks_custom, 0, 3592
DF0000 - DF9999, 0
RBD000 - RBD099, 0
SLS_JAG1, 0, 3592
K0000 - JK0009, 2
Use the viewVolserRangesByLL command to instruct the system to generate a .csv file from the output. Enter a name as a parameter to the command for the file that is generated, as shown in the following example:
viewVolserRangesByLL > any_name_you_want.csv
The system generates the .csv file and stores it in the directory that contains the TS4500CLI.jar file. No message is returned to your display. To store the .csv file in another directory, specify the name of the directory in the command, as shown in Example 5-136.
Example 5-136 The viewVolserRangesByLL command with a .csv file
viewVolserRangesByLL > C:CLICVSFilesvolser_ranges_by_ll.csv
..................Content has been hidden....................
You can't read the all page of ebook, please click here login for view all page.