QuantaStor Shell Utilities - Revision history

Qadmin: Correct the qs-iostat -z documentation (QSTOR-12384): it does not restrict the view to ZFS pool members and does not apply extended statistics - verified on 6.9.0 that the output includes the system disk and dm- devices with kB rather than MB columns, because the subprocess call passes a list with shell=True and only the bare iostat survives. Replaces the recommendation to reach for it on a slow pool with the working alternatives

2026-09-03T08:48:07Z

Correct the qs-iostat -z documentation (QSTOR-12384): it does not restrict the view to ZFS pool members and does not apply extended statistics - verified on 6.9.0 that the output includes the system disk and dm- devices with kB rather than MB columns, because the subprocess call passes a list with shell=True and only the bare iostat survives. Replaces the recommendation to reach for it on a slow pool with the working alternatives

← Older revision		Revision as of 08:48, 3 September 2026
Line 376:		Line 376:
	\| {{Code\|1=-d}} \|\| I/O statistics for all devices.		\| {{Code\|1=-d}} \|\| I/O statistics for all devices.
	\|-		\|-
	\| {{Code\|1=-z}} \|\| ~~Extended~~ I/O statistics for the devices backing ZFS storage pools only.		\| {{Code\|1=-z}} \|\| ''Intended'' to show extended I/O statistics for the devices backing ZFS storage pools only. '''Currently reports plain statistics for every device instead''' -- see the note below.
	\|-		\|-
	\| {{Code\|1=-a}} \|\| ZFS ARC, ZIL, prefetch and L2ARC statistics.		\| {{Code\|1=-a}} \|\| ZFS ARC, ZIL, prefetch and L2ARC statistics.
