HPE StoreEver MSL6480 Tape Library CLI Utility Version 1.0 User Guide

Transcription

1 HPE StoreEver MSL6480 Tape Library CLI Utility Version 1.0 User Guide Abstract This document explains how to install and use the HPE StoreEver MSL6480 Tape Library CLI utility, which provides a non-graphical user interface for accessing library information. This guide is intended for experienced library administrators who would benefit from using the CLI utility. Part Number: QU Published: December 2015 Edition: 1

2 Copyright 2015 Hewlett Packard Enterprise Development LP The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained herein. Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or copying. Consistent with FAR and , Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard Enterprise has no control over and is not responsible for information outside the Hewlett Packard Enterprise website. Acknowledgments Intel, Itanium, Pentium, Intel Inside, and the Intel Inside logo are trademarks of Intel Corporation in the United States and other countries. Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Adobe and Acrobat are trademarks of Adobe Systems Incorporated. Java and Oracle are registered trademarks of Oracle and/or its affiliates. UNIX is a registered trademark of The Open Group. Revision History Revision #1 Initial release of the CLI utility. December 2015

3 Contents 1 Overview...4 Operating system requirements...4 Network configuration requirements...4 Installation overview Installing the utility...5 Verifying pre-requisites...5 Downloading and extracting the installation archive...5 Configuring the library to allow access through the CLI utility...5 Verifying the installation Using the CLI utility...6 Starting the CLI utility...6 Command line options...6 Library list file option...6 Library option...7 Obtaining help with the utility...7 Displaying the configuration of the active library...7 Displaying the configuration of the tape drives in the active library...7 Displaying the configuration of the library partitions...8 Displaying information about tape cartridges...8 Displaying library slot configuration information...9 Moving tapes...11 Changing the active library...11 Modifying the library login credentials...12 Adding a library to the utility...12 Deleting a library from the utility Troubleshooting tips Support and other resources...14 Accessing Hewlett Packard Enterprise Support...14 Accessing updates...14 Websites...14 Customer self repair...15 Remote support...15 Documentation feedback...15 Contents 3

4 1 Overview The HPE StoreEver MSL6480 command language interface (CLI) utility provides a menu-driven interface to view basic library configuration and status information, and move tapes within the library. The CLI can be used to view the status of multiple libraries at a time. The utility cannot be used to change the library configuration. The utility cannot be used to perform library operations or maintenance functions other than moving tapes. The utility does not provide a programmatic interface to the library. The utility runs on a Windows system with network access to the library. Operating system requirements The CLI software requires one of the following minimum operating system versions: Windows 7 or newer Windows Server 2008 or newer Network configuration requirements The utility uses HTTPS and TLS for secure communication with the library. The utility uses the following ports: Installation overview The CLI utility is delivered as a zip file that is downloaded from the Hewlett Packard Enterprise website without charge and then extracted onto the local computer s filesystem. The CLI executable securely accesses the library over the network. The CLI uses the same Representational State Transfer (REST) interface to access the library as HPE StoreEver Command View for Tape Libraries (CommandView TL) uses for its Data Verification feature. The CLI does not integrate with Command View TL nor require the library to be managed by Command View TL. 4 Overview

5 2 Installing the utility Verifying pre-requisites Before installing the utility files, verify that the local system satisfies the operating system and network configuration requirements. For more information see Operating system requirements (page 4) and Network configuration requirements (page 4). Downloading and extracting the installation archive 1. Download the utility from the Hewlett Packard Enterprise support website: a. Browse to the tape storage area: b. Click Tape Libraries. c. Click HPE StoreEver MSL Tape Libraries. d. Click HPE StoreEver MSL6480 Tape Library. e. In the Download options tab, click drivers, software & firmware. f. Select your operating system. g. Go to the Utility section. h. Click Download for the CLI utility. 2. Extract the files from the archive. The utility can be run from any file system location. Configuring the library to allow access through the CLI utility The CLI utility uses the REST interface used by the Command View TL Data Verification feature and shares the Data Verification user name and password. Even if Data Verification is not used by the library, the Data Verification user name and password must be configured so the CLI utility can access the library through the REST interface. 1. Log into the library RMI as the administrator user. 2. Navigate to the Configuration > Command View TL Configuration screen. 3. If the Data Verification Password has not been set, enter the password in the two password fields and then click Submit to commit the changes. Verifying the installation To verify the installation, start the utility and then connect to the library. For instructions, see Starting the CLI utility (page 6) Verifying pre-requisites 5

