CLI commands listed alphabetically

Edit online

assignDataCartridges CLI command
Use the assignDataCartridges command to assign or reassign individual data cartridges to one or more logical libraries.
assignDriveToLL CLI command
Use the assignDriveToLL command to assign a drive to a logical library.
batch CLI command
Use the batch command to run multiple commands specified in a file.
bulkAssignDataCartridges CLI command
Use the bulkAssignDataCartridges command to bulk-assign cartridges to a single logical library. You can bulk-assign up to 100 cartridges. Use the bulkAssignDataCartridgesByLL command to bulk-assign cartridges to multiple logical libraries.
bulkAssignDataCartridgesByLL CLI command
Use the bulkAssignDataCartridgesByLL command to bulk-assign cartridges to multiple logical libraries. To bulk-assign cartridges to a single logical library, use the bulkAssignDataCartridges command.
cleanDrive CLI command
Use the cleanDrive command to clean a specific drive.
codeUpdate CLI command
Use the codeUpdate command to update the library firmware. To update the firmware in a specific drive, use the driveCodeUpdate command, or use the management GUI (Drives > Drives page).
completeDriveService CLI command
Use the completeDriveService command to complete the drive replacement procedure.
continueCloseLibraryVerify CLI command
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.)
continueLibraryVerify CLI command
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.)
createBEP CLI command
Use the createBEP command to create a bar code encryption policy. Before you run this command, run the viewKeyLabelMapping command to look up the key label mapping index number of the cartridges to have the encryption policy.
createKeyLabelMapping CLI command
Use the createKeyLabelMapping command to create a key label mapping.
createLL CLI command
Use the createLL command to create a new logical library.
createUser CLI command
Use the createUser command to create a new local user. Remote authentication can be either enabled or disabled.
createVolserRanges CLI command
Use the createVolserRanges command to create one or more new VOLSER ranges.
deleteBEP CLI command
Use the deleteBEP command to delete a bar code encryption policy (BEP). First, run the viewBEP command to obtain the index number for the BEP, then use the index number as input for the deleteBEP command.
deleteKeyLabelMapping CLI command
Use the deleteKeyLabelMapping command to delete a key label mapping. First, run the viewKeyLabelMapping command to obtain the index number for a specific key label mapping.
deleteLL CLI command
Use the deleteLL command to delete a logical library.
deleteUser CLI command
Use the deleteUser command to delete local user accounts. Local user accounts cannot be deleted from the management GUI when Remote Authentication is enabled; they can only be deleted from the CLI.
deleteVolserRanges CLI command
Use the deleteVolserRanges command to delete one or more VOLSER ranges. The command is applied immediately to all cartridges in the specified VOLSER ranges.
destageDataCartridges CLI command
Use the destageDataCartridges command to move cartridges from their cartridge cache locations to a high-density slot. (This command is only for high-density libraries. All data cartridges that are being destaged must be in tier 0.)
downloadDrivesLog CLI command
Use the downloadDrivesLog command to download a .zip file containing the logs from the specified (or all) drives. This command is useful for troubleshooting.
downloadEvents CLI command
Use the downloadEvents command to export detailed information about all error, warning, and informational events saved in the library.
downloadLog CLI command
The downloadLog command creates a set of log files describing recent library activity, including errors and failures. The default command creates encrypted files for use by IBM development; these files cannot be read by customers or SSRs. The -csh (control system health) option creates a smaller set of unencrypted log files that can be used by customers and SSRs to determine the status of the control system.
downloadPropertiesFile CLI command
Use the downloadPropertiesFile command to download the properties file (TSSC file) if one exists in the card.
downloadResources CLI command
Use the downloadResources command to export information about a library to a .csv file. You can specify all resources or a single resource, such as drives or users.
downloadSnapshot CLI command
Use the downloadSnapshot command to download a snapshot from the library. First, run the viewSnapshots command to obtain the index number for the specific snapshot.
driveCodeUpdate CLI command
Use the driveCodeUpdate command to update the firmware in a drive or list of drives.
editKeyLabelMapping CLI command
Use the editKeyLabelMapping command to edit a key label mapping. First, run the viewKeyLabelMapping command to obtain the index number of a specific key label mapping.
encrypt CLI command
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.
getFWVersion CLI command
Use the getFWVersion command to view the current library firmware version.
modifyAdvancedEncSettings CLI command
Use the modifyAdvancedEncSettings command to make the advanced encryption settings more or less restrictive for data that is stored in a library, or to return the advanced encryption settings to their default values.
modifyBEP CLI command
Use the modifyBEP command to edit a bar code encryption policy (BEP). First, run the viewBEP command to obtain the index number for the BEP, then use the index number as input for the modifyBEP command.
modifyFibreChannelSettings CLI command
Use the modifyFibreChannelSettings command to set port speed and topology for a specified drive. Speed and topology are the same for both ports in the drive.
modifyVolserRanges CLI command
Use the modifyVolserRanges command to modify existing VOLSER ranges.
modifyVolserReporting CLI command
Use the modifyVolserReporting command to specify the number of characters in each VOLSER number (first 6, first 8, all, or last 8) to report to the host for a specified logical library.
moveFromAllDrives CLI command
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 not available, the cartridges are moved to the first empty slot. (To eject a cartridge from a specific drive, use the moveFromDrive command.)
moveFromDrive CLI command
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 not available, the cartridge is moved to the first empty slot.
moveToDrive CLI command
Use the moveToDrive command to move a cartridge from a storage location (specified by VOLSER number) to a specified drive location.
prestageDataCartridges CLI command
Use the prestageDataCartridges command to move cartridges from high-density slots to cartridge cache locations specified by their VOLSER numbers. (This command is only for high-density libraries. All data cartridges that are being prestaged must be in tier 3 or higher.)
removeDataCartridges CLI command
Use the removeDataCartridges command to remove a data cartridge from a storage location and move it to the I/O station. The cartridge is unassigned from its logical library and the state changes to I/O Slot.
resetDrive CLI command
Use the resetDrive command to power cycle a specific drive.
resetNodeCards CLI command
Use the resetNodeCards command to reset one or more node cards.
restoreConfiguration CLI command
Use the restoreConfiguration command to restore a configuration database to the library. Use the saveConfiguration command to save the configuration database to a file. This requires a user with the Service role.
saveConfiguration CLI command
Use the saveConfiguration command to save the configuration database to your computer. Use the restoreConfiguration command to restore a configuration database to the library. This requires a user with a Service role.
setAccessorZones CLI command
(TS4500 Dual-accessor libraries only.) Use the setAccessorZones command 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 inactivate an accessor.
setAutoEjectCleaningCarts CLI command
Use the setAutoEjectCleaningCarts command to specify whether expired cleaning cartridges are automatically ejected from the library.
setDrivePortsID CLI command
Use the setDrivePortsID command to set the port IDs for a specified drive (port 1 and port 2).
setDriveUse CLI command
Use the setDriveUse command to configure the drive for media access, control path with media access, or media verification.
setISCSI CLI command
Use the setISCSI command to update 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 so that ports in the same drive can be attached to different subnets.
setLibraryTime CLI command
Use the setLibraryTime command to set the library date and time to the same date, time, and time zone of the server on which the CLI is running.
setMacAddress CLI command
Use the setMacAddress command to change 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.
setMaximumVIOCartridges CLI command
Use the setMaximumVIOCartridges command to update the number of virtual I/O slots for the logical library.
setNMADetection CLI command
Use the setNMADetection command to enable or disable NMA detection in the library.
setRolePermissions CLI command
Use the setRolePermissions command to allow or restrict access to individual GUI pages for a specified role. Use the output from the viewRolePermissions command as input for this command.
setScannerSpeed CLI command
Use the setScannerSpeed command to set the speed of the scanner.
setSlotOffline CLI command
Use the setSlotOffline command to set a specified storage slot offline.
setSlotOnline CLI command
Use the setSlotOnline command to set a specified storage slot online.
setSSL CLI command
Use the setSSL command to enable or disable the use of HTTPS (HTTP over SSL). The HTTPS protocol provides secure communication over the network.
setUtilThreshold CLI command
Use the setUtilThreshold command to change the cartridge capacity utilization threshold settings. Use the viewUtilThreshold command to view the current settings.
showQueuedExports CLI command
Use the showQueuedExports command to specify whether cartridges that are queued for export remain assigned to the logical library or are unassigned from the logical library.
startCalibration CLI command
Use the startCalibration command to calibrate a library component.
startDiscoverHW CLI command
Use the startDiscoverHW command to start a discover hardware operation.
startDriveService CLI command
Use the startDriveService command to start the drive replacement procedure.
startInventory CLI command
Use the startInventory command to start an inventory operation.
startLibraryVerify CLI command
Use the startLibraryVerify command to start the library verification process for I/O stations. When the command completes, you will be 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 this order: startLibraryVerify, continueLibraryVerify, and continueCloseLibraryVerify.)
unassignDrive CLI command
Use the unassignDrive command to unassign a specific drive from its current logical library.
version CLI command
Use the version command to view the current version of the CLI tool.
viewAccessor CLI command
Use the viewAccessor command to show the accessor's status and usage statistics.
viewAccessorZones CLI command
This is only for the TS4500. Use the viewAccessorZones command to view which tape drives and I/O stations (within sets of frames) are being served by which accessor. You can also view these settings in the TS4500 management GUI on the Settings > Library > Advanced page.
viewAdvancedEncryptionSettings CLI command
Use the viewAdvancedEncryptionSettings command to display the advanced encryption settings for the specified logical library.
viewBEP CLI command
Use the viewBEP command to display a list of all VOLSER ranges showing the BEP settings. In the command output, each VOLSER range has a corresponding index number that you will need to specify to run the modifyBEP and deleteBEP commands.
viewCleaningCartridges CLI command
Use the viewCleaningCartridges command to view information for all cleaning cartridges in a library, including the number of remaining cleans.
viewDataCartridges CLI command
Use the viewDataCartridges command to view high-level information for all data cartridges in a library, sorted by VOLSER number.
viewDriveDetails CLI command
The viewDriveDetails command returns information about a specific drive that is useful for troubleshooting, including the contents of the drive, the name of the logical library, worldwide node numbers (WWNNs), and port ID information.
viewDriveEthernetPorts CLI command
The viewEthernetPorts command returns a list of all the Ethernet drives in the library.
viewDriveSasPorts CLI command
The viewDriveSasPorts command returns of all the SAS drives in the library.
viewDriveSummary CLI command
Use the viewDriveSummary command to list all of the drives in the library. This summary information is useful to network administrators who are deciding where to mount a cartridge. To list detailed information about a specific drive, use the viewDriveDetails command.
viewDriveVPD CLI command
Use the viewDriveVPD command to show vital product data (VPD) information for all drives in the library. This command is useful if an administrator or service engineer needs to see such information as a product model number, product release level, or other information specific to the device type.
viewDrivePod CLI command
The viewDrivePod command provides basic monitoring capability to display system health and drives in use. The output is in JSON format for use with the IBM Storage Mobile Dashboard. This command provides the same information as the middle pod (drive utilization) on the System GUI page.
viewFibreChannel CLI command
Use the viewFibreChannel command to show the Fibre Channel settings for both ports in each drive. The information is sorted by drive name. This command is useful to view the port configuration for the Fibre Channel switch and make sure that the configuration is compatible for the type of network in use.
viewIoStation CLI command
Use the viewIoStation command to view a summary of information for all cartridges in the I/O station.
viewISCSI CLI command
Use the viewISCSI command to view the configuration settings for a specific Ethernet drive.
viewKeyLabelMapping CLI command
Use the viewKeyLabelMapping command to view the list of available key labels and to obtain the index number for each key label mapping for use with the editKeyLabelMapping and deleteKeyLabelMapping commands.
viewLibraryVPD CLI command
Use the viewLibraryVPD command to show vital product data (VPD) for the library. This command is useful if an administrator or service engineer needs to see the model or serial number or other information specific to the library.
viewLogicalLibraries CLI command
Use the viewLogicalLibraries command to list high-level information for all logical libraries. If you need detailed information for a specific library, use the viewLogicalLibraryDetails command.
viewLogicalLibraryDetails CLI command
Use the viewLogicalLibraryDetails command to show the name, type, maximum cartridges, number of virtual I/0 slot addresses, and number of drive addresses in a specified logical library. To show summary information for all logical libraries, use the viewLogicalLibraries command.
viewMacAddress CLI command
Use the viewMacAddress command to look up the MAC addresses for a drive's Ethernet ports.
viewNodeCards CLI command
Use the viewNodeCards command to view a summary of information about each node card in the library.
viewOfflineComponents CLI command
Use the viewOfflineComponents command to display a list of all offline components in the library.
viewPasswordAndSessionPolicy CLI command
The viewPasswordAndSessionPolicy command displays the current password security settings.
viewRolePermissions CLI command
Use the viewRolePermissions command to display the access level for each GUI page for the specified role. You can send the command output to a text file that can be edited and used as input to the setRolePermissions command.
viewRoles CLI command
Use the viewRoles command to display all of the defined roles in the library and the number of users with that role.
viewSnapshots CLI command
Use the viewSnapshots command to display a list of all available snapshots in the library. The snapshots are listed chronologically, with the most recent file last. Each snapshot is assigned an index number. To download a snapshot, use the downloadSnapshots command and specify the index number returned by this command.
viewStorageCapacity CLI command
The viewStorageCapacity command provides basic monitoring capability for capacity utilization and licensed slots. The output is in JSON format for use with the IBM Storage Mobile Dashboard.
viewSystemSummary CLI command
Use the viewSystemSummary command to view a summary of library components. This command is useful for users who need to view information about each frame, or to see a summary of the total storage capacity. The information is listed in ascending order by frame number, followed by component totals for the whole library.
viewSystemSummaryDetails CLI command
Use the viewSystemSummaryDetails command to view detailed information about a specific frame. If you need to view summary information about all frames in the library, use the viewSystemSummary command.
viewUsers CLI command
Use the viewUsers command to display a list of users (either remote or local) and their properties, including state, role, email address, and date and time of last login.
viewUtilThreshold CLI command
Use the viewUtilThreshold command to view the current cartridge capacity utilization threshold settings. Use the setUtilThreshold to change these settings.
viewVolserRanges CLI command
Use the viewVolserRanges command to list all VOLSER ranges in the physical library, sorted by the starting VOLSER number in the range. To list the VOLSER ranges assigned for each logical library, use the viewVolserRangesbyLL command.
viewVolserRangesByLL CLI command
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.

Parent topic: Tape CLI commands