Quantum DXi--Series Command
Line Interface (CLI) Guide
Introduction 1
CLI Users 1
CLI Passwords or Authorized Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Available Linux Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
CLI Syntax Conventions 3
Adding the CLI Directory to the Path 4
CLI Help Commands 4
CLI Special Options 5
Syntax of Options File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
CLI Exit Code 6
Web Services Support (Optional) 7
Web Services Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Web Services Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Sample Web Services Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Supported Web Services Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
How to Run Unsupported Web Services Commands . . . . . . . . . . . . . . . . . . . . 10
Documentation of Web Services Commands. . . . . . . . . . . . . . . . . . . . . . . . . . 10
6-67081-05 Rev B, April 2012
*6-67081-05 B*
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
VTL Configuration CLI Commands 10
Listing Existing VTL and Its Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Listing Available Library Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Listing of Supported Tape Drive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Adding a VTL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Editing a VTL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Deleting a VTL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Listing the Media Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Creating Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Listing the Media and Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Media Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Deleting All Media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Turning a VTL Online/Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Listing Available Hosts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Adding a Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Editing a Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Deleting a Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Listing Targets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Listing Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Listing the SAN Client Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Adding a SAN Clients Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Deleting a SAN Client Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Listing VTL Storage Locations and Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Moving Media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Unloading Media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Resetting the VTL Target Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
NAS Configuration CLI Commands 21
Listing the Existing NAS Share and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 22
This document is for DXi 2.1.1 Software. Made in the USA. Quantum Corporation provides this publication “as is” without
warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability or
fitness for a particular purpose. Quantum Corporation may revise this publication from time to time without notice.
COPYRIGHT STATEMENT
© 2012 Quantum Corporation. All rights reserved. Your right to copy this manual is limited by copyright law. Making copies
or adaptations without prior written authorization of Quantum Corporation is prohibited by law and constitutes a
punishable violation of the law.
TRADEMARK STATEMENT
Quantum, the Quantum logo, DLT, DLTtape, the DLTtape logo, SuperLoader, Scalar, StorNext, and DXi are registered
trademarks of Quantum Corporation, registered in the U.S. and other countries. Preserving the World's Most Important Data.
Yours., Backup. Recovery. Archive. It’s What We Do., the DLT logo, DLTSage, Dynamic Powerdown, FastSense, FlexLink,
GoVault, MediaShield, Optyon, Pocket-sized. Well-armored, SDLT, SiteCare, SmartVerify, StorageCare, Super DLTtape, and
Vision are trademarks of Quantum. LTO and Ultrium are trademarks of HP, IBM, and Quantum in the U.S. and other countries.
All other trademarks are the property of their respective companies. Specifications are subject to change without notice.
ii Contents
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Listing of Existing NAS Share Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Getting the Total NAS Share Count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Adding a NAS Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Editing a NAS Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Enabling Allowlinks on a NAS Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Deleting a NAS Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Deleting All NAS Shares. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Joining or Disjoining a Windows Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Workgroup Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Share Administrators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
CIFS Share Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
NFS Share Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting NFS Share Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Changing NFS Share Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Query Status of a NAS Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Querying the CIFS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Setting the CIFS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Commit NFS Synchronously . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Commit NFS Asynchronously . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Replication CLI Commands 36
Initiating a Cartridge Based, File/Directory Based, or Namespace Replication . 38
Locking a VTL or NAS Share . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Unlocking a VTL or NAS Share. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Getting VTL or NAS Share Lock Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Initiating Source to Target Cartridge or File Synchronization . . . . . . . . . . . . . 39
Generating a Replication Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Listing the Allowed Replication Sources for the Target . . . . . . . . . . . . . . . . . . 39
Adding a Source on a Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Deleting a Source on a Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Listing the Replication Targets for the Source . . . . . . . . . . . . . . . . . . . . . . . . . 40
Adding a Target on a Source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Deleting a Target on the Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Enabling VTL Replication Options on the Source. . . . . . . . . . . . . . . . . . . . . . . 41
Disabling VTL Replication Options on the Source . . . . . . . . . . . . . . . . . . . . . . 41
Enabling NAS Share Replication Options on the Source . . . . . . . . . . . . . . . . . 41
Disabling NAS Share Replication Options on the Source . . . . . . . . . . . . . . . . . 42
Checking Readiness on Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Aborting Replication of VTL or NAS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Aborting Synchronization of VTL or NAS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Pausing the Replication Service on the Source . . . . . . . . . . . . . . . . . . . . . . . . 42
Resuming the Replication Service on the Source. . . . . . . . . . . . . . . . . . . . . . . 42
Enabling All Replication for Both VTL and NAS on the Source. . . . . . . . . . . . . 43
Contents iii
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Disabling All Replication for Both VTL and NAS on the Source . . . . . . . . . . . . 43
Clearing Replication Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Listing Deduplicated VTL on the Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Listing Deduplicated NAS on the Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Listing Replicated VTL on the Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Listing a Replicated NAS Share on the Target . . . . . . . . . . . . . . . . . . . . . . . . . 44
Recovering VTL on the Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Recovering a NAS Share on the Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Failback VTL To the Source from the Target System . . . . . . . . . . . . . . . . . . . . 46
Failback a NAS Share on the Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Deleting a Replicated VTL from the Target . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Deleting a NAS Share on the Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Listing the Replicated VTL Recovery Jobs on the Target. . . . . . . . . . . . . . . . . . 47
Listing the Replicated NAS Recovery Jobs on Target . . . . . . . . . . . . . . . . . . . . 48
Deleting the Replicated VTL Recovery Jobs on the Target . . . . . . . . . . . . . . . . 48
Deleting the Replicated NAS Recovery Jobs on Target. . . . . . . . . . . . . . . . . . . 48
Listing the Replicated VTL Failback Jobs on the Target . . . . . . . . . . . . . . . . . . 48
Listing the Replicated NAS Failback Jobs on the Target. . . . . . . . . . . . . . . . . . 48
Deleting the Replicated VTL Failback Jobs on the Target. . . . . . . . . . . . . . . . . 49
Deleting the Replicated NAS Failback Job on the Target . . . . . . . . . . . . . . . . . 49
Aborting the Replicated VTL Failback Jobs on the Target . . . . . . . . . . . . . . . . 49
Aborting the Replicated NAS Failback Job on the Target. . . . . . . . . . . . . . . . . 49
Enabling the VTL Cartridge Based Replication on the Target. . . . . . . . . . . . . . 49
Enabling NAS File/Directory Based Replication on the Target . . . . . . . . . . . . . 49
Disabling VTL Cartridge Based Replication on the Target . . . . . . . . . . . . . . . . 49
Disabling NAS File/Directory Based Replication on the Target . . . . . . . . . . . . . 50
Downloading a Replication Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Getting the Status of Active Cartridge Base or File/Directory Request . . . . . . . 50
Getting the Status of the Active Synchronization Requests. . . . . . . . . . . . . . . 50
Listing the File/Directory-Based Replication Status and Statistics. . . . . . . . . . . 50
Listing the File/Directory-Based Replication Target Shares. . . . . . . . . . . . . . . . 50
Listing the Cartridge Replication Status and Statistics. . . . . . . . . . . . . . . . . . . 50
Listing the VTL Cartridge Replication Status and Statistics . . . . . . . . . . . . . . . 51
Mapping an OST IP to a Replication IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Deleting an OST Target Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Getting an OST Target Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Scheduler CLI Commands 52
Adding an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Changing an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Listing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Deleting an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
iv Contents
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Statistics Report CLI Commands 56
Displaying the Disk Usage Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Displaying Data Reduction Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Displaying the Ingest Throughput Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
OST CLI Commands 56
Adding a Storage Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Deleting Storage Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Editing a Storage Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Listing a Storage Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Adding an LSU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Deleting an LSU. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Editing an LSU. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Listing an LSU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Setting OST Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Getting OST Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Listing OST Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Other System Configuration CLI Commands 59
E-Mail Recipient CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Outgoing E-mail Server CLI Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Sending a Test E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
E-mail Home CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
SNMP Trap Destination CLI Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Utility CLI Commands 65
Upgrading the System Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Getting the Cluster Status of Local Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Space Reclamation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Node Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
License Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Diagnostic Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Authenticate User (Login Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Release Credential (Logout Command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Run Command CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Changing the Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Resetting the Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Getting the Security Banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Setting the Security Banner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Getting the Number of Failed Login Attempts . . . . . . . . . . . . . . . . . . . . . . . . 74
Contents v
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Network CLI Commands 74
Adding Network Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Deleting Network Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Displaying Network Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Backing Up the Current Network Configuration . . . . . . . . . . . . . . . . . . . . . . . 77
Restoring a Network Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Displaying System Network Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Listing Network Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Adding Throttle on the Source System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Deleting Throttle on the Source System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Listing Throttle States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Setting Host and Domain Names and the DNS Search Path . . . . . . . . . . . . . . 79
Editing the Network Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Adding a Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Deleting a Route From the System of Network Device . . . . . . . . . . . . . . . . . . 81
Listing Static Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Deprecated Network CLI Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Netcfg Configuration Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Path To Tape CLI Commands 92
Listing the Path to Tape Initiator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Listing the Path to Tape Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Adding a Backup User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Editing a Backup User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Deleting a Backup User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Deleting All Backup Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Listing Backup Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Listing Medium Changers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Listing Tape Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Scanning Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Using Medium Changers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Using Tape Drives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Date and Time CLI Commands 94
Getting the Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Setting the Date and Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Displaying the NTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Displaying the Time Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Status CLI Commands 95
Getting VTL Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Getting Tape Drive Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
vi Contents
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Getting Storage Slot Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Getting the VTL Logical View Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Getting the Common Component Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Getting Storage Array Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Getting Hardware System Component Status . . . . . . . . . . . . . . . . . . . . . . . . . 96
Getting System Board Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Getting Network Port Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Getting Detailed Storage Array Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Getting System Memory Usage Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Alert CLI Commands 97
Deleting an Administration Alert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Deleting All Administration Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Editing the Service Ticket Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Listing the Administration Alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Listing the Service Tickets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Sending the Service Ticket Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Showing the Service Ticket Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Showing the Service Ticket Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Closing All Service Tickets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Analyzer CLI Commands 98
Analyzing the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Enabling or Disabling the NetServer to Perform a Network Analysis . . . . . . . . 98
Performing a Disk Analysis on the System. . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Displaying the NetServer Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Displaying the Last Run Result of the Disk/Network Analysis. . . . . . . . . . . . . . 99
Health Check CLI Commands 99
Starting a Health Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Stopping a Health Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Scheduling a Health Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Listing the Health Check Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Editing the Health Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Getting the General Status of System Health Checks . . . . . . . . . . . . . . . . . . 100
Getting the Health Check Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
CLI Error Codes 102
Contents vii
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
viii Contents
Introduction
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
The Command Line Interface (CLI) for DXi™-Series systems serves as a command
line equivalent of the remote management functionality. This guide describes
the CLI commands for DXi 2.1.1 Software, which is available for the following
systems:
•DXi V1000
• DXi4000 Family
• DXi6500 Family
• DXi6700 Family
• DXi8500
Not all CLI commands are available for all DXi-Series systems, as noted below in
the sections describing the CLI commands.
Note: Before you can login to the CLI User account, you must change the
password on the Security page of the remote management console.
For more information, see the
Reference and Documentation CD that came with your system.
User’s Guide
located on the Quick
CLI Users
Note: For more information about concepts and terms used in this guide, see
the “System Description” chapter and the glossary of terms in the
User’s Guide
that came with your system.
There are two local CLI user accounts to support the command line interface: a
CLI admin user and a CLI viewer user. They are defined as cliadmin (CLI
Administrator Account) and cliviewer (CLI Monitor Account), respectively. The
passwords are the same as the CLI user names. The CLI users can also be enabled
or disabled from the Security configuration page. By default, the two CLI user
accounts are enabled.
The two CLI users use the SSH capability to log in to the DXi™ system. Both are
confined to a restricted shell for security purposes. Only certain commands are
allowed to run in the restricted shell. The CLI command (syscli) is available for
both CLI users. In addition, a limited number of shell commands are available to
both CLI users to support scripting such as cat, cp, grep, ll, ls, mv, rm, vi, and
wbinfo. These commands are restricted so that they only work on files in the CLI
user’s home directory (see Available Linux Commands
located on the Quick Reference and Documentation CD
on page 2).
The cliviewer user has the ability to view or retrieve information and is not
allowed to add, change, or delete any information. The cliadmin user has the
same ability as cliviewer and in addition, has the privilege to add, change, or
delete information. If the cliviewer user attempts to run any intrusive command
Introduction 1
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
(such as add, edit, or delete) that changes any information in the system, an
error will be returned.
Additional commands are available to the CLI admin user but not to the CLI
viewer user. For example, the ftp command is available only to the CLI admin
(see Available Linux Commands
on page 2).
CLI Passwords or Authorized Keys
Available Linux Commands
To remotely issue CLI commands via SSH, you must ensure that the
authorized_keys file contains public keys that allow commands to be executed
without requiring a login password. The authorized_keys file is located in the
/home/cliadmin/authorized_keys file.
The following commands are standard Linux commands that are available to the
CLI users in their restricted shells. Display the help text to see syntax and usage
information for a command. To display the help text, enter the --help option
after the command name. For example, cat --help displays information about
the cat command.
The following commands available to the CLI admin and CLI viewer users in their
restricted shells:
• cat - Displays the contents of a file.
• cp - Copies a file.
• grep - Searches for a pattern in files.
• ls - Displays a list of files.
• ll - Displays a list of files with attributes.
• mv - Renames a file in the restricted shell.
• rm - Deletes files.
• vi - Opens a file for editing.
• scp - Copies files securely.
• less - displays text one screen at a time.
• head - displays first part of the file
• tail - display last part of the file
The following commands are available only to the CLI admin user:
• ftp - Transfers a file from the user’s home directory to a remote system.
• wbinfo - Queries and returns information about Samba related operations
on the system.
2 CLI Users
CLI Syntax Conventions
The CLI program is named syscli. It is usually invoked with parameters necessary
to carry out a predefined task. The first parameter is usually a verb indicating the
action to be performed and hence is called a command. A number of
commands specify the command type (known as subcommand) or the object
upon which the command will operate.The syntax of each CLI is listed in each
section.
The syntax for all syscli commands falls into one of the following two formats:
• syscli --cmd --option1 <value1> --option2 <value2> ...
• syscli --cmd subcmd --option1 <value1> --option2 <value2> ...
where
• cmd can be: list, add, edit, del, deleteall, ...
• subcmd can be: share, storageserver, lsu, ...
The following are the syntax conventions for the tokens on the command line.
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
• All tokens prefixed with double dash “--” are defined as options.
• All tokens that have no double dash are defined as values of the preceding
options.
• An option can be by itself or followed by a value.
• The first option is also known as the command. It is usually a verb such as
list, add, del, edit, ...
• If the first option has a value, this value is also known as the object (or
subcommand) upon which the command operates. The object is usually a
noun such as share, storageserver, ...
• An option value specified within the angle brackets “< >” means it is to be
replaced by an appropriate value. Without the angle brackets, the value is
literal text and must be entered exactly as is. For example, the command
syscli --del share --name <share_name>
has two options --del and --name, one literal value, share, and one
appropriate value, <share_name>.
• Options or values specified between square brackets “[ ]” are optional. If an
option and/or value is not specified, the CLI provides a default value for it.
• The pipe character “|” indicates that only one of the possible option names
or values must be specified. This is like an OR symbol.
• Options enclosed within parentheses “( )” mean one or more instances of
them must be specified. For example, the command
syscli --add sanclientgroup ... (--device <device_serial_ number> --lun
<desired_LUN>)
requires that one or more pairs of devices and luns must be specified.
• If a command requires a --password option and you do not specify it on the
command line, the syscli program will prompt for the password and will
not echo the response on screen for security purposes.
CLI Syntax Conventions 3
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
• Curly braces “{ }” in the syntax are used to group options and/or values
together for readability. These characters should not be used when entering
the commands.
• Option values separated by a comma “,” mean that one or more of the
values can be specified.
• The option names and/or values may change in the final release version.
Finally, it should be noted that all options and values are defined as single
tokens in the command line syntax. Thus if a provided value consists of multiple
tokens, it must be quoted to prevent the shell from interpreting it as separate
tokens. For example:
syscli --add share .... --desc 'This is a test share'
In addition, if a provided value contains characters that are special to the shell,
these characters must be escaped correctly so that the shell treats them as
regular characters. For example,
syscli --add share .... --desc Testing\!
Note: The shell used in the CLI user accounts is the bash shell. The set of
special characters are the same characters that bash treats as special
characters. Refer to the bash shell documentation (
www.gnu.org/software/bash/manual/bashref.html) for the set of
special characters interpreted by the shell. If you do not want the shell
to interpret any special characters, use single quotes (‘).
http://
Adding the CLI Directory to the Path
The syscli commands are located in the /hurricane directory. To make it easier to
invoke the CLI commands, you should add this path to the user profile.
To do this, add the following line to the user profile:
PATH=$PATH:/hurricane;export$PATH
CLI Help Commands
The following help commands are available:
•Typing syscli alone will display a summary of help commands.
•Typing syscli help will show syntax for all syscli commands.
•Typing syscli help NAS | VTL | OST | REPLICATION |... will show syntax for
all Network Attached Storage (NAS), VTL, Open Storage Technology (OST),
replication, etc. commands respectively.
4 Adding the CLI Directory to the Path
•Typing syscli help --<cmd> will show syntax for all commands named
•Typing syscli help --<cmd> <subcmd> will show detailed help for this
CLI Special Options
Every command can accept these options:
• --outfile <output_filename>
• --errfile [<error_filename>]
• --file <options_filename>
• --ws [<ws_server>[:<port>]
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
<cmd>. For example, syscli help --list shows all list commands, syscli help
--add shows all --add commands.
specific command. For example, syscli help --list nas shows the complete
help for the --list nas command.
The first two options are supported because the shell capability of redirecting
the standard output and standard error using the “>” character is forbidden in
the restricted shell.
CLI command options:
• --outfile specifies that the standard output will be saved to file
<output_filename>.
• --errfile specifies that the standard error will be saved to file
<error_filename>. If <error_filename> is not specified, it will be saved to
the same <output_filename>.
The third option is supported to avoid the problem of quoting and/or escaping
special characters. The option --file tells the program to open the file
<options_filename> to read additional options, where each option (or each
option=value pair if the option requires a value) is listed on a separate line.
Blank lines or lines starting with “#” are ignored. For example, the command
syscli --add share --name abc --proto cifs
is functionally equivalent to any of the following commands:
1 syscli --file <myfile>
where <myfile> is a file containing the following:
‐‐add=share
‐‐name=abc
‐‐proto=cifs
2 syscli --add share --file <file1>
where <file1> is a file containing the following:
‐‐name=abc
‐‐proto=cifs
CLI Special Options 5
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
3 syscli --add share --file <file2> --proto cifs
where <file2> is a file containing the following:
‐‐name=abc
Syntax of Options File The following are the syntax conventions for the options file:
• Command line options are processed from left to right. Thus any option in
the file can be overridden by listing it again on the command line after the
--file option. In example 3 above, the option-value pair --barcode
mybarcode overrides the one specified in file2 because it is processed after
option --file.
• Spaces surrounding the options are insignificant. The following examples
are equivalent:
• --name=abc
•--name =abc
• All characters that follow “=” are significant and are accepted as is,
including space, tab, backslash, single or double quotes, or any other
symbol. Because no characters are special, don’t escape them. This rule is
enforced so to support values that contain leading or trailing spaces/quotes
such as in passwords. For example:
CLI Exit Code
--password=abc
--password= abc
--password=a\!bc
--password="abc"
are all different passwords.
• The second password has four characters: space, a, b, and c.
• The third password has five characters: a, \, !, b, and c.
• The fourth password has five characters: ", a, b, c, and ".
If the command runs to completion successfully, it returns an exit code of zero
(0) along with the following message:
Commandcompletedsuccessfully.
If the command fails, it returns an exit code of one (1) along with a one line
error message that summarizes the error. This error message is always prefixed
ERROR:“ and appended with an error code in parentheses. For example:
with “
syscli‐‐addshare‐‐protocifs‐‐namecifs1‐‐desc"For
testingonly"
......
6 CLI Exit Code
ERROR:CIFSserverisdisabled!(E1000011)
It can be seen that the error code is “E1000011” and the error message is “CIFS
serverisdisabled!
Note: Possible error codes are listed at the end of each major section below.
”
Web Services Support (Optional)
By default, each CLI is executed directly on the DXi system it is running.
However, it is possible to send the command to another DXi system for
execution and display the result on the local DXi system. The syscli program in
DXi 2.0.1 Software has the capability of running the command remotely using
Web Services WSDL protocol version 2.0, provided that the remote DXi system is
also running DXi 2.0.1 Software as well.
Starting with DXi 2.0 Software, every DXi system runs a Web Services (WS)
server (specifically, axis2 server), which listens at port 9090 for all Web Services
requests from WS clients and then sends the result back to the clients.
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Note: It is strongly recommended that all CLI commands not be run in Web
Services mode when both the server and the client are on the same
system. It is much faster to run the commands directly without using
Web Services. Running a CLI command over Web Services protocol is a
complex process involving two distinct programs (client-server) and
network communication, thus having more points for failure.
Web Services Syntax To use Web Services for any CLI, one has to specify an additional option as
follows:
syscli --<cmd> <subcmd> . . . . . --ws [<ws_server>[:<port>]]
where:
• ws_server is the hostname or IP address of the system that runs the WS
server. If not specified, it is assumed to be localhost.
• port is the port number to which the server is listening for client requests. If
not specified, it is assumed to be port 9090.
The presence of the –ws option makes the syscli program work in client-server
mode; it will not execute the command on the local DXi system anymore.
Rather, it will send the command to the axis2 server on the specified remote
system. This server will then invoke the syscli program on the system it is
running to execute the requested command and then send the result back to
the syscli client to display.
To get more help on Web Services, type “syscli help ws”.
Example: The following commands are equivalent:
• syscli --list share ... --ws
Web Services Support (Optional) 7
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
• syscli --list share ... --ws localhost:9090
• syscli --list share ... --ws localhost
• syscli --list share ... --ws :9090
Web Services Session For security reasons the WS server cannot allow an arbitrary client to send
commands to it for execution. Before a client can execute any command, it has
to log in the WS server first in order to begin a WS session. If the login is
successful, the server will send back a credential token (an encrypted string). The
client has to include this credential token in all subsequent WS commands that
it sends to the server for execution. When the client is done with its commands,
it can log out the server. If the client is idle for more than 30 minutes, the server
automatically terminates the session. This time-out value can be overridden in
the login command.
Sample Web Services Session
A Web Services session begins when the user logs in successfully and terminates
when the user logs out (releases credential), or when the session is idle for
30 minutes.
During the session:
• Any CLI commands specified with the --ws option will be executed on the
axis2 server.
• Any CLI commands without the --ws option will be executed directly as
usual (i.e, not via Web Services).
Logging in to Start a Web Services Session
syscli --authenticate --name <username> --password <password> --client
<client_info> --ws [<host>:[<port>]]
Use this CLI command to start a Web Services session. If the password is not
specified, the system will prompt for it interactively. In this case, the password is
not echoed on screen.
Running CLI Commands
After login, each subsequent command, uses the term --list share, which can be
used as follows:
syscli --list share [--credtoken <credential_token>] --ws [<host>:[<port>]]
Note that the syntax of running a CLI command over Web Services is
unchanged, except that it must have a mandatory option --ws and an optional
option --credtoken. Here, credential_token is the value returned in the output
of the authenticate command. The --credtoken can be specified explicitly or
omitted because the syscli program is smart enough to cache the credential
token in the authenticate command for subsequent use.
8 Web Services Support (Optional)
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Logging Out
syscli --release credential [--credtoken <credential_token>] --ws
[<host>:[<port>]]
Note again that the credential token can be omitted because the syscli program
can use the cached value.
Supported Web Services Commands
The DXi 2.0.1 Software release supports about 20 Web Services commands, also
known as “operations” in the areas of Replication, NAS, and System Utilities. To
see a complete list, one can type the following URL in a browser:
http://<hostname_or_ipaddress_of_DXi_system>:9090/axis2/services
The output is as follows (with the equivalent syscli commands listed in
parentheses):
WSReplication Service
Available Operations:
• disableNASReplication (syscli -disablerep nas)
• enableNASReplication (syscli -enablerep nas)
• addReplicationSource (syscli -add sourcerep)
• deleteReplicationTarget (syscli -del targetrep)
• addReplicationTarget (syscli -add targetrep)
• deleteReplicationSource (syscli -del sourcerep)
WSNas Service
Available Operations:
• deleteAllShares (syscli –deleteall share)
• getShare (syscli –get share)
• updateShare (syscli –edit share)
• deleteShare (syscli –del share)
• getShares (syscli –list share)
• getShareNames (syscli –list sharename)
• getShareCount (syscli –getcount share)
• addShare (syscli –add share)
WSSystem Service (System Utility)
Available Operations:
• runCommand (syscli –runcmd)
• getPermissions (syscli –get permission)
• releaseCredential (syscli –release credential)
• authenticate (syscli –authenticate)
Web Services Support (Optional) 9
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
How to Run Unsupported Web Services Commands
The vast majority of CLI commands are not supported to run over Web Services
in DXi 2.0.1 Software. However, they can be run over WS via the command
syscli --runcmd because this command is supported for execution over Web
Services.
Consider the command --list healthcheckstatus, which is not supported in Web
Services. To understand how it can be run over Web Services, one needs to
understand how the runcmd CLI works.
The runcmd CLI is very simple. Any CLI command can run directly as is, such as
the following command:
syscli --list healthcheckstatus
However, the command can be run indirectly by specifying it as options to the
runcmd CLI as follows:
syscli --runcmd --list healthcheckstatus
The syntax above runs the runcmd CLI, which then parses the options specified
after the “—runcmd” token. Based on these options, the runcmd CLI invokes
the appropriate system API to execute. In the end the effect is executing the
--list healthcheckstatus command.
Because the runcmd CLI is supported over Web Services, it can accept the –ws
option to send the command to a WS server for execution as follows:
syscli --runcmd --list healthcheckstatus --ws [<remotehost>[:<port>]]
Documentation of Web Services Commands
Because Web Services commands and regular CLI commands differ only in the
additional options --ws and --credtoken, there is no need to document WS
commands separately. The option --credtoken is optional and can be ignored
because syscli can use the cached value.
VTL Configuration CLI Commands
The following sections describe the supported VTL CLI commands:
Note: VTL configuration CLI commands are available only on the DXi6700 and
DXi8500 systems.
• Listing Existing VTL and Its Attributes
• Listing Available Library Models
• Listing of Supported Tape Drive
• Adding a VTL
• Editing a VTL
• Deleting a VTL
• Listing the Media Types
10 VTL Configuration CLI Commands
Quantum DXi-Series Command Line Interface (CLI) Guide
• Creating Media
• Listing the Media and Attributes
• Media Actions
• Deleting All Media
• Turning a VTL Online/Offline
• Listing Available Hosts
• Adding a Host
• Editing a Host
• Deleting a Host
• Listing Targets
• Listing Devices
• Listing the SAN Client Group
• Adding a SAN Clients Group
• Deleting a SAN Client Group
6-67081-05 Rev B
April 2012
Listing Existing VTL and Its Attributes
• Listing VTL Storage Locations and Index
• Moving Media
• Unloading Media
• Resetting the VTL Target Ports
syscli --list vtl [--name <VTL_name>]]
This CLI command allows the CLI admin to display a list of all existing VTLs on
the system and their attributes when no partition name is specified. If a VTL
name is specified, only that VTL is listed with its attributes. The attribute list
includes the name of the VTL, mode, library model, drive model type, number of
drives, number of media, number of slots, serial number, data deduplication
status (enabled/disabled) and backup window status (enabled/disabled). If the
backup window status is enabled, the list will also include the start and end
time of the backup window.
An example output for a VTL named myvtl is shown below:
ListofallexistingVTL's:
Totalcount=1
[vtl=1]
name=myvtl
mode=offline
model=DXi6700
drivemodel=QUANTUMDLTS4
drives=2
media=2
VTL Configuration CLI Commands 11
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
slots=12
serial=123456XYZ
dedup=enabled
backupwindow=disabled
Listing Available Library Models
syscli --list library
This CLI command allows the CLI admin to display a list of the available library
models. Specific library model or product ID is required when adding or creating
a new partition.
An example output of three supported library models is shown below:
Listofallavailablelibrarymodels:
Totalcount=1
[library=1]
productid=DL1500
description=EMCDiskLibrary
[library=2]
productid=Scalar100
description=ADICScalar100
[library=3]
productid=Scalari2000
description=ADICScalari2000
Listing of Supported Tap e D r i v e
syscli --list drive
This CLI command allows the CLI admin to display a list of the available virtual
tape drive models. A specific virtual tape drive model is required when adding or
creating a new partition.
An example output of two tape drive is shown below:
Listofallavailabledrivemodels:
Totalcount=2
[drive=1]
model=QUANTUMDLTS4
description=QuantumDLTS4
[drive=2]
model=QUANTUMSDLT320
description=QuantumSDLT320
12 VTL Configuration CLI Commands
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
Adding a VTL syscli --add vtl --name <vtlname> --model <modelname> --slots
<number_of_slots> --drivemodel <tape_drive_model> --drives
<number_of_drives> [--dedup]
This CLI command allows the CLI admin to add a partition. The following
partition settings are required:
• --name <vtlname>: The virtual library name, vtlname, must be
alphanumeric, and it must begin with a letter.
• --model <modelname>: The library model name, modelname, is the VTL
model to create. A list of supported library models can be retrieved using
the --list library command.
• --slots <number_of_slots>: One I/E slot will be created for each storage
slot, until maximum of 240 I/E slots exist.
• --drivemodel <tape_drive_model>: The drive model to create for this VTL.
A list of supported drives can be retrieved using the --list drive command.
• --drives <number_of_drives>: The number of virtual tape drives attached
to the VTL.
• --dedup: Enables deduplication. By default, VTL will be created with
deduplication disabled.
April 2012
Optionally, the user can specify whether to enable data deduplication and
enable backup window. Once the partition is created, the data deduplication
state cannot be changed. The backup window start and end time can be
specified if the data deduplication is specified (enable).
The library model can be derived from the 'productid' value returned from the
list of available library models.
Caution: Do not use an underscore ( _ ) in the name of the VTL partition.
Editing a VTL syscli --edit vtl --name <VTL_name> [--model <model_name>] [--slots
<number_of_slots>] [--drives <number_of_drives>] [--startbackup
<hh:mm> --endbackup <hh:mm>]
This CLI command allows the CLI admin to edit an existing partition. The VTL
name is required to change any VTL setting. The VTL name and the tape drive
model cannot be changed. Note: Data deduplication settings cannot be edited
once the partition is created.
Caution: Do not use an underscore ( _ ) in the name of the VTL partition.
Deleting a VTL syscli --del vtl --name <VTL_name>
This CLI command allows the CLI admin to delete an existing VTL. The VTL name
is required to delete an existing VTL. In order to delete a VTL, a VTL needs to be
offline first and no media should be present in the VTL.
VTL Configuration CLI Commands 13
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Listing the Media Types syscli --list mediatype --drivetype <drive_type>
This CLI command allows the CLI admin to display a list of media types
supported given a tape drive model. For example, for DLT-S4 drive model, media
types SDLT1, SDLT2 and DLTS4 are supported and will be returned from this CLI.
The drive type can be derived from the value of the 'model' key name of the list
of available tape drives models.
An example output of three media types is shown below for DLT-S4 media types
supported.
Listofmediatypes:
Totalcount=3
[mediatype=1]
type=SDLT1
capability=RW
[mediatype=2]
type=SDLT2
capability=RW
[mediatype=3]
type=DLTS4
capability=RW
Creating Media syscli --add media --name <VTL_name> --type <media_type> --media
<number_of_media> --barcodestart <starting_barcode> --location slot |
ieslot [--capacity <media capacity>]
This CLI command allows the CLI admin to create a media for a defined VTL.
Creating a media is necessary after a VTL is created. The following are required
to create a media:
•VTL Name
•Media Type
• Number of media
•Starting barcode
• Initial location
The media type can be derived from the values returned from the type field
name of the list of media supported for a given tape drive model CLI. Initial
location can either be a slot or I/E slot.
The media capacity can optionally be specified. If media capacity is not
specified, it defaults to the media type native capacity.
14 VTL Configuration CLI Commands
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Listing the Media and Attributes
syscli --list media --name <VTL_name> [--barcode <barcode>]
This CLI command allows the CLI admin to display a list of barcodes in the
system from the specified VTL name. When a barcode of the cartridge is
specified, this CLI returns the attributes of the single cartridge specified if it
exists. An example output of two media from VTL MyVTL is shown below.
Listofmedia:
Totalcount=2
[media=1]
vtl=MyVTL
barcode=SDL101
type=SDLT-S4
access=scratch
pool=application
used=0.0
capacity=800.0
[media=2]
vtl=MyVTL
barcode=SDL101
type=SDLT-S4
access=scratch
pool=application
used=0.0
capacity=800.0
Media Actions syscli --del media --barcode <barcode> --name <VTL_name>
syscli --export media (--barcode <barcode>) | --all --name <VTL_name>
syscli --recycle media (--barcode <barcode>) | --all --name <VTL_name>
syscli --writeprot media (--barcode <barcode>) | --all --name <VTL_name>
[--disable]
syscli --import media (--barcode <barcode>) | --all --name <VTL_name>
This CLI command allows the admin user, given a specified media barcode(s)
and its VTL name, to change the state of a tape to deleted, exported, recycled,
write-protected or import media using this CLI. Multiple barcodes can be
specified on the command that supports it. This is specified in the syntax with
“()” which means one or more. Alternatively, if the --all option is specified, then
all the media in the specified VTL is used for the operation.
To d i sa b l e t h e w r i te -protect on a media, the --disable option must be specified
in the --writeprot media command.
VTL Configuration CLI Commands 15
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Deleting All Media syscli --deleteall media --name <VTL_name> [--sure]
This CLI command allows the admin user to delete all media in the specified VTL.
If the --sure option is specified, no confirmation prompt is displayed. Note that
*UNASSIGNED must be used for <VTL_name>.
Turning a VTL Online/ Offline
syscli --online vtl (--name <VTL_name>) | --all
This CLI command allows the admin to turn a VTL online.
syscli --offline vtl (--name <VTL_name>) | --all
This CLI command allows the admin to turn a VTL offline. A VTL needs to be
offline before you can edit or delete a partition.
Listing Available Hosts syscli --list host
This CLI command allows the CLI admin to display a list of available hosts. The
WWPN, its alias (if it was added by the user) and connection status are returned
for each host. If the host alias was not added initially, the output will indicate
that no alias was given.
An example output of a host with no alias given is shown below.
Listofavailablehosts:
Totalcount=1
[host=1]
wwpn=220100e08ba8338d
alias=null
connectionstatus=active
Adding a Host syscli --add host -wwpn <host_world_wide_port_name> --alias
<host_alias>
This CLI command allows the CLI admin to add a host to the available host list.
The required parameters are the host's world wide port name (WWPN) and alias.
If the host already exists from the list of available hosts, adding the same host
will return an error.
Editing a Host syscli --edit host --wwpn <host_world_wide_port_name> --alias
<host_alias>
This CLI command allows the CLI admin to add or change the host alias of a
host. The required parameter are the existing host's world wide port name
(WWPN) and alias.
16 VTL Configuration CLI Commands
Quantum DXi-Series Command Line Interface (CLI) Guide
Deleting a Host syscli --del host --wwpn <host_world_wide_port_name>
This CLI command allows the CLI admin to delete an existing host from available
host list. The required parameter is the host's WWPN. The host must be inactive
to delete it.
Listing Targets syscli --list target
This CLI command allows the CLI admin to display a list of targets on the system.
It lists the node, alias (FC port) and the WWPN. An example output of a target is
given below.
Listoftargets:
Totalcount=1
[target=1]
node=1
alias=FC3
6-67081-05 Rev B
April 2012
wwpn=214108001bc08278
Listing Devices syscli --list device --name <VTL_name>
This CLI command allows the CLI admin to display a list of devices on the
system. The list includes the type of device (VMC or VTD), serial number of the
device and the virtual tape library name the device is in. An example output of
devices on the system is shown below.
Listofdevices:
Totalcount=3
[device=1]
vtlname=MyVTL
type=VMC
serial=VL01SV0825BVA04501
[device=2]
vtlname=MyVTL
type=VTD
serial=VL01SV0825BVA04501
[device=3]
vtlname=MyVTL
type=VTD
serial=VL01SV0825BVA04501
VTL Configuration CLI Commands 17
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Listing the SAN Client Group
syscli --list sanclientgroup [--vtlname <VTL_name>]
This CLI command allows the CLI admin to display a list of existing SAN client
group(s) on the system. The list returned contains the virtual tape library name,
group name, host, target and devices associated with the group. If a virtual
library name is specified, this CLI lists only the group associated with the virtual
tape library.
An example output of a SAN client group is shown below.
ListofSANclientgroups:
Totalcount=1
[group=1]
vtlname=MyVTL
groupname=Group1
host=
target=
totaldevicecount=2
[device=1]
type=VMC
serial=VL01SV0825BVA04501
Adding a SAN Clients Group
lun=1
[device=2]
type=VTD
serial=VL01SV0825BVA04501
lun=2
syscli --add sanclientgroup --name <VTL_name> --groupname
<group_name> --wwpn <world_wide_port_name> --target <target>
(--device <device_serial_number> --lun <desired_LUN>) [ --useccl ]
This CLI command allows the CLI admin to add a host access group. The
following are required to create a host access group.
• Group Name
•VTL Name
• Host Name or WWPN
• Target (FC Port)
• List of device serial numbers (either VMC or VTD) and the desired host LUNs.
There should at least be one device and LUN specified.
The WWPN can be derived from the values returned for wwpn field name of the
list of host CLI. The Target can be derived from the value returned for wwpn
field name of the list of targets CLI. The List of device serial number can be
derived from the 'serial' field name of the list of devices of the VTL specified.
18 VTL Configuration CLI Commands
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
If the --useccl option is specified, the Command and Control LUN feature is
enabled.
Note: The CCL (Command and Control LUN) is not used in most
environments. This option is recommended for host access groups that
contain an HP-UX host. It can also be used if hosts that are not
assigned to any host access group exist in the SAN. The CCL is
accessible to hosts only through LUN 0.
Caution: If you are not sure if you should use CCL, contact Quantum
Customer Support before you enable this option.
Deleting a SAN Client Group
Listing VTL Storage Locations and Index
syscli --del sanclientgroup --name <VTL_name> --groupname
<group_name>
This CLI command allows the CLI admin to delete a SAN client group given the
required VTL name and the group name.
syscli --list vtlstorage --name <VTL_name> --loc source | dest [--type drive |
slot | ieslot]
This CLI command allows the CLI admin to list the source and destination
storage locations. This is useful to determine the locations to move or unload
media command. If the --type option is specified, only locations of the specified
type is listed.
Below is a sample output of this CLI with a VTL name and destination location
specified:
syscli --list vtlstorage --name VTL1 --loc dest
Output data:
ListofVTLstoragelocations:
Totalcount=4
[storagelocation=1]
locationtype=I/ESlot
index=0
driveserialnumber=N/A
barcode=N/A
writeprotect=disabled
access=N/A
used=N/A
[storagelocation=2]
locationtype=I/ESlot
VTL Configuration CLI Commands 19
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
index=1
driveserialnumber=N/A
barcode=N/A
writeprotect=disabled
access=N/A
used=N/A
[storagelocation=3]
locationtype=I/ESlot
index=2
driveserialnumber=N/A
barcode=N/A
writeprotect=disabled
access=N/A
used=N/A
[storagelocation=4]
locationtype=I/ESlot
index=3
driveserialnumber=N/A
barcode=N/A
writeprotect=disabled
access=N/A
used=N/A
Moving Media syscli --move media --name <VTL_name> --srctype slot | drive | ieslot
--desttype slot | drive | ieslot --srcindex <source_index> --destindex
<destination_index> [--forceunload]
This CLI allows the admin user to move media between virtual storage locations.
The media is moved from the specified source type and index location to the
specified type and index destination location. The location type and index can
be determined from the output of the --list vtlstorage command. The
--forceunload optional parameter refers only to virtual drive source location.
Unloading Media syscli --unload media (--barcode <media_barcode>) | { --loctype drive |
ieslot --index <index_location> } [--forceunload]
This CLI allows the admin user to unload media from virtual drive or import/
export virtual storage location specified by the barcode or the type and index
location. There may be one or more barcode specified to unload multiple media.
The option --forceunload refers to a virtual drive source location.
20 VTL Configuration CLI Commands
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Resetting the VTL Tar g e t P o r t s
syscli --reset targetport [(--name <portname> )] [--sure]
This CLI allows the admin user to reset all or individual VTL target ports.
CLI command options:
• --reset - Resets one or more VTL target ports.
• --name - Port name. Can be specified repeatedly for additional ports. If no
port is specified, all ports will be reset.
• --sure - if specified, the command will execute immediately without asking
for confirmation.
NAS Configuration CLI Commands
The following sections describe the supported NAS configuration CLI
commands:
• Listing the Existing NAS Share and Attributes
• Listing of Existing NAS Share Names
• Getting the Total NAS Share Count
• Adding a NAS Share
• Editing a NAS Share
• Enabling Allowlinks on a NAS Share
• Deleting a NAS Share
• Deleting All NAS Shares
• Joining or Disjoining a Windows Domain
• Workgroup Users
• Share Administrators
• CIFS Share Access Control
• NFS Share Access Control
• Getting NFS Share Settings
• Changing NFS Share Settings
• Query Status of a NAS Service
• Querying the CIFS Settings
• Setting the CIFS Settings
• Commit NFS Synchronously
• Commit NFS Asynchronously
NAS Configuration CLI Commands 21
Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
Listing the Existing NAS Share and Attributes
Listing of Existing NAS Share Names
syscli --list share [{--proto cifs|nfs} | {--name <share name>}] [-namematch <pattern>]
This CLI command provides a list of all existing NAS shares on the system and
their attributes. The list can be limited to the type of protocol if --proto is
specified. If --name is specified, only the attributes of that share are listed.
CLI command options:
• --list: Lists all NAS shares.
• * --namematch: If specified, only shares whose names match the specified
pattern are listed. The wild characters ^ and $ are supported as follows:
• ^xxx – matching pattern xxx at the start of names
• xxx$ – matching pattern xxx at the end of names
Remember to escape $ with a backslash because it is special to the shell. For
example, to list all shares ending with test in the names, type the following:
syscli --list sharename --namematch test\$
Note: Option marked with (*) means not supported in Web Services.
syscli --list sharename [--proto cifs|nfs] [--namematch <pattern>]
This CLI lists all share names for both CIFS and NFS. If --proto is specified, only
names of shares associated with the specified protocol will be listed.
Getting the Total NAS Share Count
CLI command options:
• --proto: If specified, limits the listing to the specified protocol.
• --namematch: If specified, only shares whose names match the specified
pattern are listed.
The wild characters ^ and $ are supported as follows:
• ^xxx — matching pattern xxx at the start of names
• xxx$ — matching pattern xxx at the end of names
Remember to escape $ with a backslash because it is special to the shell. For
example, to list all shares ending with test in the names, type the following
command: syscli --list sharename --namematch test\$
Alternately, you can list a single share with the following CLI command:
syscli --get share --name <sharename>
syscli --getcount share [--proto cifs|nfs] [--namematch <pattern>]
This CLI displays the total count of NAS shares defined in the system.
CLI command options:
• --proto: If specified, displays the count for this protocol only.
• --namematch: If specified, only shares whose names match the specified
pattern are counted.
22 NAS Configuration CLI Commands
Loading...