6 3 Using the CLI utility The utility connects to one or more libraries though either the utility command line or through the utility menus. The utility displays information about one library at a time. That library is designated as the active library. Starting the CLI utility 1. Start the utility in one of these ways: Open a DOS window and then run the msl6480_cli.exe utility executable. With this method you can specify command line options. See Command line options (page 6). Double-click msl6480_cli.exe to run the utility without specifying command line options. 2. Enter a library IP address or hostname. 3. Enter the REST password. For additional information, see Configuring the library to allow access through the CLI utility (page 5). 4. When the utility connects to the library it displays the library configuration and utility Main Menu. If the utility fails to connect to the library, follow the prompts to edit the library address or password, or to connect to a different library. If the credentials are correct and the utility is unable to connect to the library, see Connection problems (page 13). Command line options Library list file option The library list file contains the IP address and login information for one or more libraries. When working with several libraries, using this option can save time. msl6480_cli.exe [-f libs.txt] The file format is: <library> <password> where <library> is the IP address or domain name for a library <password> is the REST password. For additional information, see Configuring the library to allow access through the CLI utility (page 5) The utility will ignore any line starting with #. This is useful for comments or when you don t want the tool to connect with a specific library. 6 Using the CLI utility

7 Example 1 Sample library list file pwd12345 mymsl6480.example.com pwd45678 # ignore.example.com pwd98765 Library option With this option, you can specify a library on the command line. msl6480_cli.exe [-l library] Where <library> is the IP address or domain name for a library. Obtaining help with the utility This option displays the online help for the utility. msl6480_cli.exe [-h] Displaying the configuration of the active library 1. Start the utility and connect to a library. See Starting the CLI utility (page 6). 2. Enter 1. The utility obtains the library configuration information. This can take a few seconds. Displaying the configuration of the tape drives in the active library 1. Start the utility and connect to a library. See Starting the CLI utility (page 6). 2. Enter 2. The utility obtains the tape drive configuration information from the library. This can take a few seconds. Displaying the configuration of the active library 7

8 3. For additional information about a tape drive, enter the drive number from the list. For the original tape drive list, enter list. To exit the tape drive menu, press any other key. Displaying the configuration of the library partitions 1. Start the utility and connect to a library. See Starting the CLI utility (page 6). 2. Enter 3. The utility obtains the requested information from the library. This can take a few seconds. 3. For additional information about a partition, enter the partition number from the list. For the original partition list, enter list. To exit the partition menu, enter any other character. Displaying information about tape cartridges 1. Start the utility and connect to a library. See Starting the CLI utility (page 6). 2. Enter 4. The utility displays the Cartridge Menu. 3. Enter the number for the submenu: 1: Display all tapes: Displays a list of all tape cartridges in the library. 2: Display all tapes in a given partition: Displays a list of all tape cartridges in a specified library partition. 3: Display all tapes in a specified LTO generation: Displays a list of all tape cartridges of a specified LTO generation. 4: Display tapes that match a given barcode label Displaying information about all tapes in the library 1. In the Cartridge Menu, enter 1. The utility lists the location, barcode label, LTO generation, and partition for the first 20 tapes in the library. 2. To stop the listing, enter s. You can then enter the list number of a cartridge for additional information about that cartridge or enter any other character to return to the Cartridge Menu. To see information about the next 20 cartridges in the library, enter any other character. 3. When all of the tapes have been listed, enter the number of a tape cartridge for additional information about that cartridge. To return to the Cartridge Menu enter any other key. Displaying information about all tapes in a partition 1. In the Cartridge Menu, enter 2. 8 Using the CLI utility

