DXi Command Line Interface (CLI)

The Command Line Interface (CLI) for DXi systems serves as a command line equivalent of the web-based remote management GUI. This guide describes the CLI commands available for any platform running v4.x software.

Terminology

DXi as used throughout this topic refers to DXi4800, DXi4801, DXi9000 Series, and DXi T-Series platforms.

Important Notes

CLI Syntax Conventions

The program you will use to operate your Command Line Interface (CLI) is syscli. The syscli program contains predefined tasks that you invoke through parameters. Parameters are comprised of commands, subcommands, options, and values that follow a specific syntax conventions.

Definitions

Review the following definitions of parameter components

Syntax Conventions

The syntax for all syscli commands uses one of the following formats:

Notes

Review the following CLI syntax notes for further information.

DXi CLI Users

The Command Line Interface (CLI) for DXi has three system user accounts: CLI administrator (cliadmin), CLI viewer (cliviewer), and Quantum Service user-only ServiceLogin.

Note: Do not use the ServiceLogin account unless requested by Quantum Service.

 

SSH Public Keys

Use the following commands to manage SecureShell (SSH) public keys for the CLI administrator (cliadmin), CLI viewer (cliviewer), and Service (servicelogin) user accounts.

Note: If the VDMS feature on the system is supported, licensed, and enbabled, the SSH public key commands can be used to manage the public keys for the VDMS agent (veeam).

CLI Commands, Codes, and Options

The Command Line Interface (CLI) contains the following help commands, error and exit codes, and special options.

Administrative Alert CLI Commands

This section presents supported administrative alert CLI commands.

Analyzer CLI Commands

This section presents supported Analyzer CLI commands.

Application Environment CLI Commands

This section presents application environment CLI commands. Use these commands to do the following:

Manage DAE

Use the following commands to manage a Dynamic Application Environment (DAE).

Manage Veeam

Use the following commands to manage Veeam agent integration.

Manage Increased Stream Counts (ISC)

Backup Application User CLI Commands

Use the following CLI commands to manage Open Storage (OST), RMAN, AccentFS, and Path to Tape (PTT) backup application users.

Cloud-Based Analytics (CBA) CLI Commands

Use the following commands to manage email recipients of DXi service tickets.

Note: This feature is only available in Licensed Editions with Quantum Service and Support.

Cloud Share CLI Commands

This section presents supported Cloud Share CLI commands.

Configuration CLI Commands

This section lists supported configuration CLI commands. Use these commands to do the following:

Note: NAS is only available on certain DXi models. See your DXi User's Guide to determine whether NAS is available for your model.

Manage User Access

Use the following commands to assign and manage users, workgroup users, and administrators within created groups for specific share, OST VTL and partition access in your DXi system.

Note: Some commands in this section replace NAS commands in previous releases. Also see Manage CIFS Shares for commands to manage Workgroup Users.

Manage Shares for a DXi System

Use the following commands to manage Network Attached Storage (NAS) and Application-Specific shares for your DXi system.

Note: NAS is only available on certain DXi models. See your DXi User's Guide to determine whether NAS is available for your model.

Manage Workgroups and ADS Domains

Use the following CLI commands to manage your DXi system's connection to workgroups or Active Directory Service (ADS) domains.

Note: NAS is only available on certain DXi models. WG/AD connectivity is NAS-dependent. See your DXi User's Guide to determine whether NAS is available for your model.

Manage CIFS Shares

Use the following CLI commands to manage Common Internet File System (CIFS) shares on your DXi system.

CIFS Share Administrator Privileges

When the Samba server is joined to an Active Directory Service (ADS) domain, domain users can access CIFS shares but they cannot manage the shares using the CLI. The CLI merely provides a limited capability to grant share administrator privileges to certain domain users. A share administrator is a domain user or domain group that is granted the privilege of setting share permissions.

To manage the CIFS shares, the Windows domain administrator needs to log in to the Windows server and use the Microsoft Management Console (MMC).

CIFS Share Users

Two types of users are allowed access to CIFS shares depending on whether the system is joined to a workgroup or an ADS domain. When the server is joined to a workgroup, only workgroup users can access CIFS shares, and various CLI commands provide the capabilities to manage them. Workgroup users are stored in both the local Linux database and the Samba password database.

Note: NAS is only available on certain DXi models. See your DXi User's Guide to determine whether NAS is available for your model.

Note: The List, Add, Edit, and Delete workgroup Users commands previously in this section have been modified and moved to Manage User Access.

Manage NFS Shares

