QoreStor 6.1.0 - User Guide

Using the QoreStor Web Terminal

The QoreStor UI offers direct access to the QoreStor terminal for execution of CLI commands through the browser.

To access the Web Terminal

1. On the QoreStor UI, select System to expand the menu. Click Terminal
2. In the Username field, enter the desired user name. You will be prompted for the password.

   NOTE: QoreStor includes a custom shell implementation that simplifies and secures command line access. During installation, QoreStor creates the qsadmin user account with the permissions and configurations necessary to run QoreStor commands. Unless absolutely necessary, Quest recommends using the qsadmin account for CLI access. The default credentials are: user: qsadmin password: St0r@ge!

3. Click Connect to authenticate and access the terminal.
4. To view the list of available QoreStor commands, enter help at the prompt.

   NOTE: Refer to the QoreStor Command Line Reference Guide for more detailed information on QoreStor CLI commands.

5. To log out of the terminal, enter exit at the prompt.

Using the QoreStor REST API

QoreStor provides a REST API in order to provide an efficient method for application management or integration. For more information on using the REST API, see the sections below.

API Overview

All API requests should be sent to https://<QoreStor host>:5233/api. With the exception of the Authentication request, all requests should carry the HTTP header Authorization: Bearer <token>.

API calls will generate one of the response types below. Refer to the API documentation for the specific request for more information on expected responses.

• 200 - OK
• 400 - Bad request
• 401 - Unauthorized
• 404 - Not found
• 500 - Internal server error

Authentication

Authentication to the API is accomplished using the username and password for an existing QoreStor account. Once logged in, a token will be generated that can be used to authenticate API commands.

To use API authentication:

1. Execute the login request using the username and password for the desired QoreStor account as well as the IP or domain name of your QoreStor server.

   curl -X POST "https://QoreStor.host.com:5233/api/auth/login" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"name\": \"TestUser\", \"password\": \"TestUserPassword\"}"

2. In the request response, find and record the value for JWT_Token.
3. For subsequent API requests, ensure that the header contains the value Authorization: Bearer <token>.

   You may also use this token to authorize API requests via the documentation page. To do so,

   • At the top of the API documentation page, click Authorize.
   • In the Value field, enter the token.
   • Click Authorize.

API Documentation

The detailed documentation for the QoreStor API is hosted on your QoreStor serer. To view the documentation, enter the URL below into a browser.

https://<QoreStor Server>:5233//api/docs/index.html

The API documentation contains the following:

• An Authorize button to enable authentication.
• A list of available API resource categories. Each list is expandable to reveal the resources in each category.
• Each resource listing can be expanded to view the resource description, parameters and responses, and a Try it Out button that can be used to execute the API call with entered parameters.

To view and test an API

1. Before testing the API, authenticate as described in Authentication.
2. In the resource list, expand Containers.
3. Find the Get Containers request (GET/v1/Containers) and click to expand.
4. Click Try it Out. Note that the parameters fields are now enabled.

   NOTE: Parameters for Get Containers are optional. Some requests have required parameters.

5. Optionally, enter the parameters as described below:
   • Storage Group - The name of the storage group to which the containers belong
   • Type - required container type (cloud, link, or tier)
6. Click Execute.

Configuring QoreStor settings

In the QoreStor GUI, you can easily view and configure system settings such as, active directory, system date and time, expansion shelf enclosures, licenses, networking, schedules for system operations, SSL certificates, storage groups, and users.

Licensing QoreStor

QoreStor offers a backend capacity licensing model to allow for simple integration with other Quest Data Protection products.

• Standalone license - QoreStor is licensed by the amount of backend capacity required. Standalone licenses are available as either perpetual licenses (with no expiration), or term licenses, which expire after a specified period of time.

• NOTE: Term licenses are intended for specific customer use cases, i.e., licensing according to yearly billing cycles. A perpetual license is appropriate for most customers.

QoreStor licenses are additive, meaning that if you purchase a 5TB license now, and a 10TB license in the future, you will have 15TB total capacity.

Evaluating QoreStor

QoreStor offers two methods for evaluation:

• Default installation - If no license is installed, QoreStor defaults to a no-cost, 1TB capacity installation supported by the QoreStor Community. This option requires no license and does not expire.
  • If a license is applied to a server running in this mode, the free 1TB is not added to the purchased license capacity.
  • When installed in Demo mode, the capacity is limited to 100GB.
• Full capacity trial - available on the Quest Software Trial site, which provides a 30-day evaluation license for up to 360TB and access to Quest Support. After the evaluation period has expired, the QoreStor server will operate in Manual Intervention mode until a license is applied. To use QoreStor beyond that time frame, you will need to purchase a perpetual standalone license.
  • If installed in Demo mode, the capacity is limited to 100GB
  • If a longer trial period is required, please contact Quest Sales.

If you have purchased a standalone license, you can install it using the system --license command, as described in the QoreStor Command Line Reference Guide.