Understanding the QoreStor CLI
The QoreStor command line interface (CLI) provides the most efficient method for managing the status, data capacity, storage savings, and throughput of data containers. While some QoreStor functions can be managed through the QoreStor GUI, the CLI provides full access to all QoreStor features and functions.
Accessing the QoreStor CLI commands
This guide assumes that your QoreStor system has been deployed in the proper network location and is accessible to your workstation.
Accessing the CLI commands
Accessing the CLI commands
To access the command line interface for QoreStor:
- Using the terminal emulation application of your choice, connect to your QoreStor server.
- At the system prompt, enter the user name for an account with sufficient privileges.
- Type <user name>
- Press <Enter>
-
- At the password prompt, enter the password for the account used in the previous step:
- Type <password>
- Press <Enter>
- Enter the desired command at the prompt. To view the available QoreStor CLI commands, type help.
Alternatively, you may access the command line interface through the QoreStore web terminal in the QoreStor GUI.
QoreStor CLI commands overview
The following command groups are available in the QoreStor CLI.
For more information on each command group, run the following command:
<command name> --help show
Table 2: QoreStor CLI Commands Overview
alerts |
View system events and alerts. |
authenticate |
Configure Active Directory (AD) authentication. |
cloud_tier |
Configure a cloud connection. |
connection |
Configure OST or RDS access to a container. |
container |
Configure a filesystem to share over RDS or OST. |
email_alerts |
Configure/enable/disable QoreStor Alert Email Service. |
email_stats |
Configure/enable/disable QoreStor Daily Stats Report Service. |
iscsi
|
Manage and view iSCSI connection types for VTL containers. |
ndmp
|
Manage and view NDMP connection types for VTL containers. |
maintenance
|
Repair the data and state of the system. Collect diagnostics for the product. |
object_container |
Configure and manage Object Container. |
ost |
Configure OST for Veritas (formerly Symantec) backup applications. |
performance_tier |
Configure a performance tier storage group. |
qs_help |
Display the QoreStor help command listing. |
rda |
Configure Rapid Data Access (RDA) for the NetVault application. |
replication |
Manage replication between systems. |
schedule |
Manage replication and cleaner schedules in the system. |
seed |
Configure and manage seeding import or export. |
stats |
View statistics for system components. |
storage_group |
Manage and view the storage groups on a QoreStor |
system |
Manage and view the system configuration. |
user |
Enable or disable service and root accounts on the node. |
vtl |
Manage and view VTL container types. |