Use the following CLI commands to manage Network File System (NFS) shares.

Note: NAS is only available on certain DXi models. See your DXi User's Guide to determine whether NAS is available for your model.

Date And Time CLI Commands

This section presents supported CLI commands to use in managing system date and time.

Email Configuration CLI Commands

This section presents email configuration CLI commands. Use these commands to do the following:

Manage Outgoing Email Server

Use the following commands to manage the outgoing email server.

Manage Service Ticket Recipients

Use the following commands to manage email recipients of DXi service tickets.

Manage Report Recipients

Use the following commands to manage the recipients of configuration and status reports, as well as to send the reports on demand to specified recipients.

Manage SNMP Trap Destinations

Use the following commands to manage Simple Network Management Protocol (SNMP) on your system.

Test Email and SNMP Configuration

Use the following commands to test email and Simple Network Management Protocol (SNMP) configuration settings.

Encryption CLI Commands

Data-at-Rest Encryption uses Self-Encrypting Drive (SED) technology to secure all data stored on DXi systems, including:

When Data-at-Rest Encryption is enabled, all hard drives in the DXi are paired with the disk controllers through encryption keys. After this pairing, accessing data on the drives requires the same encryption keys and controllers that were used to write the data. This access method ensures that a drive physically removed from the DXi cannot be read using another system or device.

System Requirements

To enable Data-at-Rest Encryption, you must ensure that the following requirements are met.

Caution: After you enable Data-at-Rest Encryption, you cannot disable it or turn it off. Make sure to back up your passphrase and security files, as they may be required for future capacity expansion or rare hardware failure scenarios.

Manage Encryption

Use the following CLI commands to manage encryption for a DXi system.

Note: Data-at-Rest Encryption is also referred to as hard drive (HD) security.

Health Check CLI Commands

This section presents supported Health Check CLI commands.

Network Configuration CLI Commands

This section presents network configuration CLI commands. Use these commands to do the following:

Considerations

Before using network configuration CLI commands, review the following:

Caution: Changes made with network configuration CLI commands might cause the system to become inoperable or unreachable.

Manage Network Configuration

Use the following CLI commands to manage your network configuration. In general, use these commands to set individual IP subnet information for each physical interface. In addition to configuring independent ports, you can create multiple bonds, although all ports in a bond must be the same type.

Manage Network Throttle

Use the following CLI commands to manage network throttle.

Manage Network Routes

Use the following CLI commands to manage network routes.

Manage System Firewall

Use the following CLI commands to manage the system firewall.

Network Configuration Examples

This section presents examples of advanced network configuration CLI commands. When reviewing these examples, keep the following in mind.

OST CLI Commands

This section lists supported OpenStorage Technology (OST) CLI commands.

Use these commands to do the following:

Note: OST is only available on certain DXi models. See your DXi User's Guide to determine whether OST is available for your model.

Manage OST Global Settings

Use the following commands to manage global settings for OpenStorage Technology (OST).

Note: OST is only available on certain DXi models. See your DXi User's Guide to determine whether OST is available for your model.

Manage Storage Servers and LSUs

Use the following commands to manage OpenStorage Technology (OST) storage servers and attached logical storage units (LSUs).

Note: OST is only available on certain DXi models. To see if OST is enabled for your system, check the Utilities > License Keys page in the remote management console.

Manage TLS Certificate Files for Replication and/or OST

Use the following commands to manage Transport Layer Security (TLS) certificate files for Replication and/or OpenStorage Technology (OST).

Note: OST is only available on certain DXi models. See your DXi User's Guide to determine whether OST is available for your model.

Manage AIR for OST

Use the following commands to manage Automatic Image Replication (AIR) for OpenStorage Technology (OST).

Note: OST is only available on certain DXi models. See your DXi User's Guide to determine whether OST is available for your model.

Path To Tape CLI Commands

This section presents Path To Tape (PTT) CLI commands. Use these commands to manage PTT CLI commands:

Note: PTT is only available on certain DXi models. See your DXi User's Guide to determine whether PTT is available for your model.

Manage Path To Tape Configuration

Use the following CLI commands to manage path to tape (PTT) configuration.

Note: PTT is only available on certain DXi models. See your DXi User's Guide to determine whether PTT is available for your model.

Replication CLI Commands

This section lists supported Replication CLI commands.

Use these commands to do the following:

Manage System Replication

Use the following commands to manage replication for your DXi system.

Note: For the purposes of this section all references to NAS apply to Application Specific shares as well.

Manage VTL Replication

