NearStore® VTL Version 5.2 Command Reference

Table of Contents

Copyright and Trademark Information

Copyright Information

Trademark Information

Preface

Introduction

Audience

Terminology

Keyboard Conventions

Typographic Conventions

Special Messages

1. Understanding the NearStore VTL CLI

Introduction

User Interface

Accessing the VTL CLI

Logging Out of the VTL CLI

VTL Command Structure

Command Usage

Syntax Constraints

Command Help Structure

User Interaction

Types of Commands

Command Errors

Using Scripts to Set Up VTL CLI Access Without Passwords

Installing Scripts

Customizing the Script

Sample Export Workflow Script

Running the Script

2. Appliance Management

Rebooting the Appliance (appliance reboot)

Shutting Down the Appliance (appliance shutdown)

Restarting the Appliance (appliance restart)

Obtaining the Appliance Version (appliance version)

Obtaining the Appliance Uptime (appliance uptime)

Showing Appliance Information (appliance show)

Setting the Appliance ID (appliance set)

Discovering Devices (appliance discover)

3. Managing Configuration

Loading the Default Configuration (config load_default)

4. Configuring Time

Showing the Appliance Time (time show)

Showing the NTP Configuration (time show_ntp)

Setting the NTP Configuration (time set_ntp)

5. Configuring SNMP

Showing the SNMP Configuration (snmp show)

Setting the SNMP Configuration (snmp set)

Sending the Test SNMP Trap (snmp sendtrap)

6. Configuring Network Settings

Showing Network Configuration (network show)

Setting Network Configuration (network set)

7. Configuring E-Mail

Showing E-Mail Configuration (email show)

Setting E-Mail Configuration (email set)

Sending Test E-Mail (email send)

8. Configuring AutoSupport

Showing AutoSupport Configuration (asup show)

Setting AutoSupport Configuration (asup set)

Sending Test AutoSupport Mail (asup send)

9. Configuring Advanced Options

Showing Advanced Options Settings (options show)

Setting Advanced Options (options set)

10. Configuring the Administrator Account

Showing Administrator Account Configuration (admin show)

Setting Administrator Account Configuration (admin set)

Setting the Administrator Password (admin passwd)

11. Configuring the Tape Operator Account

Showing Tape Operator Account Configuration (tapeoperator show)

Setting Tape Operator Account Configuration (tapeoperator set)

Setting Tape Operator Password (tapeoperator passwd)

12. Configuring Debugging

Listing Debug Categories (debug list)

Showing Debug Categories (debug show)

Enabling a Debug Category (debug enable)

Disabling a Debug Category (debug disable)

13. Diagnosing the Appliance

Showing Diagnostics (diag show)

Clearing Diagnostic Messages (diag clear)

Enabling Diagnostic Messages on the Console (diag enable)

Disabling Diagnostic Messages on the Console (diag disable)

14. Showing System Diagnostic Messages

Showing Diagnostic Messages (dmesg show)

15. Showing the Appliance Event Log

Showing the Event Log (eventlog show)

16. Configuring Physical Disks

Listing the Physical Disks (pdisk list)

Showing Physical Disk Details (pdisk show)

Discovering a Physical Disk Name or UUID (pdisk lookup)

17. Configuring RAID

Listing Available RAID Groups (raid list)

Showing Details for a RAID Group (raid show)

Discovering a RAID Name or UUID (raid lookup)

Showing RAID Statistics (raid stats)

Removing a RAID Group (raid remove)

Adding a RAID Group (raid add)

Failing a Disk from a RAID Group (raid fail)

Autocreating a Raid Group (raid autocreate)

18. Configuring Hot Spare Disks

Listing Hot Spare Disks (hotspare list)

Showing Hot Spare Disk Details (hotspare show)

Discovering a Hot Spare Disk Name or UUID (hotspare lookup)

Adding a Physical Disk to the Hot Spare Disk Pool (hotspare add)

Removing a Physical Disk from Hot Spare Disk Pool (hotspare remove)

19. Configuring Physical Libraries

Listing Available Physical Libraries (plib list)

Showing Physical Library Details (plib show)

Discovering a Physical Library Name or UUID (plib lookup)

Listing Inventory Details (plib inventory)

Adding a Physical Library (plib add)

Removing a Physical Library (plib remove)

Exporting a Volume (plib move_to_eep)

Canceling an Export Request (plib eep_cancel)

Polling EEP (plib eep_check)

Rescanning Inventory (plib rescan)

20. Configuring Physical Tape Drives

Listing Physical Tape Drives (pdrive list)

Showing Physical Tape Drive Details (pdrive show)

Discovering a Physical Tape Drive Name or UUID (pdrive lookup)

Showing I/O Statistics for Physical Tape Drive (pdrive stats)

Adding a Physical Tape Drive (pdrive add)

Removing a Physical Tape Drive (pdrive remove)

Enabling a Physical Tape Drive (pdrive enable)

Disabling a Physical Tape Drive (pdrive disable)

Listing Physical Tape Drive Content (pdrive contents)

21. Configuring Customer Information

Listing Customers (customer list)

Showing Customer Details (customer show)

Discovering a Customer Name or UUID (customer lookup)

Removing a Customer (customer remove)

Adding a New Customer (customer add)

Updating Customer Information (customer update)

Setting the Password for a Customer (customer passwd)

