Difference between revisions of "QuantaStor Shell Utilities"
m (→qs-version) |
m (→qs-zpoolscrub) |
||
| Line 29: | Line 29: | ||
==qs-zpoolscrub== | ==qs-zpoolscrub== | ||
| + | This is a deprecated script that can be used to run a periodic scrub of a pool. It has been replaced by the Maintenance Schedule which can be created in the Schedules section in the QuantaStor WUI. | ||
| + | |||
==qs-avidlog== | ==qs-avidlog== | ||
==qs-crm== | ==qs-crm== | ||
Revision as of 16:51, 11 November 2021
Internal to every QuantaStor system is the QuantaStor CLI utility 'qs' which has all the same command functionality as the QuantaStor web management interface (WUI) but there are also other helper utilities for support and triage activities like log collection. This section will go over the basic description of each of these utilities.
Contents
qs
This is the main QuantaStor management CLI which is available for download for Linux and Windows from the downloads page. Full documentation for the qs CLI is available on here here. The qs CLI can be used to automate applying licenses to systems, creating snapshots, provisioning file, block and object storage and even automating complete configuration of new clusters. It's especially useful for MSPs/CSPs where frequent configuration and setup of new QuantaStor systems needs to be automated.
qs-ceph
This internal utility helps with gathering stats on mons, pools, osds, and general cluster health. It's a low level utility that in turn calls ceph CLIs. The 'qs-ceph cleanup' command can be used to completely wipe a Ceph Cluster configuration from a system but this should only be used with great caution and only by OSNexus support.
qs-distupgrade
Regular upgrades of QuantaStor systems do not do an upgrade of the underlying distro. This is because a ditro upgrade will upgrade various drivers and other packages that could lead to a longer maintenance window for the upgrade. As such upgrades of the underlying Linux distro should only be done when an adequate maintenance window has been reserved and one should coordinate with OSNexus support before doing a distro upgrade so that your system logs can be reviewed before and after. This script runs the distro upgrade itself and is customized to handle the various platforms QuantaStor is available on.
qs-iostat
This is a helper script which is an overlay over other Linux utilities for looking at device IO stats, ARC stats, and CPU stats. It can be used as part of a hardware triage effort to see what's happening with the hardware performance wise.
qs-sendlogs
This is the main log collection and sending script and you can run it with no args to collect logs and have those sent automatically to the OSNexus log collection server. If your system is deployed in a dark-site then you should use the --no_upload=1 option so that the logs are not attempted to be uploaded when the system doesn't have direct internet access. The --scrub=1 option will remove all personally identifiable information from the logs to make them GDPR compliant. When you use the Send Logs dialog from within the QuantaStor WUI it is using this same script to send logs and by default it does a --scrub=1 to ensure all logs sent to OSNexus are pre-scrubed.
qs-sslcert
This is a helper utility to get information about the SSL certs on the system that QuantaStor is using for inter-node and web communication. All certificates can be replaced and this script helps with that process. See the Security Configuration section for more detail on how to change the certificates in your QuantaStor storage grid.
qs-statsdb
QuantaStor uses InfluxDB to store real-time stats which are then presented in dashboards within various parts of the QuantaStor web management interface (WUI). Custom dashboards can be created in Grafana and this is also documented in the wiki. This qs-statsdb is a simple utility that makes inquiries into InfluxDB so that one can see some of the data. It is good to triaging issues with the dashboards or stats data collection issues.
qs-upgrade
This is the main product upgrade script which is used to upgrade QuantaStor using the package servers at packages.osnexus.com. When one does an upgrade via the QuantaStor WUI it in turn uses this script to drive the upgrade process. QuantaStor commercial packages are packaged in .rpm and .deb platform and use standard yum/apt tools to drive the upgrade process. This script is doing operations like updating the package catalog and running the upgrade of all the various packages and security package updates for the platform.
qs-version
Prints the current version of QuantaStor running on the system for the CLI, Service, WUI, and then gets the version information for all the nodes of the grid the local system is a member of.
qs-zpoolscrub
This is a deprecated script that can be used to run a periodic scrub of a pool. It has been replaced by the Maintenance Schedule which can be created in the Schedules section in the QuantaStor WUI.
