Difference between revisions of "QuantaStor Shell Utilities"
m (→qs-iostat) |
m (→qs-sendlogs) |
||
| Line 14: | Line 14: | ||
==qs-sendlogs== | ==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== | ==qs-sslcert== | ||
==qs-statsdb== | ==qs-statsdb== | ||
Revision as of 16:43, 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.