9 2. To see a list of partitions, enter l. To see a list of cartridges in a partition, enter the number of the partition from the partition list. For additional information about a cartridge, enter the number of the cartridge. To return to the Cartridge Menu, enter any other character. 3. To return to the main menu from the Cartridge Menu, enter any other character. Displaying information about all tapes of a specified LTO generation 1. In the Cartridge Menu, enter Enter the number of an LTO generation: 1: LTO-1 2: LTO-2 3: LTO-3 4: LTO-4 5: LTO-5 6: LTO-6 7: LTO-7 The utility lists information about the first 20 cartridges for the specified LTO generation. 3. To stop the listing, enter s. You can then enter the list number of a cartridge for additional information about that cartridge or enter any other character to return to the Cartridge Menu. To see information about the next 20 cartridges, enter any other character. 4. When all of the tapes for the LTO generation have been listed, enter the number of a tape cartridge for additional information about that cartridge. To return to the Cartridge Menu, enter any other character. Displaying information about tapes based on their barcode labels 1. In the Cartridge Menu, enter Enter a barcode label that you want to search for. This can be the whole barcode label or a substring. It is case sensitive. The utility lists information about the first 20 cartridges that meet the search criteria.. 3. To exit the listing, enter s. For a list of the next 20 cartridges, enter any other character. 4. At the end of the list, enter y to perform another search. To return to the Cartridge Menu, enter any other character. Displaying library slot configuration information 1. Start the utility and connect to a library. See Starting the CLI utility (page 6). 2. Enter 5. The utility displays the Slot Sub-Menu. Displaying library slot configuration information 9

10 3. Enter the number for the submenu: 1: Display all slots 2: Display all mailslots 3: Display all slots in a specified partition 4: Display all slots containing media 5: Display all slots containing media of a specified generation Displaying information about all slots in the library 1. In the Slot Sub-Menu, enter 1. The utility lists the barcode label of the cartridge in the slot, the slot s partition, and whether the slot is a mailslot for the first 40 slots in the library. 2. To return to the Slot Sub-Menu, enter s. To see information about the next 40 slots, enter any other character. 3. When all of the slots have been listed, the utility displays the Slot Sub-Menu. Displaying information about all slots in the library 1. In the Slot Sub-Menu, enter 2. The utility lists the barcode label of the cartridge in the mailslot and the mailslot s partition. 2. To return to the Slot Sub-Menu, enter s. To see information about cartridges additional mailslots, enter any other character. 3. When all of the mailslots have been listed, the utility displays the Slot Sub-Menu. Displaying information about all slots in a partition 1. In the Slot Sub-Menu, enter 3. The utility lists information about each library partition. 2. To see information about the slots in a partition, enter the number of the partition from the list. To return to the Slot Sub-Menu, enter s. To see information about the next 40 slots, enter any other character. 3. When all of the slots have been listed, the utility displays the Slot Sub-Menu. Displaying information about all slots in the library that contain media 1. In the Slot Sub-Menu, enter 4. The utility lists the barcode label of the cartridge in the slot, the slot s partition, and whether the slot is a mailslot for the first 40 slots in the library that contain media. 2. To return to the Slot Sub-Menu, enter s. To see information about the next 40 slots that contain media, enter any other character. 3. When all of the slots containing media have been listed, the utility displays the Slot Sub-Menu. Displaying information about all slots in the library that contain media of a specified LTO generation 1. In the Slot Sub-Menu, enter Using the CLI utility

11 2. Enter the number of an LTO generation: 1: LTO-1 2: LTO-2 3: LTO-3 4: LTO-4 5: LTO-5 6: LTO-6 7: LTO-7 The utility lists information about cartridges for the specified LTO generation. 3. To return to the Slot Sub-Menu, enter s. To see information about the next set of slots that contain media of the specified LTO generation, enter any other character. 4. When all of the slots containing media of the specified LTO generation have been listed, the utility displays the Slot Sub-Menu. Moving tapes The utility supports moving tapes to assist in library administration tasks, such as importing or exporting cartridges through the mailslot or making a cleaning cartridge available to a drive. WARNING! The utility will move a tape without regard to the library partition configuration or application requirements. Before moving a cartridge, verify that doing so will not disrupt library or application operations. 1. Start the utility and connect to a library. See Starting the CLI utility (page 6). 2. Enter 6. The utility displays the Move Source menu. 3. Enter the number for the Move Source menu item: 1: Display all tapes 2: Display all tapes in a specified partition 3: Display all slots in a specified LTO generation 4: Display tapes that match a given barcode label Follow the menus to specify the tape to be moved. 4. Enter the letter corresponding with the type of destination: s: Slot m: Mailslot d: Drive Follow the menus to specify the destination location. Changing the active library 1. From the Main Menu, enter 7. The utility displays the Library Options menu. 2. Enter 1. The utility lists the current libraries. Moving tapes 11