Line 400:		Line 400:
	</pre>		</pre>

	{{Code\|1=-z}} is the ~~one~~ to ~~reach for~~ on ~~a pool that feels slow~~: ~~it restricts~~ the device ~~view to~~ the pool ~~members, so~~ a ~~single slow disk stands out instead of being averaged away. Use~~ {{Code\|1=qs-~~iostat~~ -z -f}} ~~while~~ the ~~workload is running~~.		'''{{Code\|1=-z}} does not currently restrict the view to pool members.''' Verified on 6.9.0: the output includes the system disk and device-mapper devices, and its columns are in kB rather than MB, so neither the pool-member filter nor the extended statistics are applied -- it behaves as a plain {{Code\|1=iostat}} over all devices. Tracked as [https://atlas.osnexus.net:8080/browse/QSTOR-12384 QSTOR-12384]. Until it is fixed, use {{Code\|1=-d}} for all devices and identify the pool's members from [[Storage Pools]] or {{Code\|1=zpool status}}, or read the per-disk view described in [[Performance Monitoring]], which plots a single device on its own.

	What the ARC and ZIL numbers mean, and what to do about them, is on [[Performance Tuning]]; see also [[IO Performance Tuning]] and [[Performance Monitoring]].		What the ARC and ZIL numbers mean, and what to do about them, is on [[Performance Tuning]]; see also [[IO Performance Tuning]] and [[Performance Monitoring]].

Qadmin: Link the new QuantaStor Touch Files page (QSTOR-12429)

2026-09-03T07:14:43Z

Link the new QuantaStor Touch Files page (QSTOR-12429)

← Older revision		Revision as of 07:14, 3 September 2026
Line 1,312:		Line 1,312:
	* [[Audit Log Analyzer]] -- the audit log in the web interface		* [[Audit Log Analyzer]] -- the audit log in the web interface
	* [[Hardware Controllers & Enclosures]] -- enclosure and controller management		* [[Hardware Controllers & Enclosures]] -- enclosure and controller management
			* [[QuantaStor Touch Files]] -- the empty marker files support may ask you to create, including the ones {{Code\|1=qs-util}}, {{Code\|1=qs-crm}}, {{Code\|1=qs-fscheck}} and {{Code\|1=qs-sendlogs}} read

	----		----
	<small>''Verified against QuantaStor 6.9.0.''</small>		<small>''Verified against QuantaStor 6.9.0.''</small>

Qadmin: Remove qs-rgw-moveobjects: it is deprecated and its functionality is in qs-s3util move-objects (QSTOR-12352)

2026-09-03T05:57:53Z

Remove qs-rgw-moveobjects: it is deprecated and its functionality is in qs-s3util move-objects (QSTOR-12352)

← Older revision		Revision as of 05:57, 3 September 2026
Line 22:		Line 22:
	\| High availability \|\| {{Code\|1=qs-crm}}, {{Code\|1=qs-iofence}}, {{Code\|1=qs-scstdlm}}, {{Code\|1=qs-pcsnodealert}} \|\| Corosync/Pacemaker state, SCSI-3 persistent reservations, clustered reservation locking.		\| High availability \|\| {{Code\|1=qs-crm}}, {{Code\|1=qs-iofence}}, {{Code\|1=qs-scstdlm}}, {{Code\|1=qs-pcsnodealert}} \|\| Corosync/Pacemaker state, SCSI-3 persistent reservations, clustered reservation locking.
	\|-		\|-
	\| Scale-out (Ceph) \|\| {{Code\|1=qs-ceph}}, {{Code\|1=qs-ceph-journalgroup}}, {{Code\|1=qs-osd-compact}}, {{Code\|1=qs-cephfsutil}}, {{Code\|1=qs-s3util}}, {{Code\|1=qs-rgw-autotier}}, {{Code\|1=qs-rgw-monitor~~}}, {{Code\|1=qs-rgw-moveobjects~~}} \|\| Cluster health, OSD and journal maintenance, CephFS and S3 object tooling.		\| Scale-out (Ceph) \|\| {{Code\|1=qs-ceph}}, {{Code\|1=qs-ceph-journalgroup}}, {{Code\|1=qs-osd-compact}}, {{Code\|1=qs-cephfsutil}}, {{Code\|1=qs-s3util}}, {{Code\|1=qs-rgw-autotier}}, {{Code\|1=qs-rgw-monitor}} \|\| Cluster health, OSD and journal maintenance, CephFS and S3 object tooling.
	\|-		\|-
	\| Certificates \|\| {{Code\|1=qs-sslcert}} \|\| Inspect, generate, install and reset the grid and web certificates.		\| Certificates \|\| {{Code\|1=qs-sslcert}} \|\| Inspect, generate, install and reset the grid and web certificates.
Line 1,116:		Line 1,116:

	Use a bucket created for the purpose. The check writes to it.		Use a bucket created for the purpose. The check writes to it.

	~~=== qs-rgw-moveobjects ===~~

	~~Moves objects between S3 storage classes in bulk. Requires root.~~

	~~<pre style="font-size: smaller">~~
	~~qs-rgw-moveobjects -b bucketlist.txt -s STANDARD_IA -e http://10.0.8.80:7480 \~~
	~~-k aAbBcCdDeEfF01234567 -x aAbBcCdDeEfF0123456789aAbBcCdDeEfF012345 -r us-east-1 -m 60000~~
	~~</pre>~~

	{{Code\|1=-b}} is a bucket name or a file listing one bucket per line, and accepts both {{Code\|1=bucket}} and {{Code\|1=tenant/bucket}}. {{Code\|1=-s}} is the destination storage class, {{Code\|1=-e}} the gateway endpoint, {{Code\|1=-k}} and {{Code\|1=-x}} the S3 access and secret keys, and {{Code\|1=-r}} the zone or region. {{Code\|1=-m}} sets a minimum object size in bytes -- only objects at or above it are moved, defaulting to 32768.

	{{Code\|1=qs-s3util move-objects}} does the same job with date filtering, per-bucket concurrency control and an error log, so prefer it for anything large. Storage classes and lifecycle rules from the web interface are on [[Ceph Object Storage]].

	== Certificates ==		== Certificates ==

Qadmin: Restore the verified detail that qs client packages are downloadable for Debian/Ubuntu, RedHat/CentOS and Windows (QSTOR-12352)

2026-09-03T05:50:19Z

Restore the verified detail that qs client packages are downloadable for Debian/Ubuntu, RedHat/CentOS and Windows (QSTOR-12352)

← Older revision		Revision as of 05:50, 3 September 2026
Line 50:		Line 50:
	{{Code\|1=qs}} is the full QuantaStor management interface as a command-line tool. It exposes the same operations as the web interface, and it is the tool to reach for when provisioning, licensing or cluster configuration needs to be scripted -- which is why it is the basis of most MSP and service-provider automation around QuantaStor.		{{Code\|1=qs}} is the full QuantaStor management interface as a command-line tool. It exposes the same operations as the web interface, and it is the tool to reach for when provisioning, licensing or cluster configuration needs to be scripted -- which is why it is the basis of most MSP and service-provider automation around QuantaStor.

	It is installed on every appliance, and it also runs remotely: point it at an appliance with {{Code\|1=--server}}, the {{Code\|1=QS_SERVER}} environment variable, or a {{Code\|1=~/.qs.cnf}} file holding {{Code\|1=ipaddress,username,password}}.		It is installed on every appliance, and it also runs remotely: point it at an appliance with {{Code\|1=--server}}, the {{Code\|1=QS_SERVER}} environment variable, or a {{Code\|1=~/.qs.cnf}} file holding {{Code\|1=ipaddress,username,password}}. Client packages for Debian/Ubuntu, RedHat/CentOS and Windows are on the [https://osnexus.com/downloads OSNEXUS downloads page], so the same commands can be run from an administrator's own workstation.

	The command set is large -- around two thousand commands and aliases -- so discovery matters more than memorisation:		The command set is large -- around two thousand commands and aliases -- so discovery matters more than memorisation:

Qadmin: Rewrite from the appliance: all 45 shipped qs-* utilities verified on a 6.9.0.274 master build, grouped by purpose, with real syntax, arguments and worked examples; corrected the qs-sendlogs argument names (--no-upload/--no-scrub; scrubbing is now the default, there is no --scrub) and the stale qs-status/qs-showlog output; added the ~30 utilities the page never covered; cross-linked to the pages that own each topic (QSTOR-12352)

2026-09-03T05:49:21Z

Rewrite from the appliance: all 45 shipped qs-* utilities verified on a 6.9.0.274 master build, grouped by purpose, with real syntax, arguments and worked examples; corrected the qs-sendlogs argument names (--no-upload/--no-scrub; scrubbing is now the default, there is no --scrub) and the stale qs-status/qs-showlog output; added the ~30 utilities the page never covered; cross-linked to the pages that own each topic (QSTOR-12352)

Show changes

Qadmin: /* qs-zvolutil */

2021-11-12T00:05:46Z

qs-zvolutil

← Older revision		Revision as of 00:05, 12 November 2021
Line 104:		Line 104:

	==qs-zvolutil==		==qs-zvolutil==
			On systems pre-2015 some users deployed QuantaStor on top of hardware RAID. This is not recommended as the hardware RAID layer can change the data out from underneath the filesystem. If the ZFS based filesystem is at RAID0 it will still detect this bit-rot and corruption as the checksums will not match but with RAID0 at the ZFS layer there's no ability to auto-repair the pool. This qs-zvolutil is a utility that can be used to zero out unreadable blocks within a zvol on a RAID0 device to assist with recovering the Storage Volume. It should only be used by OSNexus support.

Qadmin: /* qs-zconvert */

2021-11-12T00:02:27Z

qs-zconvert

← Older revision		Revision as of 00:02, 12 November 2021
Line 100:		Line 100:
	This utility has various commands for the support team to do triage and information gathering, it's for internal use only.		This utility has various commands for the support team to do triage and information gathering, it's for internal use only.

	==qs-zconvert==		==qs-zconvert==
			This command is used to import 3rd party OpenZFS storage pools. QuantaStor has a naming convention for the pool (qs-UUID) and the zvols (UUID) so 3rd party pools must go through a renaming process to prepare the pool for use and management by QuantaStor. So that none of the naming information is lost QuantaStor keeps the friendly name for the pool and zvol(s) and stores these as custom ZFS properties on the datasets. This command doesn't need to be used directly and can be accessed via the Storage Pool Import process that's available in the QuantaStor WUI and available in the CLI (qs pool-import) and REST API.

	==qs-zvolutil==		==qs-zvolutil==

Qadmin: /* qs-util */

2021-11-11T23:59:19Z

qs-util

← Older revision		Revision as of 23:59, 11 November 2021
Line 97:		Line 97:
	</pre>		</pre>

	==qs-util==		==qs-util==
			This utility has various commands for the support team to do triage and information gathering, it's for internal use only.

	==qs-zconvert==		==qs-zconvert==
	==qs-zvolutil==		==qs-zvolutil==

Qadmin: /* qs-status */

2021-11-11T23:58:08Z

qs-status

@@ Line 68: / Line 68: @@
 same as qs-sslcert
 ==qs-status==
 ==qs-util==
 ==qs-zconvert==
 ==qs-zvolutil==

Qadmin: /* qs-sslcertgen */

2021-11-11T23:57:22Z

qs-sslcertgen

← Older revision		Revision as of 23:57, 11 November 2021
Line 66:		Line 66:

	==qs-sslcertgen==		==qs-sslcertgen==
			same as qs-sslcert

	==qs-status==		==qs-status==
	==qs-util==		==qs-util==
	==qs-zconvert==		==qs-zconvert==
	==qs-zvolutil==		==qs-zvolutil==