22. Configuring Storage Pools

Listing Names of Storage Pools (sp list)

Showing Storage Pool Details (sp show)

Discovering a Storage a Pool Name or UUID (sp lookup)

Adding a Storage Pool to the Appliance (sp add)

Removing a Storage Pool from the Appliance (sp remove)

Updating Storage Pool Information (sp update)

23. Configuring Virtual Libraries

Listing Virtual Libraries (vlib list)

Showing Virtual Library Details (vlib show)

Discovering a Virtual Library Name or UUID (vlib lookup)

Creating a Virtual Library (vlib add)

Removing a Virtual Library (vlib remove)

Updating Virtual Library Information (vlib update)

Importing a Volume into a Virtual Library (vlib import)

Exporting a Volume from a Virtual Library (vlib export)

Listing Inventory Details of a Virtual Library (vlib inventory)

24. Configuring Virtual Tapes

Listing Virtual Tapes (vtape list)

Showing Virtual Tape Details (vtape show)

Discovering a Virtual Tape Name or UUID (vtape lookup)

Creating a Virtual Tape (vtape add)

Removing a Virtual Tape (vtape remove)

Updating a Virtual Tape (vtape update)

Moving a Volume from One Virtual Library to Another (vtape move)

Loading a Volume into a Virtual Library Drive (vtape load)

Unloading a Volume from a Virtual Library Drive (vtape unload)

25. Configuring Virtual Tape Drive Type

Listing a Virtual Tape Drive Type (vtdt list)

Showing Virtual Tape Drive Type Details (vtdt show)

Discovering a Virtual Tape Drive Type Name or UUID (vtdt lookup)

Adding a New Virtual Tape Drive Type (vtdt add)

Removing a Virtual Tape Drive Type (vtdt remove)

Updating a Virtual Tape Drive Type (vtdt update)

26. Configuring Hosts

Listing Host Names (host list)

Showing Host Details (host show)

Discovering a Host Name or UUID (host lookup)

Adding a New Host (host add)

Removing a Host (host remove)

Updating a Host (host update)

27. Configuring Ports

Listing Ports (port list)

Showing Port Details (port show)

Discovering a Port Name or UUID (port lookup)

28. Showing Appliance Actions

Showing Action Details (action show)

29. Importing or Exporting Requests

Showing Import or Export Request Details (iereq show)

Requesting the Loading of a Volume (iereq load)

Canceling a Request (iereq cancel)

Requeuing a Request (iereq requeue)

30. Using the Pick List

Showing the Pick List (picklist show)

Notifying That a Volume Has Been Found (picklist found)

Notifying That a Volume Is Missing (picklist missing)

31. Configuring Host or Port Access

Listing Host Access (access host_list)

Defining Scope for Host Access (access host_scope)

Adding Host Access (access host_add)

Removing Host Access (access host_remove)

Listing Port Access (access port_list)

Defining Scope for Port Access (access port_scope)

Adding Port Access (access port_add)

Removing Port Access (access port_remove)

32. Configuring Virtual Tape Drive

Listing Virtual Tape Drives (vdrive list)

Showing Virtual Tape Drive Details (vdrive show)

Showing I/O Statistics for a Virtual Tape Drive (vdrive stats)

33. Using Shadow Tape APIs

Listing Shadow Tapes (stape list)

Showing Shadow Tape Details (stape show)

Discovering a Shadow Tape Name or UUID (stape lookup)

34. Configuring ACSLS

Enabling ACSLS

Setting the ACSLS Server (acsls set)

Showing ACSLS Status (acsls show)

Listing Barcode Ranges (acsls list_barcode_range)

Adding Barcode Ranges to VTL (acsls add_barcode_range)

Removing Barcode Ranges to VTL (acsls remove_barcode_range)

35. Using ACS Libraries

Listing ACS Libraries (acs list)

Showing ACS Libraries (acs list_acs)

Listing ACS Libraries LSM Details (acs list_lsm)

Listing ACS Library Drive Details (acs list_drive)

Listing ACS Libraries CAP Details (acs list_cap)

Adding ACS Libraries (acs add)

Removing ACS Libraries (acs remove)

Listing Inventory Details of an ACS (acs inventory)

Making a Batch CAP Request (acs batch_cap)

Listing Batch CAP Requests (acs list_batch_cap)

Canceling a Batch CAP Request (acs cancel_batch_cap)

Moving Tapes to CAP (acs eject)

36. Licensing

Listing Installed Licenses (license list)

Showing Installed Licenses (license show)

Adding a License (license add)

37. Upgrading Firmware

Installing VTL Firmware (appliance install)

Listing Shelf Controller Firmware (shelffirmware list)

Installing Downloaded Shelf Controller Firmware on Specific Shelves (shelffirmware install)

Installing Downloaded Shelf Controller Firmware on All Shelves (shelffirmware install image_name all)

Installing Prepackaged Shelf Controller Firmware (shelffirmware install all)

Viewing Shelf Controller Firmware Status (shelffirmware status)

Listing Disk Firmware (diskfirmware list)

Installing Disk Firmware on Disks of a Specific Model (diskfirmware install)

Installing Downloaded Firmware on All Disks (diskfirmware install all ftp)

Installing Prepackaged Firmware on All Disks (diskfirmware install all default)

Viewing Disk Firmware Status (diskfirmware status)