12 3. Enter the list number of the library. The utility tests the connection to the new active library and displays the library configuration. Modifying the library login credentials You can modify the library login credentials if they were entered incorrectly or are changed while the utility is running. 1. From the Main Menu, enter 7. The utility displays the Library Options menu. 2. Enter 2. The utility lists the current libraries. 3. Enter the list number of the library. The utility displays the IP address and serial number for the library. 4. Enter the IP address or fully qualified domain name for the library, or leave blank use the same library address. 5. Enter the REST password or leave blank to use the same password. For additional information, see Configuring the library to allow access through the CLI utility (page 5). The utility tests the connection using the updated credentials and then displays the library configuration. Adding a library to the utility 1. From the Main Menu, enter 7. The utility displays the Library Options menu. 2. Enter Enter the IP address or fully qualified domain name for the library. 4. Enter the REST password. For additional information, see Configuring the library to allow access through the CLI utility (page 5). The utility tests the connection using the updated credentials and then displays the library configuration. Deleting a library from the utility 1. From the Main Menu, enter 7. The utility displays the Library Options menu. 2. Enter 4. The utility displays the a list of the libraries. 3. Enter the list number of the library. 4. Enter DELETE to confirm the deletion. 12 Using the CLI utility

13 4 Troubleshooting tips Connection problems If the utility fails to connect to the library, verify the following: The IP address entered in the utility is correct The password entered in the utility is the same as configured for the library in Configuring the library to allow access through the CLI utility (page 5). Network settings for the host and library Basic network connectivity between the host and library is working. Try using ping or viewing the library RMI to verify connectivity No firewalls are blocking HTTPS and TLS traffic between the Windows host and the library on ports 443 and 3031 The library is running 4.80 or newer library firmware. You are running the latest version of the CLI utility. For version and download information, see Downloading and extracting the installation archive (page 5). 13

14 5 Support and other resources Accessing Hewlett Packard Enterprise Support For assistance, go to the Contact Hewlett Packard Enterprise Worldwide website: To access documentation and support services, go to the Hewlett Packard Enterprise Support Center website: Information to collect Technical support registration number (if applicable) Product name, model or version, and serial number Operating system name and version Firmware version Error messages Product-specific reports and logs Add-on products or components Third-party products or components Accessing updates Websites Some software products provide a mechanism for accessing software updates through the product interface. Review your product documentation to identify the recommended software update method. To download product updates, go to either of the following: Hewlett Packard Enterprise Support Center Get connected with updates page: Software Depot website: To view and update your entitlements, and to link your contracts and warranties with your profile, go to the Hewlett Packard Enterprise Support Center More Information on Access to Support Materials page: IMPORTANT: Access to some updates might require product entitlement when accessed through the Hewlett Packard Enterprise Support Center. You must have an HP Passport set up with relevant entitlements. Website Hewlett Packard Enterprise Information Library Hewlett Packard Enterprise Support Center Link Support and other resources

15 Website Contact Hewlett Packard Enterprise Worldwide Subscription Service/Support Alerts Software Depot Customer Self Repair Insight Remote Support Serviceguard Solutions for HP-UX Single Point of Connectivity Knowledge (SPOCK) Storage compatibility matrix Storage white papers and analyst reports Link Customer self repair Hewlett Packard Enterprise customer self repair (CSR) programs allow you to repair your product. If a CSR part needs to be replaced, it will be shipped directly to you so that you can install it at your convenience. Some parts do not qualify for CSR. Your Hewlett Packard Enterprise authorized service provider will determine whether a repair can be accomplished by CSR. For more information about CSR, contact your local service provider or go to the CSR website: Remote support Remote support is available with supported devices as part of your warranty or contractual support agreement. It provides intelligent event diagnosis, and automatic, secure submission of hardware event notifications to Hewlett Packard Enterprise, which will initiate a fast and accurate resolution based on your product s service level. Hewlett Packard Enterprise strongly recommends that you register your device for remote support. For more information and device support details, go to the following website: Documentation feedback Hewlett Packard Enterprise is committed to providing documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback (docsfeedback@hpe.com). When submitting your feedback, include the document title, part number, edition, and publication date located on the front cover of the document. For online help content, include the product name, product version, help edition, and publication date located on the legal notices page. Customer self repair 15