Use the following commands to manage replication for Virtual Tape Libraries (VTLs).

Manage NAS and Application Specific Shares

Use the following commands to manage replication for Network Attached Storage (NAS) and Application Specific shares.

Note: For the purposes of this section, NAS also refers to Application Specific.

Manage OST Replication

Use the following commands to manage replication for OpenStorage Technology (OST).

Scheduler CLI Commands

This section lists supported Scheduler CLI commands that you can use to establish and maintain schedules for certain events. The events can be a single occurrence or can be set to recur on a specified schedule.

Secure Snapshot CLI Commands

Use the following commands to manage Secure Snapshots:

Service Ticket CLI Commands

This section presents supported service ticket CLI commands.

Statistics Report CLI Commands

This section presents supported CLI commands for statistics reporting.

Status CLI Commands

This section presents supported status CLI commands.

Use these commands to do the following:

Access System Status

Use the following CLI commands to access the statuses of the DXi system.

Access VTL Status

Use the following CLI commands to access statuses for your virtual tape libraries (VTLs).

Utility CLI Commands

This section presents utility CLI commands.

Use these commands to do the following:

Manage the Administrative Activity Log

Use the following utility CLI commands to manage the Administrative Activity Log.

Manage Compaction Services

Use the following utility CLI commands to manage compaction services.

Manage Diagnostic Logs

Use the following utility CLI commands to manage diagnostic logs for the DXi system.

Manage Hostbus Adapters

Use the following utility CLI commands to manage Hostbus Adapters (HBAs) for the DXi system.

Manage LDAP/AD

Use the following CLI commands to manage Lightweight Directory Access Protocol (LDAP) user settings.

Manage Licenses

Use the following utility CLI commands to manage licenses for the DXi system.

Manage Logging

Use the following utility CLI commands to manage logging for the DXi system.

Manage Metrics Exporter

Use the following utility CLI commands to manage the Metrics Exporter.

Manage Nodes

Use the following utility CLI commands to manage nodes.

Manage Passwords and Logins

Use the following utility CLI commands to manage users' passwords, monitor login attempts, and set user inactivity timeouts on the DXi system.

Manage the Security Banner

Use the following utility CLI commands to manage the DXi system's security banner.

Manage Software RAID

Use the following utility CLI commands to manage the DXi T-Series software RAID.

Manage Space Reclamation

Use the following utility CLI commands to manage space reclamation.

Manage Upgrades

Use the following utility CLI commands to manage system upgrades.

VTL Configuration CLI Commands

This section presents Virtual Tape Library (VTL) CLI commands.

Use these commands to do the following:

Note: VTL is only available on certain DXi models. To see if VTL is enabled for your system, check the Utilities > License Keys page in the remote management console. To use VTL commands, at least one Fibre Channel card must be installed in the DXi. (Exception: You can always use VTL failback commands, even when no Fibre Channel card is installed.)

Manage VTLs for a DXi System

Use the following CLI commands to manage Virtual Tape Libraries (VTLs) for your DXi system.

Note: VTL is only available on certain DXi models. To see if VTL is enabled for your system, check the Utilities > License Keys page in the remote management console. To use VTL commands, at least one Fibre Channel card must be installed in the DXi. (Exception: You can always use VTL failback commands, even when no Fibre Channel card is installed.)

Manage Media for VTLs

Use the following CLI commands to manage media for your Virtual Tape Libraries (VTLs).

Note: VTL is only available on certain DXi models. To see if VTL is enabled for your system, check the Utilities > License Keys page in the remote management console. To use VTL commands, at least one Fibre Channel card must be installed in the DXi. (Exception: You can always use VTL failback commands, even when no Fibre Channel card is installed.)

Manage Hosts for VTLs

Use the following CLI commands to manage hosts for your Virtual Tape Libraries (VTLs).

Note: VTL is only available on certain DXi models. To see if VTL is enabled for your system, check the Utilities > License Keys page in the remote management console. To use VTL commands, at least one Fibre Channel card must be installed in the DXi. (Exception: You can always use VTL failback commands, even when no Fibre Channel card is installed.)

Manage SAN Client Groups for VTLs

Use the following CLI commands to manage SAN Client Groups for Virtual Tape Libraries.

Note: VTL is only available on certain DXi models. To see if VTL is enabled for your system, check the Utilities > License Keys page in the remote management console. To use VTL commands, at least one Fibre Channel card must be installed in the DXi. (Exception: You can always use VTL failback commands, even when no Fibre Channel card is installed.)