Difference between revisions of "OSNEXUS QuantaStor Documentation"

From OSNEXUS Online Documentation Site
Jump to: navigation, search
m (Developer Guide)
m (Command Line Interface / Scripting Guide)
Line 33: Line 33:
 
* Covers topics on how to integrate QuantaStor with other systems and applications.
 
* Covers topics on how to integrate QuantaStor with other systems and applications.
  
==== [[+ CLI Guide Overview|Command Line Interface / Scripting Guide]] ====
+
==== [[+ CLI Guide Overview|Command Line Interface (qs CLI) / Scripting Guide]] ====
 
* Covers the QuantaStor CLI (qs) which enables one to automate configuration steps or configure the system without the use of the Web UI.
 
* Covers the QuantaStor CLI (qs) which enables one to automate configuration steps or configure the system without the use of the Web UI.
  

Revision as of 11:16, 21 March 2019

Welcome to the OSNEXUS QuantaStor online documentation site. The following guides and sections cover all aspects of QuantaStor SDS configuration from installation to integration with 3rd party software. General information on key product features and product screenshots can be found on the main product site here: http://www.osnexus.com.

Overview

What is QuantaStor?

Trial & Community Edition Download

The QuantaStor 5 ISO image and license keys for Trial Edition (256TB, 30-days) and Community Edition (40TB, 2 years) are available for download here.

QuantaStor uses a single common ISO image for all editions so upgrading a system from Trial or Community Edition to Enterprise Edition just requires applying a new license key.

Guides / Manuals

Solution Design Guide

  • Covers general QuantaStor solution engineering and design guidelines

Installation Guide

  • Covers the process of installing QuantaStor onto bare-metal hardware or as guest VM to make a Virtual Storage Appliance.

Getting Started

  • Covers the initial system configuration steps including logging in, applying a license key, and other initial system step procedures.

Administrator Guide

  • This guide goes into detail on each of the features and capabilities of QuantaStor and how to configure them.

User Guide

  • Covers topics on how to connect to QuantaStor via various file and block protocols from servers and workstations.

Integration Guide

  • Covers topics on how to integrate QuantaStor with other systems and applications.

Command Line Interface (qs CLI) / Scripting Guide

  • Covers the QuantaStor CLI (qs) which enables one to automate configuration steps or configure the system without the use of the Web UI.

Developer (REST API) Guide

  • Covers how to use the QuantaStor REST API to integrate via various programming languages and utilities like 'curl'.

Support Guide

  • Covers product support topics including EULA, version EOL notices, version change log, support agreements and more.

Advanced Topics

SNMP Agent Setup

  • Detailed instructions on how to setup the SNMP agent to send SNMP traps.

Customizing Appliance Internals

  • Details on how to write custom scripts to augment various operations like system started/shutdown, storage pool start/stop, etc.

Troubleshooting Guide

  • Various troubleshooting topics ranging from login issues to driver upgrades.

Custom Unmanaged NFS/CIFS Shares

  • Instructions on how to create custom entries for SMB/NFS access which are ignored by QuantaStor

Appendix

Internal Architecture

  • Covers aspects of the internal architecture of the storage system.

Terms & Definitions

  • Glossary of terms and concepts used in managing various aspects of a QuantaStor storage system.