OSNEXUS Online Documentation Site - User contributions [en]

QuantaStor 6.8.5 Upgrade Instructions

2026-08-19T22:58:02Z

Qadmin: QuantaStor 6.8.5 upgrade instructions

= Upgrading to 6.8.5, and Latest OS Packages and Security updates via Command Line Interface =

'''This is the recommended option for systems running 6.x QuantaStor versions on the Focal Platform, and systems that may be out of date and require OS level package updates as well.'''

This procedure will upgrade the QuantaStor system to the latest software version, and also update all OS level packages to their latest versions as well, ensuring the system software has the latest security patches in place.

It is recommended that you schedule a downtime work window, as a reboot may be required for changes in the 6.8.5 upgrade. You will need to run these commands as a user with sudo access on the QuantaStor appliance, such as the default 'qadmin' account, or as root if you have enabled direct root access.

:''NOTE: We recommend allocating a maintenance window for all upgrades. For more complex upgrades we recommend scheduling time with OSNEXUS support for assistance.''

'''Login to the CLI to perform a full upgrade to QuantaStor 6.8.5 along with the latest Kernel and Security and OS packages.'''

<pre>
# For Noble platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-noble/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Jammy platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-jammy/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Focal platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-focal/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true
</pre>

Once the install completes you will be running QuantaStor 6.8.5

'''Platform Upgrades from Jammy to Noble via the qs-distupgrade command are enabled with the 6.8.0 release.'''

'''Platform Upgrades from Focal to Jammy via the qs-distupgrade command are enabled with the 6.5.1 release.'''

'''Platform Upgrades from Bionic to Focal via the qs-distupgrade command are enabled with the 6.0.4 release.

'''Platform Upgrades from Xenial to Bionic via the qs-distupgrade command are enabled with the 5.10.2 release.

'''OSNEXUS Support recommend fully upgrading to the latest available, including System and Kernel Updates using the commands above. Please contact Support for assistance with a platform upgrade.'''

'''Platform Upgrades via the qs-distupgrade command from QuantStor 4.x on Trusty are enabled with the 4.7.2 release. '''

'''Please contact support@osnexus.com if you have any questions or need upgrade assistance.

QuantaStor Version ChangeLog

2026-08-19T22:58:02Z

Qadmin: QuantaStor 6.8.5 release notes

[[Category:Support guide]]
= Change Log Overview =
The change log contains a detailed summary of the changes made for each new release of QuantaStor. Each change made to QuantaStor is tracked with an engineering ticket number in the form '''[QSTOR-NNNN]'''. This information is provided so that if you're working with OSNexus support you can track the availability of a given product feature add, improvement, or maintenance fix to a specific release. For information on how to upgrade your storage system please see the [[QuantaStor Upgrade Guide|Upgrade Guide]].

== Versioning System ==
QuantaStor version numbers consist of four (4) parts. A major number (M), minor number (N), maintenance update number (U) and build number (B) of the form M.N.U.B such as 6.0.2.006.

QuantaStor upgrades go directly from whatever version you are running to the latest version, with no interim steps so for example if you are at v6.0.1 you will upgrade directly to the latest version which may be v6.1.2

== Product Update Types ==

==== Major Updates (X.y.z) ====
If the first digit in the version number has changed this indicates a major product release such as QuantaStor v5 to QuantaStor v6. Major releases generally come with a new underlying Linux platform as the basis. For example, the standard ISO install for QuantaStor v5 is based on Ubuntu 18.04 whereas QuantaStor v6 is based on Ubuntu 20.04. Major product releases generally include new features and maintenance updates and are supported on multiple underlying Linux platforms. For example, QuantaStor v6 is available as an upgrade on Ubuntu 18.04 and Ubuntu 20.04 based systems as well as RHEL and RHEL derivative platforms. Platform upgrades to move systems forward (eg 18.04 to 20.04) are made generally available in the first feature update release, such as QuantaStor 6.1.

==== Feature Updates (x.Y.z) ====
If the second digit in the version number has changed this indicates a feature release such as 6.'''1''' going to 6.'''2'''. Feature releases add new product features as well as a maintenance updates. No additional licensing is required to access any new features that added but note that QuantaStor licenses do not include licenses for 3rd party products and services that may integrate with QuantaStor.

==== Maintenance Updates (x.y.Z) ====
If the third digit of the version number has changed this such as 6.0.'''2''' or 6.0.'''3''' it represents a maintenance update to address one or more support tickets. These updates generally do not contain new features, only fixes to address specific issues. Maintenance releases generally ship every 4 to 8 weeks. All maintenance "aka hot-fix" releases are provided against the current stable release so upgrading to the latest QuantaStor version is generally required to apply them.

==== Build Number (x.y.z.BBB) ====
The build number and corresponding build reference hash can be largely ignored. The build number simply increments with each commit that is made to the source tree. The hash is provided to make it easier for OSNEXUS support and engineering to quickly confirm difference between your current running release and any more modern release.

== Boot Install Image and other downloads ==
=== ISO/DVD/USB Boot Install Image ===

* The latest version of QuantaStor can be found on our [https://downloads.osnexus.com downloads page here].

* [[QuantaStor Installation via USB Thumb Drive|Bootable Flash Drive instructions.]]

NOTE: Archived older versions of QuantaStor ISO install media and CLI tools can be found [https://downloads.osnexus.com.s3.us-east-1.amazonaws.com/list.html here].

= Recent Change Logs =

== v6.8.5.018 (August 19th 2026) ==

=== [[QuantaStor 6.8.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.5 Upgrade Instructions | upgrading to QuantaStor v6.8.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed: RGW auto-tiering rules now apply to tenant-scoped buckets; the tiering script is installed for every tenant instead of only the default one. [ QSTOR-12223 ]
* Added: auto-tiering rules can now be scoped to a tenant from the web interface and CLI - all tenants, buckets outside any tenant, or a named tenant. [ QSTOR-12225 ]
* Changed: named-tenant matching is now exact ('sc2' no longer also matches 'sc2_prod'); no rule created in the web interface could carry a named tenant before this change, so no existing configuration is affected. [ QSTOR-12225 ]

Enclosures and Controllers
* Fixed: Supermicro SC846 and SC847 enclosures reporting vendor SMC now match their JBOD layout profile instead of logging a layout detection failure on every discovery cycle. [ QSTOR-11947 ]
* Fixed: disks could remain displayed under a 9600-series HBA after the attached storage was removed, because a successful-but-empty discovery result was treated as a command failure and the disk list was never refreshed. [ QSTOR-12036 ]

Network Shares
* Fixed: Active Directory user and group lookups no longer fail intermittently where a domain controller address reverse-resolves to a name other than the controller own name. [ QSTOR-12214 ]
* Added: a domain-join option that disables reverse DNS canonicalization and sends user and group lookups to every pinned domain controller. [ QSTOR-12214 ]
* Fixed: an Active Directory user/group search now reports why it could not run, instead of always blaming a trusted-domain search filter. [ QSTOR-12216 ]

Service Core
* Fixed a qs_service crash under sustained DB connection pool exhaustion on large Ceph/S3 grids by serializing and capping overflow connection creation. [ QSTOR-11580 ]
* Fixed: a task that failed to resume after a service restart could block every other task from resuming. [ QSTOR-12218 ]
* Fixed: the task resume limit was not enforced for some task types, so a task that could never finish was retried on every service start. [ QSTOR-12218 ]

Storage Pool Management
* Added capability to simulate Corvault configurations in order to test pool configurations for redundancy. [ QSTOR-11945 ]

Upgrade Manager and Installer
* Fixed: a storage system upgrade task could stop resuming after the second service restart, leaving a completed upgrade reported as stuck at 30%. [ QSTOR-12177 ]
* Fixed: leftover upgrade progress files were never purged, so a finished upgrade could keep reporting stale progress. [ QSTOR-12219 ]
* Fixed: 6.8.4 ISO and OVA images were missing qstortomcat, qstorrest, qstoraws and qstorbase, which left the web interface unavailable after an offline install. The images have been rebuilt. [ QSTOR-12237 ]
* Added: an ISO build now fails if a package it declares is absent, so an incomplete image cannot ship. [ QSTOR-12237 ]
== v6.8.4.038 (August 13th 2026) ==

=== [[QuantaStor 6.8.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.4 Upgrade Instructions | upgrading to QuantaStor v6.8.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the Ceph Cluster Coordinator role could become stuck on one node. The automatic fallback election methods (grid-primary, site-primary, mon-rank) were not taking effect, so when no designated coordinator was set, coordinatorship never moved (e.g. after changing the grid master). Automatic coordinator election now works correctly; explicitly designated coordinators were unaffected. [ QSTOR-12194 ]

Dashboards and Analytics
* Fixed the Ceph RGW dashboard on Ceph Tentacle so it correctly reports throughput/latency when transferring files to a bucket. [ QSTOR-11803 ]

High Availability Failover
* Fixed the script to set the device reservation ability on WD Openflex Data24 [ QSTOR-12117 ]
* Fixed site cluster heartbeat rings so each ring keeps its own network address and member list. Previously the rings of a multi-ring site collapsed into a single entry with no subnet shown. [ QSTOR-12159 ]

Network Shares
* Adds an explicit domain controller to the GSSAPI ldapsearch for Active Directory user and group lookups, fixing intermittent failures on multi-controller domains. Domain joins also wait longer for a busy controller. [ QSTOR-11939 ]
* Added a cleanup-only mode to the Active Directory leave operation that reverts the local domain configuration without contacting the domain controller, for recovering from a failed or partial leave. [ QSTOR-12058 ]
* Fixed: SMB/DFS network share namespace referrals now advertise all of an appliance's reachable addresses rather than just one, so clients on any subnet can reach the share. [ QSTOR-12107 ]
* Fixed per-user share permissions so an existing entry with no recorded read/write/execute setting is treated as full access rather than no access. Modifying a share no longer rewrites ACLs when no permission actually changed. [ QSTOR-12113 ]
* Fixed Active Directory joins in SSSD-only mode against Windows Server 2025 domain controllers, which previously failed to set the machine account password. [ QSTOR-12141 ]
* Fixed placeholder values such as None, null or undefined sent by API clients being written into the Samba configuration, which stopped Samba loading the file and took SMB access down for every share on the node. [ QSTOR-12152 ]
* Fixed the Active Directory leave hanging when the PDC Emulator is offline. The leave now completes within a bounded timeout and reverts the local configuration. [ QSTOR-12161 ]

== v6.8.3.018 (August 6th 2026) ==

=== [[QuantaStor 6.8.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.3 Upgrade Instructions | upgrading to QuantaStor v6.8.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Creating or removing a Ceph object storage class now commits the RGW period so it takes effect immediately. [ QSTOR-11938 ]
* A failed bucket enumeration is no longer treated as an empty list, which could silently drop bucket configuration. [ QSTOR-12130 ]
* Ceph object pool group creation now commits the RGW period, fixing persistent RGW realm/master-zone errors. [ QSTOR-12132 ]

Network Shares
* Fixed Active Directory join failures on domains that use older Kerberos encryption methods. [ QSTOR-11646 ]
* Changed: Active Directory joins now set 'restrict anonymous = 2' in smb.conf to block unauthenticated SID/RID enumeration. [ QSTOR-11834 ]
* Fixed: Active Directory joins no longer fail when the computer-account OU contains a space. [ QSTOR-11895 ]
* Fixed: Active Directory joins no longer disable SASL signing in the system-wide ldap.conf. [ QSTOR-11926 ]
* Added a 'Skip DNS registration' option to the Active Directory join dialog, CLI and API for sites whose DNS is managed outside AD. [ QSTOR-12083 ]
* Fixed a custom autorid Domain Range Size being discarded during an Active Directory join. [ QSTOR-12089 ]
* The Active Directory KDC field now accepts a comma-separated list of domain controllers for Kerberos failover. [ QSTOR-12091 ]
* Active Directory joins in SSSD modes no longer force user/group enumeration, which could stall startup on large domains. [ QSTOR-12092 ]
* Fixed: Active Directory joins now send the machine-account password update to the PDC Emulator, fixing 'Message stream modified' failures. [ QSTOR-12136 ]
* Fixed: leaving an Active Directory domain now updates the web UI immediately instead of still showing the old domain. [ QSTOR-12153 ]
* Changed: the Active Directory join dialog now labels its two ID-range sections distinctly so it's clear which is being edited. [ QSTOR-12154 ]

Service Core
* Memory optimization for grid event handling. [ QSTOR-12112 ]

Upgrade Manager and Installer
* The upgrade system now fetches and verifies the latest OSNEXUS package signing key before applying updates. [ QSTOR-9551 ]
* Fixed EL8 upgrades pinning a stale awscli/qstoraws package version from the RedHat repository. [ QSTOR-11991 ]
* In-place Ceph upgrades now install the shipped Ceph 20.2.2 release instead of an older pinned version. [ QSTOR-11998 ]
* Fixed a grafana-enterprise package upgrade failure that could leave dpkg in a held state during upgrades from 6.8.1. [ QSTOR-12075 ]
* Updated the Ubuntu 24.04 upgrade configuration to the shipped kernel and Ceph 20.2.2 versions. [ QSTOR-12077 ]

== v6.8.2.002 (July 24th 2026) ==

=== [[QuantaStor 6.8.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.2 Upgrade Instructions | upgrading to QuantaStor v6.8.2]].

=== Release Notes ===

Network Shares
* Fixed: AD groups could not be added to a Network Share ACL in Winbind+SSSD mode (group@DOMAIN form could not be resolved). [ QSTOR-12025 ]

== v6.8.1.007 (July 18th 2026) ==

=== [[QuantaStor 6.8.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.1 Upgrade Instructions | upgrading to QuantaStor v6.8.1]].

=== Release Notes ===

Upgrade Manager and Installer
* Fixed: platform upgrades remove the obsolete linux-tools-common package that could trigger security alerts. [ QSTOR-10314 ]
* Changed: qs-distupgrade output is timestamped and includes a pre-upgrade configuration report. [ QSTOR-11632 ]
* Added: platform distribution upgrade (qs-distupgrade) from Ubuntu 22.04 to 24.04. [ QSTOR-11651 ]
* Added: non-interactive flags for qs-distupgrade enabling fully unattended platform upgrades with automatic reboot. Use the qs-distupgrade --help to review the available usage options. [ QSTOR-11918 ]
* Fixed: platform distribution upgrades keep Ceph pinned at its current version. [ QSTOR-11955 ]
* Added: qs-distupgrade requires all Ceph nodes on the latest offered Ceph version (--skip-check-ceph-latest to override). [ QSTOR-11958 ]
* Fixed: coordinated Ceph upgrades restart all RGW daemons on hosts running multiple RGW services. [ QSTOR-11983 ]
* Fixed: a 6.8.0-only issue where service-driven package upgrades reported success without installing anything. [ QSTOR-11992 ]

== v6.8.0.205 (July 8th 2026) ==

=== [[QuantaStor 6.8.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.0 Upgrade Instructions | upgrading to QuantaStor v6.8.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert webhook support for Google Chat. [ QSTOR-9793 ]
* Allow users to have a subset of alert subscriptions. [ QSTOR-11683 ]

Ceph Scale-out Block, Object and File
* Added an 'Enable Versioning' checkbox to the Create Bucket dialog (automatically enabled when object locking or governance/compliance is selected); versioning can also be enabled on existing buckets. [ QSTOR-10937 ]
* Added Ceph Tentacle 20.2.2 support to the Jammy QuantaStor ISO and package mirror. [ QSTOR-11441 ]
* QuantaStor 6.8 ships Ceph 20.2.2 (Tentacle), which includes the upstream MDS fix (tracker #76031) for the SIGABRT/crash on client eviction caused by a null MDRequestRef under sustained metadata contention. [ QSTOR-11504 ]
* The Ceph Tentacle 20.2.2 release resolves frequent radosgw (RGW) crashes related to Kafka bucket notifications. [ QSTOR-11687 ]
* Fix ceph bucket delete with large number of objects timing out. [ QSTOR-11728 ]
* Removed: the deprecated S3 bucket orphan-object cleanup feature; any existing scheduled task is disabled automatically on upgrade. [ QSTOR-11729 ]
* Fixed a regression where deleting multiple Ceph (RBD) volumes at once on a multi-node cluster would fail after the first volume. [ QSTOR-11756 ]
* Added support for major-version Ceph upgrades (through Tentacle 20.2.x) in the upgrade script. [ QSTOR-11762 ]
* Increase the timeout for "Add Node" to a ceph cluster [ QSTOR-11906 ]

Dashboards and Analytics
* Added: a 'qs-statsdb resetpassword' command to rotate the InfluxDB stats password; telegraf is updated in lockstep so dashboards keep working. [ QSTOR-11170 ]
* Rebuilt bundled telegraf with its vendored rclone library updated to 1.74.3, clearing CVE-2026-41176 and CVE-2026-41179. [ QSTOR-11771 ]

Enclosures and Controllers
* Fixed issue with "disappearing" enclosures [ QSTOR-11676 ]
* Added support for the Supermicro SSG-222B-NE3X24R all-NVMe server, including hardware enclosure auto-detection, enclosure layout and diagram, and NVMe drive slot mapping in the QuantaStor web management interface. [ QSTOR-11712 ]

High Availability Failover
* Add logging for manually run iofence commands [ QSTOR-11751 ]
* Fixed HA pool failover persisting a stale size=0 / isMounted=false when the pool's datasets were still mounting during fast-import; the last-known-good size and mount state are now preserved (and the corrected record wins via a bumped modified timestamp). [ QSTOR-11818 ]
* Fixed: Storage Pool HA io-fencing and failover now work over NVMe-TCP; target namespaces advertise persistent reservations. [ QSTOR-11850 ]

Kernel and Drivers
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]
* Updated the Mellanox OFED driver installer for current Ubuntu 22.04 (Jammy) kernels, fixing driver installation failures on recent kernels. [ QSTOR-11709 ]

Multitenancy
* Added RBD namespace support, allowing multiple tenants to share a single Ceph block pool with isolated volumes. [ QSTOR-11650 ]

NAS Gateway / Cloud Containers
* Add a fix for Samba access to Cloud Container shares. [ QSTOR-11763 ]
* Fixed: cloud containers are now accessible over SMB, not just NFS. [ QSTOR-11824 ]
* Updated the bundled AWS CLI to version 2.35.6. [ QSTOR-11827 ]

Network Interfaces
* Added DOCA OFED install script for jammy and upcoming noble platforms as an optional install for latest hardware. [ QSTOR-11069 ]
* Fixed the Network Interface Rename feature on systems upgraded from older releases where the 'ip' command resides in a different path. [ QSTOR-11614 ]
* Fixed: converting a local VIF to an HA VIF now preserves the original local interface if the conversion fails, so client connectivity isn't lost. [ QSTOR-11706 ]

Network Shares
* Add the ability to specify per user or group permissions on Network Shares during create or modify [ QSTOR-10662 ]
* Fixed: intermittent 'NFS server not responding' stalls under load by raising the nfsd listen backlog from 64 to 4096. [ QSTOR-10872 ]
* Fixed: NFS client entries can now be added or removed on a share while a long-running replication or snapshot task is using it, instead of queuing. [ QSTOR-11571 ]
* Consolidated the Network Share create/modify dialog's Permission Settings into the File Masks tab — now a single 'File Masks & Permission Settings' tab containing Owner Permission Settings plus the Directory and File Create Permissions Masks. [ QSTOR-11625 ]
* Reduced excessive event logging (event spam) for network shares and related grid objects. [ QSTOR-11695 ]
* Fixed handling of CIFS share options so empty/null option values are no longer written to the Samba configuration. [ QSTOR-11731 ]
* Fixed an issue where an Active Directory group added to a share's permissions was not preserved, and excluded built-in/default AD groups from the group picker. [ QSTOR-11767 ]

Remote Replication, Snapshots and Backup Policies
* Copy source Network Share settings to the destination share after replication. [ QSTOR-5738 ]
* Add support for rollback of Storage Volumes and Network Shares for a replication schedule [ QSTOR-6227 ]
* Minor updates to the auto snapshot cleanup tasks for replication schedules. [ QSTOR-11622 ]
* Fix auto create of replication association after failover [ QSTOR-11700 ]
* Snapshot schedule now shows the state detail when schedule is disabled by user. [ QSTOR-11717 ]
* The Snapshot Schedule properties page now displays Retention Tags. [ QSTOR-11719 ]
* Changed: Auto-tier backup policies now display as 'Auto-Tier >> Outbound' instead of 'Move >> Outbound'. [ QSTOR-11764 ]
* Fixed the CLI replication-schedule rollback so volume and share names are accepted (not just IDs), and rolling back only volumes (or only shares) no longer also rolls back the other type. [ QSTOR-11814 ]

SCSI / NVMe Target
* Added: a 'Select Initiator...' picker in the Add Host dialog to choose a discovered FC remote initiator WWPN instead of typing it. [ QSTOR-10741 ]
* Renamed the sys-list 'Firmware Version' column to 'SCSI Target Version' and corrected the value to show the actual SCST target-driver version (e.g. scst-3.10.0.qs01-...) instead of the literal 'scst-SCST'. [ QSTOR-11854 ]

Security
* Added support for Okta multi-factor authentication. [ QSTOR-9399 ]
* Added Multi-Admin Approval support, allowing deletion of pools, buckets, shares, and volumes to require approval from a configurable number of administrators. [ QSTOR-11344 ]
* Fixed certificate update failures when using a certificate template, and ensured dependent services (such as HAProxy and RGW) are restarted after a certificate replacement. [ QSTOR-11678 ]
* Fixed an issue in the Security Manager dialog where it was showing the "password policy change" warning confirmation when no fields were changed. [ QSTOR-11708 ]
* InfluxDB (port 8086) now requires authentication and binds to localhost by default; remote access is opt-in via the tf_influxdb_remote_access.enable touchfile (authentication still enforced). [ QSTOR-11759 ]
* Added the Ubuntu security apt repositories to the default package sources and removed unused bundled components flagged by scanning (Chronograf, the LXD/core20/snapd snaps, the docker-scan plugin), clearing CVE-2024-41110, CVE-2026-34177/-34178/-34179, CVE-2020-14343, CVE-2025-68121, and CVE-2024-45337. [ QSTOR-11760 ]
* Rebuilt the bundled QuantaStor Go tools (qs_iofence, qs_pool_export_helper, qs_diskinfo) and s5cmd with a current Go toolchain, clearing CVE-2025-68121, CVE-2024-45337, CVE-2024-24790, CVE-2023-24540, and CVE-2023-24538. [ QSTOR-11761 ]
* Hardened the internal QuantaStor script service (scriptsvc): removed a command-injection vector in request handling and now enforce the service's authorization check on every call. Addresses ZDI-CAN-30036 [ QSTOR-11799 ]
* Made a number of usability and reliability improvements to the multi-admin delete-approval workflow. [ QSTOR-11804 ]

Service Core
* Fix tag-set where custom key/value tags were not appearing for User objects. [ QSTOR-11528 ]
* Improved Ceph OSD daemon restart handling during upgrades and reduced database load on large-scale clusters. [ QSTOR-11675 ]
* Fixed an issue with QuantaStor management service memory usage when a grid node was offline. [ QSTOR-11693 ]
* Improved crash handling and diagnostic tracing for coordinated tasks, during operations such as adding a Ceph RADOS Gateway across multiple nodes. [ QSTOR-11702 ]
* Improved logging and error checking for QuantaStor configuration database backups, including capturing error output when a backup fails. [ QSTOR-11742 ]
* Expanded diagnostic log collection to capture additional network routing details (ip route output and static-route configuration). [ QSTOR-11748 ]
* Fixed the Sessions view showing stale SMB/NFS client sessions that lingered after a reboot; the share session monitor now forces a full re-sync on its first poll after startup so sessions left over from before the reboot are cleared. [ QSTOR-11757 ]
* Fixed a self-sustaining grid event flood triggered when creating CephFS/CIFS network shares at scale: nodes no longer re-cache remote-origin (sync-applied) events, and CIFS options are diff-merged to secondaries, eliminating the event resync cascade. [ QSTOR-11785 ]
* qs-sendlogs now writes a qs_logs.runtime.info file recording the options and variables used during log collection, and reliably scrubs sensitive data from the collected database. [ QSTOR-11897 ]

Storage Pool Management
* Added automated ordered-disk-list pool creation for Seagate Corvault and WD Data24 systems, simplifying creation of fully redundant storage pools. [ QSTOR-11538 ]
* Fixed software-encrypted pool creation so a disk block-size mismatch is detected before disks are encrypted, avoiding leftover encryption mappings. [ QSTOR-11599 ]
* ZFS deduplication now uses the faster fast_dedup mode by default, improving sustained deduplication performance. [ QSTOR-11714 ]
* When a LUKS-encrypted disk member of a pool momentarily goes offline and the hot-spare swap-in completes, if the "bad" disk in question has in the meantime come back online, its iofence status, encryption status and its related properties in its respective disk object are cleared up, making the disk available for use again. [ QSTOR-11738 ]
* Resolved a boot-time race where the OS-level zfs-import-cache.service could import ZFS pools before qs_service started. QuantaStor now imports pools with cachefile=none, masks the zfs-import-cache and zfs-import-scan services on install and upgrade, and clears the stale global ZFS cache file at boot, ensuring QuantaStor remains the sole coordinator of pool imports. [ QSTOR-11752 ]
* Add the ability to create a Storage Pool checkpoint for scale-up pools [ QSTOR-11784 ]
* Added a support-only, touchfile-gated pool-export triage call-out (qs_pool_export_triage.sh) that gathers diagnostics when a share or volume is still open during a storage pool export. Off by default (enabled via the tf_pool_export_triage.enable touchfile). [ QSTOR-11807 ]
* Resolved issue preventing HA failover functionality using SED drives. [ QSTOR-11832 ]

Upgrade Manager and Installer
* Added retry logic with a timeout to the Ceph upgrade script's daemon restarts so transient restart failures no longer abort the upgrade. [ QSTOR-10598 ]
* Fixed focal-to-jammy distribution upgrades leaving the HA cluster service (pcsd/pacemaker) inoperative due to a missing ruby-webrick dependency on Ruby 3.0+. The upgrade now installs ruby-webrick so HA failover keeps working. [ QSTOR-11841 ]
* Fixed focal-to-jammy distribution upgrades that could abort and roll back when Ubuntu's unattended-upgrades/apt-daily held the apt lock or needrestart blocked on a prompt. QuantaStor now disables automatic apt upgrades and runs the distribution upgrade non-interactively. [ QSTOR-11874 ]
* Fixed a Noble (24.04) upgrade failure where qs-upgrade aborted because the dpkg package version string could not be parsed. QuantaStor now compares Debian package versions using dpkg's native version ordering. [ QSTOR-11881 ]

Web Manager
* Minor fix to the "Copy to Clipboard" for task descriptions [ QSTOR-9574 ]
* Added a method field and a sortable timestamp column to the web interface Audit Log Analyzer. [ QSTOR-11191 ]
* Updated web interface translations across the major supported languages. [ QSTOR-11585 ]
* Added a 'Create Share' option to the share template menu to quickly create a share applying all of a template's settings. [ QSTOR-11595 ]
* Fixed the web interface to display all configured Ceph MDS daemons instead of limiting the list to five. [ QSTOR-11615 ]
* Add auto select convenience buttons to the Storage Volume multi-delete dialog. [ QSTOR-11707 ]

== v6.7.6.001 (June 25th 2026) ==

=== [[QuantaStor 6.7.6 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.6 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.6 Upgrade Instructions | upgrading to QuantaStor v6.7.6]].

=== Release Notes ===

Storage Pool Management
* Fixed a service crash that could occur when creating a LUKS-encrypted storage pool on NVMe devices. [ QSTOR-11876 ]

== v6.7.5.013 (May 21st 2026) ==

=== [[QuantaStor 6.7.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.5 Upgrade Instructions | upgrading to QuantaStor v6.7.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert triggers for disks with SMART medium errors. [ QSTOR-11652 ]

Ceph Scale-out Block, Object and File
* Adds new qs-cephfsutil for transparent movement of files between data pools via server-side copy [ QSTOR-11543 ]

Kernel and Drivers
* Added RedHat Platform kernel 4.18.0-553.124.1.el8_10.x86_64 support via DKMS driver build [ QSTOR-11679 ]
* Updated SCST driver to 3.10.0.qs01.9273.1b48521 with a patch that allows for dkms builds/support on non-preferred 5.15.x kernels on jammy platforms. [ QSTOR-11672 ]

Remote Replication, Snapshots and Backup Policies
* Minor fix while loading snapshots in the UI. [ QSTOR-11624 ]

Service Core
* Fixes bug where partial upgraded node would be skip daemon restart phase at version check. [ QSTOR-11703 ]
* Fixed a rare race condition where adding a Ceph Object (RADOS) Gateway on a multi-node cluster could silently crash. [ QSTOR-11689 ]
* Added defensive exception handling and trace coverage around coordinated task execution. [ QSTOR-11689 ]

Storage Pool Management
* Fix allows for creation of TRIM maintenance schedules on pools with special vdevs. [ QSTOR-11663 ]

Web Manager
* Add graphs for replication task status details. [ QSTOR-11661 ]
* Make improvements in the replication reporting area. [ QSTOR-11661 ]

== v6.7.4.011 (April 30th 2026) ==

=== [[QuantaStor 6.7.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.4 Upgrade Instructions | upgrading to QuantaStor v6.7.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Eliminated daily Ceph monitor outage on coordinator nodes caused by the mon-db backup process; the backup now uses a RocksDB compaction flush and hot-copy so the monitor service remains running throughout, and backup activity is now logged to qs_service.log. [ QSTOR-11655 ]

Enclosures and Controllers
* Fixed issue regarding hwController/hwEnclosure double discovery caused by the presence of certain Dell HBA cards that are visible to both the storcli and perccli CLI tools. [ QSTOR-11372 ]

Network Interfaces
* Fixed an issue with the allowed portals for iscsi and nvme being updated on network ports or having the settings retained on HA VIFs. [ QSTOR-11659 ]

Remote Replication, Snapshots and Backup Policies
* Improvements in the replication reports. [ QSTOR-11644 ]

Service Core
* Updated task output for storage system modify to improve clarity [ QSTOR-11660 ]
* Coordinated Task (CCT) Reliability Improvements — Fixed an issue on large or heavily-loaded Ceph clusters where CCT broadcasts could silently hang until timeout. [ QSTOR-11648 ]

Upgrade Manager and Installer
* Updated kmod and libkmod2 packages for ubuntu jammy and focal platforms to disable algif_aead and address CVE-2026-31431 [ QSTOR-11670 ]

== v6.7.3.010 (April 17th 2026) ==

=== [[QuantaStor 6.7.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.3 Upgrade Instructions | upgrading to QuantaStor v6.7.3]].

=== Release Notes ===

High Availability Failover
* Fixed an issue where Site Clusters could not be deleted in cases where the site cluster was unhealthy. For example if the Network Interfaces or IP addresses on the interface change for the heartbeat rings. Or if the site cluster corosync/pacemaker service are stopped. [ QSTOR-11631 ]
* Fixed a corner case where Site cluster vifs could start on nodes outside of the site cluster. [ QSTOR-11630 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Volume _chkpnt Replications on N-Way A>B>C replications being incorrectly named. they B>C leg should have _chkpnt.1 as the target suffix for the replication. [ QSTOR-11477 ]

Service Core
* Added further optimizations for Grid sync on large configs with many QuantaStor service objects. [ QSTOR-11628 ]

Storage Pool Management
* Fixed: SED disk Locked status is now propogated using grid logic for disks once a disk is used for Hardware encryption. Previously this required an HA group to also be on the pool. [ QSTOR-11611 ]
Fixed a corner case where SED Device Capabilities was showing as No for multipath disks plugged in twice to the same controller. [ QSTOR-11611 ]

== v6.7.2.003 (April 13th 2026) ==

=== [[QuantaStor 6.7.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.2 Upgrade Instructions | upgrading to QuantaStor v6.7.2]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue where some Enclosure objects would appear showing \[CBLERR\] when that status was incorrect. [ QSTOR-11135 ]

Network Shares
* Added a qs_global_namespace.conf file for users to provide a specific IP address to be offered for Microsoft DFS with the preferred_ip=x.x.x.x [ QSTOR-11627 ]
* Updated Jammy platform nfs-kernel-server and related nfs-utils packages to include junction support needed for NFS Referrals. [ QSTOR-11626 ]

== v6.7.1.008 (April 10th 2026) ==

=== [[QuantaStor 6.7.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.1 Upgrade Instructions | upgrading to QuantaStor v6.7.1]].

=== Release Notes ===

Network Shares
* Fix an issue with snapshot cleanup by the replication schedule. [ QSTOR-11621 ]

Security
* Upgrade the Cisco Duo library to 2.2.0 [ QSTOR-11592 ]

Upgrade Manager and Installer
* Disable and mask openzfs util zfs-shares.service which caused unexpected Share service restarts. [ QSTOR-11619 ]
* Fixed an issue with qs-distupgrade from Focal to Jammy Platforms of systems that had been originally deployed with bionic and older platforms. [ QSTOR-11616 ]
* Ensured the 6.8.0-90-generic kernel is deployed during Focal to Jammy Platform distupgrades. [ QSTOR-11616 ]

== v6.7.0.184 (April 8th 2026) ==

=== [[QuantaStor 6.7.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.0 Upgrade Instructions | upgrading to QuantaStor v6.7.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Add a 'Skip log server ping pre-checks' checkbox to the Send Support Logs dialog. The server will skip ping checks during log upload when the checkbox is checked. [ QSTOR-11397 ]
* Fixed an issue with clearing parent interface status alerts in the Health Checker System report [ QSTOR-11058 ]
* Add ability to specify reason for log uploads [ QSTOR-10479 ]

Ceph Scale-out Block, Object and File
* Fixed a QuantaStor service crash for Ceph scale-out file storage share snapshot delete [ QSTOR-11570 ]
* Adds support for new load balancer modes and customization in the /opt/osnexus/quantastor/conf/qs_loadbalancer.conf file. [ QSTOR-11502 ]
* Improved the method of tracking degraded object cleanup and reporting progress to the task objects. [ QSTOR-11292 ]
* Bug fixes in qs-s3util script when an invalid endpoint URL is provided. [ QSTOR-11292 ]
* Improved object state reporting for OSDs. [ QSTOR-11292 ]
* Fixed an issue with unlocking NVMe SED media on boot for Ceph Scale-out Cluster OSDs [ QSTOR-11118 ]
* Enabled Ceph OSD block and journal discard support [ QSTOR-10672 ]

Dashboards and Analytics
* Fixed an issue with influxdb install for qs\_upgrade\_redhat8.sh [ QSTOR-11562 ]

Disk Management
* Added logic to make SED Locking status consistent between QuantaStor Scale-Up ZFS HA Storage Pools. Note: Pools must have an HA group and HA Vif and be activated. [ QSTOR-11515 ]
* Added error counters for disks with available columns in the center grid view of the Physical Disks section. [ QSTOR-11308 ]

Enclosures and Controllers
* Added Enclosure layout support for Supermicro SSG-542B-DE1CR90 [ QSTOR-11572 ]
* This feature allows servers equipped with the Xinnor XiRAID software [ QSTOR-11374 ]

* Create a XiRAID raid unit, which appears as a QS HwUnit. [ QSTOR-11374 ]
* This HwUnit entity is surfaced in Quantastor as a physical disk drive. [ QSTOR-11374 ]
* The physical disks that are used to create the XiRaid unit are surfaced as HwDisks.[ QSTOR-11374 ]
* The creation includes a variable number of partitions on said physical disk.[ QSTOR-11374 ]
* These partitions are also surfaced as QS physical disks.[ QSTOR-11374 ]
* These partition-based physical disks can be used to create Ceph OSD objects. [ QSTOR-11374 ]
* Updated Storcli64 version to 007.3603.0000.0000 [ QSTOR-10911 ]

High Availability Failover
* Fixed an issue with FC ALUA path status when HA groups are disabled and HA VIFs are not present. [ QSTOR-11598 ]

Kernel and Drivers
* Updated kernel 6.8.0-90-generic drivers include intel ixgbe driver version 6.3.4 [ QSTOR-11524 ]
* Updated Jammy Platform installer ISO image to 22.04.5 [ QSTOR-11380 ]
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]

Multitenancy
* Changed Object User Create dialog text to more accurately reflect that it refers to Object Users/Tenants, and not Multitenancy objects [ QSTOR-9803 ]

Network Interfaces
* Fixed an issue where MTU values were being written to the VLAN interface configuration files. [ QSTOR-11552 ]

Network Shares
* Added further checks to Network Share Delete to verify the underlying ZFS filesystem properties has a matching OSNEXUS QuantaStor share ID before removing. [ QSTOR-11525 ]
* Auto populate the AD dialog with Organization Unit of specified on other systems in the grid [ QSTOR-11519 ]
* Add more options to filter shares in the delete dialog [ QSTOR-11499 ]

Remote Replication, Snapshots and Backup Policies
* Adds a new '--snapshots-with-holds-only' option to qs share-list and volume-list to list snapshots with holds on them. [ QSTOR-11388 ]

SNMP
* Update SNMP MIB [ QSTOR-11602 ]

Security
* When updating a certificate via cert-update, the relevant service (e.g. HAProxy) is now
automatically restarted to pick up the new certificate. Additionally, cert-update and
cert-rescan now accept the storage system by name or UUID. [ QSTOR-11529 ]
* Updated WebUI to have System Use Notification dialog/message display before user login dialog. [ QSTOR-11174 ]

Service Core
* Strip any invalid XML characters from description fields causing WebUI to not load [ QSTOR-11566 ]
* Cleaned up some repetitive log spam from the Blink Manager and the storcli hardware adappter [ QSTOR-11551 ]
* Fixed event spam and potential crash during Ceph daemon upgrade on large grids. [ QSTOR-11510 ]
* Fixes bug in site cluster maintenance mode logic. [ QSTOR-11489 ]
* Fixed an issue where the iSCSI/NVMe flag settings were not being retained for site cluster vifs after moving the vif to a new node. [ QSTOR-11464 ]
* Added support for LACP layer2+3 xmit\_hash\_policy [ QSTOR-11400 ]

Storage Pool Management
* Add more storage system tuning parameters [ QSTOR-11549 ]
* Added discard to LUKS options for NVMe model disks on ZFS Scale-Up Storage Pools with encryption. [ QSTOR-11501 ]

Upgrade Manager and Installer
* Fixed a throw in the qstorservice package install if the radosgw-admin command is not available [ QSTOR-11579 ]
* Fixed the qs-upgrade for kernel upgrades to ensure recommended packages for qstortarget are installed if they were previously manually removed. [ QSTOR-11556 ]

Web Manager
* When selecting Create Share from an existing selected share in the tree view, ensure the correct Storage Pool is selected in the Create Share dialog. [ QSTOR-11591 ]
* Create a new share template system for users to reuse settings from existing network shares. [ QSTOR-11314 ]

== v6.6.11.017 (March 5th 2026) ==

=== [[QuantaStor 6.6.11 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.11 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.11 Upgrade Instructions | upgrading to QuantaStor v6.6.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added a check to alert on SSL certificate expiration for the certificate manager managed certs. [ QSTOR-11462 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with rekeying scale-out ceph OSD's on Seagate Corvault backend external storage systems [ QSTOR-11206 ]

Disk Management
* Fixed an issue with SED media when adding as a hot-spare / for repair of a failed storage pool disk. [ QSTOR-11531 ]
* Fixed an issue where SSD Life Left status showing on multipath devices. [ QSTOR-11463 ]

Enclosures and Controllers
* Added Enclosure support from multiple Manufacturers such as Seagate, Gigabyte, Supermicro etc. [ QSTOR-11498 ]
* Fixed items related to the Intel 2u12 enclosure layout [ QSTOR-11286 ]
* Fixed Items related to the Supermicro 90-bay enclosure layout [ QSTOR-10932 ]

Network Shares
* Fix to allow creation of Network Shares with record size greater than 1M (1M, 2M, 4M, 8M). [ QSTOR-11535 ]

Security
* Fixed a few items related to Grafana default security ports [ QSTOR-11526 ]
* Fix configuration file manager file paths for telegraf.qstor and influxdb.qstor. [ QSTOR-11526 ]
* Fixed some items related to software encrypted HA storage pools management of /etc/crypttab [ QSTOR-11416 ]

Service Core
* Fixed some items related to QuantaStor Management Service database transactions [ QSTOR-11527 ]

== v6.6.10.006 (February 23rd 2026) ==

=== [[QuantaStor 6.6.10 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.10 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.10 Upgrade Instructions | upgrading to QuantaStor v6.6.10]].

=== Release Notes ===

Network Shares
* Fixed a service crash with Network share global Namespaces [ QSTOR-11518 ]
* Fixed an issue with AD join. [ QSTOR-11514 ]
* Fixed an issue with Seagate Corvault vpd83 parsing [ QSTOR-11518 ]

== v6.6.9.002 (February 13th 2026) ==

=== [[QuantaStor 6.6.9 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.9 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.9 Upgrade Instructions | upgrading to QuantaStor v6.6.9]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash when upgrading QuantaStor on Systems configured with Scale-Out storage. [ QSTOR-11509 ]

== v6.6.8.004 (February 11th 2026) ==

=== [[QuantaStor 6.6.8 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.8 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.8 Upgrade Instructions | upgrading to QuantaStor v6.6.8]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash for Network Interface discover logic [ QSTOR-11507 ]
* Fixed a service crash in Scale-out bucket discovery logic. [ QSTOR-11505 ]

== v6.6.7.017 (February 9th 2026) ==

=== [[QuantaStor 6.6.7 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.7 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.7 Upgrade Instructions | upgrading to QuantaStor v6.6.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Optimized grid communication paths and reduced database read frequency by improving internal object caching mechanisms. [ QSTOR-11473 ]
* Show compression ratio in the Scale-out Storage Pool grid. It is hidden by default. [ QSTOR-11130 ]

Disk Management
* Fixed an issue where a NVMe quick secure erase would be executed when formatting disks used for new storage pool creation [ QSTOR-11478 ]
* Fixed an issue where quick secure erase reformated the NVMe disk with a new namespace using a 512K sector size. [ QSTOR-11478 ]

Enclosures and Controllers
* Recertify Quantastor with the gen4 series of Western Digital Data24 [ QSTOR-11479 ]
* Fix up the config file defaults for NVMe software adapter when logging into a NVMe WD Data24. [ QSTOR-11470 ]

Network Shares
* Fix an issue with password shown in the service log during AD join [ QSTOR-11483 ]
* Add the ability to select multiple shares using the ctrl key in the share multi-delete dialog [ QSTOR-9181 ]

Web Manager
* Fixed a minor issue with file masks in modify Network Share [ QSTOR-11495 ]

== v6.6.5.026 (January 16th 2026) ==

=== [[QuantaStor 6.6.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.5 Upgrade Instructions | upgrading to QuantaStor v6.6.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Adds alerts in the event a Corvault device is in a warning or missing state. [ QSTOR-11411 ]

Ceph Scale-out Block, Object and File
* Fix an issue with creation of S3 user on a secondary zone. User will be created on the master zone. [ QSTOR-11438 ]
* Fixed an Issue with the Ceph initial PG calculations when creating ceph storage pools on HDD and SSD based OSDs. [ QSTOR-11437 ]
* Fix a minor issue with bucket sync when bucket originates on a secondary zone [ QSTOR-11435 ]
* Add granular options for object bucket rescan. [ QSTOR-11312 ]

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11436 ]
* Fix a row selection issue in the central pane on the External Media and Port grids. Show the 'Used By' column for External Volumes. [ QSTOR-11384 ]

High Availability Failover
* Fixed an issue with the Storage Pool Health check on systems with high load. [ QSTOR-11454 ]
* Fixed an issue with HA storage Pools in a degraded warnign state. [ QSTOR-11451 ]
* Reduced scale-out Object logging for site cluster vifs to debug level. [ QSTOR-11448 ]

Network Shares
* Fixed an issue with joining AD domains using SSSD+Winbind [ QSTOR-7845 ]

SNMP
* Updated SNMP MIB [ QSTOR-11456 ]

Security
* Enabled HTTPS redirect mode in QuantaStor WebUI by default during new Installs and upgrades to version 6.6.5 and newer. [ QSTOR-11368 ]
* Added a custom script callout via a security-message-update for the Security manager System Usage Notification contents: [ QSTOR-11222 ]
[https://wiki.osnexus.com/index.php?title=QuantaStor\_Custom\_Scripting\_/\_Application\_Extensions\#/var/opt/osnexus/custom/security-message-update.sh](https://wiki.osnexus.com/index.php?title=QuantaStor_Custom_Scripting_/_Application_Extensions#/var/opt/osnexus/custom/security-message-update.sh)

Service Core
* Added minimum timeout value to Coordinated tasks [ QSTOR-11455 ]
* Optimized Grid logic for Scale-out Object Bucket discovery on deployments with a large amount of ceph buckets. [ QSTOR-11433 ]
* Fixed an issue with License Key activation verification [ QSTOR-11110 ]

== v6.6.4.001 (December 17th 2025) ==

=== [[QuantaStor 6.6.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.4 Upgrade Instructions | upgrading to QuantaStor v6.6.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fix an issue where the S3 Object User Create fails when the User is not a Tenant member. [ QSTOR-11432 ]

== v6.6.3.033 (December 16th 2025) ==

=== [[QuantaStor 6.6.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.3 Upgrade Instructions | upgrading to QuantaStor v6.6.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Raise alerts when OSDs are down. [ QSTOR-11415 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with object user create under a tenant with multi-site is enabled for two zones. [ QSTOR-11427 ]
* Fix an issue with bucket sync policy create on the secondary zone bucket. [ QSTOR-11426 ]
* Allow selection of any object gateway when setting up ceph multi-site configuration. [ QSTOR-11409 ]

Enclosures and Controllers
* Adds enclosure management support for Supermicro Server SSG-522B-ACR12L [ QSTOR-11422 ]
* Change external volumes, media and volume grids from grouping to non-grouping for a minor performance improvement. Re-order Corvault columns in central grid (External Systems). Only show volumes for the currently selected Corvault. [ QSTOR-11370 ]

High Availability Failover
* Added a check to the site cluster to ensure that a user cannot set the final active node in a site cluster into standby. This is to prevent all nodes in a site cluster or HA pair from both being in standby and not serving any resources. [ QSTOR-11402 ]

Network Interfaces
* Fixed an issue where modifying the iscsi/nvme portal port settings on a VLAN or VIF interface would cause the parent interface to be restarted [ QSTOR-11406 ]
* Fixed an issue with importing LACP options in the /etc/network/interfaces file. [ QSTOR-11396 ]
* Updated the LACP bond-xmit-hash-policy options to use the modern text option names instead of the legacy numerical values. [ QSTOR-11396 ]

Network Shares
* Added 'qs-util nfsrdma' command to enable nfs rdma support for systems that have NFS RDMA supported hardware and drivers. [ QSTOR-11309 ]
* Auto detect when the AD server goes down and raise an alert. [ QSTOR-11182 ]
* Fixed issues with SSSD AD Join [ QSTOR-11335 ]

SNMP
* Updated SNMP MIB [ QSTOR-11428 ]
* Fixed a few items related to the SNMP agent stability. [ QSTOR-11405 ]
* Added logic to ensure new nodes joined to the grid get the snmp agent deployed on them with the same settings and snmp user. [ QSTOR-11393 ]

Security
* Removed default nginx index.html and version reporting from nginx. [ QSTOR-11351 ]

Service Core
* Extended timeout values for coordinated task finishing stage throughout the service. This will help prevent grid communication errors that are caused in high latency environments. [ QSTOR-11421 ]
* Enhanced grid logic for High Latency multi-site deployments. [ QSTOR-11391 ]

Upgrade Manager and Installer
* Added protections to ensure zfs pools are not imported incorrectly on a passive HA node during upgrade processes that update the grub configuration. [ QSTOR-11413 ]

Web Manager
* Add a tooltip to the Force checkbox on the Storage System Restart and Shutdown dialogs to clarify it's for immediate, unclean shutdowns. [ QSTOR-11381 ]

== v6.6.2.003 (November 14th 2025) ==

=== [[QuantaStor 6.6.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.2 Upgrade Instructions | upgrading to QuantaStor v6.6.2]].

=== Release Notes ===

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11367 ]

Security
* Updated QuantaStor Tomcat version to 9.0.112 [ QSTOR-11376 ]
* Fix a regression in single sign on failing to login AD users. [ QSTOR-11375 ]
* Enhanced Grid communication event batching that can help with large numbers of QuantaStor Grid object counts. [ QSTOR-11366 ]

== v6.6.1.013 (November 7th 2025) ==

=== [[QuantaStor 6.6.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.1 Upgrade Instructions | upgrading to QuantaStor v6.6.1]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Removed rgw gc optimizations that are no longer needed for modern ceph versions. [ QSTOR-10920 ]

Enclosures and Controllers
* Added some new warning icons for hardware controllers, hardware units and hardware disks. Fixed icon priority for status on hardware enclosures. [ QSTOR-11358 ]
* Fixed an issue with discovery of Hardware RAID Disks for LSI Hardware RAID controllers that use the storcli tool. [ QSTOR-11347 ]
* Fixed an issue with enclosure discovery for older LSI SAS HBA controllers that utilize sas3ircu [ QSTOR-11209 ]

High Availability Failover
* Fixed an issue with HA failover for storage pools that have multipath disks with -part1- in the device name. [ QSTOR-11373 ]

Security
* Fixed a possible SQL Injection during Login. [ QSTOR-11365 ]

Service Core
* Changes haproxy logrotate to be hourly by default. [ QSTOR-11349 ]
* Updated the QS PyClient Code in the github repo. [ QSTOR-11346 ]

== v6.6.0.362 (October 9th 2025) ==

=== [[QuantaStor 6.6.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.6.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.6.0 Upgrade Instructions| upgrading to QuantaStor v6.6.0]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Block rename of object pool group. [ QSTOR-11336 ]
* Add a fix so auto-tier rules can be set on multiple ceph clusters [ QSTOR-11323 ]
* Fixes bug with OSD replace prepare context menu button when called from the enclosure view. [ QSTOR-11313 ]
* Fixed: added duplicate zone check for Object Group Create [ QSTOR-11266 ]
* Add indication on the journal group if it is encrypted. [ QSTOR-11261 ]
* Updated Ceph version on Focal and Jammy platforms to 18.2.7 [ QSTOR-11129 ]
* Generate proper caps for keyring when using additional pools in CephFS [ QSTOR-11106 ]
* Display S3 user information in the delete user dialog to distinguish between S3 user and local user. [ QSTOR-10723 ]
* New feature adds the ability to modify RGW settings. Added the ability to add and remove load balancers on each Ceph cluster member. [ QSTOR-10623 ]
* Added support for Portal Groups for FC and iSCSI Targets [ QSTOR-10533 ]
* Add the ability to control synchronization for selected buckets in two objects storage clusters. [ QSTOR-10346 ]
* Add ability to specify multiple pools in a ceph file system. [ QSTOR-8674 ]

Dashboards and Analytics
* Add a new bucket dashboard that reports Average Total Objects and Average Utilized Space. [ QSTOR-11259 ]

Disk Management
* Adds an NVMe quick format to the Physical Disk Format dialog using the secure erase options. [ QSTOR-10688 ]

Enclosures and Controllers
* Fixed various items related to Linux Software RAID adapter support. [ QSTOR-11198 ]

Multitenancy
* Scope the access of user accounts so that they can only manage users, buckets, keys and other resources related to the tenant in the resource group they're a member of [ QSTOR-11326 ]
* Allow CephFS shares to be added to a Resource Group. [ QSTOR-11007 ]

Network Shares
* Share rename needs a force flag as it may disconnect NFS clients. [ QSTOR-11337 ]
* Provides an optional backported version of samba via a 'qs_samba_jammy_optional.sh' install script that includes a version of samba required to address the ad rfc2307 changes Microsoft introduced in KB5062572. Note this samba version does not include sssd support and so will not be installed by default. It should only be used for those customers using ad rfc2307 mode. [ QSTOR-11319 ]

Security
* Adds the ability to add and remove SSL certificate templates. Using those templates you can update the certificates for HaProxy and Rados gateways configured for HTTPS. [ QSTOR-9016 ]

Service Core
* Eliminates common errors in active directory join process, prepopulating dialog from previously joined systems [ QSTOR-11015 ]
* Added support for shutting down or restarting multiple systems at once [ QSTOR-10022 ]
* Added an optional force flag to Storage System Restart and Shutdown Dialogs to provide an option for immediate sysrq based shutdown of the system [ QSTOR-10022 ]

SNMP
* Updated SNMP MIB [ QSTOR-11343 ]

Storage Volumes
* Allow rename of Scale Out block storage volumes [ QSTOR-11311 ]
* Fix an event issue where the Volumes count was not getting updated in the central Host grid view. [ QSTOR-11038 ]

Universal Containers
* Add Universal Container support to the server and the Create Config dialog in the WUI. [ QSTOR-11194 ]

Upgrade Manager and Installer
* verified that packages are being installed properly with the new iso filtering stuff [ QSTOR-11030 ]

Web Manager
* Minor fix to the modify Network Port dialog. [ QSTOR-11302 ]
* Added the ability to save a local copy of a report schedule. [ QSTOR-11217 ]
* Simplifies active directory join and leave process, allowing multiple systems to join or leave at once [ QSTOR-8771 ]

== v6.5.12.005 (September 22nd 2025) ==

=== [[QuantaStor 6.5.12 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.12 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.12 Upgrade Instructions| upgrading to QuantaStor v6.5.12]].

=== Release Notes ===

Enclosures and Controllers
* Fixed vendor/model defaulting, improved enclosure layout auto-selection in the Modify Storage System dialog (including correct child-layout selection to choose the primary NVMe drive group), and resolved an invalid enclosureLayoutId that prevented layout auto-detection. [ QSTOR-11263 ]

Security
* Fixed: disable gzip compresson on web and api ports by default. [ QSTOR-11210 ]
* Fixed: internal qs-statsd/qs_restd service port 5173 moved to localhost only as it should not be presented as an external port. [ QSTOR-11210 ]
* Fixed: reduced syslog logging of qs-statsdb/qs_restd. [ QSTOR-11210 ]
* Added: DROP rules to block ICMP timechecks [ QSTOR-11210 ]
* Updated SSL Ciphers and TLS1.3 support for the web and API ports [ QSTOR-11210 ]
* Fixed: Set pcsd api port 2224 to bind to localhost only by default [ QSTOR-11210 ]

== v6.5.11.029 (August 28th 2025) ==

=== [[QuantaStor 6.5.11 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.11 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.11 Upgrade Instructions| upgrading to QuantaStor v6.5.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added support for SMTP servers that allow open relay with no username/password to the Alert Manager [ QSTOR-11167 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with multiple alerts occurring for long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Fixed some corner case issues with long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Added support for larger MDB devices upto 2100GB [ QSTOR-11274 ]
* Added support for encryption bypass on OSD create while still encrypting wal/db journal devices. [ QSTOR-11260 ]

Disk Management
* Fixed an issue with running the disk read performance test benchmark on very fast modern media. [ QSTOR-11296 ]

Enclosures and Controllers
* Fixed Enclosure and Controller discovery support for SAS3516 based SAS controllers [ QSTOR-11267 ]

High Availability Failover
* Fix an issue with VIF used for scale-out file usage after rebooting all nodes in the cluster. [ QSTOR-11265 ]

Network Interfaces
* Fixed: added gfortran-11 dependency to jammy repository required for LTS mellanox ofed install to succeed [ QSTOR-11285 ]
* Add QS cli command to hide disabled Network Ports [ QSTOR-10898 ]
* Fixed an issue where VLAN and VIF interfaces would not report their bond mode correctly if their parent interfaces was a bonded port. [ QSTOR-10754 ]

Network Shares
* Adds support for multiple HA VIF redirects and smart network filtering for NFSv4 referrals [ QSTOR-11278 ]
* Minor fix to skip NFS export commands for scale out shares. [ QSTOR-11275 ]

Quantastor CLI
* Provide a utility to create temporary log download links via qs-download-link [ QSTOR-11273 ]

SCSI / NVMe Target
* Fixed: Added logic to always default FC ports to target mode for supported FC target card models from QLogic. Ports can still be explicitly set to initiator mode if the user so chooses. [ QSTOR-10744 ]

Service Core
* Fixed: added the option to cancel the Physical Disk Identify task if the duration for the identify task is longer than the user wants. [ QSTOR-11258 ]
* Provide a download link for log collection in case logs cannot be uploaded from a Quantastor system [ QSTOR-11116 ]

Upgrade Manager and Installer
* Fixed: added proxy settings to the /etc/apt/apt.conf.d/80proxy file [ QSTOR-11281 ]
* Fixed: added logic to the upgrade manager and qs-upgrade command to check for missing version pinning if qs-util aptnopin has been run on the system. The upgrade task will fail early if correct pinning is not in place advising running qs-util aptpin. [ QSTOR-11277 ]

Web Manager
* Fixed: clarified text in create resource group for network share access of service containers [ QSTOR-11187 ]

== v6.5.10.013 (August 12th 2025) ==

=== [[QuantaStor 6.5.10 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.10 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.10 Upgrade Instructions| upgrading to QuantaStor v6.5.10]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the access key and secret key were not updating in the UI in instances with multiple object storage users across multiple ceph clusters in the same grid. [ QSTOR-11254 ]
* Fixed an issue with the cephfs mounts if communication is lost with the active MDS and a new MDS is elected. [ QSTOR-10738 ]

Enclosures and Controllers
* Fix an enclosure refresh issue via the event path where the underlying disk were not getting refreshed. [ QSTOR-11247 ]
* Fixed: Added additional checks for enclosure id on enclosures that fail to report correctly on older firmwares. [ QSTOR-11227 ]

Service Core
* Fixed: replaced size with maxsize in the ceph, radosgw and haproxy logrotate definitions so that they rotate as expected on their daily rotations as well as when reaching the max size definition. [ QSTOR-11253 ]
* Fix an underlying dashboard issue where new diskio entries were not properly added to the telegraf.conf file on new deployments. [ QSTOR-11246 ]
* Fix: Optimize the restarting of influx and telegraf. [ QSTOR-11246 ]

== v6.5.9.003 (August 5th 2025) ==

=== [[QuantaStor 6.5.9 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.9 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.9 Upgrade Instructions| upgrading to QuantaStor v6.5.9]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with slotmap updates when changing the slotmap in the enclosure and controllers section. [ QSTOR-11245 ]

Service Core
* Fixed an issue where QuantaStor was restarting the influxdb service when it was not needed. [ QSTOR-11244 ]
* Fixed: separated the influxdb, telegrafd and QuantaStor stats_db service restart logic to allow more granular control. [ QSTOR-11244 ]

== v6.5.8.008 (July 31st 2025) ==

=== [[QuantaStor 6.5.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.8 Upgrade Instructions| upgrading to QuantaStor v6.5.8]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed a small issue with the ceph osd reweight script progress trace. [ QSTOR-11234 ]

Enclosures and Controllers
* Add support for Supermicro ASG-2115S-NE332R system enclosure layouts [ QSTOR-11237 ]

Network Shares
* Fixed: Disable security features options in Network Share Create/Modify dialogs when the share is from a Scale-out File Pool. [ QSTOR-11235 ]
* Fixed: Remove redundant "NFS Security Mode" on the share advanced tab. [ QSTOR-11235 ]
* Fixed an issue with clearing the manage gids setting on Jammy platforms [ QSTOR-11225 ]
* Fixed an issue with setting specific nfs v3 or v4 server configurations on Focal platforms [ QSTOR-11225 ]
* Fixed a conflict with the nfs mountd ports between scale-out and scale-up nfs modes. [ QSTOR-11212 ]
* Fixed detection of nfs scale-out mode when it is configured at the time of ceph scale-out filesystem creation. [ QSTOR-11212 ]

Upgrade Manager and Installer
* Added a check to disable the grub os prober by default to prevent adding of any block devices with OS data other than the installed QuantaStor OS disk to the grub boot loader. [ QSTOR-11199 ]

== v6.5.7.004 (July 24th 2025) ==

=== [[QuantaStor 6.5.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.7 Upgrade Instructions| upgrading to QuantaStor v6.5.7]].

=== Release Notes ===

Network Shares
* Fixed an issue with network share cifs/smb settings such as ignore system acls introduced in the 6.5.1 release. [ QSTOR-11224 ]
* Removed the API underscore to space conversion logic in cifs/smb settings introduced in 6.5.1. REST API's should use proper url encoding like %20 when sending strings that contain spaces via curl or other http calls. [ QSTOR-11224 ]

Storage Pool Management
* Fixed a path naming issue for the sedutil-cli binaries used for SED disk encryption. [ QSTOR-11221 ]
* Added Several small enhancements and fixes for the sedutil-cli tool usage and SED supported disk discovery [ QSTOR-11219 ]

== v6.5.6.052 (July 16th 2025) ==

=== [[QuantaStor 6.5.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.6 Upgrade Instructions| upgrading to QuantaStor v6.5.6]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fix minor issue with Corvault log collection. [ QSTOR-11201 ]
* Added alerts to notify the user as they approach quota limits for S3C buckets [ QSTOR-11055 ]
* Fixed an issue with the IPMI Ip addresses showing up in the Health Check reports. [ QSTOR-10356 ]

Ceph Scale-out Block, Object and File
* Fixed radosgw logging logrotation not always occurring on fresh installs. [ QSTOR-11176 ]
* Fixed: radosgw logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Fixed: haproxy logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Improved logic for Ceph OSD Gentle Reweight. [ QSTOR-11163 ]
* Fixed an issue with the version check when upgrading the the scale-out ceph MDS, RGW and other daemons. [ QSTOR-11138 ]
* Fixed a few corner cases with ensuring successful Ceph upgrades. [ QSTOR-11138 ]
* Allow compression support for Ceph RBD pools. [ QSTOR-11131 ]
* Added Object User quota usage information to the Object User grid [ QSTOR-10722 ]

Dashboards and Analytics
* Add Pool, volume and share space usage trending dashboards (Early Access). [ QSTOR-11076 ]
* Add Pool, volume and share space usage trending dashboard routes and toggle buttons. [ QSTOR-11076 ]
* Expand the trending time scale for Tenants and Owners to make use of longer retention policies (e.g. 'Last 30 Days'). [ QSTOR-11076 ]
* Fix InfluxDB trending continuous query settings in qs\_statsdb.sh. [ QSTOR-11076 ]

Disk Management
* Add Multipath and HA support for SED Disks. [ QSTOR-11172 ]
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11065 ]

Enclosures and Controllers
* Fixes intermittent boot time OSD start issue with Corvault media. [ QSTOR-11195 ]
* Adds encryption bypass mode to avoid applying double (hardware plus software) encryption to Corvault media. [ QSTOR-11195 ]
* Added enclosure layout for Supermicro SYS-221H-TN24R systems. [ QSTOR-11154 ]

High Availability Failover
* Fixed an issue with Storage pool import of a previously exported pool that has iofencing on nvme disks. [ QSTOR-11173 ]

Network Shares
* Add new cyphers for active directory join. [ QSTOR-11183 ]
* Added sync flag by default to NFS mount for ceph object storage ganesha shares [ QSTOR-11181 ]
* Adjust minor Network Share quota alert levels. [ QSTOR-11171 ]
* Add larger record size upto 8M for Network Shares on ZFS Storage Pools. [ QSTOR-10118 ]
* Added support for hidden shares that end in a '$' as 'Browseable (admin-only) shares in the CIFS/SMB Options tab of the Network Share Create/Modify Dialogs. [ QSTOR-9222 ]

Service Core
* Optimize database reads for large clusters. [ QSTOR-11178 ]
* Added qs-util dbdiff for use to compare osn.db database versions [ QSTOR-10566 ]
* Added https as the default preferred method for support log bundle upload. [ QSTOR-9875 ]

Universal Containers
* Added initial support for a universal container system [ QSTOR-11162 ]

Upgrade Manager and Installer
* Added logic to fix the /boot/efi based on a efi partition label for Software RAID and EFI installs [ QSTOR-11140 ]

Web Manager
* Revise the Object User Access Key Manager to include Storage URLs in the Copy to Clipboard action. [ QSTOR-11177 ]
* Improved fieldset placements for network share create/modify dialogs. [ QSTOR-11156 ]
* SED Pool management - Reorder SED columns in PD grid. Move to the right of the "Correlated Device" column. Revise the SED capability detection to check for non-enterprise. [ QSTOR-11146 ]

== v6.5.5.039 (May 29th 2025) ==

=== [[QuantaStor 6.5.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.5 Upgrade Instructions| upgrading to QuantaStor v6.5.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixes bug in osd gentle reweight script that was bottlenecking performance. [ QSTOR-11123 ]
* Added logic to auto-clean up volume objects for non-QuantaStor managed ceph rbd's (rbd's created directly by the client using client rbd drivers/software). [ QSTOR-11112 ]
* Add warnings for the user if OSD or journal delete is being used on a device with duplicate PVs due to multi-pathing mapping. [ QSTOR-11099 ]
* Added 'qs-ceph' utility commands to modify compression options on Ceph pools. [ QSTOR-11096 ]
* Added compression ratio column in storage pools grid. [ QSTOR-11087 ]

Enclosures and Controllers
* Added support for discovery of RMSP3JD160J controllers. [ QSTOR-11107 ]
* Add validation for both primary and secondary IPs during External System Credentials Add. [ QSTOR-11009 ]

High Availability Failover
* Fixed a very rare corner case where a Manual HA failover task could generate unexpected errors due to a background periodic storage pool scan. [ QSTOR-11111 ]
* Added the option to set a Site Cluster Member Node as Manual Standby. [ QSTOR-11105 ]
* Fixed an issue where nodes could come out of standby status on a reboot too early before grid communication was established. [ QSTOR-11105 ]
* Enhanced HA Failover times for Storage Volumes for Fibre Channel clients. [ QSTOR-11105 ]
* Enhanced Fiber Channel High availability ALUA Changes to occur more quickly and to more quickly advertise failed paths to clients like VMware so that they can resume I/O to healthy available paths sooner. [ QSTOR-11105 ]
* Enhanced the logic used for High Availability Storage SCSI Target decoupling during a Storage Pool export. This can help greatly reduce the failover time for very Large configurations with thousands of volumes or volume snapshots. [ QSTOR-10969 ]

Network Interfaces
* Fixes bug that was blocking users from creating a static route with the same destination subnet across different systems. [ QSTOR-11125 ]
* Fixed a bug in static route validation logic and allow users to delete malformed static route entries. [ QSTOR-11115 ]

Network Shares
* Allow rename of nested shares [ QSTOR-11046 ]
* Added logic to help persist and manage NFS options for NFS version and nfs --manage-gids flags [ QSTOR-11001 ]

REST API
* Add an API to clear missing shares or volumes from the QS database. [ QSTOR-11117 ]

Remote Replication, Snapshots and Backup Policies
* Clarify concurrency options for backup policies. [ QSTOR-11004 ]

Security
* Added explicit modprobe disable and blacklist of ksmbd module to address any CVE-2025-37899 concerns. [ QSTOR-11134 ]

Service Core
* Enhanced the Core QuantaStor service management thread scaling. [ QSTOR-10767 ]
* Fixed a small memory leak with debug log tracing [ QSTOR-10689 ]

Storage Pool Management
* Updated sedutil-cli that supports a wider range of encrypted devices. [ QSTOR-11088 ]
* Restores sedutil / Storage Pool encryption support for SED Ruby NVMe devices. [ QSTOR-11088 ]
* Removed restriction to satisfy the VDEV count of N+1 to create a RAIDZx(RAID50/60/etc) array on a ZFS scale-up Storage pool when passing in a Set Disk Size instead of using the 'auto' option. [ QSTOR-11086 ]

== v6.5.4.016 (April 29th 2025) ==

=== [[QuantaStor 6.5.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.4 Upgrade Instructions| upgrading to QuantaStor v6.5.4]].

=== Release Notes ===

Dashboards and Analytics
* Fix issue where the dashboard of a newly created volume was not showing performance data after it had been assigned because of a pending Telegraf restart required. [ QSTOR-11077 ]
* Show CPU Temp and Power Usage in the System Dashboard (new Sensors button). [ QSTOR-11029 ]

High Availability Failover
* Unblocked creating HA ViF if there is an HA irrelavant bond in active-backup mode and unblocked modifying an HA irrelavant bond. [ QSTOR-11073 ]
* Fixed an issue when modifying non-name fields of an HA group. [ QSTOR-11071 ]

Network Interfaces
* Fixed bugs in validation logic for static route create and delete. [ QSTOR-11056 ]

Network Shares
* Ensure 'Browseable' is checked on SMB network shares when Browseable (Access Based) is checked. This ensures that authenticated clients who have pre-assigned browseable access can see the share offered by the QuantaStor but prevents non-authenticated users from seeing the share. [ QSTOR-11078 ]

Remote Replication, Snapshots and Backup Policies
* Minor log file cleanup after backup job is finished. [ QSTOR-11044 ]
* Add the ability to rollback a read-write Storage Volume or Network Share snapshot to it's underlying snapshot. [ QSTOR-9820 ]

Storage Pool Management
* Fixed an issue with Storage Pool auto-start on reboot for software encrypted storage pools. [ QSTOR-11081 ]

== v6.5.3.021 (April 9th 2025) ==

=== [[QuantaStor 6.5.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.3 Upgrade Instructions| upgrading to QuantaStor v6.5.3]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* Improved timeout handling for QuantaStor coordinated task system. [ QSTOR-11022 ]

Disk Management
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11032 ]

Enclosures and Controllers
* Added Hardware Enclosure support for Dell PowerEdge R7615 [ QSTOR-11043 ]
* Added Hardware Enclosure support for Supermicro AS-1115CS-TNR [ QSTOR-11043 ]
* Optimized performance and fixed issues when rendering systems with attached CORVAULT external systems. [ QSTOR-11039 ]
* Optimize the rendering of enclosures. Fix drawer rendering issue where extra slots were appearing. [ QSTOR-11014 ]

Network Interfaces
* Fixed an issue with static route netmask CIDR calculations. [ QSTOR-11048 ]

Network Shares
* Update Network Share Namespace on all nodes to reflect any modification to NFS access entries to share that is part of a Namespace. [ QSTOR-11042 ]
* Online newly promoted Network Share Snapshots. [ QSTOR-11021 ]
* Add post share create and modify script callouts. [ QSTOR-11016 ]
* Fixed mount paths for enabled snapshots of Network Share when Share is renamed. [ QSTOR-11012 ]
* Add the ability to prioritize NFS access rules in /etc/exports file. [ QSTOR-10552 ]

SNMP
* Regen SNMP for 6.5.3 [ QSTOR-11054 ]

Security
* Added docker http proxy override [ QSTOR-11040 ]
* Updated Tomcat version to 9.0.102.0 [ QSTOR-11013 ]

Upgrade Manager and Installer
* Fixed various issues with the OVA vApp properties being set after VM image cloning. Added additional properties to the OVA by default. [ QSTOR-10508 ]

== v6.5.2.070 (March 27th 2025) ==

=== [[QuantaStor 6.5.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.2 Upgrade Instructions| upgrading to QuantaStor v6.5.2]].
=== Release Notes ===

Alerts and Configuration Analysis
* Added SED version of Micron 7300 drives to firmware check for Config Analyzer [ QSTOR-10933 ]

Ceph Scale-out Block, Object and File
* Update AWS cli. [ QSTOR-10956 ]
* Extend Resource Groups to support adding S3 Tenant resource type. [ QSTOR-10808 ]
* Extended timeouts for logical volume allocation commands when creating Ceph OSDs. [ QSTOR-10930 ]
* Added more permissive check when running Ceph OSD replace prepare operation. (CLI only) [ QSTOR-10914 ]
* Add a qs-ceph command to allow switching between fuse and kernel mount for cephFS to allow user comparison of fuse versus the faster kernel option. [ QSTOR-10905 ]
* Adds additional Ceph coordinator election mode that maps to the site-cluster. [ QSTOR-10795 ]

Dashboards and Analytics
* Added Jammy platform support for the ceph prometheus install script [ QSTOR-10949 ]

Enclosures and Controllers
* Strip whitespace characters from primary and secondary IPs during External System Credentials Add. [ QSTOR-10896 ]
* Add validation for External System Credentials during creation. [ QSTOR-10826 ]

High Availability Failover
* Fixed a bug with creation grid master (gm) Site Cluster vifs. [ QSTOR-10996 ]
* Implemented new naming schema for underlying Site Cluster HA Groups. [ QSTOR-10904 ]

Network Interfaces
* Fixed an issue with deleting bonded interfaces leaving slave interfaces tagged as slaves. [ QSTOR-10931 ]
* Updates for mellanox ofed lossless networking support to work better with newer model cards. [ QSTOR-10779 ]

Network Shares
* Fixes bug where having 'gmt' or 'GMT' in the name of a network share would cause issues with NFS protocol. [ QSTOR-10982 ]
* Fix the mount paths for read-write GMT snapshots. [ QSTOR-10938 ]
* Add mountaddr to the view mount instructions for Network Share. [ QSTOR-10923 ]
* Add crossmnt option in the NFS exports for newly created shares. Also skip adding the default export for .zfs directory. [ QSTOR-10806 ]
* Add the ability to clone a GMT snapshot and promote it.
Add QS CLI to copy share permissions. [ QSTOR-10580 ]

REST API
* Handle empty lists from the curl calls to Quantastor APIs. [ QSTOR-10939 ]

Remote Replication, Snapshots and Backup Policies
* Fixed up dead links which were created after running some types of auto-tier Backup Policies. [ QSTOR-10934 ]

SNMP
* Update SNMP MIB [ QSTOR-11019 ]

Security
* Prevent MFA passcodes with leading 0 from being truncated. [ QSTOR-10852 ]

Service Core
* Fixes an issue where role-creation would fail due to deprecated permission-definitions. [ QSTOR-10988 ]

Storage Pool Management
* Added support for the creation of mirror sets consisting of "quad-mirrors" (4-way mirror sets) for both the data device groups in the pool and also the "special" devices, such as "dedup" and "metadata offload" devices. [ QSTOR-10893 ]

Storage Volumes
* Add more detail for logical and physical space utilization for volumes. [ QSTOR-10981 ]

Upgrade Manager and Installer
* Deprecates legacy package version pinning for the packages.osnexus.com mirror server that was causing issues with some ceph cluster upgrades [ QSTOR-10990 ]
* Added protections in qs\_distupgrade.sh for lvm snapshots that could cause issues with the platform upgrade. [ QSTOR-10970 ]
* Resolved multiple items that were causing issues with installing QuantaStor on redhat based platforms when STIG enforcement policies were present. [ QSTOR-10958 ]
Note: the qs_upgrade_redhat8.sh install/upgrade script temporarily sets selinux to permissive mode and temporarily disables fapolicyd if it is enabled when the script is running and restores them to their original state when the script completes.

Web Manager
* Auto select S3 tenant for S3 User when user create is invoked from context menu on the S3 tenant. [ QSTOR-11010 ]
* Increase the width of grids to show the 'Correlated Device' column in the Add Log/Cache/Metadata Device to Pool dialog w/o the need for scrolling. [ QSTOR-10951 ]
* Add an option to upload logs with no truncation. [ QSTOR-10925 ]
* Add drawer support for the Corvault enclosure layout and rendering engine in the WUI. [ QSTOR-10796 ]

== v6.5.1.058 (February 12th 2025) ==

=== [[QuantaStor 6.5.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.1 Upgrade Instructions| upgrading to QuantaStor v6.5.1]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* General improvements to OSD drive replacement process. Added additional LVM clean up logic. Fixed issues with device correlation for multipath devices and encrypted drives. [ QSTOR-10915 ]
* Allow deleting journals from the UI via Ceph journal delete dialog [ QSTOR-10890 ]

Dashboards and Analytics
* Add gridPreferredPort check to the WUI dashboard service (qsrestd) if set on a Storage System. [ QSTOR-10866 ]

Disk Management
* Fixed: New systems and clean QuantaStor service configurations databases will initialize Multipath autoconfig support as enabled by default. [ QSTOR-10900 ]
* Increased timeouts and other optimizations for large multipath configurations. [ QSTOR-10881 ]
* Added protections to prevent QuantaStor service from running multiple blkid instances if one is already running. [ QSTOR-10881 ]
* Unblocked adding disk as a scale-up pool spare with a larger block size. [ QSTOR-10876 ]

Enclosures and Controllers
* Add Enclosure mapping support for HPE ProLiant DL325 Gen10. [ QSTOR-10899 ]
* Fixed an issue with Hardware Disk Identify for Storage Pool Physical Disks where the controller was not properly selected in the dialog. [ QSTOR-10858 ]
* Fixed an issue with applying External System Profile A+B. [ QSTOR-10840 ]

High Availability Failover
* Fixed an issue with automatically starting HA scale-up ZFS pools if both HA nodes are booted at the same time. [ QSTOR-10902 ]
* Added a a check to ensure the luks crypttab was upto date after encrypted ha pool failover. [ QSTOR-10901 ]
* Added VLAN interfaces to allowed interfaces for Site Cluster heartbeat rings. [ QSTOR-10871 ]
* Added better logic for smb/nfs service management for Scale-up HA configurations with shares on multiple storage pools in the same HA cluster. [ QSTOR-10762 ]
* Fixed an issue with Resource Group Service configs starting on a node after the node had previously hosted the service. [ QSTOR-10762 ]
* Fixed: added a unique name check for HA group create/modify. [ QSTOR-10311 ]

NAS Gateway / Cloud Containers
* Change Seagate Lyve Cloud endpoints [ QSTOR-10868 ]

Network Interfaces
* Fixed an issue with calling iptables commands when distupgrading from older distributions. [ QSTOR-10860 ]

Network Shares
* Minor fix to allow creation of GMT snapshots for volumes from the Web UI. [ QSTOR-10873 ]
* Fixed an issue with spaces in the curl command issued to Quantastor. [ QSTOR-10838 ]
* Fix issue where renaming a share that contained a nested share failed. [ QSTOR-10811 ]
* Allow setting Samba share as read-only using ZFS. The new support has been added to the Network Share create and modify dialogs on the Advanced settings tab. [ QSTOR-10755 ]
* Fixed an issue which created duplicate mounts for nested shares. [ QSTOR-10704 ]
* Exposed ZFS 'Case Sensitivity' option at share creation time. [ QSTOR-8869 ]

REST API
* Fixed the POST command in the REST API [ QSTOR-10844 ]

Remote Replication, Snapshots and Backup Policies
* Fix an issue with auto tiering in backup policies. [ QSTOR-10845 ]
* Refined the Backup Policy Create and Modify dialogs. [ QSTOR-10843 ]
* Fixed an issue with Backup Policy tasks completing when the underlying file copy or move process process had returned. [ QSTOR-10839 ]
* Add alerting when replication fails. [ QSTOR-10799 ]

SNMP
* Updated SNMP MIB [ QSTOR-10922 ]

Service Core
* Fixed an issue that could sometimes cause performing a reboot or shutdown of the storage system via the QuantaStor UI to fail. [ QSTOR-10917 ]
* Fix an issue with database backups on the storage pools. [ QSTOR-10907 ]
* Fixed an issue with creating encrypted pools when an underlying disk is read-only. [ QSTOR-10886 ]
* Fixed a disk discovery issue when discoverying a large number of disks. [ QSTOR-10875 ]
* Fixed QuantaStor service builds for Redhat based distros. [ QSTOR-10846 ]
* Added /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable touchfile to bypess the icmp ping check and allow sending logs from the UI/qs cli. [ QSTOR-10556 ]

Storage Pool Management
* Fix an issue with pick a smaller hotspare disk getting picked for metadata offload if disk goes missing. [ QSTOR-10877 ]
* Add storage capacity properties for metadata offload VDEV [ QSTOR-10661 ]

Upgrade Manager and Installer
* Added a blacklist of the bnxt\_re driver to prevent issues for normal network operations for the bnxt_en driver loading on network controllers that have rdma support enabled in their firmware by default. [ QSTOR-10918 ]
* Added elbencho benchmarking tool to quantastor utilities. [ QSTOR-10892 ]
* Added support for Focal 20.04 to Jammy 22.04 Platform upgrades via qs-distupgrade [ QSTOR-10547 ]
* Fix telegraf start failures at startup due to invalid config file errors. [ QSTOR-10353 ]

Web Manager
* Fixed a minor truncation issue with trigger Backup Policy dialog [ QSTOR-10919 ]
* Add a Description column to the share and snapshot grid and default to hidden. [ QSTOR-10882 ]
* Minor fix to NTP server add dialog to prevent empty entries in the dialog. [ QSTOR-10870 ]
* Auto select first row in NTP and DNS settings dialogs. [ QSTOR-10867 ]
* Improve the host assign volume dialog. [ QSTOR-10862 ]

== v6.5.0.246 (January 9th 2025) ==

=== [[QuantaStor 6.5.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.0 Upgrade Instructions| upgrading to QuantaStor v6.5.0]].
=== Release Notes ===

Alerts and Configuration Analysis
* Increased HA health checks on Systems with local HA Pools. [ QSTOR-10746 ]
* Fixed: sending logs from specific grid nodes will now send logs only from the selected nodes. [ QSTOR-10694 ]

Ceph Scale-out Block, Object and File
* Fixes issue with access permissions for ceph client admin keyring file. [ QSTOR-10818 ]
* Fixed issues related to encrypted OSD replace operations. [ QSTOR-10786 ]
* Fixed an issue with wal journal device discovery and association with osds. [ QSTOR-10751 ]
* Deprecated replica=2 as a creation option from Ceph Scale-out storage. Replica=2 did not provide enough redundancy for consistent normal storage operations in the event of an osd or storage system outage. [ QSTOR-10748 ]
* Added the force flag checkbox to the Create S3 Storage Class dialog. [ QSTOR-10734 ]
* Fixed bugs in Ceph upgrade stage completion and failure alerting. [ QSTOR-10730 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10717 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10716 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10708 ]
* Improve ceph discovery. [ QSTOR-10675 ]
* Add metadata pool utilization for Ceph Object Pool Group and Ceph File System [ QSTOR-10650 ]
* Disabled OSD auto restart. auto restart can be activated using the touchfile '/var/opt/osnexus/quantastor/touchfiles/tf\_ceph\_osd\_auto\_start.enable' [ QSTOR-10632 ]
* Ensure the Tenant and User grid's bucket count column is updated after the delete bucket operation via events. [ QSTOR-10610 ]
* Fixed a bug with Ceph OSD 'Last Rekey Date' field not being updated properly. [ QSTOR-10509 ]
* Updated default Ceph version to Reef 18.2.4 for new Focal and Jammy platform deployments. [ QSTOR-10415 ]

Dashboards and Analytics
* Add a new Ceph Member selection combo to the Ceph Pool dashboard. [ QSTOR-10798 ]
* Add Tenant and Owner usage dashboards to the Bucket menu area. [ QSTOR-10698 ]
* Add CPU Temp and Power Usage to the Grid Dashboard's System Tiles. [ QSTOR-10427 ]
* Change the grid CPU metric to use system\_usage which matches the metric used in the System dashboard. The overlapping text issue is no longer an issue as Highcharts has been replaced with Chart.js. [ QSTOR-10263 ]
* Add power usage and average CPU temp sparklines to the System Tile dashboards in the grid view. [ QSTOR-10013 ]
* Removed resource column from Health Checker/Config Analyzer. [ QSTOR-5515 ]

Disk Management

* Removed the multipath autoconf touchfile support which fixes issues where disabling multipath autoconfig would not apply. [ QSTOR-10706 ]
Enclosures and Controllers
* Addes enclosure layour for Supermicro Server SYS-F629P3-RC1B FatTwin 4-Node 24+12 bay [ QSTOR-10853 ]
* Fixed an issue with disk discovery when a CORVAULT is attached. [ QSTOR-10664 ]
* Added the ability to blink empty slots on jbod hardware that supports that feature. This action is accomplished using sg\_ses commands. [ QSTOR-10618 ]
* Added functionality to treat enclosures accidentally unplugged as MISSING, so that when reconnected their user-set properties are not lost . [ QSTOR-10542 ]

High Availability Failover
* Fixed an issue with post failover storage pool update tasks being stuck in a running state for nodes where the HA storage pool was previously evicted from due to an automatically triggered failover event. [ QSTOR-10485 ]

Kernel and Drivers
* Updated ZFS driver version to 2.2.6 [ QSTOR-10647 ]
* Updated scst iSCSI/FC Target driver to 3.9.0 [ QSTOR-10534 ]

Licensing
* Fixup old license keys to work with new format. [ QSTOR-10788 ]
* Added Express Edition Licenses [ QSTOR-10619 ]
* Show TB Utilized in the License grid and property view. [ QSTOR-8009 ]

NAS Gateway / Cloud Containers
* Fix wrap and truncation issues in the Cloud Add Credential dialog for Spanish. [ QSTOR-10792 ]

Network Shares
* Retain include line position in smb.conf [ QSTOR-10800 ]
* Minor fix to retain the share description when creating a Network Share. [ QSTOR-10793 ]
* Enhance the network share CLI search to support paging (similar to buckets). [ QSTOR-10757 ]
* Fix minor share name and snapshot name validation. [ QSTOR-10520 ]
* Added additional share name validation to share modify cli and API calls. [ QSTOR-10519 ]
* Add SSSD support [ QSTOR-10445 ]
* Implemented ransomware detection for Network Shares. [ QSTOR-10391 ]

Quantastor CLI
* Fixed qs cli disk-list filters for ssd, and nvme disk types. [ QSTOR-10515 ]
* Fixed the filtering for qs cli disk-list --filter="\[unused\]" and --filter="\[used\]" commands [ QSTOR-10482 ]

Remote Replication, Snapshots and Backup Policies
* Remove SSH keys after replication links are deleted [ QSTOR-10782 ]
* Fix minor argument validation for replication schedule create and snapshot schedule create. [ QSTOR-10732 ]
* Added monitoring for file modify events to enable continuous data protection on modified files. [ QSTOR-10557 ]
* Added ability for Snapshot Schedules and Replication Schedules to absorb old snapshots. [ QSTOR-10524 ]
* Create local delta Snapshot on source when Replication Schedule is skipped. [ QSTOR-10357 ]
* Change the control in the 'Update Selections for Replication Schedule' dialog to be a dual chooser. [ QSTOR-10351 ]

SCSI / NVMe Target
* Added a remote Fibre Channel port list to the fc target port section of the UI and 'qs fc-remote-port-enum' CLI command. [ QSTOR-10541 ]
* Added the Fiber Channel Issue LIP dialog to the UI that can be used to issue a lip on a specific FC port. [ QSTOR-10226 ]

SNMP
* Update SNMP MIB [ QSTOR-10847 ]

Security
* Fixed a bug in the 2FA login process. [ QSTOR-10841 ]
* Added support for a custom iptables include script under
/var/opt/osnexus/quantastor/iptables.qscustom [ QSTOR-10794 ]
* Updated tomcat package version to 9.0.96.0 [ QSTOR-10691 ]

Service Core
* Fix a small memory leak [ QSTOR-10778 ]
* Revise the server S3 modify API to accept spaces for the Display Name property. [ QSTOR-10724 ]
* Fixed some issues with writing the Chrony conf file on platforms that have chrony installed (like Jammy) [ QSTOR-10293 ]

Storage Pool Management
* Allow trim schedule to run nightly. [ QSTOR-10652 ]

Storage Volumes
* Allow minimum of <4MB for Storage Volume QoS Control limits. [ QSTOR-10765 ]
* Updated Storage Volume QoS controls to use cGroups v2 for modern linux kernels/platforms. [ QSTOR-10529 ]

Upgrade Manager and Installer
* Added logic to temporarily disable the upmap balancer during ceph upgrade. [ QSTOR-10702 ]
* Fixed an issue where Storage System Upgrade tasks were showing 25% progress but transitioned to the 'Completed' stage. [ QSTOR-10673 ]
* Install sssd packages by default on focal and newer platforms. [ QSTOR-10549 ]
* chrony is now the default time daemon for ubuntu 22.04 jammy and newer platforms. [ QSTOR-10273 ]
* Added 22.04 Jammy as a new Platform for QuantaStor [ QSTOR-10225 ]

Web Manager
* Disable the 'Start Upgrade' button in the Upgrade dialog until the system update check is complete. [ QSTOR-10776 ]
* Show the Tag/Alt Name value along with the Controller name in the identify dialog if provided. [ QSTOR-10775 ]
* Decrease the replication detail chart update frequency. [ QSTOR-10753 ]
* Added email validation check for the Alert Manager dialog [ QSTOR-10590 ]
* Added Timezone configuration as a step in the getting started guide. [ QSTOR-10502 ]

== v6.4.5.001 (November 1st 2024) ==

=== [[QuantaStor 6.4.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.5 Upgrade Instructions| upgrading to QuantaStor v6.4.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an error with Ceph Bucket Discovery tasks. [ QSTOR-10707 ]

== v6.4.4.013 (October 25th 2024) ==

=== [[QuantaStor 6.4.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.4 Upgrade Instructions| upgrading to QuantaStor v6.4.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added a fix for Seagate Corvault based Ceph deployments to ensure ceph LVM layer is started on system boot. [ QSTOR-10686 ]
* Added qs-osd-compact script to assist with OSD compaction on a per system basis. [ QSTOR-10668 ]
* Fixed an issue with Ceph OSD Journal device discovery for encrypted Ceph Clusters. [ QSTOR-10666 ]
* Extend timeouts for OSD restart stage of the Ceph upgrade task. [ QSTOR-10665 ]
* Fixes bug were OSDs lose journal device correlation after OSD reweight operation. [ QSTOR-10657 ]

Enclosures and Controllers
* Fixed an issue with enclosure and disk slot identity correlation information. [ QSTOR-10681 ]

High Availability Failover
* Disables the PCS daemon WebUI by default. [ QSTOR-10692 ]
* Adds a check for versions older than 6.4.3 to auto-disable the new health checks logic that is not compatible with older versions. [ QSTOR-10692 ]

Upgrade Manager and Installer
* Fixed: the qs_upgrade_redhat8.sh script now automatically removes legacy centos repos that are no longer needed for Redhat platform deployments. [ QSTOR-10676 ]

== v6.4.3.021 (October 10th 2024) ==

=== [[QuantaStor 6.4.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.3 Upgrade Instructions| upgrading to QuantaStor v6.4.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed a incorrect encrypted ZFS pool check check in the Config Analyzer for encrypted Ceph clusters with encrypted OSDs. [ QSTOR-10643 ]

Ceph Scale-out Block, Object and File
* Optimized scale-out ceph bucket discovery for very large number of S3 buckets. [ QSTOR-10621 ]
* Ceph OSD create and delete operations will no longer fail due to services being masked. [ QSTOR-10617 ]
* Made some improvements to the Veeam SOSAPI update cycle. [ QSTOR-10616 ]
* Fixed an issue with creating Ceph Storage Classes of the same name on different Ceph Clusters. [ QSTOR-10592 ]
* Default to http based checks from the haproxy load balancer to backend http radosgw instances. [ QSTOR-10559 ]

NAS Gateway / Cloud Containers
* Add a rescan for cloud containers so that data is refreshed if uploaded from another S3 gateway. [ QSTOR-10627 ]

Network Shares
* Fix an issue with trusted domain users not found in the Active Directory User search dialog. [ QSTOR-7353 ]

Remote Replication, Snapshots and Backup Policies
* Enabled Continuous Data Protection and Auto-tiering on Backup Policies using the SMB protocol. [ QSTOR-10601 ]

Security
* Added http proxy support for Upgrades, Support Log submission and License Key Activation. [ QSTOR-10432 ]

Upgrade Manager and Installer
* Fix triggering Ceph cluster upgrades when there are multiple scale-out storage Ceph clusters in the same QuantaStor Storage Grid. [ QSTOR-10612 ]
* Fixed an issue with the Ganesha 5.9 libntirpc dependency. This change was shipped earlier with a respin of QuantaStor 6.4.3 to include the missing updated library in the update repo and in the ISO and OVA image. [ QSTOR-10576 ]

== v6.4.2.053 (September 19th 2024) ==

=== [[QuantaStor 6.4.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.2 Upgrade Instructions| upgrading to QuantaStor v6.4.2]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed tolerances for alerting on changes in PSU status and other IPMI sensors. [ QSTOR-10447 ]

Ceph Scale-out Block, Object and File
* Adds total Object count to S3 tenant and user objects [ QSTOR-10606 ]
* Improved logic to ensure Scale-out Object Storage Class Auto-Tiering Rules were applied correctly on all nodes after an update. [ QSTOR-10599 ]
* Unblocked file quotas for CephFS Shares. [ QSTOR-10584 ]

Enclosures and Controllers
* Added Enclosure for Tyan Transport SX TS70-B8056. [ QSTOR-10597 ]
* Fixed an issue with enclosure support for Supermicro SSG-621E-ACR16L [ QSTOR-10563 ]

NAS Gateway / Cloud Containers
* Fix a regression with NFS and SMB access for cloud container shares. [ QSTOR-10588 ]

Network Shares
* Fixed an issue where the quota field was incorrectly disabled in the network share modify and create dialogs for nested shares on zfs storage pools. [ QSTOR-10602 ]
* Implemented ability to adjust Network Shares permission settings via a specified permissions mask. [ QSTOR-10147 ]

Quantastor CLI
* Fix a minor regression with share name now showing in the output of "qs share-list" [ QSTOR-10587 ]

Remote Replication, Snapshots and Backup Policies
* Show more informative errors when a Backup Job fails. [ QSTOR-10575 ]
* Fixed an issue where multiple snapshots were wrongfully created. [ QSTOR-10564 ]
* Fix an issue with removing excess snapshots for a backup policy with cephFS shares. [ QSTOR-10560 ]
* Add maximum total snapshots for replication, snapshot and backup schedules. [ QSTOR-10539 ]
* Fixed an issue where GMT Snapshots were disappearing. [ QSTOR-10538 ]
* Fix an issue with resume replication not updating the replication reports. [ QSTOR-10536 ]
* Added auto-tier stubbing minimum file size threshold. [ QSTOR-10505 ]

SCSI / NVMe Target
* Added support for setting specific LUN numbers on Storage volumes for Fibre Channel access. This is available in the Advanced tab of the Storage Volume Create and Modify dialogs. [ QSTOR-10544 ]

Service Core
* Improved efficiency for Ceph Bucket discovery. New Default behavior is to skip collecting life cycle policy and object locking data on the bucket. Contact support to enable object locking discovery on buckets. [ QSTOR-10600 ]

Upgrade Manager and Installer
* Added script to fix RGW configurations on clusters created on older versions of QuantaStor. [ QSTOR-10569 ]
* Added support for Ceph Reef 18.x upgrades. [ QSTOR-10493 ]

Web Manager
* Make the info fields, in the Snapshot Rollback Point fieldset of the Rollback Storage Volume dialog, read-only. [ QSTOR-10596 ]
* Hide the timezone column in the Upgrade Manager dialog. [ QSTOR-10540 ]
* Change S3 Bucket Search panel location from North to West of screen. [ QSTOR-10405 ]

== v6.4.1.011 (August 6th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.1 Upgrade Instructions| upgrading to QuantaStor v6.4.1]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with the Supermicro NVMe Enclosure mappings for the SBB-SSG-221E and SSG-641E [ QSTOR-10506 ]

Network Interfaces
* Fixed: Infiniband Devices should now have the correct Make and Model displayed in the Network interface section. [ QSTOR-10448 ]

Network Shares
* Fixed an issue with updating the status of Backup Policy Jobs. [ QSTOR-10517 ]

Remote Replication, Snapshots and Backup Policies
* Fixed: Shows the last 14 days in the replication schedule dashboard regardless of the replication schedule configuration. Fix an issue where not all series data was appearing despite being in a completed state. [ QSTOR-10528 ]
* Fixed an issue with duplicate Replication tasks. [ QSTOR-10526 ]
* Correct the max temporary snapshots retained for volumes in a replication schedule. [ QSTOR-10525 ]
* Add the ability to discover partially transferred chkpnts if replication is interrupted on the first transfer. [ QSTOR-10500 ]

Upgrade Manager and Installer
* Fixed: optimized dependency checker for qs-upgrade script. [ QSTOR-10531 ]

== v6.4.0.174 (July 18th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.0 Upgrade Instructions| upgrading to QuantaStor v6.4.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue with adding new ITSM webhook integrations. [ QSTOR-10480 ]
* Added support for Microsoft Teams to ITSM integrations. [ QSTOR-10458 ]
* Added the ability to easily extend ITSM integrations with new integration modules with qs_alerthandlers.conf file. [ QSTOR-10458 ]
* Include storage volumes in pool reports. [ QSTOR-10083 ]

Ceph Scale-out Block, Object and File
* Fixed an issue where the wrong libntirpc library was installed for nfs-ganesha. [ QSTOR-10463 ]
* Added a Copy to Clipboard Button for a selected access key and changed the double click on access/secret key behavior to copy to clipboard for the S3 User Access Key Manager Dialog. [ QSTOR-10428 ]
* Added a check to the S3 User Access Key Manager Dialog to ensure only the selected key text is shown when the user clicks the 'Show Key Text' button on the dialog. [ QSTOR-10428 ]
* Added block for more than 2 S3 Gateway loadbalancer modes configured at the same time. [ QSTOR-10407 ]
* Added a new feature for data pool capacity based, overflow rules for ceph object storage. Added support for a force flag for the auto tiering rules, that will overwrite any client side storage class specifications. [ QSTOR-10379 ]
* Add reporting for object storage usage. Periodic reports can be generated as part of "Report Schedules" by enabling "Object Zone Usage Report". [ QSTOR-10355 ]
* Added object count for Ceph Buckets. [ QSTOR-10348 ]
* Updated the default access permissions for Ceph keyring files. [ QSTOR-10325 ]
* Updated ceph cluster scale-out OSD osd_op_queue setting to wpq by default. The setting will take effect for any new OSDs on creation. Existing OSDs will use the new setting on OSD service restart (system reboot, encrypted OSD re-keying or manual OSD service restart) [ QSTOR-10123 ]
* Improved an error message when creating a Site Vif with Block Storage use case. [ QSTOR-9984 ]
* Added ability to enable a size quota and a file number quota on cephFS Shares. [ QSTOR-7344 ]

Enclosures and Controllers
* Fixed an issue where a disconnected JBOD could leave the enclosure object around on LSI HBAs. [ QSTOR-10503 ]
* Fixed: a modify of enclosure or system layout to something other than default will also set the same layout on the corresponding system or enclosure(s) that are currently set to default. [ QSTOR-10496 ]
* Fixed an issue with using the wrong LED control Utility for disk identification on Supermicro NVMe storage systems. [ QSTOR-10469 ]
* Added support for Supermicro SBB-SSG-221E-DN2R24R to enclosure/server views. [ QSTOR-10460 ]
* Added Support for Supermicro SSG-641E-E1CR36L/H to enclosure/server views. [ QSTOR-10429 ]
* Prevent a missing disk from being blinked. [ QSTOR-10179 ]

High Availability Failover
* Fixed an issue that could terminate the qs_pool_export script early on ha failover without final logging. [ QSTOR-10514 ]
* Fixed: added a check for HA VIFs to the network port offline dialog. This prevents a possible split cluster scenario. [ QSTOR-10414 ]
* Updated Task error messages to include the system where an error occurred for HA Storage pool failover tasks. [ QSTOR-10248 ]
* Added periodic HA failover group health checks for client and media connectivity. An alert will be raised If a health check fails that could indicate an issue with the future success of a High Availability failover from the primary to secondary node. [ QSTOR-9380 ]

Network Interfaces
* Prevent modifying parent port when static route is configured. [ QSTOR-10200 ]
* Fixed: removed iscsi and nvmeof portal configuration options on all grid vifs. client access should be configured through HA or Site cluster vifs only. [ QSTOR-9974 ]

Network Shares
* Fixed: NFS remove client access dialog and the qs share-client-remove CLI command now default to immediately terminate client connections for removed export rules, enhancing security. An option to retain client connections is available in the UI ("Retain Client Connections") and CLI (--retain-client-connection=true). [ QSTOR-10431 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Remote Replication reporting incorrect snapshot count. [ QSTOR-10476 ]
* Added a ZFS quantastor:scheduletype property to snapshots so that it is clearer what type of schedule created the snapshot. [ QSTOR-10421 ]
* Fix duplicate entries in replication dashboard. [ QSTOR-10385 ]
* Use raw mode for ZFS send and receive. Use on the wire compression if the source is not compressed. [ QSTOR-10153 ]

SNMP
* Update SNMP MIB [ QSTOR-10512 ]

Security
* Added feature to replace the OSD encryption keys for a given Ceph cluster. [ QSTOR-10283 ]
* Improved qs-util wrapper script so that user is prompted for secret passphrase. Passphrase will remain hidden. [ QSTOR-9982 ]

Service Core
* Fix minor trace message for Maintenance schedules. [ QSTOR-10416 ]
* Added a check to the QuantaStor system startup to ensure that LUKS encrypted Physical disks devices provided to QuantaStor via the iSCSI Software adapter are opened after system boot. [ QSTOR-10257 ]

Upgrade Manager and Installer
* Added support for customizing OVF templates with passwords and license keys. [ QSTOR-10451 ]
* Fixed an issue with the archived centos ganesha mirrors in the qs_upgrade_redhat8.sh install and upgrade script. [ QSTOR-10446 ]

Web Manager
* Fixed an issue where the User Web Customization rules were not being properly applied when the rules were defined in the Role create or modify dialog. [ QSTOR-10513 ]
* Fixed the text highlight and other colors used in the UI to be consistent across elements. [ QSTOR-10470 ]
* Update: Replaced all instances of 'double click to reveal plain text' on password fields with an explicit eyeball reveal button to allow users to show plain text. [ QSTOR-10410 ]
* Updated web manager tomcat and Java runtime dependencies. [ QSTOR-9492 ]

== v6.3.7.011 (June 18th 2024) ==

=== [[QuantaStor 6.3.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.7 Upgrade Instructions| upgrading to QuantaStor v6.3.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue with creating Erasure Coded Ceph Object Storage Classes in the Web UI. [ QSTOR-10434 ]

Dashboards and Analytics
* Fixed the install-ceph-prometheus scripts to always have a default fallback install version if the latest version is not available. [ QSTOR-10441 ]
* Updated wiki documentation for the Prometheus and Grafana Integration guide to reflect changes from latest Grafana 11.0 release. [ QSTOR-10441 ]

Enclosures and Controllers
* Fixed several items and updated logic for External System Corvault support. [ QSTOR-10235 ]

Kernel and Drivers
* * Fixed an issue with modern mellanox OFED installs using the mellanox-ofed-install.sh script and legacy ConnectX-3 Based Mellanox HBA's [ QSTOR-10295 ]

Network Shares
* Added logic to always bind mount the /export paths on Network Shares even if the share has no NFS access rules and is set to disabled and SMB/CIFS disabled. This includes Nested shares under Parent Network Shares. No noticeable increase in failover times was detected when testing on a Large HA config with many Network Shares including many Nested Shares and snapshots. [ QSTOR-10424 ]
* Fixed an issue with the Network Share snapshot count property. [ QSTOR-10329 ]
* Re-enabled the Network Share Snapshot count column by default in the Network Share Grid View. [ QSTOR-10329 ]

Storage Volumes
* Fixed an issue where FC ALUA standby LUN devices for Storage Volumes would not appear as non-rotational(SSD) to clients when on an SSD or NVMe based Storage Pool. Note: a reboot is required to reload the SCST kernel driver stack on the system for the fix to take effect. [ QSTOR-10417 ]
* Fixed an issue with presenting pass-through Storage Volumes as non-rotational(SSD) to clients. [ QSTOR-10417 ]

Upgrade Manager and Installer
* Updated mellanox-ofed-install.sh script to support latest Mellanox OFED 24.04-0.6.6.0 [ QSTOR-10438 ]
* Added a lts optional flag to the mellanox-ofed-install.sh for installing Mellanox OFED version 5.8-4.1.5.0. [ QSTOR-10438 ]

Web Manager
* Fix a minor ribbon bar alignment and spacing issue between elements by making a deferred force layout call during context switching. [ QSTOR-10413 ]
* Fixed an issue where some elements of the Ribbon Bar would not be visible or would somehow be under the visible section of the UI. [ QSTOR-10413 ]
* Removed the ZFS share encryption tab from the create and modify network share dialogs. The ZFS Share encryption feature is still available for share creation via the CLI but is not recommended for most users due to ZFS driver level issues. When the ZFS driver issues are resolved in a future ZFS release, the encryption tab will be re-enabled. [ QSTOR-10352 ]

== v6.3.6.003 (June 4th 2024) ==

=== [[QuantaStor 6.3.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.6 Upgrade Instructions| upgrading to QuantaStor v6.3.6]].

=== Release Notes ===
Remote Replication, Snapshots and Backup Policies
* Added a check to enforce 'Enable target checkpoint recovery (unchecking will perform full replication)' setting on Remote Replication Schedules. This helps ensure that no additional _chkpnt is created for a share or volume if one already exists for the source and target replication association. [ QSTOR-10419 ]
* Fixed an issue with replication report showing synchronizing state forever. [ QSTOR-10419 ]

Security
* Added qs-util wuicustomcerts command to allow creation of a /var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf nginx override config so that users can customize certificate paths and ciphers from the QuantaStor defaults for the Web UI. [ QSTOR-9037 ]

== v6.3.5.020 (May 23rd 2024) ==

=== [[QuantaStor 6.3.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.5 Upgrade Instructions| upgrading to QuantaStor v6.3.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where s3 gateway create was creating load balancers with https->https mode when https->http mode was passed in. [ QSTOR-10399 ]
* Fixed some issues with discovery of the http/https mode for the S3 load balancer. [ QSTOR-10399 ]
* Further optimizations and fixes related to Grid communication and Ceph Scale-out Object discovery on Object Storage Pools with a large number of buckets. [ QSTOR-10380 ]
* Fixed an issue with adding and removing RGW instances on the same node via different IP addresses. [ QSTOR-10370 ]

High Availability Failover
* Added logic to limit number of open threads and open file handles needed to unmount shares for the HA storage pool failover process. This fixes an issue with deployments that have a large amount of shares, including nested shares and share snapshots. [ QSTOR-10373 ]
* Added more coverage for the auto close open file handles logic during HA storage pool failover to help unmount shares under the nfs /exports path as well as nested shares/snapshots. [ QSTOR-10373 ]

Multitenancy
* Fixed some issues with Multitenancy Container discovery and database table updates. [ QSTOR-10363 ]

Network Interfaces
* Added a exact match filter config file /var/opt/osnexus/quantastor/conf/qs_portFilter.conf for interface names that allows users to blacklist interfaces they do not want QuantaStor to see and/or manage. [ QSTOR-9664 ]

Network Shares
* Fixed an issue with the Network Share samba audit logging feature when upgrading from a legacy audit logging config. [ QSTOR-10390 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Security
* Adds support for controlling the sample period over which bad login attempts can trigger a short or permanent lock. [ QSTOR-10374 ]
* Adds support for controlling the duration of the short lock. [ QSTOR-10374 ]
* Fixes a security bug where good login attempts could mask bad login attempts by clearing the bad login attempt sample set for a given user. [ QSTOR-10374 ]
* Changes the special rules around bad login attempts for the 'admin' user, now allowing it to be locked. [ QSTOR-10374 ]
* Adds a touch file to unlock the 'admin' user account. [ QSTOR-10374 ]
* Adds a touch file to block the permanent locking of the 'admin' user account, which is similar to the current behavior. [ QSTOR-10374 ]

Storage Volumes
* Fixed an issue where iSCSI CHAP was not being correctly enabled in the iSCSI target on volumes when configured. [ QSTOR-10398 ]
* Fixed an issue with Fibre Channel Storage Volumes being presented after Storage System boot for Single QuantaStor node deployments (non-HA). [ QSTOR-10277 ]

== v6.3.4.003 (May 14th 2024) ==

=== [[QuantaStor 6.3.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.4 Upgrade Instructions| upgrading to QuantaStor v6.3.4]].

=== Release Notes ===

Web Manager
* Optimized WebUI login time for Large Scale-out Object deployments. [ QSTOR-10365 ]
* Fixed an issue where the WUI idle logout timer would be reached even when browsing inside of the WUI for various different sections. [ QSTOR-10361 ]

== v6.3.3.033 (May 1st 2024) ==

=== [[QuantaStor 6.3.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.3 Upgrade Instructions| upgrading to QuantaStor v6.3.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added qs_rgw_iam_policy.sh script for generating S3api IAM compatible bucket policies. [ QSTOR-10336 ]
* Added FQDN specific string validation to the Modify Realm/Zone Group dialog. [ QSTOR-10320 ]
* Fixed some items with the Modify Realm/Zone Group task. [ QSTOR-10320 ]
* Added a drop-down to the Create Storage Class Dialog with pre-defined S3 Storage Classes supported by most S3 CLI and S3 Library based clients. Users can still create a custom Storage class if they so choose and use their own custom S3 API implementation that supports Custom S3 Storage Classes. [ QSTOR-10232 ]
* Fixed some issues with adding/removing S3 Gateways with Load Balancers. [ QSTOR-9848 ]

High Availability Failover
* Added a force flag to the Remove Site Cluster Virtual Interface dialog. [ QSTOR-8276 ]
* Added logic to auto re-apply iofencing to devices that are re-added to the system due to prior physical removal or power loss of the device/device enclosure. [ QSTOR-5475 ]
* Fixed an issue with enabling client connectivity on HA Groups and implemented more safe guards. [ QSTOR-3432 ]

Network Shares
* Add touch file to limit discovery of snapshots of nested shares. [ QSTOR-10334 ]
* Fixed: Network Share rename will correctly remount the /export/ NFS mount location to the new name. [ QSTOR-10318 ]
* Fix minor message during share disable with active SMB clients. [ QSTOR-10292 ]
* Share disable will close open file handles to the share when accessed via SMB. [ QSTOR-10291 ]
* Fixed an issue where Network sub-share alias shares would not start properly after Storage Pool HA Failover. [ QSTOR-10278 ]
* Fixed an issue where share alias advanced settings allowed modification after an HA failover. [ QSTOR-10276 ]

Remote Replication, Snapshots and Backup Policies
* Fix update selections for a replication schedule for cases where source is on a HA pool. [ QSTOR-10310 ]
* Fixed an issue with Windows Previous Versions on share-alias. [ QSTOR-10274 ]
* Added a check to ensure no duplicate share alias names are created on the same parent share. [ QSTOR-10274 ]

Security
* Fixed an issue where the Security Manager > Default Login Username field was not initializing to 'admin' for default installs and upgrades. [ QSTOR-10323 ]

Upgrade Manager and Installer
* Added logic to remove legacy google-compute-engine-oslogin and/or google-guest-agent on upgrade. These packages caused systems to not shutdown properly when installed. [ QSTOR-10340 ]
* Added a check to ensure the ledmon service is disabled by default. This is to ensure that there are no conflicts with the QuantaStor managed Disk Identify logic. [ QSTOR-10313 ]

Web Manager
* Added paging support to S3 Bucket search [ QSTOR-10324 ]

== v6.3.2.025 (April 15th 2024) ==

=== [[QuantaStor 6.3.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.2 Upgrade Instructions| upgrading to QuantaStor v6.3.2]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added search capability to the S3 Bucket section of the Web UI. [ QSTOR-10288 ]
* Added Rule Sorting and an explicit rule remove button to the Storage Class Auto-Tiering Rules Dialog. [ QSTOR-10287 ]
* Added: You can now add the FQDN's for DNS names that you want the S3 Gateways to respond to via the Modify Realm/Zone Group Dialog. Note: you must add the FQDN's of the hosts or an FQDN alias e.g. s3.yourdomain.net (like used by DNS round robin) for the HAproxy load balancer to work properly. [ QSTOR-10285 ]
* Fixed issues with Ceph S3 Bucket discovery with a large amount of buckets. [ QSTOR-10261 ]
* Fixed some items related to Veeam SOSAPI integration based on testing in Veeam Certifcation scripts. [ QSTOR-10243 ]

Enclosures and Controllers
* Fixed an issue where Dell RAID Controllers were being discovered twice in due to new support for the controllers discovery in Broadcom storcli utilities. [ QSTOR-10244 ]

High Availability Failover
* Fixed an issue where rebooting an active High Availability storage node would cause ZFS encrypted shares to go offline for any active pools on that node prior to automatic failover. [ QSTOR-10218 ]

Network Interfaces
* Fixed an issue where legacy VLAN interfaces that had the RX/TX optimizations flag set would not allow modification of the interface for any other setting. [ QSTOR-10272 ]

Not Set
* Added logic to prioritize high-speed data ports by default in the Ceph Cluster create and S3 gateway create dialogs. [ QSTOR-10266 ]
* Fixed usable space calculation on Object Pool Group when there are multiple Pools or Storage Classes using the same OSD's. [ QSTOR-10264 ]
* Fixed an issue with modifying a network share after after a custom veto files setting had been added to the samba cifs options. Now the veto files merge as a set with the default .qssnaps veto files used by the VSS GMT snapshots feature. [ QSTOR-10249 ]

Security
* Updated the OSNEXUS Security Notice service [https://services.osnexus.com/security/](https://services.osnexus.com/security/) for bionic and focal platform support. [ QSTOR-10269 ]

Service Core
* Added support for replacing ntpd with chronyd in Ubuntu Focal platform based deployments. [ QSTOR-10239 ]

== v6.3.1.009 (April 1st 2024) ==

=== [[QuantaStor 6.3.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.1 Upgrade Instructions| upgrading to QuantaStor v6.3.1]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where a pool running a scrub would report as degraded in the Config Analyzer health report. [ QSTOR-10258 ]

Ceph Scale-out Block, Object and File
* Added qs-rgw-moveobjects script to allow easier s3api copy-object of a buckets contents to a different storage class. [ QSTOR-10268 ]
* Changed haproxy load-balancer to use balance source mode by default. [ QSTOR-10260 ]
* Fixed an issue with the Storage Class Auto-Tiering rules where multipart uploads with Capacity Operators of greater than or greater and equal to the Capacity Threshold would not be uploaded to the correct storage class. [ QSTOR-10254 ]

Enclosures and Controllers
* Changed qs-util seagate-ap-split mode command to use zone 5 [ QSTOR-10259 ]

Web Manager
* Increased default max bucket count for S3 user to 100K. [ QSTOR-10256 ]
* Added new Grid Preferred Port status column in the Network Port Grid. It's hidden by default. [ QSTOR-10256 ]
* Fixed s3 gateway dialog height so it can show more nodes in the grid. [ QSTOR-10256 ]
* Fixed s3 tenant create, if "Display Name" is not specified use the "Name" (display name is no longer mandatory in dialog). [ QSTOR-10256 ]

== v6.3.0.268 (March 20th 2024) ==

=== [[QuantaStor 6.3.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.0 Upgrade Instructions| upgrading to QuantaStor v6.3.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where md software raid os partitions where being reported in the config analyzer as offline storage pools. [ QSTOR-10168 ]
* Fixed an issue where non-management ports were being flagged in the config analyzer for iSCSI acess being enabled. [ QSTOR-9891 ]

Ceph Scale-out Block, Object and File
* Blocked creating new OSDs when the OSD service is masked. [ QSTOR-10212 ]
* Show the S3 Object Storage Pool as the root node in the S3 User's and Tenant tree. [ QSTOR-10156 ]
* Show the S3 Object Storage Pool as the root node in the bucket tree. [ QSTOR-10150 ]
* Add support for multiple data pools for storage classes for Ceph Object Storage Pool. [ QSTOR-10137 ]
* Add auto tiering capability to ceph buckets. [ QSTOR-10125 ]
* Change the Ceph block storage pool to default to replica=3 for performance. [ QSTOR-10062 ]
* For CephFS, the min_size for the metadata pool should be 2. [ QSTOR-10015 ]
* Introduce safe disk replacement for Ceph OSDs. [ QSTOR-9937 ]
* Applied adjustments to Ceph Clusters for optimized scrubs on smaller and denser clusters. [ QSTOR-9900 ]
* Updated NFS Ganesha to 5.7 [ QSTOR-9821 ]
* Add support for Ceph Multi-site bucket replication. [ QSTOR-6570 ]

Disk Management
* Added support for ScaleFlux CSD 3000 SSDs that support builtin compression provisioning. [ QSTOR-10198 ]
* Fixed an issue with disk correlation by serial number on Broadcom/LSI 93XX series HBAs. [ QSTOR-10194 ]
* Show osd number in 'qs disk-list'. [ QSTOR-9717 ]

Enclosures and Controllers
* Add enclosure view for the ASUS 2u24 NVMe. [ QSTOR-10202 ]
* Fix controller selection issue in the 'Identify Hardware Controller Disk Device' dialog for when the selected object in the Physical Disk tree is a Physical Disk and not the Disk itself. [ QSTOR-10195 ]
* Updated wddcs tool to 3.2.8.0 [ QSTOR-10166 ]
* Added to feature to create or delete multiple External System Volume configurations. [ QSTOR-10061 ]

High Availability Failover
* Fixed an issue with the Create HA Failover Group Dialog when there are active FC sessions on volumes on the selected pool. [ QSTOR-10169 ]
* Changed NVMe reservations to use cptpl=2 when available so that iofencing is cleared on power on of a nvme drive. [ QSTOR-10124 ]

Licensing
* Added logic to auto-fetch new QuantaStor License Server ca certificates during online license activation. [ QSTOR-10174 ]

NAS Gateway / Cloud Containers
* Update rclone version. [ QSTOR-9512 ]

Network Interfaces
* Show static route parent port in the respective grid and delete dialog. [ QSTOR-10199 ]
* Fixed an issue with onlining/restarting offline VLAN interfaces. [ QSTOR-10180 ]
* Fixed an issue with VLAN ontop of Bonded ports on VM deployed QuantaStor instances. [ QSTOR-10180 ]
* Improve the Network bond mode descriptions, in the 'Create Bonded Port' dialog, for those that require managed switches. [ QSTOR-9842 ]
* Added IP address place holder for DHCP interfaces that have no assigned IP address. [ QSTOR-9828 ]
* Fixed an issue with downing virtual interfaces when converting to HA virtual interface. [ QSTOR-9774 ]

Network Shares
* Minor Web UI fix to display share quota percent utilization. [ QSTOR-10121 ]
* Implemented a Real Time Auto Copy feature to enhance data protection for Network Shares. [ QSTOR-9929 ]
* Updated Focal platform Samba to 4.18.6 backported from ubuntu upstream release. [ QSTOR-9924 ]
* Show parent shares in the 'qs share-list' command results. [ QSTOR-9702 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Remote Replication, Snapshots and Backup Policies
* Add the ability to force create symbolic links for backup policy outbound-move to cloud containers without a delay of 24 hours. [ QSTOR-10136 ]
* Update Replication Report Summary object as failed if source system reboots right after schedule is triggered. [ QSTOR-10097 ]

SNMP
* Regen SNMP MIB for 6.3 [ QSTOR-10228 ]

Security
* Updated JQuery version used in the QuantaStor WebUI to 3.7.1 [ QSTOR-10064 ]
* Add Audit Log Viewing to the Storage System menus. [ QSTOR-10031 ]

Storage Pool Management
* Improved logic for replacing zpool UNAVAIL disks that are identified by their id instead of a device path as the disk is no longer present or visible to the OS. [ QSTOR-10129 ]

Upgrade Manager and Installer
* Automatically disable and mask uefi fwupd service on platforms that include it to prevent unplanned firmware updates. [ QSTOR-10205 ]
* Fixed: the low boot space warning for kernel upgrades now correctly appears in the Upgrade Manager task failure message. [ QSTOR-10185 ]
* Fixed an issue where the scst/zfs userspace packages were not being pinned on security updates. [ QSTOR-10185 ]
* Fixed an issue where qstortarget was incorrectly selected during security updates but fails due to existing pinning rules. qstortarget now correctly only gets selected for install on kernel/driver upgrades. [ QSTOR-10185 ]

Web Manager
* Minor fix to show NA for share-alias space columns. [ QSTOR-10227 ]
* Login dialog shown after service restart is complete. [ QSTOR-10007 ]

== v6.2.8.016 (March 5th 2024) ==

=== [[QuantaStor 6.2.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.8 Upgrade Instructions| upgrading to QuantaStor v6.2.8]].

=== Release Notes ===

Enclosures and Controllers
* Fixed Hardware Disk to Physical disk slot correlation issues. [ QSTOR-10135 ]
* Improved Enclosure object guid uniqueness to better support more complex/multipath setups for hardware disk to physical disk mapping. [ QSTOR-10135 ]
* Added Hardware Enclosure Serial\# property and logic to discover serial\# when available. [ QSTOR-10102 ]

Multitenancy
* Updated Resilio container image to 3.8.1.2250 [ QSTOR-10162 ]
* Fix errors with Resilio container errors seen after upgrade. [ QSTOR-10099 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue that could sometimes cause duplicate snapshot objects to appear for snapshot schedules with nested shares and recursive snapshot enabled. [ QSTOR-10159 ]
* Added a check to temporarily prevent adding ZFS dataset encrypted Network Shares to remote replication schedules until the Open ZFS issue \#12014 is resolved in an upcoming ZFS release. [ QSTOR-10145 ]
* Fixed an issue with using Windows Restore Previous Versions on remote Replica \_chkpnt Network Shares. [ QSTOR-10065 ]

SCSI / NVMe Target
* Updated SCST driver to 3.8.0.9038-f134517-qs01 to support latest available linux kernels for Focal platform and Focal cloud platform kernels. [ QSTOR-10151 ]

Upgrade Manager and Installer
* Added Kernel Driver Support for QuantaStor installation on Ubuntu 20.04 images on Azure, AWS and Google Cloud. [ QSTOR-10138 ]

== v6.2.7.002 (February 23rd 2024) ==

=== [[QuantaStor 6.2.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.7 Upgrade Instructions| upgrading to QuantaStor v6.2.7]].

=== Release Notes ===

Licensing

* Updated license manager certificates for online license activation. [ QSTOR-10154 ]

== v6.2.6.024 (February 8th 2024) ==

=== [[QuantaStor 6.2.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.6 Upgrade Instructions| upgrading to QuantaStor v6.2.6]].

=== Release Notes ===

Enclosures and Controllers

* Added support for iofencing NVMe disks that do not support cdw11 [ QSTOR-10087 ]
* Added an Alert for when a OS Software RAID1 mirror enters a degraded state. [ QSTOR-10080 ]
* Added support LSI-3008C0 model controllers. [ QSTOR-9841 ]
* Added a check to hardware Enclosure Discovery to automatically filter out enclosures that do not have any drive slots. [ QSTOR-9716 ]

High Availability Failover

* Fixed an issue with the I/O fencing tool where it was reporting not-supported on reservation capable nvme devices. [ QSTOR-10114 ]

Network Interfaces

* Updated static routes to use modern ip route syntax with the 'proto static' option. [ QSTOR-10103 ]
* Updated netplan conversion to by default create static routes using ip route to match the original netplan static route rules. [ QSTOR-10103 ]

Storage Pool Management

* Fixed: Activate HA Failover Group now works for Storage Pools in a degraded state missing a few devices. [ QSTOR-10100 ]
* Fixed: Create HA Failover Group now allows a force option if there are a small number of drives missing on the secondary node. Note that the operation will still be blocked if most/all of the drives are missing from the secondary node. [ QSTOR-10100 ]
* Added support for Zero Touch Maintenance Automatic Global Hot spare marking of Hardware RAID0 Passthrough units. [ QSTOR-9865 ]

Storage Volumes

* Fixed: NVMe Target Storage volumes now persist their serial numbers correctly on reboot [ QSTOR-9992 ]
* Fixed: the NVMe Target now correctly re-exports the allowed portals on system boot. [ QSTOR-9992 ]

Upgrade Manager and Installer

* Updated mellanox-ofed-install.sh script to support the latest Focal platform 5.15.0-91-generic kernel. [ QSTOR-10117 ]
* Updated the GPG repo keys for QuantaStor RedHat / and Almalinux platform installs [ QSTOR-10107 ]
* Fixed a incorrect error log when upgrading the Kernel and Drivers on the Ubuntu Focal platform. The upgrade would succeed when the error was seen, but it was unclear to the user without full log analysis. [ QSTOR-10106 ]
* Updated upgrade manager logic to ensure recommended dependency packages are always selected for install during core service and security upgrades. [ QSTOR-10101 ]
* Fixed an issue with the qs-distupgrade script where some QuantaStor core package changes were not being applied after a platform dist-upgrade from bionic to focal. [ QSTOR-10132 ]
* Added better logging of systemctl service enablement and restart during qstorservice package installs. [ QSTOR-10134 ]

== v6.2.5.032 (January 18th 2024) ==

=== [[QuantaStor 6.2.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.5 Upgrade Instructions| upgrading to QuantaStor v6.2.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added ssh port 22 to network connectivity checker tests. [ QSTOR-10092 ]

Ceph Scale-out Block, Object and File
* Fix bug where ceph monitor daemon is disabled. [ QSTOR-10095 ]
* Added script to setup Ceph multi-site replication. [ QSTOR-10075 ]

Enclosures and Controllers
* Updated storcli version to 007.2705.0000.0000 [ QSTOR-10072 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-10036 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-9825 ]

Kernel and Drivers
* Updated Linux Kernel to 5.15.0-91-generic for Focal platforms [ QSTOR-10025 ]
* Linux Kernel 5.15.0-91-generic includes fixes for NFS v3 lockd that would cause file handles to be left open for NFSv3 clients when attempting to stop the nfs server before ZFS pool export during HA failover. [ QSTOR-10025 ]
* Updated ZFS to 2.1.14.qs25 for Focal platforms [ QSTOR-10025 ]

Multitenancy
* Fix an issue with missing Service Configs. [ QSTOR-10079 ]
* Add the ability to sync nested shares when parent share is selected in Resilio. Optionally skip changing the share permissions when user is specified in the config file. [ QSTOR-10070 ]

Network Shares
* Block rename of nested shares. [ QSTOR-10091 ]
* Add the ability to enable and clone a GMT snapshot [ QSTOR-4145 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue where Remote Replication Schedules can fail if 2 source snapshots have the same created timestamp. [ QSTOR-10059 ]
* Fix a minor issue with File Age settings in the Backup Schedule Modify dialog. [ QSTOR-10056 ]
* Properly transition a Replication task and Replication Report to the 'failed' status if the source system loses power during the Replication. [ QSTOR-10041 ]
* Add a warning if checkpoint is selected in create snapshot schedule. [ QSTOR-10038 ]

Storage Volumes
* Fixed an issue with zfs storage volumes being correctly marked as missing if the underlying zfs zvol or snapshot is removed or unavailable. [ QSTOR-10086 ]

Upgrade Manager and Installer
* Added a --password option to the qs\_install.sh script to allow users to provide the QuantaStor admin user password as well as the same password for the default qadmin shell account. [ QSTOR-10085 ]

Web Manager
* Clear the replica summary graph when there are no report entries. [ QSTOR-10057 ]
* Fix enclosure graph rendering issue where a selected system with multiple valid controllers was not being render because of one underlying MD BOOT Controller. [ QSTOR-10055 ]

= Archived Change Logs =

== [[Change Log Archive 2023]] ==

== [[Change Log Archive 2022]] ==

== [[Change Log Archive 2021]] ==

== [[Change Log Archive 2020]] ==

== [[Change Log Archive 2019]] ==

== [[Change Log Archive 2018]] ==

== [[Change Log Archive|Change Log Archive pre-2018]] ==

Select the link above to see the [[Change Log Archive]] of older revisions.

NVMe-oF Target Configuration

2026-08-18T14:54:52Z

Qadmin:

= NVMe-oF Target Configuration =

QuantaStor can present Storage Volumes over NVMe over Fabrics (NVMe-oF) in addition to iSCSI, Fibre Channel, and CephRBD. NVMe-oF carries the NVMe command set across the network fabric instead of translating through SCSI, giving lower command overhead and deeper queueing than iSCSI on the same media. It is available on both scale-up (ZFS) and scale-out (Ceph) pools.

== Transports ==

* '''NVMe/TCP''' — works over any standard Ethernet fabric, no special NIC required.
* '''NVMe/RDMA (RoCE v2)''' — requires RoCE-capable NICs on both target and initiator, and a lossless fabric with Priority Flow Control (PFC) and Explicit Congestion Notification (ECN) enabled end to end. Recommended for latency-sensitive block workloads.

== How targets are modeled ==

Each Storage Volume exposed over NVMe-oF gets its own NVMe subsystem, identified by an NQN, the same way it gets an IQN when exposed over iSCSI. Host access is controlled per volume by initiator NQN, directly analogous to iSCSI initiator ACLs, see [[Storage Volumes#Managing Host Initiators|Managing Host Initiators]].

== Enabling NVMe-oF on a target port ==

NVMe-oF is enabled per network port rather than configured as a separate target type.

Via the Web UI: '''Storage Management''' > select the storage system > '''Network Ports''' tab > select the port > '''Modify'''. Check "NVMeoF Portal" (the Network Ports list shows this same setting as an "NVMeoF TCP" column, same flag, inconsistent label).

[[File:nvmeof-ports-list.png|frameless|900px|Network Ports list, iSCSI and NVMeoF TCP columns per port]]



The dialog also has a "Lossless Networking" checkbox, this is the RDMA/RoCE toggle, it's only selectable when the NIC actually supports it, greyed out otherwise.

[[File:nvmeof-modify-dialog.png|frameless|500px|Modify Network Port dialog, showing the NVMeoF Portal and Lossless Networking checkboxes]]



Via CLI:
qs target-port-modify --port <port> --nvmeof-enable true

The same option is available when creating a floating service VIF or an HA failover interface, so an NVMe-oF-enabled target can be made highly available the same way an iSCSI target is.

== Connecting an initiator ==

Standard NVMe-oF host tooling applies (Linux nvme-cli, VMware NVMe-oF adapter, etc.). Discover and connect using the target's NQN and portal address as you would for any NVMe-oF target; QuantaStor does not require a proprietary initiator.

== See also ==

* [[Storage Volumes]]
* [[Network Shares]]

File:Nvmeof-modify-dialog.png

2026-08-18T14:50:43Z

Qadmin:

File:Nvmeof-ports-list.png

2026-08-18T14:50:17Z

Qadmin:

NVMe-oF Target Configuration

2026-08-18T14:48:20Z

Qadmin:

= NVMe-oF Target Configuration =

QuantaStor can present Storage Volumes over NVMe over Fabrics (NVMe-oF) in addition to iSCSI, Fibre Channel, and CephRBD. NVMe-oF carries the NVMe command set across the network fabric instead of translating through SCSI, giving lower command overhead and deeper queueing than iSCSI on the same media. It is available on both scale-up (ZFS) and scale-out (Ceph) pools.

== Transports ==

* '''NVMe/TCP''' — works over any standard Ethernet fabric, no special NIC required.
* '''NVMe/RDMA (RoCE v2)''' — requires RoCE-capable NICs on both target and initiator, and a lossless fabric with Priority Flow Control (PFC) and Explicit Congestion Notification (ECN) enabled end to end. Recommended for latency-sensitive block workloads.

== How targets are modeled ==

Each Storage Volume exposed over NVMe-oF gets its own NVMe subsystem, identified by an NQN, the same way it gets an IQN when exposed over iSCSI. Host access is controlled per volume by initiator NQN, directly analogous to iSCSI initiator ACLs, see [[Storage Volumes#Managing Host Initiators|Managing Host Initiators]].

== Enabling NVMe-oF on a target port ==

NVMe-oF is enabled per network port rather than configured as a separate target type.

Via the Web UI: '''Storage Management''' > select the storage system > '''Network Ports''' tab > select the port > '''Modify'''. Check "NVMeoF Portal" (the Network Ports list shows this same setting as an "NVMeoF TCP" column, same flag, inconsistent label).

[[File:nvmeof-ports-list.png|thumb|400px|Network Ports list, iSCSI and NVMeoF TCP columns per port]]



The dialog also has a "Lossless Networking" checkbox, this is the RDMA/RoCE toggle, it's only selectable when the NIC actually supports it, greyed out otherwise.

[[File:nvmeof-modify-dialog.png|thumb|400px|Modify Network Port dialog, showing the NVMeoF Portal and Lossless Networking checkboxes]]



Via CLI:
qs target-port-modify --port <port> --nvmeof-enable true

The same option is available when creating a floating service VIF or an HA failover interface, so an NVMe-oF-enabled target can be made highly available the same way an iSCSI target is.

== Connecting an initiator ==

Standard NVMe-oF host tooling applies (Linux nvme-cli, VMware NVMe-oF adapter, etc.). Discover and connect using the target's NQN and portal address as you would for any NVMe-oF target; QuantaStor does not require a proprietary initiator.

== See also ==

* [[Storage Volumes]]
* [[Network Shares]]

NVMe-oF Target Configuration

2026-08-18T13:57:14Z

Qadmin: Created page with "= NVMe-oF Target Configuration = QuantaStor can present Storage Volumes over NVMe over Fabrics (NVMe-oF) in addition to iSCSI, Fibre Channel, and CephRBD. NVMe-oF carries the NVMe command set across the network fabric instead of translating through SCSI, giving lower command overhead and deeper queueing than iSCSI on the same media. It is available on both scale-up (ZFS) and scale-out (Ceph) pools. == Transports == * '''NVMe/TCP''' — works over any standard Ethernet..."

= NVMe-oF Target Configuration =

QuantaStor can present Storage Volumes over NVMe over Fabrics (NVMe-oF) in addition to iSCSI, Fibre Channel, and CephRBD. NVMe-oF carries the NVMe command set across the network fabric instead of translating through SCSI, giving lower command overhead and deeper queueing than iSCSI on the same media. It is available on both scale-up (ZFS) and scale-out (Ceph) pools.

== Transports ==

* '''NVMe/TCP''' — works over any standard Ethernet fabric, no special NIC required.
* '''NVMe/RDMA (RoCE v2)''' — requires RoCE-capable NICs on both target and initiator, and a lossless fabric with Priority Flow Control (PFC) and Explicit Congestion Notification (ECN) enabled end to end. Recommended for latency-sensitive block workloads.

== How targets are modeled ==

Each Storage Volume exposed over NVMe-oF gets its own NVMe subsystem, identified by an NQN, the same way it gets an IQN when exposed over iSCSI. Host access is controlled per volume by initiator NQN, directly analogous to iSCSI initiator ACLs, see [[Storage Volumes#Managing Host Initiators|Managing Host Initiators]].

== Enabling NVMe-oF on a target port ==

NVMe-oF is enabled per network port rather than configured as a separate target type.

Via the Web UI: '''Storage Management''' > select the storage system > '''Network Ports''' tab > select the port > '''Modify'''. Check "NVMeoF Portal" (the Network Ports list shows this same setting as an "NVMeoF TCP" column, same flag, inconsistent label).

[[File:nvmeof-ports-list.png|thumb|400px|Network Ports list, showing the iSCSI and NVMeoF TCP columns per port]]



The dialog also has a "Lossless Networking" checkbox, this is the RDMA/RoCE toggle, it's only selectable when the NIC actually supports it, greyed out otherwise.

[[File:nvmeof-modify-dialog.png|thumb|400px|Modify Network Port dialog, showing the NVMeoF Portal and Lossless Networking checkboxes]]



Via CLI:
qs target-port-modify --port <port> --nvmeof-enable true

The same option is available when creating a floating service VIF or an HA failover interface, so an NVMe-oF-enabled target can be made highly available the same way an iSCSI target is.

== Connecting an initiator ==

Standard NVMe-oF host tooling applies (Linux nvme-cli, VMware NVMe-oF adapter, etc.). Discover and connect using the target's NQN and portal address as you would for any NVMe-oF target; QuantaStor does not require a proprietary initiator.

== See also ==

* [[Storage Volumes]]
* [[Network Shares]]

== Changes needed on the Storage Volumes page ==

See the separate "Storage Volumes Full Page Corrected" doc for the exact, ready-to-paste page text with both edits already applied, and "Storage Volumes Wiki Edits" for the explanation of what changed and why. Not repeated here to avoid two slightly different copies of the same instructions drifting apart. Short version: the existing "Managing Host Initiators" section gets one word turned into a link, and a new "NVMe-oF Access" subsection (three equals signs, matching its siblings) gets inserted right after it, before "Managing Host Initiator Groups".

Storage Volumes

2026-08-18T13:56:44Z

Qadmin:

[[Category:admin_guide]]

== Storage Volume (SAN) Management ==
Each storage volume is a unique block device/target (a.k.a a 'LUN' as it is often referred to in the storage industry) which can be accessed via iSCSI, Fibre Channel, or Infiniband/SRP. A ''storage volume'' is essentially a virtual disk drive on the network (the SAN) that you can assign to any host in your environment. Storage volumes are provisioned from a ''storage pool'' so you must first create a ''storage pool'' before you can start provisioning volumes.

=== Creating Storage Volumes ===
[[File:Storage Volume - Before.jpg|712px|thumb|Create a Storage Volume.]]
Storage volumes may be provisioned with a ''% Reserved'' which indicates the amount of pre-reserved storage assigned to the volume. Since ''% Reserved'' provisioning is simply a reservation it can be adjusted at any time using the ''Modify Storage Volume'' dialog via the right-click pop-up menu after selecting a given volume. Choosing % Reserved provisioning has very little to no impact on the overall performance of the storage volume so the default mode and recommended mode is to use less provisioning.

==== Advanced Volume Settings ====

Volumes may be customized via the Create and Modify Volume dialogs to set a number of advanced settings including CHAP settings, and access mode settings.

===== Batch Create =====

To create a large number of volumes all at once select a batch count greater than one. Batch created volumes will be named with a numbered suffix increasing from ".000", ".001", ".002" and so on. If a given suffix number is taken it will automatically be skipped.

===== Volume Access Mode =====
By default volumes are all read-write including storage volume snapshots. Read-only mode is useful for volumes that will be used as a template for cloning to produce new volumes from a common image to ensure that the template is not changed.

===== Volume Block Size =====
The block size selection is only available at the time the volume is created and cannot be adjusted afterwards. In the ''Advanced Settings...''' section one will see that the Block Size is set to ''Auto'' by default. In the ''Auto'' mode the block size for the storage volume will be set to 64K by default which is optimal for most hypervisors including VMware.

=== Delete & Multi-Delete Storage Volumes ===

[[File:Delete Storage Volume - Web.jpg|512px|thumb|Delete the Storage Volume.]]

There are two dialogs for deleting storage volumes, one for deleting individual volumes and one for deleting volumes in bulk which is especially useful for deleting snapshots. Pressing the "Delete Volumes" button in the ribbon bar will be presented the multiple ''Delete Storage Volumes'' dialog whereas right-clicking on a specific volume in the tree view will present one with the ''Delete Volume...'' option from the pop-up menu for single volume deletion. The multi-volume delete dialog also has a ''Search'' button so that volumes can be selected based on a partial name match. WARNING: Once a storage volume is deleted all the data is destroyed so use caution when deleting storage volumes.

=== Quality of Service (QoS) Controls ===

When QuantaStor systems are in a shared or multi-tenancy environment it is important to be able to limit the maximum read and write bandwidth allowed for specific storage volumes so that a given user or application cannot unfairly consume an excessive amount of the storage system's available bandwidth. This bandwidth limiting feature is often referred to as '''Q'''uality '''o'''f '''S'''ervice (QoS) controls which limit the maximum throughput for reads and writes to ensure a reliable and predictable QoS for all applications and users of a given system . Once you've setup QoS controls on a given Storage Volume settings will be visible in the main center table.

[[File:Quality of Service - Web.jpg|712px]]

To see the columns for Quality of Service, left mouse click on the column arrow as in the image below. Mouse over the Columns to see the possible columns for display. Check "QoS Policy", "QoS Max Read/'s", and "QoS Max Write/'s" to see the Quality of Service columns.

[[File:Column Set for QoS - Web.jpg|1024px]]

==== QoS Support Requirements ====
* System must be running QuantaStor v3.16 or newer
* QoS controls can only be applied to Storage Volumes (not Network Shares)
* Storage Volume must be in a ZFS or Ceph based Storage Pool in order to adjust QoS controls for it

==== QoS Policies ====
QoS levels may also be set by policy. QoS Policies makes it easy to adjust QoS settings for a given group of Storage Volumes across the storage grid in a single operation. To create a QoS Policy using the QuantaStor CLI run the following command with the MB/sec settings adjusted as required.

qs qos-policy-create high-performance --bw-read=300MB --bw-write=300MB

Policies may be adjusted at any time and the changes will be immediately applied to all Storage Volumes associated with the given QoS policy.

qs qos-policy-create high-performance --bw-read=400MB --bw-write=400MB

QoS Policies may also be used to dynamically increase or decrease the maximum throughput for Storage Volumes at certain hours of the day where storage I/O loads are expected to be lower or higher.

Note: QoS settings applied to a specific Storage Volume clear any QoS policy setting associated with the Storage Volume. The reverse is also true, if you have a specific QoS setting for a Storage Volume (eg: 200MB/sec reads, 100MB/sec writes) and then you apply a QoS policy to the volume, the limits set in the policy will clear the Storage Volume specific settings.

=== Resizing Storage Volumes ===

QuantaStor supports increasing the size of storage volumes but due to the high probability of data-loss that would come from truncation of the end of a disk QuantaStor does not support shrink. To resize a volume simply right-click on it then choose ''Resize Volume...'' from the pop-up menu. After the resize is complete a signal is sent to the connected iSCSI and FC initiator sessions to let the client hosts know that the block device has been resized. Some operating systems will detect the new size automatically, others will require a device rescan to detect the new expanded size. In most cases additional steps are required in the host OS to expand partitions or other volume settings adjusted to make use of the additional space.

=== Creating Storage Volume Snapshots (Snap-Clones) ===

QuantaStor supports creation of snapshots and even snapshots of snapshots. Snapshots are R/W by default and read-only snapshots are also supported. QuantaStor uses what we call a ''lazy cloning'' technique where the underlying clone to make a snapshot writable is not done until the snapshot has been assigned to a host. Most snapshots are created by a schedule and then deleted without ever being accessed, so the ''lazy cloning'' technique boosts the performance and scalability of the ''Snapshot Schedules'' and ''Remote Replication'' system.

All Storage Volume snapshots are 'thin provisioned', that is they are a copy of the meta-data associated with the original volume and not a full copy of all the data blocks. To create a snapshot or a batch of snapshots you'll want to select the Storage Volume that you which to snap, right-click on it and choose 'Snapshot Storage Volume...' from the menu. If you do not supply a name then QuantaStor will automatically choose a name for you by appending the suffix "_snap" to the end of the original's volume name. So if you have a storage volume named 'vol1' and you create a snapshot of it, you'll have a snapshot named 'vol1_snap000'. If you create many snapshots then the system will increment the number at the end so that each snapshot has a unique name.

We recommend setting up a Snapshot Schedule so as to have rollback capabilities and some protection against ransomware. Snapshot Schedules have 'Long Term Retention Rules' to preserve snapshots for multiple months and/or quarters providing rollback and data recovery that is ideally prior to an attack in such a scenario.

=== Creating Storage Volume Clones ===

Clones represent complete copies of the data blocks in the original storage volume, and a clone can be created in any storage pool in your storage system whereas a snapshot can only be created within the same storage pool as the original. You can create a clone at any time and while the source volume is in use because QuantaStor creates a temporary snapshot in the background to facilitate the clone process. The temporary snapshot is automatically deleted once the clone operation completes. Note also that you cannot use a cloned storage volume until the data copy completes. You can monitor the progress of the cloning by looking at the Task bar at the bottom of the QuantaStor Manager screen. (Note: In contrast to clones (complete copies), snapshots are created near instantly and do not involve data movement so you can use them immediately. Named snapshots are read/write by default.)

=== Restoring from Snapshots ===

If you've accidentally lost some data by inadvertently deleting files in one of your storage volumes, you can recover your data quickly and easily using the 'Restore Storage Volume' operation. To restore your original storage volume to a previous point in time, first select the original, the right-click on it and choose "Restore Storage Volume..." from the pop-up menu. When the dialog appears you will be presented with all the snapshots of that original from which you can recover from. Just select the snapshot that you want to restore to and press "Ok". Note that you cannot have any active sessions to the original or the snapshot storage volume when you restore, if you do you'll get an error. This is to prevent the restore from taking place while the OS has the volume in use or mounted as this will lead to data corruption.
<pre>
WARNING: When you restore, the data in the original is replaced with the data in
the snapshot. As such, there's a possibility of loosing data as everything that
was written to the original since the time the snapshot was created will be lost.
Remember, you can always create a snapshot of the original before you restore it
to a previous point-in-time snapshot.
</pre>

=== Managing Host Initiators ===

Hosts represent the client computers that one may assign Storage Volumes to. In FC/SCSI terminology the host systems are ''initiate'' the communication with your storage volumes (target devices) and so they are called '''initiators'''. Each Host entry may have one or more initiators associated with it. These can be one or more [[NVMe-oF Target Configuration|NVMeoF]], iSCSI and/or FC initiators per Host.

=== NVMe-oF Access ===

Storage Volumes can also be presented over NVMe over Fabrics (NVMe-oF) as an alternative to iSCSI or Fibre Channel. NVMe-oF is enabled per network port and supports both TCP and RDMA (RoCE v2) transports. Each volume gets its own NVMe subsystem (NQN) the same way it gets an IQN for iSCSI, and host access uses the same initiator-based model described above.

See [[NVMe-oF Target Configuration]] for how to enable it on a target port and connect a host.

=== Managing Host Initiator Groups ===

When multiple Host entries comprise a cluster (eg VMware, HyperV) we recommend making a Host Group to combine them. This way Storage Volumes may be assigned to the Host Group and that will provide access to the Storage Volume to all Hosts in the Host Group. When additional Hosts are added to a Host Group they'll automatically be assigned access to all Storage Volumes in the Host Group. This greatly simplifies Storage Volume assignment and management.

=== Disk Migration / LUN Copy to Storage Volume ===
[[File:Physical Disk Data Copy - Web.jpg|512px|thumb|Migrate or Copy Physical Disk Data.]]

'''Navigation:''' Storage Management --> Physical Disks --> Physical Disk --> Copy ''(toolbar)''

Migrating LUNs (iSCSI and FC block storage) from legacy systems can be time consuming and potentially error prone as it generally involves mapping the new storage and the old storage to a host, ensuring the the newly allocated LUN is equal to or larger than the old LUN and then the data makes two hops from Legacy SAN -> host -> New SAN so it uses more network bandwidth and can take more time.

QuantaStor has a built-in data migration feature to help make this process easier and faster. If your legacy SAN is FC based then you'll need to put a Emulex or Qlogic FC adapter into your QuantaStor system and will need to make sure that it is in initiator mode. Using the WWPN of this FC initiator you'll then setup the zoning in the switch and the storage access in the legacy SAN so that the QuantaStor system can connect directly to the storage in the legacy SAN with no host in-between. Once you've assign some storage from the legacy SAN to the QuantaStor system's initiator WWPN you'll need to do a 'Scan for Disks' in the QuantaStor system and you will then see your LUNs appear from the legacy SAN (they will appear with devices names like sdd, sde, sdf, sdg, etc).
To copy a LUN to the QuantaStor system right-click on the disk device and choose 'Copy Disk...' from the pop-up menu.

You will see a dialog like the one above and it will show the details of the source device to be copied on the left. On the right it shows the destination information which will be one of the storage pools on the system where the LUN is connected. Enter the name for the new storage volume to be allocated which will be the destination for the copy. A new storage volume will be allocated with that name which is exactly the same size as the source volume. It will then copy all the blocks of the source LUN to the new destination Storage Volume.

=== 3rd Party Volume Data Migration via iSCSI ===
QuantaStor includes iSCSI Software Adapter support so that one can directly connect to and access iSCSI LUNs from a SAN without having to use the CLI commands outlined below. The option to create a new iSCSI Software Adapter is in the Hardware Enclosures & Controllers section within the web management interface.

The process for copying a LUN via iSCSI is similar to that for FC except that iSCSI requires an initiator login from QuantaStor system to the remote iSCSI SAN to initially establish access to the remote LUN(s). This can be done via the QuantaStor console/SSH using the qs-util iscsiinstall', 'qs-util iscsiiqn', and 'qs-util iscsilogin' commands. Here's the step-by-step process:

<code>sudo qs-util iscsiinstall</code>

This command will install the iSCSI initiator software (open-iscsi).

<code>sudo qs-util iscsiiqn</code>

This command will show you the iSCSI IQN for the QuantaStor system . You'll need to assign the LUNs in the legacy SAN that you want to copy over to your QuantaStor system to this IQN. If your legacy SAN supports snapshots it's a good idea to assign a snapshot LUN to the QuantaStor system so that the data isn't changing during the copy.

<code>sudo qs-util iscsilogin 10.10.10.10</code>

In the command above, replace the example 10.10.10.10 IP address with the IP address of the legacy SAN which has the LUNs you're going to migrate over. Alternatively, you can use the iscsiadm command line utility directly to do this step. There are several of these iscsi helper commands, type 'qs-util' for a full listing.
Once you've logged into the devices you'll see information about the devices by running the 'cat /proc/scsi/scsi' command or just go back to the QuantaStor web management interface and use the 'Scan for Disks' command to make the disks appear. Once they appear in the 'Physical Disks' section you can right-click on them and to do a 'Migrate Disk...' operation.

=== 3rd Party Volume Data Migration via Fibre Channel ===
Note that for FC data migration one may use either a Qlogic or a Emulex FC HBA in initiator mode but QuantaStor only supports Qlogic QLE24xx/25xx/26xx series cards in FC Target mode. One may also use OEM versions of the Qlogic QLE series cards. It is best to use Qlogic cards as they may be used in both initiator and target mode. FC mode is switched in the ''Fibre Channel'' section by right-clicking on a given port and then selecting ''FC Port Enable (Target Mode)..'' or ''FC Port Disable (Initiator Mode)..''.

=== Managing FC/iSCSI Sessions ===
[[File:Drop Session - Web.jpg|512px|thumb|Drop an iSCSI session.]]

A list of active FC and iSCSI sessions for a given volume can be found by selecting the ''Storage Volume'' in the tree section and then select the 'Sessions' tab. The ''Sessions'' tab shows both active FC and iSCSI session information. To drop an iSCSI session simply right-click on a session in the table and choose ''Drop Session...'' from the pop-up menu.

''Note: Some initiators will automatically re-establish a new iSCSI session if one is dropped by the storage system. To prevent this, unassign the ''Storage Volume'' from assigned ''Host'' or ''Host Group'' so that the host may not automatically re-login.''

QuantaStor 6.8.4 Upgrade Instructions

2026-08-13T11:31:52Z

Qadmin: Create QuantaStor 6.8.4 Upgrade Instructions

= Upgrading to 6.8.4, and Latest OS Packages and Security updates via Command Line Interface =

'''This is the recommended option for systems running 6.x QuantaStor versions on the Focal Platform, and systems that may be out of date and require OS level package updates as well.'''

This procedure will upgrade the QuantaStor system to the latest software version, and also update all OS level packages to their latest versions as well, ensuring the system software has the latest security patches in place.

It is recommended that you schedule a downtime work window, as a reboot may be required for changes in the 6.8.4 upgrade. You will need to run these commands as a user with sudo access on the QuantaStor appliance, such as the default 'qadmin' account, or as root if you have enabled direct root access.

:''NOTE: We recommend allocating a maintenance window for all upgrades. For more complex upgrades we recommend scheduling time with OSNEXUS support for assistance.''

'''Login to the CLI to perform a full upgrade to QuantaStor 6.8.4 along with the latest Kernel and Security and OS packages.'''

<pre>
# For Noble platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-noble/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Jammy platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-jammy/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Focal platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-focal/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true
</pre>

Once the install completes you will be running QuantaStor 6.8.4

'''Platform Upgrades from Jammy to Noble via the qs-distupgrade command are enabled with the 6.8.0 release.'''

'''Platform Upgrades from Focal to Jammy via the qs-distupgrade command are enabled with the 6.5.1 release.'''

'''Platform Upgrades from Bionic to Focal via the qs-distupgrade command are enabled with the 6.0.4 release.

'''Platform Upgrades from Xenial to Bionic via the qs-distupgrade command are enabled with the 5.10.2 release.

'''OSNEXUS Support recommend fully upgrading to the latest available, including System and Kernel Updates using the commands above. Please contact Support for assistance with a platform upgrade.'''

'''Platform Upgrades via the qs-distupgrade command from QuantStor 4.x on Trusty are enabled with the 4.7.2 release. '''

'''Please contact support@osnexus.com if you have any questions or need upgrade assistance.

QuantaStor Version ChangeLog

2026-08-13T11:31:40Z

Qadmin: Add v6.8.4.038 release notes; drop duplicate QSTOR-11803 bullet from v6.8.0.205

[[Category:Support guide]]
= Change Log Overview =
The change log contains a detailed summary of the changes made for each new release of QuantaStor. Each change made to QuantaStor is tracked with an engineering ticket number in the form '''[QSTOR-NNNN]'''. This information is provided so that if you're working with OSNexus support you can track the availability of a given product feature add, improvement, or maintenance fix to a specific release. For information on how to upgrade your storage system please see the [[QuantaStor Upgrade Guide|Upgrade Guide]].

== Versioning System ==
QuantaStor version numbers consist of four (4) parts. A major number (M), minor number (N), maintenance update number (U) and build number (B) of the form M.N.U.B such as 6.0.2.006.

QuantaStor upgrades go directly from whatever version you are running to the latest version, with no interim steps so for example if you are at v6.0.1 you will upgrade directly to the latest version which may be v6.1.2

== Product Update Types ==

==== Major Updates (X.y.z) ====
If the first digit in the version number has changed this indicates a major product release such as QuantaStor v5 to QuantaStor v6. Major releases generally come with a new underlying Linux platform as the basis. For example, the standard ISO install for QuantaStor v5 is based on Ubuntu 18.04 whereas QuantaStor v6 is based on Ubuntu 20.04. Major product releases generally include new features and maintenance updates and are supported on multiple underlying Linux platforms. For example, QuantaStor v6 is available as an upgrade on Ubuntu 18.04 and Ubuntu 20.04 based systems as well as RHEL and RHEL derivative platforms. Platform upgrades to move systems forward (eg 18.04 to 20.04) are made generally available in the first feature update release, such as QuantaStor 6.1.

==== Feature Updates (x.Y.z) ====
If the second digit in the version number has changed this indicates a feature release such as 6.'''1''' going to 6.'''2'''. Feature releases add new product features as well as a maintenance updates. No additional licensing is required to access any new features that added but note that QuantaStor licenses do not include licenses for 3rd party products and services that may integrate with QuantaStor.

==== Maintenance Updates (x.y.Z) ====
If the third digit of the version number has changed this such as 6.0.'''2''' or 6.0.'''3''' it represents a maintenance update to address one or more support tickets. These updates generally do not contain new features, only fixes to address specific issues. Maintenance releases generally ship every 4 to 8 weeks. All maintenance "aka hot-fix" releases are provided against the current stable release so upgrading to the latest QuantaStor version is generally required to apply them.

==== Build Number (x.y.z.BBB) ====
The build number and corresponding build reference hash can be largely ignored. The build number simply increments with each commit that is made to the source tree. The hash is provided to make it easier for OSNEXUS support and engineering to quickly confirm difference between your current running release and any more modern release.

== Boot Install Image and other downloads ==
=== ISO/DVD/USB Boot Install Image ===

* The latest version of QuantaStor can be found on our [https://downloads.osnexus.com downloads page here].

* [[QuantaStor Installation via USB Thumb Drive|Bootable Flash Drive instructions.]]

NOTE: Archived older versions of QuantaStor ISO install media and CLI tools can be found [https://downloads.osnexus.com.s3.us-east-1.amazonaws.com/list.html here].

= Recent Change Logs =

== v6.8.4.038 (August 13th 2026) ==

=== [[QuantaStor 6.8.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.4 Upgrade Instructions | upgrading to QuantaStor v6.8.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the Ceph Cluster Coordinator role could become stuck on one node. The automatic fallback election methods (grid-primary, site-primary, mon-rank) were not taking effect, so when no designated coordinator was set, coordinatorship never moved (e.g. after changing the grid master). Automatic coordinator election now works correctly; explicitly designated coordinators were unaffected. [ QSTOR-12194 ]

Dashboards and Analytics
* Fixed the Ceph RGW dashboard on Ceph Tentacle so it correctly reports throughput/latency when transferring files to a bucket. [ QSTOR-11803 ]

High Availability Failover
* Fixed the script to set the device reservation ability on WD Openflex Data24 [ QSTOR-12117 ]
* Fixed site cluster heartbeat rings so each ring keeps its own network address and member list. Previously the rings of a multi-ring site collapsed into a single entry with no subnet shown. [ QSTOR-12159 ]

Network Shares
* Adds an explicit domain controller to the GSSAPI ldapsearch for Active Directory user and group lookups, fixing intermittent failures on multi-controller domains. Domain joins also wait longer for a busy controller. [ QSTOR-11939 ]
* Added a cleanup-only mode to the Active Directory leave operation that reverts the local domain configuration without contacting the domain controller, for recovering from a failed or partial leave. [ QSTOR-12058 ]
* Fixed: SMB/DFS network share namespace referrals now advertise all of an appliance's reachable addresses rather than just one, so clients on any subnet can reach the share. [ QSTOR-12107 ]
* Fixed per-user share permissions so an existing entry with no recorded read/write/execute setting is treated as full access rather than no access. Modifying a share no longer rewrites ACLs when no permission actually changed. [ QSTOR-12113 ]
* Fixed Active Directory joins in SSSD-only mode against Windows Server 2025 domain controllers, which previously failed to set the machine account password. [ QSTOR-12141 ]
* Fixed placeholder values such as None, null or undefined sent by API clients being written into the Samba configuration, which stopped Samba loading the file and took SMB access down for every share on the node. [ QSTOR-12152 ]
* Fixed the Active Directory leave hanging when the PDC Emulator is offline. The leave now completes within a bounded timeout and reverts the local configuration. [ QSTOR-12161 ]

== v6.8.3.018 (August 6th 2026) ==

=== [[QuantaStor 6.8.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.3 Upgrade Instructions | upgrading to QuantaStor v6.8.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Creating or removing a Ceph object storage class now commits the RGW period so it takes effect immediately. [ QSTOR-11938 ]
* A failed bucket enumeration is no longer treated as an empty list, which could silently drop bucket configuration. [ QSTOR-12130 ]
* Ceph object pool group creation now commits the RGW period, fixing persistent RGW realm/master-zone errors. [ QSTOR-12132 ]

Network Shares
* Fixed Active Directory join failures on domains that use older Kerberos encryption methods. [ QSTOR-11646 ]
* Changed: Active Directory joins now set 'restrict anonymous = 2' in smb.conf to block unauthenticated SID/RID enumeration. [ QSTOR-11834 ]
* Fixed: Active Directory joins no longer fail when the computer-account OU contains a space. [ QSTOR-11895 ]
* Fixed: Active Directory joins no longer disable SASL signing in the system-wide ldap.conf. [ QSTOR-11926 ]
* Added a 'Skip DNS registration' option to the Active Directory join dialog, CLI and API for sites whose DNS is managed outside AD. [ QSTOR-12083 ]
* Fixed a custom autorid Domain Range Size being discarded during an Active Directory join. [ QSTOR-12089 ]
* The Active Directory KDC field now accepts a comma-separated list of domain controllers for Kerberos failover. [ QSTOR-12091 ]
* Active Directory joins in SSSD modes no longer force user/group enumeration, which could stall startup on large domains. [ QSTOR-12092 ]
* Fixed: Active Directory joins now send the machine-account password update to the PDC Emulator, fixing 'Message stream modified' failures. [ QSTOR-12136 ]
* Fixed: leaving an Active Directory domain now updates the web UI immediately instead of still showing the old domain. [ QSTOR-12153 ]
* Changed: the Active Directory join dialog now labels its two ID-range sections distinctly so it's clear which is being edited. [ QSTOR-12154 ]

Service Core
* Memory optimization for grid event handling. [ QSTOR-12112 ]

Upgrade Manager and Installer
* The upgrade system now fetches and verifies the latest OSNEXUS package signing key before applying updates. [ QSTOR-9551 ]
* Fixed EL8 upgrades pinning a stale awscli/qstoraws package version from the RedHat repository. [ QSTOR-11991 ]
* In-place Ceph upgrades now install the shipped Ceph 20.2.2 release instead of an older pinned version. [ QSTOR-11998 ]
* Fixed a grafana-enterprise package upgrade failure that could leave dpkg in a held state during upgrades from 6.8.1. [ QSTOR-12075 ]
* Updated the Ubuntu 24.04 upgrade configuration to the shipped kernel and Ceph 20.2.2 versions. [ QSTOR-12077 ]

== v6.8.2.002 (July 24th 2026) ==

=== [[QuantaStor 6.8.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.2 Upgrade Instructions | upgrading to QuantaStor v6.8.2]].

=== Release Notes ===

Network Shares
* Fixed: AD groups could not be added to a Network Share ACL in Winbind+SSSD mode (group@DOMAIN form could not be resolved). [ QSTOR-12025 ]

== v6.8.1.007 (July 18th 2026) ==

=== [[QuantaStor 6.8.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.1 Upgrade Instructions | upgrading to QuantaStor v6.8.1]].

=== Release Notes ===

Upgrade Manager and Installer
* Fixed: platform upgrades remove the obsolete linux-tools-common package that could trigger security alerts. [ QSTOR-10314 ]
* Changed: qs-distupgrade output is timestamped and includes a pre-upgrade configuration report. [ QSTOR-11632 ]
* Added: platform distribution upgrade (qs-distupgrade) from Ubuntu 22.04 to 24.04. [ QSTOR-11651 ]
* Added: non-interactive flags for qs-distupgrade enabling fully unattended platform upgrades with automatic reboot. Use the qs-distupgrade --help to review the available usage options. [ QSTOR-11918 ]
* Fixed: platform distribution upgrades keep Ceph pinned at its current version. [ QSTOR-11955 ]
* Added: qs-distupgrade requires all Ceph nodes on the latest offered Ceph version (--skip-check-ceph-latest to override). [ QSTOR-11958 ]
* Fixed: coordinated Ceph upgrades restart all RGW daemons on hosts running multiple RGW services. [ QSTOR-11983 ]
* Fixed: a 6.8.0-only issue where service-driven package upgrades reported success without installing anything. [ QSTOR-11992 ]

== v6.8.0.205 (July 8th 2026) ==

=== [[QuantaStor 6.8.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.0 Upgrade Instructions | upgrading to QuantaStor v6.8.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert webhook support for Google Chat. [ QSTOR-9793 ]
* Allow users to have a subset of alert subscriptions. [ QSTOR-11683 ]

Ceph Scale-out Block, Object and File
* Added an 'Enable Versioning' checkbox to the Create Bucket dialog (automatically enabled when object locking or governance/compliance is selected); versioning can also be enabled on existing buckets. [ QSTOR-10937 ]
* Added Ceph Tentacle 20.2.2 support to the Jammy QuantaStor ISO and package mirror. [ QSTOR-11441 ]
* QuantaStor 6.8 ships Ceph 20.2.2 (Tentacle), which includes the upstream MDS fix (tracker #76031) for the SIGABRT/crash on client eviction caused by a null MDRequestRef under sustained metadata contention. [ QSTOR-11504 ]
* The Ceph Tentacle 20.2.2 release resolves frequent radosgw (RGW) crashes related to Kafka bucket notifications. [ QSTOR-11687 ]
* Fix ceph bucket delete with large number of objects timing out. [ QSTOR-11728 ]
* Removed: the deprecated S3 bucket orphan-object cleanup feature; any existing scheduled task is disabled automatically on upgrade. [ QSTOR-11729 ]
* Fixed a regression where deleting multiple Ceph (RBD) volumes at once on a multi-node cluster would fail after the first volume. [ QSTOR-11756 ]
* Added support for major-version Ceph upgrades (through Tentacle 20.2.x) in the upgrade script. [ QSTOR-11762 ]
* Increase the timeout for "Add Node" to a ceph cluster [ QSTOR-11906 ]

Dashboards and Analytics
* Added: a 'qs-statsdb resetpassword' command to rotate the InfluxDB stats password; telegraf is updated in lockstep so dashboards keep working. [ QSTOR-11170 ]
* Rebuilt bundled telegraf with its vendored rclone library updated to 1.74.3, clearing CVE-2026-41176 and CVE-2026-41179. [ QSTOR-11771 ]

Enclosures and Controllers
* Fixed issue with "disappearing" enclosures [ QSTOR-11676 ]
* Added support for the Supermicro SSG-222B-NE3X24R all-NVMe server, including hardware enclosure auto-detection, enclosure layout and diagram, and NVMe drive slot mapping in the QuantaStor web management interface. [ QSTOR-11712 ]

High Availability Failover
* Add logging for manually run iofence commands [ QSTOR-11751 ]
* Fixed HA pool failover persisting a stale size=0 / isMounted=false when the pool's datasets were still mounting during fast-import; the last-known-good size and mount state are now preserved (and the corrected record wins via a bumped modified timestamp). [ QSTOR-11818 ]
* Fixed: Storage Pool HA io-fencing and failover now work over NVMe-TCP; target namespaces advertise persistent reservations. [ QSTOR-11850 ]

Kernel and Drivers
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]
* Updated the Mellanox OFED driver installer for current Ubuntu 22.04 (Jammy) kernels, fixing driver installation failures on recent kernels. [ QSTOR-11709 ]

Multitenancy
* Added RBD namespace support, allowing multiple tenants to share a single Ceph block pool with isolated volumes. [ QSTOR-11650 ]

NAS Gateway / Cloud Containers
* Add a fix for Samba access to Cloud Container shares. [ QSTOR-11763 ]
* Fixed: cloud containers are now accessible over SMB, not just NFS. [ QSTOR-11824 ]
* Updated the bundled AWS CLI to version 2.35.6. [ QSTOR-11827 ]

Network Interfaces
* Added DOCA OFED install script for jammy and upcoming noble platforms as an optional install for latest hardware. [ QSTOR-11069 ]
* Fixed the Network Interface Rename feature on systems upgraded from older releases where the 'ip' command resides in a different path. [ QSTOR-11614 ]
* Fixed: converting a local VIF to an HA VIF now preserves the original local interface if the conversion fails, so client connectivity isn't lost. [ QSTOR-11706 ]

Network Shares
* Add the ability to specify per user or group permissions on Network Shares during create or modify [ QSTOR-10662 ]
* Fixed: intermittent 'NFS server not responding' stalls under load by raising the nfsd listen backlog from 64 to 4096. [ QSTOR-10872 ]
* Fixed: NFS client entries can now be added or removed on a share while a long-running replication or snapshot task is using it, instead of queuing. [ QSTOR-11571 ]
* Consolidated the Network Share create/modify dialog's Permission Settings into the File Masks tab — now a single 'File Masks & Permission Settings' tab containing Owner Permission Settings plus the Directory and File Create Permissions Masks. [ QSTOR-11625 ]
* Reduced excessive event logging (event spam) for network shares and related grid objects. [ QSTOR-11695 ]
* Fixed handling of CIFS share options so empty/null option values are no longer written to the Samba configuration. [ QSTOR-11731 ]
* Fixed an issue where an Active Directory group added to a share's permissions was not preserved, and excluded built-in/default AD groups from the group picker. [ QSTOR-11767 ]

Remote Replication, Snapshots and Backup Policies
* Copy source Network Share settings to the destination share after replication. [ QSTOR-5738 ]
* Add support for rollback of Storage Volumes and Network Shares for a replication schedule [ QSTOR-6227 ]
* Minor updates to the auto snapshot cleanup tasks for replication schedules. [ QSTOR-11622 ]
* Fix auto create of replication association after failover [ QSTOR-11700 ]
* Snapshot schedule now shows the state detail when schedule is disabled by user. [ QSTOR-11717 ]
* The Snapshot Schedule properties page now displays Retention Tags. [ QSTOR-11719 ]
* Changed: Auto-tier backup policies now display as 'Auto-Tier >> Outbound' instead of 'Move >> Outbound'. [ QSTOR-11764 ]
* Fixed the CLI replication-schedule rollback so volume and share names are accepted (not just IDs), and rolling back only volumes (or only shares) no longer also rolls back the other type. [ QSTOR-11814 ]

SCSI / NVMe Target
* Added: a 'Select Initiator...' picker in the Add Host dialog to choose a discovered FC remote initiator WWPN instead of typing it. [ QSTOR-10741 ]
* Renamed the sys-list 'Firmware Version' column to 'SCSI Target Version' and corrected the value to show the actual SCST target-driver version (e.g. scst-3.10.0.qs01-...) instead of the literal 'scst-SCST'. [ QSTOR-11854 ]

Security
* Added support for Okta multi-factor authentication. [ QSTOR-9399 ]
* Added Multi-Admin Approval support, allowing deletion of pools, buckets, shares, and volumes to require approval from a configurable number of administrators. [ QSTOR-11344 ]
* Fixed certificate update failures when using a certificate template, and ensured dependent services (such as HAProxy and RGW) are restarted after a certificate replacement. [ QSTOR-11678 ]
* Fixed an issue in the Security Manager dialog where it was showing the "password policy change" warning confirmation when no fields were changed. [ QSTOR-11708 ]
* InfluxDB (port 8086) now requires authentication and binds to localhost by default; remote access is opt-in via the tf_influxdb_remote_access.enable touchfile (authentication still enforced). [ QSTOR-11759 ]
* Added the Ubuntu security apt repositories to the default package sources and removed unused bundled components flagged by scanning (Chronograf, the LXD/core20/snapd snaps, the docker-scan plugin), clearing CVE-2024-41110, CVE-2026-34177/-34178/-34179, CVE-2020-14343, CVE-2025-68121, and CVE-2024-45337. [ QSTOR-11760 ]
* Rebuilt the bundled QuantaStor Go tools (qs_iofence, qs_pool_export_helper, qs_diskinfo) and s5cmd with a current Go toolchain, clearing CVE-2025-68121, CVE-2024-45337, CVE-2024-24790, CVE-2023-24540, and CVE-2023-24538. [ QSTOR-11761 ]
* Hardened the internal QuantaStor script service (scriptsvc): removed a command-injection vector in request handling and now enforce the service's authorization check on every call. Addresses ZDI-CAN-30036 [ QSTOR-11799 ]
* Made a number of usability and reliability improvements to the multi-admin delete-approval workflow. [ QSTOR-11804 ]

Service Core
* Fix tag-set where custom key/value tags were not appearing for User objects. [ QSTOR-11528 ]
* Improved Ceph OSD daemon restart handling during upgrades and reduced database load on large-scale clusters. [ QSTOR-11675 ]
* Fixed an issue with QuantaStor management service memory usage when a grid node was offline. [ QSTOR-11693 ]
* Improved crash handling and diagnostic tracing for coordinated tasks, during operations such as adding a Ceph RADOS Gateway across multiple nodes. [ QSTOR-11702 ]
* Improved logging and error checking for QuantaStor configuration database backups, including capturing error output when a backup fails. [ QSTOR-11742 ]
* Expanded diagnostic log collection to capture additional network routing details (ip route output and static-route configuration). [ QSTOR-11748 ]
* Fixed the Sessions view showing stale SMB/NFS client sessions that lingered after a reboot; the share session monitor now forces a full re-sync on its first poll after startup so sessions left over from before the reboot are cleared. [ QSTOR-11757 ]
* Fixed a self-sustaining grid event flood triggered when creating CephFS/CIFS network shares at scale: nodes no longer re-cache remote-origin (sync-applied) events, and CIFS options are diff-merged to secondaries, eliminating the event resync cascade. [ QSTOR-11785 ]
* qs-sendlogs now writes a qs_logs.runtime.info file recording the options and variables used during log collection, and reliably scrubs sensitive data from the collected database. [ QSTOR-11897 ]

Storage Pool Management
* Added automated ordered-disk-list pool creation for Seagate Corvault and WD Data24 systems, simplifying creation of fully redundant storage pools. [ QSTOR-11538 ]
* Fixed software-encrypted pool creation so a disk block-size mismatch is detected before disks are encrypted, avoiding leftover encryption mappings. [ QSTOR-11599 ]
* ZFS deduplication now uses the faster fast_dedup mode by default, improving sustained deduplication performance. [ QSTOR-11714 ]
* When a LUKS-encrypted disk member of a pool momentarily goes offline and the hot-spare swap-in completes, if the "bad" disk in question has in the meantime come back online, its iofence status, encryption status and its related properties in its respective disk object are cleared up, making the disk available for use again. [ QSTOR-11738 ]
* Resolved a boot-time race where the OS-level zfs-import-cache.service could import ZFS pools before qs_service started. QuantaStor now imports pools with cachefile=none, masks the zfs-import-cache and zfs-import-scan services on install and upgrade, and clears the stale global ZFS cache file at boot, ensuring QuantaStor remains the sole coordinator of pool imports. [ QSTOR-11752 ]
* Add the ability to create a Storage Pool checkpoint for scale-up pools [ QSTOR-11784 ]
* Added a support-only, touchfile-gated pool-export triage call-out (qs_pool_export_triage.sh) that gathers diagnostics when a share or volume is still open during a storage pool export. Off by default (enabled via the tf_pool_export_triage.enable touchfile). [ QSTOR-11807 ]
* Resolved issue preventing HA failover functionality using SED drives. [ QSTOR-11832 ]

Upgrade Manager and Installer
* Added retry logic with a timeout to the Ceph upgrade script's daemon restarts so transient restart failures no longer abort the upgrade. [ QSTOR-10598 ]
* Fixed focal-to-jammy distribution upgrades leaving the HA cluster service (pcsd/pacemaker) inoperative due to a missing ruby-webrick dependency on Ruby 3.0+. The upgrade now installs ruby-webrick so HA failover keeps working. [ QSTOR-11841 ]
* Fixed focal-to-jammy distribution upgrades that could abort and roll back when Ubuntu's unattended-upgrades/apt-daily held the apt lock or needrestart blocked on a prompt. QuantaStor now disables automatic apt upgrades and runs the distribution upgrade non-interactively. [ QSTOR-11874 ]
* Fixed a Noble (24.04) upgrade failure where qs-upgrade aborted because the dpkg package version string could not be parsed. QuantaStor now compares Debian package versions using dpkg's native version ordering. [ QSTOR-11881 ]

Web Manager
* Minor fix to the "Copy to Clipboard" for task descriptions [ QSTOR-9574 ]
* Added a method field and a sortable timestamp column to the web interface Audit Log Analyzer. [ QSTOR-11191 ]
* Updated web interface translations across the major supported languages. [ QSTOR-11585 ]
* Added a 'Create Share' option to the share template menu to quickly create a share applying all of a template's settings. [ QSTOR-11595 ]
* Fixed the web interface to display all configured Ceph MDS daemons instead of limiting the list to five. [ QSTOR-11615 ]
* Add auto select convenience buttons to the Storage Volume multi-delete dialog. [ QSTOR-11707 ]

== v6.7.6.001 (June 25th 2026) ==

=== [[QuantaStor 6.7.6 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.6 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.6 Upgrade Instructions | upgrading to QuantaStor v6.7.6]].

=== Release Notes ===

Storage Pool Management
* Fixed a service crash that could occur when creating a LUKS-encrypted storage pool on NVMe devices. [ QSTOR-11876 ]

== v6.7.5.013 (May 21st 2026) ==

=== [[QuantaStor 6.7.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.5 Upgrade Instructions | upgrading to QuantaStor v6.7.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert triggers for disks with SMART medium errors. [ QSTOR-11652 ]

Ceph Scale-out Block, Object and File
* Adds new qs-cephfsutil for transparent movement of files between data pools via server-side copy [ QSTOR-11543 ]

Kernel and Drivers
* Added RedHat Platform kernel 4.18.0-553.124.1.el8_10.x86_64 support via DKMS driver build [ QSTOR-11679 ]
* Updated SCST driver to 3.10.0.qs01.9273.1b48521 with a patch that allows for dkms builds/support on non-preferred 5.15.x kernels on jammy platforms. [ QSTOR-11672 ]

Remote Replication, Snapshots and Backup Policies
* Minor fix while loading snapshots in the UI. [ QSTOR-11624 ]

Service Core
* Fixes bug where partial upgraded node would be skip daemon restart phase at version check. [ QSTOR-11703 ]
* Fixed a rare race condition where adding a Ceph Object (RADOS) Gateway on a multi-node cluster could silently crash. [ QSTOR-11689 ]
* Added defensive exception handling and trace coverage around coordinated task execution. [ QSTOR-11689 ]

Storage Pool Management
* Fix allows for creation of TRIM maintenance schedules on pools with special vdevs. [ QSTOR-11663 ]

Web Manager
* Add graphs for replication task status details. [ QSTOR-11661 ]
* Make improvements in the replication reporting area. [ QSTOR-11661 ]

== v6.7.4.011 (April 30th 2026) ==

=== [[QuantaStor 6.7.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.4 Upgrade Instructions | upgrading to QuantaStor v6.7.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Eliminated daily Ceph monitor outage on coordinator nodes caused by the mon-db backup process; the backup now uses a RocksDB compaction flush and hot-copy so the monitor service remains running throughout, and backup activity is now logged to qs_service.log. [ QSTOR-11655 ]

Enclosures and Controllers
* Fixed issue regarding hwController/hwEnclosure double discovery caused by the presence of certain Dell HBA cards that are visible to both the storcli and perccli CLI tools. [ QSTOR-11372 ]

Network Interfaces
* Fixed an issue with the allowed portals for iscsi and nvme being updated on network ports or having the settings retained on HA VIFs. [ QSTOR-11659 ]

Remote Replication, Snapshots and Backup Policies
* Improvements in the replication reports. [ QSTOR-11644 ]

Service Core
* Updated task output for storage system modify to improve clarity [ QSTOR-11660 ]
* Coordinated Task (CCT) Reliability Improvements — Fixed an issue on large or heavily-loaded Ceph clusters where CCT broadcasts could silently hang until timeout. [ QSTOR-11648 ]

Upgrade Manager and Installer
* Updated kmod and libkmod2 packages for ubuntu jammy and focal platforms to disable algif_aead and address CVE-2026-31431 [ QSTOR-11670 ]

== v6.7.3.010 (April 17th 2026) ==

=== [[QuantaStor 6.7.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.3 Upgrade Instructions | upgrading to QuantaStor v6.7.3]].

=== Release Notes ===

High Availability Failover
* Fixed an issue where Site Clusters could not be deleted in cases where the site cluster was unhealthy. For example if the Network Interfaces or IP addresses on the interface change for the heartbeat rings. Or if the site cluster corosync/pacemaker service are stopped. [ QSTOR-11631 ]
* Fixed a corner case where Site cluster vifs could start on nodes outside of the site cluster. [ QSTOR-11630 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Volume _chkpnt Replications on N-Way A>B>C replications being incorrectly named. they B>C leg should have _chkpnt.1 as the target suffix for the replication. [ QSTOR-11477 ]

Service Core
* Added further optimizations for Grid sync on large configs with many QuantaStor service objects. [ QSTOR-11628 ]

Storage Pool Management
* Fixed: SED disk Locked status is now propogated using grid logic for disks once a disk is used for Hardware encryption. Previously this required an HA group to also be on the pool. [ QSTOR-11611 ]
Fixed a corner case where SED Device Capabilities was showing as No for multipath disks plugged in twice to the same controller. [ QSTOR-11611 ]

== v6.7.2.003 (April 13th 2026) ==

=== [[QuantaStor 6.7.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.2 Upgrade Instructions | upgrading to QuantaStor v6.7.2]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue where some Enclosure objects would appear showing \[CBLERR\] when that status was incorrect. [ QSTOR-11135 ]

Network Shares
* Added a qs_global_namespace.conf file for users to provide a specific IP address to be offered for Microsoft DFS with the preferred_ip=x.x.x.x [ QSTOR-11627 ]
* Updated Jammy platform nfs-kernel-server and related nfs-utils packages to include junction support needed for NFS Referrals. [ QSTOR-11626 ]

== v6.7.1.008 (April 10th 2026) ==

=== [[QuantaStor 6.7.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.1 Upgrade Instructions | upgrading to QuantaStor v6.7.1]].

=== Release Notes ===

Network Shares
* Fix an issue with snapshot cleanup by the replication schedule. [ QSTOR-11621 ]

Security
* Upgrade the Cisco Duo library to 2.2.0 [ QSTOR-11592 ]

Upgrade Manager and Installer
* Disable and mask openzfs util zfs-shares.service which caused unexpected Share service restarts. [ QSTOR-11619 ]
* Fixed an issue with qs-distupgrade from Focal to Jammy Platforms of systems that had been originally deployed with bionic and older platforms. [ QSTOR-11616 ]
* Ensured the 6.8.0-90-generic kernel is deployed during Focal to Jammy Platform distupgrades. [ QSTOR-11616 ]

== v6.7.0.184 (April 8th 2026) ==

=== [[QuantaStor 6.7.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.0 Upgrade Instructions | upgrading to QuantaStor v6.7.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Add a 'Skip log server ping pre-checks' checkbox to the Send Support Logs dialog. The server will skip ping checks during log upload when the checkbox is checked. [ QSTOR-11397 ]
* Fixed an issue with clearing parent interface status alerts in the Health Checker System report [ QSTOR-11058 ]
* Add ability to specify reason for log uploads [ QSTOR-10479 ]

Ceph Scale-out Block, Object and File
* Fixed a QuantaStor service crash for Ceph scale-out file storage share snapshot delete [ QSTOR-11570 ]
* Adds support for new load balancer modes and customization in the /opt/osnexus/quantastor/conf/qs_loadbalancer.conf file. [ QSTOR-11502 ]
* Improved the method of tracking degraded object cleanup and reporting progress to the task objects. [ QSTOR-11292 ]
* Bug fixes in qs-s3util script when an invalid endpoint URL is provided. [ QSTOR-11292 ]
* Improved object state reporting for OSDs. [ QSTOR-11292 ]
* Fixed an issue with unlocking NVMe SED media on boot for Ceph Scale-out Cluster OSDs [ QSTOR-11118 ]
* Enabled Ceph OSD block and journal discard support [ QSTOR-10672 ]

Dashboards and Analytics
* Fixed an issue with influxdb install for qs\_upgrade\_redhat8.sh [ QSTOR-11562 ]

Disk Management
* Added logic to make SED Locking status consistent between QuantaStor Scale-Up ZFS HA Storage Pools. Note: Pools must have an HA group and HA Vif and be activated. [ QSTOR-11515 ]
* Added error counters for disks with available columns in the center grid view of the Physical Disks section. [ QSTOR-11308 ]

Enclosures and Controllers
* Added Enclosure layout support for Supermicro SSG-542B-DE1CR90 [ QSTOR-11572 ]
* This feature allows servers equipped with the Xinnor XiRAID software [ QSTOR-11374 ]

* Create a XiRAID raid unit, which appears as a QS HwUnit. [ QSTOR-11374 ]
* This HwUnit entity is surfaced in Quantastor as a physical disk drive. [ QSTOR-11374 ]
* The physical disks that are used to create the XiRaid unit are surfaced as HwDisks.[ QSTOR-11374 ]
* The creation includes a variable number of partitions on said physical disk.[ QSTOR-11374 ]
* These partitions are also surfaced as QS physical disks.[ QSTOR-11374 ]
* These partition-based physical disks can be used to create Ceph OSD objects. [ QSTOR-11374 ]
* Updated Storcli64 version to 007.3603.0000.0000 [ QSTOR-10911 ]

High Availability Failover
* Fixed an issue with FC ALUA path status when HA groups are disabled and HA VIFs are not present. [ QSTOR-11598 ]

Kernel and Drivers
* Updated kernel 6.8.0-90-generic drivers include intel ixgbe driver version 6.3.4 [ QSTOR-11524 ]
* Updated Jammy Platform installer ISO image to 22.04.5 [ QSTOR-11380 ]
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]

Multitenancy
* Changed Object User Create dialog text to more accurately reflect that it refers to Object Users/Tenants, and not Multitenancy objects [ QSTOR-9803 ]

Network Interfaces
* Fixed an issue where MTU values were being written to the VLAN interface configuration files. [ QSTOR-11552 ]

Network Shares
* Added further checks to Network Share Delete to verify the underlying ZFS filesystem properties has a matching OSNEXUS QuantaStor share ID before removing. [ QSTOR-11525 ]
* Auto populate the AD dialog with Organization Unit of specified on other systems in the grid [ QSTOR-11519 ]
* Add more options to filter shares in the delete dialog [ QSTOR-11499 ]

Remote Replication, Snapshots and Backup Policies
* Adds a new '--snapshots-with-holds-only' option to qs share-list and volume-list to list snapshots with holds on them. [ QSTOR-11388 ]

SNMP
* Update SNMP MIB [ QSTOR-11602 ]

Security
* When updating a certificate via cert-update, the relevant service (e.g. HAProxy) is now
automatically restarted to pick up the new certificate. Additionally, cert-update and
cert-rescan now accept the storage system by name or UUID. [ QSTOR-11529 ]
* Updated WebUI to have System Use Notification dialog/message display before user login dialog. [ QSTOR-11174 ]

Service Core
* Strip any invalid XML characters from description fields causing WebUI to not load [ QSTOR-11566 ]
* Cleaned up some repetitive log spam from the Blink Manager and the storcli hardware adappter [ QSTOR-11551 ]
* Fixed event spam and potential crash during Ceph daemon upgrade on large grids. [ QSTOR-11510 ]
* Fixes bug in site cluster maintenance mode logic. [ QSTOR-11489 ]
* Fixed an issue where the iSCSI/NVMe flag settings were not being retained for site cluster vifs after moving the vif to a new node. [ QSTOR-11464 ]
* Added support for LACP layer2+3 xmit\_hash\_policy [ QSTOR-11400 ]

Storage Pool Management
* Add more storage system tuning parameters [ QSTOR-11549 ]
* Added discard to LUKS options for NVMe model disks on ZFS Scale-Up Storage Pools with encryption. [ QSTOR-11501 ]

Upgrade Manager and Installer
* Fixed a throw in the qstorservice package install if the radosgw-admin command is not available [ QSTOR-11579 ]
* Fixed the qs-upgrade for kernel upgrades to ensure recommended packages for qstortarget are installed if they were previously manually removed. [ QSTOR-11556 ]

Web Manager
* When selecting Create Share from an existing selected share in the tree view, ensure the correct Storage Pool is selected in the Create Share dialog. [ QSTOR-11591 ]
* Create a new share template system for users to reuse settings from existing network shares. [ QSTOR-11314 ]

== v6.6.11.017 (March 5th 2026) ==

=== [[QuantaStor 6.6.11 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.11 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.11 Upgrade Instructions | upgrading to QuantaStor v6.6.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added a check to alert on SSL certificate expiration for the certificate manager managed certs. [ QSTOR-11462 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with rekeying scale-out ceph OSD's on Seagate Corvault backend external storage systems [ QSTOR-11206 ]

Disk Management
* Fixed an issue with SED media when adding as a hot-spare / for repair of a failed storage pool disk. [ QSTOR-11531 ]
* Fixed an issue where SSD Life Left status showing on multipath devices. [ QSTOR-11463 ]

Enclosures and Controllers
* Added Enclosure support from multiple Manufacturers such as Seagate, Gigabyte, Supermicro etc. [ QSTOR-11498 ]
* Fixed items related to the Intel 2u12 enclosure layout [ QSTOR-11286 ]
* Fixed Items related to the Supermicro 90-bay enclosure layout [ QSTOR-10932 ]

Network Shares
* Fix to allow creation of Network Shares with record size greater than 1M (1M, 2M, 4M, 8M). [ QSTOR-11535 ]

Security
* Fixed a few items related to Grafana default security ports [ QSTOR-11526 ]
* Fix configuration file manager file paths for telegraf.qstor and influxdb.qstor. [ QSTOR-11526 ]
* Fixed some items related to software encrypted HA storage pools management of /etc/crypttab [ QSTOR-11416 ]

Service Core
* Fixed some items related to QuantaStor Management Service database transactions [ QSTOR-11527 ]

== v6.6.10.006 (February 23rd 2026) ==

=== [[QuantaStor 6.6.10 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.10 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.10 Upgrade Instructions | upgrading to QuantaStor v6.6.10]].

=== Release Notes ===

Network Shares
* Fixed a service crash with Network share global Namespaces [ QSTOR-11518 ]
* Fixed an issue with AD join. [ QSTOR-11514 ]
* Fixed an issue with Seagate Corvault vpd83 parsing [ QSTOR-11518 ]

== v6.6.9.002 (February 13th 2026) ==

=== [[QuantaStor 6.6.9 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.9 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.9 Upgrade Instructions | upgrading to QuantaStor v6.6.9]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash when upgrading QuantaStor on Systems configured with Scale-Out storage. [ QSTOR-11509 ]

== v6.6.8.004 (February 11th 2026) ==

=== [[QuantaStor 6.6.8 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.8 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.8 Upgrade Instructions | upgrading to QuantaStor v6.6.8]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash for Network Interface discover logic [ QSTOR-11507 ]
* Fixed a service crash in Scale-out bucket discovery logic. [ QSTOR-11505 ]

== v6.6.7.017 (February 9th 2026) ==

=== [[QuantaStor 6.6.7 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.7 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.7 Upgrade Instructions | upgrading to QuantaStor v6.6.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Optimized grid communication paths and reduced database read frequency by improving internal object caching mechanisms. [ QSTOR-11473 ]
* Show compression ratio in the Scale-out Storage Pool grid. It is hidden by default. [ QSTOR-11130 ]

Disk Management
* Fixed an issue where a NVMe quick secure erase would be executed when formatting disks used for new storage pool creation [ QSTOR-11478 ]
* Fixed an issue where quick secure erase reformated the NVMe disk with a new namespace using a 512K sector size. [ QSTOR-11478 ]

Enclosures and Controllers
* Recertify Quantastor with the gen4 series of Western Digital Data24 [ QSTOR-11479 ]
* Fix up the config file defaults for NVMe software adapter when logging into a NVMe WD Data24. [ QSTOR-11470 ]

Network Shares
* Fix an issue with password shown in the service log during AD join [ QSTOR-11483 ]
* Add the ability to select multiple shares using the ctrl key in the share multi-delete dialog [ QSTOR-9181 ]

Web Manager
* Fixed a minor issue with file masks in modify Network Share [ QSTOR-11495 ]

== v6.6.5.026 (January 16th 2026) ==

=== [[QuantaStor 6.6.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.5 Upgrade Instructions | upgrading to QuantaStor v6.6.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Adds alerts in the event a Corvault device is in a warning or missing state. [ QSTOR-11411 ]

Ceph Scale-out Block, Object and File
* Fix an issue with creation of S3 user on a secondary zone. User will be created on the master zone. [ QSTOR-11438 ]
* Fixed an Issue with the Ceph initial PG calculations when creating ceph storage pools on HDD and SSD based OSDs. [ QSTOR-11437 ]
* Fix a minor issue with bucket sync when bucket originates on a secondary zone [ QSTOR-11435 ]
* Add granular options for object bucket rescan. [ QSTOR-11312 ]

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11436 ]
* Fix a row selection issue in the central pane on the External Media and Port grids. Show the 'Used By' column for External Volumes. [ QSTOR-11384 ]

High Availability Failover
* Fixed an issue with the Storage Pool Health check on systems with high load. [ QSTOR-11454 ]
* Fixed an issue with HA storage Pools in a degraded warnign state. [ QSTOR-11451 ]
* Reduced scale-out Object logging for site cluster vifs to debug level. [ QSTOR-11448 ]

Network Shares
* Fixed an issue with joining AD domains using SSSD+Winbind [ QSTOR-7845 ]

SNMP
* Updated SNMP MIB [ QSTOR-11456 ]

Security
* Enabled HTTPS redirect mode in QuantaStor WebUI by default during new Installs and upgrades to version 6.6.5 and newer. [ QSTOR-11368 ]
* Added a custom script callout via a security-message-update for the Security manager System Usage Notification contents: [ QSTOR-11222 ]
[https://wiki.osnexus.com/index.php?title=QuantaStor\_Custom\_Scripting\_/\_Application\_Extensions\#/var/opt/osnexus/custom/security-message-update.sh](https://wiki.osnexus.com/index.php?title=QuantaStor_Custom_Scripting_/_Application_Extensions#/var/opt/osnexus/custom/security-message-update.sh)

Service Core
* Added minimum timeout value to Coordinated tasks [ QSTOR-11455 ]
* Optimized Grid logic for Scale-out Object Bucket discovery on deployments with a large amount of ceph buckets. [ QSTOR-11433 ]
* Fixed an issue with License Key activation verification [ QSTOR-11110 ]

== v6.6.4.001 (December 17th 2025) ==

=== [[QuantaStor 6.6.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.4 Upgrade Instructions | upgrading to QuantaStor v6.6.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fix an issue where the S3 Object User Create fails when the User is not a Tenant member. [ QSTOR-11432 ]

== v6.6.3.033 (December 16th 2025) ==

=== [[QuantaStor 6.6.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.3 Upgrade Instructions | upgrading to QuantaStor v6.6.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Raise alerts when OSDs are down. [ QSTOR-11415 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with object user create under a tenant with multi-site is enabled for two zones. [ QSTOR-11427 ]
* Fix an issue with bucket sync policy create on the secondary zone bucket. [ QSTOR-11426 ]
* Allow selection of any object gateway when setting up ceph multi-site configuration. [ QSTOR-11409 ]

Enclosures and Controllers
* Adds enclosure management support for Supermicro Server SSG-522B-ACR12L [ QSTOR-11422 ]
* Change external volumes, media and volume grids from grouping to non-grouping for a minor performance improvement. Re-order Corvault columns in central grid (External Systems). Only show volumes for the currently selected Corvault. [ QSTOR-11370 ]

High Availability Failover
* Added a check to the site cluster to ensure that a user cannot set the final active node in a site cluster into standby. This is to prevent all nodes in a site cluster or HA pair from both being in standby and not serving any resources. [ QSTOR-11402 ]

Network Interfaces
* Fixed an issue where modifying the iscsi/nvme portal port settings on a VLAN or VIF interface would cause the parent interface to be restarted [ QSTOR-11406 ]
* Fixed an issue with importing LACP options in the /etc/network/interfaces file. [ QSTOR-11396 ]
* Updated the LACP bond-xmit-hash-policy options to use the modern text option names instead of the legacy numerical values. [ QSTOR-11396 ]

Network Shares
* Added 'qs-util nfsrdma' command to enable nfs rdma support for systems that have NFS RDMA supported hardware and drivers. [ QSTOR-11309 ]
* Auto detect when the AD server goes down and raise an alert. [ QSTOR-11182 ]
* Fixed issues with SSSD AD Join [ QSTOR-11335 ]

SNMP
* Updated SNMP MIB [ QSTOR-11428 ]
* Fixed a few items related to the SNMP agent stability. [ QSTOR-11405 ]
* Added logic to ensure new nodes joined to the grid get the snmp agent deployed on them with the same settings and snmp user. [ QSTOR-11393 ]

Security
* Removed default nginx index.html and version reporting from nginx. [ QSTOR-11351 ]

Service Core
* Extended timeout values for coordinated task finishing stage throughout the service. This will help prevent grid communication errors that are caused in high latency environments. [ QSTOR-11421 ]
* Enhanced grid logic for High Latency multi-site deployments. [ QSTOR-11391 ]

Upgrade Manager and Installer
* Added protections to ensure zfs pools are not imported incorrectly on a passive HA node during upgrade processes that update the grub configuration. [ QSTOR-11413 ]

Web Manager
* Add a tooltip to the Force checkbox on the Storage System Restart and Shutdown dialogs to clarify it's for immediate, unclean shutdowns. [ QSTOR-11381 ]

== v6.6.2.003 (November 14th 2025) ==

=== [[QuantaStor 6.6.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.2 Upgrade Instructions | upgrading to QuantaStor v6.6.2]].

=== Release Notes ===

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11367 ]

Security
* Updated QuantaStor Tomcat version to 9.0.112 [ QSTOR-11376 ]
* Fix a regression in single sign on failing to login AD users. [ QSTOR-11375 ]
* Enhanced Grid communication event batching that can help with large numbers of QuantaStor Grid object counts. [ QSTOR-11366 ]

== v6.6.1.013 (November 7th 2025) ==

=== [[QuantaStor 6.6.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.1 Upgrade Instructions | upgrading to QuantaStor v6.6.1]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Removed rgw gc optimizations that are no longer needed for modern ceph versions. [ QSTOR-10920 ]

Enclosures and Controllers
* Added some new warning icons for hardware controllers, hardware units and hardware disks. Fixed icon priority for status on hardware enclosures. [ QSTOR-11358 ]
* Fixed an issue with discovery of Hardware RAID Disks for LSI Hardware RAID controllers that use the storcli tool. [ QSTOR-11347 ]
* Fixed an issue with enclosure discovery for older LSI SAS HBA controllers that utilize sas3ircu [ QSTOR-11209 ]

High Availability Failover
* Fixed an issue with HA failover for storage pools that have multipath disks with -part1- in the device name. [ QSTOR-11373 ]

Security
* Fixed a possible SQL Injection during Login. [ QSTOR-11365 ]

Service Core
* Changes haproxy logrotate to be hourly by default. [ QSTOR-11349 ]
* Updated the QS PyClient Code in the github repo. [ QSTOR-11346 ]

== v6.6.0.362 (October 9th 2025) ==

=== [[QuantaStor 6.6.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.6.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.6.0 Upgrade Instructions| upgrading to QuantaStor v6.6.0]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Block rename of object pool group. [ QSTOR-11336 ]
* Add a fix so auto-tier rules can be set on multiple ceph clusters [ QSTOR-11323 ]
* Fixes bug with OSD replace prepare context menu button when called from the enclosure view. [ QSTOR-11313 ]
* Fixed: added duplicate zone check for Object Group Create [ QSTOR-11266 ]
* Add indication on the journal group if it is encrypted. [ QSTOR-11261 ]
* Updated Ceph version on Focal and Jammy platforms to 18.2.7 [ QSTOR-11129 ]
* Generate proper caps for keyring when using additional pools in CephFS [ QSTOR-11106 ]
* Display S3 user information in the delete user dialog to distinguish between S3 user and local user. [ QSTOR-10723 ]
* New feature adds the ability to modify RGW settings. Added the ability to add and remove load balancers on each Ceph cluster member. [ QSTOR-10623 ]
* Added support for Portal Groups for FC and iSCSI Targets [ QSTOR-10533 ]
* Add the ability to control synchronization for selected buckets in two objects storage clusters. [ QSTOR-10346 ]
* Add ability to specify multiple pools in a ceph file system. [ QSTOR-8674 ]

Dashboards and Analytics
* Add a new bucket dashboard that reports Average Total Objects and Average Utilized Space. [ QSTOR-11259 ]

Disk Management
* Adds an NVMe quick format to the Physical Disk Format dialog using the secure erase options. [ QSTOR-10688 ]

Enclosures and Controllers
* Fixed various items related to Linux Software RAID adapter support. [ QSTOR-11198 ]

Multitenancy
* Scope the access of user accounts so that they can only manage users, buckets, keys and other resources related to the tenant in the resource group they're a member of [ QSTOR-11326 ]
* Allow CephFS shares to be added to a Resource Group. [ QSTOR-11007 ]

Network Shares
* Share rename needs a force flag as it may disconnect NFS clients. [ QSTOR-11337 ]
* Provides an optional backported version of samba via a 'qs_samba_jammy_optional.sh' install script that includes a version of samba required to address the ad rfc2307 changes Microsoft introduced in KB5062572. Note this samba version does not include sssd support and so will not be installed by default. It should only be used for those customers using ad rfc2307 mode. [ QSTOR-11319 ]

Security
* Adds the ability to add and remove SSL certificate templates. Using those templates you can update the certificates for HaProxy and Rados gateways configured for HTTPS. [ QSTOR-9016 ]

Service Core
* Eliminates common errors in active directory join process, prepopulating dialog from previously joined systems [ QSTOR-11015 ]
* Added support for shutting down or restarting multiple systems at once [ QSTOR-10022 ]
* Added an optional force flag to Storage System Restart and Shutdown Dialogs to provide an option for immediate sysrq based shutdown of the system [ QSTOR-10022 ]

SNMP
* Updated SNMP MIB [ QSTOR-11343 ]

Storage Volumes
* Allow rename of Scale Out block storage volumes [ QSTOR-11311 ]
* Fix an event issue where the Volumes count was not getting updated in the central Host grid view. [ QSTOR-11038 ]

Universal Containers
* Add Universal Container support to the server and the Create Config dialog in the WUI. [ QSTOR-11194 ]

Upgrade Manager and Installer
* verified that packages are being installed properly with the new iso filtering stuff [ QSTOR-11030 ]

Web Manager
* Minor fix to the modify Network Port dialog. [ QSTOR-11302 ]
* Added the ability to save a local copy of a report schedule. [ QSTOR-11217 ]
* Simplifies active directory join and leave process, allowing multiple systems to join or leave at once [ QSTOR-8771 ]

== v6.5.12.005 (September 22nd 2025) ==

=== [[QuantaStor 6.5.12 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.12 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.12 Upgrade Instructions| upgrading to QuantaStor v6.5.12]].

=== Release Notes ===

Enclosures and Controllers
* Fixed vendor/model defaulting, improved enclosure layout auto-selection in the Modify Storage System dialog (including correct child-layout selection to choose the primary NVMe drive group), and resolved an invalid enclosureLayoutId that prevented layout auto-detection. [ QSTOR-11263 ]

Security
* Fixed: disable gzip compresson on web and api ports by default. [ QSTOR-11210 ]
* Fixed: internal qs-statsd/qs_restd service port 5173 moved to localhost only as it should not be presented as an external port. [ QSTOR-11210 ]
* Fixed: reduced syslog logging of qs-statsdb/qs_restd. [ QSTOR-11210 ]
* Added: DROP rules to block ICMP timechecks [ QSTOR-11210 ]
* Updated SSL Ciphers and TLS1.3 support for the web and API ports [ QSTOR-11210 ]
* Fixed: Set pcsd api port 2224 to bind to localhost only by default [ QSTOR-11210 ]

== v6.5.11.029 (August 28th 2025) ==

=== [[QuantaStor 6.5.11 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.11 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.11 Upgrade Instructions| upgrading to QuantaStor v6.5.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added support for SMTP servers that allow open relay with no username/password to the Alert Manager [ QSTOR-11167 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with multiple alerts occurring for long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Fixed some corner case issues with long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Added support for larger MDB devices upto 2100GB [ QSTOR-11274 ]
* Added support for encryption bypass on OSD create while still encrypting wal/db journal devices. [ QSTOR-11260 ]

Disk Management
* Fixed an issue with running the disk read performance test benchmark on very fast modern media. [ QSTOR-11296 ]

Enclosures and Controllers
* Fixed Enclosure and Controller discovery support for SAS3516 based SAS controllers [ QSTOR-11267 ]

High Availability Failover
* Fix an issue with VIF used for scale-out file usage after rebooting all nodes in the cluster. [ QSTOR-11265 ]

Network Interfaces
* Fixed: added gfortran-11 dependency to jammy repository required for LTS mellanox ofed install to succeed [ QSTOR-11285 ]
* Add QS cli command to hide disabled Network Ports [ QSTOR-10898 ]
* Fixed an issue where VLAN and VIF interfaces would not report their bond mode correctly if their parent interfaces was a bonded port. [ QSTOR-10754 ]

Network Shares
* Adds support for multiple HA VIF redirects and smart network filtering for NFSv4 referrals [ QSTOR-11278 ]
* Minor fix to skip NFS export commands for scale out shares. [ QSTOR-11275 ]

Quantastor CLI
* Provide a utility to create temporary log download links via qs-download-link [ QSTOR-11273 ]

SCSI / NVMe Target
* Fixed: Added logic to always default FC ports to target mode for supported FC target card models from QLogic. Ports can still be explicitly set to initiator mode if the user so chooses. [ QSTOR-10744 ]

Service Core
* Fixed: added the option to cancel the Physical Disk Identify task if the duration for the identify task is longer than the user wants. [ QSTOR-11258 ]
* Provide a download link for log collection in case logs cannot be uploaded from a Quantastor system [ QSTOR-11116 ]

Upgrade Manager and Installer
* Fixed: added proxy settings to the /etc/apt/apt.conf.d/80proxy file [ QSTOR-11281 ]
* Fixed: added logic to the upgrade manager and qs-upgrade command to check for missing version pinning if qs-util aptnopin has been run on the system. The upgrade task will fail early if correct pinning is not in place advising running qs-util aptpin. [ QSTOR-11277 ]

Web Manager
* Fixed: clarified text in create resource group for network share access of service containers [ QSTOR-11187 ]

== v6.5.10.013 (August 12th 2025) ==

=== [[QuantaStor 6.5.10 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.10 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.10 Upgrade Instructions| upgrading to QuantaStor v6.5.10]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the access key and secret key were not updating in the UI in instances with multiple object storage users across multiple ceph clusters in the same grid. [ QSTOR-11254 ]
* Fixed an issue with the cephfs mounts if communication is lost with the active MDS and a new MDS is elected. [ QSTOR-10738 ]

Enclosures and Controllers
* Fix an enclosure refresh issue via the event path where the underlying disk were not getting refreshed. [ QSTOR-11247 ]
* Fixed: Added additional checks for enclosure id on enclosures that fail to report correctly on older firmwares. [ QSTOR-11227 ]

Service Core
* Fixed: replaced size with maxsize in the ceph, radosgw and haproxy logrotate definitions so that they rotate as expected on their daily rotations as well as when reaching the max size definition. [ QSTOR-11253 ]
* Fix an underlying dashboard issue where new diskio entries were not properly added to the telegraf.conf file on new deployments. [ QSTOR-11246 ]
* Fix: Optimize the restarting of influx and telegraf. [ QSTOR-11246 ]

== v6.5.9.003 (August 5th 2025) ==

=== [[QuantaStor 6.5.9 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.9 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.9 Upgrade Instructions| upgrading to QuantaStor v6.5.9]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with slotmap updates when changing the slotmap in the enclosure and controllers section. [ QSTOR-11245 ]

Service Core
* Fixed an issue where QuantaStor was restarting the influxdb service when it was not needed. [ QSTOR-11244 ]
* Fixed: separated the influxdb, telegrafd and QuantaStor stats_db service restart logic to allow more granular control. [ QSTOR-11244 ]

== v6.5.8.008 (July 31st 2025) ==

=== [[QuantaStor 6.5.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.8 Upgrade Instructions| upgrading to QuantaStor v6.5.8]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed a small issue with the ceph osd reweight script progress trace. [ QSTOR-11234 ]

Enclosures and Controllers
* Add support for Supermicro ASG-2115S-NE332R system enclosure layouts [ QSTOR-11237 ]

Network Shares
* Fixed: Disable security features options in Network Share Create/Modify dialogs when the share is from a Scale-out File Pool. [ QSTOR-11235 ]
* Fixed: Remove redundant "NFS Security Mode" on the share advanced tab. [ QSTOR-11235 ]
* Fixed an issue with clearing the manage gids setting on Jammy platforms [ QSTOR-11225 ]
* Fixed an issue with setting specific nfs v3 or v4 server configurations on Focal platforms [ QSTOR-11225 ]
* Fixed a conflict with the nfs mountd ports between scale-out and scale-up nfs modes. [ QSTOR-11212 ]
* Fixed detection of nfs scale-out mode when it is configured at the time of ceph scale-out filesystem creation. [ QSTOR-11212 ]

Upgrade Manager and Installer
* Added a check to disable the grub os prober by default to prevent adding of any block devices with OS data other than the installed QuantaStor OS disk to the grub boot loader. [ QSTOR-11199 ]

== v6.5.7.004 (July 24th 2025) ==

=== [[QuantaStor 6.5.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.7 Upgrade Instructions| upgrading to QuantaStor v6.5.7]].

=== Release Notes ===

Network Shares
* Fixed an issue with network share cifs/smb settings such as ignore system acls introduced in the 6.5.1 release. [ QSTOR-11224 ]
* Removed the API underscore to space conversion logic in cifs/smb settings introduced in 6.5.1. REST API's should use proper url encoding like %20 when sending strings that contain spaces via curl or other http calls. [ QSTOR-11224 ]

Storage Pool Management
* Fixed a path naming issue for the sedutil-cli binaries used for SED disk encryption. [ QSTOR-11221 ]
* Added Several small enhancements and fixes for the sedutil-cli tool usage and SED supported disk discovery [ QSTOR-11219 ]

== v6.5.6.052 (July 16th 2025) ==

=== [[QuantaStor 6.5.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.6 Upgrade Instructions| upgrading to QuantaStor v6.5.6]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fix minor issue with Corvault log collection. [ QSTOR-11201 ]
* Added alerts to notify the user as they approach quota limits for S3C buckets [ QSTOR-11055 ]
* Fixed an issue with the IPMI Ip addresses showing up in the Health Check reports. [ QSTOR-10356 ]

Ceph Scale-out Block, Object and File
* Fixed radosgw logging logrotation not always occurring on fresh installs. [ QSTOR-11176 ]
* Fixed: radosgw logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Fixed: haproxy logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Improved logic for Ceph OSD Gentle Reweight. [ QSTOR-11163 ]
* Fixed an issue with the version check when upgrading the the scale-out ceph MDS, RGW and other daemons. [ QSTOR-11138 ]
* Fixed a few corner cases with ensuring successful Ceph upgrades. [ QSTOR-11138 ]
* Allow compression support for Ceph RBD pools. [ QSTOR-11131 ]
* Added Object User quota usage information to the Object User grid [ QSTOR-10722 ]

Dashboards and Analytics
* Add Pool, volume and share space usage trending dashboards (Early Access). [ QSTOR-11076 ]
* Add Pool, volume and share space usage trending dashboard routes and toggle buttons. [ QSTOR-11076 ]
* Expand the trending time scale for Tenants and Owners to make use of longer retention policies (e.g. 'Last 30 Days'). [ QSTOR-11076 ]
* Fix InfluxDB trending continuous query settings in qs\_statsdb.sh. [ QSTOR-11076 ]

Disk Management
* Add Multipath and HA support for SED Disks. [ QSTOR-11172 ]
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11065 ]

Enclosures and Controllers
* Fixes intermittent boot time OSD start issue with Corvault media. [ QSTOR-11195 ]
* Adds encryption bypass mode to avoid applying double (hardware plus software) encryption to Corvault media. [ QSTOR-11195 ]
* Added enclosure layout for Supermicro SYS-221H-TN24R systems. [ QSTOR-11154 ]

High Availability Failover
* Fixed an issue with Storage pool import of a previously exported pool that has iofencing on nvme disks. [ QSTOR-11173 ]

Network Shares
* Add new cyphers for active directory join. [ QSTOR-11183 ]
* Added sync flag by default to NFS mount for ceph object storage ganesha shares [ QSTOR-11181 ]
* Adjust minor Network Share quota alert levels. [ QSTOR-11171 ]
* Add larger record size upto 8M for Network Shares on ZFS Storage Pools. [ QSTOR-10118 ]
* Added support for hidden shares that end in a '$' as 'Browseable (admin-only) shares in the CIFS/SMB Options tab of the Network Share Create/Modify Dialogs. [ QSTOR-9222 ]

Service Core
* Optimize database reads for large clusters. [ QSTOR-11178 ]
* Added qs-util dbdiff for use to compare osn.db database versions [ QSTOR-10566 ]
* Added https as the default preferred method for support log bundle upload. [ QSTOR-9875 ]

Universal Containers
* Added initial support for a universal container system [ QSTOR-11162 ]

Upgrade Manager and Installer
* Added logic to fix the /boot/efi based on a efi partition label for Software RAID and EFI installs [ QSTOR-11140 ]

Web Manager
* Revise the Object User Access Key Manager to include Storage URLs in the Copy to Clipboard action. [ QSTOR-11177 ]
* Improved fieldset placements for network share create/modify dialogs. [ QSTOR-11156 ]
* SED Pool management - Reorder SED columns in PD grid. Move to the right of the "Correlated Device" column. Revise the SED capability detection to check for non-enterprise. [ QSTOR-11146 ]

== v6.5.5.039 (May 29th 2025) ==

=== [[QuantaStor 6.5.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.5 Upgrade Instructions| upgrading to QuantaStor v6.5.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixes bug in osd gentle reweight script that was bottlenecking performance. [ QSTOR-11123 ]
* Added logic to auto-clean up volume objects for non-QuantaStor managed ceph rbd's (rbd's created directly by the client using client rbd drivers/software). [ QSTOR-11112 ]
* Add warnings for the user if OSD or journal delete is being used on a device with duplicate PVs due to multi-pathing mapping. [ QSTOR-11099 ]
* Added 'qs-ceph' utility commands to modify compression options on Ceph pools. [ QSTOR-11096 ]
* Added compression ratio column in storage pools grid. [ QSTOR-11087 ]

Enclosures and Controllers
* Added support for discovery of RMSP3JD160J controllers. [ QSTOR-11107 ]
* Add validation for both primary and secondary IPs during External System Credentials Add. [ QSTOR-11009 ]

High Availability Failover
* Fixed a very rare corner case where a Manual HA failover task could generate unexpected errors due to a background periodic storage pool scan. [ QSTOR-11111 ]
* Added the option to set a Site Cluster Member Node as Manual Standby. [ QSTOR-11105 ]
* Fixed an issue where nodes could come out of standby status on a reboot too early before grid communication was established. [ QSTOR-11105 ]
* Enhanced HA Failover times for Storage Volumes for Fibre Channel clients. [ QSTOR-11105 ]
* Enhanced Fiber Channel High availability ALUA Changes to occur more quickly and to more quickly advertise failed paths to clients like VMware so that they can resume I/O to healthy available paths sooner. [ QSTOR-11105 ]
* Enhanced the logic used for High Availability Storage SCSI Target decoupling during a Storage Pool export. This can help greatly reduce the failover time for very Large configurations with thousands of volumes or volume snapshots. [ QSTOR-10969 ]

Network Interfaces
* Fixes bug that was blocking users from creating a static route with the same destination subnet across different systems. [ QSTOR-11125 ]
* Fixed a bug in static route validation logic and allow users to delete malformed static route entries. [ QSTOR-11115 ]

Network Shares
* Allow rename of nested shares [ QSTOR-11046 ]
* Added logic to help persist and manage NFS options for NFS version and nfs --manage-gids flags [ QSTOR-11001 ]

REST API
* Add an API to clear missing shares or volumes from the QS database. [ QSTOR-11117 ]

Remote Replication, Snapshots and Backup Policies
* Clarify concurrency options for backup policies. [ QSTOR-11004 ]

Security
* Added explicit modprobe disable and blacklist of ksmbd module to address any CVE-2025-37899 concerns. [ QSTOR-11134 ]

Service Core
* Enhanced the Core QuantaStor service management thread scaling. [ QSTOR-10767 ]
* Fixed a small memory leak with debug log tracing [ QSTOR-10689 ]

Storage Pool Management
* Updated sedutil-cli that supports a wider range of encrypted devices. [ QSTOR-11088 ]
* Restores sedutil / Storage Pool encryption support for SED Ruby NVMe devices. [ QSTOR-11088 ]
* Removed restriction to satisfy the VDEV count of N+1 to create a RAIDZx(RAID50/60/etc) array on a ZFS scale-up Storage pool when passing in a Set Disk Size instead of using the 'auto' option. [ QSTOR-11086 ]

== v6.5.4.016 (April 29th 2025) ==

=== [[QuantaStor 6.5.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.4 Upgrade Instructions| upgrading to QuantaStor v6.5.4]].

=== Release Notes ===

Dashboards and Analytics
* Fix issue where the dashboard of a newly created volume was not showing performance data after it had been assigned because of a pending Telegraf restart required. [ QSTOR-11077 ]
* Show CPU Temp and Power Usage in the System Dashboard (new Sensors button). [ QSTOR-11029 ]

High Availability Failover
* Unblocked creating HA ViF if there is an HA irrelavant bond in active-backup mode and unblocked modifying an HA irrelavant bond. [ QSTOR-11073 ]
* Fixed an issue when modifying non-name fields of an HA group. [ QSTOR-11071 ]

Network Interfaces
* Fixed bugs in validation logic for static route create and delete. [ QSTOR-11056 ]

Network Shares
* Ensure 'Browseable' is checked on SMB network shares when Browseable (Access Based) is checked. This ensures that authenticated clients who have pre-assigned browseable access can see the share offered by the QuantaStor but prevents non-authenticated users from seeing the share. [ QSTOR-11078 ]

Remote Replication, Snapshots and Backup Policies
* Minor log file cleanup after backup job is finished. [ QSTOR-11044 ]
* Add the ability to rollback a read-write Storage Volume or Network Share snapshot to it's underlying snapshot. [ QSTOR-9820 ]

Storage Pool Management
* Fixed an issue with Storage Pool auto-start on reboot for software encrypted storage pools. [ QSTOR-11081 ]

== v6.5.3.021 (April 9th 2025) ==

=== [[QuantaStor 6.5.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.3 Upgrade Instructions| upgrading to QuantaStor v6.5.3]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* Improved timeout handling for QuantaStor coordinated task system. [ QSTOR-11022 ]

Disk Management
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11032 ]

Enclosures and Controllers
* Added Hardware Enclosure support for Dell PowerEdge R7615 [ QSTOR-11043 ]
* Added Hardware Enclosure support for Supermicro AS-1115CS-TNR [ QSTOR-11043 ]
* Optimized performance and fixed issues when rendering systems with attached CORVAULT external systems. [ QSTOR-11039 ]
* Optimize the rendering of enclosures. Fix drawer rendering issue where extra slots were appearing. [ QSTOR-11014 ]

Network Interfaces
* Fixed an issue with static route netmask CIDR calculations. [ QSTOR-11048 ]

Network Shares
* Update Network Share Namespace on all nodes to reflect any modification to NFS access entries to share that is part of a Namespace. [ QSTOR-11042 ]
* Online newly promoted Network Share Snapshots. [ QSTOR-11021 ]
* Add post share create and modify script callouts. [ QSTOR-11016 ]
* Fixed mount paths for enabled snapshots of Network Share when Share is renamed. [ QSTOR-11012 ]
* Add the ability to prioritize NFS access rules in /etc/exports file. [ QSTOR-10552 ]

SNMP
* Regen SNMP for 6.5.3 [ QSTOR-11054 ]

Security
* Added docker http proxy override [ QSTOR-11040 ]
* Updated Tomcat version to 9.0.102.0 [ QSTOR-11013 ]

Upgrade Manager and Installer
* Fixed various issues with the OVA vApp properties being set after VM image cloning. Added additional properties to the OVA by default. [ QSTOR-10508 ]

== v6.5.2.070 (March 27th 2025) ==

=== [[QuantaStor 6.5.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.2 Upgrade Instructions| upgrading to QuantaStor v6.5.2]].
=== Release Notes ===

Alerts and Configuration Analysis
* Added SED version of Micron 7300 drives to firmware check for Config Analyzer [ QSTOR-10933 ]

Ceph Scale-out Block, Object and File
* Update AWS cli. [ QSTOR-10956 ]
* Extend Resource Groups to support adding S3 Tenant resource type. [ QSTOR-10808 ]
* Extended timeouts for logical volume allocation commands when creating Ceph OSDs. [ QSTOR-10930 ]
* Added more permissive check when running Ceph OSD replace prepare operation. (CLI only) [ QSTOR-10914 ]
* Add a qs-ceph command to allow switching between fuse and kernel mount for cephFS to allow user comparison of fuse versus the faster kernel option. [ QSTOR-10905 ]
* Adds additional Ceph coordinator election mode that maps to the site-cluster. [ QSTOR-10795 ]

Dashboards and Analytics
* Added Jammy platform support for the ceph prometheus install script [ QSTOR-10949 ]

Enclosures and Controllers
* Strip whitespace characters from primary and secondary IPs during External System Credentials Add. [ QSTOR-10896 ]
* Add validation for External System Credentials during creation. [ QSTOR-10826 ]

High Availability Failover
* Fixed a bug with creation grid master (gm) Site Cluster vifs. [ QSTOR-10996 ]
* Implemented new naming schema for underlying Site Cluster HA Groups. [ QSTOR-10904 ]

Network Interfaces
* Fixed an issue with deleting bonded interfaces leaving slave interfaces tagged as slaves. [ QSTOR-10931 ]
* Updates for mellanox ofed lossless networking support to work better with newer model cards. [ QSTOR-10779 ]

Network Shares
* Fixes bug where having 'gmt' or 'GMT' in the name of a network share would cause issues with NFS protocol. [ QSTOR-10982 ]
* Fix the mount paths for read-write GMT snapshots. [ QSTOR-10938 ]
* Add mountaddr to the view mount instructions for Network Share. [ QSTOR-10923 ]
* Add crossmnt option in the NFS exports for newly created shares. Also skip adding the default export for .zfs directory. [ QSTOR-10806 ]
* Add the ability to clone a GMT snapshot and promote it.
Add QS CLI to copy share permissions. [ QSTOR-10580 ]

REST API
* Handle empty lists from the curl calls to Quantastor APIs. [ QSTOR-10939 ]

Remote Replication, Snapshots and Backup Policies
* Fixed up dead links which were created after running some types of auto-tier Backup Policies. [ QSTOR-10934 ]

SNMP
* Update SNMP MIB [ QSTOR-11019 ]

Security
* Prevent MFA passcodes with leading 0 from being truncated. [ QSTOR-10852 ]

Service Core
* Fixes an issue where role-creation would fail due to deprecated permission-definitions. [ QSTOR-10988 ]

Storage Pool Management
* Added support for the creation of mirror sets consisting of "quad-mirrors" (4-way mirror sets) for both the data device groups in the pool and also the "special" devices, such as "dedup" and "metadata offload" devices. [ QSTOR-10893 ]

Storage Volumes
* Add more detail for logical and physical space utilization for volumes. [ QSTOR-10981 ]

Upgrade Manager and Installer
* Deprecates legacy package version pinning for the packages.osnexus.com mirror server that was causing issues with some ceph cluster upgrades [ QSTOR-10990 ]
* Added protections in qs\_distupgrade.sh for lvm snapshots that could cause issues with the platform upgrade. [ QSTOR-10970 ]
* Resolved multiple items that were causing issues with installing QuantaStor on redhat based platforms when STIG enforcement policies were present. [ QSTOR-10958 ]
Note: the qs_upgrade_redhat8.sh install/upgrade script temporarily sets selinux to permissive mode and temporarily disables fapolicyd if it is enabled when the script is running and restores them to their original state when the script completes.

Web Manager
* Auto select S3 tenant for S3 User when user create is invoked from context menu on the S3 tenant. [ QSTOR-11010 ]
* Increase the width of grids to show the 'Correlated Device' column in the Add Log/Cache/Metadata Device to Pool dialog w/o the need for scrolling. [ QSTOR-10951 ]
* Add an option to upload logs with no truncation. [ QSTOR-10925 ]
* Add drawer support for the Corvault enclosure layout and rendering engine in the WUI. [ QSTOR-10796 ]

== v6.5.1.058 (February 12th 2025) ==

=== [[QuantaStor 6.5.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.1 Upgrade Instructions| upgrading to QuantaStor v6.5.1]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* General improvements to OSD drive replacement process. Added additional LVM clean up logic. Fixed issues with device correlation for multipath devices and encrypted drives. [ QSTOR-10915 ]
* Allow deleting journals from the UI via Ceph journal delete dialog [ QSTOR-10890 ]

Dashboards and Analytics
* Add gridPreferredPort check to the WUI dashboard service (qsrestd) if set on a Storage System. [ QSTOR-10866 ]

Disk Management
* Fixed: New systems and clean QuantaStor service configurations databases will initialize Multipath autoconfig support as enabled by default. [ QSTOR-10900 ]
* Increased timeouts and other optimizations for large multipath configurations. [ QSTOR-10881 ]
* Added protections to prevent QuantaStor service from running multiple blkid instances if one is already running. [ QSTOR-10881 ]
* Unblocked adding disk as a scale-up pool spare with a larger block size. [ QSTOR-10876 ]

Enclosures and Controllers
* Add Enclosure mapping support for HPE ProLiant DL325 Gen10. [ QSTOR-10899 ]
* Fixed an issue with Hardware Disk Identify for Storage Pool Physical Disks where the controller was not properly selected in the dialog. [ QSTOR-10858 ]
* Fixed an issue with applying External System Profile A+B. [ QSTOR-10840 ]

High Availability Failover
* Fixed an issue with automatically starting HA scale-up ZFS pools if both HA nodes are booted at the same time. [ QSTOR-10902 ]
* Added a a check to ensure the luks crypttab was upto date after encrypted ha pool failover. [ QSTOR-10901 ]
* Added VLAN interfaces to allowed interfaces for Site Cluster heartbeat rings. [ QSTOR-10871 ]
* Added better logic for smb/nfs service management for Scale-up HA configurations with shares on multiple storage pools in the same HA cluster. [ QSTOR-10762 ]
* Fixed an issue with Resource Group Service configs starting on a node after the node had previously hosted the service. [ QSTOR-10762 ]
* Fixed: added a unique name check for HA group create/modify. [ QSTOR-10311 ]

NAS Gateway / Cloud Containers
* Change Seagate Lyve Cloud endpoints [ QSTOR-10868 ]

Network Interfaces
* Fixed an issue with calling iptables commands when distupgrading from older distributions. [ QSTOR-10860 ]

Network Shares
* Minor fix to allow creation of GMT snapshots for volumes from the Web UI. [ QSTOR-10873 ]
* Fixed an issue with spaces in the curl command issued to Quantastor. [ QSTOR-10838 ]
* Fix issue where renaming a share that contained a nested share failed. [ QSTOR-10811 ]
* Allow setting Samba share as read-only using ZFS. The new support has been added to the Network Share create and modify dialogs on the Advanced settings tab. [ QSTOR-10755 ]
* Fixed an issue which created duplicate mounts for nested shares. [ QSTOR-10704 ]
* Exposed ZFS 'Case Sensitivity' option at share creation time. [ QSTOR-8869 ]

REST API
* Fixed the POST command in the REST API [ QSTOR-10844 ]

Remote Replication, Snapshots and Backup Policies
* Fix an issue with auto tiering in backup policies. [ QSTOR-10845 ]
* Refined the Backup Policy Create and Modify dialogs. [ QSTOR-10843 ]
* Fixed an issue with Backup Policy tasks completing when the underlying file copy or move process process had returned. [ QSTOR-10839 ]
* Add alerting when replication fails. [ QSTOR-10799 ]

SNMP
* Updated SNMP MIB [ QSTOR-10922 ]

Service Core
* Fixed an issue that could sometimes cause performing a reboot or shutdown of the storage system via the QuantaStor UI to fail. [ QSTOR-10917 ]
* Fix an issue with database backups on the storage pools. [ QSTOR-10907 ]
* Fixed an issue with creating encrypted pools when an underlying disk is read-only. [ QSTOR-10886 ]
* Fixed a disk discovery issue when discoverying a large number of disks. [ QSTOR-10875 ]
* Fixed QuantaStor service builds for Redhat based distros. [ QSTOR-10846 ]
* Added /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable touchfile to bypess the icmp ping check and allow sending logs from the UI/qs cli. [ QSTOR-10556 ]

Storage Pool Management
* Fix an issue with pick a smaller hotspare disk getting picked for metadata offload if disk goes missing. [ QSTOR-10877 ]
* Add storage capacity properties for metadata offload VDEV [ QSTOR-10661 ]

Upgrade Manager and Installer
* Added a blacklist of the bnxt\_re driver to prevent issues for normal network operations for the bnxt_en driver loading on network controllers that have rdma support enabled in their firmware by default. [ QSTOR-10918 ]
* Added elbencho benchmarking tool to quantastor utilities. [ QSTOR-10892 ]
* Added support for Focal 20.04 to Jammy 22.04 Platform upgrades via qs-distupgrade [ QSTOR-10547 ]
* Fix telegraf start failures at startup due to invalid config file errors. [ QSTOR-10353 ]

Web Manager
* Fixed a minor truncation issue with trigger Backup Policy dialog [ QSTOR-10919 ]
* Add a Description column to the share and snapshot grid and default to hidden. [ QSTOR-10882 ]
* Minor fix to NTP server add dialog to prevent empty entries in the dialog. [ QSTOR-10870 ]
* Auto select first row in NTP and DNS settings dialogs. [ QSTOR-10867 ]
* Improve the host assign volume dialog. [ QSTOR-10862 ]

== v6.5.0.246 (January 9th 2025) ==

=== [[QuantaStor 6.5.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.0 Upgrade Instructions| upgrading to QuantaStor v6.5.0]].
=== Release Notes ===

Alerts and Configuration Analysis
* Increased HA health checks on Systems with local HA Pools. [ QSTOR-10746 ]
* Fixed: sending logs from specific grid nodes will now send logs only from the selected nodes. [ QSTOR-10694 ]

Ceph Scale-out Block, Object and File
* Fixes issue with access permissions for ceph client admin keyring file. [ QSTOR-10818 ]
* Fixed issues related to encrypted OSD replace operations. [ QSTOR-10786 ]
* Fixed an issue with wal journal device discovery and association with osds. [ QSTOR-10751 ]
* Deprecated replica=2 as a creation option from Ceph Scale-out storage. Replica=2 did not provide enough redundancy for consistent normal storage operations in the event of an osd or storage system outage. [ QSTOR-10748 ]
* Added the force flag checkbox to the Create S3 Storage Class dialog. [ QSTOR-10734 ]
* Fixed bugs in Ceph upgrade stage completion and failure alerting. [ QSTOR-10730 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10717 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10716 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10708 ]
* Improve ceph discovery. [ QSTOR-10675 ]
* Add metadata pool utilization for Ceph Object Pool Group and Ceph File System [ QSTOR-10650 ]
* Disabled OSD auto restart. auto restart can be activated using the touchfile '/var/opt/osnexus/quantastor/touchfiles/tf\_ceph\_osd\_auto\_start.enable' [ QSTOR-10632 ]
* Ensure the Tenant and User grid's bucket count column is updated after the delete bucket operation via events. [ QSTOR-10610 ]
* Fixed a bug with Ceph OSD 'Last Rekey Date' field not being updated properly. [ QSTOR-10509 ]
* Updated default Ceph version to Reef 18.2.4 for new Focal and Jammy platform deployments. [ QSTOR-10415 ]

Dashboards and Analytics
* Add a new Ceph Member selection combo to the Ceph Pool dashboard. [ QSTOR-10798 ]
* Add Tenant and Owner usage dashboards to the Bucket menu area. [ QSTOR-10698 ]
* Add CPU Temp and Power Usage to the Grid Dashboard's System Tiles. [ QSTOR-10427 ]
* Change the grid CPU metric to use system\_usage which matches the metric used in the System dashboard. The overlapping text issue is no longer an issue as Highcharts has been replaced with Chart.js. [ QSTOR-10263 ]
* Add power usage and average CPU temp sparklines to the System Tile dashboards in the grid view. [ QSTOR-10013 ]
* Removed resource column from Health Checker/Config Analyzer. [ QSTOR-5515 ]

Disk Management

* Removed the multipath autoconf touchfile support which fixes issues where disabling multipath autoconfig would not apply. [ QSTOR-10706 ]
Enclosures and Controllers
* Addes enclosure layour for Supermicro Server SYS-F629P3-RC1B FatTwin 4-Node 24+12 bay [ QSTOR-10853 ]
* Fixed an issue with disk discovery when a CORVAULT is attached. [ QSTOR-10664 ]
* Added the ability to blink empty slots on jbod hardware that supports that feature. This action is accomplished using sg\_ses commands. [ QSTOR-10618 ]
* Added functionality to treat enclosures accidentally unplugged as MISSING, so that when reconnected their user-set properties are not lost . [ QSTOR-10542 ]

High Availability Failover
* Fixed an issue with post failover storage pool update tasks being stuck in a running state for nodes where the HA storage pool was previously evicted from due to an automatically triggered failover event. [ QSTOR-10485 ]

Kernel and Drivers
* Updated ZFS driver version to 2.2.6 [ QSTOR-10647 ]
* Updated scst iSCSI/FC Target driver to 3.9.0 [ QSTOR-10534 ]

Licensing
* Fixup old license keys to work with new format. [ QSTOR-10788 ]
* Added Express Edition Licenses [ QSTOR-10619 ]
* Show TB Utilized in the License grid and property view. [ QSTOR-8009 ]

NAS Gateway / Cloud Containers
* Fix wrap and truncation issues in the Cloud Add Credential dialog for Spanish. [ QSTOR-10792 ]

Network Shares
* Retain include line position in smb.conf [ QSTOR-10800 ]
* Minor fix to retain the share description when creating a Network Share. [ QSTOR-10793 ]
* Enhance the network share CLI search to support paging (similar to buckets). [ QSTOR-10757 ]
* Fix minor share name and snapshot name validation. [ QSTOR-10520 ]
* Added additional share name validation to share modify cli and API calls. [ QSTOR-10519 ]
* Add SSSD support [ QSTOR-10445 ]
* Implemented ransomware detection for Network Shares. [ QSTOR-10391 ]

Quantastor CLI
* Fixed qs cli disk-list filters for ssd, and nvme disk types. [ QSTOR-10515 ]
* Fixed the filtering for qs cli disk-list --filter="\[unused\]" and --filter="\[used\]" commands [ QSTOR-10482 ]

Remote Replication, Snapshots and Backup Policies
* Remove SSH keys after replication links are deleted [ QSTOR-10782 ]
* Fix minor argument validation for replication schedule create and snapshot schedule create. [ QSTOR-10732 ]
* Added monitoring for file modify events to enable continuous data protection on modified files. [ QSTOR-10557 ]
* Added ability for Snapshot Schedules and Replication Schedules to absorb old snapshots. [ QSTOR-10524 ]
* Create local delta Snapshot on source when Replication Schedule is skipped. [ QSTOR-10357 ]
* Change the control in the 'Update Selections for Replication Schedule' dialog to be a dual chooser. [ QSTOR-10351 ]

SCSI / NVMe Target
* Added a remote Fibre Channel port list to the fc target port section of the UI and 'qs fc-remote-port-enum' CLI command. [ QSTOR-10541 ]
* Added the Fiber Channel Issue LIP dialog to the UI that can be used to issue a lip on a specific FC port. [ QSTOR-10226 ]

SNMP
* Update SNMP MIB [ QSTOR-10847 ]

Security
* Fixed a bug in the 2FA login process. [ QSTOR-10841 ]
* Added support for a custom iptables include script under
/var/opt/osnexus/quantastor/iptables.qscustom [ QSTOR-10794 ]
* Updated tomcat package version to 9.0.96.0 [ QSTOR-10691 ]

Service Core
* Fix a small memory leak [ QSTOR-10778 ]
* Revise the server S3 modify API to accept spaces for the Display Name property. [ QSTOR-10724 ]
* Fixed some issues with writing the Chrony conf file on platforms that have chrony installed (like Jammy) [ QSTOR-10293 ]

Storage Pool Management
* Allow trim schedule to run nightly. [ QSTOR-10652 ]

Storage Volumes
* Allow minimum of <4MB for Storage Volume QoS Control limits. [ QSTOR-10765 ]
* Updated Storage Volume QoS controls to use cGroups v2 for modern linux kernels/platforms. [ QSTOR-10529 ]

Upgrade Manager and Installer
* Added logic to temporarily disable the upmap balancer during ceph upgrade. [ QSTOR-10702 ]
* Fixed an issue where Storage System Upgrade tasks were showing 25% progress but transitioned to the 'Completed' stage. [ QSTOR-10673 ]
* Install sssd packages by default on focal and newer platforms. [ QSTOR-10549 ]
* chrony is now the default time daemon for ubuntu 22.04 jammy and newer platforms. [ QSTOR-10273 ]
* Added 22.04 Jammy as a new Platform for QuantaStor [ QSTOR-10225 ]

Web Manager
* Disable the 'Start Upgrade' button in the Upgrade dialog until the system update check is complete. [ QSTOR-10776 ]
* Show the Tag/Alt Name value along with the Controller name in the identify dialog if provided. [ QSTOR-10775 ]
* Decrease the replication detail chart update frequency. [ QSTOR-10753 ]
* Added email validation check for the Alert Manager dialog [ QSTOR-10590 ]
* Added Timezone configuration as a step in the getting started guide. [ QSTOR-10502 ]

== v6.4.5.001 (November 1st 2024) ==

=== [[QuantaStor 6.4.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.5 Upgrade Instructions| upgrading to QuantaStor v6.4.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an error with Ceph Bucket Discovery tasks. [ QSTOR-10707 ]

== v6.4.4.013 (October 25th 2024) ==

=== [[QuantaStor 6.4.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.4 Upgrade Instructions| upgrading to QuantaStor v6.4.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added a fix for Seagate Corvault based Ceph deployments to ensure ceph LVM layer is started on system boot. [ QSTOR-10686 ]
* Added qs-osd-compact script to assist with OSD compaction on a per system basis. [ QSTOR-10668 ]
* Fixed an issue with Ceph OSD Journal device discovery for encrypted Ceph Clusters. [ QSTOR-10666 ]
* Extend timeouts for OSD restart stage of the Ceph upgrade task. [ QSTOR-10665 ]
* Fixes bug were OSDs lose journal device correlation after OSD reweight operation. [ QSTOR-10657 ]

Enclosures and Controllers
* Fixed an issue with enclosure and disk slot identity correlation information. [ QSTOR-10681 ]

High Availability Failover
* Disables the PCS daemon WebUI by default. [ QSTOR-10692 ]
* Adds a check for versions older than 6.4.3 to auto-disable the new health checks logic that is not compatible with older versions. [ QSTOR-10692 ]

Upgrade Manager and Installer
* Fixed: the qs_upgrade_redhat8.sh script now automatically removes legacy centos repos that are no longer needed for Redhat platform deployments. [ QSTOR-10676 ]

== v6.4.3.021 (October 10th 2024) ==

=== [[QuantaStor 6.4.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.3 Upgrade Instructions| upgrading to QuantaStor v6.4.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed a incorrect encrypted ZFS pool check check in the Config Analyzer for encrypted Ceph clusters with encrypted OSDs. [ QSTOR-10643 ]

Ceph Scale-out Block, Object and File
* Optimized scale-out ceph bucket discovery for very large number of S3 buckets. [ QSTOR-10621 ]
* Ceph OSD create and delete operations will no longer fail due to services being masked. [ QSTOR-10617 ]
* Made some improvements to the Veeam SOSAPI update cycle. [ QSTOR-10616 ]
* Fixed an issue with creating Ceph Storage Classes of the same name on different Ceph Clusters. [ QSTOR-10592 ]
* Default to http based checks from the haproxy load balancer to backend http radosgw instances. [ QSTOR-10559 ]

NAS Gateway / Cloud Containers
* Add a rescan for cloud containers so that data is refreshed if uploaded from another S3 gateway. [ QSTOR-10627 ]

Network Shares
* Fix an issue with trusted domain users not found in the Active Directory User search dialog. [ QSTOR-7353 ]

Remote Replication, Snapshots and Backup Policies
* Enabled Continuous Data Protection and Auto-tiering on Backup Policies using the SMB protocol. [ QSTOR-10601 ]

Security
* Added http proxy support for Upgrades, Support Log submission and License Key Activation. [ QSTOR-10432 ]

Upgrade Manager and Installer
* Fix triggering Ceph cluster upgrades when there are multiple scale-out storage Ceph clusters in the same QuantaStor Storage Grid. [ QSTOR-10612 ]
* Fixed an issue with the Ganesha 5.9 libntirpc dependency. This change was shipped earlier with a respin of QuantaStor 6.4.3 to include the missing updated library in the update repo and in the ISO and OVA image. [ QSTOR-10576 ]

== v6.4.2.053 (September 19th 2024) ==

=== [[QuantaStor 6.4.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.2 Upgrade Instructions| upgrading to QuantaStor v6.4.2]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed tolerances for alerting on changes in PSU status and other IPMI sensors. [ QSTOR-10447 ]

Ceph Scale-out Block, Object and File
* Adds total Object count to S3 tenant and user objects [ QSTOR-10606 ]
* Improved logic to ensure Scale-out Object Storage Class Auto-Tiering Rules were applied correctly on all nodes after an update. [ QSTOR-10599 ]
* Unblocked file quotas for CephFS Shares. [ QSTOR-10584 ]

Enclosures and Controllers
* Added Enclosure for Tyan Transport SX TS70-B8056. [ QSTOR-10597 ]
* Fixed an issue with enclosure support for Supermicro SSG-621E-ACR16L [ QSTOR-10563 ]

NAS Gateway / Cloud Containers
* Fix a regression with NFS and SMB access for cloud container shares. [ QSTOR-10588 ]

Network Shares
* Fixed an issue where the quota field was incorrectly disabled in the network share modify and create dialogs for nested shares on zfs storage pools. [ QSTOR-10602 ]
* Implemented ability to adjust Network Shares permission settings via a specified permissions mask. [ QSTOR-10147 ]

Quantastor CLI
* Fix a minor regression with share name now showing in the output of "qs share-list" [ QSTOR-10587 ]

Remote Replication, Snapshots and Backup Policies
* Show more informative errors when a Backup Job fails. [ QSTOR-10575 ]
* Fixed an issue where multiple snapshots were wrongfully created. [ QSTOR-10564 ]
* Fix an issue with removing excess snapshots for a backup policy with cephFS shares. [ QSTOR-10560 ]
* Add maximum total snapshots for replication, snapshot and backup schedules. [ QSTOR-10539 ]
* Fixed an issue where GMT Snapshots were disappearing. [ QSTOR-10538 ]
* Fix an issue with resume replication not updating the replication reports. [ QSTOR-10536 ]
* Added auto-tier stubbing minimum file size threshold. [ QSTOR-10505 ]

SCSI / NVMe Target
* Added support for setting specific LUN numbers on Storage volumes for Fibre Channel access. This is available in the Advanced tab of the Storage Volume Create and Modify dialogs. [ QSTOR-10544 ]

Service Core
* Improved efficiency for Ceph Bucket discovery. New Default behavior is to skip collecting life cycle policy and object locking data on the bucket. Contact support to enable object locking discovery on buckets. [ QSTOR-10600 ]

Upgrade Manager and Installer
* Added script to fix RGW configurations on clusters created on older versions of QuantaStor. [ QSTOR-10569 ]
* Added support for Ceph Reef 18.x upgrades. [ QSTOR-10493 ]

Web Manager
* Make the info fields, in the Snapshot Rollback Point fieldset of the Rollback Storage Volume dialog, read-only. [ QSTOR-10596 ]
* Hide the timezone column in the Upgrade Manager dialog. [ QSTOR-10540 ]
* Change S3 Bucket Search panel location from North to West of screen. [ QSTOR-10405 ]

== v6.4.1.011 (August 6th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.1 Upgrade Instructions| upgrading to QuantaStor v6.4.1]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with the Supermicro NVMe Enclosure mappings for the SBB-SSG-221E and SSG-641E [ QSTOR-10506 ]

Network Interfaces
* Fixed: Infiniband Devices should now have the correct Make and Model displayed in the Network interface section. [ QSTOR-10448 ]

Network Shares
* Fixed an issue with updating the status of Backup Policy Jobs. [ QSTOR-10517 ]

Remote Replication, Snapshots and Backup Policies
* Fixed: Shows the last 14 days in the replication schedule dashboard regardless of the replication schedule configuration. Fix an issue where not all series data was appearing despite being in a completed state. [ QSTOR-10528 ]
* Fixed an issue with duplicate Replication tasks. [ QSTOR-10526 ]
* Correct the max temporary snapshots retained for volumes in a replication schedule. [ QSTOR-10525 ]
* Add the ability to discover partially transferred chkpnts if replication is interrupted on the first transfer. [ QSTOR-10500 ]

Upgrade Manager and Installer
* Fixed: optimized dependency checker for qs-upgrade script. [ QSTOR-10531 ]

== v6.4.0.174 (July 18th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.0 Upgrade Instructions| upgrading to QuantaStor v6.4.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue with adding new ITSM webhook integrations. [ QSTOR-10480 ]
* Added support for Microsoft Teams to ITSM integrations. [ QSTOR-10458 ]
* Added the ability to easily extend ITSM integrations with new integration modules with qs_alerthandlers.conf file. [ QSTOR-10458 ]
* Include storage volumes in pool reports. [ QSTOR-10083 ]

Ceph Scale-out Block, Object and File
* Fixed an issue where the wrong libntirpc library was installed for nfs-ganesha. [ QSTOR-10463 ]
* Added a Copy to Clipboard Button for a selected access key and changed the double click on access/secret key behavior to copy to clipboard for the S3 User Access Key Manager Dialog. [ QSTOR-10428 ]
* Added a check to the S3 User Access Key Manager Dialog to ensure only the selected key text is shown when the user clicks the 'Show Key Text' button on the dialog. [ QSTOR-10428 ]
* Added block for more than 2 S3 Gateway loadbalancer modes configured at the same time. [ QSTOR-10407 ]
* Added a new feature for data pool capacity based, overflow rules for ceph object storage. Added support for a force flag for the auto tiering rules, that will overwrite any client side storage class specifications. [ QSTOR-10379 ]
* Add reporting for object storage usage. Periodic reports can be generated as part of "Report Schedules" by enabling "Object Zone Usage Report". [ QSTOR-10355 ]
* Added object count for Ceph Buckets. [ QSTOR-10348 ]
* Updated the default access permissions for Ceph keyring files. [ QSTOR-10325 ]
* Updated ceph cluster scale-out OSD osd_op_queue setting to wpq by default. The setting will take effect for any new OSDs on creation. Existing OSDs will use the new setting on OSD service restart (system reboot, encrypted OSD re-keying or manual OSD service restart) [ QSTOR-10123 ]
* Improved an error message when creating a Site Vif with Block Storage use case. [ QSTOR-9984 ]
* Added ability to enable a size quota and a file number quota on cephFS Shares. [ QSTOR-7344 ]

Enclosures and Controllers
* Fixed an issue where a disconnected JBOD could leave the enclosure object around on LSI HBAs. [ QSTOR-10503 ]
* Fixed: a modify of enclosure or system layout to something other than default will also set the same layout on the corresponding system or enclosure(s) that are currently set to default. [ QSTOR-10496 ]
* Fixed an issue with using the wrong LED control Utility for disk identification on Supermicro NVMe storage systems. [ QSTOR-10469 ]
* Added support for Supermicro SBB-SSG-221E-DN2R24R to enclosure/server views. [ QSTOR-10460 ]
* Added Support for Supermicro SSG-641E-E1CR36L/H to enclosure/server views. [ QSTOR-10429 ]
* Prevent a missing disk from being blinked. [ QSTOR-10179 ]

High Availability Failover
* Fixed an issue that could terminate the qs_pool_export script early on ha failover without final logging. [ QSTOR-10514 ]
* Fixed: added a check for HA VIFs to the network port offline dialog. This prevents a possible split cluster scenario. [ QSTOR-10414 ]
* Updated Task error messages to include the system where an error occurred for HA Storage pool failover tasks. [ QSTOR-10248 ]
* Added periodic HA failover group health checks for client and media connectivity. An alert will be raised If a health check fails that could indicate an issue with the future success of a High Availability failover from the primary to secondary node. [ QSTOR-9380 ]

Network Interfaces
* Prevent modifying parent port when static route is configured. [ QSTOR-10200 ]
* Fixed: removed iscsi and nvmeof portal configuration options on all grid vifs. client access should be configured through HA or Site cluster vifs only. [ QSTOR-9974 ]

Network Shares
* Fixed: NFS remove client access dialog and the qs share-client-remove CLI command now default to immediately terminate client connections for removed export rules, enhancing security. An option to retain client connections is available in the UI ("Retain Client Connections") and CLI (--retain-client-connection=true). [ QSTOR-10431 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Remote Replication reporting incorrect snapshot count. [ QSTOR-10476 ]
* Added a ZFS quantastor:scheduletype property to snapshots so that it is clearer what type of schedule created the snapshot. [ QSTOR-10421 ]
* Fix duplicate entries in replication dashboard. [ QSTOR-10385 ]
* Use raw mode for ZFS send and receive. Use on the wire compression if the source is not compressed. [ QSTOR-10153 ]

SNMP
* Update SNMP MIB [ QSTOR-10512 ]

Security
* Added feature to replace the OSD encryption keys for a given Ceph cluster. [ QSTOR-10283 ]
* Improved qs-util wrapper script so that user is prompted for secret passphrase. Passphrase will remain hidden. [ QSTOR-9982 ]

Service Core
* Fix minor trace message for Maintenance schedules. [ QSTOR-10416 ]
* Added a check to the QuantaStor system startup to ensure that LUKS encrypted Physical disks devices provided to QuantaStor via the iSCSI Software adapter are opened after system boot. [ QSTOR-10257 ]

Upgrade Manager and Installer
* Added support for customizing OVF templates with passwords and license keys. [ QSTOR-10451 ]
* Fixed an issue with the archived centos ganesha mirrors in the qs_upgrade_redhat8.sh install and upgrade script. [ QSTOR-10446 ]

Web Manager
* Fixed an issue where the User Web Customization rules were not being properly applied when the rules were defined in the Role create or modify dialog. [ QSTOR-10513 ]
* Fixed the text highlight and other colors used in the UI to be consistent across elements. [ QSTOR-10470 ]
* Update: Replaced all instances of 'double click to reveal plain text' on password fields with an explicit eyeball reveal button to allow users to show plain text. [ QSTOR-10410 ]
* Updated web manager tomcat and Java runtime dependencies. [ QSTOR-9492 ]

== v6.3.7.011 (June 18th 2024) ==

=== [[QuantaStor 6.3.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.7 Upgrade Instructions| upgrading to QuantaStor v6.3.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue with creating Erasure Coded Ceph Object Storage Classes in the Web UI. [ QSTOR-10434 ]

Dashboards and Analytics
* Fixed the install-ceph-prometheus scripts to always have a default fallback install version if the latest version is not available. [ QSTOR-10441 ]
* Updated wiki documentation for the Prometheus and Grafana Integration guide to reflect changes from latest Grafana 11.0 release. [ QSTOR-10441 ]

Enclosures and Controllers
* Fixed several items and updated logic for External System Corvault support. [ QSTOR-10235 ]

Kernel and Drivers
* * Fixed an issue with modern mellanox OFED installs using the mellanox-ofed-install.sh script and legacy ConnectX-3 Based Mellanox HBA's [ QSTOR-10295 ]

Network Shares
* Added logic to always bind mount the /export paths on Network Shares even if the share has no NFS access rules and is set to disabled and SMB/CIFS disabled. This includes Nested shares under Parent Network Shares. No noticeable increase in failover times was detected when testing on a Large HA config with many Network Shares including many Nested Shares and snapshots. [ QSTOR-10424 ]
* Fixed an issue with the Network Share snapshot count property. [ QSTOR-10329 ]
* Re-enabled the Network Share Snapshot count column by default in the Network Share Grid View. [ QSTOR-10329 ]

Storage Volumes
* Fixed an issue where FC ALUA standby LUN devices for Storage Volumes would not appear as non-rotational(SSD) to clients when on an SSD or NVMe based Storage Pool. Note: a reboot is required to reload the SCST kernel driver stack on the system for the fix to take effect. [ QSTOR-10417 ]
* Fixed an issue with presenting pass-through Storage Volumes as non-rotational(SSD) to clients. [ QSTOR-10417 ]

Upgrade Manager and Installer
* Updated mellanox-ofed-install.sh script to support latest Mellanox OFED 24.04-0.6.6.0 [ QSTOR-10438 ]
* Added a lts optional flag to the mellanox-ofed-install.sh for installing Mellanox OFED version 5.8-4.1.5.0. [ QSTOR-10438 ]

Web Manager
* Fix a minor ribbon bar alignment and spacing issue between elements by making a deferred force layout call during context switching. [ QSTOR-10413 ]
* Fixed an issue where some elements of the Ribbon Bar would not be visible or would somehow be under the visible section of the UI. [ QSTOR-10413 ]
* Removed the ZFS share encryption tab from the create and modify network share dialogs. The ZFS Share encryption feature is still available for share creation via the CLI but is not recommended for most users due to ZFS driver level issues. When the ZFS driver issues are resolved in a future ZFS release, the encryption tab will be re-enabled. [ QSTOR-10352 ]

== v6.3.6.003 (June 4th 2024) ==

=== [[QuantaStor 6.3.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.6 Upgrade Instructions| upgrading to QuantaStor v6.3.6]].

=== Release Notes ===
Remote Replication, Snapshots and Backup Policies
* Added a check to enforce 'Enable target checkpoint recovery (unchecking will perform full replication)' setting on Remote Replication Schedules. This helps ensure that no additional _chkpnt is created for a share or volume if one already exists for the source and target replication association. [ QSTOR-10419 ]
* Fixed an issue with replication report showing synchronizing state forever. [ QSTOR-10419 ]

Security
* Added qs-util wuicustomcerts command to allow creation of a /var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf nginx override config so that users can customize certificate paths and ciphers from the QuantaStor defaults for the Web UI. [ QSTOR-9037 ]

== v6.3.5.020 (May 23rd 2024) ==

=== [[QuantaStor 6.3.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.5 Upgrade Instructions| upgrading to QuantaStor v6.3.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where s3 gateway create was creating load balancers with https->https mode when https->http mode was passed in. [ QSTOR-10399 ]
* Fixed some issues with discovery of the http/https mode for the S3 load balancer. [ QSTOR-10399 ]
* Further optimizations and fixes related to Grid communication and Ceph Scale-out Object discovery on Object Storage Pools with a large number of buckets. [ QSTOR-10380 ]
* Fixed an issue with adding and removing RGW instances on the same node via different IP addresses. [ QSTOR-10370 ]

High Availability Failover
* Added logic to limit number of open threads and open file handles needed to unmount shares for the HA storage pool failover process. This fixes an issue with deployments that have a large amount of shares, including nested shares and share snapshots. [ QSTOR-10373 ]
* Added more coverage for the auto close open file handles logic during HA storage pool failover to help unmount shares under the nfs /exports path as well as nested shares/snapshots. [ QSTOR-10373 ]

Multitenancy
* Fixed some issues with Multitenancy Container discovery and database table updates. [ QSTOR-10363 ]

Network Interfaces
* Added a exact match filter config file /var/opt/osnexus/quantastor/conf/qs_portFilter.conf for interface names that allows users to blacklist interfaces they do not want QuantaStor to see and/or manage. [ QSTOR-9664 ]

Network Shares
* Fixed an issue with the Network Share samba audit logging feature when upgrading from a legacy audit logging config. [ QSTOR-10390 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Security
* Adds support for controlling the sample period over which bad login attempts can trigger a short or permanent lock. [ QSTOR-10374 ]
* Adds support for controlling the duration of the short lock. [ QSTOR-10374 ]
* Fixes a security bug where good login attempts could mask bad login attempts by clearing the bad login attempt sample set for a given user. [ QSTOR-10374 ]
* Changes the special rules around bad login attempts for the 'admin' user, now allowing it to be locked. [ QSTOR-10374 ]
* Adds a touch file to unlock the 'admin' user account. [ QSTOR-10374 ]
* Adds a touch file to block the permanent locking of the 'admin' user account, which is similar to the current behavior. [ QSTOR-10374 ]

Storage Volumes
* Fixed an issue where iSCSI CHAP was not being correctly enabled in the iSCSI target on volumes when configured. [ QSTOR-10398 ]
* Fixed an issue with Fibre Channel Storage Volumes being presented after Storage System boot for Single QuantaStor node deployments (non-HA). [ QSTOR-10277 ]

== v6.3.4.003 (May 14th 2024) ==

=== [[QuantaStor 6.3.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.4 Upgrade Instructions| upgrading to QuantaStor v6.3.4]].

=== Release Notes ===

Web Manager
* Optimized WebUI login time for Large Scale-out Object deployments. [ QSTOR-10365 ]
* Fixed an issue where the WUI idle logout timer would be reached even when browsing inside of the WUI for various different sections. [ QSTOR-10361 ]

== v6.3.3.033 (May 1st 2024) ==

=== [[QuantaStor 6.3.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.3 Upgrade Instructions| upgrading to QuantaStor v6.3.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added qs_rgw_iam_policy.sh script for generating S3api IAM compatible bucket policies. [ QSTOR-10336 ]
* Added FQDN specific string validation to the Modify Realm/Zone Group dialog. [ QSTOR-10320 ]
* Fixed some items with the Modify Realm/Zone Group task. [ QSTOR-10320 ]
* Added a drop-down to the Create Storage Class Dialog with pre-defined S3 Storage Classes supported by most S3 CLI and S3 Library based clients. Users can still create a custom Storage class if they so choose and use their own custom S3 API implementation that supports Custom S3 Storage Classes. [ QSTOR-10232 ]
* Fixed some issues with adding/removing S3 Gateways with Load Balancers. [ QSTOR-9848 ]

High Availability Failover
* Added a force flag to the Remove Site Cluster Virtual Interface dialog. [ QSTOR-8276 ]
* Added logic to auto re-apply iofencing to devices that are re-added to the system due to prior physical removal or power loss of the device/device enclosure. [ QSTOR-5475 ]
* Fixed an issue with enabling client connectivity on HA Groups and implemented more safe guards. [ QSTOR-3432 ]

Network Shares
* Add touch file to limit discovery of snapshots of nested shares. [ QSTOR-10334 ]
* Fixed: Network Share rename will correctly remount the /export/ NFS mount location to the new name. [ QSTOR-10318 ]
* Fix minor message during share disable with active SMB clients. [ QSTOR-10292 ]
* Share disable will close open file handles to the share when accessed via SMB. [ QSTOR-10291 ]
* Fixed an issue where Network sub-share alias shares would not start properly after Storage Pool HA Failover. [ QSTOR-10278 ]
* Fixed an issue where share alias advanced settings allowed modification after an HA failover. [ QSTOR-10276 ]

Remote Replication, Snapshots and Backup Policies
* Fix update selections for a replication schedule for cases where source is on a HA pool. [ QSTOR-10310 ]
* Fixed an issue with Windows Previous Versions on share-alias. [ QSTOR-10274 ]
* Added a check to ensure no duplicate share alias names are created on the same parent share. [ QSTOR-10274 ]

Security
* Fixed an issue where the Security Manager > Default Login Username field was not initializing to 'admin' for default installs and upgrades. [ QSTOR-10323 ]

Upgrade Manager and Installer
* Added logic to remove legacy google-compute-engine-oslogin and/or google-guest-agent on upgrade. These packages caused systems to not shutdown properly when installed. [ QSTOR-10340 ]
* Added a check to ensure the ledmon service is disabled by default. This is to ensure that there are no conflicts with the QuantaStor managed Disk Identify logic. [ QSTOR-10313 ]

Web Manager
* Added paging support to S3 Bucket search [ QSTOR-10324 ]

== v6.3.2.025 (April 15th 2024) ==

=== [[QuantaStor 6.3.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.2 Upgrade Instructions| upgrading to QuantaStor v6.3.2]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added search capability to the S3 Bucket section of the Web UI. [ QSTOR-10288 ]
* Added Rule Sorting and an explicit rule remove button to the Storage Class Auto-Tiering Rules Dialog. [ QSTOR-10287 ]
* Added: You can now add the FQDN's for DNS names that you want the S3 Gateways to respond to via the Modify Realm/Zone Group Dialog. Note: you must add the FQDN's of the hosts or an FQDN alias e.g. s3.yourdomain.net (like used by DNS round robin) for the HAproxy load balancer to work properly. [ QSTOR-10285 ]
* Fixed issues with Ceph S3 Bucket discovery with a large amount of buckets. [ QSTOR-10261 ]
* Fixed some items related to Veeam SOSAPI integration based on testing in Veeam Certifcation scripts. [ QSTOR-10243 ]

Enclosures and Controllers
* Fixed an issue where Dell RAID Controllers were being discovered twice in due to new support for the controllers discovery in Broadcom storcli utilities. [ QSTOR-10244 ]

High Availability Failover
* Fixed an issue where rebooting an active High Availability storage node would cause ZFS encrypted shares to go offline for any active pools on that node prior to automatic failover. [ QSTOR-10218 ]

Network Interfaces
* Fixed an issue where legacy VLAN interfaces that had the RX/TX optimizations flag set would not allow modification of the interface for any other setting. [ QSTOR-10272 ]

Not Set
* Added logic to prioritize high-speed data ports by default in the Ceph Cluster create and S3 gateway create dialogs. [ QSTOR-10266 ]
* Fixed usable space calculation on Object Pool Group when there are multiple Pools or Storage Classes using the same OSD's. [ QSTOR-10264 ]
* Fixed an issue with modifying a network share after after a custom veto files setting had been added to the samba cifs options. Now the veto files merge as a set with the default .qssnaps veto files used by the VSS GMT snapshots feature. [ QSTOR-10249 ]

Security
* Updated the OSNEXUS Security Notice service [https://services.osnexus.com/security/](https://services.osnexus.com/security/) for bionic and focal platform support. [ QSTOR-10269 ]

Service Core
* Added support for replacing ntpd with chronyd in Ubuntu Focal platform based deployments. [ QSTOR-10239 ]

== v6.3.1.009 (April 1st 2024) ==

=== [[QuantaStor 6.3.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.1 Upgrade Instructions| upgrading to QuantaStor v6.3.1]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where a pool running a scrub would report as degraded in the Config Analyzer health report. [ QSTOR-10258 ]

Ceph Scale-out Block, Object and File
* Added qs-rgw-moveobjects script to allow easier s3api copy-object of a buckets contents to a different storage class. [ QSTOR-10268 ]
* Changed haproxy load-balancer to use balance source mode by default. [ QSTOR-10260 ]
* Fixed an issue with the Storage Class Auto-Tiering rules where multipart uploads with Capacity Operators of greater than or greater and equal to the Capacity Threshold would not be uploaded to the correct storage class. [ QSTOR-10254 ]

Enclosures and Controllers
* Changed qs-util seagate-ap-split mode command to use zone 5 [ QSTOR-10259 ]

Web Manager
* Increased default max bucket count for S3 user to 100K. [ QSTOR-10256 ]
* Added new Grid Preferred Port status column in the Network Port Grid. It's hidden by default. [ QSTOR-10256 ]
* Fixed s3 gateway dialog height so it can show more nodes in the grid. [ QSTOR-10256 ]
* Fixed s3 tenant create, if "Display Name" is not specified use the "Name" (display name is no longer mandatory in dialog). [ QSTOR-10256 ]

== v6.3.0.268 (March 20th 2024) ==

=== [[QuantaStor 6.3.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.0 Upgrade Instructions| upgrading to QuantaStor v6.3.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where md software raid os partitions where being reported in the config analyzer as offline storage pools. [ QSTOR-10168 ]
* Fixed an issue where non-management ports were being flagged in the config analyzer for iSCSI acess being enabled. [ QSTOR-9891 ]

Ceph Scale-out Block, Object and File
* Blocked creating new OSDs when the OSD service is masked. [ QSTOR-10212 ]
* Show the S3 Object Storage Pool as the root node in the S3 User's and Tenant tree. [ QSTOR-10156 ]
* Show the S3 Object Storage Pool as the root node in the bucket tree. [ QSTOR-10150 ]
* Add support for multiple data pools for storage classes for Ceph Object Storage Pool. [ QSTOR-10137 ]
* Add auto tiering capability to ceph buckets. [ QSTOR-10125 ]
* Change the Ceph block storage pool to default to replica=3 for performance. [ QSTOR-10062 ]
* For CephFS, the min_size for the metadata pool should be 2. [ QSTOR-10015 ]
* Introduce safe disk replacement for Ceph OSDs. [ QSTOR-9937 ]
* Applied adjustments to Ceph Clusters for optimized scrubs on smaller and denser clusters. [ QSTOR-9900 ]
* Updated NFS Ganesha to 5.7 [ QSTOR-9821 ]
* Add support for Ceph Multi-site bucket replication. [ QSTOR-6570 ]

Disk Management
* Added support for ScaleFlux CSD 3000 SSDs that support builtin compression provisioning. [ QSTOR-10198 ]
* Fixed an issue with disk correlation by serial number on Broadcom/LSI 93XX series HBAs. [ QSTOR-10194 ]
* Show osd number in 'qs disk-list'. [ QSTOR-9717 ]

Enclosures and Controllers
* Add enclosure view for the ASUS 2u24 NVMe. [ QSTOR-10202 ]
* Fix controller selection issue in the 'Identify Hardware Controller Disk Device' dialog for when the selected object in the Physical Disk tree is a Physical Disk and not the Disk itself. [ QSTOR-10195 ]
* Updated wddcs tool to 3.2.8.0 [ QSTOR-10166 ]
* Added to feature to create or delete multiple External System Volume configurations. [ QSTOR-10061 ]

High Availability Failover
* Fixed an issue with the Create HA Failover Group Dialog when there are active FC sessions on volumes on the selected pool. [ QSTOR-10169 ]
* Changed NVMe reservations to use cptpl=2 when available so that iofencing is cleared on power on of a nvme drive. [ QSTOR-10124 ]

Licensing
* Added logic to auto-fetch new QuantaStor License Server ca certificates during online license activation. [ QSTOR-10174 ]

NAS Gateway / Cloud Containers
* Update rclone version. [ QSTOR-9512 ]

Network Interfaces
* Show static route parent port in the respective grid and delete dialog. [ QSTOR-10199 ]
* Fixed an issue with onlining/restarting offline VLAN interfaces. [ QSTOR-10180 ]
* Fixed an issue with VLAN ontop of Bonded ports on VM deployed QuantaStor instances. [ QSTOR-10180 ]
* Improve the Network bond mode descriptions, in the 'Create Bonded Port' dialog, for those that require managed switches. [ QSTOR-9842 ]
* Added IP address place holder for DHCP interfaces that have no assigned IP address. [ QSTOR-9828 ]
* Fixed an issue with downing virtual interfaces when converting to HA virtual interface. [ QSTOR-9774 ]

Network Shares
* Minor Web UI fix to display share quota percent utilization. [ QSTOR-10121 ]
* Implemented a Real Time Auto Copy feature to enhance data protection for Network Shares. [ QSTOR-9929 ]
* Updated Focal platform Samba to 4.18.6 backported from ubuntu upstream release. [ QSTOR-9924 ]
* Show parent shares in the 'qs share-list' command results. [ QSTOR-9702 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Remote Replication, Snapshots and Backup Policies
* Add the ability to force create symbolic links for backup policy outbound-move to cloud containers without a delay of 24 hours. [ QSTOR-10136 ]
* Update Replication Report Summary object as failed if source system reboots right after schedule is triggered. [ QSTOR-10097 ]

SNMP
* Regen SNMP MIB for 6.3 [ QSTOR-10228 ]

Security
* Updated JQuery version used in the QuantaStor WebUI to 3.7.1 [ QSTOR-10064 ]
* Add Audit Log Viewing to the Storage System menus. [ QSTOR-10031 ]

Storage Pool Management
* Improved logic for replacing zpool UNAVAIL disks that are identified by their id instead of a device path as the disk is no longer present or visible to the OS. [ QSTOR-10129 ]

Upgrade Manager and Installer
* Automatically disable and mask uefi fwupd service on platforms that include it to prevent unplanned firmware updates. [ QSTOR-10205 ]
* Fixed: the low boot space warning for kernel upgrades now correctly appears in the Upgrade Manager task failure message. [ QSTOR-10185 ]
* Fixed an issue where the scst/zfs userspace packages were not being pinned on security updates. [ QSTOR-10185 ]
* Fixed an issue where qstortarget was incorrectly selected during security updates but fails due to existing pinning rules. qstortarget now correctly only gets selected for install on kernel/driver upgrades. [ QSTOR-10185 ]

Web Manager
* Minor fix to show NA for share-alias space columns. [ QSTOR-10227 ]
* Login dialog shown after service restart is complete. [ QSTOR-10007 ]

== v6.2.8.016 (March 5th 2024) ==

=== [[QuantaStor 6.2.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.8 Upgrade Instructions| upgrading to QuantaStor v6.2.8]].

=== Release Notes ===

Enclosures and Controllers
* Fixed Hardware Disk to Physical disk slot correlation issues. [ QSTOR-10135 ]
* Improved Enclosure object guid uniqueness to better support more complex/multipath setups for hardware disk to physical disk mapping. [ QSTOR-10135 ]
* Added Hardware Enclosure Serial\# property and logic to discover serial\# when available. [ QSTOR-10102 ]

Multitenancy
* Updated Resilio container image to 3.8.1.2250 [ QSTOR-10162 ]
* Fix errors with Resilio container errors seen after upgrade. [ QSTOR-10099 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue that could sometimes cause duplicate snapshot objects to appear for snapshot schedules with nested shares and recursive snapshot enabled. [ QSTOR-10159 ]
* Added a check to temporarily prevent adding ZFS dataset encrypted Network Shares to remote replication schedules until the Open ZFS issue \#12014 is resolved in an upcoming ZFS release. [ QSTOR-10145 ]
* Fixed an issue with using Windows Restore Previous Versions on remote Replica \_chkpnt Network Shares. [ QSTOR-10065 ]

SCSI / NVMe Target
* Updated SCST driver to 3.8.0.9038-f134517-qs01 to support latest available linux kernels for Focal platform and Focal cloud platform kernels. [ QSTOR-10151 ]

Upgrade Manager and Installer
* Added Kernel Driver Support for QuantaStor installation on Ubuntu 20.04 images on Azure, AWS and Google Cloud. [ QSTOR-10138 ]

== v6.2.7.002 (February 23rd 2024) ==

=== [[QuantaStor 6.2.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.7 Upgrade Instructions| upgrading to QuantaStor v6.2.7]].

=== Release Notes ===

Licensing

* Updated license manager certificates for online license activation. [ QSTOR-10154 ]

== v6.2.6.024 (February 8th 2024) ==

=== [[QuantaStor 6.2.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.6 Upgrade Instructions| upgrading to QuantaStor v6.2.6]].

=== Release Notes ===

Enclosures and Controllers

* Added support for iofencing NVMe disks that do not support cdw11 [ QSTOR-10087 ]
* Added an Alert for when a OS Software RAID1 mirror enters a degraded state. [ QSTOR-10080 ]
* Added support LSI-3008C0 model controllers. [ QSTOR-9841 ]
* Added a check to hardware Enclosure Discovery to automatically filter out enclosures that do not have any drive slots. [ QSTOR-9716 ]

High Availability Failover

* Fixed an issue with the I/O fencing tool where it was reporting not-supported on reservation capable nvme devices. [ QSTOR-10114 ]

Network Interfaces

* Updated static routes to use modern ip route syntax with the 'proto static' option. [ QSTOR-10103 ]
* Updated netplan conversion to by default create static routes using ip route to match the original netplan static route rules. [ QSTOR-10103 ]

Storage Pool Management

* Fixed: Activate HA Failover Group now works for Storage Pools in a degraded state missing a few devices. [ QSTOR-10100 ]
* Fixed: Create HA Failover Group now allows a force option if there are a small number of drives missing on the secondary node. Note that the operation will still be blocked if most/all of the drives are missing from the secondary node. [ QSTOR-10100 ]
* Added support for Zero Touch Maintenance Automatic Global Hot spare marking of Hardware RAID0 Passthrough units. [ QSTOR-9865 ]

Storage Volumes

* Fixed: NVMe Target Storage volumes now persist their serial numbers correctly on reboot [ QSTOR-9992 ]
* Fixed: the NVMe Target now correctly re-exports the allowed portals on system boot. [ QSTOR-9992 ]

Upgrade Manager and Installer

* Updated mellanox-ofed-install.sh script to support the latest Focal platform 5.15.0-91-generic kernel. [ QSTOR-10117 ]
* Updated the GPG repo keys for QuantaStor RedHat / and Almalinux platform installs [ QSTOR-10107 ]
* Fixed a incorrect error log when upgrading the Kernel and Drivers on the Ubuntu Focal platform. The upgrade would succeed when the error was seen, but it was unclear to the user without full log analysis. [ QSTOR-10106 ]
* Updated upgrade manager logic to ensure recommended dependency packages are always selected for install during core service and security upgrades. [ QSTOR-10101 ]
* Fixed an issue with the qs-distupgrade script where some QuantaStor core package changes were not being applied after a platform dist-upgrade from bionic to focal. [ QSTOR-10132 ]
* Added better logging of systemctl service enablement and restart during qstorservice package installs. [ QSTOR-10134 ]

== v6.2.5.032 (January 18th 2024) ==

=== [[QuantaStor 6.2.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.5 Upgrade Instructions| upgrading to QuantaStor v6.2.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added ssh port 22 to network connectivity checker tests. [ QSTOR-10092 ]

Ceph Scale-out Block, Object and File
* Fix bug where ceph monitor daemon is disabled. [ QSTOR-10095 ]
* Added script to setup Ceph multi-site replication. [ QSTOR-10075 ]

Enclosures and Controllers
* Updated storcli version to 007.2705.0000.0000 [ QSTOR-10072 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-10036 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-9825 ]

Kernel and Drivers
* Updated Linux Kernel to 5.15.0-91-generic for Focal platforms [ QSTOR-10025 ]
* Linux Kernel 5.15.0-91-generic includes fixes for NFS v3 lockd that would cause file handles to be left open for NFSv3 clients when attempting to stop the nfs server before ZFS pool export during HA failover. [ QSTOR-10025 ]
* Updated ZFS to 2.1.14.qs25 for Focal platforms [ QSTOR-10025 ]

Multitenancy
* Fix an issue with missing Service Configs. [ QSTOR-10079 ]
* Add the ability to sync nested shares when parent share is selected in Resilio. Optionally skip changing the share permissions when user is specified in the config file. [ QSTOR-10070 ]

Network Shares
* Block rename of nested shares. [ QSTOR-10091 ]
* Add the ability to enable and clone a GMT snapshot [ QSTOR-4145 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue where Remote Replication Schedules can fail if 2 source snapshots have the same created timestamp. [ QSTOR-10059 ]
* Fix a minor issue with File Age settings in the Backup Schedule Modify dialog. [ QSTOR-10056 ]
* Properly transition a Replication task and Replication Report to the 'failed' status if the source system loses power during the Replication. [ QSTOR-10041 ]
* Add a warning if checkpoint is selected in create snapshot schedule. [ QSTOR-10038 ]

Storage Volumes
* Fixed an issue with zfs storage volumes being correctly marked as missing if the underlying zfs zvol or snapshot is removed or unavailable. [ QSTOR-10086 ]

Upgrade Manager and Installer
* Added a --password option to the qs\_install.sh script to allow users to provide the QuantaStor admin user password as well as the same password for the default qadmin shell account. [ QSTOR-10085 ]

Web Manager
* Clear the replica summary graph when there are no report entries. [ QSTOR-10057 ]
* Fix enclosure graph rendering issue where a selected system with multiple valid controllers was not being render because of one underlying MD BOOT Controller. [ QSTOR-10055 ]

= Archived Change Logs =

== [[Change Log Archive 2023]] ==

== [[Change Log Archive 2022]] ==

== [[Change Log Archive 2021]] ==

== [[Change Log Archive 2020]] ==

== [[Change Log Archive 2019]] ==

== [[Change Log Archive 2018]] ==

== [[Change Log Archive|Change Log Archive pre-2018]] ==

Select the link above to see the [[Change Log Archive]] of older revisions.

QuantaStor 6.8.3 Upgrade Instructions

2026-08-06T20:19:35Z

Qadmin: Create QuantaStor 6.8.3 Upgrade Instructions

= Upgrading to 6.8.3, and Latest OS Packages and Security updates via Command Line Interface =

'''This is the recommended option for systems running 6.x QuantaStor versions on the Focal Platform, and systems that may be out of date and require OS level package updates as well.'''

This procedure will upgrade the QuantaStor system to the latest software version, and also update all OS level packages to their latest versions as well, ensuring the system software has the latest security patches in place.

It is recommended that you schedule a downtime work window, as a reboot may be required for changes in the 6.8.3 upgrade. You will need to run these commands as a user with sudo access on the QuantaStor appliance, such as the default 'qadmin' account, or as root if you have enabled direct root access.

:''NOTE: We recommend allocating a maintenance window for all upgrades. For more complex upgrades we recommend scheduling time with OSNEXUS support for assistance.''

'''Login to the CLI to perform a full upgrade to QuantaStor 6.8.3 along with the latest Kernel and Security and OS packages.'''

<pre>
# For Noble platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-noble/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Jammy platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-jammy/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Focal platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-focal/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true
</pre>

Once the install completes you will be running QuantaStor 6.8.3

'''Platform Upgrades from Jammy to Noble via the qs-distupgrade command are enabled with the 6.8.0 release.'''

'''Platform Upgrades from Focal to Jammy via the qs-distupgrade command are enabled with the 6.5.1 release.'''

'''Platform Upgrades from Bionic to Focal via the qs-distupgrade command are enabled with the 6.0.4 release.

'''Platform Upgrades from Xenial to Bionic via the qs-distupgrade command are enabled with the 5.10.2 release.

'''OSNEXUS Support recommend fully upgrading to the latest available, including System and Kernel Updates using the commands above. Please contact Support for assistance with a platform upgrade.'''

'''Platform Upgrades via the qs-distupgrade command from QuantStor 4.x on Trusty are enabled with the 4.7.2 release. '''

'''Please contact support@osnexus.com if you have any questions or need upgrade assistance.

QuantaStor Version ChangeLog

2026-08-06T20:19:35Z

Qadmin: Add v6.8.3.018 release notes

[[Category:Support guide]]
= Change Log Overview =
The change log contains a detailed summary of the changes made for each new release of QuantaStor. Each change made to QuantaStor is tracked with an engineering ticket number in the form '''[QSTOR-NNNN]'''. This information is provided so that if you're working with OSNexus support you can track the availability of a given product feature add, improvement, or maintenance fix to a specific release. For information on how to upgrade your storage system please see the [[QuantaStor Upgrade Guide|Upgrade Guide]].

== Versioning System ==
QuantaStor version numbers consist of four (4) parts. A major number (M), minor number (N), maintenance update number (U) and build number (B) of the form M.N.U.B such as 6.0.2.006.

QuantaStor upgrades go directly from whatever version you are running to the latest version, with no interim steps so for example if you are at v6.0.1 you will upgrade directly to the latest version which may be v6.1.2

== Product Update Types ==

==== Major Updates (X.y.z) ====
If the first digit in the version number has changed this indicates a major product release such as QuantaStor v5 to QuantaStor v6. Major releases generally come with a new underlying Linux platform as the basis. For example, the standard ISO install for QuantaStor v5 is based on Ubuntu 18.04 whereas QuantaStor v6 is based on Ubuntu 20.04. Major product releases generally include new features and maintenance updates and are supported on multiple underlying Linux platforms. For example, QuantaStor v6 is available as an upgrade on Ubuntu 18.04 and Ubuntu 20.04 based systems as well as RHEL and RHEL derivative platforms. Platform upgrades to move systems forward (eg 18.04 to 20.04) are made generally available in the first feature update release, such as QuantaStor 6.1.

==== Feature Updates (x.Y.z) ====
If the second digit in the version number has changed this indicates a feature release such as 6.'''1''' going to 6.'''2'''. Feature releases add new product features as well as a maintenance updates. No additional licensing is required to access any new features that added but note that QuantaStor licenses do not include licenses for 3rd party products and services that may integrate with QuantaStor.

==== Maintenance Updates (x.y.Z) ====
If the third digit of the version number has changed this such as 6.0.'''2''' or 6.0.'''3''' it represents a maintenance update to address one or more support tickets. These updates generally do not contain new features, only fixes to address specific issues. Maintenance releases generally ship every 4 to 8 weeks. All maintenance "aka hot-fix" releases are provided against the current stable release so upgrading to the latest QuantaStor version is generally required to apply them.

==== Build Number (x.y.z.BBB) ====
The build number and corresponding build reference hash can be largely ignored. The build number simply increments with each commit that is made to the source tree. The hash is provided to make it easier for OSNEXUS support and engineering to quickly confirm difference between your current running release and any more modern release.

== Boot Install Image and other downloads ==
=== ISO/DVD/USB Boot Install Image ===

* The latest version of QuantaStor can be found on our [https://downloads.osnexus.com downloads page here].

* [[QuantaStor Installation via USB Thumb Drive|Bootable Flash Drive instructions.]]

NOTE: Archived older versions of QuantaStor ISO install media and CLI tools can be found [https://downloads.osnexus.com.s3.us-east-1.amazonaws.com/list.html here].

= Recent Change Logs =

== v6.8.3.018 (August 6th 2026) ==

=== [[QuantaStor 6.8.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.3 Upgrade Instructions | upgrading to QuantaStor v6.8.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Creating or removing a Ceph object storage class now commits the RGW period so it takes effect immediately. [ QSTOR-11938 ]
* A failed bucket enumeration is no longer treated as an empty list, which could silently drop bucket configuration. [ QSTOR-12130 ]
* Ceph object pool group creation now commits the RGW period, fixing persistent RGW realm/master-zone errors. [ QSTOR-12132 ]

Network Shares
* Fixed Active Directory join failures on domains that use older Kerberos encryption methods. [ QSTOR-11646 ]
* Changed: Active Directory joins now set 'restrict anonymous = 2' in smb.conf to block unauthenticated SID/RID enumeration. [ QSTOR-11834 ]
* Fixed: Active Directory joins no longer fail when the computer-account OU contains a space. [ QSTOR-11895 ]
* Fixed: Active Directory joins no longer disable SASL signing in the system-wide ldap.conf. [ QSTOR-11926 ]
* Added a 'Skip DNS registration' option to the Active Directory join dialog, CLI and API for sites whose DNS is managed outside AD. [ QSTOR-12083 ]
* Fixed a custom autorid Domain Range Size being discarded during an Active Directory join. [ QSTOR-12089 ]
* The Active Directory KDC field now accepts a comma-separated list of domain controllers for Kerberos failover. [ QSTOR-12091 ]
* Active Directory joins in SSSD modes no longer force user/group enumeration, which could stall startup on large domains. [ QSTOR-12092 ]
* Fixed: Active Directory joins now send the machine-account password update to the PDC Emulator, fixing 'Message stream modified' failures. [ QSTOR-12136 ]
* Fixed: leaving an Active Directory domain now updates the web UI immediately instead of still showing the old domain. [ QSTOR-12153 ]
* Changed: the Active Directory join dialog now labels its two ID-range sections distinctly so it's clear which is being edited. [ QSTOR-12154 ]

Service Core
* Memory optimization for grid event handling. [ QSTOR-12112 ]

Upgrade Manager and Installer
* The upgrade system now fetches and verifies the latest OSNEXUS package signing key before applying updates. [ QSTOR-9551 ]
* Fixed EL8 upgrades pinning a stale awscli/qstoraws package version from the RedHat repository. [ QSTOR-11991 ]
* In-place Ceph upgrades now install the shipped Ceph 20.2.2 release instead of an older pinned version. [ QSTOR-11998 ]
* Fixed a grafana-enterprise package upgrade failure that could leave dpkg in a held state during upgrades from 6.8.1. [ QSTOR-12075 ]
* Updated the Ubuntu 24.04 upgrade configuration to the shipped kernel and Ceph 20.2.2 versions. [ QSTOR-12077 ]

== v6.8.2.002 (July 24th 2026) ==

=== [[QuantaStor 6.8.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.2 Upgrade Instructions | upgrading to QuantaStor v6.8.2]].

=== Release Notes ===

Network Shares
* Fixed: AD groups could not be added to a Network Share ACL in Winbind+SSSD mode (group@DOMAIN form could not be resolved). [ QSTOR-12025 ]

== v6.8.1.007 (July 18th 2026) ==

=== [[QuantaStor 6.8.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.1 Upgrade Instructions | upgrading to QuantaStor v6.8.1]].

=== Release Notes ===

Upgrade Manager and Installer
* Fixed: platform upgrades remove the obsolete linux-tools-common package that could trigger security alerts. [ QSTOR-10314 ]
* Changed: qs-distupgrade output is timestamped and includes a pre-upgrade configuration report. [ QSTOR-11632 ]
* Added: platform distribution upgrade (qs-distupgrade) from Ubuntu 22.04 to 24.04. [ QSTOR-11651 ]
* Added: non-interactive flags for qs-distupgrade enabling fully unattended platform upgrades with automatic reboot. Use the qs-distupgrade --help to review the available usage options. [ QSTOR-11918 ]
* Fixed: platform distribution upgrades keep Ceph pinned at its current version. [ QSTOR-11955 ]
* Added: qs-distupgrade requires all Ceph nodes on the latest offered Ceph version (--skip-check-ceph-latest to override). [ QSTOR-11958 ]
* Fixed: coordinated Ceph upgrades restart all RGW daemons on hosts running multiple RGW services. [ QSTOR-11983 ]
* Fixed: a 6.8.0-only issue where service-driven package upgrades reported success without installing anything. [ QSTOR-11992 ]

== v6.8.0.205 (July 8th 2026) ==

=== [[QuantaStor 6.8.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.0 Upgrade Instructions | upgrading to QuantaStor v6.8.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert webhook support for Google Chat. [ QSTOR-9793 ]
* Allow users to have a subset of alert subscriptions. [ QSTOR-11683 ]

Ceph Scale-out Block, Object and File
* Added an 'Enable Versioning' checkbox to the Create Bucket dialog (automatically enabled when object locking or governance/compliance is selected); versioning can also be enabled on existing buckets. [ QSTOR-10937 ]
* Added Ceph Tentacle 20.2.2 support to the Jammy QuantaStor ISO and package mirror. [ QSTOR-11441 ]
* QuantaStor 6.8 ships Ceph 20.2.2 (Tentacle), which includes the upstream MDS fix (tracker #76031) for the SIGABRT/crash on client eviction caused by a null MDRequestRef under sustained metadata contention. [ QSTOR-11504 ]
* The Ceph Tentacle 20.2.2 release resolves frequent radosgw (RGW) crashes related to Kafka bucket notifications. [ QSTOR-11687 ]
* Fix ceph bucket delete with large number of objects timing out. [ QSTOR-11728 ]
* Removed: the deprecated S3 bucket orphan-object cleanup feature; any existing scheduled task is disabled automatically on upgrade. [ QSTOR-11729 ]
* Fixed a regression where deleting multiple Ceph (RBD) volumes at once on a multi-node cluster would fail after the first volume. [ QSTOR-11756 ]
* Added support for major-version Ceph upgrades (through Tentacle 20.2.x) in the upgrade script. [ QSTOR-11762 ]
* Increase the timeout for "Add Node" to a ceph cluster [ QSTOR-11906 ]

Dashboards and Analytics
* Added: a 'qs-statsdb resetpassword' command to rotate the InfluxDB stats password; telegraf is updated in lockstep so dashboards keep working. [ QSTOR-11170 ]
* Rebuilt bundled telegraf with its vendored rclone library updated to 1.74.3, clearing CVE-2026-41176 and CVE-2026-41179. [ QSTOR-11771 ]
* Fixed the Ceph RGW dashboard on Ceph Tentacle so it correctly reports throughput/latency when transferring files to a bucket. [ QSTOR-11803 ]

Enclosures and Controllers
* Fixed issue with "disappearing" enclosures [ QSTOR-11676 ]
* Added support for the Supermicro SSG-222B-NE3X24R all-NVMe server, including hardware enclosure auto-detection, enclosure layout and diagram, and NVMe drive slot mapping in the QuantaStor web management interface. [ QSTOR-11712 ]

High Availability Failover
* Add logging for manually run iofence commands [ QSTOR-11751 ]
* Fixed HA pool failover persisting a stale size=0 / isMounted=false when the pool's datasets were still mounting during fast-import; the last-known-good size and mount state are now preserved (and the corrected record wins via a bumped modified timestamp). [ QSTOR-11818 ]
* Fixed: Storage Pool HA io-fencing and failover now work over NVMe-TCP; target namespaces advertise persistent reservations. [ QSTOR-11850 ]

Kernel and Drivers
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]
* Updated the Mellanox OFED driver installer for current Ubuntu 22.04 (Jammy) kernels, fixing driver installation failures on recent kernels. [ QSTOR-11709 ]

Multitenancy
* Added RBD namespace support, allowing multiple tenants to share a single Ceph block pool with isolated volumes. [ QSTOR-11650 ]

NAS Gateway / Cloud Containers
* Add a fix for Samba access to Cloud Container shares. [ QSTOR-11763 ]
* Fixed: cloud containers are now accessible over SMB, not just NFS. [ QSTOR-11824 ]
* Updated the bundled AWS CLI to version 2.35.6. [ QSTOR-11827 ]

Network Interfaces
* Added DOCA OFED install script for jammy and upcoming noble platforms as an optional install for latest hardware. [ QSTOR-11069 ]
* Fixed the Network Interface Rename feature on systems upgraded from older releases where the 'ip' command resides in a different path. [ QSTOR-11614 ]
* Fixed: converting a local VIF to an HA VIF now preserves the original local interface if the conversion fails, so client connectivity isn't lost. [ QSTOR-11706 ]

Network Shares
* Add the ability to specify per user or group permissions on Network Shares during create or modify [ QSTOR-10662 ]
* Fixed: intermittent 'NFS server not responding' stalls under load by raising the nfsd listen backlog from 64 to 4096. [ QSTOR-10872 ]
* Fixed: NFS client entries can now be added or removed on a share while a long-running replication or snapshot task is using it, instead of queuing. [ QSTOR-11571 ]
* Consolidated the Network Share create/modify dialog's Permission Settings into the File Masks tab — now a single 'File Masks & Permission Settings' tab containing Owner Permission Settings plus the Directory and File Create Permissions Masks. [ QSTOR-11625 ]
* Reduced excessive event logging (event spam) for network shares and related grid objects. [ QSTOR-11695 ]
* Fixed handling of CIFS share options so empty/null option values are no longer written to the Samba configuration. [ QSTOR-11731 ]
* Fixed an issue where an Active Directory group added to a share's permissions was not preserved, and excluded built-in/default AD groups from the group picker. [ QSTOR-11767 ]

Remote Replication, Snapshots and Backup Policies
* Copy source Network Share settings to the destination share after replication. [ QSTOR-5738 ]
* Add support for rollback of Storage Volumes and Network Shares for a replication schedule [ QSTOR-6227 ]
* Minor updates to the auto snapshot cleanup tasks for replication schedules. [ QSTOR-11622 ]
* Fix auto create of replication association after failover [ QSTOR-11700 ]
* Snapshot schedule now shows the state detail when schedule is disabled by user. [ QSTOR-11717 ]
* The Snapshot Schedule properties page now displays Retention Tags. [ QSTOR-11719 ]
* Changed: Auto-tier backup policies now display as 'Auto-Tier >> Outbound' instead of 'Move >> Outbound'. [ QSTOR-11764 ]
* Fixed the CLI replication-schedule rollback so volume and share names are accepted (not just IDs), and rolling back only volumes (or only shares) no longer also rolls back the other type. [ QSTOR-11814 ]

SCSI / NVMe Target
* Added: a 'Select Initiator...' picker in the Add Host dialog to choose a discovered FC remote initiator WWPN instead of typing it. [ QSTOR-10741 ]
* Renamed the sys-list 'Firmware Version' column to 'SCSI Target Version' and corrected the value to show the actual SCST target-driver version (e.g. scst-3.10.0.qs01-...) instead of the literal 'scst-SCST'. [ QSTOR-11854 ]

Security
* Added support for Okta multi-factor authentication. [ QSTOR-9399 ]
* Added Multi-Admin Approval support, allowing deletion of pools, buckets, shares, and volumes to require approval from a configurable number of administrators. [ QSTOR-11344 ]
* Fixed certificate update failures when using a certificate template, and ensured dependent services (such as HAProxy and RGW) are restarted after a certificate replacement. [ QSTOR-11678 ]
* Fixed an issue in the Security Manager dialog where it was showing the "password policy change" warning confirmation when no fields were changed. [ QSTOR-11708 ]
* InfluxDB (port 8086) now requires authentication and binds to localhost by default; remote access is opt-in via the tf_influxdb_remote_access.enable touchfile (authentication still enforced). [ QSTOR-11759 ]
* Added the Ubuntu security apt repositories to the default package sources and removed unused bundled components flagged by scanning (Chronograf, the LXD/core20/snapd snaps, the docker-scan plugin), clearing CVE-2024-41110, CVE-2026-34177/-34178/-34179, CVE-2020-14343, CVE-2025-68121, and CVE-2024-45337. [ QSTOR-11760 ]
* Rebuilt the bundled QuantaStor Go tools (qs_iofence, qs_pool_export_helper, qs_diskinfo) and s5cmd with a current Go toolchain, clearing CVE-2025-68121, CVE-2024-45337, CVE-2024-24790, CVE-2023-24540, and CVE-2023-24538. [ QSTOR-11761 ]
* Hardened the internal QuantaStor script service (scriptsvc): removed a command-injection vector in request handling and now enforce the service's authorization check on every call. Addresses ZDI-CAN-30036 [ QSTOR-11799 ]
* Made a number of usability and reliability improvements to the multi-admin delete-approval workflow. [ QSTOR-11804 ]

Service Core
* Fix tag-set where custom key/value tags were not appearing for User objects. [ QSTOR-11528 ]
* Improved Ceph OSD daemon restart handling during upgrades and reduced database load on large-scale clusters. [ QSTOR-11675 ]
* Fixed an issue with QuantaStor management service memory usage when a grid node was offline. [ QSTOR-11693 ]
* Improved crash handling and diagnostic tracing for coordinated tasks, during operations such as adding a Ceph RADOS Gateway across multiple nodes. [ QSTOR-11702 ]
* Improved logging and error checking for QuantaStor configuration database backups, including capturing error output when a backup fails. [ QSTOR-11742 ]
* Expanded diagnostic log collection to capture additional network routing details (ip route output and static-route configuration). [ QSTOR-11748 ]
* Fixed the Sessions view showing stale SMB/NFS client sessions that lingered after a reboot; the share session monitor now forces a full re-sync on its first poll after startup so sessions left over from before the reboot are cleared. [ QSTOR-11757 ]
* Fixed a self-sustaining grid event flood triggered when creating CephFS/CIFS network shares at scale: nodes no longer re-cache remote-origin (sync-applied) events, and CIFS options are diff-merged to secondaries, eliminating the event resync cascade. [ QSTOR-11785 ]
* qs-sendlogs now writes a qs_logs.runtime.info file recording the options and variables used during log collection, and reliably scrubs sensitive data from the collected database. [ QSTOR-11897 ]

Storage Pool Management
* Added automated ordered-disk-list pool creation for Seagate Corvault and WD Data24 systems, simplifying creation of fully redundant storage pools. [ QSTOR-11538 ]
* Fixed software-encrypted pool creation so a disk block-size mismatch is detected before disks are encrypted, avoiding leftover encryption mappings. [ QSTOR-11599 ]
* ZFS deduplication now uses the faster fast_dedup mode by default, improving sustained deduplication performance. [ QSTOR-11714 ]
* When a LUKS-encrypted disk member of a pool momentarily goes offline and the hot-spare swap-in completes, if the "bad" disk in question has in the meantime come back online, its iofence status, encryption status and its related properties in its respective disk object are cleared up, making the disk available for use again. [ QSTOR-11738 ]
* Resolved a boot-time race where the OS-level zfs-import-cache.service could import ZFS pools before qs_service started. QuantaStor now imports pools with cachefile=none, masks the zfs-import-cache and zfs-import-scan services on install and upgrade, and clears the stale global ZFS cache file at boot, ensuring QuantaStor remains the sole coordinator of pool imports. [ QSTOR-11752 ]
* Add the ability to create a Storage Pool checkpoint for scale-up pools [ QSTOR-11784 ]
* Added a support-only, touchfile-gated pool-export triage call-out (qs_pool_export_triage.sh) that gathers diagnostics when a share or volume is still open during a storage pool export. Off by default (enabled via the tf_pool_export_triage.enable touchfile). [ QSTOR-11807 ]
* Resolved issue preventing HA failover functionality using SED drives. [ QSTOR-11832 ]

Upgrade Manager and Installer
* Added retry logic with a timeout to the Ceph upgrade script's daemon restarts so transient restart failures no longer abort the upgrade. [ QSTOR-10598 ]
* Fixed focal-to-jammy distribution upgrades leaving the HA cluster service (pcsd/pacemaker) inoperative due to a missing ruby-webrick dependency on Ruby 3.0+. The upgrade now installs ruby-webrick so HA failover keeps working. [ QSTOR-11841 ]
* Fixed focal-to-jammy distribution upgrades that could abort and roll back when Ubuntu's unattended-upgrades/apt-daily held the apt lock or needrestart blocked on a prompt. QuantaStor now disables automatic apt upgrades and runs the distribution upgrade non-interactively. [ QSTOR-11874 ]
* Fixed a Noble (24.04) upgrade failure where qs-upgrade aborted because the dpkg package version string could not be parsed. QuantaStor now compares Debian package versions using dpkg's native version ordering. [ QSTOR-11881 ]

Web Manager
* Minor fix to the "Copy to Clipboard" for task descriptions [ QSTOR-9574 ]
* Added a method field and a sortable timestamp column to the web interface Audit Log Analyzer. [ QSTOR-11191 ]
* Updated web interface translations across the major supported languages. [ QSTOR-11585 ]
* Added a 'Create Share' option to the share template menu to quickly create a share applying all of a template's settings. [ QSTOR-11595 ]
* Fixed the web interface to display all configured Ceph MDS daemons instead of limiting the list to five. [ QSTOR-11615 ]
* Add auto select convenience buttons to the Storage Volume multi-delete dialog. [ QSTOR-11707 ]

== v6.7.6.001 (June 25th 2026) ==

=== [[QuantaStor 6.7.6 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.6 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.6 Upgrade Instructions | upgrading to QuantaStor v6.7.6]].

=== Release Notes ===

Storage Pool Management
* Fixed a service crash that could occur when creating a LUKS-encrypted storage pool on NVMe devices. [ QSTOR-11876 ]

== v6.7.5.013 (May 21st 2026) ==

=== [[QuantaStor 6.7.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.5 Upgrade Instructions | upgrading to QuantaStor v6.7.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert triggers for disks with SMART medium errors. [ QSTOR-11652 ]

Ceph Scale-out Block, Object and File
* Adds new qs-cephfsutil for transparent movement of files between data pools via server-side copy [ QSTOR-11543 ]

Kernel and Drivers
* Added RedHat Platform kernel 4.18.0-553.124.1.el8_10.x86_64 support via DKMS driver build [ QSTOR-11679 ]
* Updated SCST driver to 3.10.0.qs01.9273.1b48521 with a patch that allows for dkms builds/support on non-preferred 5.15.x kernels on jammy platforms. [ QSTOR-11672 ]

Remote Replication, Snapshots and Backup Policies
* Minor fix while loading snapshots in the UI. [ QSTOR-11624 ]

Service Core
* Fixes bug where partial upgraded node would be skip daemon restart phase at version check. [ QSTOR-11703 ]
* Fixed a rare race condition where adding a Ceph Object (RADOS) Gateway on a multi-node cluster could silently crash. [ QSTOR-11689 ]
* Added defensive exception handling and trace coverage around coordinated task execution. [ QSTOR-11689 ]

Storage Pool Management
* Fix allows for creation of TRIM maintenance schedules on pools with special vdevs. [ QSTOR-11663 ]

Web Manager
* Add graphs for replication task status details. [ QSTOR-11661 ]
* Make improvements in the replication reporting area. [ QSTOR-11661 ]

== v6.7.4.011 (April 30th 2026) ==

=== [[QuantaStor 6.7.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.4 Upgrade Instructions | upgrading to QuantaStor v6.7.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Eliminated daily Ceph monitor outage on coordinator nodes caused by the mon-db backup process; the backup now uses a RocksDB compaction flush and hot-copy so the monitor service remains running throughout, and backup activity is now logged to qs_service.log. [ QSTOR-11655 ]

Enclosures and Controllers
* Fixed issue regarding hwController/hwEnclosure double discovery caused by the presence of certain Dell HBA cards that are visible to both the storcli and perccli CLI tools. [ QSTOR-11372 ]

Network Interfaces
* Fixed an issue with the allowed portals for iscsi and nvme being updated on network ports or having the settings retained on HA VIFs. [ QSTOR-11659 ]

Remote Replication, Snapshots and Backup Policies
* Improvements in the replication reports. [ QSTOR-11644 ]

Service Core
* Updated task output for storage system modify to improve clarity [ QSTOR-11660 ]
* Coordinated Task (CCT) Reliability Improvements — Fixed an issue on large or heavily-loaded Ceph clusters where CCT broadcasts could silently hang until timeout. [ QSTOR-11648 ]

Upgrade Manager and Installer
* Updated kmod and libkmod2 packages for ubuntu jammy and focal platforms to disable algif_aead and address CVE-2026-31431 [ QSTOR-11670 ]

== v6.7.3.010 (April 17th 2026) ==

=== [[QuantaStor 6.7.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.3 Upgrade Instructions | upgrading to QuantaStor v6.7.3]].

=== Release Notes ===

High Availability Failover
* Fixed an issue where Site Clusters could not be deleted in cases where the site cluster was unhealthy. For example if the Network Interfaces or IP addresses on the interface change for the heartbeat rings. Or if the site cluster corosync/pacemaker service are stopped. [ QSTOR-11631 ]
* Fixed a corner case where Site cluster vifs could start on nodes outside of the site cluster. [ QSTOR-11630 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Volume _chkpnt Replications on N-Way A>B>C replications being incorrectly named. they B>C leg should have _chkpnt.1 as the target suffix for the replication. [ QSTOR-11477 ]

Service Core
* Added further optimizations for Grid sync on large configs with many QuantaStor service objects. [ QSTOR-11628 ]

Storage Pool Management
* Fixed: SED disk Locked status is now propogated using grid logic for disks once a disk is used for Hardware encryption. Previously this required an HA group to also be on the pool. [ QSTOR-11611 ]
Fixed a corner case where SED Device Capabilities was showing as No for multipath disks plugged in twice to the same controller. [ QSTOR-11611 ]

== v6.7.2.003 (April 13th 2026) ==

=== [[QuantaStor 6.7.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.2 Upgrade Instructions | upgrading to QuantaStor v6.7.2]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue where some Enclosure objects would appear showing \[CBLERR\] when that status was incorrect. [ QSTOR-11135 ]

Network Shares
* Added a qs_global_namespace.conf file for users to provide a specific IP address to be offered for Microsoft DFS with the preferred_ip=x.x.x.x [ QSTOR-11627 ]
* Updated Jammy platform nfs-kernel-server and related nfs-utils packages to include junction support needed for NFS Referrals. [ QSTOR-11626 ]

== v6.7.1.008 (April 10th 2026) ==

=== [[QuantaStor 6.7.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.1 Upgrade Instructions | upgrading to QuantaStor v6.7.1]].

=== Release Notes ===

Network Shares
* Fix an issue with snapshot cleanup by the replication schedule. [ QSTOR-11621 ]

Security
* Upgrade the Cisco Duo library to 2.2.0 [ QSTOR-11592 ]

Upgrade Manager and Installer
* Disable and mask openzfs util zfs-shares.service which caused unexpected Share service restarts. [ QSTOR-11619 ]
* Fixed an issue with qs-distupgrade from Focal to Jammy Platforms of systems that had been originally deployed with bionic and older platforms. [ QSTOR-11616 ]
* Ensured the 6.8.0-90-generic kernel is deployed during Focal to Jammy Platform distupgrades. [ QSTOR-11616 ]

== v6.7.0.184 (April 8th 2026) ==

=== [[QuantaStor 6.7.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.0 Upgrade Instructions | upgrading to QuantaStor v6.7.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Add a 'Skip log server ping pre-checks' checkbox to the Send Support Logs dialog. The server will skip ping checks during log upload when the checkbox is checked. [ QSTOR-11397 ]
* Fixed an issue with clearing parent interface status alerts in the Health Checker System report [ QSTOR-11058 ]
* Add ability to specify reason for log uploads [ QSTOR-10479 ]

Ceph Scale-out Block, Object and File
* Fixed a QuantaStor service crash for Ceph scale-out file storage share snapshot delete [ QSTOR-11570 ]
* Adds support for new load balancer modes and customization in the /opt/osnexus/quantastor/conf/qs_loadbalancer.conf file. [ QSTOR-11502 ]
* Improved the method of tracking degraded object cleanup and reporting progress to the task objects. [ QSTOR-11292 ]
* Bug fixes in qs-s3util script when an invalid endpoint URL is provided. [ QSTOR-11292 ]
* Improved object state reporting for OSDs. [ QSTOR-11292 ]
* Fixed an issue with unlocking NVMe SED media on boot for Ceph Scale-out Cluster OSDs [ QSTOR-11118 ]
* Enabled Ceph OSD block and journal discard support [ QSTOR-10672 ]

Dashboards and Analytics
* Fixed an issue with influxdb install for qs\_upgrade\_redhat8.sh [ QSTOR-11562 ]

Disk Management
* Added logic to make SED Locking status consistent between QuantaStor Scale-Up ZFS HA Storage Pools. Note: Pools must have an HA group and HA Vif and be activated. [ QSTOR-11515 ]
* Added error counters for disks with available columns in the center grid view of the Physical Disks section. [ QSTOR-11308 ]

Enclosures and Controllers
* Added Enclosure layout support for Supermicro SSG-542B-DE1CR90 [ QSTOR-11572 ]
* This feature allows servers equipped with the Xinnor XiRAID software [ QSTOR-11374 ]

* Create a XiRAID raid unit, which appears as a QS HwUnit. [ QSTOR-11374 ]
* This HwUnit entity is surfaced in Quantastor as a physical disk drive. [ QSTOR-11374 ]
* The physical disks that are used to create the XiRaid unit are surfaced as HwDisks.[ QSTOR-11374 ]
* The creation includes a variable number of partitions on said physical disk.[ QSTOR-11374 ]
* These partitions are also surfaced as QS physical disks.[ QSTOR-11374 ]
* These partition-based physical disks can be used to create Ceph OSD objects. [ QSTOR-11374 ]
* Updated Storcli64 version to 007.3603.0000.0000 [ QSTOR-10911 ]

High Availability Failover
* Fixed an issue with FC ALUA path status when HA groups are disabled and HA VIFs are not present. [ QSTOR-11598 ]

Kernel and Drivers
* Updated kernel 6.8.0-90-generic drivers include intel ixgbe driver version 6.3.4 [ QSTOR-11524 ]
* Updated Jammy Platform installer ISO image to 22.04.5 [ QSTOR-11380 ]
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]

Multitenancy
* Changed Object User Create dialog text to more accurately reflect that it refers to Object Users/Tenants, and not Multitenancy objects [ QSTOR-9803 ]

Network Interfaces
* Fixed an issue where MTU values were being written to the VLAN interface configuration files. [ QSTOR-11552 ]

Network Shares
* Added further checks to Network Share Delete to verify the underlying ZFS filesystem properties has a matching OSNEXUS QuantaStor share ID before removing. [ QSTOR-11525 ]
* Auto populate the AD dialog with Organization Unit of specified on other systems in the grid [ QSTOR-11519 ]
* Add more options to filter shares in the delete dialog [ QSTOR-11499 ]

Remote Replication, Snapshots and Backup Policies
* Adds a new '--snapshots-with-holds-only' option to qs share-list and volume-list to list snapshots with holds on them. [ QSTOR-11388 ]

SNMP
* Update SNMP MIB [ QSTOR-11602 ]

Security
* When updating a certificate via cert-update, the relevant service (e.g. HAProxy) is now
automatically restarted to pick up the new certificate. Additionally, cert-update and
cert-rescan now accept the storage system by name or UUID. [ QSTOR-11529 ]
* Updated WebUI to have System Use Notification dialog/message display before user login dialog. [ QSTOR-11174 ]

Service Core
* Strip any invalid XML characters from description fields causing WebUI to not load [ QSTOR-11566 ]
* Cleaned up some repetitive log spam from the Blink Manager and the storcli hardware adappter [ QSTOR-11551 ]
* Fixed event spam and potential crash during Ceph daemon upgrade on large grids. [ QSTOR-11510 ]
* Fixes bug in site cluster maintenance mode logic. [ QSTOR-11489 ]
* Fixed an issue where the iSCSI/NVMe flag settings were not being retained for site cluster vifs after moving the vif to a new node. [ QSTOR-11464 ]
* Added support for LACP layer2+3 xmit\_hash\_policy [ QSTOR-11400 ]

Storage Pool Management
* Add more storage system tuning parameters [ QSTOR-11549 ]
* Added discard to LUKS options for NVMe model disks on ZFS Scale-Up Storage Pools with encryption. [ QSTOR-11501 ]

Upgrade Manager and Installer
* Fixed a throw in the qstorservice package install if the radosgw-admin command is not available [ QSTOR-11579 ]
* Fixed the qs-upgrade for kernel upgrades to ensure recommended packages for qstortarget are installed if they were previously manually removed. [ QSTOR-11556 ]

Web Manager
* When selecting Create Share from an existing selected share in the tree view, ensure the correct Storage Pool is selected in the Create Share dialog. [ QSTOR-11591 ]
* Create a new share template system for users to reuse settings from existing network shares. [ QSTOR-11314 ]

== v6.6.11.017 (March 5th 2026) ==

=== [[QuantaStor 6.6.11 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.11 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.11 Upgrade Instructions | upgrading to QuantaStor v6.6.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added a check to alert on SSL certificate expiration for the certificate manager managed certs. [ QSTOR-11462 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with rekeying scale-out ceph OSD's on Seagate Corvault backend external storage systems [ QSTOR-11206 ]

Disk Management
* Fixed an issue with SED media when adding as a hot-spare / for repair of a failed storage pool disk. [ QSTOR-11531 ]
* Fixed an issue where SSD Life Left status showing on multipath devices. [ QSTOR-11463 ]

Enclosures and Controllers
* Added Enclosure support from multiple Manufacturers such as Seagate, Gigabyte, Supermicro etc. [ QSTOR-11498 ]
* Fixed items related to the Intel 2u12 enclosure layout [ QSTOR-11286 ]
* Fixed Items related to the Supermicro 90-bay enclosure layout [ QSTOR-10932 ]

Network Shares
* Fix to allow creation of Network Shares with record size greater than 1M (1M, 2M, 4M, 8M). [ QSTOR-11535 ]

Security
* Fixed a few items related to Grafana default security ports [ QSTOR-11526 ]
* Fix configuration file manager file paths for telegraf.qstor and influxdb.qstor. [ QSTOR-11526 ]
* Fixed some items related to software encrypted HA storage pools management of /etc/crypttab [ QSTOR-11416 ]

Service Core
* Fixed some items related to QuantaStor Management Service database transactions [ QSTOR-11527 ]

== v6.6.10.006 (February 23rd 2026) ==

=== [[QuantaStor 6.6.10 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.10 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.10 Upgrade Instructions | upgrading to QuantaStor v6.6.10]].

=== Release Notes ===

Network Shares
* Fixed a service crash with Network share global Namespaces [ QSTOR-11518 ]
* Fixed an issue with AD join. [ QSTOR-11514 ]
* Fixed an issue with Seagate Corvault vpd83 parsing [ QSTOR-11518 ]

== v6.6.9.002 (February 13th 2026) ==

=== [[QuantaStor 6.6.9 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.9 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.9 Upgrade Instructions | upgrading to QuantaStor v6.6.9]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash when upgrading QuantaStor on Systems configured with Scale-Out storage. [ QSTOR-11509 ]

== v6.6.8.004 (February 11th 2026) ==

=== [[QuantaStor 6.6.8 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.8 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.8 Upgrade Instructions | upgrading to QuantaStor v6.6.8]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash for Network Interface discover logic [ QSTOR-11507 ]
* Fixed a service crash in Scale-out bucket discovery logic. [ QSTOR-11505 ]

== v6.6.7.017 (February 9th 2026) ==

=== [[QuantaStor 6.6.7 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.7 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.7 Upgrade Instructions | upgrading to QuantaStor v6.6.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Optimized grid communication paths and reduced database read frequency by improving internal object caching mechanisms. [ QSTOR-11473 ]
* Show compression ratio in the Scale-out Storage Pool grid. It is hidden by default. [ QSTOR-11130 ]

Disk Management
* Fixed an issue where a NVMe quick secure erase would be executed when formatting disks used for new storage pool creation [ QSTOR-11478 ]
* Fixed an issue where quick secure erase reformated the NVMe disk with a new namespace using a 512K sector size. [ QSTOR-11478 ]

Enclosures and Controllers
* Recertify Quantastor with the gen4 series of Western Digital Data24 [ QSTOR-11479 ]
* Fix up the config file defaults for NVMe software adapter when logging into a NVMe WD Data24. [ QSTOR-11470 ]

Network Shares
* Fix an issue with password shown in the service log during AD join [ QSTOR-11483 ]
* Add the ability to select multiple shares using the ctrl key in the share multi-delete dialog [ QSTOR-9181 ]

Web Manager
* Fixed a minor issue with file masks in modify Network Share [ QSTOR-11495 ]

== v6.6.5.026 (January 16th 2026) ==

=== [[QuantaStor 6.6.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.5 Upgrade Instructions | upgrading to QuantaStor v6.6.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Adds alerts in the event a Corvault device is in a warning or missing state. [ QSTOR-11411 ]

Ceph Scale-out Block, Object and File
* Fix an issue with creation of S3 user on a secondary zone. User will be created on the master zone. [ QSTOR-11438 ]
* Fixed an Issue with the Ceph initial PG calculations when creating ceph storage pools on HDD and SSD based OSDs. [ QSTOR-11437 ]
* Fix a minor issue with bucket sync when bucket originates on a secondary zone [ QSTOR-11435 ]
* Add granular options for object bucket rescan. [ QSTOR-11312 ]

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11436 ]
* Fix a row selection issue in the central pane on the External Media and Port grids. Show the 'Used By' column for External Volumes. [ QSTOR-11384 ]

High Availability Failover
* Fixed an issue with the Storage Pool Health check on systems with high load. [ QSTOR-11454 ]
* Fixed an issue with HA storage Pools in a degraded warnign state. [ QSTOR-11451 ]
* Reduced scale-out Object logging for site cluster vifs to debug level. [ QSTOR-11448 ]

Network Shares
* Fixed an issue with joining AD domains using SSSD+Winbind [ QSTOR-7845 ]

SNMP
* Updated SNMP MIB [ QSTOR-11456 ]

Security
* Enabled HTTPS redirect mode in QuantaStor WebUI by default during new Installs and upgrades to version 6.6.5 and newer. [ QSTOR-11368 ]
* Added a custom script callout via a security-message-update for the Security manager System Usage Notification contents: [ QSTOR-11222 ]
[https://wiki.osnexus.com/index.php?title=QuantaStor\_Custom\_Scripting\_/\_Application\_Extensions\#/var/opt/osnexus/custom/security-message-update.sh](https://wiki.osnexus.com/index.php?title=QuantaStor_Custom_Scripting_/_Application_Extensions#/var/opt/osnexus/custom/security-message-update.sh)

Service Core
* Added minimum timeout value to Coordinated tasks [ QSTOR-11455 ]
* Optimized Grid logic for Scale-out Object Bucket discovery on deployments with a large amount of ceph buckets. [ QSTOR-11433 ]
* Fixed an issue with License Key activation verification [ QSTOR-11110 ]

== v6.6.4.001 (December 17th 2025) ==

=== [[QuantaStor 6.6.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.4 Upgrade Instructions | upgrading to QuantaStor v6.6.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fix an issue where the S3 Object User Create fails when the User is not a Tenant member. [ QSTOR-11432 ]

== v6.6.3.033 (December 16th 2025) ==

=== [[QuantaStor 6.6.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.3 Upgrade Instructions | upgrading to QuantaStor v6.6.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Raise alerts when OSDs are down. [ QSTOR-11415 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with object user create under a tenant with multi-site is enabled for two zones. [ QSTOR-11427 ]
* Fix an issue with bucket sync policy create on the secondary zone bucket. [ QSTOR-11426 ]
* Allow selection of any object gateway when setting up ceph multi-site configuration. [ QSTOR-11409 ]

Enclosures and Controllers
* Adds enclosure management support for Supermicro Server SSG-522B-ACR12L [ QSTOR-11422 ]
* Change external volumes, media and volume grids from grouping to non-grouping for a minor performance improvement. Re-order Corvault columns in central grid (External Systems). Only show volumes for the currently selected Corvault. [ QSTOR-11370 ]

High Availability Failover
* Added a check to the site cluster to ensure that a user cannot set the final active node in a site cluster into standby. This is to prevent all nodes in a site cluster or HA pair from both being in standby and not serving any resources. [ QSTOR-11402 ]

Network Interfaces
* Fixed an issue where modifying the iscsi/nvme portal port settings on a VLAN or VIF interface would cause the parent interface to be restarted [ QSTOR-11406 ]
* Fixed an issue with importing LACP options in the /etc/network/interfaces file. [ QSTOR-11396 ]
* Updated the LACP bond-xmit-hash-policy options to use the modern text option names instead of the legacy numerical values. [ QSTOR-11396 ]

Network Shares
* Added 'qs-util nfsrdma' command to enable nfs rdma support for systems that have NFS RDMA supported hardware and drivers. [ QSTOR-11309 ]
* Auto detect when the AD server goes down and raise an alert. [ QSTOR-11182 ]
* Fixed issues with SSSD AD Join [ QSTOR-11335 ]

SNMP
* Updated SNMP MIB [ QSTOR-11428 ]
* Fixed a few items related to the SNMP agent stability. [ QSTOR-11405 ]
* Added logic to ensure new nodes joined to the grid get the snmp agent deployed on them with the same settings and snmp user. [ QSTOR-11393 ]

Security
* Removed default nginx index.html and version reporting from nginx. [ QSTOR-11351 ]

Service Core
* Extended timeout values for coordinated task finishing stage throughout the service. This will help prevent grid communication errors that are caused in high latency environments. [ QSTOR-11421 ]
* Enhanced grid logic for High Latency multi-site deployments. [ QSTOR-11391 ]

Upgrade Manager and Installer
* Added protections to ensure zfs pools are not imported incorrectly on a passive HA node during upgrade processes that update the grub configuration. [ QSTOR-11413 ]

Web Manager
* Add a tooltip to the Force checkbox on the Storage System Restart and Shutdown dialogs to clarify it's for immediate, unclean shutdowns. [ QSTOR-11381 ]

== v6.6.2.003 (November 14th 2025) ==

=== [[QuantaStor 6.6.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.2 Upgrade Instructions | upgrading to QuantaStor v6.6.2]].

=== Release Notes ===

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11367 ]

Security
* Updated QuantaStor Tomcat version to 9.0.112 [ QSTOR-11376 ]
* Fix a regression in single sign on failing to login AD users. [ QSTOR-11375 ]
* Enhanced Grid communication event batching that can help with large numbers of QuantaStor Grid object counts. [ QSTOR-11366 ]

== v6.6.1.013 (November 7th 2025) ==

=== [[QuantaStor 6.6.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.1 Upgrade Instructions | upgrading to QuantaStor v6.6.1]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Removed rgw gc optimizations that are no longer needed for modern ceph versions. [ QSTOR-10920 ]

Enclosures and Controllers
* Added some new warning icons for hardware controllers, hardware units and hardware disks. Fixed icon priority for status on hardware enclosures. [ QSTOR-11358 ]
* Fixed an issue with discovery of Hardware RAID Disks for LSI Hardware RAID controllers that use the storcli tool. [ QSTOR-11347 ]
* Fixed an issue with enclosure discovery for older LSI SAS HBA controllers that utilize sas3ircu [ QSTOR-11209 ]

High Availability Failover
* Fixed an issue with HA failover for storage pools that have multipath disks with -part1- in the device name. [ QSTOR-11373 ]

Security
* Fixed a possible SQL Injection during Login. [ QSTOR-11365 ]

Service Core
* Changes haproxy logrotate to be hourly by default. [ QSTOR-11349 ]
* Updated the QS PyClient Code in the github repo. [ QSTOR-11346 ]

== v6.6.0.362 (October 9th 2025) ==

=== [[QuantaStor 6.6.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.6.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.6.0 Upgrade Instructions| upgrading to QuantaStor v6.6.0]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Block rename of object pool group. [ QSTOR-11336 ]
* Add a fix so auto-tier rules can be set on multiple ceph clusters [ QSTOR-11323 ]
* Fixes bug with OSD replace prepare context menu button when called from the enclosure view. [ QSTOR-11313 ]
* Fixed: added duplicate zone check for Object Group Create [ QSTOR-11266 ]
* Add indication on the journal group if it is encrypted. [ QSTOR-11261 ]
* Updated Ceph version on Focal and Jammy platforms to 18.2.7 [ QSTOR-11129 ]
* Generate proper caps for keyring when using additional pools in CephFS [ QSTOR-11106 ]
* Display S3 user information in the delete user dialog to distinguish between S3 user and local user. [ QSTOR-10723 ]
* New feature adds the ability to modify RGW settings. Added the ability to add and remove load balancers on each Ceph cluster member. [ QSTOR-10623 ]
* Added support for Portal Groups for FC and iSCSI Targets [ QSTOR-10533 ]
* Add the ability to control synchronization for selected buckets in two objects storage clusters. [ QSTOR-10346 ]
* Add ability to specify multiple pools in a ceph file system. [ QSTOR-8674 ]

Dashboards and Analytics
* Add a new bucket dashboard that reports Average Total Objects and Average Utilized Space. [ QSTOR-11259 ]

Disk Management
* Adds an NVMe quick format to the Physical Disk Format dialog using the secure erase options. [ QSTOR-10688 ]

Enclosures and Controllers
* Fixed various items related to Linux Software RAID adapter support. [ QSTOR-11198 ]

Multitenancy
* Scope the access of user accounts so that they can only manage users, buckets, keys and other resources related to the tenant in the resource group they're a member of [ QSTOR-11326 ]
* Allow CephFS shares to be added to a Resource Group. [ QSTOR-11007 ]

Network Shares
* Share rename needs a force flag as it may disconnect NFS clients. [ QSTOR-11337 ]
* Provides an optional backported version of samba via a 'qs_samba_jammy_optional.sh' install script that includes a version of samba required to address the ad rfc2307 changes Microsoft introduced in KB5062572. Note this samba version does not include sssd support and so will not be installed by default. It should only be used for those customers using ad rfc2307 mode. [ QSTOR-11319 ]

Security
* Adds the ability to add and remove SSL certificate templates. Using those templates you can update the certificates for HaProxy and Rados gateways configured for HTTPS. [ QSTOR-9016 ]

Service Core
* Eliminates common errors in active directory join process, prepopulating dialog from previously joined systems [ QSTOR-11015 ]
* Added support for shutting down or restarting multiple systems at once [ QSTOR-10022 ]
* Added an optional force flag to Storage System Restart and Shutdown Dialogs to provide an option for immediate sysrq based shutdown of the system [ QSTOR-10022 ]

SNMP
* Updated SNMP MIB [ QSTOR-11343 ]

Storage Volumes
* Allow rename of Scale Out block storage volumes [ QSTOR-11311 ]
* Fix an event issue where the Volumes count was not getting updated in the central Host grid view. [ QSTOR-11038 ]

Universal Containers
* Add Universal Container support to the server and the Create Config dialog in the WUI. [ QSTOR-11194 ]

Upgrade Manager and Installer
* verified that packages are being installed properly with the new iso filtering stuff [ QSTOR-11030 ]

Web Manager
* Minor fix to the modify Network Port dialog. [ QSTOR-11302 ]
* Added the ability to save a local copy of a report schedule. [ QSTOR-11217 ]
* Simplifies active directory join and leave process, allowing multiple systems to join or leave at once [ QSTOR-8771 ]

== v6.5.12.005 (September 22nd 2025) ==

=== [[QuantaStor 6.5.12 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.12 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.12 Upgrade Instructions| upgrading to QuantaStor v6.5.12]].

=== Release Notes ===

Enclosures and Controllers
* Fixed vendor/model defaulting, improved enclosure layout auto-selection in the Modify Storage System dialog (including correct child-layout selection to choose the primary NVMe drive group), and resolved an invalid enclosureLayoutId that prevented layout auto-detection. [ QSTOR-11263 ]

Security
* Fixed: disable gzip compresson on web and api ports by default. [ QSTOR-11210 ]
* Fixed: internal qs-statsd/qs_restd service port 5173 moved to localhost only as it should not be presented as an external port. [ QSTOR-11210 ]
* Fixed: reduced syslog logging of qs-statsdb/qs_restd. [ QSTOR-11210 ]
* Added: DROP rules to block ICMP timechecks [ QSTOR-11210 ]
* Updated SSL Ciphers and TLS1.3 support for the web and API ports [ QSTOR-11210 ]
* Fixed: Set pcsd api port 2224 to bind to localhost only by default [ QSTOR-11210 ]

== v6.5.11.029 (August 28th 2025) ==

=== [[QuantaStor 6.5.11 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.11 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.11 Upgrade Instructions| upgrading to QuantaStor v6.5.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added support for SMTP servers that allow open relay with no username/password to the Alert Manager [ QSTOR-11167 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with multiple alerts occurring for long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Fixed some corner case issues with long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Added support for larger MDB devices upto 2100GB [ QSTOR-11274 ]
* Added support for encryption bypass on OSD create while still encrypting wal/db journal devices. [ QSTOR-11260 ]

Disk Management
* Fixed an issue with running the disk read performance test benchmark on very fast modern media. [ QSTOR-11296 ]

Enclosures and Controllers
* Fixed Enclosure and Controller discovery support for SAS3516 based SAS controllers [ QSTOR-11267 ]

High Availability Failover
* Fix an issue with VIF used for scale-out file usage after rebooting all nodes in the cluster. [ QSTOR-11265 ]

Network Interfaces
* Fixed: added gfortran-11 dependency to jammy repository required for LTS mellanox ofed install to succeed [ QSTOR-11285 ]
* Add QS cli command to hide disabled Network Ports [ QSTOR-10898 ]
* Fixed an issue where VLAN and VIF interfaces would not report their bond mode correctly if their parent interfaces was a bonded port. [ QSTOR-10754 ]

Network Shares
* Adds support for multiple HA VIF redirects and smart network filtering for NFSv4 referrals [ QSTOR-11278 ]
* Minor fix to skip NFS export commands for scale out shares. [ QSTOR-11275 ]

Quantastor CLI
* Provide a utility to create temporary log download links via qs-download-link [ QSTOR-11273 ]

SCSI / NVMe Target
* Fixed: Added logic to always default FC ports to target mode for supported FC target card models from QLogic. Ports can still be explicitly set to initiator mode if the user so chooses. [ QSTOR-10744 ]

Service Core
* Fixed: added the option to cancel the Physical Disk Identify task if the duration for the identify task is longer than the user wants. [ QSTOR-11258 ]
* Provide a download link for log collection in case logs cannot be uploaded from a Quantastor system [ QSTOR-11116 ]

Upgrade Manager and Installer
* Fixed: added proxy settings to the /etc/apt/apt.conf.d/80proxy file [ QSTOR-11281 ]
* Fixed: added logic to the upgrade manager and qs-upgrade command to check for missing version pinning if qs-util aptnopin has been run on the system. The upgrade task will fail early if correct pinning is not in place advising running qs-util aptpin. [ QSTOR-11277 ]

Web Manager
* Fixed: clarified text in create resource group for network share access of service containers [ QSTOR-11187 ]

== v6.5.10.013 (August 12th 2025) ==

=== [[QuantaStor 6.5.10 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.10 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.10 Upgrade Instructions| upgrading to QuantaStor v6.5.10]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the access key and secret key were not updating in the UI in instances with multiple object storage users across multiple ceph clusters in the same grid. [ QSTOR-11254 ]
* Fixed an issue with the cephfs mounts if communication is lost with the active MDS and a new MDS is elected. [ QSTOR-10738 ]

Enclosures and Controllers
* Fix an enclosure refresh issue via the event path where the underlying disk were not getting refreshed. [ QSTOR-11247 ]
* Fixed: Added additional checks for enclosure id on enclosures that fail to report correctly on older firmwares. [ QSTOR-11227 ]

Service Core
* Fixed: replaced size with maxsize in the ceph, radosgw and haproxy logrotate definitions so that they rotate as expected on their daily rotations as well as when reaching the max size definition. [ QSTOR-11253 ]
* Fix an underlying dashboard issue where new diskio entries were not properly added to the telegraf.conf file on new deployments. [ QSTOR-11246 ]
* Fix: Optimize the restarting of influx and telegraf. [ QSTOR-11246 ]

== v6.5.9.003 (August 5th 2025) ==

=== [[QuantaStor 6.5.9 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.9 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.9 Upgrade Instructions| upgrading to QuantaStor v6.5.9]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with slotmap updates when changing the slotmap in the enclosure and controllers section. [ QSTOR-11245 ]

Service Core
* Fixed an issue where QuantaStor was restarting the influxdb service when it was not needed. [ QSTOR-11244 ]
* Fixed: separated the influxdb, telegrafd and QuantaStor stats_db service restart logic to allow more granular control. [ QSTOR-11244 ]

== v6.5.8.008 (July 31st 2025) ==

=== [[QuantaStor 6.5.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.8 Upgrade Instructions| upgrading to QuantaStor v6.5.8]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed a small issue with the ceph osd reweight script progress trace. [ QSTOR-11234 ]

Enclosures and Controllers
* Add support for Supermicro ASG-2115S-NE332R system enclosure layouts [ QSTOR-11237 ]

Network Shares
* Fixed: Disable security features options in Network Share Create/Modify dialogs when the share is from a Scale-out File Pool. [ QSTOR-11235 ]
* Fixed: Remove redundant "NFS Security Mode" on the share advanced tab. [ QSTOR-11235 ]
* Fixed an issue with clearing the manage gids setting on Jammy platforms [ QSTOR-11225 ]
* Fixed an issue with setting specific nfs v3 or v4 server configurations on Focal platforms [ QSTOR-11225 ]
* Fixed a conflict with the nfs mountd ports between scale-out and scale-up nfs modes. [ QSTOR-11212 ]
* Fixed detection of nfs scale-out mode when it is configured at the time of ceph scale-out filesystem creation. [ QSTOR-11212 ]

Upgrade Manager and Installer
* Added a check to disable the grub os prober by default to prevent adding of any block devices with OS data other than the installed QuantaStor OS disk to the grub boot loader. [ QSTOR-11199 ]

== v6.5.7.004 (July 24th 2025) ==

=== [[QuantaStor 6.5.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.7 Upgrade Instructions| upgrading to QuantaStor v6.5.7]].

=== Release Notes ===

Network Shares
* Fixed an issue with network share cifs/smb settings such as ignore system acls introduced in the 6.5.1 release. [ QSTOR-11224 ]
* Removed the API underscore to space conversion logic in cifs/smb settings introduced in 6.5.1. REST API's should use proper url encoding like %20 when sending strings that contain spaces via curl or other http calls. [ QSTOR-11224 ]

Storage Pool Management
* Fixed a path naming issue for the sedutil-cli binaries used for SED disk encryption. [ QSTOR-11221 ]
* Added Several small enhancements and fixes for the sedutil-cli tool usage and SED supported disk discovery [ QSTOR-11219 ]

== v6.5.6.052 (July 16th 2025) ==

=== [[QuantaStor 6.5.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.6 Upgrade Instructions| upgrading to QuantaStor v6.5.6]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fix minor issue with Corvault log collection. [ QSTOR-11201 ]
* Added alerts to notify the user as they approach quota limits for S3C buckets [ QSTOR-11055 ]
* Fixed an issue with the IPMI Ip addresses showing up in the Health Check reports. [ QSTOR-10356 ]

Ceph Scale-out Block, Object and File
* Fixed radosgw logging logrotation not always occurring on fresh installs. [ QSTOR-11176 ]
* Fixed: radosgw logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Fixed: haproxy logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Improved logic for Ceph OSD Gentle Reweight. [ QSTOR-11163 ]
* Fixed an issue with the version check when upgrading the the scale-out ceph MDS, RGW and other daemons. [ QSTOR-11138 ]
* Fixed a few corner cases with ensuring successful Ceph upgrades. [ QSTOR-11138 ]
* Allow compression support for Ceph RBD pools. [ QSTOR-11131 ]
* Added Object User quota usage information to the Object User grid [ QSTOR-10722 ]

Dashboards and Analytics
* Add Pool, volume and share space usage trending dashboards (Early Access). [ QSTOR-11076 ]
* Add Pool, volume and share space usage trending dashboard routes and toggle buttons. [ QSTOR-11076 ]
* Expand the trending time scale for Tenants and Owners to make use of longer retention policies (e.g. 'Last 30 Days'). [ QSTOR-11076 ]
* Fix InfluxDB trending continuous query settings in qs\_statsdb.sh. [ QSTOR-11076 ]

Disk Management
* Add Multipath and HA support for SED Disks. [ QSTOR-11172 ]
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11065 ]

Enclosures and Controllers
* Fixes intermittent boot time OSD start issue with Corvault media. [ QSTOR-11195 ]
* Adds encryption bypass mode to avoid applying double (hardware plus software) encryption to Corvault media. [ QSTOR-11195 ]
* Added enclosure layout for Supermicro SYS-221H-TN24R systems. [ QSTOR-11154 ]

High Availability Failover
* Fixed an issue with Storage pool import of a previously exported pool that has iofencing on nvme disks. [ QSTOR-11173 ]

Network Shares
* Add new cyphers for active directory join. [ QSTOR-11183 ]
* Added sync flag by default to NFS mount for ceph object storage ganesha shares [ QSTOR-11181 ]
* Adjust minor Network Share quota alert levels. [ QSTOR-11171 ]
* Add larger record size upto 8M for Network Shares on ZFS Storage Pools. [ QSTOR-10118 ]
* Added support for hidden shares that end in a '$' as 'Browseable (admin-only) shares in the CIFS/SMB Options tab of the Network Share Create/Modify Dialogs. [ QSTOR-9222 ]

Service Core
* Optimize database reads for large clusters. [ QSTOR-11178 ]
* Added qs-util dbdiff for use to compare osn.db database versions [ QSTOR-10566 ]
* Added https as the default preferred method for support log bundle upload. [ QSTOR-9875 ]

Universal Containers
* Added initial support for a universal container system [ QSTOR-11162 ]

Upgrade Manager and Installer
* Added logic to fix the /boot/efi based on a efi partition label for Software RAID and EFI installs [ QSTOR-11140 ]

Web Manager
* Revise the Object User Access Key Manager to include Storage URLs in the Copy to Clipboard action. [ QSTOR-11177 ]
* Improved fieldset placements for network share create/modify dialogs. [ QSTOR-11156 ]
* SED Pool management - Reorder SED columns in PD grid. Move to the right of the "Correlated Device" column. Revise the SED capability detection to check for non-enterprise. [ QSTOR-11146 ]

== v6.5.5.039 (May 29th 2025) ==

=== [[QuantaStor 6.5.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.5 Upgrade Instructions| upgrading to QuantaStor v6.5.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixes bug in osd gentle reweight script that was bottlenecking performance. [ QSTOR-11123 ]
* Added logic to auto-clean up volume objects for non-QuantaStor managed ceph rbd's (rbd's created directly by the client using client rbd drivers/software). [ QSTOR-11112 ]
* Add warnings for the user if OSD or journal delete is being used on a device with duplicate PVs due to multi-pathing mapping. [ QSTOR-11099 ]
* Added 'qs-ceph' utility commands to modify compression options on Ceph pools. [ QSTOR-11096 ]
* Added compression ratio column in storage pools grid. [ QSTOR-11087 ]

Enclosures and Controllers
* Added support for discovery of RMSP3JD160J controllers. [ QSTOR-11107 ]
* Add validation for both primary and secondary IPs during External System Credentials Add. [ QSTOR-11009 ]

High Availability Failover
* Fixed a very rare corner case where a Manual HA failover task could generate unexpected errors due to a background periodic storage pool scan. [ QSTOR-11111 ]
* Added the option to set a Site Cluster Member Node as Manual Standby. [ QSTOR-11105 ]
* Fixed an issue where nodes could come out of standby status on a reboot too early before grid communication was established. [ QSTOR-11105 ]
* Enhanced HA Failover times for Storage Volumes for Fibre Channel clients. [ QSTOR-11105 ]
* Enhanced Fiber Channel High availability ALUA Changes to occur more quickly and to more quickly advertise failed paths to clients like VMware so that they can resume I/O to healthy available paths sooner. [ QSTOR-11105 ]
* Enhanced the logic used for High Availability Storage SCSI Target decoupling during a Storage Pool export. This can help greatly reduce the failover time for very Large configurations with thousands of volumes or volume snapshots. [ QSTOR-10969 ]

Network Interfaces
* Fixes bug that was blocking users from creating a static route with the same destination subnet across different systems. [ QSTOR-11125 ]
* Fixed a bug in static route validation logic and allow users to delete malformed static route entries. [ QSTOR-11115 ]

Network Shares
* Allow rename of nested shares [ QSTOR-11046 ]
* Added logic to help persist and manage NFS options for NFS version and nfs --manage-gids flags [ QSTOR-11001 ]

REST API
* Add an API to clear missing shares or volumes from the QS database. [ QSTOR-11117 ]

Remote Replication, Snapshots and Backup Policies
* Clarify concurrency options for backup policies. [ QSTOR-11004 ]

Security
* Added explicit modprobe disable and blacklist of ksmbd module to address any CVE-2025-37899 concerns. [ QSTOR-11134 ]

Service Core
* Enhanced the Core QuantaStor service management thread scaling. [ QSTOR-10767 ]
* Fixed a small memory leak with debug log tracing [ QSTOR-10689 ]

Storage Pool Management
* Updated sedutil-cli that supports a wider range of encrypted devices. [ QSTOR-11088 ]
* Restores sedutil / Storage Pool encryption support for SED Ruby NVMe devices. [ QSTOR-11088 ]
* Removed restriction to satisfy the VDEV count of N+1 to create a RAIDZx(RAID50/60/etc) array on a ZFS scale-up Storage pool when passing in a Set Disk Size instead of using the 'auto' option. [ QSTOR-11086 ]

== v6.5.4.016 (April 29th 2025) ==

=== [[QuantaStor 6.5.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.4 Upgrade Instructions| upgrading to QuantaStor v6.5.4]].

=== Release Notes ===

Dashboards and Analytics
* Fix issue where the dashboard of a newly created volume was not showing performance data after it had been assigned because of a pending Telegraf restart required. [ QSTOR-11077 ]
* Show CPU Temp and Power Usage in the System Dashboard (new Sensors button). [ QSTOR-11029 ]

High Availability Failover
* Unblocked creating HA ViF if there is an HA irrelavant bond in active-backup mode and unblocked modifying an HA irrelavant bond. [ QSTOR-11073 ]
* Fixed an issue when modifying non-name fields of an HA group. [ QSTOR-11071 ]

Network Interfaces
* Fixed bugs in validation logic for static route create and delete. [ QSTOR-11056 ]

Network Shares
* Ensure 'Browseable' is checked on SMB network shares when Browseable (Access Based) is checked. This ensures that authenticated clients who have pre-assigned browseable access can see the share offered by the QuantaStor but prevents non-authenticated users from seeing the share. [ QSTOR-11078 ]

Remote Replication, Snapshots and Backup Policies
* Minor log file cleanup after backup job is finished. [ QSTOR-11044 ]
* Add the ability to rollback a read-write Storage Volume or Network Share snapshot to it's underlying snapshot. [ QSTOR-9820 ]

Storage Pool Management
* Fixed an issue with Storage Pool auto-start on reboot for software encrypted storage pools. [ QSTOR-11081 ]

== v6.5.3.021 (April 9th 2025) ==

=== [[QuantaStor 6.5.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.3 Upgrade Instructions| upgrading to QuantaStor v6.5.3]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* Improved timeout handling for QuantaStor coordinated task system. [ QSTOR-11022 ]

Disk Management
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11032 ]

Enclosures and Controllers
* Added Hardware Enclosure support for Dell PowerEdge R7615 [ QSTOR-11043 ]
* Added Hardware Enclosure support for Supermicro AS-1115CS-TNR [ QSTOR-11043 ]
* Optimized performance and fixed issues when rendering systems with attached CORVAULT external systems. [ QSTOR-11039 ]
* Optimize the rendering of enclosures. Fix drawer rendering issue where extra slots were appearing. [ QSTOR-11014 ]

Network Interfaces
* Fixed an issue with static route netmask CIDR calculations. [ QSTOR-11048 ]

Network Shares
* Update Network Share Namespace on all nodes to reflect any modification to NFS access entries to share that is part of a Namespace. [ QSTOR-11042 ]
* Online newly promoted Network Share Snapshots. [ QSTOR-11021 ]
* Add post share create and modify script callouts. [ QSTOR-11016 ]
* Fixed mount paths for enabled snapshots of Network Share when Share is renamed. [ QSTOR-11012 ]
* Add the ability to prioritize NFS access rules in /etc/exports file. [ QSTOR-10552 ]

SNMP
* Regen SNMP for 6.5.3 [ QSTOR-11054 ]

Security
* Added docker http proxy override [ QSTOR-11040 ]
* Updated Tomcat version to 9.0.102.0 [ QSTOR-11013 ]

Upgrade Manager and Installer
* Fixed various issues with the OVA vApp properties being set after VM image cloning. Added additional properties to the OVA by default. [ QSTOR-10508 ]

== v6.5.2.070 (March 27th 2025) ==

=== [[QuantaStor 6.5.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.2 Upgrade Instructions| upgrading to QuantaStor v6.5.2]].
=== Release Notes ===

Alerts and Configuration Analysis
* Added SED version of Micron 7300 drives to firmware check for Config Analyzer [ QSTOR-10933 ]

Ceph Scale-out Block, Object and File
* Update AWS cli. [ QSTOR-10956 ]
* Extend Resource Groups to support adding S3 Tenant resource type. [ QSTOR-10808 ]
* Extended timeouts for logical volume allocation commands when creating Ceph OSDs. [ QSTOR-10930 ]
* Added more permissive check when running Ceph OSD replace prepare operation. (CLI only) [ QSTOR-10914 ]
* Add a qs-ceph command to allow switching between fuse and kernel mount for cephFS to allow user comparison of fuse versus the faster kernel option. [ QSTOR-10905 ]
* Adds additional Ceph coordinator election mode that maps to the site-cluster. [ QSTOR-10795 ]

Dashboards and Analytics
* Added Jammy platform support for the ceph prometheus install script [ QSTOR-10949 ]

Enclosures and Controllers
* Strip whitespace characters from primary and secondary IPs during External System Credentials Add. [ QSTOR-10896 ]
* Add validation for External System Credentials during creation. [ QSTOR-10826 ]

High Availability Failover
* Fixed a bug with creation grid master (gm) Site Cluster vifs. [ QSTOR-10996 ]
* Implemented new naming schema for underlying Site Cluster HA Groups. [ QSTOR-10904 ]

Network Interfaces
* Fixed an issue with deleting bonded interfaces leaving slave interfaces tagged as slaves. [ QSTOR-10931 ]
* Updates for mellanox ofed lossless networking support to work better with newer model cards. [ QSTOR-10779 ]

Network Shares
* Fixes bug where having 'gmt' or 'GMT' in the name of a network share would cause issues with NFS protocol. [ QSTOR-10982 ]
* Fix the mount paths for read-write GMT snapshots. [ QSTOR-10938 ]
* Add mountaddr to the view mount instructions for Network Share. [ QSTOR-10923 ]
* Add crossmnt option in the NFS exports for newly created shares. Also skip adding the default export for .zfs directory. [ QSTOR-10806 ]
* Add the ability to clone a GMT snapshot and promote it.
Add QS CLI to copy share permissions. [ QSTOR-10580 ]

REST API
* Handle empty lists from the curl calls to Quantastor APIs. [ QSTOR-10939 ]

Remote Replication, Snapshots and Backup Policies
* Fixed up dead links which were created after running some types of auto-tier Backup Policies. [ QSTOR-10934 ]

SNMP
* Update SNMP MIB [ QSTOR-11019 ]

Security
* Prevent MFA passcodes with leading 0 from being truncated. [ QSTOR-10852 ]

Service Core
* Fixes an issue where role-creation would fail due to deprecated permission-definitions. [ QSTOR-10988 ]

Storage Pool Management
* Added support for the creation of mirror sets consisting of "quad-mirrors" (4-way mirror sets) for both the data device groups in the pool and also the "special" devices, such as "dedup" and "metadata offload" devices. [ QSTOR-10893 ]

Storage Volumes
* Add more detail for logical and physical space utilization for volumes. [ QSTOR-10981 ]

Upgrade Manager and Installer
* Deprecates legacy package version pinning for the packages.osnexus.com mirror server that was causing issues with some ceph cluster upgrades [ QSTOR-10990 ]
* Added protections in qs\_distupgrade.sh for lvm snapshots that could cause issues with the platform upgrade. [ QSTOR-10970 ]
* Resolved multiple items that were causing issues with installing QuantaStor on redhat based platforms when STIG enforcement policies were present. [ QSTOR-10958 ]
Note: the qs_upgrade_redhat8.sh install/upgrade script temporarily sets selinux to permissive mode and temporarily disables fapolicyd if it is enabled when the script is running and restores them to their original state when the script completes.

Web Manager
* Auto select S3 tenant for S3 User when user create is invoked from context menu on the S3 tenant. [ QSTOR-11010 ]
* Increase the width of grids to show the 'Correlated Device' column in the Add Log/Cache/Metadata Device to Pool dialog w/o the need for scrolling. [ QSTOR-10951 ]
* Add an option to upload logs with no truncation. [ QSTOR-10925 ]
* Add drawer support for the Corvault enclosure layout and rendering engine in the WUI. [ QSTOR-10796 ]

== v6.5.1.058 (February 12th 2025) ==

=== [[QuantaStor 6.5.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.1 Upgrade Instructions| upgrading to QuantaStor v6.5.1]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* General improvements to OSD drive replacement process. Added additional LVM clean up logic. Fixed issues with device correlation for multipath devices and encrypted drives. [ QSTOR-10915 ]
* Allow deleting journals from the UI via Ceph journal delete dialog [ QSTOR-10890 ]

Dashboards and Analytics
* Add gridPreferredPort check to the WUI dashboard service (qsrestd) if set on a Storage System. [ QSTOR-10866 ]

Disk Management
* Fixed: New systems and clean QuantaStor service configurations databases will initialize Multipath autoconfig support as enabled by default. [ QSTOR-10900 ]
* Increased timeouts and other optimizations for large multipath configurations. [ QSTOR-10881 ]
* Added protections to prevent QuantaStor service from running multiple blkid instances if one is already running. [ QSTOR-10881 ]
* Unblocked adding disk as a scale-up pool spare with a larger block size. [ QSTOR-10876 ]

Enclosures and Controllers
* Add Enclosure mapping support for HPE ProLiant DL325 Gen10. [ QSTOR-10899 ]
* Fixed an issue with Hardware Disk Identify for Storage Pool Physical Disks where the controller was not properly selected in the dialog. [ QSTOR-10858 ]
* Fixed an issue with applying External System Profile A+B. [ QSTOR-10840 ]

High Availability Failover
* Fixed an issue with automatically starting HA scale-up ZFS pools if both HA nodes are booted at the same time. [ QSTOR-10902 ]
* Added a a check to ensure the luks crypttab was upto date after encrypted ha pool failover. [ QSTOR-10901 ]
* Added VLAN interfaces to allowed interfaces for Site Cluster heartbeat rings. [ QSTOR-10871 ]
* Added better logic for smb/nfs service management for Scale-up HA configurations with shares on multiple storage pools in the same HA cluster. [ QSTOR-10762 ]
* Fixed an issue with Resource Group Service configs starting on a node after the node had previously hosted the service. [ QSTOR-10762 ]
* Fixed: added a unique name check for HA group create/modify. [ QSTOR-10311 ]

NAS Gateway / Cloud Containers
* Change Seagate Lyve Cloud endpoints [ QSTOR-10868 ]

Network Interfaces
* Fixed an issue with calling iptables commands when distupgrading from older distributions. [ QSTOR-10860 ]

Network Shares
* Minor fix to allow creation of GMT snapshots for volumes from the Web UI. [ QSTOR-10873 ]
* Fixed an issue with spaces in the curl command issued to Quantastor. [ QSTOR-10838 ]
* Fix issue where renaming a share that contained a nested share failed. [ QSTOR-10811 ]
* Allow setting Samba share as read-only using ZFS. The new support has been added to the Network Share create and modify dialogs on the Advanced settings tab. [ QSTOR-10755 ]
* Fixed an issue which created duplicate mounts for nested shares. [ QSTOR-10704 ]
* Exposed ZFS 'Case Sensitivity' option at share creation time. [ QSTOR-8869 ]

REST API
* Fixed the POST command in the REST API [ QSTOR-10844 ]

Remote Replication, Snapshots and Backup Policies
* Fix an issue with auto tiering in backup policies. [ QSTOR-10845 ]
* Refined the Backup Policy Create and Modify dialogs. [ QSTOR-10843 ]
* Fixed an issue with Backup Policy tasks completing when the underlying file copy or move process process had returned. [ QSTOR-10839 ]
* Add alerting when replication fails. [ QSTOR-10799 ]

SNMP
* Updated SNMP MIB [ QSTOR-10922 ]

Service Core
* Fixed an issue that could sometimes cause performing a reboot or shutdown of the storage system via the QuantaStor UI to fail. [ QSTOR-10917 ]
* Fix an issue with database backups on the storage pools. [ QSTOR-10907 ]
* Fixed an issue with creating encrypted pools when an underlying disk is read-only. [ QSTOR-10886 ]
* Fixed a disk discovery issue when discoverying a large number of disks. [ QSTOR-10875 ]
* Fixed QuantaStor service builds for Redhat based distros. [ QSTOR-10846 ]
* Added /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable touchfile to bypess the icmp ping check and allow sending logs from the UI/qs cli. [ QSTOR-10556 ]

Storage Pool Management
* Fix an issue with pick a smaller hotspare disk getting picked for metadata offload if disk goes missing. [ QSTOR-10877 ]
* Add storage capacity properties for metadata offload VDEV [ QSTOR-10661 ]

Upgrade Manager and Installer
* Added a blacklist of the bnxt\_re driver to prevent issues for normal network operations for the bnxt_en driver loading on network controllers that have rdma support enabled in their firmware by default. [ QSTOR-10918 ]
* Added elbencho benchmarking tool to quantastor utilities. [ QSTOR-10892 ]
* Added support for Focal 20.04 to Jammy 22.04 Platform upgrades via qs-distupgrade [ QSTOR-10547 ]
* Fix telegraf start failures at startup due to invalid config file errors. [ QSTOR-10353 ]

Web Manager
* Fixed a minor truncation issue with trigger Backup Policy dialog [ QSTOR-10919 ]
* Add a Description column to the share and snapshot grid and default to hidden. [ QSTOR-10882 ]
* Minor fix to NTP server add dialog to prevent empty entries in the dialog. [ QSTOR-10870 ]
* Auto select first row in NTP and DNS settings dialogs. [ QSTOR-10867 ]
* Improve the host assign volume dialog. [ QSTOR-10862 ]

== v6.5.0.246 (January 9th 2025) ==

=== [[QuantaStor 6.5.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.0 Upgrade Instructions| upgrading to QuantaStor v6.5.0]].
=== Release Notes ===

Alerts and Configuration Analysis
* Increased HA health checks on Systems with local HA Pools. [ QSTOR-10746 ]
* Fixed: sending logs from specific grid nodes will now send logs only from the selected nodes. [ QSTOR-10694 ]

Ceph Scale-out Block, Object and File
* Fixes issue with access permissions for ceph client admin keyring file. [ QSTOR-10818 ]
* Fixed issues related to encrypted OSD replace operations. [ QSTOR-10786 ]
* Fixed an issue with wal journal device discovery and association with osds. [ QSTOR-10751 ]
* Deprecated replica=2 as a creation option from Ceph Scale-out storage. Replica=2 did not provide enough redundancy for consistent normal storage operations in the event of an osd or storage system outage. [ QSTOR-10748 ]
* Added the force flag checkbox to the Create S3 Storage Class dialog. [ QSTOR-10734 ]
* Fixed bugs in Ceph upgrade stage completion and failure alerting. [ QSTOR-10730 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10717 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10716 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10708 ]
* Improve ceph discovery. [ QSTOR-10675 ]
* Add metadata pool utilization for Ceph Object Pool Group and Ceph File System [ QSTOR-10650 ]
* Disabled OSD auto restart. auto restart can be activated using the touchfile '/var/opt/osnexus/quantastor/touchfiles/tf\_ceph\_osd\_auto\_start.enable' [ QSTOR-10632 ]
* Ensure the Tenant and User grid's bucket count column is updated after the delete bucket operation via events. [ QSTOR-10610 ]
* Fixed a bug with Ceph OSD 'Last Rekey Date' field not being updated properly. [ QSTOR-10509 ]
* Updated default Ceph version to Reef 18.2.4 for new Focal and Jammy platform deployments. [ QSTOR-10415 ]

Dashboards and Analytics
* Add a new Ceph Member selection combo to the Ceph Pool dashboard. [ QSTOR-10798 ]
* Add Tenant and Owner usage dashboards to the Bucket menu area. [ QSTOR-10698 ]
* Add CPU Temp and Power Usage to the Grid Dashboard's System Tiles. [ QSTOR-10427 ]
* Change the grid CPU metric to use system\_usage which matches the metric used in the System dashboard. The overlapping text issue is no longer an issue as Highcharts has been replaced with Chart.js. [ QSTOR-10263 ]
* Add power usage and average CPU temp sparklines to the System Tile dashboards in the grid view. [ QSTOR-10013 ]
* Removed resource column from Health Checker/Config Analyzer. [ QSTOR-5515 ]

Disk Management

* Removed the multipath autoconf touchfile support which fixes issues where disabling multipath autoconfig would not apply. [ QSTOR-10706 ]
Enclosures and Controllers
* Addes enclosure layour for Supermicro Server SYS-F629P3-RC1B FatTwin 4-Node 24+12 bay [ QSTOR-10853 ]
* Fixed an issue with disk discovery when a CORVAULT is attached. [ QSTOR-10664 ]
* Added the ability to blink empty slots on jbod hardware that supports that feature. This action is accomplished using sg\_ses commands. [ QSTOR-10618 ]
* Added functionality to treat enclosures accidentally unplugged as MISSING, so that when reconnected their user-set properties are not lost . [ QSTOR-10542 ]

High Availability Failover
* Fixed an issue with post failover storage pool update tasks being stuck in a running state for nodes where the HA storage pool was previously evicted from due to an automatically triggered failover event. [ QSTOR-10485 ]

Kernel and Drivers
* Updated ZFS driver version to 2.2.6 [ QSTOR-10647 ]
* Updated scst iSCSI/FC Target driver to 3.9.0 [ QSTOR-10534 ]

Licensing
* Fixup old license keys to work with new format. [ QSTOR-10788 ]
* Added Express Edition Licenses [ QSTOR-10619 ]
* Show TB Utilized in the License grid and property view. [ QSTOR-8009 ]

NAS Gateway / Cloud Containers
* Fix wrap and truncation issues in the Cloud Add Credential dialog for Spanish. [ QSTOR-10792 ]

Network Shares
* Retain include line position in smb.conf [ QSTOR-10800 ]
* Minor fix to retain the share description when creating a Network Share. [ QSTOR-10793 ]
* Enhance the network share CLI search to support paging (similar to buckets). [ QSTOR-10757 ]
* Fix minor share name and snapshot name validation. [ QSTOR-10520 ]
* Added additional share name validation to share modify cli and API calls. [ QSTOR-10519 ]
* Add SSSD support [ QSTOR-10445 ]
* Implemented ransomware detection for Network Shares. [ QSTOR-10391 ]

Quantastor CLI
* Fixed qs cli disk-list filters for ssd, and nvme disk types. [ QSTOR-10515 ]
* Fixed the filtering for qs cli disk-list --filter="\[unused\]" and --filter="\[used\]" commands [ QSTOR-10482 ]

Remote Replication, Snapshots and Backup Policies
* Remove SSH keys after replication links are deleted [ QSTOR-10782 ]
* Fix minor argument validation for replication schedule create and snapshot schedule create. [ QSTOR-10732 ]
* Added monitoring for file modify events to enable continuous data protection on modified files. [ QSTOR-10557 ]
* Added ability for Snapshot Schedules and Replication Schedules to absorb old snapshots. [ QSTOR-10524 ]
* Create local delta Snapshot on source when Replication Schedule is skipped. [ QSTOR-10357 ]
* Change the control in the 'Update Selections for Replication Schedule' dialog to be a dual chooser. [ QSTOR-10351 ]

SCSI / NVMe Target
* Added a remote Fibre Channel port list to the fc target port section of the UI and 'qs fc-remote-port-enum' CLI command. [ QSTOR-10541 ]
* Added the Fiber Channel Issue LIP dialog to the UI that can be used to issue a lip on a specific FC port. [ QSTOR-10226 ]

SNMP
* Update SNMP MIB [ QSTOR-10847 ]

Security
* Fixed a bug in the 2FA login process. [ QSTOR-10841 ]
* Added support for a custom iptables include script under
/var/opt/osnexus/quantastor/iptables.qscustom [ QSTOR-10794 ]
* Updated tomcat package version to 9.0.96.0 [ QSTOR-10691 ]

Service Core
* Fix a small memory leak [ QSTOR-10778 ]
* Revise the server S3 modify API to accept spaces for the Display Name property. [ QSTOR-10724 ]
* Fixed some issues with writing the Chrony conf file on platforms that have chrony installed (like Jammy) [ QSTOR-10293 ]

Storage Pool Management
* Allow trim schedule to run nightly. [ QSTOR-10652 ]

Storage Volumes
* Allow minimum of <4MB for Storage Volume QoS Control limits. [ QSTOR-10765 ]
* Updated Storage Volume QoS controls to use cGroups v2 for modern linux kernels/platforms. [ QSTOR-10529 ]

Upgrade Manager and Installer
* Added logic to temporarily disable the upmap balancer during ceph upgrade. [ QSTOR-10702 ]
* Fixed an issue where Storage System Upgrade tasks were showing 25% progress but transitioned to the 'Completed' stage. [ QSTOR-10673 ]
* Install sssd packages by default on focal and newer platforms. [ QSTOR-10549 ]
* chrony is now the default time daemon for ubuntu 22.04 jammy and newer platforms. [ QSTOR-10273 ]
* Added 22.04 Jammy as a new Platform for QuantaStor [ QSTOR-10225 ]

Web Manager
* Disable the 'Start Upgrade' button in the Upgrade dialog until the system update check is complete. [ QSTOR-10776 ]
* Show the Tag/Alt Name value along with the Controller name in the identify dialog if provided. [ QSTOR-10775 ]
* Decrease the replication detail chart update frequency. [ QSTOR-10753 ]
* Added email validation check for the Alert Manager dialog [ QSTOR-10590 ]
* Added Timezone configuration as a step in the getting started guide. [ QSTOR-10502 ]

== v6.4.5.001 (November 1st 2024) ==

=== [[QuantaStor 6.4.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.5 Upgrade Instructions| upgrading to QuantaStor v6.4.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an error with Ceph Bucket Discovery tasks. [ QSTOR-10707 ]

== v6.4.4.013 (October 25th 2024) ==

=== [[QuantaStor 6.4.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.4 Upgrade Instructions| upgrading to QuantaStor v6.4.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added a fix for Seagate Corvault based Ceph deployments to ensure ceph LVM layer is started on system boot. [ QSTOR-10686 ]
* Added qs-osd-compact script to assist with OSD compaction on a per system basis. [ QSTOR-10668 ]
* Fixed an issue with Ceph OSD Journal device discovery for encrypted Ceph Clusters. [ QSTOR-10666 ]
* Extend timeouts for OSD restart stage of the Ceph upgrade task. [ QSTOR-10665 ]
* Fixes bug were OSDs lose journal device correlation after OSD reweight operation. [ QSTOR-10657 ]

Enclosures and Controllers
* Fixed an issue with enclosure and disk slot identity correlation information. [ QSTOR-10681 ]

High Availability Failover
* Disables the PCS daemon WebUI by default. [ QSTOR-10692 ]
* Adds a check for versions older than 6.4.3 to auto-disable the new health checks logic that is not compatible with older versions. [ QSTOR-10692 ]

Upgrade Manager and Installer
* Fixed: the qs_upgrade_redhat8.sh script now automatically removes legacy centos repos that are no longer needed for Redhat platform deployments. [ QSTOR-10676 ]

== v6.4.3.021 (October 10th 2024) ==

=== [[QuantaStor 6.4.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.3 Upgrade Instructions| upgrading to QuantaStor v6.4.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed a incorrect encrypted ZFS pool check check in the Config Analyzer for encrypted Ceph clusters with encrypted OSDs. [ QSTOR-10643 ]

Ceph Scale-out Block, Object and File
* Optimized scale-out ceph bucket discovery for very large number of S3 buckets. [ QSTOR-10621 ]
* Ceph OSD create and delete operations will no longer fail due to services being masked. [ QSTOR-10617 ]
* Made some improvements to the Veeam SOSAPI update cycle. [ QSTOR-10616 ]
* Fixed an issue with creating Ceph Storage Classes of the same name on different Ceph Clusters. [ QSTOR-10592 ]
* Default to http based checks from the haproxy load balancer to backend http radosgw instances. [ QSTOR-10559 ]

NAS Gateway / Cloud Containers
* Add a rescan for cloud containers so that data is refreshed if uploaded from another S3 gateway. [ QSTOR-10627 ]

Network Shares
* Fix an issue with trusted domain users not found in the Active Directory User search dialog. [ QSTOR-7353 ]

Remote Replication, Snapshots and Backup Policies
* Enabled Continuous Data Protection and Auto-tiering on Backup Policies using the SMB protocol. [ QSTOR-10601 ]

Security
* Added http proxy support for Upgrades, Support Log submission and License Key Activation. [ QSTOR-10432 ]

Upgrade Manager and Installer
* Fix triggering Ceph cluster upgrades when there are multiple scale-out storage Ceph clusters in the same QuantaStor Storage Grid. [ QSTOR-10612 ]
* Fixed an issue with the Ganesha 5.9 libntirpc dependency. This change was shipped earlier with a respin of QuantaStor 6.4.3 to include the missing updated library in the update repo and in the ISO and OVA image. [ QSTOR-10576 ]

== v6.4.2.053 (September 19th 2024) ==

=== [[QuantaStor 6.4.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.2 Upgrade Instructions| upgrading to QuantaStor v6.4.2]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed tolerances for alerting on changes in PSU status and other IPMI sensors. [ QSTOR-10447 ]

Ceph Scale-out Block, Object and File
* Adds total Object count to S3 tenant and user objects [ QSTOR-10606 ]
* Improved logic to ensure Scale-out Object Storage Class Auto-Tiering Rules were applied correctly on all nodes after an update. [ QSTOR-10599 ]
* Unblocked file quotas for CephFS Shares. [ QSTOR-10584 ]

Enclosures and Controllers
* Added Enclosure for Tyan Transport SX TS70-B8056. [ QSTOR-10597 ]
* Fixed an issue with enclosure support for Supermicro SSG-621E-ACR16L [ QSTOR-10563 ]

NAS Gateway / Cloud Containers
* Fix a regression with NFS and SMB access for cloud container shares. [ QSTOR-10588 ]

Network Shares
* Fixed an issue where the quota field was incorrectly disabled in the network share modify and create dialogs for nested shares on zfs storage pools. [ QSTOR-10602 ]
* Implemented ability to adjust Network Shares permission settings via a specified permissions mask. [ QSTOR-10147 ]

Quantastor CLI
* Fix a minor regression with share name now showing in the output of "qs share-list" [ QSTOR-10587 ]

Remote Replication, Snapshots and Backup Policies
* Show more informative errors when a Backup Job fails. [ QSTOR-10575 ]
* Fixed an issue where multiple snapshots were wrongfully created. [ QSTOR-10564 ]
* Fix an issue with removing excess snapshots for a backup policy with cephFS shares. [ QSTOR-10560 ]
* Add maximum total snapshots for replication, snapshot and backup schedules. [ QSTOR-10539 ]
* Fixed an issue where GMT Snapshots were disappearing. [ QSTOR-10538 ]
* Fix an issue with resume replication not updating the replication reports. [ QSTOR-10536 ]
* Added auto-tier stubbing minimum file size threshold. [ QSTOR-10505 ]

SCSI / NVMe Target
* Added support for setting specific LUN numbers on Storage volumes for Fibre Channel access. This is available in the Advanced tab of the Storage Volume Create and Modify dialogs. [ QSTOR-10544 ]

Service Core
* Improved efficiency for Ceph Bucket discovery. New Default behavior is to skip collecting life cycle policy and object locking data on the bucket. Contact support to enable object locking discovery on buckets. [ QSTOR-10600 ]

Upgrade Manager and Installer
* Added script to fix RGW configurations on clusters created on older versions of QuantaStor. [ QSTOR-10569 ]
* Added support for Ceph Reef 18.x upgrades. [ QSTOR-10493 ]

Web Manager
* Make the info fields, in the Snapshot Rollback Point fieldset of the Rollback Storage Volume dialog, read-only. [ QSTOR-10596 ]
* Hide the timezone column in the Upgrade Manager dialog. [ QSTOR-10540 ]
* Change S3 Bucket Search panel location from North to West of screen. [ QSTOR-10405 ]

== v6.4.1.011 (August 6th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.1 Upgrade Instructions| upgrading to QuantaStor v6.4.1]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with the Supermicro NVMe Enclosure mappings for the SBB-SSG-221E and SSG-641E [ QSTOR-10506 ]

Network Interfaces
* Fixed: Infiniband Devices should now have the correct Make and Model displayed in the Network interface section. [ QSTOR-10448 ]

Network Shares
* Fixed an issue with updating the status of Backup Policy Jobs. [ QSTOR-10517 ]

Remote Replication, Snapshots and Backup Policies
* Fixed: Shows the last 14 days in the replication schedule dashboard regardless of the replication schedule configuration. Fix an issue where not all series data was appearing despite being in a completed state. [ QSTOR-10528 ]
* Fixed an issue with duplicate Replication tasks. [ QSTOR-10526 ]
* Correct the max temporary snapshots retained for volumes in a replication schedule. [ QSTOR-10525 ]
* Add the ability to discover partially transferred chkpnts if replication is interrupted on the first transfer. [ QSTOR-10500 ]

Upgrade Manager and Installer
* Fixed: optimized dependency checker for qs-upgrade script. [ QSTOR-10531 ]

== v6.4.0.174 (July 18th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.0 Upgrade Instructions| upgrading to QuantaStor v6.4.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue with adding new ITSM webhook integrations. [ QSTOR-10480 ]
* Added support for Microsoft Teams to ITSM integrations. [ QSTOR-10458 ]
* Added the ability to easily extend ITSM integrations with new integration modules with qs_alerthandlers.conf file. [ QSTOR-10458 ]
* Include storage volumes in pool reports. [ QSTOR-10083 ]

Ceph Scale-out Block, Object and File
* Fixed an issue where the wrong libntirpc library was installed for nfs-ganesha. [ QSTOR-10463 ]
* Added a Copy to Clipboard Button for a selected access key and changed the double click on access/secret key behavior to copy to clipboard for the S3 User Access Key Manager Dialog. [ QSTOR-10428 ]
* Added a check to the S3 User Access Key Manager Dialog to ensure only the selected key text is shown when the user clicks the 'Show Key Text' button on the dialog. [ QSTOR-10428 ]
* Added block for more than 2 S3 Gateway loadbalancer modes configured at the same time. [ QSTOR-10407 ]
* Added a new feature for data pool capacity based, overflow rules for ceph object storage. Added support for a force flag for the auto tiering rules, that will overwrite any client side storage class specifications. [ QSTOR-10379 ]
* Add reporting for object storage usage. Periodic reports can be generated as part of "Report Schedules" by enabling "Object Zone Usage Report". [ QSTOR-10355 ]
* Added object count for Ceph Buckets. [ QSTOR-10348 ]
* Updated the default access permissions for Ceph keyring files. [ QSTOR-10325 ]
* Updated ceph cluster scale-out OSD osd_op_queue setting to wpq by default. The setting will take effect for any new OSDs on creation. Existing OSDs will use the new setting on OSD service restart (system reboot, encrypted OSD re-keying or manual OSD service restart) [ QSTOR-10123 ]
* Improved an error message when creating a Site Vif with Block Storage use case. [ QSTOR-9984 ]
* Added ability to enable a size quota and a file number quota on cephFS Shares. [ QSTOR-7344 ]

Enclosures and Controllers
* Fixed an issue where a disconnected JBOD could leave the enclosure object around on LSI HBAs. [ QSTOR-10503 ]
* Fixed: a modify of enclosure or system layout to something other than default will also set the same layout on the corresponding system or enclosure(s) that are currently set to default. [ QSTOR-10496 ]
* Fixed an issue with using the wrong LED control Utility for disk identification on Supermicro NVMe storage systems. [ QSTOR-10469 ]
* Added support for Supermicro SBB-SSG-221E-DN2R24R to enclosure/server views. [ QSTOR-10460 ]
* Added Support for Supermicro SSG-641E-E1CR36L/H to enclosure/server views. [ QSTOR-10429 ]
* Prevent a missing disk from being blinked. [ QSTOR-10179 ]

High Availability Failover
* Fixed an issue that could terminate the qs_pool_export script early on ha failover without final logging. [ QSTOR-10514 ]
* Fixed: added a check for HA VIFs to the network port offline dialog. This prevents a possible split cluster scenario. [ QSTOR-10414 ]
* Updated Task error messages to include the system where an error occurred for HA Storage pool failover tasks. [ QSTOR-10248 ]
* Added periodic HA failover group health checks for client and media connectivity. An alert will be raised If a health check fails that could indicate an issue with the future success of a High Availability failover from the primary to secondary node. [ QSTOR-9380 ]

Network Interfaces
* Prevent modifying parent port when static route is configured. [ QSTOR-10200 ]
* Fixed: removed iscsi and nvmeof portal configuration options on all grid vifs. client access should be configured through HA or Site cluster vifs only. [ QSTOR-9974 ]

Network Shares
* Fixed: NFS remove client access dialog and the qs share-client-remove CLI command now default to immediately terminate client connections for removed export rules, enhancing security. An option to retain client connections is available in the UI ("Retain Client Connections") and CLI (--retain-client-connection=true). [ QSTOR-10431 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Remote Replication reporting incorrect snapshot count. [ QSTOR-10476 ]
* Added a ZFS quantastor:scheduletype property to snapshots so that it is clearer what type of schedule created the snapshot. [ QSTOR-10421 ]
* Fix duplicate entries in replication dashboard. [ QSTOR-10385 ]
* Use raw mode for ZFS send and receive. Use on the wire compression if the source is not compressed. [ QSTOR-10153 ]

SNMP
* Update SNMP MIB [ QSTOR-10512 ]

Security
* Added feature to replace the OSD encryption keys for a given Ceph cluster. [ QSTOR-10283 ]
* Improved qs-util wrapper script so that user is prompted for secret passphrase. Passphrase will remain hidden. [ QSTOR-9982 ]

Service Core
* Fix minor trace message for Maintenance schedules. [ QSTOR-10416 ]
* Added a check to the QuantaStor system startup to ensure that LUKS encrypted Physical disks devices provided to QuantaStor via the iSCSI Software adapter are opened after system boot. [ QSTOR-10257 ]

Upgrade Manager and Installer
* Added support for customizing OVF templates with passwords and license keys. [ QSTOR-10451 ]
* Fixed an issue with the archived centos ganesha mirrors in the qs_upgrade_redhat8.sh install and upgrade script. [ QSTOR-10446 ]

Web Manager
* Fixed an issue where the User Web Customization rules were not being properly applied when the rules were defined in the Role create or modify dialog. [ QSTOR-10513 ]
* Fixed the text highlight and other colors used in the UI to be consistent across elements. [ QSTOR-10470 ]
* Update: Replaced all instances of 'double click to reveal plain text' on password fields with an explicit eyeball reveal button to allow users to show plain text. [ QSTOR-10410 ]
* Updated web manager tomcat and Java runtime dependencies. [ QSTOR-9492 ]

== v6.3.7.011 (June 18th 2024) ==

=== [[QuantaStor 6.3.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.7 Upgrade Instructions| upgrading to QuantaStor v6.3.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue with creating Erasure Coded Ceph Object Storage Classes in the Web UI. [ QSTOR-10434 ]

Dashboards and Analytics
* Fixed the install-ceph-prometheus scripts to always have a default fallback install version if the latest version is not available. [ QSTOR-10441 ]
* Updated wiki documentation for the Prometheus and Grafana Integration guide to reflect changes from latest Grafana 11.0 release. [ QSTOR-10441 ]

Enclosures and Controllers
* Fixed several items and updated logic for External System Corvault support. [ QSTOR-10235 ]

Kernel and Drivers
* * Fixed an issue with modern mellanox OFED installs using the mellanox-ofed-install.sh script and legacy ConnectX-3 Based Mellanox HBA's [ QSTOR-10295 ]

Network Shares
* Added logic to always bind mount the /export paths on Network Shares even if the share has no NFS access rules and is set to disabled and SMB/CIFS disabled. This includes Nested shares under Parent Network Shares. No noticeable increase in failover times was detected when testing on a Large HA config with many Network Shares including many Nested Shares and snapshots. [ QSTOR-10424 ]
* Fixed an issue with the Network Share snapshot count property. [ QSTOR-10329 ]
* Re-enabled the Network Share Snapshot count column by default in the Network Share Grid View. [ QSTOR-10329 ]

Storage Volumes
* Fixed an issue where FC ALUA standby LUN devices for Storage Volumes would not appear as non-rotational(SSD) to clients when on an SSD or NVMe based Storage Pool. Note: a reboot is required to reload the SCST kernel driver stack on the system for the fix to take effect. [ QSTOR-10417 ]
* Fixed an issue with presenting pass-through Storage Volumes as non-rotational(SSD) to clients. [ QSTOR-10417 ]

Upgrade Manager and Installer
* Updated mellanox-ofed-install.sh script to support latest Mellanox OFED 24.04-0.6.6.0 [ QSTOR-10438 ]
* Added a lts optional flag to the mellanox-ofed-install.sh for installing Mellanox OFED version 5.8-4.1.5.0. [ QSTOR-10438 ]

Web Manager
* Fix a minor ribbon bar alignment and spacing issue between elements by making a deferred force layout call during context switching. [ QSTOR-10413 ]
* Fixed an issue where some elements of the Ribbon Bar would not be visible or would somehow be under the visible section of the UI. [ QSTOR-10413 ]
* Removed the ZFS share encryption tab from the create and modify network share dialogs. The ZFS Share encryption feature is still available for share creation via the CLI but is not recommended for most users due to ZFS driver level issues. When the ZFS driver issues are resolved in a future ZFS release, the encryption tab will be re-enabled. [ QSTOR-10352 ]

== v6.3.6.003 (June 4th 2024) ==

=== [[QuantaStor 6.3.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.6 Upgrade Instructions| upgrading to QuantaStor v6.3.6]].

=== Release Notes ===
Remote Replication, Snapshots and Backup Policies
* Added a check to enforce 'Enable target checkpoint recovery (unchecking will perform full replication)' setting on Remote Replication Schedules. This helps ensure that no additional _chkpnt is created for a share or volume if one already exists for the source and target replication association. [ QSTOR-10419 ]
* Fixed an issue with replication report showing synchronizing state forever. [ QSTOR-10419 ]

Security
* Added qs-util wuicustomcerts command to allow creation of a /var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf nginx override config so that users can customize certificate paths and ciphers from the QuantaStor defaults for the Web UI. [ QSTOR-9037 ]

== v6.3.5.020 (May 23rd 2024) ==

=== [[QuantaStor 6.3.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.5 Upgrade Instructions| upgrading to QuantaStor v6.3.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where s3 gateway create was creating load balancers with https->https mode when https->http mode was passed in. [ QSTOR-10399 ]
* Fixed some issues with discovery of the http/https mode for the S3 load balancer. [ QSTOR-10399 ]
* Further optimizations and fixes related to Grid communication and Ceph Scale-out Object discovery on Object Storage Pools with a large number of buckets. [ QSTOR-10380 ]
* Fixed an issue with adding and removing RGW instances on the same node via different IP addresses. [ QSTOR-10370 ]

High Availability Failover
* Added logic to limit number of open threads and open file handles needed to unmount shares for the HA storage pool failover process. This fixes an issue with deployments that have a large amount of shares, including nested shares and share snapshots. [ QSTOR-10373 ]
* Added more coverage for the auto close open file handles logic during HA storage pool failover to help unmount shares under the nfs /exports path as well as nested shares/snapshots. [ QSTOR-10373 ]

Multitenancy
* Fixed some issues with Multitenancy Container discovery and database table updates. [ QSTOR-10363 ]

Network Interfaces
* Added a exact match filter config file /var/opt/osnexus/quantastor/conf/qs_portFilter.conf for interface names that allows users to blacklist interfaces they do not want QuantaStor to see and/or manage. [ QSTOR-9664 ]

Network Shares
* Fixed an issue with the Network Share samba audit logging feature when upgrading from a legacy audit logging config. [ QSTOR-10390 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Security
* Adds support for controlling the sample period over which bad login attempts can trigger a short or permanent lock. [ QSTOR-10374 ]
* Adds support for controlling the duration of the short lock. [ QSTOR-10374 ]
* Fixes a security bug where good login attempts could mask bad login attempts by clearing the bad login attempt sample set for a given user. [ QSTOR-10374 ]
* Changes the special rules around bad login attempts for the 'admin' user, now allowing it to be locked. [ QSTOR-10374 ]
* Adds a touch file to unlock the 'admin' user account. [ QSTOR-10374 ]
* Adds a touch file to block the permanent locking of the 'admin' user account, which is similar to the current behavior. [ QSTOR-10374 ]

Storage Volumes
* Fixed an issue where iSCSI CHAP was not being correctly enabled in the iSCSI target on volumes when configured. [ QSTOR-10398 ]
* Fixed an issue with Fibre Channel Storage Volumes being presented after Storage System boot for Single QuantaStor node deployments (non-HA). [ QSTOR-10277 ]

== v6.3.4.003 (May 14th 2024) ==

=== [[QuantaStor 6.3.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.4 Upgrade Instructions| upgrading to QuantaStor v6.3.4]].

=== Release Notes ===

Web Manager
* Optimized WebUI login time for Large Scale-out Object deployments. [ QSTOR-10365 ]
* Fixed an issue where the WUI idle logout timer would be reached even when browsing inside of the WUI for various different sections. [ QSTOR-10361 ]

== v6.3.3.033 (May 1st 2024) ==

=== [[QuantaStor 6.3.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.3 Upgrade Instructions| upgrading to QuantaStor v6.3.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added qs_rgw_iam_policy.sh script for generating S3api IAM compatible bucket policies. [ QSTOR-10336 ]
* Added FQDN specific string validation to the Modify Realm/Zone Group dialog. [ QSTOR-10320 ]
* Fixed some items with the Modify Realm/Zone Group task. [ QSTOR-10320 ]
* Added a drop-down to the Create Storage Class Dialog with pre-defined S3 Storage Classes supported by most S3 CLI and S3 Library based clients. Users can still create a custom Storage class if they so choose and use their own custom S3 API implementation that supports Custom S3 Storage Classes. [ QSTOR-10232 ]
* Fixed some issues with adding/removing S3 Gateways with Load Balancers. [ QSTOR-9848 ]

High Availability Failover
* Added a force flag to the Remove Site Cluster Virtual Interface dialog. [ QSTOR-8276 ]
* Added logic to auto re-apply iofencing to devices that are re-added to the system due to prior physical removal or power loss of the device/device enclosure. [ QSTOR-5475 ]
* Fixed an issue with enabling client connectivity on HA Groups and implemented more safe guards. [ QSTOR-3432 ]

Network Shares
* Add touch file to limit discovery of snapshots of nested shares. [ QSTOR-10334 ]
* Fixed: Network Share rename will correctly remount the /export/ NFS mount location to the new name. [ QSTOR-10318 ]
* Fix minor message during share disable with active SMB clients. [ QSTOR-10292 ]
* Share disable will close open file handles to the share when accessed via SMB. [ QSTOR-10291 ]
* Fixed an issue where Network sub-share alias shares would not start properly after Storage Pool HA Failover. [ QSTOR-10278 ]
* Fixed an issue where share alias advanced settings allowed modification after an HA failover. [ QSTOR-10276 ]

Remote Replication, Snapshots and Backup Policies
* Fix update selections for a replication schedule for cases where source is on a HA pool. [ QSTOR-10310 ]
* Fixed an issue with Windows Previous Versions on share-alias. [ QSTOR-10274 ]
* Added a check to ensure no duplicate share alias names are created on the same parent share. [ QSTOR-10274 ]

Security
* Fixed an issue where the Security Manager > Default Login Username field was not initializing to 'admin' for default installs and upgrades. [ QSTOR-10323 ]

Upgrade Manager and Installer
* Added logic to remove legacy google-compute-engine-oslogin and/or google-guest-agent on upgrade. These packages caused systems to not shutdown properly when installed. [ QSTOR-10340 ]
* Added a check to ensure the ledmon service is disabled by default. This is to ensure that there are no conflicts with the QuantaStor managed Disk Identify logic. [ QSTOR-10313 ]

Web Manager
* Added paging support to S3 Bucket search [ QSTOR-10324 ]

== v6.3.2.025 (April 15th 2024) ==

=== [[QuantaStor 6.3.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.2 Upgrade Instructions| upgrading to QuantaStor v6.3.2]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added search capability to the S3 Bucket section of the Web UI. [ QSTOR-10288 ]
* Added Rule Sorting and an explicit rule remove button to the Storage Class Auto-Tiering Rules Dialog. [ QSTOR-10287 ]
* Added: You can now add the FQDN's for DNS names that you want the S3 Gateways to respond to via the Modify Realm/Zone Group Dialog. Note: you must add the FQDN's of the hosts or an FQDN alias e.g. s3.yourdomain.net (like used by DNS round robin) for the HAproxy load balancer to work properly. [ QSTOR-10285 ]
* Fixed issues with Ceph S3 Bucket discovery with a large amount of buckets. [ QSTOR-10261 ]
* Fixed some items related to Veeam SOSAPI integration based on testing in Veeam Certifcation scripts. [ QSTOR-10243 ]

Enclosures and Controllers
* Fixed an issue where Dell RAID Controllers were being discovered twice in due to new support for the controllers discovery in Broadcom storcli utilities. [ QSTOR-10244 ]

High Availability Failover
* Fixed an issue where rebooting an active High Availability storage node would cause ZFS encrypted shares to go offline for any active pools on that node prior to automatic failover. [ QSTOR-10218 ]

Network Interfaces
* Fixed an issue where legacy VLAN interfaces that had the RX/TX optimizations flag set would not allow modification of the interface for any other setting. [ QSTOR-10272 ]

Not Set
* Added logic to prioritize high-speed data ports by default in the Ceph Cluster create and S3 gateway create dialogs. [ QSTOR-10266 ]
* Fixed usable space calculation on Object Pool Group when there are multiple Pools or Storage Classes using the same OSD's. [ QSTOR-10264 ]
* Fixed an issue with modifying a network share after after a custom veto files setting had been added to the samba cifs options. Now the veto files merge as a set with the default .qssnaps veto files used by the VSS GMT snapshots feature. [ QSTOR-10249 ]

Security
* Updated the OSNEXUS Security Notice service [https://services.osnexus.com/security/](https://services.osnexus.com/security/) for bionic and focal platform support. [ QSTOR-10269 ]

Service Core
* Added support for replacing ntpd with chronyd in Ubuntu Focal platform based deployments. [ QSTOR-10239 ]

== v6.3.1.009 (April 1st 2024) ==

=== [[QuantaStor 6.3.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.1 Upgrade Instructions| upgrading to QuantaStor v6.3.1]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where a pool running a scrub would report as degraded in the Config Analyzer health report. [ QSTOR-10258 ]

Ceph Scale-out Block, Object and File
* Added qs-rgw-moveobjects script to allow easier s3api copy-object of a buckets contents to a different storage class. [ QSTOR-10268 ]
* Changed haproxy load-balancer to use balance source mode by default. [ QSTOR-10260 ]
* Fixed an issue with the Storage Class Auto-Tiering rules where multipart uploads with Capacity Operators of greater than or greater and equal to the Capacity Threshold would not be uploaded to the correct storage class. [ QSTOR-10254 ]

Enclosures and Controllers
* Changed qs-util seagate-ap-split mode command to use zone 5 [ QSTOR-10259 ]

Web Manager
* Increased default max bucket count for S3 user to 100K. [ QSTOR-10256 ]
* Added new Grid Preferred Port status column in the Network Port Grid. It's hidden by default. [ QSTOR-10256 ]
* Fixed s3 gateway dialog height so it can show more nodes in the grid. [ QSTOR-10256 ]
* Fixed s3 tenant create, if "Display Name" is not specified use the "Name" (display name is no longer mandatory in dialog). [ QSTOR-10256 ]

== v6.3.0.268 (March 20th 2024) ==

=== [[QuantaStor 6.3.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.0 Upgrade Instructions| upgrading to QuantaStor v6.3.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where md software raid os partitions where being reported in the config analyzer as offline storage pools. [ QSTOR-10168 ]
* Fixed an issue where non-management ports were being flagged in the config analyzer for iSCSI acess being enabled. [ QSTOR-9891 ]

Ceph Scale-out Block, Object and File
* Blocked creating new OSDs when the OSD service is masked. [ QSTOR-10212 ]
* Show the S3 Object Storage Pool as the root node in the S3 User's and Tenant tree. [ QSTOR-10156 ]
* Show the S3 Object Storage Pool as the root node in the bucket tree. [ QSTOR-10150 ]
* Add support for multiple data pools for storage classes for Ceph Object Storage Pool. [ QSTOR-10137 ]
* Add auto tiering capability to ceph buckets. [ QSTOR-10125 ]
* Change the Ceph block storage pool to default to replica=3 for performance. [ QSTOR-10062 ]
* For CephFS, the min_size for the metadata pool should be 2. [ QSTOR-10015 ]
* Introduce safe disk replacement for Ceph OSDs. [ QSTOR-9937 ]
* Applied adjustments to Ceph Clusters for optimized scrubs on smaller and denser clusters. [ QSTOR-9900 ]
* Updated NFS Ganesha to 5.7 [ QSTOR-9821 ]
* Add support for Ceph Multi-site bucket replication. [ QSTOR-6570 ]

Disk Management
* Added support for ScaleFlux CSD 3000 SSDs that support builtin compression provisioning. [ QSTOR-10198 ]
* Fixed an issue with disk correlation by serial number on Broadcom/LSI 93XX series HBAs. [ QSTOR-10194 ]
* Show osd number in 'qs disk-list'. [ QSTOR-9717 ]

Enclosures and Controllers
* Add enclosure view for the ASUS 2u24 NVMe. [ QSTOR-10202 ]
* Fix controller selection issue in the 'Identify Hardware Controller Disk Device' dialog for when the selected object in the Physical Disk tree is a Physical Disk and not the Disk itself. [ QSTOR-10195 ]
* Updated wddcs tool to 3.2.8.0 [ QSTOR-10166 ]
* Added to feature to create or delete multiple External System Volume configurations. [ QSTOR-10061 ]

High Availability Failover
* Fixed an issue with the Create HA Failover Group Dialog when there are active FC sessions on volumes on the selected pool. [ QSTOR-10169 ]
* Changed NVMe reservations to use cptpl=2 when available so that iofencing is cleared on power on of a nvme drive. [ QSTOR-10124 ]

Licensing
* Added logic to auto-fetch new QuantaStor License Server ca certificates during online license activation. [ QSTOR-10174 ]

NAS Gateway / Cloud Containers
* Update rclone version. [ QSTOR-9512 ]

Network Interfaces
* Show static route parent port in the respective grid and delete dialog. [ QSTOR-10199 ]
* Fixed an issue with onlining/restarting offline VLAN interfaces. [ QSTOR-10180 ]
* Fixed an issue with VLAN ontop of Bonded ports on VM deployed QuantaStor instances. [ QSTOR-10180 ]
* Improve the Network bond mode descriptions, in the 'Create Bonded Port' dialog, for those that require managed switches. [ QSTOR-9842 ]
* Added IP address place holder for DHCP interfaces that have no assigned IP address. [ QSTOR-9828 ]
* Fixed an issue with downing virtual interfaces when converting to HA virtual interface. [ QSTOR-9774 ]

Network Shares
* Minor Web UI fix to display share quota percent utilization. [ QSTOR-10121 ]
* Implemented a Real Time Auto Copy feature to enhance data protection for Network Shares. [ QSTOR-9929 ]
* Updated Focal platform Samba to 4.18.6 backported from ubuntu upstream release. [ QSTOR-9924 ]
* Show parent shares in the 'qs share-list' command results. [ QSTOR-9702 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Remote Replication, Snapshots and Backup Policies
* Add the ability to force create symbolic links for backup policy outbound-move to cloud containers without a delay of 24 hours. [ QSTOR-10136 ]
* Update Replication Report Summary object as failed if source system reboots right after schedule is triggered. [ QSTOR-10097 ]

SNMP
* Regen SNMP MIB for 6.3 [ QSTOR-10228 ]

Security
* Updated JQuery version used in the QuantaStor WebUI to 3.7.1 [ QSTOR-10064 ]
* Add Audit Log Viewing to the Storage System menus. [ QSTOR-10031 ]

Storage Pool Management
* Improved logic for replacing zpool UNAVAIL disks that are identified by their id instead of a device path as the disk is no longer present or visible to the OS. [ QSTOR-10129 ]

Upgrade Manager and Installer
* Automatically disable and mask uefi fwupd service on platforms that include it to prevent unplanned firmware updates. [ QSTOR-10205 ]
* Fixed: the low boot space warning for kernel upgrades now correctly appears in the Upgrade Manager task failure message. [ QSTOR-10185 ]
* Fixed an issue where the scst/zfs userspace packages were not being pinned on security updates. [ QSTOR-10185 ]
* Fixed an issue where qstortarget was incorrectly selected during security updates but fails due to existing pinning rules. qstortarget now correctly only gets selected for install on kernel/driver upgrades. [ QSTOR-10185 ]

Web Manager
* Minor fix to show NA for share-alias space columns. [ QSTOR-10227 ]
* Login dialog shown after service restart is complete. [ QSTOR-10007 ]

== v6.2.8.016 (March 5th 2024) ==

=== [[QuantaStor 6.2.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.8 Upgrade Instructions| upgrading to QuantaStor v6.2.8]].

=== Release Notes ===

Enclosures and Controllers
* Fixed Hardware Disk to Physical disk slot correlation issues. [ QSTOR-10135 ]
* Improved Enclosure object guid uniqueness to better support more complex/multipath setups for hardware disk to physical disk mapping. [ QSTOR-10135 ]
* Added Hardware Enclosure Serial\# property and logic to discover serial\# when available. [ QSTOR-10102 ]

Multitenancy
* Updated Resilio container image to 3.8.1.2250 [ QSTOR-10162 ]
* Fix errors with Resilio container errors seen after upgrade. [ QSTOR-10099 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue that could sometimes cause duplicate snapshot objects to appear for snapshot schedules with nested shares and recursive snapshot enabled. [ QSTOR-10159 ]
* Added a check to temporarily prevent adding ZFS dataset encrypted Network Shares to remote replication schedules until the Open ZFS issue \#12014 is resolved in an upcoming ZFS release. [ QSTOR-10145 ]
* Fixed an issue with using Windows Restore Previous Versions on remote Replica \_chkpnt Network Shares. [ QSTOR-10065 ]

SCSI / NVMe Target
* Updated SCST driver to 3.8.0.9038-f134517-qs01 to support latest available linux kernels for Focal platform and Focal cloud platform kernels. [ QSTOR-10151 ]

Upgrade Manager and Installer
* Added Kernel Driver Support for QuantaStor installation on Ubuntu 20.04 images on Azure, AWS and Google Cloud. [ QSTOR-10138 ]

== v6.2.7.002 (February 23rd 2024) ==

=== [[QuantaStor 6.2.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.7 Upgrade Instructions| upgrading to QuantaStor v6.2.7]].

=== Release Notes ===

Licensing

* Updated license manager certificates for online license activation. [ QSTOR-10154 ]

== v6.2.6.024 (February 8th 2024) ==

=== [[QuantaStor 6.2.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.6 Upgrade Instructions| upgrading to QuantaStor v6.2.6]].

=== Release Notes ===

Enclosures and Controllers

* Added support for iofencing NVMe disks that do not support cdw11 [ QSTOR-10087 ]
* Added an Alert for when a OS Software RAID1 mirror enters a degraded state. [ QSTOR-10080 ]
* Added support LSI-3008C0 model controllers. [ QSTOR-9841 ]
* Added a check to hardware Enclosure Discovery to automatically filter out enclosures that do not have any drive slots. [ QSTOR-9716 ]

High Availability Failover

* Fixed an issue with the I/O fencing tool where it was reporting not-supported on reservation capable nvme devices. [ QSTOR-10114 ]

Network Interfaces

* Updated static routes to use modern ip route syntax with the 'proto static' option. [ QSTOR-10103 ]
* Updated netplan conversion to by default create static routes using ip route to match the original netplan static route rules. [ QSTOR-10103 ]

Storage Pool Management

* Fixed: Activate HA Failover Group now works for Storage Pools in a degraded state missing a few devices. [ QSTOR-10100 ]
* Fixed: Create HA Failover Group now allows a force option if there are a small number of drives missing on the secondary node. Note that the operation will still be blocked if most/all of the drives are missing from the secondary node. [ QSTOR-10100 ]
* Added support for Zero Touch Maintenance Automatic Global Hot spare marking of Hardware RAID0 Passthrough units. [ QSTOR-9865 ]

Storage Volumes

* Fixed: NVMe Target Storage volumes now persist their serial numbers correctly on reboot [ QSTOR-9992 ]
* Fixed: the NVMe Target now correctly re-exports the allowed portals on system boot. [ QSTOR-9992 ]

Upgrade Manager and Installer

* Updated mellanox-ofed-install.sh script to support the latest Focal platform 5.15.0-91-generic kernel. [ QSTOR-10117 ]
* Updated the GPG repo keys for QuantaStor RedHat / and Almalinux platform installs [ QSTOR-10107 ]
* Fixed a incorrect error log when upgrading the Kernel and Drivers on the Ubuntu Focal platform. The upgrade would succeed when the error was seen, but it was unclear to the user without full log analysis. [ QSTOR-10106 ]
* Updated upgrade manager logic to ensure recommended dependency packages are always selected for install during core service and security upgrades. [ QSTOR-10101 ]
* Fixed an issue with the qs-distupgrade script where some QuantaStor core package changes were not being applied after a platform dist-upgrade from bionic to focal. [ QSTOR-10132 ]
* Added better logging of systemctl service enablement and restart during qstorservice package installs. [ QSTOR-10134 ]

== v6.2.5.032 (January 18th 2024) ==

=== [[QuantaStor 6.2.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.5 Upgrade Instructions| upgrading to QuantaStor v6.2.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added ssh port 22 to network connectivity checker tests. [ QSTOR-10092 ]

Ceph Scale-out Block, Object and File
* Fix bug where ceph monitor daemon is disabled. [ QSTOR-10095 ]
* Added script to setup Ceph multi-site replication. [ QSTOR-10075 ]

Enclosures and Controllers
* Updated storcli version to 007.2705.0000.0000 [ QSTOR-10072 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-10036 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-9825 ]

Kernel and Drivers
* Updated Linux Kernel to 5.15.0-91-generic for Focal platforms [ QSTOR-10025 ]
* Linux Kernel 5.15.0-91-generic includes fixes for NFS v3 lockd that would cause file handles to be left open for NFSv3 clients when attempting to stop the nfs server before ZFS pool export during HA failover. [ QSTOR-10025 ]
* Updated ZFS to 2.1.14.qs25 for Focal platforms [ QSTOR-10025 ]

Multitenancy
* Fix an issue with missing Service Configs. [ QSTOR-10079 ]
* Add the ability to sync nested shares when parent share is selected in Resilio. Optionally skip changing the share permissions when user is specified in the config file. [ QSTOR-10070 ]

Network Shares
* Block rename of nested shares. [ QSTOR-10091 ]
* Add the ability to enable and clone a GMT snapshot [ QSTOR-4145 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue where Remote Replication Schedules can fail if 2 source snapshots have the same created timestamp. [ QSTOR-10059 ]
* Fix a minor issue with File Age settings in the Backup Schedule Modify dialog. [ QSTOR-10056 ]
* Properly transition a Replication task and Replication Report to the 'failed' status if the source system loses power during the Replication. [ QSTOR-10041 ]
* Add a warning if checkpoint is selected in create snapshot schedule. [ QSTOR-10038 ]

Storage Volumes
* Fixed an issue with zfs storage volumes being correctly marked as missing if the underlying zfs zvol or snapshot is removed or unavailable. [ QSTOR-10086 ]

Upgrade Manager and Installer
* Added a --password option to the qs\_install.sh script to allow users to provide the QuantaStor admin user password as well as the same password for the default qadmin shell account. [ QSTOR-10085 ]

Web Manager
* Clear the replica summary graph when there are no report entries. [ QSTOR-10057 ]
* Fix enclosure graph rendering issue where a selected system with multiple valid controllers was not being render because of one underlying MD BOOT Controller. [ QSTOR-10055 ]

= Archived Change Logs =

== [[Change Log Archive 2023]] ==

== [[Change Log Archive 2022]] ==

== [[Change Log Archive 2021]] ==

== [[Change Log Archive 2020]] ==

== [[Change Log Archive 2019]] ==

== [[Change Log Archive 2018]] ==

== [[Change Log Archive|Change Log Archive pre-2018]] ==

Select the link above to see the [[Change Log Archive]] of older revisions.

QuantaStor 6.8.2 Upgrade Instructions

2026-07-24T16:48:22Z

Qadmin: Create 6.8.2 upgrade instructions page

= Upgrading to 6.8.2, and Latest OS Packages and Security updates via Command Line Interface =

'''This is the recommended option for systems running 6.x QuantaStor versions on the Focal Platform, and systems that may be out of date and require OS level package updates as well.'''

This procedure will upgrade the QuantaStor system to the latest software version, and also update all OS level packages to their latest versions as well, ensuring the system software has the latest security patches in place.

It is recommended that you schedule a downtime work window, as a reboot may be required for changes in the 6.8.2 upgrade. You will need to run these commands as a user with sudo access on the QuantaStor appliance, such as the default 'qadmin' account, or as root if you have enabled direct root access.

:''NOTE: We recommend allocating a maintenance window for all upgrades. For more complex upgrades we recommend scheduling time with OSNEXUS support for assistance.''

'''Login to the CLI to perform a full upgrade to QuantaStor 6.8.2 along with the latest Kernel and Security and OS packages.'''

<pre>
# For Noble platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-noble/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Jammy platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-jammy/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Focal platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-focal/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true
</pre>

Once the install completes you will be running QuantaStor 6.8.2

'''Platform Upgrades from Jammy to Noble via the qs-distupgrade command are enabled with the 6.8.0 release.'''

'''Platform Upgrades from Focal to Jammy via the qs-distupgrade command are enabled with the 6.5.1 release.'''

'''Platform Upgrades from Bionic to Focal via the qs-distupgrade command are enabled with the 6.0.4 release.

'''Platform Upgrades from Xenial to Bionic via the qs-distupgrade command are enabled with the 5.10.2 release.

'''OSNEXUS Support recommend fully upgrading to the latest available, including System and Kernel Updates using the commands above. Please contact Support for assistance with a platform upgrade.'''

'''Platform Upgrades via the qs-distupgrade command from QuantStor 4.x on Trusty are enabled with the 4.7.2 release. '''

'''Please contact support@osnexus.com if you have any questions or need upgrade assistance.

QuantaStor Version ChangeLog

2026-07-24T16:48:22Z

Qadmin: Add v6.8.2.002 release notes (QSTOR-12025)

[[Category:Support guide]]
= Change Log Overview =
The change log contains a detailed summary of the changes made for each new release of QuantaStor. Each change made to QuantaStor is tracked with an engineering ticket number in the form '''[QSTOR-NNNN]'''. This information is provided so that if you're working with OSNexus support you can track the availability of a given product feature add, improvement, or maintenance fix to a specific release. For information on how to upgrade your storage system please see the [[QuantaStor Upgrade Guide|Upgrade Guide]].

== Versioning System ==
QuantaStor version numbers consist of four (4) parts. A major number (M), minor number (N), maintenance update number (U) and build number (B) of the form M.N.U.B such as 6.0.2.006.

QuantaStor upgrades go directly from whatever version you are running to the latest version, with no interim steps so for example if you are at v6.0.1 you will upgrade directly to the latest version which may be v6.1.2

== Product Update Types ==

==== Major Updates (X.y.z) ====
If the first digit in the version number has changed this indicates a major product release such as QuantaStor v5 to QuantaStor v6. Major releases generally come with a new underlying Linux platform as the basis. For example, the standard ISO install for QuantaStor v5 is based on Ubuntu 18.04 whereas QuantaStor v6 is based on Ubuntu 20.04. Major product releases generally include new features and maintenance updates and are supported on multiple underlying Linux platforms. For example, QuantaStor v6 is available as an upgrade on Ubuntu 18.04 and Ubuntu 20.04 based systems as well as RHEL and RHEL derivative platforms. Platform upgrades to move systems forward (eg 18.04 to 20.04) are made generally available in the first feature update release, such as QuantaStor 6.1.

==== Feature Updates (x.Y.z) ====
If the second digit in the version number has changed this indicates a feature release such as 6.'''1''' going to 6.'''2'''. Feature releases add new product features as well as a maintenance updates. No additional licensing is required to access any new features that added but note that QuantaStor licenses do not include licenses for 3rd party products and services that may integrate with QuantaStor.

==== Maintenance Updates (x.y.Z) ====
If the third digit of the version number has changed this such as 6.0.'''2''' or 6.0.'''3''' it represents a maintenance update to address one or more support tickets. These updates generally do not contain new features, only fixes to address specific issues. Maintenance releases generally ship every 4 to 8 weeks. All maintenance "aka hot-fix" releases are provided against the current stable release so upgrading to the latest QuantaStor version is generally required to apply them.

==== Build Number (x.y.z.BBB) ====
The build number and corresponding build reference hash can be largely ignored. The build number simply increments with each commit that is made to the source tree. The hash is provided to make it easier for OSNEXUS support and engineering to quickly confirm difference between your current running release and any more modern release.

== Boot Install Image and other downloads ==
=== ISO/DVD/USB Boot Install Image ===

* The latest version of QuantaStor can be found on our [https://downloads.osnexus.com downloads page here].

* [[QuantaStor Installation via USB Thumb Drive|Bootable Flash Drive instructions.]]

NOTE: Archived older versions of QuantaStor ISO install media and CLI tools can be found [https://downloads.osnexus.com.s3.us-east-1.amazonaws.com/list.html here].

= Recent Change Logs =

== v6.8.2.002 (July 24th 2026) ==

=== [[QuantaStor 6.8.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.2 Upgrade Instructions | upgrading to QuantaStor v6.8.2]].

=== Release Notes ===

Network Shares
* Fixed: AD groups could not be added to a Network Share ACL in Winbind+SSSD mode (group@DOMAIN form could not be resolved). [ QSTOR-12025 ]

== v6.8.1.007 (July 18th 2026) ==

=== [[QuantaStor 6.8.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.1 Upgrade Instructions | upgrading to QuantaStor v6.8.1]].

=== Release Notes ===

Upgrade Manager and Installer
* Fixed: platform upgrades remove the obsolete linux-tools-common package that could trigger security alerts. [ QSTOR-10314 ]
* Changed: qs-distupgrade output is timestamped and includes a pre-upgrade configuration report. [ QSTOR-11632 ]
* Added: platform distribution upgrade (qs-distupgrade) from Ubuntu 22.04 to 24.04. [ QSTOR-11651 ]
* Added: non-interactive flags for qs-distupgrade enabling fully unattended platform upgrades with automatic reboot. Use the qs-distupgrade --help to review the available usage options. [ QSTOR-11918 ]
* Fixed: platform distribution upgrades keep Ceph pinned at its current version. [ QSTOR-11955 ]
* Added: qs-distupgrade requires all Ceph nodes on the latest offered Ceph version (--skip-check-ceph-latest to override). [ QSTOR-11958 ]
* Fixed: coordinated Ceph upgrades restart all RGW daemons on hosts running multiple RGW services. [ QSTOR-11983 ]
* Fixed: a 6.8.0-only issue where service-driven package upgrades reported success without installing anything. [ QSTOR-11992 ]

== v6.8.0.205 (July 8th 2026) ==

=== [[QuantaStor 6.8.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.0 Upgrade Instructions | upgrading to QuantaStor v6.8.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert webhook support for Google Chat. [ QSTOR-9793 ]
* Allow users to have a subset of alert subscriptions. [ QSTOR-11683 ]

Ceph Scale-out Block, Object and File
* Added an 'Enable Versioning' checkbox to the Create Bucket dialog (automatically enabled when object locking or governance/compliance is selected); versioning can also be enabled on existing buckets. [ QSTOR-10937 ]
* Added Ceph Tentacle 20.2.2 support to the Jammy QuantaStor ISO and package mirror. [ QSTOR-11441 ]
* QuantaStor 6.8 ships Ceph 20.2.2 (Tentacle), which includes the upstream MDS fix (tracker #76031) for the SIGABRT/crash on client eviction caused by a null MDRequestRef under sustained metadata contention. [ QSTOR-11504 ]
* The Ceph Tentacle 20.2.2 release resolves frequent radosgw (RGW) crashes related to Kafka bucket notifications. [ QSTOR-11687 ]
* Fix ceph bucket delete with large number of objects timing out. [ QSTOR-11728 ]
* Removed: the deprecated S3 bucket orphan-object cleanup feature; any existing scheduled task is disabled automatically on upgrade. [ QSTOR-11729 ]
* Fixed a regression where deleting multiple Ceph (RBD) volumes at once on a multi-node cluster would fail after the first volume. [ QSTOR-11756 ]
* Added support for major-version Ceph upgrades (through Tentacle 20.2.x) in the upgrade script. [ QSTOR-11762 ]
* Increase the timeout for "Add Node" to a ceph cluster [ QSTOR-11906 ]

Dashboards and Analytics
* Added: a 'qs-statsdb resetpassword' command to rotate the InfluxDB stats password; telegraf is updated in lockstep so dashboards keep working. [ QSTOR-11170 ]
* Rebuilt bundled telegraf with its vendored rclone library updated to 1.74.3, clearing CVE-2026-41176 and CVE-2026-41179. [ QSTOR-11771 ]
* Fixed the Ceph RGW dashboard on Ceph Tentacle so it correctly reports throughput/latency when transferring files to a bucket. [ QSTOR-11803 ]

Enclosures and Controllers
* Fixed issue with "disappearing" enclosures [ QSTOR-11676 ]
* Added support for the Supermicro SSG-222B-NE3X24R all-NVMe server, including hardware enclosure auto-detection, enclosure layout and diagram, and NVMe drive slot mapping in the QuantaStor web management interface. [ QSTOR-11712 ]

High Availability Failover
* Add logging for manually run iofence commands [ QSTOR-11751 ]
* Fixed HA pool failover persisting a stale size=0 / isMounted=false when the pool's datasets were still mounting during fast-import; the last-known-good size and mount state are now preserved (and the corrected record wins via a bumped modified timestamp). [ QSTOR-11818 ]
* Fixed: Storage Pool HA io-fencing and failover now work over NVMe-TCP; target namespaces advertise persistent reservations. [ QSTOR-11850 ]

Kernel and Drivers
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]
* Updated the Mellanox OFED driver installer for current Ubuntu 22.04 (Jammy) kernels, fixing driver installation failures on recent kernels. [ QSTOR-11709 ]

Multitenancy
* Added RBD namespace support, allowing multiple tenants to share a single Ceph block pool with isolated volumes. [ QSTOR-11650 ]

NAS Gateway / Cloud Containers
* Add a fix for Samba access to Cloud Container shares. [ QSTOR-11763 ]
* Fixed: cloud containers are now accessible over SMB, not just NFS. [ QSTOR-11824 ]
* Updated the bundled AWS CLI to version 2.35.6. [ QSTOR-11827 ]

Network Interfaces
* Added DOCA OFED install script for jammy and upcoming noble platforms as an optional install for latest hardware. [ QSTOR-11069 ]
* Fixed the Network Interface Rename feature on systems upgraded from older releases where the 'ip' command resides in a different path. [ QSTOR-11614 ]
* Fixed: converting a local VIF to an HA VIF now preserves the original local interface if the conversion fails, so client connectivity isn't lost. [ QSTOR-11706 ]

Network Shares
* Add the ability to specify per user or group permissions on Network Shares during create or modify [ QSTOR-10662 ]
* Fixed: intermittent 'NFS server not responding' stalls under load by raising the nfsd listen backlog from 64 to 4096. [ QSTOR-10872 ]
* Fixed: NFS client entries can now be added or removed on a share while a long-running replication or snapshot task is using it, instead of queuing. [ QSTOR-11571 ]
* Consolidated the Network Share create/modify dialog's Permission Settings into the File Masks tab — now a single 'File Masks & Permission Settings' tab containing Owner Permission Settings plus the Directory and File Create Permissions Masks. [ QSTOR-11625 ]
* Reduced excessive event logging (event spam) for network shares and related grid objects. [ QSTOR-11695 ]
* Fixed handling of CIFS share options so empty/null option values are no longer written to the Samba configuration. [ QSTOR-11731 ]
* Fixed an issue where an Active Directory group added to a share's permissions was not preserved, and excluded built-in/default AD groups from the group picker. [ QSTOR-11767 ]

Remote Replication, Snapshots and Backup Policies
* Copy source Network Share settings to the destination share after replication. [ QSTOR-5738 ]
* Add support for rollback of Storage Volumes and Network Shares for a replication schedule [ QSTOR-6227 ]
* Minor updates to the auto snapshot cleanup tasks for replication schedules. [ QSTOR-11622 ]
* Fix auto create of replication association after failover [ QSTOR-11700 ]
* Snapshot schedule now shows the state detail when schedule is disabled by user. [ QSTOR-11717 ]
* The Snapshot Schedule properties page now displays Retention Tags. [ QSTOR-11719 ]
* Changed: Auto-tier backup policies now display as 'Auto-Tier >> Outbound' instead of 'Move >> Outbound'. [ QSTOR-11764 ]
* Fixed the CLI replication-schedule rollback so volume and share names are accepted (not just IDs), and rolling back only volumes (or only shares) no longer also rolls back the other type. [ QSTOR-11814 ]

SCSI / NVMe Target
* Added: a 'Select Initiator...' picker in the Add Host dialog to choose a discovered FC remote initiator WWPN instead of typing it. [ QSTOR-10741 ]
* Renamed the sys-list 'Firmware Version' column to 'SCSI Target Version' and corrected the value to show the actual SCST target-driver version (e.g. scst-3.10.0.qs01-...) instead of the literal 'scst-SCST'. [ QSTOR-11854 ]

Security
* Added support for Okta multi-factor authentication. [ QSTOR-9399 ]
* Added Multi-Admin Approval support, allowing deletion of pools, buckets, shares, and volumes to require approval from a configurable number of administrators. [ QSTOR-11344 ]
* Fixed certificate update failures when using a certificate template, and ensured dependent services (such as HAProxy and RGW) are restarted after a certificate replacement. [ QSTOR-11678 ]
* Fixed an issue in the Security Manager dialog where it was showing the "password policy change" warning confirmation when no fields were changed. [ QSTOR-11708 ]
* InfluxDB (port 8086) now requires authentication and binds to localhost by default; remote access is opt-in via the tf_influxdb_remote_access.enable touchfile (authentication still enforced). [ QSTOR-11759 ]
* Added the Ubuntu security apt repositories to the default package sources and removed unused bundled components flagged by scanning (Chronograf, the LXD/core20/snapd snaps, the docker-scan plugin), clearing CVE-2024-41110, CVE-2026-34177/-34178/-34179, CVE-2020-14343, CVE-2025-68121, and CVE-2024-45337. [ QSTOR-11760 ]
* Rebuilt the bundled QuantaStor Go tools (qs_iofence, qs_pool_export_helper, qs_diskinfo) and s5cmd with a current Go toolchain, clearing CVE-2025-68121, CVE-2024-45337, CVE-2024-24790, CVE-2023-24540, and CVE-2023-24538. [ QSTOR-11761 ]
* Hardened the internal QuantaStor script service (scriptsvc): removed a command-injection vector in request handling and now enforce the service's authorization check on every call. Addresses ZDI-CAN-30036 [ QSTOR-11799 ]
* Made a number of usability and reliability improvements to the multi-admin delete-approval workflow. [ QSTOR-11804 ]

Service Core
* Fix tag-set where custom key/value tags were not appearing for User objects. [ QSTOR-11528 ]
* Improved Ceph OSD daemon restart handling during upgrades and reduced database load on large-scale clusters. [ QSTOR-11675 ]
* Fixed an issue with QuantaStor management service memory usage when a grid node was offline. [ QSTOR-11693 ]
* Improved crash handling and diagnostic tracing for coordinated tasks, during operations such as adding a Ceph RADOS Gateway across multiple nodes. [ QSTOR-11702 ]
* Improved logging and error checking for QuantaStor configuration database backups, including capturing error output when a backup fails. [ QSTOR-11742 ]
* Expanded diagnostic log collection to capture additional network routing details (ip route output and static-route configuration). [ QSTOR-11748 ]
* Fixed the Sessions view showing stale SMB/NFS client sessions that lingered after a reboot; the share session monitor now forces a full re-sync on its first poll after startup so sessions left over from before the reboot are cleared. [ QSTOR-11757 ]
* Fixed a self-sustaining grid event flood triggered when creating CephFS/CIFS network shares at scale: nodes no longer re-cache remote-origin (sync-applied) events, and CIFS options are diff-merged to secondaries, eliminating the event resync cascade. [ QSTOR-11785 ]
* qs-sendlogs now writes a qs_logs.runtime.info file recording the options and variables used during log collection, and reliably scrubs sensitive data from the collected database. [ QSTOR-11897 ]

Storage Pool Management
* Added automated ordered-disk-list pool creation for Seagate Corvault and WD Data24 systems, simplifying creation of fully redundant storage pools. [ QSTOR-11538 ]
* Fixed software-encrypted pool creation so a disk block-size mismatch is detected before disks are encrypted, avoiding leftover encryption mappings. [ QSTOR-11599 ]
* ZFS deduplication now uses the faster fast_dedup mode by default, improving sustained deduplication performance. [ QSTOR-11714 ]
* When a LUKS-encrypted disk member of a pool momentarily goes offline and the hot-spare swap-in completes, if the "bad" disk in question has in the meantime come back online, its iofence status, encryption status and its related properties in its respective disk object are cleared up, making the disk available for use again. [ QSTOR-11738 ]
* Resolved a boot-time race where the OS-level zfs-import-cache.service could import ZFS pools before qs_service started. QuantaStor now imports pools with cachefile=none, masks the zfs-import-cache and zfs-import-scan services on install and upgrade, and clears the stale global ZFS cache file at boot, ensuring QuantaStor remains the sole coordinator of pool imports. [ QSTOR-11752 ]
* Add the ability to create a Storage Pool checkpoint for scale-up pools [ QSTOR-11784 ]
* Added a support-only, touchfile-gated pool-export triage call-out (qs_pool_export_triage.sh) that gathers diagnostics when a share or volume is still open during a storage pool export. Off by default (enabled via the tf_pool_export_triage.enable touchfile). [ QSTOR-11807 ]
* Resolved issue preventing HA failover functionality using SED drives. [ QSTOR-11832 ]

Upgrade Manager and Installer
* Added retry logic with a timeout to the Ceph upgrade script's daemon restarts so transient restart failures no longer abort the upgrade. [ QSTOR-10598 ]
* Fixed focal-to-jammy distribution upgrades leaving the HA cluster service (pcsd/pacemaker) inoperative due to a missing ruby-webrick dependency on Ruby 3.0+. The upgrade now installs ruby-webrick so HA failover keeps working. [ QSTOR-11841 ]
* Fixed focal-to-jammy distribution upgrades that could abort and roll back when Ubuntu's unattended-upgrades/apt-daily held the apt lock or needrestart blocked on a prompt. QuantaStor now disables automatic apt upgrades and runs the distribution upgrade non-interactively. [ QSTOR-11874 ]
* Fixed a Noble (24.04) upgrade failure where qs-upgrade aborted because the dpkg package version string could not be parsed. QuantaStor now compares Debian package versions using dpkg's native version ordering. [ QSTOR-11881 ]

Web Manager
* Minor fix to the "Copy to Clipboard" for task descriptions [ QSTOR-9574 ]
* Added a method field and a sortable timestamp column to the web interface Audit Log Analyzer. [ QSTOR-11191 ]
* Updated web interface translations across the major supported languages. [ QSTOR-11585 ]
* Added a 'Create Share' option to the share template menu to quickly create a share applying all of a template's settings. [ QSTOR-11595 ]
* Fixed the web interface to display all configured Ceph MDS daemons instead of limiting the list to five. [ QSTOR-11615 ]
* Add auto select convenience buttons to the Storage Volume multi-delete dialog. [ QSTOR-11707 ]

== v6.7.6.001 (June 25th 2026) ==

=== [[QuantaStor 6.7.6 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.6 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.6 Upgrade Instructions | upgrading to QuantaStor v6.7.6]].

=== Release Notes ===

Storage Pool Management
* Fixed a service crash that could occur when creating a LUKS-encrypted storage pool on NVMe devices. [ QSTOR-11876 ]

== v6.7.5.013 (May 21st 2026) ==

=== [[QuantaStor 6.7.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.5 Upgrade Instructions | upgrading to QuantaStor v6.7.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert triggers for disks with SMART medium errors. [ QSTOR-11652 ]

Ceph Scale-out Block, Object and File
* Adds new qs-cephfsutil for transparent movement of files between data pools via server-side copy [ QSTOR-11543 ]

Kernel and Drivers
* Added RedHat Platform kernel 4.18.0-553.124.1.el8_10.x86_64 support via DKMS driver build [ QSTOR-11679 ]
* Updated SCST driver to 3.10.0.qs01.9273.1b48521 with a patch that allows for dkms builds/support on non-preferred 5.15.x kernels on jammy platforms. [ QSTOR-11672 ]

Remote Replication, Snapshots and Backup Policies
* Minor fix while loading snapshots in the UI. [ QSTOR-11624 ]

Service Core
* Fixes bug where partial upgraded node would be skip daemon restart phase at version check. [ QSTOR-11703 ]
* Fixed a rare race condition where adding a Ceph Object (RADOS) Gateway on a multi-node cluster could silently crash. [ QSTOR-11689 ]
* Added defensive exception handling and trace coverage around coordinated task execution. [ QSTOR-11689 ]

Storage Pool Management
* Fix allows for creation of TRIM maintenance schedules on pools with special vdevs. [ QSTOR-11663 ]

Web Manager
* Add graphs for replication task status details. [ QSTOR-11661 ]
* Make improvements in the replication reporting area. [ QSTOR-11661 ]

== v6.7.4.011 (April 30th 2026) ==

=== [[QuantaStor 6.7.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.4 Upgrade Instructions | upgrading to QuantaStor v6.7.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Eliminated daily Ceph monitor outage on coordinator nodes caused by the mon-db backup process; the backup now uses a RocksDB compaction flush and hot-copy so the monitor service remains running throughout, and backup activity is now logged to qs_service.log. [ QSTOR-11655 ]

Enclosures and Controllers
* Fixed issue regarding hwController/hwEnclosure double discovery caused by the presence of certain Dell HBA cards that are visible to both the storcli and perccli CLI tools. [ QSTOR-11372 ]

Network Interfaces
* Fixed an issue with the allowed portals for iscsi and nvme being updated on network ports or having the settings retained on HA VIFs. [ QSTOR-11659 ]

Remote Replication, Snapshots and Backup Policies
* Improvements in the replication reports. [ QSTOR-11644 ]

Service Core
* Updated task output for storage system modify to improve clarity [ QSTOR-11660 ]
* Coordinated Task (CCT) Reliability Improvements — Fixed an issue on large or heavily-loaded Ceph clusters where CCT broadcasts could silently hang until timeout. [ QSTOR-11648 ]

Upgrade Manager and Installer
* Updated kmod and libkmod2 packages for ubuntu jammy and focal platforms to disable algif_aead and address CVE-2026-31431 [ QSTOR-11670 ]

== v6.7.3.010 (April 17th 2026) ==

=== [[QuantaStor 6.7.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.3 Upgrade Instructions | upgrading to QuantaStor v6.7.3]].

=== Release Notes ===

High Availability Failover
* Fixed an issue where Site Clusters could not be deleted in cases where the site cluster was unhealthy. For example if the Network Interfaces or IP addresses on the interface change for the heartbeat rings. Or if the site cluster corosync/pacemaker service are stopped. [ QSTOR-11631 ]
* Fixed a corner case where Site cluster vifs could start on nodes outside of the site cluster. [ QSTOR-11630 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Volume _chkpnt Replications on N-Way A>B>C replications being incorrectly named. they B>C leg should have _chkpnt.1 as the target suffix for the replication. [ QSTOR-11477 ]

Service Core
* Added further optimizations for Grid sync on large configs with many QuantaStor service objects. [ QSTOR-11628 ]

Storage Pool Management
* Fixed: SED disk Locked status is now propogated using grid logic for disks once a disk is used for Hardware encryption. Previously this required an HA group to also be on the pool. [ QSTOR-11611 ]
Fixed a corner case where SED Device Capabilities was showing as No for multipath disks plugged in twice to the same controller. [ QSTOR-11611 ]

== v6.7.2.003 (April 13th 2026) ==

=== [[QuantaStor 6.7.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.2 Upgrade Instructions | upgrading to QuantaStor v6.7.2]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue where some Enclosure objects would appear showing \[CBLERR\] when that status was incorrect. [ QSTOR-11135 ]

Network Shares
* Added a qs_global_namespace.conf file for users to provide a specific IP address to be offered for Microsoft DFS with the preferred_ip=x.x.x.x [ QSTOR-11627 ]
* Updated Jammy platform nfs-kernel-server and related nfs-utils packages to include junction support needed for NFS Referrals. [ QSTOR-11626 ]

== v6.7.1.008 (April 10th 2026) ==

=== [[QuantaStor 6.7.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.1 Upgrade Instructions | upgrading to QuantaStor v6.7.1]].

=== Release Notes ===

Network Shares
* Fix an issue with snapshot cleanup by the replication schedule. [ QSTOR-11621 ]

Security
* Upgrade the Cisco Duo library to 2.2.0 [ QSTOR-11592 ]

Upgrade Manager and Installer
* Disable and mask openzfs util zfs-shares.service which caused unexpected Share service restarts. [ QSTOR-11619 ]
* Fixed an issue with qs-distupgrade from Focal to Jammy Platforms of systems that had been originally deployed with bionic and older platforms. [ QSTOR-11616 ]
* Ensured the 6.8.0-90-generic kernel is deployed during Focal to Jammy Platform distupgrades. [ QSTOR-11616 ]

== v6.7.0.184 (April 8th 2026) ==

=== [[QuantaStor 6.7.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.0 Upgrade Instructions | upgrading to QuantaStor v6.7.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Add a 'Skip log server ping pre-checks' checkbox to the Send Support Logs dialog. The server will skip ping checks during log upload when the checkbox is checked. [ QSTOR-11397 ]
* Fixed an issue with clearing parent interface status alerts in the Health Checker System report [ QSTOR-11058 ]
* Add ability to specify reason for log uploads [ QSTOR-10479 ]

Ceph Scale-out Block, Object and File
* Fixed a QuantaStor service crash for Ceph scale-out file storage share snapshot delete [ QSTOR-11570 ]
* Adds support for new load balancer modes and customization in the /opt/osnexus/quantastor/conf/qs_loadbalancer.conf file. [ QSTOR-11502 ]
* Improved the method of tracking degraded object cleanup and reporting progress to the task objects. [ QSTOR-11292 ]
* Bug fixes in qs-s3util script when an invalid endpoint URL is provided. [ QSTOR-11292 ]
* Improved object state reporting for OSDs. [ QSTOR-11292 ]
* Fixed an issue with unlocking NVMe SED media on boot for Ceph Scale-out Cluster OSDs [ QSTOR-11118 ]
* Enabled Ceph OSD block and journal discard support [ QSTOR-10672 ]

Dashboards and Analytics
* Fixed an issue with influxdb install for qs\_upgrade\_redhat8.sh [ QSTOR-11562 ]

Disk Management
* Added logic to make SED Locking status consistent between QuantaStor Scale-Up ZFS HA Storage Pools. Note: Pools must have an HA group and HA Vif and be activated. [ QSTOR-11515 ]
* Added error counters for disks with available columns in the center grid view of the Physical Disks section. [ QSTOR-11308 ]

Enclosures and Controllers
* Added Enclosure layout support for Supermicro SSG-542B-DE1CR90 [ QSTOR-11572 ]
* This feature allows servers equipped with the Xinnor XiRAID software [ QSTOR-11374 ]

* Create a XiRAID raid unit, which appears as a QS HwUnit. [ QSTOR-11374 ]
* This HwUnit entity is surfaced in Quantastor as a physical disk drive. [ QSTOR-11374 ]
* The physical disks that are used to create the XiRaid unit are surfaced as HwDisks.[ QSTOR-11374 ]
* The creation includes a variable number of partitions on said physical disk.[ QSTOR-11374 ]
* These partitions are also surfaced as QS physical disks.[ QSTOR-11374 ]
* These partition-based physical disks can be used to create Ceph OSD objects. [ QSTOR-11374 ]
* Updated Storcli64 version to 007.3603.0000.0000 [ QSTOR-10911 ]

High Availability Failover
* Fixed an issue with FC ALUA path status when HA groups are disabled and HA VIFs are not present. [ QSTOR-11598 ]

Kernel and Drivers
* Updated kernel 6.8.0-90-generic drivers include intel ixgbe driver version 6.3.4 [ QSTOR-11524 ]
* Updated Jammy Platform installer ISO image to 22.04.5 [ QSTOR-11380 ]
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]

Multitenancy
* Changed Object User Create dialog text to more accurately reflect that it refers to Object Users/Tenants, and not Multitenancy objects [ QSTOR-9803 ]

Network Interfaces
* Fixed an issue where MTU values were being written to the VLAN interface configuration files. [ QSTOR-11552 ]

Network Shares
* Added further checks to Network Share Delete to verify the underlying ZFS filesystem properties has a matching OSNEXUS QuantaStor share ID before removing. [ QSTOR-11525 ]
* Auto populate the AD dialog with Organization Unit of specified on other systems in the grid [ QSTOR-11519 ]
* Add more options to filter shares in the delete dialog [ QSTOR-11499 ]

Remote Replication, Snapshots and Backup Policies
* Adds a new '--snapshots-with-holds-only' option to qs share-list and volume-list to list snapshots with holds on them. [ QSTOR-11388 ]

SNMP
* Update SNMP MIB [ QSTOR-11602 ]

Security
* When updating a certificate via cert-update, the relevant service (e.g. HAProxy) is now
automatically restarted to pick up the new certificate. Additionally, cert-update and
cert-rescan now accept the storage system by name or UUID. [ QSTOR-11529 ]
* Updated WebUI to have System Use Notification dialog/message display before user login dialog. [ QSTOR-11174 ]

Service Core
* Strip any invalid XML characters from description fields causing WebUI to not load [ QSTOR-11566 ]
* Cleaned up some repetitive log spam from the Blink Manager and the storcli hardware adappter [ QSTOR-11551 ]
* Fixed event spam and potential crash during Ceph daemon upgrade on large grids. [ QSTOR-11510 ]
* Fixes bug in site cluster maintenance mode logic. [ QSTOR-11489 ]
* Fixed an issue where the iSCSI/NVMe flag settings were not being retained for site cluster vifs after moving the vif to a new node. [ QSTOR-11464 ]
* Added support for LACP layer2+3 xmit\_hash\_policy [ QSTOR-11400 ]

Storage Pool Management
* Add more storage system tuning parameters [ QSTOR-11549 ]
* Added discard to LUKS options for NVMe model disks on ZFS Scale-Up Storage Pools with encryption. [ QSTOR-11501 ]

Upgrade Manager and Installer
* Fixed a throw in the qstorservice package install if the radosgw-admin command is not available [ QSTOR-11579 ]
* Fixed the qs-upgrade for kernel upgrades to ensure recommended packages for qstortarget are installed if they were previously manually removed. [ QSTOR-11556 ]

Web Manager
* When selecting Create Share from an existing selected share in the tree view, ensure the correct Storage Pool is selected in the Create Share dialog. [ QSTOR-11591 ]
* Create a new share template system for users to reuse settings from existing network shares. [ QSTOR-11314 ]

== v6.6.11.017 (March 5th 2026) ==

=== [[QuantaStor 6.6.11 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.11 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.11 Upgrade Instructions | upgrading to QuantaStor v6.6.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added a check to alert on SSL certificate expiration for the certificate manager managed certs. [ QSTOR-11462 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with rekeying scale-out ceph OSD's on Seagate Corvault backend external storage systems [ QSTOR-11206 ]

Disk Management
* Fixed an issue with SED media when adding as a hot-spare / for repair of a failed storage pool disk. [ QSTOR-11531 ]
* Fixed an issue where SSD Life Left status showing on multipath devices. [ QSTOR-11463 ]

Enclosures and Controllers
* Added Enclosure support from multiple Manufacturers such as Seagate, Gigabyte, Supermicro etc. [ QSTOR-11498 ]
* Fixed items related to the Intel 2u12 enclosure layout [ QSTOR-11286 ]
* Fixed Items related to the Supermicro 90-bay enclosure layout [ QSTOR-10932 ]

Network Shares
* Fix to allow creation of Network Shares with record size greater than 1M (1M, 2M, 4M, 8M). [ QSTOR-11535 ]

Security
* Fixed a few items related to Grafana default security ports [ QSTOR-11526 ]
* Fix configuration file manager file paths for telegraf.qstor and influxdb.qstor. [ QSTOR-11526 ]
* Fixed some items related to software encrypted HA storage pools management of /etc/crypttab [ QSTOR-11416 ]

Service Core
* Fixed some items related to QuantaStor Management Service database transactions [ QSTOR-11527 ]

== v6.6.10.006 (February 23rd 2026) ==

=== [[QuantaStor 6.6.10 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.10 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.10 Upgrade Instructions | upgrading to QuantaStor v6.6.10]].

=== Release Notes ===

Network Shares
* Fixed a service crash with Network share global Namespaces [ QSTOR-11518 ]
* Fixed an issue with AD join. [ QSTOR-11514 ]
* Fixed an issue with Seagate Corvault vpd83 parsing [ QSTOR-11518 ]

== v6.6.9.002 (February 13th 2026) ==

=== [[QuantaStor 6.6.9 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.9 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.9 Upgrade Instructions | upgrading to QuantaStor v6.6.9]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash when upgrading QuantaStor on Systems configured with Scale-Out storage. [ QSTOR-11509 ]

== v6.6.8.004 (February 11th 2026) ==

=== [[QuantaStor 6.6.8 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.8 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.8 Upgrade Instructions | upgrading to QuantaStor v6.6.8]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash for Network Interface discover logic [ QSTOR-11507 ]
* Fixed a service crash in Scale-out bucket discovery logic. [ QSTOR-11505 ]

== v6.6.7.017 (February 9th 2026) ==

=== [[QuantaStor 6.6.7 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.7 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.7 Upgrade Instructions | upgrading to QuantaStor v6.6.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Optimized grid communication paths and reduced database read frequency by improving internal object caching mechanisms. [ QSTOR-11473 ]
* Show compression ratio in the Scale-out Storage Pool grid. It is hidden by default. [ QSTOR-11130 ]

Disk Management
* Fixed an issue where a NVMe quick secure erase would be executed when formatting disks used for new storage pool creation [ QSTOR-11478 ]
* Fixed an issue where quick secure erase reformated the NVMe disk with a new namespace using a 512K sector size. [ QSTOR-11478 ]

Enclosures and Controllers
* Recertify Quantastor with the gen4 series of Western Digital Data24 [ QSTOR-11479 ]
* Fix up the config file defaults for NVMe software adapter when logging into a NVMe WD Data24. [ QSTOR-11470 ]

Network Shares
* Fix an issue with password shown in the service log during AD join [ QSTOR-11483 ]
* Add the ability to select multiple shares using the ctrl key in the share multi-delete dialog [ QSTOR-9181 ]

Web Manager
* Fixed a minor issue with file masks in modify Network Share [ QSTOR-11495 ]

== v6.6.5.026 (January 16th 2026) ==

=== [[QuantaStor 6.6.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.5 Upgrade Instructions | upgrading to QuantaStor v6.6.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Adds alerts in the event a Corvault device is in a warning or missing state. [ QSTOR-11411 ]

Ceph Scale-out Block, Object and File
* Fix an issue with creation of S3 user on a secondary zone. User will be created on the master zone. [ QSTOR-11438 ]
* Fixed an Issue with the Ceph initial PG calculations when creating ceph storage pools on HDD and SSD based OSDs. [ QSTOR-11437 ]
* Fix a minor issue with bucket sync when bucket originates on a secondary zone [ QSTOR-11435 ]
* Add granular options for object bucket rescan. [ QSTOR-11312 ]

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11436 ]
* Fix a row selection issue in the central pane on the External Media and Port grids. Show the 'Used By' column for External Volumes. [ QSTOR-11384 ]

High Availability Failover
* Fixed an issue with the Storage Pool Health check on systems with high load. [ QSTOR-11454 ]
* Fixed an issue with HA storage Pools in a degraded warnign state. [ QSTOR-11451 ]
* Reduced scale-out Object logging for site cluster vifs to debug level. [ QSTOR-11448 ]

Network Shares
* Fixed an issue with joining AD domains using SSSD+Winbind [ QSTOR-7845 ]

SNMP
* Updated SNMP MIB [ QSTOR-11456 ]

Security
* Enabled HTTPS redirect mode in QuantaStor WebUI by default during new Installs and upgrades to version 6.6.5 and newer. [ QSTOR-11368 ]
* Added a custom script callout via a security-message-update for the Security manager System Usage Notification contents: [ QSTOR-11222 ]
[https://wiki.osnexus.com/index.php?title=QuantaStor\_Custom\_Scripting\_/\_Application\_Extensions\#/var/opt/osnexus/custom/security-message-update.sh](https://wiki.osnexus.com/index.php?title=QuantaStor_Custom_Scripting_/_Application_Extensions#/var/opt/osnexus/custom/security-message-update.sh)

Service Core
* Added minimum timeout value to Coordinated tasks [ QSTOR-11455 ]
* Optimized Grid logic for Scale-out Object Bucket discovery on deployments with a large amount of ceph buckets. [ QSTOR-11433 ]
* Fixed an issue with License Key activation verification [ QSTOR-11110 ]

== v6.6.4.001 (December 17th 2025) ==

=== [[QuantaStor 6.6.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.4 Upgrade Instructions | upgrading to QuantaStor v6.6.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fix an issue where the S3 Object User Create fails when the User is not a Tenant member. [ QSTOR-11432 ]

== v6.6.3.033 (December 16th 2025) ==

=== [[QuantaStor 6.6.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.3 Upgrade Instructions | upgrading to QuantaStor v6.6.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Raise alerts when OSDs are down. [ QSTOR-11415 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with object user create under a tenant with multi-site is enabled for two zones. [ QSTOR-11427 ]
* Fix an issue with bucket sync policy create on the secondary zone bucket. [ QSTOR-11426 ]
* Allow selection of any object gateway when setting up ceph multi-site configuration. [ QSTOR-11409 ]

Enclosures and Controllers
* Adds enclosure management support for Supermicro Server SSG-522B-ACR12L [ QSTOR-11422 ]
* Change external volumes, media and volume grids from grouping to non-grouping for a minor performance improvement. Re-order Corvault columns in central grid (External Systems). Only show volumes for the currently selected Corvault. [ QSTOR-11370 ]

High Availability Failover
* Added a check to the site cluster to ensure that a user cannot set the final active node in a site cluster into standby. This is to prevent all nodes in a site cluster or HA pair from both being in standby and not serving any resources. [ QSTOR-11402 ]

Network Interfaces
* Fixed an issue where modifying the iscsi/nvme portal port settings on a VLAN or VIF interface would cause the parent interface to be restarted [ QSTOR-11406 ]
* Fixed an issue with importing LACP options in the /etc/network/interfaces file. [ QSTOR-11396 ]
* Updated the LACP bond-xmit-hash-policy options to use the modern text option names instead of the legacy numerical values. [ QSTOR-11396 ]

Network Shares
* Added 'qs-util nfsrdma' command to enable nfs rdma support for systems that have NFS RDMA supported hardware and drivers. [ QSTOR-11309 ]
* Auto detect when the AD server goes down and raise an alert. [ QSTOR-11182 ]
* Fixed issues with SSSD AD Join [ QSTOR-11335 ]

SNMP
* Updated SNMP MIB [ QSTOR-11428 ]
* Fixed a few items related to the SNMP agent stability. [ QSTOR-11405 ]
* Added logic to ensure new nodes joined to the grid get the snmp agent deployed on them with the same settings and snmp user. [ QSTOR-11393 ]

Security
* Removed default nginx index.html and version reporting from nginx. [ QSTOR-11351 ]

Service Core
* Extended timeout values for coordinated task finishing stage throughout the service. This will help prevent grid communication errors that are caused in high latency environments. [ QSTOR-11421 ]
* Enhanced grid logic for High Latency multi-site deployments. [ QSTOR-11391 ]

Upgrade Manager and Installer
* Added protections to ensure zfs pools are not imported incorrectly on a passive HA node during upgrade processes that update the grub configuration. [ QSTOR-11413 ]

Web Manager
* Add a tooltip to the Force checkbox on the Storage System Restart and Shutdown dialogs to clarify it's for immediate, unclean shutdowns. [ QSTOR-11381 ]

== v6.6.2.003 (November 14th 2025) ==

=== [[QuantaStor 6.6.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.2 Upgrade Instructions | upgrading to QuantaStor v6.6.2]].

=== Release Notes ===

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11367 ]

Security
* Updated QuantaStor Tomcat version to 9.0.112 [ QSTOR-11376 ]
* Fix a regression in single sign on failing to login AD users. [ QSTOR-11375 ]
* Enhanced Grid communication event batching that can help with large numbers of QuantaStor Grid object counts. [ QSTOR-11366 ]

== v6.6.1.013 (November 7th 2025) ==

=== [[QuantaStor 6.6.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.1 Upgrade Instructions | upgrading to QuantaStor v6.6.1]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Removed rgw gc optimizations that are no longer needed for modern ceph versions. [ QSTOR-10920 ]

Enclosures and Controllers
* Added some new warning icons for hardware controllers, hardware units and hardware disks. Fixed icon priority for status on hardware enclosures. [ QSTOR-11358 ]
* Fixed an issue with discovery of Hardware RAID Disks for LSI Hardware RAID controllers that use the storcli tool. [ QSTOR-11347 ]
* Fixed an issue with enclosure discovery for older LSI SAS HBA controllers that utilize sas3ircu [ QSTOR-11209 ]

High Availability Failover
* Fixed an issue with HA failover for storage pools that have multipath disks with -part1- in the device name. [ QSTOR-11373 ]

Security
* Fixed a possible SQL Injection during Login. [ QSTOR-11365 ]

Service Core
* Changes haproxy logrotate to be hourly by default. [ QSTOR-11349 ]
* Updated the QS PyClient Code in the github repo. [ QSTOR-11346 ]

== v6.6.0.362 (October 9th 2025) ==

=== [[QuantaStor 6.6.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.6.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.6.0 Upgrade Instructions| upgrading to QuantaStor v6.6.0]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Block rename of object pool group. [ QSTOR-11336 ]
* Add a fix so auto-tier rules can be set on multiple ceph clusters [ QSTOR-11323 ]
* Fixes bug with OSD replace prepare context menu button when called from the enclosure view. [ QSTOR-11313 ]
* Fixed: added duplicate zone check for Object Group Create [ QSTOR-11266 ]
* Add indication on the journal group if it is encrypted. [ QSTOR-11261 ]
* Updated Ceph version on Focal and Jammy platforms to 18.2.7 [ QSTOR-11129 ]
* Generate proper caps for keyring when using additional pools in CephFS [ QSTOR-11106 ]
* Display S3 user information in the delete user dialog to distinguish between S3 user and local user. [ QSTOR-10723 ]
* New feature adds the ability to modify RGW settings. Added the ability to add and remove load balancers on each Ceph cluster member. [ QSTOR-10623 ]
* Added support for Portal Groups for FC and iSCSI Targets [ QSTOR-10533 ]
* Add the ability to control synchronization for selected buckets in two objects storage clusters. [ QSTOR-10346 ]
* Add ability to specify multiple pools in a ceph file system. [ QSTOR-8674 ]

Dashboards and Analytics
* Add a new bucket dashboard that reports Average Total Objects and Average Utilized Space. [ QSTOR-11259 ]

Disk Management
* Adds an NVMe quick format to the Physical Disk Format dialog using the secure erase options. [ QSTOR-10688 ]

Enclosures and Controllers
* Fixed various items related to Linux Software RAID adapter support. [ QSTOR-11198 ]

Multitenancy
* Scope the access of user accounts so that they can only manage users, buckets, keys and other resources related to the tenant in the resource group they're a member of [ QSTOR-11326 ]
* Allow CephFS shares to be added to a Resource Group. [ QSTOR-11007 ]

Network Shares
* Share rename needs a force flag as it may disconnect NFS clients. [ QSTOR-11337 ]
* Provides an optional backported version of samba via a 'qs_samba_jammy_optional.sh' install script that includes a version of samba required to address the ad rfc2307 changes Microsoft introduced in KB5062572. Note this samba version does not include sssd support and so will not be installed by default. It should only be used for those customers using ad rfc2307 mode. [ QSTOR-11319 ]

Security
* Adds the ability to add and remove SSL certificate templates. Using those templates you can update the certificates for HaProxy and Rados gateways configured for HTTPS. [ QSTOR-9016 ]

Service Core
* Eliminates common errors in active directory join process, prepopulating dialog from previously joined systems [ QSTOR-11015 ]
* Added support for shutting down or restarting multiple systems at once [ QSTOR-10022 ]
* Added an optional force flag to Storage System Restart and Shutdown Dialogs to provide an option for immediate sysrq based shutdown of the system [ QSTOR-10022 ]

SNMP
* Updated SNMP MIB [ QSTOR-11343 ]

Storage Volumes
* Allow rename of Scale Out block storage volumes [ QSTOR-11311 ]
* Fix an event issue where the Volumes count was not getting updated in the central Host grid view. [ QSTOR-11038 ]

Universal Containers
* Add Universal Container support to the server and the Create Config dialog in the WUI. [ QSTOR-11194 ]

Upgrade Manager and Installer
* verified that packages are being installed properly with the new iso filtering stuff [ QSTOR-11030 ]

Web Manager
* Minor fix to the modify Network Port dialog. [ QSTOR-11302 ]
* Added the ability to save a local copy of a report schedule. [ QSTOR-11217 ]
* Simplifies active directory join and leave process, allowing multiple systems to join or leave at once [ QSTOR-8771 ]

== v6.5.12.005 (September 22nd 2025) ==

=== [[QuantaStor 6.5.12 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.12 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.12 Upgrade Instructions| upgrading to QuantaStor v6.5.12]].

=== Release Notes ===

Enclosures and Controllers
* Fixed vendor/model defaulting, improved enclosure layout auto-selection in the Modify Storage System dialog (including correct child-layout selection to choose the primary NVMe drive group), and resolved an invalid enclosureLayoutId that prevented layout auto-detection. [ QSTOR-11263 ]

Security
* Fixed: disable gzip compresson on web and api ports by default. [ QSTOR-11210 ]
* Fixed: internal qs-statsd/qs_restd service port 5173 moved to localhost only as it should not be presented as an external port. [ QSTOR-11210 ]
* Fixed: reduced syslog logging of qs-statsdb/qs_restd. [ QSTOR-11210 ]
* Added: DROP rules to block ICMP timechecks [ QSTOR-11210 ]
* Updated SSL Ciphers and TLS1.3 support for the web and API ports [ QSTOR-11210 ]
* Fixed: Set pcsd api port 2224 to bind to localhost only by default [ QSTOR-11210 ]

== v6.5.11.029 (August 28th 2025) ==

=== [[QuantaStor 6.5.11 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.11 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.11 Upgrade Instructions| upgrading to QuantaStor v6.5.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added support for SMTP servers that allow open relay with no username/password to the Alert Manager [ QSTOR-11167 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with multiple alerts occurring for long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Fixed some corner case issues with long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Added support for larger MDB devices upto 2100GB [ QSTOR-11274 ]
* Added support for encryption bypass on OSD create while still encrypting wal/db journal devices. [ QSTOR-11260 ]

Disk Management
* Fixed an issue with running the disk read performance test benchmark on very fast modern media. [ QSTOR-11296 ]

Enclosures and Controllers
* Fixed Enclosure and Controller discovery support for SAS3516 based SAS controllers [ QSTOR-11267 ]

High Availability Failover
* Fix an issue with VIF used for scale-out file usage after rebooting all nodes in the cluster. [ QSTOR-11265 ]

Network Interfaces
* Fixed: added gfortran-11 dependency to jammy repository required for LTS mellanox ofed install to succeed [ QSTOR-11285 ]
* Add QS cli command to hide disabled Network Ports [ QSTOR-10898 ]
* Fixed an issue where VLAN and VIF interfaces would not report their bond mode correctly if their parent interfaces was a bonded port. [ QSTOR-10754 ]

Network Shares
* Adds support for multiple HA VIF redirects and smart network filtering for NFSv4 referrals [ QSTOR-11278 ]
* Minor fix to skip NFS export commands for scale out shares. [ QSTOR-11275 ]

Quantastor CLI
* Provide a utility to create temporary log download links via qs-download-link [ QSTOR-11273 ]

SCSI / NVMe Target
* Fixed: Added logic to always default FC ports to target mode for supported FC target card models from QLogic. Ports can still be explicitly set to initiator mode if the user so chooses. [ QSTOR-10744 ]

Service Core
* Fixed: added the option to cancel the Physical Disk Identify task if the duration for the identify task is longer than the user wants. [ QSTOR-11258 ]
* Provide a download link for log collection in case logs cannot be uploaded from a Quantastor system [ QSTOR-11116 ]

Upgrade Manager and Installer
* Fixed: added proxy settings to the /etc/apt/apt.conf.d/80proxy file [ QSTOR-11281 ]
* Fixed: added logic to the upgrade manager and qs-upgrade command to check for missing version pinning if qs-util aptnopin has been run on the system. The upgrade task will fail early if correct pinning is not in place advising running qs-util aptpin. [ QSTOR-11277 ]

Web Manager
* Fixed: clarified text in create resource group for network share access of service containers [ QSTOR-11187 ]

== v6.5.10.013 (August 12th 2025) ==

=== [[QuantaStor 6.5.10 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.10 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.10 Upgrade Instructions| upgrading to QuantaStor v6.5.10]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the access key and secret key were not updating in the UI in instances with multiple object storage users across multiple ceph clusters in the same grid. [ QSTOR-11254 ]
* Fixed an issue with the cephfs mounts if communication is lost with the active MDS and a new MDS is elected. [ QSTOR-10738 ]

Enclosures and Controllers
* Fix an enclosure refresh issue via the event path where the underlying disk were not getting refreshed. [ QSTOR-11247 ]
* Fixed: Added additional checks for enclosure id on enclosures that fail to report correctly on older firmwares. [ QSTOR-11227 ]

Service Core
* Fixed: replaced size with maxsize in the ceph, radosgw and haproxy logrotate definitions so that they rotate as expected on their daily rotations as well as when reaching the max size definition. [ QSTOR-11253 ]
* Fix an underlying dashboard issue where new diskio entries were not properly added to the telegraf.conf file on new deployments. [ QSTOR-11246 ]
* Fix: Optimize the restarting of influx and telegraf. [ QSTOR-11246 ]

== v6.5.9.003 (August 5th 2025) ==

=== [[QuantaStor 6.5.9 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.9 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.9 Upgrade Instructions| upgrading to QuantaStor v6.5.9]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with slotmap updates when changing the slotmap in the enclosure and controllers section. [ QSTOR-11245 ]

Service Core
* Fixed an issue where QuantaStor was restarting the influxdb service when it was not needed. [ QSTOR-11244 ]
* Fixed: separated the influxdb, telegrafd and QuantaStor stats_db service restart logic to allow more granular control. [ QSTOR-11244 ]

== v6.5.8.008 (July 31st 2025) ==

=== [[QuantaStor 6.5.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.8 Upgrade Instructions| upgrading to QuantaStor v6.5.8]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed a small issue with the ceph osd reweight script progress trace. [ QSTOR-11234 ]

Enclosures and Controllers
* Add support for Supermicro ASG-2115S-NE332R system enclosure layouts [ QSTOR-11237 ]

Network Shares
* Fixed: Disable security features options in Network Share Create/Modify dialogs when the share is from a Scale-out File Pool. [ QSTOR-11235 ]
* Fixed: Remove redundant "NFS Security Mode" on the share advanced tab. [ QSTOR-11235 ]
* Fixed an issue with clearing the manage gids setting on Jammy platforms [ QSTOR-11225 ]
* Fixed an issue with setting specific nfs v3 or v4 server configurations on Focal platforms [ QSTOR-11225 ]
* Fixed a conflict with the nfs mountd ports between scale-out and scale-up nfs modes. [ QSTOR-11212 ]
* Fixed detection of nfs scale-out mode when it is configured at the time of ceph scale-out filesystem creation. [ QSTOR-11212 ]

Upgrade Manager and Installer
* Added a check to disable the grub os prober by default to prevent adding of any block devices with OS data other than the installed QuantaStor OS disk to the grub boot loader. [ QSTOR-11199 ]

== v6.5.7.004 (July 24th 2025) ==

=== [[QuantaStor 6.5.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.7 Upgrade Instructions| upgrading to QuantaStor v6.5.7]].

=== Release Notes ===

Network Shares
* Fixed an issue with network share cifs/smb settings such as ignore system acls introduced in the 6.5.1 release. [ QSTOR-11224 ]
* Removed the API underscore to space conversion logic in cifs/smb settings introduced in 6.5.1. REST API's should use proper url encoding like %20 when sending strings that contain spaces via curl or other http calls. [ QSTOR-11224 ]

Storage Pool Management
* Fixed a path naming issue for the sedutil-cli binaries used for SED disk encryption. [ QSTOR-11221 ]
* Added Several small enhancements and fixes for the sedutil-cli tool usage and SED supported disk discovery [ QSTOR-11219 ]

== v6.5.6.052 (July 16th 2025) ==

=== [[QuantaStor 6.5.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.6 Upgrade Instructions| upgrading to QuantaStor v6.5.6]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fix minor issue with Corvault log collection. [ QSTOR-11201 ]
* Added alerts to notify the user as they approach quota limits for S3C buckets [ QSTOR-11055 ]
* Fixed an issue with the IPMI Ip addresses showing up in the Health Check reports. [ QSTOR-10356 ]

Ceph Scale-out Block, Object and File
* Fixed radosgw logging logrotation not always occurring on fresh installs. [ QSTOR-11176 ]
* Fixed: radosgw logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Fixed: haproxy logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Improved logic for Ceph OSD Gentle Reweight. [ QSTOR-11163 ]
* Fixed an issue with the version check when upgrading the the scale-out ceph MDS, RGW and other daemons. [ QSTOR-11138 ]
* Fixed a few corner cases with ensuring successful Ceph upgrades. [ QSTOR-11138 ]
* Allow compression support for Ceph RBD pools. [ QSTOR-11131 ]
* Added Object User quota usage information to the Object User grid [ QSTOR-10722 ]

Dashboards and Analytics
* Add Pool, volume and share space usage trending dashboards (Early Access). [ QSTOR-11076 ]
* Add Pool, volume and share space usage trending dashboard routes and toggle buttons. [ QSTOR-11076 ]
* Expand the trending time scale for Tenants and Owners to make use of longer retention policies (e.g. 'Last 30 Days'). [ QSTOR-11076 ]
* Fix InfluxDB trending continuous query settings in qs\_statsdb.sh. [ QSTOR-11076 ]

Disk Management
* Add Multipath and HA support for SED Disks. [ QSTOR-11172 ]
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11065 ]

Enclosures and Controllers
* Fixes intermittent boot time OSD start issue with Corvault media. [ QSTOR-11195 ]
* Adds encryption bypass mode to avoid applying double (hardware plus software) encryption to Corvault media. [ QSTOR-11195 ]
* Added enclosure layout for Supermicro SYS-221H-TN24R systems. [ QSTOR-11154 ]

High Availability Failover
* Fixed an issue with Storage pool import of a previously exported pool that has iofencing on nvme disks. [ QSTOR-11173 ]

Network Shares
* Add new cyphers for active directory join. [ QSTOR-11183 ]
* Added sync flag by default to NFS mount for ceph object storage ganesha shares [ QSTOR-11181 ]
* Adjust minor Network Share quota alert levels. [ QSTOR-11171 ]
* Add larger record size upto 8M for Network Shares on ZFS Storage Pools. [ QSTOR-10118 ]
* Added support for hidden shares that end in a '$' as 'Browseable (admin-only) shares in the CIFS/SMB Options tab of the Network Share Create/Modify Dialogs. [ QSTOR-9222 ]

Service Core
* Optimize database reads for large clusters. [ QSTOR-11178 ]
* Added qs-util dbdiff for use to compare osn.db database versions [ QSTOR-10566 ]
* Added https as the default preferred method for support log bundle upload. [ QSTOR-9875 ]

Universal Containers
* Added initial support for a universal container system [ QSTOR-11162 ]

Upgrade Manager and Installer
* Added logic to fix the /boot/efi based on a efi partition label for Software RAID and EFI installs [ QSTOR-11140 ]

Web Manager
* Revise the Object User Access Key Manager to include Storage URLs in the Copy to Clipboard action. [ QSTOR-11177 ]
* Improved fieldset placements for network share create/modify dialogs. [ QSTOR-11156 ]
* SED Pool management - Reorder SED columns in PD grid. Move to the right of the "Correlated Device" column. Revise the SED capability detection to check for non-enterprise. [ QSTOR-11146 ]

== v6.5.5.039 (May 29th 2025) ==

=== [[QuantaStor 6.5.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.5 Upgrade Instructions| upgrading to QuantaStor v6.5.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixes bug in osd gentle reweight script that was bottlenecking performance. [ QSTOR-11123 ]
* Added logic to auto-clean up volume objects for non-QuantaStor managed ceph rbd's (rbd's created directly by the client using client rbd drivers/software). [ QSTOR-11112 ]
* Add warnings for the user if OSD or journal delete is being used on a device with duplicate PVs due to multi-pathing mapping. [ QSTOR-11099 ]
* Added 'qs-ceph' utility commands to modify compression options on Ceph pools. [ QSTOR-11096 ]
* Added compression ratio column in storage pools grid. [ QSTOR-11087 ]

Enclosures and Controllers
* Added support for discovery of RMSP3JD160J controllers. [ QSTOR-11107 ]
* Add validation for both primary and secondary IPs during External System Credentials Add. [ QSTOR-11009 ]

High Availability Failover
* Fixed a very rare corner case where a Manual HA failover task could generate unexpected errors due to a background periodic storage pool scan. [ QSTOR-11111 ]
* Added the option to set a Site Cluster Member Node as Manual Standby. [ QSTOR-11105 ]
* Fixed an issue where nodes could come out of standby status on a reboot too early before grid communication was established. [ QSTOR-11105 ]
* Enhanced HA Failover times for Storage Volumes for Fibre Channel clients. [ QSTOR-11105 ]
* Enhanced Fiber Channel High availability ALUA Changes to occur more quickly and to more quickly advertise failed paths to clients like VMware so that they can resume I/O to healthy available paths sooner. [ QSTOR-11105 ]
* Enhanced the logic used for High Availability Storage SCSI Target decoupling during a Storage Pool export. This can help greatly reduce the failover time for very Large configurations with thousands of volumes or volume snapshots. [ QSTOR-10969 ]

Network Interfaces
* Fixes bug that was blocking users from creating a static route with the same destination subnet across different systems. [ QSTOR-11125 ]
* Fixed a bug in static route validation logic and allow users to delete malformed static route entries. [ QSTOR-11115 ]

Network Shares
* Allow rename of nested shares [ QSTOR-11046 ]
* Added logic to help persist and manage NFS options for NFS version and nfs --manage-gids flags [ QSTOR-11001 ]

REST API
* Add an API to clear missing shares or volumes from the QS database. [ QSTOR-11117 ]

Remote Replication, Snapshots and Backup Policies
* Clarify concurrency options for backup policies. [ QSTOR-11004 ]

Security
* Added explicit modprobe disable and blacklist of ksmbd module to address any CVE-2025-37899 concerns. [ QSTOR-11134 ]

Service Core
* Enhanced the Core QuantaStor service management thread scaling. [ QSTOR-10767 ]
* Fixed a small memory leak with debug log tracing [ QSTOR-10689 ]

Storage Pool Management
* Updated sedutil-cli that supports a wider range of encrypted devices. [ QSTOR-11088 ]
* Restores sedutil / Storage Pool encryption support for SED Ruby NVMe devices. [ QSTOR-11088 ]
* Removed restriction to satisfy the VDEV count of N+1 to create a RAIDZx(RAID50/60/etc) array on a ZFS scale-up Storage pool when passing in a Set Disk Size instead of using the 'auto' option. [ QSTOR-11086 ]

== v6.5.4.016 (April 29th 2025) ==

=== [[QuantaStor 6.5.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.4 Upgrade Instructions| upgrading to QuantaStor v6.5.4]].

=== Release Notes ===

Dashboards and Analytics
* Fix issue where the dashboard of a newly created volume was not showing performance data after it had been assigned because of a pending Telegraf restart required. [ QSTOR-11077 ]
* Show CPU Temp and Power Usage in the System Dashboard (new Sensors button). [ QSTOR-11029 ]

High Availability Failover
* Unblocked creating HA ViF if there is an HA irrelavant bond in active-backup mode and unblocked modifying an HA irrelavant bond. [ QSTOR-11073 ]
* Fixed an issue when modifying non-name fields of an HA group. [ QSTOR-11071 ]

Network Interfaces
* Fixed bugs in validation logic for static route create and delete. [ QSTOR-11056 ]

Network Shares
* Ensure 'Browseable' is checked on SMB network shares when Browseable (Access Based) is checked. This ensures that authenticated clients who have pre-assigned browseable access can see the share offered by the QuantaStor but prevents non-authenticated users from seeing the share. [ QSTOR-11078 ]

Remote Replication, Snapshots and Backup Policies
* Minor log file cleanup after backup job is finished. [ QSTOR-11044 ]
* Add the ability to rollback a read-write Storage Volume or Network Share snapshot to it's underlying snapshot. [ QSTOR-9820 ]

Storage Pool Management
* Fixed an issue with Storage Pool auto-start on reboot for software encrypted storage pools. [ QSTOR-11081 ]

== v6.5.3.021 (April 9th 2025) ==

=== [[QuantaStor 6.5.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.3 Upgrade Instructions| upgrading to QuantaStor v6.5.3]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* Improved timeout handling for QuantaStor coordinated task system. [ QSTOR-11022 ]

Disk Management
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11032 ]

Enclosures and Controllers
* Added Hardware Enclosure support for Dell PowerEdge R7615 [ QSTOR-11043 ]
* Added Hardware Enclosure support for Supermicro AS-1115CS-TNR [ QSTOR-11043 ]
* Optimized performance and fixed issues when rendering systems with attached CORVAULT external systems. [ QSTOR-11039 ]
* Optimize the rendering of enclosures. Fix drawer rendering issue where extra slots were appearing. [ QSTOR-11014 ]

Network Interfaces
* Fixed an issue with static route netmask CIDR calculations. [ QSTOR-11048 ]

Network Shares
* Update Network Share Namespace on all nodes to reflect any modification to NFS access entries to share that is part of a Namespace. [ QSTOR-11042 ]
* Online newly promoted Network Share Snapshots. [ QSTOR-11021 ]
* Add post share create and modify script callouts. [ QSTOR-11016 ]
* Fixed mount paths for enabled snapshots of Network Share when Share is renamed. [ QSTOR-11012 ]
* Add the ability to prioritize NFS access rules in /etc/exports file. [ QSTOR-10552 ]

SNMP
* Regen SNMP for 6.5.3 [ QSTOR-11054 ]

Security
* Added docker http proxy override [ QSTOR-11040 ]
* Updated Tomcat version to 9.0.102.0 [ QSTOR-11013 ]

Upgrade Manager and Installer
* Fixed various issues with the OVA vApp properties being set after VM image cloning. Added additional properties to the OVA by default. [ QSTOR-10508 ]

== v6.5.2.070 (March 27th 2025) ==

=== [[QuantaStor 6.5.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.2 Upgrade Instructions| upgrading to QuantaStor v6.5.2]].
=== Release Notes ===

Alerts and Configuration Analysis
* Added SED version of Micron 7300 drives to firmware check for Config Analyzer [ QSTOR-10933 ]

Ceph Scale-out Block, Object and File
* Update AWS cli. [ QSTOR-10956 ]
* Extend Resource Groups to support adding S3 Tenant resource type. [ QSTOR-10808 ]
* Extended timeouts for logical volume allocation commands when creating Ceph OSDs. [ QSTOR-10930 ]
* Added more permissive check when running Ceph OSD replace prepare operation. (CLI only) [ QSTOR-10914 ]
* Add a qs-ceph command to allow switching between fuse and kernel mount for cephFS to allow user comparison of fuse versus the faster kernel option. [ QSTOR-10905 ]
* Adds additional Ceph coordinator election mode that maps to the site-cluster. [ QSTOR-10795 ]

Dashboards and Analytics
* Added Jammy platform support for the ceph prometheus install script [ QSTOR-10949 ]

Enclosures and Controllers
* Strip whitespace characters from primary and secondary IPs during External System Credentials Add. [ QSTOR-10896 ]
* Add validation for External System Credentials during creation. [ QSTOR-10826 ]

High Availability Failover
* Fixed a bug with creation grid master (gm) Site Cluster vifs. [ QSTOR-10996 ]
* Implemented new naming schema for underlying Site Cluster HA Groups. [ QSTOR-10904 ]

Network Interfaces
* Fixed an issue with deleting bonded interfaces leaving slave interfaces tagged as slaves. [ QSTOR-10931 ]
* Updates for mellanox ofed lossless networking support to work better with newer model cards. [ QSTOR-10779 ]

Network Shares
* Fixes bug where having 'gmt' or 'GMT' in the name of a network share would cause issues with NFS protocol. [ QSTOR-10982 ]
* Fix the mount paths for read-write GMT snapshots. [ QSTOR-10938 ]
* Add mountaddr to the view mount instructions for Network Share. [ QSTOR-10923 ]
* Add crossmnt option in the NFS exports for newly created shares. Also skip adding the default export for .zfs directory. [ QSTOR-10806 ]
* Add the ability to clone a GMT snapshot and promote it.
Add QS CLI to copy share permissions. [ QSTOR-10580 ]

REST API
* Handle empty lists from the curl calls to Quantastor APIs. [ QSTOR-10939 ]

Remote Replication, Snapshots and Backup Policies
* Fixed up dead links which were created after running some types of auto-tier Backup Policies. [ QSTOR-10934 ]

SNMP
* Update SNMP MIB [ QSTOR-11019 ]

Security
* Prevent MFA passcodes with leading 0 from being truncated. [ QSTOR-10852 ]

Service Core
* Fixes an issue where role-creation would fail due to deprecated permission-definitions. [ QSTOR-10988 ]

Storage Pool Management
* Added support for the creation of mirror sets consisting of "quad-mirrors" (4-way mirror sets) for both the data device groups in the pool and also the "special" devices, such as "dedup" and "metadata offload" devices. [ QSTOR-10893 ]

Storage Volumes
* Add more detail for logical and physical space utilization for volumes. [ QSTOR-10981 ]

Upgrade Manager and Installer
* Deprecates legacy package version pinning for the packages.osnexus.com mirror server that was causing issues with some ceph cluster upgrades [ QSTOR-10990 ]
* Added protections in qs\_distupgrade.sh for lvm snapshots that could cause issues with the platform upgrade. [ QSTOR-10970 ]
* Resolved multiple items that were causing issues with installing QuantaStor on redhat based platforms when STIG enforcement policies were present. [ QSTOR-10958 ]
Note: the qs_upgrade_redhat8.sh install/upgrade script temporarily sets selinux to permissive mode and temporarily disables fapolicyd if it is enabled when the script is running and restores them to their original state when the script completes.

Web Manager
* Auto select S3 tenant for S3 User when user create is invoked from context menu on the S3 tenant. [ QSTOR-11010 ]
* Increase the width of grids to show the 'Correlated Device' column in the Add Log/Cache/Metadata Device to Pool dialog w/o the need for scrolling. [ QSTOR-10951 ]
* Add an option to upload logs with no truncation. [ QSTOR-10925 ]
* Add drawer support for the Corvault enclosure layout and rendering engine in the WUI. [ QSTOR-10796 ]

== v6.5.1.058 (February 12th 2025) ==

=== [[QuantaStor 6.5.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.1 Upgrade Instructions| upgrading to QuantaStor v6.5.1]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* General improvements to OSD drive replacement process. Added additional LVM clean up logic. Fixed issues with device correlation for multipath devices and encrypted drives. [ QSTOR-10915 ]
* Allow deleting journals from the UI via Ceph journal delete dialog [ QSTOR-10890 ]

Dashboards and Analytics
* Add gridPreferredPort check to the WUI dashboard service (qsrestd) if set on a Storage System. [ QSTOR-10866 ]

Disk Management
* Fixed: New systems and clean QuantaStor service configurations databases will initialize Multipath autoconfig support as enabled by default. [ QSTOR-10900 ]
* Increased timeouts and other optimizations for large multipath configurations. [ QSTOR-10881 ]
* Added protections to prevent QuantaStor service from running multiple blkid instances if one is already running. [ QSTOR-10881 ]
* Unblocked adding disk as a scale-up pool spare with a larger block size. [ QSTOR-10876 ]

Enclosures and Controllers
* Add Enclosure mapping support for HPE ProLiant DL325 Gen10. [ QSTOR-10899 ]
* Fixed an issue with Hardware Disk Identify for Storage Pool Physical Disks where the controller was not properly selected in the dialog. [ QSTOR-10858 ]
* Fixed an issue with applying External System Profile A+B. [ QSTOR-10840 ]

High Availability Failover
* Fixed an issue with automatically starting HA scale-up ZFS pools if both HA nodes are booted at the same time. [ QSTOR-10902 ]
* Added a a check to ensure the luks crypttab was upto date after encrypted ha pool failover. [ QSTOR-10901 ]
* Added VLAN interfaces to allowed interfaces for Site Cluster heartbeat rings. [ QSTOR-10871 ]
* Added better logic for smb/nfs service management for Scale-up HA configurations with shares on multiple storage pools in the same HA cluster. [ QSTOR-10762 ]
* Fixed an issue with Resource Group Service configs starting on a node after the node had previously hosted the service. [ QSTOR-10762 ]
* Fixed: added a unique name check for HA group create/modify. [ QSTOR-10311 ]

NAS Gateway / Cloud Containers
* Change Seagate Lyve Cloud endpoints [ QSTOR-10868 ]

Network Interfaces
* Fixed an issue with calling iptables commands when distupgrading from older distributions. [ QSTOR-10860 ]

Network Shares
* Minor fix to allow creation of GMT snapshots for volumes from the Web UI. [ QSTOR-10873 ]
* Fixed an issue with spaces in the curl command issued to Quantastor. [ QSTOR-10838 ]
* Fix issue where renaming a share that contained a nested share failed. [ QSTOR-10811 ]
* Allow setting Samba share as read-only using ZFS. The new support has been added to the Network Share create and modify dialogs on the Advanced settings tab. [ QSTOR-10755 ]
* Fixed an issue which created duplicate mounts for nested shares. [ QSTOR-10704 ]
* Exposed ZFS 'Case Sensitivity' option at share creation time. [ QSTOR-8869 ]

REST API
* Fixed the POST command in the REST API [ QSTOR-10844 ]

Remote Replication, Snapshots and Backup Policies
* Fix an issue with auto tiering in backup policies. [ QSTOR-10845 ]
* Refined the Backup Policy Create and Modify dialogs. [ QSTOR-10843 ]
* Fixed an issue with Backup Policy tasks completing when the underlying file copy or move process process had returned. [ QSTOR-10839 ]
* Add alerting when replication fails. [ QSTOR-10799 ]

SNMP
* Updated SNMP MIB [ QSTOR-10922 ]

Service Core
* Fixed an issue that could sometimes cause performing a reboot or shutdown of the storage system via the QuantaStor UI to fail. [ QSTOR-10917 ]
* Fix an issue with database backups on the storage pools. [ QSTOR-10907 ]
* Fixed an issue with creating encrypted pools when an underlying disk is read-only. [ QSTOR-10886 ]
* Fixed a disk discovery issue when discoverying a large number of disks. [ QSTOR-10875 ]
* Fixed QuantaStor service builds for Redhat based distros. [ QSTOR-10846 ]
* Added /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable touchfile to bypess the icmp ping check and allow sending logs from the UI/qs cli. [ QSTOR-10556 ]

Storage Pool Management
* Fix an issue with pick a smaller hotspare disk getting picked for metadata offload if disk goes missing. [ QSTOR-10877 ]
* Add storage capacity properties for metadata offload VDEV [ QSTOR-10661 ]

Upgrade Manager and Installer
* Added a blacklist of the bnxt\_re driver to prevent issues for normal network operations for the bnxt_en driver loading on network controllers that have rdma support enabled in their firmware by default. [ QSTOR-10918 ]
* Added elbencho benchmarking tool to quantastor utilities. [ QSTOR-10892 ]
* Added support for Focal 20.04 to Jammy 22.04 Platform upgrades via qs-distupgrade [ QSTOR-10547 ]
* Fix telegraf start failures at startup due to invalid config file errors. [ QSTOR-10353 ]

Web Manager
* Fixed a minor truncation issue with trigger Backup Policy dialog [ QSTOR-10919 ]
* Add a Description column to the share and snapshot grid and default to hidden. [ QSTOR-10882 ]
* Minor fix to NTP server add dialog to prevent empty entries in the dialog. [ QSTOR-10870 ]
* Auto select first row in NTP and DNS settings dialogs. [ QSTOR-10867 ]
* Improve the host assign volume dialog. [ QSTOR-10862 ]

== v6.5.0.246 (January 9th 2025) ==

=== [[QuantaStor 6.5.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.0 Upgrade Instructions| upgrading to QuantaStor v6.5.0]].
=== Release Notes ===

Alerts and Configuration Analysis
* Increased HA health checks on Systems with local HA Pools. [ QSTOR-10746 ]
* Fixed: sending logs from specific grid nodes will now send logs only from the selected nodes. [ QSTOR-10694 ]

Ceph Scale-out Block, Object and File
* Fixes issue with access permissions for ceph client admin keyring file. [ QSTOR-10818 ]
* Fixed issues related to encrypted OSD replace operations. [ QSTOR-10786 ]
* Fixed an issue with wal journal device discovery and association with osds. [ QSTOR-10751 ]
* Deprecated replica=2 as a creation option from Ceph Scale-out storage. Replica=2 did not provide enough redundancy for consistent normal storage operations in the event of an osd or storage system outage. [ QSTOR-10748 ]
* Added the force flag checkbox to the Create S3 Storage Class dialog. [ QSTOR-10734 ]
* Fixed bugs in Ceph upgrade stage completion and failure alerting. [ QSTOR-10730 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10717 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10716 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10708 ]
* Improve ceph discovery. [ QSTOR-10675 ]
* Add metadata pool utilization for Ceph Object Pool Group and Ceph File System [ QSTOR-10650 ]
* Disabled OSD auto restart. auto restart can be activated using the touchfile '/var/opt/osnexus/quantastor/touchfiles/tf\_ceph\_osd\_auto\_start.enable' [ QSTOR-10632 ]
* Ensure the Tenant and User grid's bucket count column is updated after the delete bucket operation via events. [ QSTOR-10610 ]
* Fixed a bug with Ceph OSD 'Last Rekey Date' field not being updated properly. [ QSTOR-10509 ]
* Updated default Ceph version to Reef 18.2.4 for new Focal and Jammy platform deployments. [ QSTOR-10415 ]

Dashboards and Analytics
* Add a new Ceph Member selection combo to the Ceph Pool dashboard. [ QSTOR-10798 ]
* Add Tenant and Owner usage dashboards to the Bucket menu area. [ QSTOR-10698 ]
* Add CPU Temp and Power Usage to the Grid Dashboard's System Tiles. [ QSTOR-10427 ]
* Change the grid CPU metric to use system\_usage which matches the metric used in the System dashboard. The overlapping text issue is no longer an issue as Highcharts has been replaced with Chart.js. [ QSTOR-10263 ]
* Add power usage and average CPU temp sparklines to the System Tile dashboards in the grid view. [ QSTOR-10013 ]
* Removed resource column from Health Checker/Config Analyzer. [ QSTOR-5515 ]

Disk Management

* Removed the multipath autoconf touchfile support which fixes issues where disabling multipath autoconfig would not apply. [ QSTOR-10706 ]
Enclosures and Controllers
* Addes enclosure layour for Supermicro Server SYS-F629P3-RC1B FatTwin 4-Node 24+12 bay [ QSTOR-10853 ]
* Fixed an issue with disk discovery when a CORVAULT is attached. [ QSTOR-10664 ]
* Added the ability to blink empty slots on jbod hardware that supports that feature. This action is accomplished using sg\_ses commands. [ QSTOR-10618 ]
* Added functionality to treat enclosures accidentally unplugged as MISSING, so that when reconnected their user-set properties are not lost . [ QSTOR-10542 ]

High Availability Failover
* Fixed an issue with post failover storage pool update tasks being stuck in a running state for nodes where the HA storage pool was previously evicted from due to an automatically triggered failover event. [ QSTOR-10485 ]

Kernel and Drivers
* Updated ZFS driver version to 2.2.6 [ QSTOR-10647 ]
* Updated scst iSCSI/FC Target driver to 3.9.0 [ QSTOR-10534 ]

Licensing
* Fixup old license keys to work with new format. [ QSTOR-10788 ]
* Added Express Edition Licenses [ QSTOR-10619 ]
* Show TB Utilized in the License grid and property view. [ QSTOR-8009 ]

NAS Gateway / Cloud Containers
* Fix wrap and truncation issues in the Cloud Add Credential dialog for Spanish. [ QSTOR-10792 ]

Network Shares
* Retain include line position in smb.conf [ QSTOR-10800 ]
* Minor fix to retain the share description when creating a Network Share. [ QSTOR-10793 ]
* Enhance the network share CLI search to support paging (similar to buckets). [ QSTOR-10757 ]
* Fix minor share name and snapshot name validation. [ QSTOR-10520 ]
* Added additional share name validation to share modify cli and API calls. [ QSTOR-10519 ]
* Add SSSD support [ QSTOR-10445 ]
* Implemented ransomware detection for Network Shares. [ QSTOR-10391 ]

Quantastor CLI
* Fixed qs cli disk-list filters for ssd, and nvme disk types. [ QSTOR-10515 ]
* Fixed the filtering for qs cli disk-list --filter="\[unused\]" and --filter="\[used\]" commands [ QSTOR-10482 ]

Remote Replication, Snapshots and Backup Policies
* Remove SSH keys after replication links are deleted [ QSTOR-10782 ]
* Fix minor argument validation for replication schedule create and snapshot schedule create. [ QSTOR-10732 ]
* Added monitoring for file modify events to enable continuous data protection on modified files. [ QSTOR-10557 ]
* Added ability for Snapshot Schedules and Replication Schedules to absorb old snapshots. [ QSTOR-10524 ]
* Create local delta Snapshot on source when Replication Schedule is skipped. [ QSTOR-10357 ]
* Change the control in the 'Update Selections for Replication Schedule' dialog to be a dual chooser. [ QSTOR-10351 ]

SCSI / NVMe Target
* Added a remote Fibre Channel port list to the fc target port section of the UI and 'qs fc-remote-port-enum' CLI command. [ QSTOR-10541 ]
* Added the Fiber Channel Issue LIP dialog to the UI that can be used to issue a lip on a specific FC port. [ QSTOR-10226 ]

SNMP
* Update SNMP MIB [ QSTOR-10847 ]

Security
* Fixed a bug in the 2FA login process. [ QSTOR-10841 ]
* Added support for a custom iptables include script under
/var/opt/osnexus/quantastor/iptables.qscustom [ QSTOR-10794 ]
* Updated tomcat package version to 9.0.96.0 [ QSTOR-10691 ]

Service Core
* Fix a small memory leak [ QSTOR-10778 ]
* Revise the server S3 modify API to accept spaces for the Display Name property. [ QSTOR-10724 ]
* Fixed some issues with writing the Chrony conf file on platforms that have chrony installed (like Jammy) [ QSTOR-10293 ]

Storage Pool Management
* Allow trim schedule to run nightly. [ QSTOR-10652 ]

Storage Volumes
* Allow minimum of <4MB for Storage Volume QoS Control limits. [ QSTOR-10765 ]
* Updated Storage Volume QoS controls to use cGroups v2 for modern linux kernels/platforms. [ QSTOR-10529 ]

Upgrade Manager and Installer
* Added logic to temporarily disable the upmap balancer during ceph upgrade. [ QSTOR-10702 ]
* Fixed an issue where Storage System Upgrade tasks were showing 25% progress but transitioned to the 'Completed' stage. [ QSTOR-10673 ]
* Install sssd packages by default on focal and newer platforms. [ QSTOR-10549 ]
* chrony is now the default time daemon for ubuntu 22.04 jammy and newer platforms. [ QSTOR-10273 ]
* Added 22.04 Jammy as a new Platform for QuantaStor [ QSTOR-10225 ]

Web Manager
* Disable the 'Start Upgrade' button in the Upgrade dialog until the system update check is complete. [ QSTOR-10776 ]
* Show the Tag/Alt Name value along with the Controller name in the identify dialog if provided. [ QSTOR-10775 ]
* Decrease the replication detail chart update frequency. [ QSTOR-10753 ]
* Added email validation check for the Alert Manager dialog [ QSTOR-10590 ]
* Added Timezone configuration as a step in the getting started guide. [ QSTOR-10502 ]

== v6.4.5.001 (November 1st 2024) ==

=== [[QuantaStor 6.4.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.5 Upgrade Instructions| upgrading to QuantaStor v6.4.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an error with Ceph Bucket Discovery tasks. [ QSTOR-10707 ]

== v6.4.4.013 (October 25th 2024) ==

=== [[QuantaStor 6.4.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.4 Upgrade Instructions| upgrading to QuantaStor v6.4.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added a fix for Seagate Corvault based Ceph deployments to ensure ceph LVM layer is started on system boot. [ QSTOR-10686 ]
* Added qs-osd-compact script to assist with OSD compaction on a per system basis. [ QSTOR-10668 ]
* Fixed an issue with Ceph OSD Journal device discovery for encrypted Ceph Clusters. [ QSTOR-10666 ]
* Extend timeouts for OSD restart stage of the Ceph upgrade task. [ QSTOR-10665 ]
* Fixes bug were OSDs lose journal device correlation after OSD reweight operation. [ QSTOR-10657 ]

Enclosures and Controllers
* Fixed an issue with enclosure and disk slot identity correlation information. [ QSTOR-10681 ]

High Availability Failover
* Disables the PCS daemon WebUI by default. [ QSTOR-10692 ]
* Adds a check for versions older than 6.4.3 to auto-disable the new health checks logic that is not compatible with older versions. [ QSTOR-10692 ]

Upgrade Manager and Installer
* Fixed: the qs_upgrade_redhat8.sh script now automatically removes legacy centos repos that are no longer needed for Redhat platform deployments. [ QSTOR-10676 ]

== v6.4.3.021 (October 10th 2024) ==

=== [[QuantaStor 6.4.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.3 Upgrade Instructions| upgrading to QuantaStor v6.4.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed a incorrect encrypted ZFS pool check check in the Config Analyzer for encrypted Ceph clusters with encrypted OSDs. [ QSTOR-10643 ]

Ceph Scale-out Block, Object and File
* Optimized scale-out ceph bucket discovery for very large number of S3 buckets. [ QSTOR-10621 ]
* Ceph OSD create and delete operations will no longer fail due to services being masked. [ QSTOR-10617 ]
* Made some improvements to the Veeam SOSAPI update cycle. [ QSTOR-10616 ]
* Fixed an issue with creating Ceph Storage Classes of the same name on different Ceph Clusters. [ QSTOR-10592 ]
* Default to http based checks from the haproxy load balancer to backend http radosgw instances. [ QSTOR-10559 ]

NAS Gateway / Cloud Containers
* Add a rescan for cloud containers so that data is refreshed if uploaded from another S3 gateway. [ QSTOR-10627 ]

Network Shares
* Fix an issue with trusted domain users not found in the Active Directory User search dialog. [ QSTOR-7353 ]

Remote Replication, Snapshots and Backup Policies
* Enabled Continuous Data Protection and Auto-tiering on Backup Policies using the SMB protocol. [ QSTOR-10601 ]

Security
* Added http proxy support for Upgrades, Support Log submission and License Key Activation. [ QSTOR-10432 ]

Upgrade Manager and Installer
* Fix triggering Ceph cluster upgrades when there are multiple scale-out storage Ceph clusters in the same QuantaStor Storage Grid. [ QSTOR-10612 ]
* Fixed an issue with the Ganesha 5.9 libntirpc dependency. This change was shipped earlier with a respin of QuantaStor 6.4.3 to include the missing updated library in the update repo and in the ISO and OVA image. [ QSTOR-10576 ]

== v6.4.2.053 (September 19th 2024) ==

=== [[QuantaStor 6.4.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.2 Upgrade Instructions| upgrading to QuantaStor v6.4.2]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed tolerances for alerting on changes in PSU status and other IPMI sensors. [ QSTOR-10447 ]

Ceph Scale-out Block, Object and File
* Adds total Object count to S3 tenant and user objects [ QSTOR-10606 ]
* Improved logic to ensure Scale-out Object Storage Class Auto-Tiering Rules were applied correctly on all nodes after an update. [ QSTOR-10599 ]
* Unblocked file quotas for CephFS Shares. [ QSTOR-10584 ]

Enclosures and Controllers
* Added Enclosure for Tyan Transport SX TS70-B8056. [ QSTOR-10597 ]
* Fixed an issue with enclosure support for Supermicro SSG-621E-ACR16L [ QSTOR-10563 ]

NAS Gateway / Cloud Containers
* Fix a regression with NFS and SMB access for cloud container shares. [ QSTOR-10588 ]

Network Shares
* Fixed an issue where the quota field was incorrectly disabled in the network share modify and create dialogs for nested shares on zfs storage pools. [ QSTOR-10602 ]
* Implemented ability to adjust Network Shares permission settings via a specified permissions mask. [ QSTOR-10147 ]

Quantastor CLI
* Fix a minor regression with share name now showing in the output of "qs share-list" [ QSTOR-10587 ]

Remote Replication, Snapshots and Backup Policies
* Show more informative errors when a Backup Job fails. [ QSTOR-10575 ]
* Fixed an issue where multiple snapshots were wrongfully created. [ QSTOR-10564 ]
* Fix an issue with removing excess snapshots for a backup policy with cephFS shares. [ QSTOR-10560 ]
* Add maximum total snapshots for replication, snapshot and backup schedules. [ QSTOR-10539 ]
* Fixed an issue where GMT Snapshots were disappearing. [ QSTOR-10538 ]
* Fix an issue with resume replication not updating the replication reports. [ QSTOR-10536 ]
* Added auto-tier stubbing minimum file size threshold. [ QSTOR-10505 ]

SCSI / NVMe Target
* Added support for setting specific LUN numbers on Storage volumes for Fibre Channel access. This is available in the Advanced tab of the Storage Volume Create and Modify dialogs. [ QSTOR-10544 ]

Service Core
* Improved efficiency for Ceph Bucket discovery. New Default behavior is to skip collecting life cycle policy and object locking data on the bucket. Contact support to enable object locking discovery on buckets. [ QSTOR-10600 ]

Upgrade Manager and Installer
* Added script to fix RGW configurations on clusters created on older versions of QuantaStor. [ QSTOR-10569 ]
* Added support for Ceph Reef 18.x upgrades. [ QSTOR-10493 ]

Web Manager
* Make the info fields, in the Snapshot Rollback Point fieldset of the Rollback Storage Volume dialog, read-only. [ QSTOR-10596 ]
* Hide the timezone column in the Upgrade Manager dialog. [ QSTOR-10540 ]
* Change S3 Bucket Search panel location from North to West of screen. [ QSTOR-10405 ]

== v6.4.1.011 (August 6th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.1 Upgrade Instructions| upgrading to QuantaStor v6.4.1]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with the Supermicro NVMe Enclosure mappings for the SBB-SSG-221E and SSG-641E [ QSTOR-10506 ]

Network Interfaces
* Fixed: Infiniband Devices should now have the correct Make and Model displayed in the Network interface section. [ QSTOR-10448 ]

Network Shares
* Fixed an issue with updating the status of Backup Policy Jobs. [ QSTOR-10517 ]

Remote Replication, Snapshots and Backup Policies
* Fixed: Shows the last 14 days in the replication schedule dashboard regardless of the replication schedule configuration. Fix an issue where not all series data was appearing despite being in a completed state. [ QSTOR-10528 ]
* Fixed an issue with duplicate Replication tasks. [ QSTOR-10526 ]
* Correct the max temporary snapshots retained for volumes in a replication schedule. [ QSTOR-10525 ]
* Add the ability to discover partially transferred chkpnts if replication is interrupted on the first transfer. [ QSTOR-10500 ]

Upgrade Manager and Installer
* Fixed: optimized dependency checker for qs-upgrade script. [ QSTOR-10531 ]

== v6.4.0.174 (July 18th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.0 Upgrade Instructions| upgrading to QuantaStor v6.4.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue with adding new ITSM webhook integrations. [ QSTOR-10480 ]
* Added support for Microsoft Teams to ITSM integrations. [ QSTOR-10458 ]
* Added the ability to easily extend ITSM integrations with new integration modules with qs_alerthandlers.conf file. [ QSTOR-10458 ]
* Include storage volumes in pool reports. [ QSTOR-10083 ]

Ceph Scale-out Block, Object and File
* Fixed an issue where the wrong libntirpc library was installed for nfs-ganesha. [ QSTOR-10463 ]
* Added a Copy to Clipboard Button for a selected access key and changed the double click on access/secret key behavior to copy to clipboard for the S3 User Access Key Manager Dialog. [ QSTOR-10428 ]
* Added a check to the S3 User Access Key Manager Dialog to ensure only the selected key text is shown when the user clicks the 'Show Key Text' button on the dialog. [ QSTOR-10428 ]
* Added block for more than 2 S3 Gateway loadbalancer modes configured at the same time. [ QSTOR-10407 ]
* Added a new feature for data pool capacity based, overflow rules for ceph object storage. Added support for a force flag for the auto tiering rules, that will overwrite any client side storage class specifications. [ QSTOR-10379 ]
* Add reporting for object storage usage. Periodic reports can be generated as part of "Report Schedules" by enabling "Object Zone Usage Report". [ QSTOR-10355 ]
* Added object count for Ceph Buckets. [ QSTOR-10348 ]
* Updated the default access permissions for Ceph keyring files. [ QSTOR-10325 ]
* Updated ceph cluster scale-out OSD osd_op_queue setting to wpq by default. The setting will take effect for any new OSDs on creation. Existing OSDs will use the new setting on OSD service restart (system reboot, encrypted OSD re-keying or manual OSD service restart) [ QSTOR-10123 ]
* Improved an error message when creating a Site Vif with Block Storage use case. [ QSTOR-9984 ]
* Added ability to enable a size quota and a file number quota on cephFS Shares. [ QSTOR-7344 ]

Enclosures and Controllers
* Fixed an issue where a disconnected JBOD could leave the enclosure object around on LSI HBAs. [ QSTOR-10503 ]
* Fixed: a modify of enclosure or system layout to something other than default will also set the same layout on the corresponding system or enclosure(s) that are currently set to default. [ QSTOR-10496 ]
* Fixed an issue with using the wrong LED control Utility for disk identification on Supermicro NVMe storage systems. [ QSTOR-10469 ]
* Added support for Supermicro SBB-SSG-221E-DN2R24R to enclosure/server views. [ QSTOR-10460 ]
* Added Support for Supermicro SSG-641E-E1CR36L/H to enclosure/server views. [ QSTOR-10429 ]
* Prevent a missing disk from being blinked. [ QSTOR-10179 ]

High Availability Failover
* Fixed an issue that could terminate the qs_pool_export script early on ha failover without final logging. [ QSTOR-10514 ]
* Fixed: added a check for HA VIFs to the network port offline dialog. This prevents a possible split cluster scenario. [ QSTOR-10414 ]
* Updated Task error messages to include the system where an error occurred for HA Storage pool failover tasks. [ QSTOR-10248 ]
* Added periodic HA failover group health checks for client and media connectivity. An alert will be raised If a health check fails that could indicate an issue with the future success of a High Availability failover from the primary to secondary node. [ QSTOR-9380 ]

Network Interfaces
* Prevent modifying parent port when static route is configured. [ QSTOR-10200 ]
* Fixed: removed iscsi and nvmeof portal configuration options on all grid vifs. client access should be configured through HA or Site cluster vifs only. [ QSTOR-9974 ]

Network Shares
* Fixed: NFS remove client access dialog and the qs share-client-remove CLI command now default to immediately terminate client connections for removed export rules, enhancing security. An option to retain client connections is available in the UI ("Retain Client Connections") and CLI (--retain-client-connection=true). [ QSTOR-10431 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Remote Replication reporting incorrect snapshot count. [ QSTOR-10476 ]
* Added a ZFS quantastor:scheduletype property to snapshots so that it is clearer what type of schedule created the snapshot. [ QSTOR-10421 ]
* Fix duplicate entries in replication dashboard. [ QSTOR-10385 ]
* Use raw mode for ZFS send and receive. Use on the wire compression if the source is not compressed. [ QSTOR-10153 ]

SNMP
* Update SNMP MIB [ QSTOR-10512 ]

Security
* Added feature to replace the OSD encryption keys for a given Ceph cluster. [ QSTOR-10283 ]
* Improved qs-util wrapper script so that user is prompted for secret passphrase. Passphrase will remain hidden. [ QSTOR-9982 ]

Service Core
* Fix minor trace message for Maintenance schedules. [ QSTOR-10416 ]
* Added a check to the QuantaStor system startup to ensure that LUKS encrypted Physical disks devices provided to QuantaStor via the iSCSI Software adapter are opened after system boot. [ QSTOR-10257 ]

Upgrade Manager and Installer
* Added support for customizing OVF templates with passwords and license keys. [ QSTOR-10451 ]
* Fixed an issue with the archived centos ganesha mirrors in the qs_upgrade_redhat8.sh install and upgrade script. [ QSTOR-10446 ]

Web Manager
* Fixed an issue where the User Web Customization rules were not being properly applied when the rules were defined in the Role create or modify dialog. [ QSTOR-10513 ]
* Fixed the text highlight and other colors used in the UI to be consistent across elements. [ QSTOR-10470 ]
* Update: Replaced all instances of 'double click to reveal plain text' on password fields with an explicit eyeball reveal button to allow users to show plain text. [ QSTOR-10410 ]
* Updated web manager tomcat and Java runtime dependencies. [ QSTOR-9492 ]

== v6.3.7.011 (June 18th 2024) ==

=== [[QuantaStor 6.3.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.7 Upgrade Instructions| upgrading to QuantaStor v6.3.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue with creating Erasure Coded Ceph Object Storage Classes in the Web UI. [ QSTOR-10434 ]

Dashboards and Analytics
* Fixed the install-ceph-prometheus scripts to always have a default fallback install version if the latest version is not available. [ QSTOR-10441 ]
* Updated wiki documentation for the Prometheus and Grafana Integration guide to reflect changes from latest Grafana 11.0 release. [ QSTOR-10441 ]

Enclosures and Controllers
* Fixed several items and updated logic for External System Corvault support. [ QSTOR-10235 ]

Kernel and Drivers
* * Fixed an issue with modern mellanox OFED installs using the mellanox-ofed-install.sh script and legacy ConnectX-3 Based Mellanox HBA's [ QSTOR-10295 ]

Network Shares
* Added logic to always bind mount the /export paths on Network Shares even if the share has no NFS access rules and is set to disabled and SMB/CIFS disabled. This includes Nested shares under Parent Network Shares. No noticeable increase in failover times was detected when testing on a Large HA config with many Network Shares including many Nested Shares and snapshots. [ QSTOR-10424 ]
* Fixed an issue with the Network Share snapshot count property. [ QSTOR-10329 ]
* Re-enabled the Network Share Snapshot count column by default in the Network Share Grid View. [ QSTOR-10329 ]

Storage Volumes
* Fixed an issue where FC ALUA standby LUN devices for Storage Volumes would not appear as non-rotational(SSD) to clients when on an SSD or NVMe based Storage Pool. Note: a reboot is required to reload the SCST kernel driver stack on the system for the fix to take effect. [ QSTOR-10417 ]
* Fixed an issue with presenting pass-through Storage Volumes as non-rotational(SSD) to clients. [ QSTOR-10417 ]

Upgrade Manager and Installer
* Updated mellanox-ofed-install.sh script to support latest Mellanox OFED 24.04-0.6.6.0 [ QSTOR-10438 ]
* Added a lts optional flag to the mellanox-ofed-install.sh for installing Mellanox OFED version 5.8-4.1.5.0. [ QSTOR-10438 ]

Web Manager
* Fix a minor ribbon bar alignment and spacing issue between elements by making a deferred force layout call during context switching. [ QSTOR-10413 ]
* Fixed an issue where some elements of the Ribbon Bar would not be visible or would somehow be under the visible section of the UI. [ QSTOR-10413 ]
* Removed the ZFS share encryption tab from the create and modify network share dialogs. The ZFS Share encryption feature is still available for share creation via the CLI but is not recommended for most users due to ZFS driver level issues. When the ZFS driver issues are resolved in a future ZFS release, the encryption tab will be re-enabled. [ QSTOR-10352 ]

== v6.3.6.003 (June 4th 2024) ==

=== [[QuantaStor 6.3.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.6 Upgrade Instructions| upgrading to QuantaStor v6.3.6]].

=== Release Notes ===
Remote Replication, Snapshots and Backup Policies
* Added a check to enforce 'Enable target checkpoint recovery (unchecking will perform full replication)' setting on Remote Replication Schedules. This helps ensure that no additional _chkpnt is created for a share or volume if one already exists for the source and target replication association. [ QSTOR-10419 ]
* Fixed an issue with replication report showing synchronizing state forever. [ QSTOR-10419 ]

Security
* Added qs-util wuicustomcerts command to allow creation of a /var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf nginx override config so that users can customize certificate paths and ciphers from the QuantaStor defaults for the Web UI. [ QSTOR-9037 ]

== v6.3.5.020 (May 23rd 2024) ==

=== [[QuantaStor 6.3.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.5 Upgrade Instructions| upgrading to QuantaStor v6.3.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where s3 gateway create was creating load balancers with https->https mode when https->http mode was passed in. [ QSTOR-10399 ]
* Fixed some issues with discovery of the http/https mode for the S3 load balancer. [ QSTOR-10399 ]
* Further optimizations and fixes related to Grid communication and Ceph Scale-out Object discovery on Object Storage Pools with a large number of buckets. [ QSTOR-10380 ]
* Fixed an issue with adding and removing RGW instances on the same node via different IP addresses. [ QSTOR-10370 ]

High Availability Failover
* Added logic to limit number of open threads and open file handles needed to unmount shares for the HA storage pool failover process. This fixes an issue with deployments that have a large amount of shares, including nested shares and share snapshots. [ QSTOR-10373 ]
* Added more coverage for the auto close open file handles logic during HA storage pool failover to help unmount shares under the nfs /exports path as well as nested shares/snapshots. [ QSTOR-10373 ]

Multitenancy
* Fixed some issues with Multitenancy Container discovery and database table updates. [ QSTOR-10363 ]

Network Interfaces
* Added a exact match filter config file /var/opt/osnexus/quantastor/conf/qs_portFilter.conf for interface names that allows users to blacklist interfaces they do not want QuantaStor to see and/or manage. [ QSTOR-9664 ]

Network Shares
* Fixed an issue with the Network Share samba audit logging feature when upgrading from a legacy audit logging config. [ QSTOR-10390 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Security
* Adds support for controlling the sample period over which bad login attempts can trigger a short or permanent lock. [ QSTOR-10374 ]
* Adds support for controlling the duration of the short lock. [ QSTOR-10374 ]
* Fixes a security bug where good login attempts could mask bad login attempts by clearing the bad login attempt sample set for a given user. [ QSTOR-10374 ]
* Changes the special rules around bad login attempts for the 'admin' user, now allowing it to be locked. [ QSTOR-10374 ]
* Adds a touch file to unlock the 'admin' user account. [ QSTOR-10374 ]
* Adds a touch file to block the permanent locking of the 'admin' user account, which is similar to the current behavior. [ QSTOR-10374 ]

Storage Volumes
* Fixed an issue where iSCSI CHAP was not being correctly enabled in the iSCSI target on volumes when configured. [ QSTOR-10398 ]
* Fixed an issue with Fibre Channel Storage Volumes being presented after Storage System boot for Single QuantaStor node deployments (non-HA). [ QSTOR-10277 ]

== v6.3.4.003 (May 14th 2024) ==

=== [[QuantaStor 6.3.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.4 Upgrade Instructions| upgrading to QuantaStor v6.3.4]].

=== Release Notes ===

Web Manager
* Optimized WebUI login time for Large Scale-out Object deployments. [ QSTOR-10365 ]
* Fixed an issue where the WUI idle logout timer would be reached even when browsing inside of the WUI for various different sections. [ QSTOR-10361 ]

== v6.3.3.033 (May 1st 2024) ==

=== [[QuantaStor 6.3.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.3 Upgrade Instructions| upgrading to QuantaStor v6.3.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added qs_rgw_iam_policy.sh script for generating S3api IAM compatible bucket policies. [ QSTOR-10336 ]
* Added FQDN specific string validation to the Modify Realm/Zone Group dialog. [ QSTOR-10320 ]
* Fixed some items with the Modify Realm/Zone Group task. [ QSTOR-10320 ]
* Added a drop-down to the Create Storage Class Dialog with pre-defined S3 Storage Classes supported by most S3 CLI and S3 Library based clients. Users can still create a custom Storage class if they so choose and use their own custom S3 API implementation that supports Custom S3 Storage Classes. [ QSTOR-10232 ]
* Fixed some issues with adding/removing S3 Gateways with Load Balancers. [ QSTOR-9848 ]

High Availability Failover
* Added a force flag to the Remove Site Cluster Virtual Interface dialog. [ QSTOR-8276 ]
* Added logic to auto re-apply iofencing to devices that are re-added to the system due to prior physical removal or power loss of the device/device enclosure. [ QSTOR-5475 ]
* Fixed an issue with enabling client connectivity on HA Groups and implemented more safe guards. [ QSTOR-3432 ]

Network Shares
* Add touch file to limit discovery of snapshots of nested shares. [ QSTOR-10334 ]
* Fixed: Network Share rename will correctly remount the /export/ NFS mount location to the new name. [ QSTOR-10318 ]
* Fix minor message during share disable with active SMB clients. [ QSTOR-10292 ]
* Share disable will close open file handles to the share when accessed via SMB. [ QSTOR-10291 ]
* Fixed an issue where Network sub-share alias shares would not start properly after Storage Pool HA Failover. [ QSTOR-10278 ]
* Fixed an issue where share alias advanced settings allowed modification after an HA failover. [ QSTOR-10276 ]

Remote Replication, Snapshots and Backup Policies
* Fix update selections for a replication schedule for cases where source is on a HA pool. [ QSTOR-10310 ]
* Fixed an issue with Windows Previous Versions on share-alias. [ QSTOR-10274 ]
* Added a check to ensure no duplicate share alias names are created on the same parent share. [ QSTOR-10274 ]

Security
* Fixed an issue where the Security Manager > Default Login Username field was not initializing to 'admin' for default installs and upgrades. [ QSTOR-10323 ]

Upgrade Manager and Installer
* Added logic to remove legacy google-compute-engine-oslogin and/or google-guest-agent on upgrade. These packages caused systems to not shutdown properly when installed. [ QSTOR-10340 ]
* Added a check to ensure the ledmon service is disabled by default. This is to ensure that there are no conflicts with the QuantaStor managed Disk Identify logic. [ QSTOR-10313 ]

Web Manager
* Added paging support to S3 Bucket search [ QSTOR-10324 ]

== v6.3.2.025 (April 15th 2024) ==

=== [[QuantaStor 6.3.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.2 Upgrade Instructions| upgrading to QuantaStor v6.3.2]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added search capability to the S3 Bucket section of the Web UI. [ QSTOR-10288 ]
* Added Rule Sorting and an explicit rule remove button to the Storage Class Auto-Tiering Rules Dialog. [ QSTOR-10287 ]
* Added: You can now add the FQDN's for DNS names that you want the S3 Gateways to respond to via the Modify Realm/Zone Group Dialog. Note: you must add the FQDN's of the hosts or an FQDN alias e.g. s3.yourdomain.net (like used by DNS round robin) for the HAproxy load balancer to work properly. [ QSTOR-10285 ]
* Fixed issues with Ceph S3 Bucket discovery with a large amount of buckets. [ QSTOR-10261 ]
* Fixed some items related to Veeam SOSAPI integration based on testing in Veeam Certifcation scripts. [ QSTOR-10243 ]

Enclosures and Controllers
* Fixed an issue where Dell RAID Controllers were being discovered twice in due to new support for the controllers discovery in Broadcom storcli utilities. [ QSTOR-10244 ]

High Availability Failover
* Fixed an issue where rebooting an active High Availability storage node would cause ZFS encrypted shares to go offline for any active pools on that node prior to automatic failover. [ QSTOR-10218 ]

Network Interfaces
* Fixed an issue where legacy VLAN interfaces that had the RX/TX optimizations flag set would not allow modification of the interface for any other setting. [ QSTOR-10272 ]

Not Set
* Added logic to prioritize high-speed data ports by default in the Ceph Cluster create and S3 gateway create dialogs. [ QSTOR-10266 ]
* Fixed usable space calculation on Object Pool Group when there are multiple Pools or Storage Classes using the same OSD's. [ QSTOR-10264 ]
* Fixed an issue with modifying a network share after after a custom veto files setting had been added to the samba cifs options. Now the veto files merge as a set with the default .qssnaps veto files used by the VSS GMT snapshots feature. [ QSTOR-10249 ]

Security
* Updated the OSNEXUS Security Notice service [https://services.osnexus.com/security/](https://services.osnexus.com/security/) for bionic and focal platform support. [ QSTOR-10269 ]

Service Core
* Added support for replacing ntpd with chronyd in Ubuntu Focal platform based deployments. [ QSTOR-10239 ]

== v6.3.1.009 (April 1st 2024) ==

=== [[QuantaStor 6.3.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.1 Upgrade Instructions| upgrading to QuantaStor v6.3.1]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where a pool running a scrub would report as degraded in the Config Analyzer health report. [ QSTOR-10258 ]

Ceph Scale-out Block, Object and File
* Added qs-rgw-moveobjects script to allow easier s3api copy-object of a buckets contents to a different storage class. [ QSTOR-10268 ]
* Changed haproxy load-balancer to use balance source mode by default. [ QSTOR-10260 ]
* Fixed an issue with the Storage Class Auto-Tiering rules where multipart uploads with Capacity Operators of greater than or greater and equal to the Capacity Threshold would not be uploaded to the correct storage class. [ QSTOR-10254 ]

Enclosures and Controllers
* Changed qs-util seagate-ap-split mode command to use zone 5 [ QSTOR-10259 ]

Web Manager
* Increased default max bucket count for S3 user to 100K. [ QSTOR-10256 ]
* Added new Grid Preferred Port status column in the Network Port Grid. It's hidden by default. [ QSTOR-10256 ]
* Fixed s3 gateway dialog height so it can show more nodes in the grid. [ QSTOR-10256 ]
* Fixed s3 tenant create, if "Display Name" is not specified use the "Name" (display name is no longer mandatory in dialog). [ QSTOR-10256 ]

== v6.3.0.268 (March 20th 2024) ==

=== [[QuantaStor 6.3.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.0 Upgrade Instructions| upgrading to QuantaStor v6.3.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where md software raid os partitions where being reported in the config analyzer as offline storage pools. [ QSTOR-10168 ]
* Fixed an issue where non-management ports were being flagged in the config analyzer for iSCSI acess being enabled. [ QSTOR-9891 ]

Ceph Scale-out Block, Object and File
* Blocked creating new OSDs when the OSD service is masked. [ QSTOR-10212 ]
* Show the S3 Object Storage Pool as the root node in the S3 User's and Tenant tree. [ QSTOR-10156 ]
* Show the S3 Object Storage Pool as the root node in the bucket tree. [ QSTOR-10150 ]
* Add support for multiple data pools for storage classes for Ceph Object Storage Pool. [ QSTOR-10137 ]
* Add auto tiering capability to ceph buckets. [ QSTOR-10125 ]
* Change the Ceph block storage pool to default to replica=3 for performance. [ QSTOR-10062 ]
* For CephFS, the min_size for the metadata pool should be 2. [ QSTOR-10015 ]
* Introduce safe disk replacement for Ceph OSDs. [ QSTOR-9937 ]
* Applied adjustments to Ceph Clusters for optimized scrubs on smaller and denser clusters. [ QSTOR-9900 ]
* Updated NFS Ganesha to 5.7 [ QSTOR-9821 ]
* Add support for Ceph Multi-site bucket replication. [ QSTOR-6570 ]

Disk Management
* Added support for ScaleFlux CSD 3000 SSDs that support builtin compression provisioning. [ QSTOR-10198 ]
* Fixed an issue with disk correlation by serial number on Broadcom/LSI 93XX series HBAs. [ QSTOR-10194 ]
* Show osd number in 'qs disk-list'. [ QSTOR-9717 ]

Enclosures and Controllers
* Add enclosure view for the ASUS 2u24 NVMe. [ QSTOR-10202 ]
* Fix controller selection issue in the 'Identify Hardware Controller Disk Device' dialog for when the selected object in the Physical Disk tree is a Physical Disk and not the Disk itself. [ QSTOR-10195 ]
* Updated wddcs tool to 3.2.8.0 [ QSTOR-10166 ]
* Added to feature to create or delete multiple External System Volume configurations. [ QSTOR-10061 ]

High Availability Failover
* Fixed an issue with the Create HA Failover Group Dialog when there are active FC sessions on volumes on the selected pool. [ QSTOR-10169 ]
* Changed NVMe reservations to use cptpl=2 when available so that iofencing is cleared on power on of a nvme drive. [ QSTOR-10124 ]

Licensing
* Added logic to auto-fetch new QuantaStor License Server ca certificates during online license activation. [ QSTOR-10174 ]

NAS Gateway / Cloud Containers
* Update rclone version. [ QSTOR-9512 ]

Network Interfaces
* Show static route parent port in the respective grid and delete dialog. [ QSTOR-10199 ]
* Fixed an issue with onlining/restarting offline VLAN interfaces. [ QSTOR-10180 ]
* Fixed an issue with VLAN ontop of Bonded ports on VM deployed QuantaStor instances. [ QSTOR-10180 ]
* Improve the Network bond mode descriptions, in the 'Create Bonded Port' dialog, for those that require managed switches. [ QSTOR-9842 ]
* Added IP address place holder for DHCP interfaces that have no assigned IP address. [ QSTOR-9828 ]
* Fixed an issue with downing virtual interfaces when converting to HA virtual interface. [ QSTOR-9774 ]

Network Shares
* Minor Web UI fix to display share quota percent utilization. [ QSTOR-10121 ]
* Implemented a Real Time Auto Copy feature to enhance data protection for Network Shares. [ QSTOR-9929 ]
* Updated Focal platform Samba to 4.18.6 backported from ubuntu upstream release. [ QSTOR-9924 ]
* Show parent shares in the 'qs share-list' command results. [ QSTOR-9702 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Remote Replication, Snapshots and Backup Policies
* Add the ability to force create symbolic links for backup policy outbound-move to cloud containers without a delay of 24 hours. [ QSTOR-10136 ]
* Update Replication Report Summary object as failed if source system reboots right after schedule is triggered. [ QSTOR-10097 ]

SNMP
* Regen SNMP MIB for 6.3 [ QSTOR-10228 ]

Security
* Updated JQuery version used in the QuantaStor WebUI to 3.7.1 [ QSTOR-10064 ]
* Add Audit Log Viewing to the Storage System menus. [ QSTOR-10031 ]

Storage Pool Management
* Improved logic for replacing zpool UNAVAIL disks that are identified by their id instead of a device path as the disk is no longer present or visible to the OS. [ QSTOR-10129 ]

Upgrade Manager and Installer
* Automatically disable and mask uefi fwupd service on platforms that include it to prevent unplanned firmware updates. [ QSTOR-10205 ]
* Fixed: the low boot space warning for kernel upgrades now correctly appears in the Upgrade Manager task failure message. [ QSTOR-10185 ]
* Fixed an issue where the scst/zfs userspace packages were not being pinned on security updates. [ QSTOR-10185 ]
* Fixed an issue where qstortarget was incorrectly selected during security updates but fails due to existing pinning rules. qstortarget now correctly only gets selected for install on kernel/driver upgrades. [ QSTOR-10185 ]

Web Manager
* Minor fix to show NA for share-alias space columns. [ QSTOR-10227 ]
* Login dialog shown after service restart is complete. [ QSTOR-10007 ]

== v6.2.8.016 (March 5th 2024) ==

=== [[QuantaStor 6.2.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.8 Upgrade Instructions| upgrading to QuantaStor v6.2.8]].

=== Release Notes ===

Enclosures and Controllers
* Fixed Hardware Disk to Physical disk slot correlation issues. [ QSTOR-10135 ]
* Improved Enclosure object guid uniqueness to better support more complex/multipath setups for hardware disk to physical disk mapping. [ QSTOR-10135 ]
* Added Hardware Enclosure Serial\# property and logic to discover serial\# when available. [ QSTOR-10102 ]

Multitenancy
* Updated Resilio container image to 3.8.1.2250 [ QSTOR-10162 ]
* Fix errors with Resilio container errors seen after upgrade. [ QSTOR-10099 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue that could sometimes cause duplicate snapshot objects to appear for snapshot schedules with nested shares and recursive snapshot enabled. [ QSTOR-10159 ]
* Added a check to temporarily prevent adding ZFS dataset encrypted Network Shares to remote replication schedules until the Open ZFS issue \#12014 is resolved in an upcoming ZFS release. [ QSTOR-10145 ]
* Fixed an issue with using Windows Restore Previous Versions on remote Replica \_chkpnt Network Shares. [ QSTOR-10065 ]

SCSI / NVMe Target
* Updated SCST driver to 3.8.0.9038-f134517-qs01 to support latest available linux kernels for Focal platform and Focal cloud platform kernels. [ QSTOR-10151 ]

Upgrade Manager and Installer
* Added Kernel Driver Support for QuantaStor installation on Ubuntu 20.04 images on Azure, AWS and Google Cloud. [ QSTOR-10138 ]

== v6.2.7.002 (February 23rd 2024) ==

=== [[QuantaStor 6.2.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.7 Upgrade Instructions| upgrading to QuantaStor v6.2.7]].

=== Release Notes ===

Licensing

* Updated license manager certificates for online license activation. [ QSTOR-10154 ]

== v6.2.6.024 (February 8th 2024) ==

=== [[QuantaStor 6.2.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.6 Upgrade Instructions| upgrading to QuantaStor v6.2.6]].

=== Release Notes ===

Enclosures and Controllers

* Added support for iofencing NVMe disks that do not support cdw11 [ QSTOR-10087 ]
* Added an Alert for when a OS Software RAID1 mirror enters a degraded state. [ QSTOR-10080 ]
* Added support LSI-3008C0 model controllers. [ QSTOR-9841 ]
* Added a check to hardware Enclosure Discovery to automatically filter out enclosures that do not have any drive slots. [ QSTOR-9716 ]

High Availability Failover

* Fixed an issue with the I/O fencing tool where it was reporting not-supported on reservation capable nvme devices. [ QSTOR-10114 ]

Network Interfaces

* Updated static routes to use modern ip route syntax with the 'proto static' option. [ QSTOR-10103 ]
* Updated netplan conversion to by default create static routes using ip route to match the original netplan static route rules. [ QSTOR-10103 ]

Storage Pool Management

* Fixed: Activate HA Failover Group now works for Storage Pools in a degraded state missing a few devices. [ QSTOR-10100 ]
* Fixed: Create HA Failover Group now allows a force option if there are a small number of drives missing on the secondary node. Note that the operation will still be blocked if most/all of the drives are missing from the secondary node. [ QSTOR-10100 ]
* Added support for Zero Touch Maintenance Automatic Global Hot spare marking of Hardware RAID0 Passthrough units. [ QSTOR-9865 ]

Storage Volumes

* Fixed: NVMe Target Storage volumes now persist their serial numbers correctly on reboot [ QSTOR-9992 ]
* Fixed: the NVMe Target now correctly re-exports the allowed portals on system boot. [ QSTOR-9992 ]

Upgrade Manager and Installer

* Updated mellanox-ofed-install.sh script to support the latest Focal platform 5.15.0-91-generic kernel. [ QSTOR-10117 ]
* Updated the GPG repo keys for QuantaStor RedHat / and Almalinux platform installs [ QSTOR-10107 ]
* Fixed a incorrect error log when upgrading the Kernel and Drivers on the Ubuntu Focal platform. The upgrade would succeed when the error was seen, but it was unclear to the user without full log analysis. [ QSTOR-10106 ]
* Updated upgrade manager logic to ensure recommended dependency packages are always selected for install during core service and security upgrades. [ QSTOR-10101 ]
* Fixed an issue with the qs-distupgrade script where some QuantaStor core package changes were not being applied after a platform dist-upgrade from bionic to focal. [ QSTOR-10132 ]
* Added better logging of systemctl service enablement and restart during qstorservice package installs. [ QSTOR-10134 ]

== v6.2.5.032 (January 18th 2024) ==

=== [[QuantaStor 6.2.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.5 Upgrade Instructions| upgrading to QuantaStor v6.2.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added ssh port 22 to network connectivity checker tests. [ QSTOR-10092 ]

Ceph Scale-out Block, Object and File
* Fix bug where ceph monitor daemon is disabled. [ QSTOR-10095 ]
* Added script to setup Ceph multi-site replication. [ QSTOR-10075 ]

Enclosures and Controllers
* Updated storcli version to 007.2705.0000.0000 [ QSTOR-10072 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-10036 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-9825 ]

Kernel and Drivers
* Updated Linux Kernel to 5.15.0-91-generic for Focal platforms [ QSTOR-10025 ]
* Linux Kernel 5.15.0-91-generic includes fixes for NFS v3 lockd that would cause file handles to be left open for NFSv3 clients when attempting to stop the nfs server before ZFS pool export during HA failover. [ QSTOR-10025 ]
* Updated ZFS to 2.1.14.qs25 for Focal platforms [ QSTOR-10025 ]

Multitenancy
* Fix an issue with missing Service Configs. [ QSTOR-10079 ]
* Add the ability to sync nested shares when parent share is selected in Resilio. Optionally skip changing the share permissions when user is specified in the config file. [ QSTOR-10070 ]

Network Shares
* Block rename of nested shares. [ QSTOR-10091 ]
* Add the ability to enable and clone a GMT snapshot [ QSTOR-4145 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue where Remote Replication Schedules can fail if 2 source snapshots have the same created timestamp. [ QSTOR-10059 ]
* Fix a minor issue with File Age settings in the Backup Schedule Modify dialog. [ QSTOR-10056 ]
* Properly transition a Replication task and Replication Report to the 'failed' status if the source system loses power during the Replication. [ QSTOR-10041 ]
* Add a warning if checkpoint is selected in create snapshot schedule. [ QSTOR-10038 ]

Storage Volumes
* Fixed an issue with zfs storage volumes being correctly marked as missing if the underlying zfs zvol or snapshot is removed or unavailable. [ QSTOR-10086 ]

Upgrade Manager and Installer
* Added a --password option to the qs\_install.sh script to allow users to provide the QuantaStor admin user password as well as the same password for the default qadmin shell account. [ QSTOR-10085 ]

Web Manager
* Clear the replica summary graph when there are no report entries. [ QSTOR-10057 ]
* Fix enclosure graph rendering issue where a selected system with multiple valid controllers was not being render because of one underlying MD BOOT Controller. [ QSTOR-10055 ]

= Archived Change Logs =

== [[Change Log Archive 2023]] ==

== [[Change Log Archive 2022]] ==

== [[Change Log Archive 2021]] ==

== [[Change Log Archive 2020]] ==

== [[Change Log Archive 2019]] ==

== [[Change Log Archive 2018]] ==

== [[Change Log Archive|Change Log Archive pre-2018]] ==

Select the link above to see the [[Change Log Archive]] of older revisions.

QuantaStor 6.8.1 Upgrade Instructions

2026-07-18T15:20:14Z

Qadmin: QuantaStor 6.8.1 upgrade instructions

= Upgrading to 6.8.1, and Latest OS Packages and Security updates via Command Line Interface =

'''This is the recommended option for systems running 6.x QuantaStor versions on the Focal Platform, and systems that may be out of date and require OS level package updates as well.'''

This procedure will upgrade the QuantaStor system to the latest software version, and also update all OS level packages to their latest versions as well, ensuring the system software has the latest security patches in place.

It is recommended that you schedule a downtime work window, as a reboot may be required for changes in the 6.8.1 upgrade. You will need to run these commands as a user with sudo access on the QuantaStor appliance, such as the default 'qadmin' account, or as root if you have enabled direct root access.

:''NOTE: We recommend allocating a maintenance window for all upgrades. For more complex upgrades we recommend scheduling time with OSNEXUS support for assistance.''

'''Login to the CLI to perform a full upgrade to QuantaStor 6.8.1 along with the latest Kernel and Security and OS packages.'''

<pre>
# For Noble platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-noble/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Jammy platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-jammy/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true

# For Focal platforms
# curl -o /opt/osnexus/quantastor/bin/qs_upgrade.py packages.osnexus.com/packages/quantastor-focal/scripts/qs_upgrade.py
# sudo /opt/osnexus/quantastor/bin/qs_upgrade.py --includeKernel=true
</pre>

Once the install completes you will be running QuantaStor 6.8.1

'''Platform Upgrades from Jammy to Noble via the qs-distupgrade command are enabled with the 6.8.1 release.'''

'''Platform Upgrades from Focal to Jammy via the qs-distupgrade command are enabled with the 6.5.1 release.'''

'''Platform Upgrades from Bionic to Focal via the qs-distupgrade command are enabled with the 6.0.4 release.

'''Platform Upgrades from Xenial to Bionic via the qs-distupgrade command are enabled with the 5.10.2 release.

'''OSNEXUS Support recommend fully upgrading to the latest available, including System and Kernel Updates using the commands above. Please contact Support for assistance with a platform upgrade.'''

'''Platform Upgrades via the qs-distupgrade command from QuantStor 4.x on Trusty are enabled with the 4.7.2 release. '''

'''Please contact support@osnexus.com if you have any questions or need upgrade assistance.

QuantaStor Version ChangeLog

2026-07-18T15:20:13Z

Qadmin: Add v6.8.1.007 release notes (QSTOR-11993)

[[Category:Support guide]]
= Change Log Overview =
The change log contains a detailed summary of the changes made for each new release of QuantaStor. Each change made to QuantaStor is tracked with an engineering ticket number in the form '''[QSTOR-NNNN]'''. This information is provided so that if you're working with OSNexus support you can track the availability of a given product feature add, improvement, or maintenance fix to a specific release. For information on how to upgrade your storage system please see the [[QuantaStor Upgrade Guide|Upgrade Guide]].

== Versioning System ==
QuantaStor version numbers consist of four (4) parts. A major number (M), minor number (N), maintenance update number (U) and build number (B) of the form M.N.U.B such as 6.0.2.006.

QuantaStor upgrades go directly from whatever version you are running to the latest version, with no interim steps so for example if you are at v6.0.1 you will upgrade directly to the latest version which may be v6.1.2

== Product Update Types ==

==== Major Updates (X.y.z) ====
If the first digit in the version number has changed this indicates a major product release such as QuantaStor v5 to QuantaStor v6. Major releases generally come with a new underlying Linux platform as the basis. For example, the standard ISO install for QuantaStor v5 is based on Ubuntu 18.04 whereas QuantaStor v6 is based on Ubuntu 20.04. Major product releases generally include new features and maintenance updates and are supported on multiple underlying Linux platforms. For example, QuantaStor v6 is available as an upgrade on Ubuntu 18.04 and Ubuntu 20.04 based systems as well as RHEL and RHEL derivative platforms. Platform upgrades to move systems forward (eg 18.04 to 20.04) are made generally available in the first feature update release, such as QuantaStor 6.1.

==== Feature Updates (x.Y.z) ====
If the second digit in the version number has changed this indicates a feature release such as 6.'''1''' going to 6.'''2'''. Feature releases add new product features as well as a maintenance updates. No additional licensing is required to access any new features that added but note that QuantaStor licenses do not include licenses for 3rd party products and services that may integrate with QuantaStor.

==== Maintenance Updates (x.y.Z) ====
If the third digit of the version number has changed this such as 6.0.'''2''' or 6.0.'''3''' it represents a maintenance update to address one or more support tickets. These updates generally do not contain new features, only fixes to address specific issues. Maintenance releases generally ship every 4 to 8 weeks. All maintenance "aka hot-fix" releases are provided against the current stable release so upgrading to the latest QuantaStor version is generally required to apply them.

==== Build Number (x.y.z.BBB) ====
The build number and corresponding build reference hash can be largely ignored. The build number simply increments with each commit that is made to the source tree. The hash is provided to make it easier for OSNEXUS support and engineering to quickly confirm difference between your current running release and any more modern release.

== Boot Install Image and other downloads ==
=== ISO/DVD/USB Boot Install Image ===

* The latest version of QuantaStor can be found on our [https://downloads.osnexus.com downloads page here].

* [[QuantaStor Installation via USB Thumb Drive|Bootable Flash Drive instructions.]]

NOTE: Archived older versions of QuantaStor ISO install media and CLI tools can be found [https://downloads.osnexus.com.s3.us-east-1.amazonaws.com/list.html here].

= Recent Change Logs =

== v6.8.1.007 (July 18th 2026) ==

=== [[QuantaStor 6.8.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.1 Upgrade Instructions | upgrading to QuantaStor v6.8.1]].

=== Release Notes ===

Upgrade Manager and Installer
* Fixed: platform upgrades remove the obsolete linux-tools-common package that could trigger security alerts. [ QSTOR-10314 ]
* Changed: qs-distupgrade output is timestamped and includes a pre-upgrade configuration report. [ QSTOR-11632 ]
* Added: platform distribution upgrade (qs-distupgrade) from Ubuntu 22.04 to 24.04. [ QSTOR-11651 ]
* Added: non-interactive flags for qs-distupgrade enabling fully unattended platform upgrades with automatic reboot. Use the qs-distupgrade --help to review the available usage options. [ QSTOR-11918 ]
* Fixed: platform distribution upgrades keep Ceph pinned at its current version. [ QSTOR-11955 ]
* Added: qs-distupgrade requires all Ceph nodes on the latest offered Ceph version (--skip-check-ceph-latest to override). [ QSTOR-11958 ]
* Fixed: coordinated Ceph upgrades restart all RGW daemons on hosts running multiple RGW services. [ QSTOR-11983 ]
* Fixed: a 6.8.0-only issue where service-driven package upgrades reported success without installing anything. [ QSTOR-11992 ]

== v6.8.0.205 (July 8th 2026) ==

=== [[QuantaStor 6.8.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.8.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.8.0 Upgrade Instructions | upgrading to QuantaStor v6.8.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert webhook support for Google Chat. [ QSTOR-9793 ]
* Allow users to have a subset of alert subscriptions. [ QSTOR-11683 ]

Ceph Scale-out Block, Object and File
* Added an 'Enable Versioning' checkbox to the Create Bucket dialog (automatically enabled when object locking or governance/compliance is selected); versioning can also be enabled on existing buckets. [ QSTOR-10937 ]
* Added Ceph Tentacle 20.2.2 support to the Jammy QuantaStor ISO and package mirror. [ QSTOR-11441 ]
* QuantaStor 6.8 ships Ceph 20.2.2 (Tentacle), which includes the upstream MDS fix (tracker #76031) for the SIGABRT/crash on client eviction caused by a null MDRequestRef under sustained metadata contention. [ QSTOR-11504 ]
* The Ceph Tentacle 20.2.2 release resolves frequent radosgw (RGW) crashes related to Kafka bucket notifications. [ QSTOR-11687 ]
* Fix ceph bucket delete with large number of objects timing out. [ QSTOR-11728 ]
* Removed: the deprecated S3 bucket orphan-object cleanup feature; any existing scheduled task is disabled automatically on upgrade. [ QSTOR-11729 ]
* Fixed a regression where deleting multiple Ceph (RBD) volumes at once on a multi-node cluster would fail after the first volume. [ QSTOR-11756 ]
* Added support for major-version Ceph upgrades (through Tentacle 20.2.x) in the upgrade script. [ QSTOR-11762 ]
* Increase the timeout for "Add Node" to a ceph cluster [ QSTOR-11906 ]

Dashboards and Analytics
* Added: a 'qs-statsdb resetpassword' command to rotate the InfluxDB stats password; telegraf is updated in lockstep so dashboards keep working. [ QSTOR-11170 ]
* Rebuilt bundled telegraf with its vendored rclone library updated to 1.74.3, clearing CVE-2026-41176 and CVE-2026-41179. [ QSTOR-11771 ]
* Fixed the Ceph RGW dashboard on Ceph Tentacle so it correctly reports throughput/latency when transferring files to a bucket. [ QSTOR-11803 ]

Enclosures and Controllers
* Fixed issue with "disappearing" enclosures [ QSTOR-11676 ]
* Added support for the Supermicro SSG-222B-NE3X24R all-NVMe server, including hardware enclosure auto-detection, enclosure layout and diagram, and NVMe drive slot mapping in the QuantaStor web management interface. [ QSTOR-11712 ]

High Availability Failover
* Add logging for manually run iofence commands [ QSTOR-11751 ]
* Fixed HA pool failover persisting a stale size=0 / isMounted=false when the pool's datasets were still mounting during fast-import; the last-known-good size and mount state are now preserved (and the corrected record wins via a bumped modified timestamp). [ QSTOR-11818 ]
* Fixed: Storage Pool HA io-fencing and failover now work over NVMe-TCP; target namespaces advertise persistent reservations. [ QSTOR-11850 ]

Kernel and Drivers
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]
* Updated the Mellanox OFED driver installer for current Ubuntu 22.04 (Jammy) kernels, fixing driver installation failures on recent kernels. [ QSTOR-11709 ]

Multitenancy
* Added RBD namespace support, allowing multiple tenants to share a single Ceph block pool with isolated volumes. [ QSTOR-11650 ]

NAS Gateway / Cloud Containers
* Add a fix for Samba access to Cloud Container shares. [ QSTOR-11763 ]
* Fixed: cloud containers are now accessible over SMB, not just NFS. [ QSTOR-11824 ]
* Updated the bundled AWS CLI to version 2.35.6. [ QSTOR-11827 ]

Network Interfaces
* Added DOCA OFED install script for jammy and upcoming noble platforms as an optional install for latest hardware. [ QSTOR-11069 ]
* Fixed the Network Interface Rename feature on systems upgraded from older releases where the 'ip' command resides in a different path. [ QSTOR-11614 ]
* Fixed: converting a local VIF to an HA VIF now preserves the original local interface if the conversion fails, so client connectivity isn't lost. [ QSTOR-11706 ]

Network Shares
* Add the ability to specify per user or group permissions on Network Shares during create or modify [ QSTOR-10662 ]
* Fixed: intermittent 'NFS server not responding' stalls under load by raising the nfsd listen backlog from 64 to 4096. [ QSTOR-10872 ]
* Fixed: NFS client entries can now be added or removed on a share while a long-running replication or snapshot task is using it, instead of queuing. [ QSTOR-11571 ]
* Consolidated the Network Share create/modify dialog's Permission Settings into the File Masks tab — now a single 'File Masks & Permission Settings' tab containing Owner Permission Settings plus the Directory and File Create Permissions Masks. [ QSTOR-11625 ]
* Reduced excessive event logging (event spam) for network shares and related grid objects. [ QSTOR-11695 ]
* Fixed handling of CIFS share options so empty/null option values are no longer written to the Samba configuration. [ QSTOR-11731 ]
* Fixed an issue where an Active Directory group added to a share's permissions was not preserved, and excluded built-in/default AD groups from the group picker. [ QSTOR-11767 ]

Remote Replication, Snapshots and Backup Policies
* Copy source Network Share settings to the destination share after replication. [ QSTOR-5738 ]
* Add support for rollback of Storage Volumes and Network Shares for a replication schedule [ QSTOR-6227 ]
* Minor updates to the auto snapshot cleanup tasks for replication schedules. [ QSTOR-11622 ]
* Fix auto create of replication association after failover [ QSTOR-11700 ]
* Snapshot schedule now shows the state detail when schedule is disabled by user. [ QSTOR-11717 ]
* The Snapshot Schedule properties page now displays Retention Tags. [ QSTOR-11719 ]
* Changed: Auto-tier backup policies now display as 'Auto-Tier >> Outbound' instead of 'Move >> Outbound'. [ QSTOR-11764 ]
* Fixed the CLI replication-schedule rollback so volume and share names are accepted (not just IDs), and rolling back only volumes (or only shares) no longer also rolls back the other type. [ QSTOR-11814 ]

SCSI / NVMe Target
* Added: a 'Select Initiator...' picker in the Add Host dialog to choose a discovered FC remote initiator WWPN instead of typing it. [ QSTOR-10741 ]
* Renamed the sys-list 'Firmware Version' column to 'SCSI Target Version' and corrected the value to show the actual SCST target-driver version (e.g. scst-3.10.0.qs01-...) instead of the literal 'scst-SCST'. [ QSTOR-11854 ]

Security
* Added support for Okta multi-factor authentication. [ QSTOR-9399 ]
* Added Multi-Admin Approval support, allowing deletion of pools, buckets, shares, and volumes to require approval from a configurable number of administrators. [ QSTOR-11344 ]
* Fixed certificate update failures when using a certificate template, and ensured dependent services (such as HAProxy and RGW) are restarted after a certificate replacement. [ QSTOR-11678 ]
* Fixed an issue in the Security Manager dialog where it was showing the "password policy change" warning confirmation when no fields were changed. [ QSTOR-11708 ]
* InfluxDB (port 8086) now requires authentication and binds to localhost by default; remote access is opt-in via the tf_influxdb_remote_access.enable touchfile (authentication still enforced). [ QSTOR-11759 ]
* Added the Ubuntu security apt repositories to the default package sources and removed unused bundled components flagged by scanning (Chronograf, the LXD/core20/snapd snaps, the docker-scan plugin), clearing CVE-2024-41110, CVE-2026-34177/-34178/-34179, CVE-2020-14343, CVE-2025-68121, and CVE-2024-45337. [ QSTOR-11760 ]
* Rebuilt the bundled QuantaStor Go tools (qs_iofence, qs_pool_export_helper, qs_diskinfo) and s5cmd with a current Go toolchain, clearing CVE-2025-68121, CVE-2024-45337, CVE-2024-24790, CVE-2023-24540, and CVE-2023-24538. [ QSTOR-11761 ]
* Hardened the internal QuantaStor script service (scriptsvc): removed a command-injection vector in request handling and now enforce the service's authorization check on every call. Addresses ZDI-CAN-30036 [ QSTOR-11799 ]
* Made a number of usability and reliability improvements to the multi-admin delete-approval workflow. [ QSTOR-11804 ]

Service Core
* Fix tag-set where custom key/value tags were not appearing for User objects. [ QSTOR-11528 ]
* Improved Ceph OSD daemon restart handling during upgrades and reduced database load on large-scale clusters. [ QSTOR-11675 ]
* Fixed an issue with QuantaStor management service memory usage when a grid node was offline. [ QSTOR-11693 ]
* Improved crash handling and diagnostic tracing for coordinated tasks, during operations such as adding a Ceph RADOS Gateway across multiple nodes. [ QSTOR-11702 ]
* Improved logging and error checking for QuantaStor configuration database backups, including capturing error output when a backup fails. [ QSTOR-11742 ]
* Expanded diagnostic log collection to capture additional network routing details (ip route output and static-route configuration). [ QSTOR-11748 ]
* Fixed the Sessions view showing stale SMB/NFS client sessions that lingered after a reboot; the share session monitor now forces a full re-sync on its first poll after startup so sessions left over from before the reboot are cleared. [ QSTOR-11757 ]
* Fixed a self-sustaining grid event flood triggered when creating CephFS/CIFS network shares at scale: nodes no longer re-cache remote-origin (sync-applied) events, and CIFS options are diff-merged to secondaries, eliminating the event resync cascade. [ QSTOR-11785 ]
* qs-sendlogs now writes a qs_logs.runtime.info file recording the options and variables used during log collection, and reliably scrubs sensitive data from the collected database. [ QSTOR-11897 ]

Storage Pool Management
* Added automated ordered-disk-list pool creation for Seagate Corvault and WD Data24 systems, simplifying creation of fully redundant storage pools. [ QSTOR-11538 ]
* Fixed software-encrypted pool creation so a disk block-size mismatch is detected before disks are encrypted, avoiding leftover encryption mappings. [ QSTOR-11599 ]
* ZFS deduplication now uses the faster fast_dedup mode by default, improving sustained deduplication performance. [ QSTOR-11714 ]
* When a LUKS-encrypted disk member of a pool momentarily goes offline and the hot-spare swap-in completes, if the "bad" disk in question has in the meantime come back online, its iofence status, encryption status and its related properties in its respective disk object are cleared up, making the disk available for use again. [ QSTOR-11738 ]
* Resolved a boot-time race where the OS-level zfs-import-cache.service could import ZFS pools before qs_service started. QuantaStor now imports pools with cachefile=none, masks the zfs-import-cache and zfs-import-scan services on install and upgrade, and clears the stale global ZFS cache file at boot, ensuring QuantaStor remains the sole coordinator of pool imports. [ QSTOR-11752 ]
* Add the ability to create a Storage Pool checkpoint for scale-up pools [ QSTOR-11784 ]
* Added a support-only, touchfile-gated pool-export triage call-out (qs_pool_export_triage.sh) that gathers diagnostics when a share or volume is still open during a storage pool export. Off by default (enabled via the tf_pool_export_triage.enable touchfile). [ QSTOR-11807 ]
* Resolved issue preventing HA failover functionality using SED drives. [ QSTOR-11832 ]

Upgrade Manager and Installer
* Added retry logic with a timeout to the Ceph upgrade script's daemon restarts so transient restart failures no longer abort the upgrade. [ QSTOR-10598 ]
* Fixed focal-to-jammy distribution upgrades leaving the HA cluster service (pcsd/pacemaker) inoperative due to a missing ruby-webrick dependency on Ruby 3.0+. The upgrade now installs ruby-webrick so HA failover keeps working. [ QSTOR-11841 ]
* Fixed focal-to-jammy distribution upgrades that could abort and roll back when Ubuntu's unattended-upgrades/apt-daily held the apt lock or needrestart blocked on a prompt. QuantaStor now disables automatic apt upgrades and runs the distribution upgrade non-interactively. [ QSTOR-11874 ]
* Fixed a Noble (24.04) upgrade failure where qs-upgrade aborted because the dpkg package version string could not be parsed. QuantaStor now compares Debian package versions using dpkg's native version ordering. [ QSTOR-11881 ]

Web Manager
* Minor fix to the "Copy to Clipboard" for task descriptions [ QSTOR-9574 ]
* Added a method field and a sortable timestamp column to the web interface Audit Log Analyzer. [ QSTOR-11191 ]
* Updated web interface translations across the major supported languages. [ QSTOR-11585 ]
* Added a 'Create Share' option to the share template menu to quickly create a share applying all of a template's settings. [ QSTOR-11595 ]
* Fixed the web interface to display all configured Ceph MDS daemons instead of limiting the list to five. [ QSTOR-11615 ]
* Add auto select convenience buttons to the Storage Volume multi-delete dialog. [ QSTOR-11707 ]

== v6.7.6.001 (June 25th 2026) ==

=== [[QuantaStor 6.7.6 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.6 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.6 Upgrade Instructions | upgrading to QuantaStor v6.7.6]].

=== Release Notes ===

Storage Pool Management
* Fixed a service crash that could occur when creating a LUKS-encrypted storage pool on NVMe devices. [ QSTOR-11876 ]

== v6.7.5.013 (May 21st 2026) ==

=== [[QuantaStor 6.7.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.5 Upgrade Instructions | upgrading to QuantaStor v6.7.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added alert triggers for disks with SMART medium errors. [ QSTOR-11652 ]

Ceph Scale-out Block, Object and File
* Adds new qs-cephfsutil for transparent movement of files between data pools via server-side copy [ QSTOR-11543 ]

Kernel and Drivers
* Added RedHat Platform kernel 4.18.0-553.124.1.el8_10.x86_64 support via DKMS driver build [ QSTOR-11679 ]
* Updated SCST driver to 3.10.0.qs01.9273.1b48521 with a patch that allows for dkms builds/support on non-preferred 5.15.x kernels on jammy platforms. [ QSTOR-11672 ]

Remote Replication, Snapshots and Backup Policies
* Minor fix while loading snapshots in the UI. [ QSTOR-11624 ]

Service Core
* Fixes bug where partial upgraded node would be skip daemon restart phase at version check. [ QSTOR-11703 ]
* Fixed a rare race condition where adding a Ceph Object (RADOS) Gateway on a multi-node cluster could silently crash. [ QSTOR-11689 ]
* Added defensive exception handling and trace coverage around coordinated task execution. [ QSTOR-11689 ]

Storage Pool Management
* Fix allows for creation of TRIM maintenance schedules on pools with special vdevs. [ QSTOR-11663 ]

Web Manager
* Add graphs for replication task status details. [ QSTOR-11661 ]
* Make improvements in the replication reporting area. [ QSTOR-11661 ]

== v6.7.4.011 (April 30th 2026) ==

=== [[QuantaStor 6.7.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.4 Upgrade Instructions | upgrading to QuantaStor v6.7.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Eliminated daily Ceph monitor outage on coordinator nodes caused by the mon-db backup process; the backup now uses a RocksDB compaction flush and hot-copy so the monitor service remains running throughout, and backup activity is now logged to qs_service.log. [ QSTOR-11655 ]

Enclosures and Controllers
* Fixed issue regarding hwController/hwEnclosure double discovery caused by the presence of certain Dell HBA cards that are visible to both the storcli and perccli CLI tools. [ QSTOR-11372 ]

Network Interfaces
* Fixed an issue with the allowed portals for iscsi and nvme being updated on network ports or having the settings retained on HA VIFs. [ QSTOR-11659 ]

Remote Replication, Snapshots and Backup Policies
* Improvements in the replication reports. [ QSTOR-11644 ]

Service Core
* Updated task output for storage system modify to improve clarity [ QSTOR-11660 ]
* Coordinated Task (CCT) Reliability Improvements — Fixed an issue on large or heavily-loaded Ceph clusters where CCT broadcasts could silently hang until timeout. [ QSTOR-11648 ]

Upgrade Manager and Installer
* Updated kmod and libkmod2 packages for ubuntu jammy and focal platforms to disable algif_aead and address CVE-2026-31431 [ QSTOR-11670 ]

== v6.7.3.010 (April 17th 2026) ==

=== [[QuantaStor 6.7.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.3 Upgrade Instructions | upgrading to QuantaStor v6.7.3]].

=== Release Notes ===

High Availability Failover
* Fixed an issue where Site Clusters could not be deleted in cases where the site cluster was unhealthy. For example if the Network Interfaces or IP addresses on the interface change for the heartbeat rings. Or if the site cluster corosync/pacemaker service are stopped. [ QSTOR-11631 ]
* Fixed a corner case where Site cluster vifs could start on nodes outside of the site cluster. [ QSTOR-11630 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Volume _chkpnt Replications on N-Way A>B>C replications being incorrectly named. they B>C leg should have _chkpnt.1 as the target suffix for the replication. [ QSTOR-11477 ]

Service Core
* Added further optimizations for Grid sync on large configs with many QuantaStor service objects. [ QSTOR-11628 ]

Storage Pool Management
* Fixed: SED disk Locked status is now propogated using grid logic for disks once a disk is used for Hardware encryption. Previously this required an HA group to also be on the pool. [ QSTOR-11611 ]
Fixed a corner case where SED Device Capabilities was showing as No for multipath disks plugged in twice to the same controller. [ QSTOR-11611 ]

== v6.7.2.003 (April 13th 2026) ==

=== [[QuantaStor 6.7.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.2 Upgrade Instructions | upgrading to QuantaStor v6.7.2]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue where some Enclosure objects would appear showing \[CBLERR\] when that status was incorrect. [ QSTOR-11135 ]

Network Shares
* Added a qs_global_namespace.conf file for users to provide a specific IP address to be offered for Microsoft DFS with the preferred_ip=x.x.x.x [ QSTOR-11627 ]
* Updated Jammy platform nfs-kernel-server and related nfs-utils packages to include junction support needed for NFS Referrals. [ QSTOR-11626 ]

== v6.7.1.008 (April 10th 2026) ==

=== [[QuantaStor 6.7.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.1 Upgrade Instructions | upgrading to QuantaStor v6.7.1]].

=== Release Notes ===

Network Shares
* Fix an issue with snapshot cleanup by the replication schedule. [ QSTOR-11621 ]

Security
* Upgrade the Cisco Duo library to 2.2.0 [ QSTOR-11592 ]

Upgrade Manager and Installer
* Disable and mask openzfs util zfs-shares.service which caused unexpected Share service restarts. [ QSTOR-11619 ]
* Fixed an issue with qs-distupgrade from Focal to Jammy Platforms of systems that had been originally deployed with bionic and older platforms. [ QSTOR-11616 ]
* Ensured the 6.8.0-90-generic kernel is deployed during Focal to Jammy Platform distupgrades. [ QSTOR-11616 ]

== v6.7.0.184 (April 8th 2026) ==

=== [[QuantaStor 6.7.0 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.7.0 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.7.0 Upgrade Instructions | upgrading to QuantaStor v6.7.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Add a 'Skip log server ping pre-checks' checkbox to the Send Support Logs dialog. The server will skip ping checks during log upload when the checkbox is checked. [ QSTOR-11397 ]
* Fixed an issue with clearing parent interface status alerts in the Health Checker System report [ QSTOR-11058 ]
* Add ability to specify reason for log uploads [ QSTOR-10479 ]

Ceph Scale-out Block, Object and File
* Fixed a QuantaStor service crash for Ceph scale-out file storage share snapshot delete [ QSTOR-11570 ]
* Adds support for new load balancer modes and customization in the /opt/osnexus/quantastor/conf/qs_loadbalancer.conf file. [ QSTOR-11502 ]
* Improved the method of tracking degraded object cleanup and reporting progress to the task objects. [ QSTOR-11292 ]
* Bug fixes in qs-s3util script when an invalid endpoint URL is provided. [ QSTOR-11292 ]
* Improved object state reporting for OSDs. [ QSTOR-11292 ]
* Fixed an issue with unlocking NVMe SED media on boot for Ceph Scale-out Cluster OSDs [ QSTOR-11118 ]
* Enabled Ceph OSD block and journal discard support [ QSTOR-10672 ]

Dashboards and Analytics
* Fixed an issue with influxdb install for qs\_upgrade\_redhat8.sh [ QSTOR-11562 ]

Disk Management
* Added logic to make SED Locking status consistent between QuantaStor Scale-Up ZFS HA Storage Pools. Note: Pools must have an HA group and HA Vif and be activated. [ QSTOR-11515 ]
* Added error counters for disks with available columns in the center grid view of the Physical Disks section. [ QSTOR-11308 ]

Enclosures and Controllers
* Added Enclosure layout support for Supermicro SSG-542B-DE1CR90 [ QSTOR-11572 ]
* This feature allows servers equipped with the Xinnor XiRAID software [ QSTOR-11374 ]

* Create a XiRAID raid unit, which appears as a QS HwUnit. [ QSTOR-11374 ]
* This HwUnit entity is surfaced in Quantastor as a physical disk drive. [ QSTOR-11374 ]
* The physical disks that are used to create the XiRaid unit are surfaced as HwDisks.[ QSTOR-11374 ]
* The creation includes a variable number of partitions on said physical disk.[ QSTOR-11374 ]
* These partitions are also surfaced as QS physical disks.[ QSTOR-11374 ]
* These partition-based physical disks can be used to create Ceph OSD objects. [ QSTOR-11374 ]
* Updated Storcli64 version to 007.3603.0000.0000 [ QSTOR-10911 ]

High Availability Failover
* Fixed an issue with FC ALUA path status when HA groups are disabled and HA VIFs are not present. [ QSTOR-11598 ]

Kernel and Drivers
* Updated kernel 6.8.0-90-generic drivers include intel ixgbe driver version 6.3.4 [ QSTOR-11524 ]
* Updated Jammy Platform installer ISO image to 22.04.5 [ QSTOR-11380 ]
* Updated Jammy platform Kernel to 6.8.0-90-generic [ QSTOR-10903 ]
* Updated Jammy platform ZFS driver to 2.3.5 [ QSTOR-10903 ]
* Updated Jammy platform SCST driver to 3.10 [ QSTOR-10903 ]
* Updated Jammy platform mpi3mr driver to 8.15.1.0.0 [ QSTOR-10903 ]

Multitenancy
* Changed Object User Create dialog text to more accurately reflect that it refers to Object Users/Tenants, and not Multitenancy objects [ QSTOR-9803 ]

Network Interfaces
* Fixed an issue where MTU values were being written to the VLAN interface configuration files. [ QSTOR-11552 ]

Network Shares
* Added further checks to Network Share Delete to verify the underlying ZFS filesystem properties has a matching OSNEXUS QuantaStor share ID before removing. [ QSTOR-11525 ]
* Auto populate the AD dialog with Organization Unit of specified on other systems in the grid [ QSTOR-11519 ]
* Add more options to filter shares in the delete dialog [ QSTOR-11499 ]

Remote Replication, Snapshots and Backup Policies
* Adds a new '--snapshots-with-holds-only' option to qs share-list and volume-list to list snapshots with holds on them. [ QSTOR-11388 ]

SNMP
* Update SNMP MIB [ QSTOR-11602 ]

Security
* When updating a certificate via cert-update, the relevant service (e.g. HAProxy) is now
automatically restarted to pick up the new certificate. Additionally, cert-update and
cert-rescan now accept the storage system by name or UUID. [ QSTOR-11529 ]
* Updated WebUI to have System Use Notification dialog/message display before user login dialog. [ QSTOR-11174 ]

Service Core
* Strip any invalid XML characters from description fields causing WebUI to not load [ QSTOR-11566 ]
* Cleaned up some repetitive log spam from the Blink Manager and the storcli hardware adappter [ QSTOR-11551 ]
* Fixed event spam and potential crash during Ceph daemon upgrade on large grids. [ QSTOR-11510 ]
* Fixes bug in site cluster maintenance mode logic. [ QSTOR-11489 ]
* Fixed an issue where the iSCSI/NVMe flag settings were not being retained for site cluster vifs after moving the vif to a new node. [ QSTOR-11464 ]
* Added support for LACP layer2+3 xmit\_hash\_policy [ QSTOR-11400 ]

Storage Pool Management
* Add more storage system tuning parameters [ QSTOR-11549 ]
* Added discard to LUKS options for NVMe model disks on ZFS Scale-Up Storage Pools with encryption. [ QSTOR-11501 ]

Upgrade Manager and Installer
* Fixed a throw in the qstorservice package install if the radosgw-admin command is not available [ QSTOR-11579 ]
* Fixed the qs-upgrade for kernel upgrades to ensure recommended packages for qstortarget are installed if they were previously manually removed. [ QSTOR-11556 ]

Web Manager
* When selecting Create Share from an existing selected share in the tree view, ensure the correct Storage Pool is selected in the Create Share dialog. [ QSTOR-11591 ]
* Create a new share template system for users to reuse settings from existing network shares. [ QSTOR-11314 ]

== v6.6.11.017 (March 5th 2026) ==

=== [[QuantaStor 6.6.11 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.11 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.11 Upgrade Instructions | upgrading to QuantaStor v6.6.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added a check to alert on SSL certificate expiration for the certificate manager managed certs. [ QSTOR-11462 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with rekeying scale-out ceph OSD's on Seagate Corvault backend external storage systems [ QSTOR-11206 ]

Disk Management
* Fixed an issue with SED media when adding as a hot-spare / for repair of a failed storage pool disk. [ QSTOR-11531 ]
* Fixed an issue where SSD Life Left status showing on multipath devices. [ QSTOR-11463 ]

Enclosures and Controllers
* Added Enclosure support from multiple Manufacturers such as Seagate, Gigabyte, Supermicro etc. [ QSTOR-11498 ]
* Fixed items related to the Intel 2u12 enclosure layout [ QSTOR-11286 ]
* Fixed Items related to the Supermicro 90-bay enclosure layout [ QSTOR-10932 ]

Network Shares
* Fix to allow creation of Network Shares with record size greater than 1M (1M, 2M, 4M, 8M). [ QSTOR-11535 ]

Security
* Fixed a few items related to Grafana default security ports [ QSTOR-11526 ]
* Fix configuration file manager file paths for telegraf.qstor and influxdb.qstor. [ QSTOR-11526 ]
* Fixed some items related to software encrypted HA storage pools management of /etc/crypttab [ QSTOR-11416 ]

Service Core
* Fixed some items related to QuantaStor Management Service database transactions [ QSTOR-11527 ]

== v6.6.10.006 (February 23rd 2026) ==

=== [[QuantaStor 6.6.10 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.10 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.10 Upgrade Instructions | upgrading to QuantaStor v6.6.10]].

=== Release Notes ===

Network Shares
* Fixed a service crash with Network share global Namespaces [ QSTOR-11518 ]
* Fixed an issue with AD join. [ QSTOR-11514 ]
* Fixed an issue with Seagate Corvault vpd83 parsing [ QSTOR-11518 ]

== v6.6.9.002 (February 13th 2026) ==

=== [[QuantaStor 6.6.9 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.9 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.9 Upgrade Instructions | upgrading to QuantaStor v6.6.9]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash when upgrading QuantaStor on Systems configured with Scale-Out storage. [ QSTOR-11509 ]

== v6.6.8.004 (February 11th 2026) ==

=== [[QuantaStor 6.6.8 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.8 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.8 Upgrade Instructions | upgrading to QuantaStor v6.6.8]].

=== Release Notes ===

Service Core
* Fixed a QuantaStor management service crash for Network Interface discover logic [ QSTOR-11507 ]
* Fixed a service crash in Scale-out bucket discovery logic. [ QSTOR-11505 ]

== v6.6.7.017 (February 9th 2026) ==

=== [[QuantaStor 6.6.7 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.7 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.7 Upgrade Instructions | upgrading to QuantaStor v6.6.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Optimized grid communication paths and reduced database read frequency by improving internal object caching mechanisms. [ QSTOR-11473 ]
* Show compression ratio in the Scale-out Storage Pool grid. It is hidden by default. [ QSTOR-11130 ]

Disk Management
* Fixed an issue where a NVMe quick secure erase would be executed when formatting disks used for new storage pool creation [ QSTOR-11478 ]
* Fixed an issue where quick secure erase reformated the NVMe disk with a new namespace using a 512K sector size. [ QSTOR-11478 ]

Enclosures and Controllers
* Recertify Quantastor with the gen4 series of Western Digital Data24 [ QSTOR-11479 ]
* Fix up the config file defaults for NVMe software adapter when logging into a NVMe WD Data24. [ QSTOR-11470 ]

Network Shares
* Fix an issue with password shown in the service log during AD join [ QSTOR-11483 ]
* Add the ability to select multiple shares using the ctrl key in the share multi-delete dialog [ QSTOR-9181 ]

Web Manager
* Fixed a minor issue with file masks in modify Network Share [ QSTOR-11495 ]

== v6.6.5.026 (January 16th 2026) ==

=== [[QuantaStor 6.6.5 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.5 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.5 Upgrade Instructions | upgrading to QuantaStor v6.6.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Adds alerts in the event a Corvault device is in a warning or missing state. [ QSTOR-11411 ]

Ceph Scale-out Block, Object and File
* Fix an issue with creation of S3 user on a secondary zone. User will be created on the master zone. [ QSTOR-11438 ]
* Fixed an Issue with the Ceph initial PG calculations when creating ceph storage pools on HDD and SSD based OSDs. [ QSTOR-11437 ]
* Fix a minor issue with bucket sync when bucket originates on a secondary zone [ QSTOR-11435 ]
* Add granular options for object bucket rescan. [ QSTOR-11312 ]

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11436 ]
* Fix a row selection issue in the central pane on the External Media and Port grids. Show the 'Used By' column for External Volumes. [ QSTOR-11384 ]

High Availability Failover
* Fixed an issue with the Storage Pool Health check on systems with high load. [ QSTOR-11454 ]
* Fixed an issue with HA storage Pools in a degraded warnign state. [ QSTOR-11451 ]
* Reduced scale-out Object logging for site cluster vifs to debug level. [ QSTOR-11448 ]

Network Shares
* Fixed an issue with joining AD domains using SSSD+Winbind [ QSTOR-7845 ]

SNMP
* Updated SNMP MIB [ QSTOR-11456 ]

Security
* Enabled HTTPS redirect mode in QuantaStor WebUI by default during new Installs and upgrades to version 6.6.5 and newer. [ QSTOR-11368 ]
* Added a custom script callout via a security-message-update for the Security manager System Usage Notification contents: [ QSTOR-11222 ]
[https://wiki.osnexus.com/index.php?title=QuantaStor\_Custom\_Scripting\_/\_Application\_Extensions\#/var/opt/osnexus/custom/security-message-update.sh](https://wiki.osnexus.com/index.php?title=QuantaStor_Custom_Scripting_/_Application_Extensions#/var/opt/osnexus/custom/security-message-update.sh)

Service Core
* Added minimum timeout value to Coordinated tasks [ QSTOR-11455 ]
* Optimized Grid logic for Scale-out Object Bucket discovery on deployments with a large amount of ceph buckets. [ QSTOR-11433 ]
* Fixed an issue with License Key activation verification [ QSTOR-11110 ]

== v6.6.4.001 (December 17th 2025) ==

=== [[QuantaStor 6.6.4 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.4 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.4 Upgrade Instructions | upgrading to QuantaStor v6.6.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fix an issue where the S3 Object User Create fails when the User is not a Tenant member. [ QSTOR-11432 ]

== v6.6.3.033 (December 16th 2025) ==

=== [[QuantaStor 6.6.3 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.3 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.3 Upgrade Instructions | upgrading to QuantaStor v6.6.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Raise alerts when OSDs are down. [ QSTOR-11415 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with object user create under a tenant with multi-site is enabled for two zones. [ QSTOR-11427 ]
* Fix an issue with bucket sync policy create on the secondary zone bucket. [ QSTOR-11426 ]
* Allow selection of any object gateway when setting up ceph multi-site configuration. [ QSTOR-11409 ]

Enclosures and Controllers
* Adds enclosure management support for Supermicro Server SSG-522B-ACR12L [ QSTOR-11422 ]
* Change external volumes, media and volume grids from grouping to non-grouping for a minor performance improvement. Re-order Corvault columns in central grid (External Systems). Only show volumes for the currently selected Corvault. [ QSTOR-11370 ]

High Availability Failover
* Added a check to the site cluster to ensure that a user cannot set the final active node in a site cluster into standby. This is to prevent all nodes in a site cluster or HA pair from both being in standby and not serving any resources. [ QSTOR-11402 ]

Network Interfaces
* Fixed an issue where modifying the iscsi/nvme portal port settings on a VLAN or VIF interface would cause the parent interface to be restarted [ QSTOR-11406 ]
* Fixed an issue with importing LACP options in the /etc/network/interfaces file. [ QSTOR-11396 ]
* Updated the LACP bond-xmit-hash-policy options to use the modern text option names instead of the legacy numerical values. [ QSTOR-11396 ]

Network Shares
* Added 'qs-util nfsrdma' command to enable nfs rdma support for systems that have NFS RDMA supported hardware and drivers. [ QSTOR-11309 ]
* Auto detect when the AD server goes down and raise an alert. [ QSTOR-11182 ]
* Fixed issues with SSSD AD Join [ QSTOR-11335 ]

SNMP
* Updated SNMP MIB [ QSTOR-11428 ]
* Fixed a few items related to the SNMP agent stability. [ QSTOR-11405 ]
* Added logic to ensure new nodes joined to the grid get the snmp agent deployed on them with the same settings and snmp user. [ QSTOR-11393 ]

Security
* Removed default nginx index.html and version reporting from nginx. [ QSTOR-11351 ]

Service Core
* Extended timeout values for coordinated task finishing stage throughout the service. This will help prevent grid communication errors that are caused in high latency environments. [ QSTOR-11421 ]
* Enhanced grid logic for High Latency multi-site deployments. [ QSTOR-11391 ]

Upgrade Manager and Installer
* Added protections to ensure zfs pools are not imported incorrectly on a passive HA node during upgrade processes that update the grub configuration. [ QSTOR-11413 ]

Web Manager
* Add a tooltip to the Force checkbox on the Storage System Restart and Shutdown dialogs to clarify it's for immediate, unclean shutdowns. [ QSTOR-11381 ]

== v6.6.2.003 (November 14th 2025) ==

=== [[QuantaStor 6.6.2 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.2 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.2 Upgrade Instructions | upgrading to QuantaStor v6.6.2]].

=== Release Notes ===

Enclosures and Controllers
* Reduced the frequency of Corvault device discovery for External Storage System Enclosures per Seagate Recommended values. [ QSTOR-11367 ]

Security
* Updated QuantaStor Tomcat version to 9.0.112 [ QSTOR-11376 ]
* Fix a regression in single sign on failing to login AD users. [ QSTOR-11375 ]
* Enhanced Grid communication event batching that can help with large numbers of QuantaStor Grid object counts. [ QSTOR-11366 ]

== v6.6.1.013 (November 7th 2025) ==

=== [[QuantaStor 6.6.1 Upgrade Instructions | Upgrade Instructions]] ===
Click [[QuantaStor 6.6.1 Upgrade Instructions | here]] for instructions on [[QuantaStor 6.6.1 Upgrade Instructions | upgrading to QuantaStor v6.6.1]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Removed rgw gc optimizations that are no longer needed for modern ceph versions. [ QSTOR-10920 ]

Enclosures and Controllers
* Added some new warning icons for hardware controllers, hardware units and hardware disks. Fixed icon priority for status on hardware enclosures. [ QSTOR-11358 ]
* Fixed an issue with discovery of Hardware RAID Disks for LSI Hardware RAID controllers that use the storcli tool. [ QSTOR-11347 ]
* Fixed an issue with enclosure discovery for older LSI SAS HBA controllers that utilize sas3ircu [ QSTOR-11209 ]

High Availability Failover
* Fixed an issue with HA failover for storage pools that have multipath disks with -part1- in the device name. [ QSTOR-11373 ]

Security
* Fixed a possible SQL Injection during Login. [ QSTOR-11365 ]

Service Core
* Changes haproxy logrotate to be hourly by default. [ QSTOR-11349 ]
* Updated the QS PyClient Code in the github repo. [ QSTOR-11346 ]

== v6.6.0.362 (October 9th 2025) ==

=== [[QuantaStor 6.6.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.6.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.6.0 Upgrade Instructions| upgrading to QuantaStor v6.6.0]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Block rename of object pool group. [ QSTOR-11336 ]
* Add a fix so auto-tier rules can be set on multiple ceph clusters [ QSTOR-11323 ]
* Fixes bug with OSD replace prepare context menu button when called from the enclosure view. [ QSTOR-11313 ]
* Fixed: added duplicate zone check for Object Group Create [ QSTOR-11266 ]
* Add indication on the journal group if it is encrypted. [ QSTOR-11261 ]
* Updated Ceph version on Focal and Jammy platforms to 18.2.7 [ QSTOR-11129 ]
* Generate proper caps for keyring when using additional pools in CephFS [ QSTOR-11106 ]
* Display S3 user information in the delete user dialog to distinguish between S3 user and local user. [ QSTOR-10723 ]
* New feature adds the ability to modify RGW settings. Added the ability to add and remove load balancers on each Ceph cluster member. [ QSTOR-10623 ]
* Added support for Portal Groups for FC and iSCSI Targets [ QSTOR-10533 ]
* Add the ability to control synchronization for selected buckets in two objects storage clusters. [ QSTOR-10346 ]
* Add ability to specify multiple pools in a ceph file system. [ QSTOR-8674 ]

Dashboards and Analytics
* Add a new bucket dashboard that reports Average Total Objects and Average Utilized Space. [ QSTOR-11259 ]

Disk Management
* Adds an NVMe quick format to the Physical Disk Format dialog using the secure erase options. [ QSTOR-10688 ]

Enclosures and Controllers
* Fixed various items related to Linux Software RAID adapter support. [ QSTOR-11198 ]

Multitenancy
* Scope the access of user accounts so that they can only manage users, buckets, keys and other resources related to the tenant in the resource group they're a member of [ QSTOR-11326 ]
* Allow CephFS shares to be added to a Resource Group. [ QSTOR-11007 ]

Network Shares
* Share rename needs a force flag as it may disconnect NFS clients. [ QSTOR-11337 ]
* Provides an optional backported version of samba via a 'qs_samba_jammy_optional.sh' install script that includes a version of samba required to address the ad rfc2307 changes Microsoft introduced in KB5062572. Note this samba version does not include sssd support and so will not be installed by default. It should only be used for those customers using ad rfc2307 mode. [ QSTOR-11319 ]

Security
* Adds the ability to add and remove SSL certificate templates. Using those templates you can update the certificates for HaProxy and Rados gateways configured for HTTPS. [ QSTOR-9016 ]

Service Core
* Eliminates common errors in active directory join process, prepopulating dialog from previously joined systems [ QSTOR-11015 ]
* Added support for shutting down or restarting multiple systems at once [ QSTOR-10022 ]
* Added an optional force flag to Storage System Restart and Shutdown Dialogs to provide an option for immediate sysrq based shutdown of the system [ QSTOR-10022 ]

SNMP
* Updated SNMP MIB [ QSTOR-11343 ]

Storage Volumes
* Allow rename of Scale Out block storage volumes [ QSTOR-11311 ]
* Fix an event issue where the Volumes count was not getting updated in the central Host grid view. [ QSTOR-11038 ]

Universal Containers
* Add Universal Container support to the server and the Create Config dialog in the WUI. [ QSTOR-11194 ]

Upgrade Manager and Installer
* verified that packages are being installed properly with the new iso filtering stuff [ QSTOR-11030 ]

Web Manager
* Minor fix to the modify Network Port dialog. [ QSTOR-11302 ]
* Added the ability to save a local copy of a report schedule. [ QSTOR-11217 ]
* Simplifies active directory join and leave process, allowing multiple systems to join or leave at once [ QSTOR-8771 ]

== v6.5.12.005 (September 22nd 2025) ==

=== [[QuantaStor 6.5.12 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.12 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.12 Upgrade Instructions| upgrading to QuantaStor v6.5.12]].

=== Release Notes ===

Enclosures and Controllers
* Fixed vendor/model defaulting, improved enclosure layout auto-selection in the Modify Storage System dialog (including correct child-layout selection to choose the primary NVMe drive group), and resolved an invalid enclosureLayoutId that prevented layout auto-detection. [ QSTOR-11263 ]

Security
* Fixed: disable gzip compresson on web and api ports by default. [ QSTOR-11210 ]
* Fixed: internal qs-statsd/qs_restd service port 5173 moved to localhost only as it should not be presented as an external port. [ QSTOR-11210 ]
* Fixed: reduced syslog logging of qs-statsdb/qs_restd. [ QSTOR-11210 ]
* Added: DROP rules to block ICMP timechecks [ QSTOR-11210 ]
* Updated SSL Ciphers and TLS1.3 support for the web and API ports [ QSTOR-11210 ]
* Fixed: Set pcsd api port 2224 to bind to localhost only by default [ QSTOR-11210 ]

== v6.5.11.029 (August 28th 2025) ==

=== [[QuantaStor 6.5.11 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.11 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.11 Upgrade Instructions| upgrading to QuantaStor v6.5.11]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added support for SMTP servers that allow open relay with no username/password to the Alert Manager [ QSTOR-11167 ]

Ceph Scale-out Block, Object and File
* Fixed an issue with multiple alerts occurring for long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Fixed some corner case issues with long running OSD replace prepare tasks. [ QSTOR-11276 ]
* Added support for larger MDB devices upto 2100GB [ QSTOR-11274 ]
* Added support for encryption bypass on OSD create while still encrypting wal/db journal devices. [ QSTOR-11260 ]

Disk Management
* Fixed an issue with running the disk read performance test benchmark on very fast modern media. [ QSTOR-11296 ]

Enclosures and Controllers
* Fixed Enclosure and Controller discovery support for SAS3516 based SAS controllers [ QSTOR-11267 ]

High Availability Failover
* Fix an issue with VIF used for scale-out file usage after rebooting all nodes in the cluster. [ QSTOR-11265 ]

Network Interfaces
* Fixed: added gfortran-11 dependency to jammy repository required for LTS mellanox ofed install to succeed [ QSTOR-11285 ]
* Add QS cli command to hide disabled Network Ports [ QSTOR-10898 ]
* Fixed an issue where VLAN and VIF interfaces would not report their bond mode correctly if their parent interfaces was a bonded port. [ QSTOR-10754 ]

Network Shares
* Adds support for multiple HA VIF redirects and smart network filtering for NFSv4 referrals [ QSTOR-11278 ]
* Minor fix to skip NFS export commands for scale out shares. [ QSTOR-11275 ]

Quantastor CLI
* Provide a utility to create temporary log download links via qs-download-link [ QSTOR-11273 ]

SCSI / NVMe Target
* Fixed: Added logic to always default FC ports to target mode for supported FC target card models from QLogic. Ports can still be explicitly set to initiator mode if the user so chooses. [ QSTOR-10744 ]

Service Core
* Fixed: added the option to cancel the Physical Disk Identify task if the duration for the identify task is longer than the user wants. [ QSTOR-11258 ]
* Provide a download link for log collection in case logs cannot be uploaded from a Quantastor system [ QSTOR-11116 ]

Upgrade Manager and Installer
* Fixed: added proxy settings to the /etc/apt/apt.conf.d/80proxy file [ QSTOR-11281 ]
* Fixed: added logic to the upgrade manager and qs-upgrade command to check for missing version pinning if qs-util aptnopin has been run on the system. The upgrade task will fail early if correct pinning is not in place advising running qs-util aptpin. [ QSTOR-11277 ]

Web Manager
* Fixed: clarified text in create resource group for network share access of service containers [ QSTOR-11187 ]

== v6.5.10.013 (August 12th 2025) ==

=== [[QuantaStor 6.5.10 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.10 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.10 Upgrade Instructions| upgrading to QuantaStor v6.5.10]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where the access key and secret key were not updating in the UI in instances with multiple object storage users across multiple ceph clusters in the same grid. [ QSTOR-11254 ]
* Fixed an issue with the cephfs mounts if communication is lost with the active MDS and a new MDS is elected. [ QSTOR-10738 ]

Enclosures and Controllers
* Fix an enclosure refresh issue via the event path where the underlying disk were not getting refreshed. [ QSTOR-11247 ]
* Fixed: Added additional checks for enclosure id on enclosures that fail to report correctly on older firmwares. [ QSTOR-11227 ]

Service Core
* Fixed: replaced size with maxsize in the ceph, radosgw and haproxy logrotate definitions so that they rotate as expected on their daily rotations as well as when reaching the max size definition. [ QSTOR-11253 ]
* Fix an underlying dashboard issue where new diskio entries were not properly added to the telegraf.conf file on new deployments. [ QSTOR-11246 ]
* Fix: Optimize the restarting of influx and telegraf. [ QSTOR-11246 ]

== v6.5.9.003 (August 5th 2025) ==

=== [[QuantaStor 6.5.9 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.9 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.9 Upgrade Instructions| upgrading to QuantaStor v6.5.9]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with slotmap updates when changing the slotmap in the enclosure and controllers section. [ QSTOR-11245 ]

Service Core
* Fixed an issue where QuantaStor was restarting the influxdb service when it was not needed. [ QSTOR-11244 ]
* Fixed: separated the influxdb, telegrafd and QuantaStor stats_db service restart logic to allow more granular control. [ QSTOR-11244 ]

== v6.5.8.008 (July 31st 2025) ==

=== [[QuantaStor 6.5.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.8 Upgrade Instructions| upgrading to QuantaStor v6.5.8]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed a small issue with the ceph osd reweight script progress trace. [ QSTOR-11234 ]

Enclosures and Controllers
* Add support for Supermicro ASG-2115S-NE332R system enclosure layouts [ QSTOR-11237 ]

Network Shares
* Fixed: Disable security features options in Network Share Create/Modify dialogs when the share is from a Scale-out File Pool. [ QSTOR-11235 ]
* Fixed: Remove redundant "NFS Security Mode" on the share advanced tab. [ QSTOR-11235 ]
* Fixed an issue with clearing the manage gids setting on Jammy platforms [ QSTOR-11225 ]
* Fixed an issue with setting specific nfs v3 or v4 server configurations on Focal platforms [ QSTOR-11225 ]
* Fixed a conflict with the nfs mountd ports between scale-out and scale-up nfs modes. [ QSTOR-11212 ]
* Fixed detection of nfs scale-out mode when it is configured at the time of ceph scale-out filesystem creation. [ QSTOR-11212 ]

Upgrade Manager and Installer
* Added a check to disable the grub os prober by default to prevent adding of any block devices with OS data other than the installed QuantaStor OS disk to the grub boot loader. [ QSTOR-11199 ]

== v6.5.7.004 (July 24th 2025) ==

=== [[QuantaStor 6.5.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.7 Upgrade Instructions| upgrading to QuantaStor v6.5.7]].

=== Release Notes ===

Network Shares
* Fixed an issue with network share cifs/smb settings such as ignore system acls introduced in the 6.5.1 release. [ QSTOR-11224 ]
* Removed the API underscore to space conversion logic in cifs/smb settings introduced in 6.5.1. REST API's should use proper url encoding like %20 when sending strings that contain spaces via curl or other http calls. [ QSTOR-11224 ]

Storage Pool Management
* Fixed a path naming issue for the sedutil-cli binaries used for SED disk encryption. [ QSTOR-11221 ]
* Added Several small enhancements and fixes for the sedutil-cli tool usage and SED supported disk discovery [ QSTOR-11219 ]

== v6.5.6.052 (July 16th 2025) ==

=== [[QuantaStor 6.5.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.6 Upgrade Instructions| upgrading to QuantaStor v6.5.6]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fix minor issue with Corvault log collection. [ QSTOR-11201 ]
* Added alerts to notify the user as they approach quota limits for S3C buckets [ QSTOR-11055 ]
* Fixed an issue with the IPMI Ip addresses showing up in the Health Check reports. [ QSTOR-10356 ]

Ceph Scale-out Block, Object and File
* Fixed radosgw logging logrotation not always occurring on fresh installs. [ QSTOR-11176 ]
* Fixed: radosgw logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Fixed: haproxy logging now defaults to rotating at 100MB [ QSTOR-11176 ]
* Improved logic for Ceph OSD Gentle Reweight. [ QSTOR-11163 ]
* Fixed an issue with the version check when upgrading the the scale-out ceph MDS, RGW and other daemons. [ QSTOR-11138 ]
* Fixed a few corner cases with ensuring successful Ceph upgrades. [ QSTOR-11138 ]
* Allow compression support for Ceph RBD pools. [ QSTOR-11131 ]
* Added Object User quota usage information to the Object User grid [ QSTOR-10722 ]

Dashboards and Analytics
* Add Pool, volume and share space usage trending dashboards (Early Access). [ QSTOR-11076 ]
* Add Pool, volume and share space usage trending dashboard routes and toggle buttons. [ QSTOR-11076 ]
* Expand the trending time scale for Tenants and Owners to make use of longer retention policies (e.g. 'Last 30 Days'). [ QSTOR-11076 ]
* Fix InfluxDB trending continuous query settings in qs\_statsdb.sh. [ QSTOR-11076 ]

Disk Management
* Add Multipath and HA support for SED Disks. [ QSTOR-11172 ]
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11065 ]

Enclosures and Controllers
* Fixes intermittent boot time OSD start issue with Corvault media. [ QSTOR-11195 ]
* Adds encryption bypass mode to avoid applying double (hardware plus software) encryption to Corvault media. [ QSTOR-11195 ]
* Added enclosure layout for Supermicro SYS-221H-TN24R systems. [ QSTOR-11154 ]

High Availability Failover
* Fixed an issue with Storage pool import of a previously exported pool that has iofencing on nvme disks. [ QSTOR-11173 ]

Network Shares
* Add new cyphers for active directory join. [ QSTOR-11183 ]
* Added sync flag by default to NFS mount for ceph object storage ganesha shares [ QSTOR-11181 ]
* Adjust minor Network Share quota alert levels. [ QSTOR-11171 ]
* Add larger record size upto 8M for Network Shares on ZFS Storage Pools. [ QSTOR-10118 ]
* Added support for hidden shares that end in a '$' as 'Browseable (admin-only) shares in the CIFS/SMB Options tab of the Network Share Create/Modify Dialogs. [ QSTOR-9222 ]

Service Core
* Optimize database reads for large clusters. [ QSTOR-11178 ]
* Added qs-util dbdiff for use to compare osn.db database versions [ QSTOR-10566 ]
* Added https as the default preferred method for support log bundle upload. [ QSTOR-9875 ]

Universal Containers
* Added initial support for a universal container system [ QSTOR-11162 ]

Upgrade Manager and Installer
* Added logic to fix the /boot/efi based on a efi partition label for Software RAID and EFI installs [ QSTOR-11140 ]

Web Manager
* Revise the Object User Access Key Manager to include Storage URLs in the Copy to Clipboard action. [ QSTOR-11177 ]
* Improved fieldset placements for network share create/modify dialogs. [ QSTOR-11156 ]
* SED Pool management - Reorder SED columns in PD grid. Move to the right of the "Correlated Device" column. Revise the SED capability detection to check for non-enterprise. [ QSTOR-11146 ]

== v6.5.5.039 (May 29th 2025) ==

=== [[QuantaStor 6.5.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.5 Upgrade Instructions| upgrading to QuantaStor v6.5.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixes bug in osd gentle reweight script that was bottlenecking performance. [ QSTOR-11123 ]
* Added logic to auto-clean up volume objects for non-QuantaStor managed ceph rbd's (rbd's created directly by the client using client rbd drivers/software). [ QSTOR-11112 ]
* Add warnings for the user if OSD or journal delete is being used on a device with duplicate PVs due to multi-pathing mapping. [ QSTOR-11099 ]
* Added 'qs-ceph' utility commands to modify compression options on Ceph pools. [ QSTOR-11096 ]
* Added compression ratio column in storage pools grid. [ QSTOR-11087 ]

Enclosures and Controllers
* Added support for discovery of RMSP3JD160J controllers. [ QSTOR-11107 ]
* Add validation for both primary and secondary IPs during External System Credentials Add. [ QSTOR-11009 ]

High Availability Failover
* Fixed a very rare corner case where a Manual HA failover task could generate unexpected errors due to a background periodic storage pool scan. [ QSTOR-11111 ]
* Added the option to set a Site Cluster Member Node as Manual Standby. [ QSTOR-11105 ]
* Fixed an issue where nodes could come out of standby status on a reboot too early before grid communication was established. [ QSTOR-11105 ]
* Enhanced HA Failover times for Storage Volumes for Fibre Channel clients. [ QSTOR-11105 ]
* Enhanced Fiber Channel High availability ALUA Changes to occur more quickly and to more quickly advertise failed paths to clients like VMware so that they can resume I/O to healthy available paths sooner. [ QSTOR-11105 ]
* Enhanced the logic used for High Availability Storage SCSI Target decoupling during a Storage Pool export. This can help greatly reduce the failover time for very Large configurations with thousands of volumes or volume snapshots. [ QSTOR-10969 ]

Network Interfaces
* Fixes bug that was blocking users from creating a static route with the same destination subnet across different systems. [ QSTOR-11125 ]
* Fixed a bug in static route validation logic and allow users to delete malformed static route entries. [ QSTOR-11115 ]

Network Shares
* Allow rename of nested shares [ QSTOR-11046 ]
* Added logic to help persist and manage NFS options for NFS version and nfs --manage-gids flags [ QSTOR-11001 ]

REST API
* Add an API to clear missing shares or volumes from the QS database. [ QSTOR-11117 ]

Remote Replication, Snapshots and Backup Policies
* Clarify concurrency options for backup policies. [ QSTOR-11004 ]

Security
* Added explicit modprobe disable and blacklist of ksmbd module to address any CVE-2025-37899 concerns. [ QSTOR-11134 ]

Service Core
* Enhanced the Core QuantaStor service management thread scaling. [ QSTOR-10767 ]
* Fixed a small memory leak with debug log tracing [ QSTOR-10689 ]

Storage Pool Management
* Updated sedutil-cli that supports a wider range of encrypted devices. [ QSTOR-11088 ]
* Restores sedutil / Storage Pool encryption support for SED Ruby NVMe devices. [ QSTOR-11088 ]
* Removed restriction to satisfy the VDEV count of N+1 to create a RAIDZx(RAID50/60/etc) array on a ZFS scale-up Storage pool when passing in a Set Disk Size instead of using the 'auto' option. [ QSTOR-11086 ]

== v6.5.4.016 (April 29th 2025) ==

=== [[QuantaStor 6.5.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.4 Upgrade Instructions| upgrading to QuantaStor v6.5.4]].

=== Release Notes ===

Dashboards and Analytics
* Fix issue where the dashboard of a newly created volume was not showing performance data after it had been assigned because of a pending Telegraf restart required. [ QSTOR-11077 ]
* Show CPU Temp and Power Usage in the System Dashboard (new Sensors button). [ QSTOR-11029 ]

High Availability Failover
* Unblocked creating HA ViF if there is an HA irrelavant bond in active-backup mode and unblocked modifying an HA irrelavant bond. [ QSTOR-11073 ]
* Fixed an issue when modifying non-name fields of an HA group. [ QSTOR-11071 ]

Network Interfaces
* Fixed bugs in validation logic for static route create and delete. [ QSTOR-11056 ]

Network Shares
* Ensure 'Browseable' is checked on SMB network shares when Browseable (Access Based) is checked. This ensures that authenticated clients who have pre-assigned browseable access can see the share offered by the QuantaStor but prevents non-authenticated users from seeing the share. [ QSTOR-11078 ]

Remote Replication, Snapshots and Backup Policies
* Minor log file cleanup after backup job is finished. [ QSTOR-11044 ]
* Add the ability to rollback a read-write Storage Volume or Network Share snapshot to it's underlying snapshot. [ QSTOR-9820 ]

Storage Pool Management
* Fixed an issue with Storage Pool auto-start on reboot for software encrypted storage pools. [ QSTOR-11081 ]

== v6.5.3.021 (April 9th 2025) ==

=== [[QuantaStor 6.5.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.3 Upgrade Instructions| upgrading to QuantaStor v6.5.3]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* Improved timeout handling for QuantaStor coordinated task system. [ QSTOR-11022 ]

Disk Management
* Added Hardware Encryption Storage Pool create support for Seagate ST20000NM000D Enterprise SED drives. [ QSTOR-11032 ]

Enclosures and Controllers
* Added Hardware Enclosure support for Dell PowerEdge R7615 [ QSTOR-11043 ]
* Added Hardware Enclosure support for Supermicro AS-1115CS-TNR [ QSTOR-11043 ]
* Optimized performance and fixed issues when rendering systems with attached CORVAULT external systems. [ QSTOR-11039 ]
* Optimize the rendering of enclosures. Fix drawer rendering issue where extra slots were appearing. [ QSTOR-11014 ]

Network Interfaces
* Fixed an issue with static route netmask CIDR calculations. [ QSTOR-11048 ]

Network Shares
* Update Network Share Namespace on all nodes to reflect any modification to NFS access entries to share that is part of a Namespace. [ QSTOR-11042 ]
* Online newly promoted Network Share Snapshots. [ QSTOR-11021 ]
* Add post share create and modify script callouts. [ QSTOR-11016 ]
* Fixed mount paths for enabled snapshots of Network Share when Share is renamed. [ QSTOR-11012 ]
* Add the ability to prioritize NFS access rules in /etc/exports file. [ QSTOR-10552 ]

SNMP
* Regen SNMP for 6.5.3 [ QSTOR-11054 ]

Security
* Added docker http proxy override [ QSTOR-11040 ]
* Updated Tomcat version to 9.0.102.0 [ QSTOR-11013 ]

Upgrade Manager and Installer
* Fixed various issues with the OVA vApp properties being set after VM image cloning. Added additional properties to the OVA by default. [ QSTOR-10508 ]

== v6.5.2.070 (March 27th 2025) ==

=== [[QuantaStor 6.5.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.2 Upgrade Instructions| upgrading to QuantaStor v6.5.2]].
=== Release Notes ===

Alerts and Configuration Analysis
* Added SED version of Micron 7300 drives to firmware check for Config Analyzer [ QSTOR-10933 ]

Ceph Scale-out Block, Object and File
* Update AWS cli. [ QSTOR-10956 ]
* Extend Resource Groups to support adding S3 Tenant resource type. [ QSTOR-10808 ]
* Extended timeouts for logical volume allocation commands when creating Ceph OSDs. [ QSTOR-10930 ]
* Added more permissive check when running Ceph OSD replace prepare operation. (CLI only) [ QSTOR-10914 ]
* Add a qs-ceph command to allow switching between fuse and kernel mount for cephFS to allow user comparison of fuse versus the faster kernel option. [ QSTOR-10905 ]
* Adds additional Ceph coordinator election mode that maps to the site-cluster. [ QSTOR-10795 ]

Dashboards and Analytics
* Added Jammy platform support for the ceph prometheus install script [ QSTOR-10949 ]

Enclosures and Controllers
* Strip whitespace characters from primary and secondary IPs during External System Credentials Add. [ QSTOR-10896 ]
* Add validation for External System Credentials during creation. [ QSTOR-10826 ]

High Availability Failover
* Fixed a bug with creation grid master (gm) Site Cluster vifs. [ QSTOR-10996 ]
* Implemented new naming schema for underlying Site Cluster HA Groups. [ QSTOR-10904 ]

Network Interfaces
* Fixed an issue with deleting bonded interfaces leaving slave interfaces tagged as slaves. [ QSTOR-10931 ]
* Updates for mellanox ofed lossless networking support to work better with newer model cards. [ QSTOR-10779 ]

Network Shares
* Fixes bug where having 'gmt' or 'GMT' in the name of a network share would cause issues with NFS protocol. [ QSTOR-10982 ]
* Fix the mount paths for read-write GMT snapshots. [ QSTOR-10938 ]
* Add mountaddr to the view mount instructions for Network Share. [ QSTOR-10923 ]
* Add crossmnt option in the NFS exports for newly created shares. Also skip adding the default export for .zfs directory. [ QSTOR-10806 ]
* Add the ability to clone a GMT snapshot and promote it.
Add QS CLI to copy share permissions. [ QSTOR-10580 ]

REST API
* Handle empty lists from the curl calls to Quantastor APIs. [ QSTOR-10939 ]

Remote Replication, Snapshots and Backup Policies
* Fixed up dead links which were created after running some types of auto-tier Backup Policies. [ QSTOR-10934 ]

SNMP
* Update SNMP MIB [ QSTOR-11019 ]

Security
* Prevent MFA passcodes with leading 0 from being truncated. [ QSTOR-10852 ]

Service Core
* Fixes an issue where role-creation would fail due to deprecated permission-definitions. [ QSTOR-10988 ]

Storage Pool Management
* Added support for the creation of mirror sets consisting of "quad-mirrors" (4-way mirror sets) for both the data device groups in the pool and also the "special" devices, such as "dedup" and "metadata offload" devices. [ QSTOR-10893 ]

Storage Volumes
* Add more detail for logical and physical space utilization for volumes. [ QSTOR-10981 ]

Upgrade Manager and Installer
* Deprecates legacy package version pinning for the packages.osnexus.com mirror server that was causing issues with some ceph cluster upgrades [ QSTOR-10990 ]
* Added protections in qs\_distupgrade.sh for lvm snapshots that could cause issues with the platform upgrade. [ QSTOR-10970 ]
* Resolved multiple items that were causing issues with installing QuantaStor on redhat based platforms when STIG enforcement policies were present. [ QSTOR-10958 ]
Note: the qs_upgrade_redhat8.sh install/upgrade script temporarily sets selinux to permissive mode and temporarily disables fapolicyd if it is enabled when the script is running and restores them to their original state when the script completes.

Web Manager
* Auto select S3 tenant for S3 User when user create is invoked from context menu on the S3 tenant. [ QSTOR-11010 ]
* Increase the width of grids to show the 'Correlated Device' column in the Add Log/Cache/Metadata Device to Pool dialog w/o the need for scrolling. [ QSTOR-10951 ]
* Add an option to upload logs with no truncation. [ QSTOR-10925 ]
* Add drawer support for the Corvault enclosure layout and rendering engine in the WUI. [ QSTOR-10796 ]

== v6.5.1.058 (February 12th 2025) ==

=== [[QuantaStor 6.5.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.1 Upgrade Instructions| upgrading to QuantaStor v6.5.1]].
=== Release Notes ===

Ceph Scale-out Block, Object and File
* General improvements to OSD drive replacement process. Added additional LVM clean up logic. Fixed issues with device correlation for multipath devices and encrypted drives. [ QSTOR-10915 ]
* Allow deleting journals from the UI via Ceph journal delete dialog [ QSTOR-10890 ]

Dashboards and Analytics
* Add gridPreferredPort check to the WUI dashboard service (qsrestd) if set on a Storage System. [ QSTOR-10866 ]

Disk Management
* Fixed: New systems and clean QuantaStor service configurations databases will initialize Multipath autoconfig support as enabled by default. [ QSTOR-10900 ]
* Increased timeouts and other optimizations for large multipath configurations. [ QSTOR-10881 ]
* Added protections to prevent QuantaStor service from running multiple blkid instances if one is already running. [ QSTOR-10881 ]
* Unblocked adding disk as a scale-up pool spare with a larger block size. [ QSTOR-10876 ]

Enclosures and Controllers
* Add Enclosure mapping support for HPE ProLiant DL325 Gen10. [ QSTOR-10899 ]
* Fixed an issue with Hardware Disk Identify for Storage Pool Physical Disks where the controller was not properly selected in the dialog. [ QSTOR-10858 ]
* Fixed an issue with applying External System Profile A+B. [ QSTOR-10840 ]

High Availability Failover
* Fixed an issue with automatically starting HA scale-up ZFS pools if both HA nodes are booted at the same time. [ QSTOR-10902 ]
* Added a a check to ensure the luks crypttab was upto date after encrypted ha pool failover. [ QSTOR-10901 ]
* Added VLAN interfaces to allowed interfaces for Site Cluster heartbeat rings. [ QSTOR-10871 ]
* Added better logic for smb/nfs service management for Scale-up HA configurations with shares on multiple storage pools in the same HA cluster. [ QSTOR-10762 ]
* Fixed an issue with Resource Group Service configs starting on a node after the node had previously hosted the service. [ QSTOR-10762 ]
* Fixed: added a unique name check for HA group create/modify. [ QSTOR-10311 ]

NAS Gateway / Cloud Containers
* Change Seagate Lyve Cloud endpoints [ QSTOR-10868 ]

Network Interfaces
* Fixed an issue with calling iptables commands when distupgrading from older distributions. [ QSTOR-10860 ]

Network Shares
* Minor fix to allow creation of GMT snapshots for volumes from the Web UI. [ QSTOR-10873 ]
* Fixed an issue with spaces in the curl command issued to Quantastor. [ QSTOR-10838 ]
* Fix issue where renaming a share that contained a nested share failed. [ QSTOR-10811 ]
* Allow setting Samba share as read-only using ZFS. The new support has been added to the Network Share create and modify dialogs on the Advanced settings tab. [ QSTOR-10755 ]
* Fixed an issue which created duplicate mounts for nested shares. [ QSTOR-10704 ]
* Exposed ZFS 'Case Sensitivity' option at share creation time. [ QSTOR-8869 ]

REST API
* Fixed the POST command in the REST API [ QSTOR-10844 ]

Remote Replication, Snapshots and Backup Policies
* Fix an issue with auto tiering in backup policies. [ QSTOR-10845 ]
* Refined the Backup Policy Create and Modify dialogs. [ QSTOR-10843 ]
* Fixed an issue with Backup Policy tasks completing when the underlying file copy or move process process had returned. [ QSTOR-10839 ]
* Add alerting when replication fails. [ QSTOR-10799 ]

SNMP
* Updated SNMP MIB [ QSTOR-10922 ]

Service Core
* Fixed an issue that could sometimes cause performing a reboot or shutdown of the storage system via the QuantaStor UI to fail. [ QSTOR-10917 ]
* Fix an issue with database backups on the storage pools. [ QSTOR-10907 ]
* Fixed an issue with creating encrypted pools when an underlying disk is read-only. [ QSTOR-10886 ]
* Fixed a disk discovery issue when discoverying a large number of disks. [ QSTOR-10875 ]
* Fixed QuantaStor service builds for Redhat based distros. [ QSTOR-10846 ]
* Added /var/opt/osnexus/quantastor/touchfiles/tf_sendlogs_ping_check.disable touchfile to bypess the icmp ping check and allow sending logs from the UI/qs cli. [ QSTOR-10556 ]

Storage Pool Management
* Fix an issue with pick a smaller hotspare disk getting picked for metadata offload if disk goes missing. [ QSTOR-10877 ]
* Add storage capacity properties for metadata offload VDEV [ QSTOR-10661 ]

Upgrade Manager and Installer
* Added a blacklist of the bnxt\_re driver to prevent issues for normal network operations for the bnxt_en driver loading on network controllers that have rdma support enabled in their firmware by default. [ QSTOR-10918 ]
* Added elbencho benchmarking tool to quantastor utilities. [ QSTOR-10892 ]
* Added support for Focal 20.04 to Jammy 22.04 Platform upgrades via qs-distupgrade [ QSTOR-10547 ]
* Fix telegraf start failures at startup due to invalid config file errors. [ QSTOR-10353 ]

Web Manager
* Fixed a minor truncation issue with trigger Backup Policy dialog [ QSTOR-10919 ]
* Add a Description column to the share and snapshot grid and default to hidden. [ QSTOR-10882 ]
* Minor fix to NTP server add dialog to prevent empty entries in the dialog. [ QSTOR-10870 ]
* Auto select first row in NTP and DNS settings dialogs. [ QSTOR-10867 ]
* Improve the host assign volume dialog. [ QSTOR-10862 ]

== v6.5.0.246 (January 9th 2025) ==

=== [[QuantaStor 6.5.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.5.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.5.0 Upgrade Instructions| upgrading to QuantaStor v6.5.0]].
=== Release Notes ===

Alerts and Configuration Analysis
* Increased HA health checks on Systems with local HA Pools. [ QSTOR-10746 ]
* Fixed: sending logs from specific grid nodes will now send logs only from the selected nodes. [ QSTOR-10694 ]

Ceph Scale-out Block, Object and File
* Fixes issue with access permissions for ceph client admin keyring file. [ QSTOR-10818 ]
* Fixed issues related to encrypted OSD replace operations. [ QSTOR-10786 ]
* Fixed an issue with wal journal device discovery and association with osds. [ QSTOR-10751 ]
* Deprecated replica=2 as a creation option from Ceph Scale-out storage. Replica=2 did not provide enough redundancy for consistent normal storage operations in the event of an osd or storage system outage. [ QSTOR-10748 ]
* Added the force flag checkbox to the Create S3 Storage Class dialog. [ QSTOR-10734 ]
* Fixed bugs in Ceph upgrade stage completion and failure alerting. [ QSTOR-10730 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10717 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10716 ]
* Fixed an OSD discovery issue on large Scale-out configurations. [ QSTOR-10708 ]
* Improve ceph discovery. [ QSTOR-10675 ]
* Add metadata pool utilization for Ceph Object Pool Group and Ceph File System [ QSTOR-10650 ]
* Disabled OSD auto restart. auto restart can be activated using the touchfile '/var/opt/osnexus/quantastor/touchfiles/tf\_ceph\_osd\_auto\_start.enable' [ QSTOR-10632 ]
* Ensure the Tenant and User grid's bucket count column is updated after the delete bucket operation via events. [ QSTOR-10610 ]
* Fixed a bug with Ceph OSD 'Last Rekey Date' field not being updated properly. [ QSTOR-10509 ]
* Updated default Ceph version to Reef 18.2.4 for new Focal and Jammy platform deployments. [ QSTOR-10415 ]

Dashboards and Analytics
* Add a new Ceph Member selection combo to the Ceph Pool dashboard. [ QSTOR-10798 ]
* Add Tenant and Owner usage dashboards to the Bucket menu area. [ QSTOR-10698 ]
* Add CPU Temp and Power Usage to the Grid Dashboard's System Tiles. [ QSTOR-10427 ]
* Change the grid CPU metric to use system\_usage which matches the metric used in the System dashboard. The overlapping text issue is no longer an issue as Highcharts has been replaced with Chart.js. [ QSTOR-10263 ]
* Add power usage and average CPU temp sparklines to the System Tile dashboards in the grid view. [ QSTOR-10013 ]
* Removed resource column from Health Checker/Config Analyzer. [ QSTOR-5515 ]

Disk Management

* Removed the multipath autoconf touchfile support which fixes issues where disabling multipath autoconfig would not apply. [ QSTOR-10706 ]
Enclosures and Controllers
* Addes enclosure layour for Supermicro Server SYS-F629P3-RC1B FatTwin 4-Node 24+12 bay [ QSTOR-10853 ]
* Fixed an issue with disk discovery when a CORVAULT is attached. [ QSTOR-10664 ]
* Added the ability to blink empty slots on jbod hardware that supports that feature. This action is accomplished using sg\_ses commands. [ QSTOR-10618 ]
* Added functionality to treat enclosures accidentally unplugged as MISSING, so that when reconnected their user-set properties are not lost . [ QSTOR-10542 ]

High Availability Failover
* Fixed an issue with post failover storage pool update tasks being stuck in a running state for nodes where the HA storage pool was previously evicted from due to an automatically triggered failover event. [ QSTOR-10485 ]

Kernel and Drivers
* Updated ZFS driver version to 2.2.6 [ QSTOR-10647 ]
* Updated scst iSCSI/FC Target driver to 3.9.0 [ QSTOR-10534 ]

Licensing
* Fixup old license keys to work with new format. [ QSTOR-10788 ]
* Added Express Edition Licenses [ QSTOR-10619 ]
* Show TB Utilized in the License grid and property view. [ QSTOR-8009 ]

NAS Gateway / Cloud Containers
* Fix wrap and truncation issues in the Cloud Add Credential dialog for Spanish. [ QSTOR-10792 ]

Network Shares
* Retain include line position in smb.conf [ QSTOR-10800 ]
* Minor fix to retain the share description when creating a Network Share. [ QSTOR-10793 ]
* Enhance the network share CLI search to support paging (similar to buckets). [ QSTOR-10757 ]
* Fix minor share name and snapshot name validation. [ QSTOR-10520 ]
* Added additional share name validation to share modify cli and API calls. [ QSTOR-10519 ]
* Add SSSD support [ QSTOR-10445 ]
* Implemented ransomware detection for Network Shares. [ QSTOR-10391 ]

Quantastor CLI
* Fixed qs cli disk-list filters for ssd, and nvme disk types. [ QSTOR-10515 ]
* Fixed the filtering for qs cli disk-list --filter="\[unused\]" and --filter="\[used\]" commands [ QSTOR-10482 ]

Remote Replication, Snapshots and Backup Policies
* Remove SSH keys after replication links are deleted [ QSTOR-10782 ]
* Fix minor argument validation for replication schedule create and snapshot schedule create. [ QSTOR-10732 ]
* Added monitoring for file modify events to enable continuous data protection on modified files. [ QSTOR-10557 ]
* Added ability for Snapshot Schedules and Replication Schedules to absorb old snapshots. [ QSTOR-10524 ]
* Create local delta Snapshot on source when Replication Schedule is skipped. [ QSTOR-10357 ]
* Change the control in the 'Update Selections for Replication Schedule' dialog to be a dual chooser. [ QSTOR-10351 ]

SCSI / NVMe Target
* Added a remote Fibre Channel port list to the fc target port section of the UI and 'qs fc-remote-port-enum' CLI command. [ QSTOR-10541 ]
* Added the Fiber Channel Issue LIP dialog to the UI that can be used to issue a lip on a specific FC port. [ QSTOR-10226 ]

SNMP
* Update SNMP MIB [ QSTOR-10847 ]

Security
* Fixed a bug in the 2FA login process. [ QSTOR-10841 ]
* Added support for a custom iptables include script under
/var/opt/osnexus/quantastor/iptables.qscustom [ QSTOR-10794 ]
* Updated tomcat package version to 9.0.96.0 [ QSTOR-10691 ]

Service Core
* Fix a small memory leak [ QSTOR-10778 ]
* Revise the server S3 modify API to accept spaces for the Display Name property. [ QSTOR-10724 ]
* Fixed some issues with writing the Chrony conf file on platforms that have chrony installed (like Jammy) [ QSTOR-10293 ]

Storage Pool Management
* Allow trim schedule to run nightly. [ QSTOR-10652 ]

Storage Volumes
* Allow minimum of <4MB for Storage Volume QoS Control limits. [ QSTOR-10765 ]
* Updated Storage Volume QoS controls to use cGroups v2 for modern linux kernels/platforms. [ QSTOR-10529 ]

Upgrade Manager and Installer
* Added logic to temporarily disable the upmap balancer during ceph upgrade. [ QSTOR-10702 ]
* Fixed an issue where Storage System Upgrade tasks were showing 25% progress but transitioned to the 'Completed' stage. [ QSTOR-10673 ]
* Install sssd packages by default on focal and newer platforms. [ QSTOR-10549 ]
* chrony is now the default time daemon for ubuntu 22.04 jammy and newer platforms. [ QSTOR-10273 ]
* Added 22.04 Jammy as a new Platform for QuantaStor [ QSTOR-10225 ]

Web Manager
* Disable the 'Start Upgrade' button in the Upgrade dialog until the system update check is complete. [ QSTOR-10776 ]
* Show the Tag/Alt Name value along with the Controller name in the identify dialog if provided. [ QSTOR-10775 ]
* Decrease the replication detail chart update frequency. [ QSTOR-10753 ]
* Added email validation check for the Alert Manager dialog [ QSTOR-10590 ]
* Added Timezone configuration as a step in the getting started guide. [ QSTOR-10502 ]

== v6.4.5.001 (November 1st 2024) ==

=== [[QuantaStor 6.4.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.5 Upgrade Instructions| upgrading to QuantaStor v6.4.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an error with Ceph Bucket Discovery tasks. [ QSTOR-10707 ]

== v6.4.4.013 (October 25th 2024) ==

=== [[QuantaStor 6.4.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.4 Upgrade Instructions| upgrading to QuantaStor v6.4.4]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added a fix for Seagate Corvault based Ceph deployments to ensure ceph LVM layer is started on system boot. [ QSTOR-10686 ]
* Added qs-osd-compact script to assist with OSD compaction on a per system basis. [ QSTOR-10668 ]
* Fixed an issue with Ceph OSD Journal device discovery for encrypted Ceph Clusters. [ QSTOR-10666 ]
* Extend timeouts for OSD restart stage of the Ceph upgrade task. [ QSTOR-10665 ]
* Fixes bug were OSDs lose journal device correlation after OSD reweight operation. [ QSTOR-10657 ]

Enclosures and Controllers
* Fixed an issue with enclosure and disk slot identity correlation information. [ QSTOR-10681 ]

High Availability Failover
* Disables the PCS daemon WebUI by default. [ QSTOR-10692 ]
* Adds a check for versions older than 6.4.3 to auto-disable the new health checks logic that is not compatible with older versions. [ QSTOR-10692 ]

Upgrade Manager and Installer
* Fixed: the qs_upgrade_redhat8.sh script now automatically removes legacy centos repos that are no longer needed for Redhat platform deployments. [ QSTOR-10676 ]

== v6.4.3.021 (October 10th 2024) ==

=== [[QuantaStor 6.4.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.3 Upgrade Instructions| upgrading to QuantaStor v6.4.3]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed a incorrect encrypted ZFS pool check check in the Config Analyzer for encrypted Ceph clusters with encrypted OSDs. [ QSTOR-10643 ]

Ceph Scale-out Block, Object and File
* Optimized scale-out ceph bucket discovery for very large number of S3 buckets. [ QSTOR-10621 ]
* Ceph OSD create and delete operations will no longer fail due to services being masked. [ QSTOR-10617 ]
* Made some improvements to the Veeam SOSAPI update cycle. [ QSTOR-10616 ]
* Fixed an issue with creating Ceph Storage Classes of the same name on different Ceph Clusters. [ QSTOR-10592 ]
* Default to http based checks from the haproxy load balancer to backend http radosgw instances. [ QSTOR-10559 ]

NAS Gateway / Cloud Containers
* Add a rescan for cloud containers so that data is refreshed if uploaded from another S3 gateway. [ QSTOR-10627 ]

Network Shares
* Fix an issue with trusted domain users not found in the Active Directory User search dialog. [ QSTOR-7353 ]

Remote Replication, Snapshots and Backup Policies
* Enabled Continuous Data Protection and Auto-tiering on Backup Policies using the SMB protocol. [ QSTOR-10601 ]

Security
* Added http proxy support for Upgrades, Support Log submission and License Key Activation. [ QSTOR-10432 ]

Upgrade Manager and Installer
* Fix triggering Ceph cluster upgrades when there are multiple scale-out storage Ceph clusters in the same QuantaStor Storage Grid. [ QSTOR-10612 ]
* Fixed an issue with the Ganesha 5.9 libntirpc dependency. This change was shipped earlier with a respin of QuantaStor 6.4.3 to include the missing updated library in the update repo and in the ISO and OVA image. [ QSTOR-10576 ]

== v6.4.2.053 (September 19th 2024) ==

=== [[QuantaStor 6.4.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.4.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.2 Upgrade Instructions| upgrading to QuantaStor v6.4.2]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed tolerances for alerting on changes in PSU status and other IPMI sensors. [ QSTOR-10447 ]

Ceph Scale-out Block, Object and File
* Adds total Object count to S3 tenant and user objects [ QSTOR-10606 ]
* Improved logic to ensure Scale-out Object Storage Class Auto-Tiering Rules were applied correctly on all nodes after an update. [ QSTOR-10599 ]
* Unblocked file quotas for CephFS Shares. [ QSTOR-10584 ]

Enclosures and Controllers
* Added Enclosure for Tyan Transport SX TS70-B8056. [ QSTOR-10597 ]
* Fixed an issue with enclosure support for Supermicro SSG-621E-ACR16L [ QSTOR-10563 ]

NAS Gateway / Cloud Containers
* Fix a regression with NFS and SMB access for cloud container shares. [ QSTOR-10588 ]

Network Shares
* Fixed an issue where the quota field was incorrectly disabled in the network share modify and create dialogs for nested shares on zfs storage pools. [ QSTOR-10602 ]
* Implemented ability to adjust Network Shares permission settings via a specified permissions mask. [ QSTOR-10147 ]

Quantastor CLI
* Fix a minor regression with share name now showing in the output of "qs share-list" [ QSTOR-10587 ]

Remote Replication, Snapshots and Backup Policies
* Show more informative errors when a Backup Job fails. [ QSTOR-10575 ]
* Fixed an issue where multiple snapshots were wrongfully created. [ QSTOR-10564 ]
* Fix an issue with removing excess snapshots for a backup policy with cephFS shares. [ QSTOR-10560 ]
* Add maximum total snapshots for replication, snapshot and backup schedules. [ QSTOR-10539 ]
* Fixed an issue where GMT Snapshots were disappearing. [ QSTOR-10538 ]
* Fix an issue with resume replication not updating the replication reports. [ QSTOR-10536 ]
* Added auto-tier stubbing minimum file size threshold. [ QSTOR-10505 ]

SCSI / NVMe Target
* Added support for setting specific LUN numbers on Storage volumes for Fibre Channel access. This is available in the Advanced tab of the Storage Volume Create and Modify dialogs. [ QSTOR-10544 ]

Service Core
* Improved efficiency for Ceph Bucket discovery. New Default behavior is to skip collecting life cycle policy and object locking data on the bucket. Contact support to enable object locking discovery on buckets. [ QSTOR-10600 ]

Upgrade Manager and Installer
* Added script to fix RGW configurations on clusters created on older versions of QuantaStor. [ QSTOR-10569 ]
* Added support for Ceph Reef 18.x upgrades. [ QSTOR-10493 ]

Web Manager
* Make the info fields, in the Snapshot Rollback Point fieldset of the Rollback Storage Volume dialog, read-only. [ QSTOR-10596 ]
* Hide the timezone column in the Upgrade Manager dialog. [ QSTOR-10540 ]
* Change S3 Bucket Search panel location from North to West of screen. [ QSTOR-10405 ]

== v6.4.1.011 (August 6th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.1 Upgrade Instructions| upgrading to QuantaStor v6.4.1]].

=== Release Notes ===

Enclosures and Controllers
* Fixed an issue with the Supermicro NVMe Enclosure mappings for the SBB-SSG-221E and SSG-641E [ QSTOR-10506 ]

Network Interfaces
* Fixed: Infiniband Devices should now have the correct Make and Model displayed in the Network interface section. [ QSTOR-10448 ]

Network Shares
* Fixed an issue with updating the status of Backup Policy Jobs. [ QSTOR-10517 ]

Remote Replication, Snapshots and Backup Policies
* Fixed: Shows the last 14 days in the replication schedule dashboard regardless of the replication schedule configuration. Fix an issue where not all series data was appearing despite being in a completed state. [ QSTOR-10528 ]
* Fixed an issue with duplicate Replication tasks. [ QSTOR-10526 ]
* Correct the max temporary snapshots retained for volumes in a replication schedule. [ QSTOR-10525 ]
* Add the ability to discover partially transferred chkpnts if replication is interrupted on the first transfer. [ QSTOR-10500 ]

Upgrade Manager and Installer
* Fixed: optimized dependency checker for qs-upgrade script. [ QSTOR-10531 ]

== v6.4.0.174 (July 18th 2024) ==

=== [[Upgrade Instructions]] ===
Click [[QuantaStor 6.4.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.4.0 Upgrade Instructions| upgrading to QuantaStor v6.4.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue with adding new ITSM webhook integrations. [ QSTOR-10480 ]
* Added support for Microsoft Teams to ITSM integrations. [ QSTOR-10458 ]
* Added the ability to easily extend ITSM integrations with new integration modules with qs_alerthandlers.conf file. [ QSTOR-10458 ]
* Include storage volumes in pool reports. [ QSTOR-10083 ]

Ceph Scale-out Block, Object and File
* Fixed an issue where the wrong libntirpc library was installed for nfs-ganesha. [ QSTOR-10463 ]
* Added a Copy to Clipboard Button for a selected access key and changed the double click on access/secret key behavior to copy to clipboard for the S3 User Access Key Manager Dialog. [ QSTOR-10428 ]
* Added a check to the S3 User Access Key Manager Dialog to ensure only the selected key text is shown when the user clicks the 'Show Key Text' button on the dialog. [ QSTOR-10428 ]
* Added block for more than 2 S3 Gateway loadbalancer modes configured at the same time. [ QSTOR-10407 ]
* Added a new feature for data pool capacity based, overflow rules for ceph object storage. Added support for a force flag for the auto tiering rules, that will overwrite any client side storage class specifications. [ QSTOR-10379 ]
* Add reporting for object storage usage. Periodic reports can be generated as part of "Report Schedules" by enabling "Object Zone Usage Report". [ QSTOR-10355 ]
* Added object count for Ceph Buckets. [ QSTOR-10348 ]
* Updated the default access permissions for Ceph keyring files. [ QSTOR-10325 ]
* Updated ceph cluster scale-out OSD osd_op_queue setting to wpq by default. The setting will take effect for any new OSDs on creation. Existing OSDs will use the new setting on OSD service restart (system reboot, encrypted OSD re-keying or manual OSD service restart) [ QSTOR-10123 ]
* Improved an error message when creating a Site Vif with Block Storage use case. [ QSTOR-9984 ]
* Added ability to enable a size quota and a file number quota on cephFS Shares. [ QSTOR-7344 ]

Enclosures and Controllers
* Fixed an issue where a disconnected JBOD could leave the enclosure object around on LSI HBAs. [ QSTOR-10503 ]
* Fixed: a modify of enclosure or system layout to something other than default will also set the same layout on the corresponding system or enclosure(s) that are currently set to default. [ QSTOR-10496 ]
* Fixed an issue with using the wrong LED control Utility for disk identification on Supermicro NVMe storage systems. [ QSTOR-10469 ]
* Added support for Supermicro SBB-SSG-221E-DN2R24R to enclosure/server views. [ QSTOR-10460 ]
* Added Support for Supermicro SSG-641E-E1CR36L/H to enclosure/server views. [ QSTOR-10429 ]
* Prevent a missing disk from being blinked. [ QSTOR-10179 ]

High Availability Failover
* Fixed an issue that could terminate the qs_pool_export script early on ha failover without final logging. [ QSTOR-10514 ]
* Fixed: added a check for HA VIFs to the network port offline dialog. This prevents a possible split cluster scenario. [ QSTOR-10414 ]
* Updated Task error messages to include the system where an error occurred for HA Storage pool failover tasks. [ QSTOR-10248 ]
* Added periodic HA failover group health checks for client and media connectivity. An alert will be raised If a health check fails that could indicate an issue with the future success of a High Availability failover from the primary to secondary node. [ QSTOR-9380 ]

Network Interfaces
* Prevent modifying parent port when static route is configured. [ QSTOR-10200 ]
* Fixed: removed iscsi and nvmeof portal configuration options on all grid vifs. client access should be configured through HA or Site cluster vifs only. [ QSTOR-9974 ]

Network Shares
* Fixed: NFS remove client access dialog and the qs share-client-remove CLI command now default to immediately terminate client connections for removed export rules, enhancing security. An option to retain client connections is available in the UI ("Retain Client Connections") and CLI (--retain-client-connection=true). [ QSTOR-10431 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue with Remote Replication reporting incorrect snapshot count. [ QSTOR-10476 ]
* Added a ZFS quantastor:scheduletype property to snapshots so that it is clearer what type of schedule created the snapshot. [ QSTOR-10421 ]
* Fix duplicate entries in replication dashboard. [ QSTOR-10385 ]
* Use raw mode for ZFS send and receive. Use on the wire compression if the source is not compressed. [ QSTOR-10153 ]

SNMP
* Update SNMP MIB [ QSTOR-10512 ]

Security
* Added feature to replace the OSD encryption keys for a given Ceph cluster. [ QSTOR-10283 ]
* Improved qs-util wrapper script so that user is prompted for secret passphrase. Passphrase will remain hidden. [ QSTOR-9982 ]

Service Core
* Fix minor trace message for Maintenance schedules. [ QSTOR-10416 ]
* Added a check to the QuantaStor system startup to ensure that LUKS encrypted Physical disks devices provided to QuantaStor via the iSCSI Software adapter are opened after system boot. [ QSTOR-10257 ]

Upgrade Manager and Installer
* Added support for customizing OVF templates with passwords and license keys. [ QSTOR-10451 ]
* Fixed an issue with the archived centos ganesha mirrors in the qs_upgrade_redhat8.sh install and upgrade script. [ QSTOR-10446 ]

Web Manager
* Fixed an issue where the User Web Customization rules were not being properly applied when the rules were defined in the Role create or modify dialog. [ QSTOR-10513 ]
* Fixed the text highlight and other colors used in the UI to be consistent across elements. [ QSTOR-10470 ]
* Update: Replaced all instances of 'double click to reveal plain text' on password fields with an explicit eyeball reveal button to allow users to show plain text. [ QSTOR-10410 ]
* Updated web manager tomcat and Java runtime dependencies. [ QSTOR-9492 ]

== v6.3.7.011 (June 18th 2024) ==

=== [[QuantaStor 6.3.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.7 Upgrade Instructions| upgrading to QuantaStor v6.3.7]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue with creating Erasure Coded Ceph Object Storage Classes in the Web UI. [ QSTOR-10434 ]

Dashboards and Analytics
* Fixed the install-ceph-prometheus scripts to always have a default fallback install version if the latest version is not available. [ QSTOR-10441 ]
* Updated wiki documentation for the Prometheus and Grafana Integration guide to reflect changes from latest Grafana 11.0 release. [ QSTOR-10441 ]

Enclosures and Controllers
* Fixed several items and updated logic for External System Corvault support. [ QSTOR-10235 ]

Kernel and Drivers
* * Fixed an issue with modern mellanox OFED installs using the mellanox-ofed-install.sh script and legacy ConnectX-3 Based Mellanox HBA's [ QSTOR-10295 ]

Network Shares
* Added logic to always bind mount the /export paths on Network Shares even if the share has no NFS access rules and is set to disabled and SMB/CIFS disabled. This includes Nested shares under Parent Network Shares. No noticeable increase in failover times was detected when testing on a Large HA config with many Network Shares including many Nested Shares and snapshots. [ QSTOR-10424 ]
* Fixed an issue with the Network Share snapshot count property. [ QSTOR-10329 ]
* Re-enabled the Network Share Snapshot count column by default in the Network Share Grid View. [ QSTOR-10329 ]

Storage Volumes
* Fixed an issue where FC ALUA standby LUN devices for Storage Volumes would not appear as non-rotational(SSD) to clients when on an SSD or NVMe based Storage Pool. Note: a reboot is required to reload the SCST kernel driver stack on the system for the fix to take effect. [ QSTOR-10417 ]
* Fixed an issue with presenting pass-through Storage Volumes as non-rotational(SSD) to clients. [ QSTOR-10417 ]

Upgrade Manager and Installer
* Updated mellanox-ofed-install.sh script to support latest Mellanox OFED 24.04-0.6.6.0 [ QSTOR-10438 ]
* Added a lts optional flag to the mellanox-ofed-install.sh for installing Mellanox OFED version 5.8-4.1.5.0. [ QSTOR-10438 ]

Web Manager
* Fix a minor ribbon bar alignment and spacing issue between elements by making a deferred force layout call during context switching. [ QSTOR-10413 ]
* Fixed an issue where some elements of the Ribbon Bar would not be visible or would somehow be under the visible section of the UI. [ QSTOR-10413 ]
* Removed the ZFS share encryption tab from the create and modify network share dialogs. The ZFS Share encryption feature is still available for share creation via the CLI but is not recommended for most users due to ZFS driver level issues. When the ZFS driver issues are resolved in a future ZFS release, the encryption tab will be re-enabled. [ QSTOR-10352 ]

== v6.3.6.003 (June 4th 2024) ==

=== [[QuantaStor 6.3.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.6 Upgrade Instructions| upgrading to QuantaStor v6.3.6]].

=== Release Notes ===
Remote Replication, Snapshots and Backup Policies
* Added a check to enforce 'Enable target checkpoint recovery (unchecking will perform full replication)' setting on Remote Replication Schedules. This helps ensure that no additional _chkpnt is created for a share or volume if one already exists for the source and target replication association. [ QSTOR-10419 ]
* Fixed an issue with replication report showing synchronizing state forever. [ QSTOR-10419 ]

Security
* Added qs-util wuicustomcerts command to allow creation of a /var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf nginx override config so that users can customize certificate paths and ciphers from the QuantaStor defaults for the Web UI. [ QSTOR-9037 ]

== v6.3.5.020 (May 23rd 2024) ==

=== [[QuantaStor 6.3.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.5 Upgrade Instructions| upgrading to QuantaStor v6.3.5]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Fixed an issue where s3 gateway create was creating load balancers with https->https mode when https->http mode was passed in. [ QSTOR-10399 ]
* Fixed some issues with discovery of the http/https mode for the S3 load balancer. [ QSTOR-10399 ]
* Further optimizations and fixes related to Grid communication and Ceph Scale-out Object discovery on Object Storage Pools with a large number of buckets. [ QSTOR-10380 ]
* Fixed an issue with adding and removing RGW instances on the same node via different IP addresses. [ QSTOR-10370 ]

High Availability Failover
* Added logic to limit number of open threads and open file handles needed to unmount shares for the HA storage pool failover process. This fixes an issue with deployments that have a large amount of shares, including nested shares and share snapshots. [ QSTOR-10373 ]
* Added more coverage for the auto close open file handles logic during HA storage pool failover to help unmount shares under the nfs /exports path as well as nested shares/snapshots. [ QSTOR-10373 ]

Multitenancy
* Fixed some issues with Multitenancy Container discovery and database table updates. [ QSTOR-10363 ]

Network Interfaces
* Added a exact match filter config file /var/opt/osnexus/quantastor/conf/qs_portFilter.conf for interface names that allows users to blacklist interfaces they do not want QuantaStor to see and/or manage. [ QSTOR-9664 ]

Network Shares
* Fixed an issue with the Network Share samba audit logging feature when upgrading from a legacy audit logging config. [ QSTOR-10390 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Security
* Adds support for controlling the sample period over which bad login attempts can trigger a short or permanent lock. [ QSTOR-10374 ]
* Adds support for controlling the duration of the short lock. [ QSTOR-10374 ]
* Fixes a security bug where good login attempts could mask bad login attempts by clearing the bad login attempt sample set for a given user. [ QSTOR-10374 ]
* Changes the special rules around bad login attempts for the 'admin' user, now allowing it to be locked. [ QSTOR-10374 ]
* Adds a touch file to unlock the 'admin' user account. [ QSTOR-10374 ]
* Adds a touch file to block the permanent locking of the 'admin' user account, which is similar to the current behavior. [ QSTOR-10374 ]

Storage Volumes
* Fixed an issue where iSCSI CHAP was not being correctly enabled in the iSCSI target on volumes when configured. [ QSTOR-10398 ]
* Fixed an issue with Fibre Channel Storage Volumes being presented after Storage System boot for Single QuantaStor node deployments (non-HA). [ QSTOR-10277 ]

== v6.3.4.003 (May 14th 2024) ==

=== [[QuantaStor 6.3.4 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.4 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.4 Upgrade Instructions| upgrading to QuantaStor v6.3.4]].

=== Release Notes ===

Web Manager
* Optimized WebUI login time for Large Scale-out Object deployments. [ QSTOR-10365 ]
* Fixed an issue where the WUI idle logout timer would be reached even when browsing inside of the WUI for various different sections. [ QSTOR-10361 ]

== v6.3.3.033 (May 1st 2024) ==

=== [[QuantaStor 6.3.3 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.3 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.3 Upgrade Instructions| upgrading to QuantaStor v6.3.3]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added qs_rgw_iam_policy.sh script for generating S3api IAM compatible bucket policies. [ QSTOR-10336 ]
* Added FQDN specific string validation to the Modify Realm/Zone Group dialog. [ QSTOR-10320 ]
* Fixed some items with the Modify Realm/Zone Group task. [ QSTOR-10320 ]
* Added a drop-down to the Create Storage Class Dialog with pre-defined S3 Storage Classes supported by most S3 CLI and S3 Library based clients. Users can still create a custom Storage class if they so choose and use their own custom S3 API implementation that supports Custom S3 Storage Classes. [ QSTOR-10232 ]
* Fixed some issues with adding/removing S3 Gateways with Load Balancers. [ QSTOR-9848 ]

High Availability Failover
* Added a force flag to the Remove Site Cluster Virtual Interface dialog. [ QSTOR-8276 ]
* Added logic to auto re-apply iofencing to devices that are re-added to the system due to prior physical removal or power loss of the device/device enclosure. [ QSTOR-5475 ]
* Fixed an issue with enabling client connectivity on HA Groups and implemented more safe guards. [ QSTOR-3432 ]

Network Shares
* Add touch file to limit discovery of snapshots of nested shares. [ QSTOR-10334 ]
* Fixed: Network Share rename will correctly remount the /export/ NFS mount location to the new name. [ QSTOR-10318 ]
* Fix minor message during share disable with active SMB clients. [ QSTOR-10292 ]
* Share disable will close open file handles to the share when accessed via SMB. [ QSTOR-10291 ]
* Fixed an issue where Network sub-share alias shares would not start properly after Storage Pool HA Failover. [ QSTOR-10278 ]
* Fixed an issue where share alias advanced settings allowed modification after an HA failover. [ QSTOR-10276 ]

Remote Replication, Snapshots and Backup Policies
* Fix update selections for a replication schedule for cases where source is on a HA pool. [ QSTOR-10310 ]
* Fixed an issue with Windows Previous Versions on share-alias. [ QSTOR-10274 ]
* Added a check to ensure no duplicate share alias names are created on the same parent share. [ QSTOR-10274 ]

Security
* Fixed an issue where the Security Manager > Default Login Username field was not initializing to 'admin' for default installs and upgrades. [ QSTOR-10323 ]

Upgrade Manager and Installer
* Added logic to remove legacy google-compute-engine-oslogin and/or google-guest-agent on upgrade. These packages caused systems to not shutdown properly when installed. [ QSTOR-10340 ]
* Added a check to ensure the ledmon service is disabled by default. This is to ensure that there are no conflicts with the QuantaStor managed Disk Identify logic. [ QSTOR-10313 ]

Web Manager
* Added paging support to S3 Bucket search [ QSTOR-10324 ]

== v6.3.2.025 (April 15th 2024) ==

=== [[QuantaStor 6.3.2 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.2 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.2 Upgrade Instructions| upgrading to QuantaStor v6.3.2]].

=== Release Notes ===

Ceph Scale-out Block, Object and File
* Added search capability to the S3 Bucket section of the Web UI. [ QSTOR-10288 ]
* Added Rule Sorting and an explicit rule remove button to the Storage Class Auto-Tiering Rules Dialog. [ QSTOR-10287 ]
* Added: You can now add the FQDN's for DNS names that you want the S3 Gateways to respond to via the Modify Realm/Zone Group Dialog. Note: you must add the FQDN's of the hosts or an FQDN alias e.g. s3.yourdomain.net (like used by DNS round robin) for the HAproxy load balancer to work properly. [ QSTOR-10285 ]
* Fixed issues with Ceph S3 Bucket discovery with a large amount of buckets. [ QSTOR-10261 ]
* Fixed some items related to Veeam SOSAPI integration based on testing in Veeam Certifcation scripts. [ QSTOR-10243 ]

Enclosures and Controllers
* Fixed an issue where Dell RAID Controllers were being discovered twice in due to new support for the controllers discovery in Broadcom storcli utilities. [ QSTOR-10244 ]

High Availability Failover
* Fixed an issue where rebooting an active High Availability storage node would cause ZFS encrypted shares to go offline for any active pools on that node prior to automatic failover. [ QSTOR-10218 ]

Network Interfaces
* Fixed an issue where legacy VLAN interfaces that had the RX/TX optimizations flag set would not allow modification of the interface for any other setting. [ QSTOR-10272 ]

Not Set
* Added logic to prioritize high-speed data ports by default in the Ceph Cluster create and S3 gateway create dialogs. [ QSTOR-10266 ]
* Fixed usable space calculation on Object Pool Group when there are multiple Pools or Storage Classes using the same OSD's. [ QSTOR-10264 ]
* Fixed an issue with modifying a network share after after a custom veto files setting had been added to the samba cifs options. Now the veto files merge as a set with the default .qssnaps veto files used by the VSS GMT snapshots feature. [ QSTOR-10249 ]

Security
* Updated the OSNEXUS Security Notice service [https://services.osnexus.com/security/](https://services.osnexus.com/security/) for bionic and focal platform support. [ QSTOR-10269 ]

Service Core
* Added support for replacing ntpd with chronyd in Ubuntu Focal platform based deployments. [ QSTOR-10239 ]

== v6.3.1.009 (April 1st 2024) ==

=== [[QuantaStor 6.3.1 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.1 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.1 Upgrade Instructions| upgrading to QuantaStor v6.3.1]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where a pool running a scrub would report as degraded in the Config Analyzer health report. [ QSTOR-10258 ]

Ceph Scale-out Block, Object and File
* Added qs-rgw-moveobjects script to allow easier s3api copy-object of a buckets contents to a different storage class. [ QSTOR-10268 ]
* Changed haproxy load-balancer to use balance source mode by default. [ QSTOR-10260 ]
* Fixed an issue with the Storage Class Auto-Tiering rules where multipart uploads with Capacity Operators of greater than or greater and equal to the Capacity Threshold would not be uploaded to the correct storage class. [ QSTOR-10254 ]

Enclosures and Controllers
* Changed qs-util seagate-ap-split mode command to use zone 5 [ QSTOR-10259 ]

Web Manager
* Increased default max bucket count for S3 user to 100K. [ QSTOR-10256 ]
* Added new Grid Preferred Port status column in the Network Port Grid. It's hidden by default. [ QSTOR-10256 ]
* Fixed s3 gateway dialog height so it can show more nodes in the grid. [ QSTOR-10256 ]
* Fixed s3 tenant create, if "Display Name" is not specified use the "Name" (display name is no longer mandatory in dialog). [ QSTOR-10256 ]

== v6.3.0.268 (March 20th 2024) ==

=== [[QuantaStor 6.3.0 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.3.0 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.3.0 Upgrade Instructions| upgrading to QuantaStor v6.3.0]].

=== Release Notes ===

Alerts and Configuration Analysis
* Fixed an issue where md software raid os partitions where being reported in the config analyzer as offline storage pools. [ QSTOR-10168 ]
* Fixed an issue where non-management ports were being flagged in the config analyzer for iSCSI acess being enabled. [ QSTOR-9891 ]

Ceph Scale-out Block, Object and File
* Blocked creating new OSDs when the OSD service is masked. [ QSTOR-10212 ]
* Show the S3 Object Storage Pool as the root node in the S3 User's and Tenant tree. [ QSTOR-10156 ]
* Show the S3 Object Storage Pool as the root node in the bucket tree. [ QSTOR-10150 ]
* Add support for multiple data pools for storage classes for Ceph Object Storage Pool. [ QSTOR-10137 ]
* Add auto tiering capability to ceph buckets. [ QSTOR-10125 ]
* Change the Ceph block storage pool to default to replica=3 for performance. [ QSTOR-10062 ]
* For CephFS, the min_size for the metadata pool should be 2. [ QSTOR-10015 ]
* Introduce safe disk replacement for Ceph OSDs. [ QSTOR-9937 ]
* Applied adjustments to Ceph Clusters for optimized scrubs on smaller and denser clusters. [ QSTOR-9900 ]
* Updated NFS Ganesha to 5.7 [ QSTOR-9821 ]
* Add support for Ceph Multi-site bucket replication. [ QSTOR-6570 ]

Disk Management
* Added support for ScaleFlux CSD 3000 SSDs that support builtin compression provisioning. [ QSTOR-10198 ]
* Fixed an issue with disk correlation by serial number on Broadcom/LSI 93XX series HBAs. [ QSTOR-10194 ]
* Show osd number in 'qs disk-list'. [ QSTOR-9717 ]

Enclosures and Controllers
* Add enclosure view for the ASUS 2u24 NVMe. [ QSTOR-10202 ]
* Fix controller selection issue in the 'Identify Hardware Controller Disk Device' dialog for when the selected object in the Physical Disk tree is a Physical Disk and not the Disk itself. [ QSTOR-10195 ]
* Updated wddcs tool to 3.2.8.0 [ QSTOR-10166 ]
* Added to feature to create or delete multiple External System Volume configurations. [ QSTOR-10061 ]

High Availability Failover
* Fixed an issue with the Create HA Failover Group Dialog when there are active FC sessions on volumes on the selected pool. [ QSTOR-10169 ]
* Changed NVMe reservations to use cptpl=2 when available so that iofencing is cleared on power on of a nvme drive. [ QSTOR-10124 ]

Licensing
* Added logic to auto-fetch new QuantaStor License Server ca certificates during online license activation. [ QSTOR-10174 ]

NAS Gateway / Cloud Containers
* Update rclone version. [ QSTOR-9512 ]

Network Interfaces
* Show static route parent port in the respective grid and delete dialog. [ QSTOR-10199 ]
* Fixed an issue with onlining/restarting offline VLAN interfaces. [ QSTOR-10180 ]
* Fixed an issue with VLAN ontop of Bonded ports on VM deployed QuantaStor instances. [ QSTOR-10180 ]
* Improve the Network bond mode descriptions, in the 'Create Bonded Port' dialog, for those that require managed switches. [ QSTOR-9842 ]
* Added IP address place holder for DHCP interfaces that have no assigned IP address. [ QSTOR-9828 ]
* Fixed an issue with downing virtual interfaces when converting to HA virtual interface. [ QSTOR-9774 ]

Network Shares
* Minor Web UI fix to display share quota percent utilization. [ QSTOR-10121 ]
* Implemented a Real Time Auto Copy feature to enhance data protection for Network Shares. [ QSTOR-9929 ]
* Updated Focal platform Samba to 4.18.6 backported from ubuntu upstream release. [ QSTOR-9924 ]
* Show parent shares in the 'qs share-list' command results. [ QSTOR-9702 ]

Quantastor CLI
* Update qs-iostat utility to python3. [ QSTOR-10152 ]

Remote Replication, Snapshots and Backup Policies
* Add the ability to force create symbolic links for backup policy outbound-move to cloud containers without a delay of 24 hours. [ QSTOR-10136 ]
* Update Replication Report Summary object as failed if source system reboots right after schedule is triggered. [ QSTOR-10097 ]

SNMP
* Regen SNMP MIB for 6.3 [ QSTOR-10228 ]

Security
* Updated JQuery version used in the QuantaStor WebUI to 3.7.1 [ QSTOR-10064 ]
* Add Audit Log Viewing to the Storage System menus. [ QSTOR-10031 ]

Storage Pool Management
* Improved logic for replacing zpool UNAVAIL disks that are identified by their id instead of a device path as the disk is no longer present or visible to the OS. [ QSTOR-10129 ]

Upgrade Manager and Installer
* Automatically disable and mask uefi fwupd service on platforms that include it to prevent unplanned firmware updates. [ QSTOR-10205 ]
* Fixed: the low boot space warning for kernel upgrades now correctly appears in the Upgrade Manager task failure message. [ QSTOR-10185 ]
* Fixed an issue where the scst/zfs userspace packages were not being pinned on security updates. [ QSTOR-10185 ]
* Fixed an issue where qstortarget was incorrectly selected during security updates but fails due to existing pinning rules. qstortarget now correctly only gets selected for install on kernel/driver upgrades. [ QSTOR-10185 ]

Web Manager
* Minor fix to show NA for share-alias space columns. [ QSTOR-10227 ]
* Login dialog shown after service restart is complete. [ QSTOR-10007 ]

== v6.2.8.016 (March 5th 2024) ==

=== [[QuantaStor 6.2.8 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.8 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.8 Upgrade Instructions| upgrading to QuantaStor v6.2.8]].

=== Release Notes ===

Enclosures and Controllers
* Fixed Hardware Disk to Physical disk slot correlation issues. [ QSTOR-10135 ]
* Improved Enclosure object guid uniqueness to better support more complex/multipath setups for hardware disk to physical disk mapping. [ QSTOR-10135 ]
* Added Hardware Enclosure Serial\# property and logic to discover serial\# when available. [ QSTOR-10102 ]

Multitenancy
* Updated Resilio container image to 3.8.1.2250 [ QSTOR-10162 ]
* Fix errors with Resilio container errors seen after upgrade. [ QSTOR-10099 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue that could sometimes cause duplicate snapshot objects to appear for snapshot schedules with nested shares and recursive snapshot enabled. [ QSTOR-10159 ]
* Added a check to temporarily prevent adding ZFS dataset encrypted Network Shares to remote replication schedules until the Open ZFS issue \#12014 is resolved in an upcoming ZFS release. [ QSTOR-10145 ]
* Fixed an issue with using Windows Restore Previous Versions on remote Replica \_chkpnt Network Shares. [ QSTOR-10065 ]

SCSI / NVMe Target
* Updated SCST driver to 3.8.0.9038-f134517-qs01 to support latest available linux kernels for Focal platform and Focal cloud platform kernels. [ QSTOR-10151 ]

Upgrade Manager and Installer
* Added Kernel Driver Support for QuantaStor installation on Ubuntu 20.04 images on Azure, AWS and Google Cloud. [ QSTOR-10138 ]

== v6.2.7.002 (February 23rd 2024) ==

=== [[QuantaStor 6.2.7 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.7 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.7 Upgrade Instructions| upgrading to QuantaStor v6.2.7]].

=== Release Notes ===

Licensing

* Updated license manager certificates for online license activation. [ QSTOR-10154 ]

== v6.2.6.024 (February 8th 2024) ==

=== [[QuantaStor 6.2.6 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.6 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.6 Upgrade Instructions| upgrading to QuantaStor v6.2.6]].

=== Release Notes ===

Enclosures and Controllers

* Added support for iofencing NVMe disks that do not support cdw11 [ QSTOR-10087 ]
* Added an Alert for when a OS Software RAID1 mirror enters a degraded state. [ QSTOR-10080 ]
* Added support LSI-3008C0 model controllers. [ QSTOR-9841 ]
* Added a check to hardware Enclosure Discovery to automatically filter out enclosures that do not have any drive slots. [ QSTOR-9716 ]

High Availability Failover

* Fixed an issue with the I/O fencing tool where it was reporting not-supported on reservation capable nvme devices. [ QSTOR-10114 ]

Network Interfaces

* Updated static routes to use modern ip route syntax with the 'proto static' option. [ QSTOR-10103 ]
* Updated netplan conversion to by default create static routes using ip route to match the original netplan static route rules. [ QSTOR-10103 ]

Storage Pool Management

* Fixed: Activate HA Failover Group now works for Storage Pools in a degraded state missing a few devices. [ QSTOR-10100 ]
* Fixed: Create HA Failover Group now allows a force option if there are a small number of drives missing on the secondary node. Note that the operation will still be blocked if most/all of the drives are missing from the secondary node. [ QSTOR-10100 ]
* Added support for Zero Touch Maintenance Automatic Global Hot spare marking of Hardware RAID0 Passthrough units. [ QSTOR-9865 ]

Storage Volumes

* Fixed: NVMe Target Storage volumes now persist their serial numbers correctly on reboot [ QSTOR-9992 ]
* Fixed: the NVMe Target now correctly re-exports the allowed portals on system boot. [ QSTOR-9992 ]

Upgrade Manager and Installer

* Updated mellanox-ofed-install.sh script to support the latest Focal platform 5.15.0-91-generic kernel. [ QSTOR-10117 ]
* Updated the GPG repo keys for QuantaStor RedHat / and Almalinux platform installs [ QSTOR-10107 ]
* Fixed a incorrect error log when upgrading the Kernel and Drivers on the Ubuntu Focal platform. The upgrade would succeed when the error was seen, but it was unclear to the user without full log analysis. [ QSTOR-10106 ]
* Updated upgrade manager logic to ensure recommended dependency packages are always selected for install during core service and security upgrades. [ QSTOR-10101 ]
* Fixed an issue with the qs-distupgrade script where some QuantaStor core package changes were not being applied after a platform dist-upgrade from bionic to focal. [ QSTOR-10132 ]
* Added better logging of systemctl service enablement and restart during qstorservice package installs. [ QSTOR-10134 ]

== v6.2.5.032 (January 18th 2024) ==

=== [[QuantaStor 6.2.5 Upgrade Instructions| Upgrade Instructions]] ===
Click [[QuantaStor 6.2.5 Upgrade Instructions| here]] for instructions on [[QuantaStor 6.2.5 Upgrade Instructions| upgrading to QuantaStor v6.2.5]].

=== Release Notes ===

Alerts and Configuration Analysis
* Added ssh port 22 to network connectivity checker tests. [ QSTOR-10092 ]

Ceph Scale-out Block, Object and File
* Fix bug where ceph monitor daemon is disabled. [ QSTOR-10095 ]
* Added script to setup Ceph multi-site replication. [ QSTOR-10075 ]

Enclosures and Controllers
* Updated storcli version to 007.2705.0000.0000 [ QSTOR-10072 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-10036 ]
* Added feature for turning off hwDisk identification for all disks, including all empty slots. [ QSTOR-9825 ]

Kernel and Drivers
* Updated Linux Kernel to 5.15.0-91-generic for Focal platforms [ QSTOR-10025 ]
* Linux Kernel 5.15.0-91-generic includes fixes for NFS v3 lockd that would cause file handles to be left open for NFSv3 clients when attempting to stop the nfs server before ZFS pool export during HA failover. [ QSTOR-10025 ]
* Updated ZFS to 2.1.14.qs25 for Focal platforms [ QSTOR-10025 ]

Multitenancy
* Fix an issue with missing Service Configs. [ QSTOR-10079 ]
* Add the ability to sync nested shares when parent share is selected in Resilio. Optionally skip changing the share permissions when user is specified in the config file. [ QSTOR-10070 ]

Network Shares
* Block rename of nested shares. [ QSTOR-10091 ]
* Add the ability to enable and clone a GMT snapshot [ QSTOR-4145 ]

Remote Replication, Snapshots and Backup Policies
* Fixed an issue where Remote Replication Schedules can fail if 2 source snapshots have the same created timestamp. [ QSTOR-10059 ]
* Fix a minor issue with File Age settings in the Backup Schedule Modify dialog. [ QSTOR-10056 ]
* Properly transition a Replication task and Replication Report to the 'failed' status if the source system loses power during the Replication. [ QSTOR-10041 ]
* Add a warning if checkpoint is selected in create snapshot schedule. [ QSTOR-10038 ]

Storage Volumes
* Fixed an issue with zfs storage volumes being correctly marked as missing if the underlying zfs zvol or snapshot is removed or unavailable. [ QSTOR-10086 ]

Upgrade Manager and Installer
* Added a --password option to the qs\_install.sh script to allow users to provide the QuantaStor admin user password as well as the same password for the default qadmin shell account. [ QSTOR-10085 ]

Web Manager
* Clear the replica summary graph when there are no report entries. [ QSTOR-10057 ]
* Fix enclosure graph rendering issue where a selected system with multiple valid controllers was not being render because of one underlying MD BOOT Controller. [ QSTOR-10055 ]

= Archived Change Logs =

== [[Change Log Archive 2023]] ==

== [[Change Log Archive 2022]] ==

== [[Change Log Archive 2021]] ==

== [[Change Log Archive 2020]] ==

== [[Change Log Archive 2019]] ==

== [[Change Log Archive 2018]] ==

== [[Change Log Archive|Change Log Archive pre-2018]] ==

Select the link above to see the [[Change Log Archive]] of older revisions.

QuantaStor REST API Reference Guide

2026-07-10T17:18:42Z

Qadmin: Update REST API reference to 6.8.0 (build 205)

[[Category:dev_guide]]
OSNEXUS QuantaStor REST API / JSON RPC Reference Guide 6.8.0
Copyright (c) 2009-2026 OSNEXUS Corporation. All rights reserved.

The following API reference guide provides a list of all the QuantaStor service APIs presented out via the storage grid SOA from all QuantaStor nodes. These same APIs are used by all QuantaStor clients including the QuantaStor web management interface, QuantaStor CLI, QuantaStor Python Library, QuantaStor PowerShell Module, and others. Though you can use the REST API directly via utilities like curl for any extensive scripting we recommend using the Python Client library and for simple automation tasks you might find the QuantaStor CLI to be the easiest route. When calling an API you can use any IP address of any node within a storage grid to run any command, the QuantaStor grid will take care of call routing as needed to the appropriate node to run the task.

= Service API Definitions =

== aclAdd ==
''' Request Parameters '''
<code>
{
"method": "aclAdd",
"params": {
"ownerId": xsd:string
"ownerType": xsd:unsignedInt
"objectId": xsd:string
"objectType": xsd:unsignedInt
"accessLevel": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:object|osn:object]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/aclAdd?ownerId=val0&ownerType=0&objectId=val2&objectType=0&accessLevel=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @aclAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== aclModify ==
''' Request Parameters '''
<code>
{
"method": "aclModify",
"params": {
"ownerId": xsd:string
"ownerType": xsd:unsignedInt
"objectId": xsd:string
"objectType": xsd:unsignedInt
"accessLevel": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:object|osn:object]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/aclModify?ownerId=val0&ownerType=0&objectId=val2&objectType=0&accessLevel=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @aclModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== aclRemove ==
''' Request Parameters '''
<code>
{
"method": "aclRemove",
"params": {
"ownerId": xsd:string
"ownerType": xsd:unsignedInt
"objectId": xsd:string
"objectType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:object|osn:object]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/aclRemove?ownerId=val0&ownerType=0&objectId=val2&objectType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @aclRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== activeDirectoryDomainEnum ==
''' Request Parameters '''
<code>
{
"method": "activeDirectoryDomainEnum",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:activeDirDomain|osn:activeDirDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/activeDirectoryDomainEnum?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @activeDirectoryDomainEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== activeDirectoryUserAndGroupEnumEx ==
''' Request Parameters '''
<code>
{
"method": "activeDirectoryUserAndGroupEnumEx",
"params": {
"storageSystemId": xsd:string
"isGroup": xsd:boolean
"domain": xsd:string
"filter": xsd:string
"organizationalUnit": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:activeDirUserGroup|osn:activeDirUserGroup]]
"activeDirStatus": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/activeDirectoryUserAndGroupEnumEx?storageSystemId=val0&isGroup=val1&domain=val2&filter=val3&organizationalUnit=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @activeDirectoryUserAndGroupEnumEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertClear ==
''' Request Parameters '''
<code>
{
"method": "alertClear",
"params": {
"filter": xsd:string
"acknowledgeOnly": xsd:boolean
"closeOnly": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:alert|osn:alert]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertClear?filter=val0&acknowledgeOnly=val1&closeOnly=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertClear.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertClearAll ==
''' Request Parameters '''
<code>
{
"method": "alertClearAll",
"params": {
"acknowledgeOnly": xsd:boolean
"closeOnly": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:alert|osn:alert]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertClearAll?acknowledgeOnly=val0&closeOnly=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertClearAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertConfigEndpointEnum ==
''' Request Parameters '''
<code>
{
"method": "alertConfigEndpointEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:alertConfigEndpoint|osn:alertConfigEndpoint]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertConfigEndpointEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertConfigEndpointEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertConfigEndpointGet ==
''' Request Parameters '''
<code>
{
"method": "alertConfigEndpointGet",
"params": {
"alertConfigEndpoint": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:alertConfigEndpoint|osn:alertConfigEndpoint]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertConfigEndpointGet?alertConfigEndpoint=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertConfigEndpointGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertConfigGet ==
''' Request Parameters '''
<code>
{
"method": "alertConfigGet",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:alertConfigSettings|osn:alertConfigSettings]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertConfigGet?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertConfigGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertConfigSet ==
''' Request Parameters '''
<code>
{
"method": "alertConfigSet",
"params": {
"senderEmailAddress": xsd:string
"smtpServerIpAddress": xsd:string
"smtpServerPort": xsd:unsignedInt
"smtpUsername": xsd:string
"smtpPassword": xsd:string
"smtpAuthType": xsd:unsignedInt
"customerSupportEmailAddress": xsd:string
"poolFreeSpaceWarningThreshold": xsd:unsignedInt
"poolFreeSpaceAlertThreshold": xsd:unsignedInt
"poolFreeSpaceCriticalAlertThreshold": xsd:unsignedInt
"shareQuotaFreeSpaceWarningThreshold": xsd:unsignedInt
"shareQuotaFreeSpaceAlertThreshold": xsd:unsignedInt
"shareQuotaFreeSpaceCriticalThreshold": xsd:unsignedInt
"enableSyslogAlerts": xsd:boolean
"alertEndpoints": xsd:string
"enableAlertTypes": xsd:string
"disableAlertTypes": xsd:string
"pauseAlertTypes": xsd:string
"snmpUsername": xsd:string
"snmpPassword": xsd:string
"objectUserQuotaFreeSpaceWarningThreshold": xsd:unsignedInt
"objectUserQuotaFreeSpaceAlertThreshold": xsd:unsignedInt
"objectUserQuotaFreeSpaceCriticalThreshold": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:alertConfigSettings|osn:alertConfigSettings]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertConfigSet?senderEmailAddress=val0&smtpServerIpAddress=val1&smtpServerPort=0&smtpUsername=val3&smtpPassword=val4&smtpAuthType=0&customerSupportEmailAddress=val6&poolFreeSpaceWarningThreshold=0&poolFreeSpaceAlertThreshold=0&poolFreeSpaceCriticalAlertThreshold=0&shareQuotaFreeSpaceWarningThreshold=0&shareQuotaFreeSpaceAlertThreshold=0&shareQuotaFreeSpaceCriticalThreshold=0&enableSyslogAlerts=val13&alertEndpoints=val14&enableAlertTypes=val15&disableAlertTypes=val16&pauseAlertTypes=val17&snmpUsername=val18&snmpPassword=val19&objectUserQuotaFreeSpaceWarningThreshold=0&objectUserQuotaFreeSpaceAlertThreshold=0&objectUserQuotaFreeSpaceCriticalThreshold=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertConfigSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertEnum ==
''' Request Parameters '''
<code>
{
"method": "alertEnum",
"params": {
"filter": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:alert|osn:alert]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertEnum?filter=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertGet ==
''' Request Parameters '''
<code>
{
"method": "alertGet",
"params": {
"id": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:alert|osn:alert]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertGet?id=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertRaise ==
''' Request Parameters '''
<code>
{
"method": "alertRaise",
"params": {
"title": xsd:string
"message": xsd:string
"severity": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:alert|osn:alert]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertRaise?title=val0&message=val1&severity=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertRaise.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertTypeEnum ==
''' Request Parameters '''
<code>
{
"method": "alertTypeEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:alertType|osn:alertType]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertTypeEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertTypeEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== alertTypeGet ==
''' Request Parameters '''
<code>
{
"method": "alertTypeGet",
"params": {
"alertType": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:alertType|osn:alertType]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/alertTypeGet?alertType=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @alertTypeGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== auditLogEntryEnum ==
''' Request Parameters '''
<code>
{
"method": "auditLogEntryEnum",
"params": {
"storageSystem": xsd:string
"filterUserId": xsd:string
"filterAuditEntryTypes": xsd:unsignedInt
"entryCount": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:auditLogEntry|osn:auditLogEntry]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/auditLogEntryEnum?storageSystem=val0&filterUserId=val1&filterAuditEntryTypes=0&entryCount=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @auditLogEntryEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupJobCancel ==
''' Request Parameters '''
<code>
{
"method": "backupJobCancel",
"params": {
"backupJob": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupJob|osn:backupJob]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobCancel?backupJob=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupJobCancel.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupJobEnum ==
''' Request Parameters '''
<code>
{
"method": "backupJobEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:backupJob|osn:backupJob]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupJobEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupJobGet ==
''' Request Parameters '''
<code>
{
"method": "backupJobGet",
"params": {
"backupJob": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:backupJob|osn:backupJob]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobGet?backupJob=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupJobGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupJobStart ==
''' Request Parameters '''
<code>
{
"method": "backupJobStart",
"params": {
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupJob|osn:backupJob]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobStart?backupPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupJobStart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupJobStatusUpdate ==
''' Request Parameters '''
<code>
{
"method": "backupJobStatusUpdate",
"params": {
"statusXml": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupJob|osn:backupJob]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupJobStatusUpdate?statusXml=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupJobStatusUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyCreate ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyCreate",
"params": {
"name": xsd:string
"description": xsd:string
"networkShareId": xsd:string
"remoteHostname": xsd:string
"remoteExportPath": xsd:string
"remoteMountType": xsd:unsignedInt
"maxSnapshots": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"retentionCriteria": xsd:unsignedInt
"startDate": xsd:dateTime
"policyType": xsd:unsignedInt
"scanThreads": xsd:unsignedInt
"retentionDays": xsd:unsignedInt
"purgePolicy": xsd:unsignedInt
"createBackupLogs": xsd:boolean
"backupToShareRoot": xsd:boolean
"setEnabled": xsd:boolean
"scheduleType": xsd:unsignedInt
"delayInterval": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"retentionCountHourlies": xsd:unsignedInt
"retentionCountDailies": xsd:unsignedInt
"retentionCountWeeklies": xsd:unsignedInt
"retentionCountMonthlies": xsd:unsignedInt
"retentionCountQuarterlies": xsd:unsignedInt
"remoteSmbUsername": xsd:string
"remoteSmbPassword": xsd:string
"minFileAgeDays": xsd:unsignedInt
"maxFileAgeDays": xsd:unsignedInt
"createLinks": xsd:boolean
"remoteExportSubPath": xsd:string
"includeFilterStr": xsd:string
"excludeFilterStr": xsd:string
"minSizeThreshold": xsd:unsignedLong
"maxSizeThreshold": xsd:unsignedLong
"minStubThreshold": xsd:unsignedLong
"autoCopy": xsd:boolean
"forceRemoveTiered": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyCreate?name=val0&description=val1&networkShareId=val2&remoteHostname=val3&remoteExportPath=val4&remoteMountType=0&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&retentionCriteria=0&startDate=val10&policyType=0&scanThreads=0&retentionDays=0&purgePolicy=0&createBackupLogs=val15&backupToShareRoot=val16&setEnabled=val17&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&remoteSmbUsername=val26&remoteSmbPassword=val27&minFileAgeDays=0&maxFileAgeDays=0&createLinks=val30&remoteExportSubPath=val31&includeFilterStr=val32&excludeFilterStr=val33&minSizeThreshold=val34&maxSizeThreshold=val35&minStubThreshold=val36&autoCopy=val37&forceRemoveTiered=val38&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyDelete ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyDelete",
"params": {
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyDelete?backupPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyDisable ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyDisable",
"params": {
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyDisable?backupPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyEnable ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyEnable",
"params": {
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyEnable?backupPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyEnum ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyGet ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyGet",
"params": {
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyGet?backupPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyModify ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyModify",
"params": {
"backupPolicy": xsd:string
"name": xsd:string
"description": xsd:string
"networkShareId": xsd:string
"remoteHostname": xsd:string
"remoteExportPath": xsd:string
"remoteMountType": xsd:unsignedInt
"maxSnapshots": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"retentionCriteria": xsd:unsignedInt
"startDate": xsd:dateTime
"policyType": xsd:unsignedInt
"scanThreads": xsd:unsignedInt
"retentionDays": xsd:unsignedInt
"purgePolicy": xsd:unsignedInt
"createBackupLogs": xsd:boolean
"backupToShareRoot": xsd:boolean
"setEnabled": xsd:boolean
"scheduleType": xsd:unsignedInt
"delayInterval": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"retentionCountHourlies": xsd:unsignedInt
"retentionCountDailies": xsd:unsignedInt
"retentionCountWeeklies": xsd:unsignedInt
"retentionCountMonthlies": xsd:unsignedInt
"retentionCountQuarterlies": xsd:unsignedInt
"remoteSmbUsername": xsd:string
"remoteSmbPassword": xsd:string
"minFileAgeDays": xsd:unsignedInt
"maxFileAgeDays": xsd:unsignedInt
"createLinks": xsd:boolean
"remoteExportSubPath": xsd:string
"includeFilterStr": xsd:string
"excludeFilterStr": xsd:string
"minSizeThreshold": xsd:unsignedLong
"maxSizeThreshold": xsd:unsignedLong
"minAutoTierThreshold": xsd:unsignedLong
"autoCopy": xsd:boolean
"forceRemoveTiered": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyModify?backupPolicy=val0&name=val1&description=val2&networkShareId=val3&remoteHostname=val4&remoteExportPath=val5&remoteMountType=0&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&retentionCriteria=0&startDate=val11&policyType=0&scanThreads=0&retentionDays=0&purgePolicy=0&createBackupLogs=val16&backupToShareRoot=val17&setEnabled=val18&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&remoteSmbUsername=val27&remoteSmbPassword=val28&minFileAgeDays=0&maxFileAgeDays=0&createLinks=val31&remoteExportSubPath=val32&includeFilterStr=val33&excludeFilterStr=val34&minSizeThreshold=val35&maxSizeThreshold=val36&minAutoTierThreshold=val37&autoCopy=val38&forceRemoveTiered=val39&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== backupPolicyTrigger ==
''' Request Parameters '''
<code>
{
"method": "backupPolicyTrigger",
"params": {
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/backupPolicyTrigger?backupPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @backupPolicyTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketCreate ==
Creates a new S3 compatible bucket in the specified Ceph Cluster

''' Request Parameters '''
<code>
{
"method": "bucketCreate",
"params": {
"name": xsd:string
"cephClusterId": xsd:string
"quotaSize": xsd:unsignedLong
"userAccessEntry": xsd:string
"bucketAclType": xsd:unsignedInt {{Note|see osn__bucketAclType|inline=1}}
"enableVersioning": xsd:boolean
"objectLockMode": xsd:unsignedInt {{Note|see osn__bucketObjectLockMode|inline=1}}
"objectLockRetentionDays": xsd:unsignedInt
"enableLifecyclePolicy": xsd:boolean
"lifecyclePolicyDays": xsd:unsignedInt
"enableNetworkShareAccess": xsd:boolean
"estNumObjects": xsd:unsignedInt {{Note|estimated number of objects in the bucket|inline=1}}
"count": xsd:unsignedInt
"integrationOptions": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:bucket|osn:bucket]]
"list": [[#osn:bucket|osn:bucket]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketCreate?name=val0&cephClusterId=val1&quotaSize=val2&userAccessEntry=val3&bucketAclType=0&enableVersioning=val5&objectLockMode=0&objectLockRetentionDays=0&enableLifecyclePolicy=val8&lifecyclePolicyDays=0&enableNetworkShareAccess=val10&estNumObjects=0&count=0&integrationOptions=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketDelete ==
Deletes the specified S3 compatible bucket

''' Request Parameters '''
<code>
{
"method": "bucketDelete",
"params": {
"cephClusterId": xsd:string
"bucketList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:bucket|osn:bucket]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketDelete?cephClusterId=val0&bucketList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketEnum ==
Returns a list of all the buckets, optionally filtered by Ceph Cluster

''' Request Parameters '''
<code>
{
"method": "bucketEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:bucket|osn:bucket]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketGet ==
Returns detailed info of the specified bucket

''' Request Parameters '''
<code>
{
"method": "bucketGet",
"params": {
"cephClusterId": xsd:string
"bucket": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:bucket|osn:bucket]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketGet?cephClusterId=val0&bucket=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketModify ==
Modifies S3 compatible bucket with passed arguments

''' Request Parameters '''
<code>
{
"method": "bucketModify",
"params": {
"bucketId": xsd:string
"enableVersioning": xsd:boolean
"objectLockMode": xsd:unsignedInt {{Note|see osn__bucketObjectLockMode|inline=1}}
"objectLockRetentionDays": xsd:unsignedInt
"enableLifecyclePolicy": xsd:boolean
"lifecyclePolicyDays": xsd:unsignedInt
"enableNetworkShareAccess": xsd:boolean
"integrationOptions": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:bucket|osn:bucket]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketModify?bucketId=val0&enableVersioning=val1&objectLockMode=0&objectLockRetentionDays=0&enableLifecyclePolicy=val4&lifecyclePolicyDays=0&enableNetworkShareAccess=val6&integrationOptions=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketRescan ==
Starts an immediate scan for S3 compatible buckets that have been added or removed.

''' Request Parameters '''
<code>
{
"method": "bucketRescan",
"params": {
"cephClusterId": xsd:string
"scanOptions": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketRescan?cephClusterId=val0&scanOptions=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== bucketSearch ==
Returns a list of buckets based on a set of search parameters

''' Request Parameters '''
<code>
{
"method": "bucketSearch",
"params": {
"searchParams": xsd:string
"maxResults": xsd:unsignedInt
"offset": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:bucket|osn:bucket]]
"objCount": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/bucketSearch?searchParams=val0&maxResults=0&offset=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @bucketSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientConfExport ==
''' Request Parameters '''
<code>
{
"method": "cephClientConfExport",
"params": {
"cephCluster": xsd:string
"outfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephCluster|osn:cephCluster]]
"msg": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientConfExport?cephCluster=val0&outfile=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientConfExport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringCreate ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringCreate",
"params": {
"name": xsd:string
"clientKeyType": xsd:unsignedInt
"resourceList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephClientKeyring|osn:cephClientKeyring]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringCreate?name=val0&clientKeyType=0&resourceList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringDelete ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringDelete",
"params": {
"cephClient": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephClientKeyring|osn:cephClientKeyring]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringDelete?cephClient=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringEnum ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephClientKeyring|osn:cephClientKeyring]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringExport ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringExport",
"params": {
"cephClient": xsd:string
"outfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephClientKeyring|osn:cephClientKeyring]]
"msg": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringExport?cephClient=val0&outfile=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringExport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringGet ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringGet",
"params": {
"cephClient": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephClientKeyring|osn:cephClientKeyring]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringGet?cephClient=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringResourceAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringResourceAssocEnum",
"params": {
"cephClient": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephClientKeyringResourceAssoc|osn:cephClientKeyringResourceAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringResourceAssocEnum?cephClient=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringResourceAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClientKeyringResourceAssocGet ==
''' Request Parameters '''
<code>
{
"method": "cephClientKeyringResourceAssocGet",
"params": {
"cephClientId": xsd:string
"resourceId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephClientKeyringResourceAssoc|osn:cephClientKeyringResourceAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClientKeyringResourceAssocGet?cephClientId=val0&resourceId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClientKeyringResourceAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterAddNode ==
''' Request Parameters '''
<code>
{
"method": "cephClusterAddNode",
"params": {
"clusterId": xsd:string
"storageSystemId": xsd:string
"interfacePortId": xsd:string
"publicnetwork": xsd:string
"clusternetwork": xsd:string
"enableObjectStore": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterAddNode?clusterId=val0&storageSystemId=val1&interfacePortId=val2&publicnetwork=val3&clusternetwork=val4&enableObjectStore=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterAddNode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterCreate ==
''' Request Parameters '''
<code>
{
"method": "cephClusterCreate",
"params": {
"name": xsd:string
"description": xsd:string
"domainSuffix": xsd:string
"clientInterfacePortList": xsd:string
"backendInterfacePortList": xsd:string
"clientNetwork": xsd:string
"backendNetwork": xsd:string
"clusterAuthMode": xsd:unsignedInt
"osdOutSubtreeLimit": xsd:unsignedInt
"enableOsdEncryption": xsd:boolean
"encryptionMode": xsd:unsignedInt
"enableOsdCompression": xsd:boolean
"osdDownTimeoutSec": xsd:unsignedInt
"osdOutTimeoutSec": xsd:unsignedInt
"keyServerProfileId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterCreate?name=val0&description=val1&domainSuffix=val2&clientInterfacePortList=val3&backendInterfacePortList=val4&clientNetwork=val5&backendNetwork=val6&clusterAuthMode=0&osdOutSubtreeLimit=0&enableOsdEncryption=val9&encryptionMode=0&enableOsdCompression=val11&osdDownTimeoutSec=0&osdOutTimeoutSec=0&keyServerProfileId=val14&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterDelete ==
''' Request Parameters '''
<code>
{
"method": "cephClusterDelete",
"params": {
"cluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterDelete?cluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterEnum ==
''' Request Parameters '''
<code>
{
"method": "cephClusterEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterFixClockSkew ==
''' Request Parameters '''
<code>
{
"method": "cephClusterFixClockSkew",
"params": {
"cephCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterFixClockSkew?cephCluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterFixClockSkew.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterGet ==
''' Request Parameters '''
<code>
{
"method": "cephClusterGet",
"params": {
"cephCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterGet?cephCluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterHealthEventEnum ==
''' Request Parameters '''
<code>
{
"method": "cephClusterHealthEventEnum",
"params": {
"cephCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephClusterHealthEvent|osn:cephClusterHealthEvent]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterHealthEventEnum?cephCluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterHealthEventEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterHealthEventGet ==
''' Request Parameters '''
<code>
{
"method": "cephClusterHealthEventGet",
"params": {
"cephClusterHealthEvent": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephClusterHealthEvent|osn:cephClusterHealthEvent]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterHealthEventGet?cephClusterHealthEvent=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterHealthEventGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterImport ==
''' Request Parameters '''
<code>
{
"method": "cephClusterImport",
"params": {
"name": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterImport?name=val0&description=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterMemberEnum ==
''' Request Parameters '''
<code>
{
"method": "cephClusterMemberEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephClusterMember|osn:cephClusterMember]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterMemberEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterMemberEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterMemberGet ==
''' Request Parameters '''
<code>
{
"method": "cephClusterMemberGet",
"params": {
"cephCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephClusterMember|osn:cephClusterMember]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterMemberGet?cephCluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterMemberGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterModify ==
''' Request Parameters '''
<code>
{
"method": "cephClusterModify",
"params": {
"cephCluster": xsd:string
"name": xsd:string
"description": xsd:string
"osdDownTimeoutSec": xsd:unsignedInt
"osdOutTimeoutSec": xsd:unsignedInt
"nearFillFullPercent": xsd:unsignedInt
"backFillFullPercent": xsd:unsignedInt
"fullPercent": xsd:unsignedInt
"keyServerProfileId": xsd:string
"confOptions": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterModify?cephCluster=val0&name=val1&description=val2&osdDownTimeoutSec=0&osdOutTimeoutSec=0&nearFillFullPercent=0&backFillFullPercent=0&fullPercent=0&keyServerProfileId=val8&confOptions=val9&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterOsdKeyReplace ==
''' Request Parameters '''
<code>
{
"method": "cephClusterOsdKeyReplace",
"params": {
"cephCluster": xsd:string
"cephOsdList": xsd:string
"skipLockboxChange": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterOsdKeyReplace?cephCluster=val0&cephOsdList=val1&skipLockboxChange=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterOsdKeyReplace.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterRemoveNode ==
''' Request Parameters '''
<code>
{
"method": "cephClusterRemoveNode",
"params": {
"clusterId": xsd:string
"memberNodeId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterRemoveNode?clusterId=val0&memberNodeId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterRemoveNode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterServiceEventDelete ==
''' Request Parameters '''
<code>
{
"method": "cephClusterServiceEventDelete",
"params": {
"clusterId": xsd:string
"prune": xsd:boolean
"crashIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterServiceEventDelete?clusterId=val0&prune=val1&crashIdList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterServiceEventDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterServiceEventEnum ==
''' Request Parameters '''
<code>
{
"method": "cephClusterServiceEventEnum",
"params": {
"clusterId": xsd:string
"includeOld": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephClusterServiceEvent|osn:cephClusterServiceEvent]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterServiceEventEnum?clusterId=val0&includeOld=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterServiceEventEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterSetCoordinator ==
''' Request Parameters '''
<code>
{
"method": "cephClusterSetCoordinator",
"params": {
"cephCluster": xsd:string
"designatedCoordinatorId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterSetCoordinator?cephCluster=val0&designatedCoordinatorId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterSetCoordinator.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephClusterSetGlobalS3Quota ==
Modifies the global default quota settings for the cluster

''' Request Parameters '''
<code>
{
"method": "cephClusterSetGlobalS3Quota",
"params": {
"cephClusterId": xsd:string
"bucketMaxObjectCountEnable": xsd:boolean {{Note|enforce per bucket max object count for this user|inline=1}}
"bucketMaxObjectCount": xsd:unsignedLong
"bucketMaxSizeEnable": xsd:boolean {{Note|enforce per bucket max capacity for this user|inline=1}}
"bucketMaxSize": xsd:unsignedLong
"userMaxObjectCountEnable": xsd:boolean {{Note|enforce max object count for this user|inline=1}}
"userMaxObjectCount": xsd:unsignedLong
"userMaxSizeEnable": xsd:boolean {{Note|enforce max total capacity for this user|inline=1}}
"userMaxSize": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCluster|osn:cephCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephClusterSetGlobalS3Quota?cephClusterId=val0&bucketMaxObjectCountEnable=val1&bucketMaxObjectCount=val2&bucketMaxSizeEnable=val3&bucketMaxSize=val4&userMaxObjectCountEnable=val5&userMaxObjectCount=val6&userMaxSizeEnable=val7&userMaxSize=val8&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephClusterSetGlobalS3Quota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephCrushRuleCreate ==
''' Request Parameters '''
<code>
{
"method": "cephCrushRuleCreate",
"params": {
"name": xsd:string
"description": xsd:string
"cephClusterId": xsd:string
"crushRuleType": xsd:string
"failureDomain": xsd:string
"crushRoot": xsd:string
"deviceClass": xsd:string
"crushPoolProfileId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCrushRule|osn:cephCrushRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleCreate?name=val0&description=val1&cephClusterId=val2&crushRuleType=val3&failureDomain=val4&crushRoot=val5&deviceClass=val6&crushPoolProfileId=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephCrushRuleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephCrushRuleDelete ==
''' Request Parameters '''
<code>
{
"method": "cephCrushRuleDelete",
"params": {
"cephCrushRuleId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephCrushRule|osn:cephCrushRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleDelete?cephCrushRuleId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephCrushRuleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephCrushRuleEnum ==
''' Request Parameters '''
<code>
{
"method": "cephCrushRuleEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephCrushRule|osn:cephCrushRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephCrushRuleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephCrushRuleGet ==
''' Request Parameters '''
<code>
{
"method": "cephCrushRuleGet",
"params": {
"cephCrushRule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephCrushRule|osn:cephCrushRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephCrushRuleGet?cephCrushRule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephCrushRuleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephFilesystemCreate ==
''' Request Parameters '''
<code>
{
"method": "cephFilesystemCreate",
"params": {
"name": xsd:string
"description": xsd:string
"cephClusterId": xsd:string
"scalingFactor": xsd:unsignedInt
"maxReplicaCount": xsd:unsignedInt
"minReplicaCount": xsd:unsignedInt
"cephPoolType": xsd:string
"crushProfile": xsd:string
"activeMdsCount": xsd:unsignedInt
"standbyMdsCount": xsd:unsignedInt
"autoConfigNfs": xsd:boolean
"compressionAlgorithm": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephFilesystem|osn:cephFilesystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemCreate?name=val0&description=val1&cephClusterId=val2&scalingFactor=0&maxReplicaCount=0&minReplicaCount=0&cephPoolType=val6&crushProfile=val7&activeMdsCount=0&standbyMdsCount=0&autoConfigNfs=val10&compressionAlgorithm=val11&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephFilesystemCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephFilesystemDelete ==
''' Request Parameters '''
<code>
{
"method": "cephFilesystemDelete",
"params": {
"cephFilesystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephFilesystem|osn:cephFilesystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemDelete?cephFilesystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephFilesystemDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephFilesystemEnum ==
''' Request Parameters '''
<code>
{
"method": "cephFilesystemEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephFilesystem|osn:cephFilesystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephFilesystemEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephFilesystemGet ==
''' Request Parameters '''
<code>
{
"method": "cephFilesystemGet",
"params": {
"cephFilesystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephFilesystem|osn:cephFilesystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemGet?cephFilesystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephFilesystemGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephFilesystemModify ==
''' Request Parameters '''
<code>
{
"method": "cephFilesystemModify",
"params": {
"cephFilesystemId": xsd:string
"description": xsd:string
"activeMdsCount": xsd:unsignedInt
"standbyMdsCount": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephFilesystem|osn:cephFilesystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemModify?cephFilesystemId=val0&description=val1&activeMdsCount=0&standbyMdsCount=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephFilesystemModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephFilesystemPoolAdd ==
Adds a new data pool to the specified Ceph filesystem.

''' Request Parameters '''
<code>
{
"method": "cephFilesystemPoolAdd",
"params": {
"cephFilesystem": xsd:string {{Note|The Ceph filesystem to add the pool to|inline=1}}
"dataPoolSuffix": xsd:string {{Note|The suffix for the data pool|inline=1}}
"scalingFactor": xsd:unsignedInt {{Note|The scaling factor for the data pool|inline=1}}
"maxReplicaCount": xsd:unsignedInt {{Note|The maximum replica count for the data pool|inline=1}}
"minReplicaCount": xsd:unsignedInt {{Note|The minimum replica count for the data pool|inline=1}}
"cephPoolType": xsd:string {{Note|The type of the Ceph pool (replicated, erasure)|inline=1}}
"crushProfile": xsd:string {{Note|The crush profile for the Ceph pool|inline=1}}
"cephCluster": xsd:string {{Note|The Ceph cluster to add the pool to|inline=1}}
"compressionAlgorithm": xsd:string {{Note|The compression algorithm for the Ceph pool|inline=1}}
"flags": xsd:unsignedInt {{Note|Flags for the operation|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephFilesystem|osn:cephFilesystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephFilesystemPoolAdd?cephFilesystem=val0&dataPoolSuffix=val1&scalingFactor=0&maxReplicaCount=0&minReplicaCount=0&cephPoolType=val5&crushProfile=val6&cephCluster=val7&compressionAlgorithm=val8&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephFilesystemPoolAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalDeviceCreate ==
''' Request Parameters '''
<code>
{
"method": "cephJournalDeviceCreate",
"params": {
"cephJournalGroup": xsd:string
"size": xsd:unsignedLong
"mirrorJournals": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephJournalDevice|osn:cephJournalDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceCreate?cephJournalGroup=val0&size=val1&mirrorJournals=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalDeviceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalDeviceDelete ==
''' Request Parameters '''
<code>
{
"method": "cephJournalDeviceDelete",
"params": {
"cephJournalDevice": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephJournalDevice|osn:cephJournalDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceDelete?cephJournalDevice=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalDeviceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalDeviceEnum ==
''' Request Parameters '''
<code>
{
"method": "cephJournalDeviceEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephJournalDevice|osn:cephJournalDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalDeviceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalDeviceGet ==
''' Request Parameters '''
<code>
{
"method": "cephJournalDeviceGet",
"params": {
"cephJournalDevice": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephJournalDevice|osn:cephJournalDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceGet?cephJournalDevice=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalDeviceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalDeviceMigrate ==
''' Request Parameters '''
<code>
{
"method": "cephJournalDeviceMigrate",
"params": {
"cephCluster": xsd:string
"cephJournalDevice": xsd:string
"newJournalGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephJournalDevice|osn:cephJournalDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalDeviceMigrate?cephCluster=val0&cephJournalDevice=val1&newJournalGroup=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalDeviceMigrate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "cephJournalGroupCreate",
"params": {
"primaryDisk": xsd:string
"secondaryDisk": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephJournalGroup|osn:cephJournalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupCreate?primaryDisk=val0&secondaryDisk=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "cephJournalGroupDelete",
"params": {
"cephJournalGroupId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephJournalGroup|osn:cephJournalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupDelete?cephJournalGroupId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "cephJournalGroupEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephJournalGroup|osn:cephJournalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephJournalGroupGet ==
''' Request Parameters '''
<code>
{
"method": "cephJournalGroupGet",
"params": {
"cephJournalGroupId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephJournalGroup|osn:cephJournalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephJournalGroupGet?cephJournalGroupId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephJournalGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMdsAdd ==
''' Request Parameters '''
<code>
{
"method": "cephMdsAdd",
"params": {
"cephMemberIdList": xsd:string
"clusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephMds|osn:cephMds]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsAdd?cephMemberIdList=val0&clusterId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMdsAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMdsEnum ==
''' Request Parameters '''
<code>
{
"method": "cephMdsEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephMds|osn:cephMds]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMdsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMdsGet ==
''' Request Parameters '''
<code>
{
"method": "cephMdsGet",
"params": {
"cephMds": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephMds|osn:cephMds]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsGet?cephMds=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMdsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMdsRemove ==
''' Request Parameters '''
<code>
{
"method": "cephMdsRemove",
"params": {
"clusterId": xsd:string
"mdsNodeId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephMds|osn:cephMds]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMdsRemove?clusterId=val0&mdsNodeId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMdsRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMonitorAdd ==
''' Request Parameters '''
<code>
{
"method": "cephMonitorAdd",
"params": {
"clusterId": xsd:string
"cephMemberId": xsd:string
"monitorIPAddress": xsd:string
"monitorPort": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephMonitor|osn:cephMonitor]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorAdd?clusterId=val0&cephMemberId=val1&monitorIPAddress=val2&monitorPort=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMonitorAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMonitorEnum ==
''' Request Parameters '''
<code>
{
"method": "cephMonitorEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephMonitor|osn:cephMonitor]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMonitorEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMonitorGet ==
''' Request Parameters '''
<code>
{
"method": "cephMonitorGet",
"params": {
"cephMonitor": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephMonitor|osn:cephMonitor]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorGet?cephMonitor=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMonitorGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMonitorRemove ==
''' Request Parameters '''
<code>
{
"method": "cephMonitorRemove",
"params": {
"clusterId": xsd:string
"monitorNodeId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephMonitor|osn:cephMonitor]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMonitorRemove?clusterId=val0&monitorNodeId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMonitorRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMultiOsdCreate ==
''' Request Parameters '''
<code>
{
"method": "cephMultiOsdCreate",
"params": {
"cephClusterId": xsd:string
"physicalDiskList": xsd:string
"journalDiskList": xsd:string
"useExistingJournalGroups": xsd:boolean
"mirrorJournals": xsd:boolean
"quickFormat": xsd:boolean
"allowedMixedSizeJournalMedia": xsd:boolean
"forceExternalJDev": xsd:boolean
"enableDynamicWeighting": xsd:boolean
"sizeWAL": xsd:unsignedLong
"sizeDB": xsd:unsignedLong
"osdType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMultiOsdCreate?cephClusterId=val0&physicalDiskList=val1&journalDiskList=val2&useExistingJournalGroups=val3&mirrorJournals=val4&quickFormat=val5&allowedMixedSizeJournalMedia=val6&forceExternalJDev=val7&enableDynamicWeighting=val8&sizeWAL=val9&sizeDB=val10&osdType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMultiOsdCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephMultiOsdDelete ==
''' Request Parameters '''
<code>
{
"method": "cephMultiOsdDelete",
"params": {
"cephClusterId": xsd:string
"osdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephMultiOsdDelete?cephClusterId=val0&osdList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephMultiOsdDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupCreate",
"params": {
"cephClusterId": xsd:string
"description": xsd:string
"zone": xsd:string
"zoneGroup": xsd:string
"dataPoolType": xsd:string
"maxReplicaCount": xsd:unsignedInt
"minReplicaCount": xsd:unsignedInt
"poolProfile": xsd:string
"scalingFactor": xsd:unsignedInt
"autoConfigNfs": xsd:boolean
"compressionAlgorithm": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupCreate?cephClusterId=val0&description=val1&zone=val2&zoneGroup=val3&dataPoolType=val4&maxReplicaCount=0&minReplicaCount=0&poolProfile=val7&scalingFactor=0&autoConfigNfs=val9&compressionAlgorithm=val10&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupDelete",
"params": {
"cephObjectStoragePoolGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupDelete?cephObjectStoragePoolGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupGet ==
''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupGet",
"params": {
"cephObjectStoragePoolGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupGet?cephObjectStoragePoolGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupModify ==
''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupModify",
"params": {
"cephObjectStoragePoolGroupId": xsd:string
"description": xsd:string
"zoneName": xsd:string
"zoneGroupName": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupModify?cephObjectStoragePoolGroupId=val0&description=val1&zoneName=val2&zoneGroupName=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupMultiSiteSetup ==
Configure multi-site replication between two object storage pool groups

''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupMultiSiteSetup",
"params": {
"primaryObjectStoragePoolGroupId": xsd:string {{Note|the primary object storage pool group to configure|inline=1}}
"primaryGatewayId": xsd:string {{Note|the primary gateway to configure|inline=1}}
"secondaryObjectStoragePoolGroupId": xsd:string {{Note|the secondary object storage pool group to configure|inline=1}}
"secondaryGatewayId": xsd:string {{Note|the secondary gateway to configure|inline=1}}
"symmetrical": xsd:boolean {{Note|if true, primary and secondary will be configured to replicate entire zone|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupMultiSiteSetup?primaryObjectStoragePoolGroupId=val0&primaryGatewayId=val1&secondaryObjectStoragePoolGroupId=val2&secondaryGatewayId=val3&symmetrical=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupMultiSiteSetup.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupMultiSiteUnconfigure ==
Remove from multi-site

''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupMultiSiteUnconfigure",
"params": {
"cephObjectStoragePoolGroupId": xsd:string {{Note|the object storage pool group to unconfigure. This should be the secondary pool group|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephObjectPoolGroup|osn:cephObjectPoolGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupMultiSiteUnconfigure?cephObjectStoragePoolGroupId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupMultiSiteUnconfigure.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectPoolGroupStorageClassCreate ==
''' Request Parameters '''
<code>
{
"method": "cephObjectPoolGroupStorageClassCreate",
"params": {
"cephPoolGroup": xsd:string
"storageClassName": xsd:string
"scalingFactor": xsd:unsignedInt
"maxReplicaCount": xsd:unsignedInt
"minReplicaCount": xsd:unsignedInt
"cephPoolType": xsd:string
"crushProfile": xsd:string
"cephCluster": xsd:string
"customStorageClassName": xsd:boolean
"compressionAlgorithm": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephObjectStorageClass|osn:cephObjectStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectPoolGroupStorageClassCreate?cephPoolGroup=val0&storageClassName=val1&scalingFactor=0&maxReplicaCount=0&minReplicaCount=0&cephPoolType=val5&crushProfile=val6&cephCluster=val7&customStorageClassName=val8&compressionAlgorithm=val9&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectPoolGroupStorageClassCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectStorageClassEnum ==
''' Request Parameters '''
<code>
{
"method": "cephObjectStorageClassEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephObjectStorageClass|osn:cephObjectStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectStorageClassEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectStorageClassEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectStorageClassGet ==
''' Request Parameters '''
<code>
{
"method": "cephObjectStorageClassGet",
"params": {
"cephObjectStorageStorageClass": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephObjectStorageClass|osn:cephObjectStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectStorageClassGet?cephObjectStorageStorageClass=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectStorageClassGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectStorageClassRuleAddRemove ==
''' Request Parameters '''
<code>
{
"method": "cephObjectStorageClassRuleAddRemove",
"params": {
"cephClusterId": xsd:string
"modType": xsd:unsignedInt
"ruleList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephObjectStorageClassRule|osn:cephObjectStorageClassRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectStorageClassRuleAddRemove?cephClusterId=val0&modType=0&ruleList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectStorageClassRuleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectStorageClassRuleEnum ==
''' Request Parameters '''
<code>
{
"method": "cephObjectStorageClassRuleEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephObjectStorageClassRule|osn:cephObjectStorageClassRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectStorageClassRuleEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectStorageClassRuleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectStorageClassRuleGet ==
''' Request Parameters '''
<code>
{
"method": "cephObjectStorageClassRuleGet",
"params": {
"storageClassRule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephObjectStorageClassRule|osn:cephObjectStorageClassRule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectStorageClassRuleGet?storageClassRule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectStorageClassRuleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectZoneEnum ==
''' Request Parameters '''
<code>
{
"method": "cephObjectZoneEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephObjectZone|osn:cephObjectZone]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectZoneEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectZoneEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectZoneGet ==
''' Request Parameters '''
<code>
{
"method": "cephObjectZoneGet",
"params": {
"cephObjectStorageZone": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephObjectZone|osn:cephObjectZone]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectZoneGet?cephObjectStorageZone=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectZoneGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectZoneGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "cephObjectZoneGroupEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephObjectZoneGroup|osn:cephObjectZoneGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectZoneGroupEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectZoneGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectZoneGroupGet ==
''' Request Parameters '''
<code>
{
"method": "cephObjectZoneGroupGet",
"params": {
"cephObjectStorageZoneGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephObjectZoneGroup|osn:cephObjectZoneGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectZoneGroupGet?cephObjectStorageZoneGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectZoneGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephObjectZoneGroupModify ==
''' Request Parameters '''
<code>
{
"method": "cephObjectZoneGroupModify",
"params": {
"cephClusterId": xsd:string
"cephObjectStorageZoneGroup": xsd:string
"hostnameList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephObjectZoneGroup|osn:cephObjectZoneGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephObjectZoneGroupModify?cephClusterId=val0&cephObjectStorageZoneGroup=val1&hostnameList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephObjectZoneGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdCreate ==
''' Request Parameters '''
<code>
{
"method": "cephOsdCreate",
"params": {
"description": xsd:string
"cephClusterId": xsd:string
"datastoragePoolId": xsd:string
"journalGroupId": xsd:string
"enableWAL": xsd:boolean
"enableDB": xsd:boolean
"walSize": xsd:unsignedLong
"dbSize": xsd:unsignedLong
"osdType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdCreate?description=val0&cephClusterId=val1&datastoragePoolId=val2&journalGroupId=val3&enableWAL=val4&enableDB=val5&walSize=val6&dbSize=val7&osdType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdEnum ==
''' Request Parameters '''
<code>
{
"method": "cephOsdEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdGet ==
''' Request Parameters '''
<code>
{
"method": "cephOsdGet",
"params": {
"cephOsd": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdGet?cephOsd=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdIdentify ==
''' Request Parameters '''
<code>
{
"method": "cephOsdIdentify",
"params": {
"osdIdList": xsd:string
"durationInSeconds": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdIdentify?osdIdList=val0&durationInSeconds=0&blinkType=0&cephClusterId=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdKeyReplace ==
''' Request Parameters '''
<code>
{
"method": "cephOsdKeyReplace",
"params": {
"cephClusterMember": xsd:string
"cephOsdList": xsd:string
"skipLockboxChange": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephClusterMember|osn:cephClusterMember]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdKeyReplace?cephClusterMember=val0&cephOsdList=val1&skipLockboxChange=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdKeyReplace.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdModify ==
''' Request Parameters '''
<code>
{
"method": "cephOsdModify",
"params": {
"cephClusterId": xsd:string
"cephOsd": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdModify?cephClusterId=val0&cephOsd=val1&description=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdReplace ==
''' Request Parameters '''
<code>
{
"method": "cephOsdReplace",
"params": {
"disk": xsd:string
"cephOsd": xsd:string
"storagesystem": xsd:string
"recreateJournalDevices": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdReplace?disk=val0&cephOsd=val1&storagesystem=val2&recreateJournalDevices=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdReplace.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdReplacePrepare ==
''' Request Parameters '''
<code>
{
"method": "cephOsdReplacePrepare",
"params": {
"cephOsd": xsd:string
"storagesystem": xsd:string
"allowOnNoDegraded": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdReplacePrepare?cephOsd=val0&storagesystem=val1&allowOnNoDegraded=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdReplacePrepare.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdReweight ==
''' Request Parameters '''
<code>
{
"method": "cephOsdReweight",
"params": {
"cephClusterId": xsd:string
"osdIdToCapacityList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdReweight?cephClusterId=val0&osdIdToCapacityList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdReweight.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephOsdServiceUpdate ==
''' Request Parameters '''
<code>
{
"method": "cephOsdServiceUpdate",
"params": {
"osdIdList": xsd:string
"mode": xsd:unsignedInt
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephOsd|osn:cephOsd]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephOsdServiceUpdate?osdIdList=val0&mode=0&cephClusterId=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephOsdServiceUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPgSetEnum ==
''' Request Parameters '''
<code>
{
"method": "cephPgSetEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephPgSet|osn:cephPgSet]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPgSetEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPgSetEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPgSetGet ==
''' Request Parameters '''
<code>
{
"method": "cephPgSetGet",
"params": {
"cephPgSet": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephPgSet|osn:cephPgSet]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPgSetGet?cephPgSet=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPgSetGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolCreate ==
''' Request Parameters '''
<code>
{
"method": "cephPoolCreate",
"params": {
"name": xsd:string
"description": xsd:string
"cephClusterId": xsd:string
"scalingFactor": xsd:unsignedInt
"maxReplicaCount": xsd:unsignedInt
"minReplicaCount": xsd:unsignedInt
"cephPoolType": xsd:string
"crushProfile": xsd:string
"cephPoolUseCase": xsd:unsignedInt
"enableCacheTier": xsd:boolean
"compressionAlgorithm": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPool|osn:cephPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolCreate?name=val0&description=val1&cephClusterId=val2&scalingFactor=0&maxReplicaCount=0&minReplicaCount=0&cephPoolType=val6&crushProfile=val7&cephPoolUseCase=0&enableCacheTier=val9&compressionAlgorithm=val10&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolDelete ==
''' Request Parameters '''
<code>
{
"method": "cephPoolDelete",
"params": {
"cephClusterId": xsd:string
"cephPool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPool|osn:cephPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolDelete?cephClusterId=val0&cephPool=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolEnum ==
''' Request Parameters '''
<code>
{
"method": "cephPoolEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephPool|osn:cephPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolGet ==
''' Request Parameters '''
<code>
{
"method": "cephPoolGet",
"params": {
"cephPool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephPool|osn:cephPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolGet?cephPool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolGroupAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "cephPoolGroupAssocEnum",
"params": {
"cephFilesystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephPoolGroupAssoc|osn:cephPoolGroupAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolGroupAssocEnum?cephFilesystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolGroupAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolGroupAssocGet ==
''' Request Parameters '''
<code>
{
"method": "cephPoolGroupAssocGet",
"params": {
"cephFilesystemId": xsd:string
"cephPoolId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephPoolGroupAssoc|osn:cephPoolGroupAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolGroupAssocGet?cephFilesystemId=val0&cephPoolId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolGroupAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolModify ==
''' Request Parameters '''
<code>
{
"method": "cephPoolModify",
"params": {
"cephClusterId": xsd:string
"cephPool": xsd:string
"name": xsd:string
"description": xsd:string
"maxReplicaCount": xsd:unsignedInt
"poolCrushRule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPool|osn:cephPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolModify?cephClusterId=val0&cephPool=val1&name=val2&description=val3&maxReplicaCount=0&poolCrushRule=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolNamespaceCreate ==
''' Request Parameters '''
<code>
{
"method": "cephPoolNamespaceCreate",
"params": {
"name": xsd:string
"description": xsd:string
"cephClusterId": xsd:string
"cephPoolId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPoolNamespace|osn:cephPoolNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolNamespaceCreate?name=val0&description=val1&cephClusterId=val2&cephPoolId=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolNamespaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolNamespaceDelete ==
''' Request Parameters '''
<code>
{
"method": "cephPoolNamespaceDelete",
"params": {
"cephClusterId": xsd:string
"cephPool": xsd:string
"cephPoolNamespace": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPoolNamespace|osn:cephPoolNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolNamespaceDelete?cephClusterId=val0&cephPool=val1&cephPoolNamespace=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolNamespaceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolNamespaceEnum ==
''' Request Parameters '''
<code>
{
"method": "cephPoolNamespaceEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephPoolNamespace|osn:cephPoolNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolNamespaceEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolNamespaceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolNamespaceGet ==
''' Request Parameters '''
<code>
{
"method": "cephPoolNamespaceGet",
"params": {
"cephPoolNamespace": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephPoolNamespace|osn:cephPoolNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolNamespaceGet?cephPoolNamespace=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolNamespaceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolProfileCreate ==
''' Request Parameters '''
<code>
{
"method": "cephPoolProfileCreate",
"params": {
"name": xsd:string
"description": xsd:string
"cephClusterId": xsd:string
"dataChunkCount": xsd:unsignedInt
"codeChunkCount": xsd:unsignedInt
"failureDomain": xsd:string
"technique": xsd:string
"plugin": xsd:string
"storageClass": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPoolProfile|osn:cephPoolProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileCreate?name=val0&description=val1&cephClusterId=val2&dataChunkCount=0&codeChunkCount=0&failureDomain=val5&technique=val6&plugin=val7&storageClass=val8&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolProfileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolProfileDelete ==
''' Request Parameters '''
<code>
{
"method": "cephPoolProfileDelete",
"params": {
"cephPoolProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephPoolProfile|osn:cephPoolProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileDelete?cephPoolProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolProfileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolProfileEnum ==
''' Request Parameters '''
<code>
{
"method": "cephPoolProfileEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephPoolProfile|osn:cephPoolProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephPoolProfileGet ==
''' Request Parameters '''
<code>
{
"method": "cephPoolProfileGet",
"params": {
"cephPoolProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephPoolProfile|osn:cephPoolProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephPoolProfileGet?cephPoolProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephPoolProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephRadosGatewayAdd ==
''' Request Parameters '''
<code>
{
"method": "cephRadosGatewayAdd",
"params": {
"clusterId": xsd:string
"cephRadosGatewayIPAddress": xsd:string
"cephRadosGatewayPort": xsd:unsignedInt
"serviceEngine": xsd:unsignedInt
"serviceMode": xsd:unsignedInt
"options": xsd:string
"certificatePemData": xsd:string
"redirect": xsd:boolean
"loadbalance": xsd:boolean
"loadBalancerMappingMode": xsd:unsignedInt
"useTcpChecks": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:cephRadosGateway|osn:cephRadosGateway]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayAdd?clusterId=val0&cephRadosGatewayIPAddress=val1&cephRadosGatewayPort=0&serviceEngine=0&serviceMode=0&options=val5&certificatePemData=val6&redirect=val7&loadbalance=val8&loadBalancerMappingMode=0&useTcpChecks=val10&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephRadosGatewayAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephRadosGatewayEnum ==
''' Request Parameters '''
<code>
{
"method": "cephRadosGatewayEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cephRadosGateway|osn:cephRadosGateway]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephRadosGatewayEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephRadosGatewayGet ==
''' Request Parameters '''
<code>
{
"method": "cephRadosGatewayGet",
"params": {
"cephGatewayId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cephRadosGateway|osn:cephRadosGateway]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayGet?cephGatewayId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephRadosGatewayGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephRadosGatewayModify ==
''' Request Parameters '''
<code>
{
"method": "cephRadosGatewayModify",
"params": {
"cephRadosGatewayId": xsd:string
"enableLoadBalancing": xsd:boolean
"enableActiveMonitoring": xsd:boolean
"cephRgwSettings": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephRadosGateway|osn:cephRadosGateway]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayModify?cephRadosGatewayId=val0&enableLoadBalancing=val1&enableActiveMonitoring=val2&cephRgwSettings=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephRadosGatewayModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephRadosGatewayRemove ==
''' Request Parameters '''
<code>
{
"method": "cephRadosGatewayRemove",
"params": {
"clusterId": xsd:string
"cephRadosGatewayId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephRadosGateway|osn:cephRadosGateway]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayRemove?clusterId=val0&cephRadosGatewayId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephRadosGatewayRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cephRadosGatewayStartStopRestart ==
''' Request Parameters '''
<code>
{
"method": "cephRadosGatewayStartStopRestart",
"params": {
"cephRadosGatewayId": xsd:string
"modType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cephRadosGateway|osn:cephRadosGateway]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cephRadosGatewayStartStopRestart?cephRadosGatewayId=val0&modType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cephRadosGatewayStartStopRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateEnum ==
''' Request Parameters '''
<code>
{
"method": "certificateEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:certificate|osn:certificate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateGet ==
''' Request Parameters '''
<code>
{
"method": "certificateGet",
"params": {
"certificateId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:certificate|osn:certificate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateGet?certificateId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateRescan ==
''' Request Parameters '''
<code>
{
"method": "certificateRescan",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:certificate|osn:certificate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateRescan?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateTemplateAdd ==
''' Request Parameters '''
<code>
{
"method": "certificateTemplateAdd",
"params": {
"name": xsd:string
"description": xsd:string
"pemFileContentCertificate": xsd:string
"pemFileContentPrivateKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:certificateTemplate|osn:certificateTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateTemplateAdd?name=val0&description=val1&pemFileContentCertificate=val2&pemFileContentPrivateKey=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateTemplateAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateTemplateEnum ==
''' Request Parameters '''
<code>
{
"method": "certificateTemplateEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:certificateTemplate|osn:certificateTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateTemplateEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateTemplateEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateTemplateGet ==
''' Request Parameters '''
<code>
{
"method": "certificateTemplateGet",
"params": {
"certificateId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:certificateTemplate|osn:certificateTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateTemplateGet?certificateId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateTemplateGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateTemplateRemove ==
''' Request Parameters '''
<code>
{
"method": "certificateTemplateRemove",
"params": {
"certificateId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:certificateTemplate|osn:certificateTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateTemplateRemove?certificateId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateTemplateRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== certificateUpdate ==
''' Request Parameters '''
<code>
{
"method": "certificateUpdate",
"params": {
"storageSystemId": xsd:string
"useCase": xsd:unsignedInt
"certificateTemplateId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:certificate|osn:certificate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/certificateUpdate?storageSystemId=val0&useCase=0&certificateTemplateId=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @certificateUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clientConnectionEnum ==
Returns a list of all the client connections tot he specified storage system

''' Request Parameters '''
<code>
{
"method": "clientConnectionEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:clientConnection|osn:clientConnection]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clientConnectionEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clientConnectionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerAdd ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerAdd",
"params": {
"credentialsId": xsd:string
"locationId": xsd:string
"encryptionKey": xsd:string
"storageUrl": xsd:string
"enableNfs": xsd:boolean
"attachToStorageSystem": xsd:string
"containerType": xsd:unsignedInt
"mountOptions": xsd:string
"storageClass": xsd:string
"cacheMode": xsd:unsignedInt
"dirCacheTime": xsd:string
"cacheShareId": xsd:string
"bufferSize": xsd:unsignedLong
"vfsCacheMaxAge": xsd:string
"vfsCacheMaxSize": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerAdd?credentialsId=val0&locationId=val1&encryptionKey=val2&storageUrl=val3&enableNfs=val4&attachToStorageSystem=val5&containerType=0&mountOptions=val7&storageClass=val8&cacheMode=0&dirCacheTime=val10&cacheShareId=val11&bufferSize=val12&vfsCacheMaxAge=val13&vfsCacheMaxSize=val14&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerBucketScan ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerBucketScan",
"params": {
"credentialsId": xsd:string
"locationId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerBucketScan?credentialsId=val0&locationId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerBucketScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerCacheSettingsGet ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerCacheSettingsGet",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cloudContainerCacheSettings|osn:cloudContainerCacheSettings]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerCacheSettingsGet?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerCacheSettingsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerCacheSettingsModify ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerCacheSettingsModify",
"params": {
"cloudSettingsId": xsd:string
"cacheMode": xsd:unsignedInt
"dirCacheTime": xsd:string
"cacheShareId": xsd:string
"bufferSize": xsd:unsignedLong
"vfsCacheMaxAge": xsd:string
"vfsCacheMaxSize": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainerCacheSettings|osn:cloudContainerCacheSettings]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerCacheSettingsModify?cloudSettingsId=val0&cacheMode=0&dirCacheTime=val2&cacheShareId=val3&bufferSize=val4&vfsCacheMaxAge=val5&vfsCacheMaxSize=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerCacheSettingsModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerCreate ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerCreate",
"params": {
"name": xsd:string
"description": xsd:string
"credentialsId": xsd:string
"locationId": xsd:string
"encryptionKey": xsd:string
"storageUrl": xsd:string
"enableNfs": xsd:boolean
"attachToStorageSystem": xsd:string
"containerType": xsd:unsignedInt
"mountOptions": xsd:string
"storageClass": xsd:string
"cacheMode": xsd:unsignedInt
"dirCacheTime": xsd:string
"cacheShareId": xsd:string
"bufferSize": xsd:unsignedLong
"vfsCacheMaxAge": xsd:string
"vfsCacheMaxSize": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerCreate?name=val0&description=val1&credentialsId=val2&locationId=val3&encryptionKey=val4&storageUrl=val5&enableNfs=val6&attachToStorageSystem=val7&containerType=0&mountOptions=val9&storageClass=val10&cacheMode=0&dirCacheTime=val12&cacheShareId=val13&bufferSize=val14&vfsCacheMaxAge=val15&vfsCacheMaxSize=val16&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerDelete ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerDelete",
"params": {
"container": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerDelete?container=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerDisable ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerDisable",
"params": {
"container": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerDisable?container=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerEnable ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerEnable",
"params": {
"container": xsd:string
"attachToStorageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerEnable?container=val0&attachToStorageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerEnum ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerGet ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerGet",
"params": {
"container": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerGet?container=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerRepair ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerRepair",
"params": {
"container": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerRepair?container=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerRepair.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudContainerRescan ==
''' Request Parameters '''
<code>
{
"method": "cloudContainerRescan",
"params": {
"container": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudContainerRescan?container=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudContainerRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderAdd ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderAdd",
"params": {
"name": xsd:string
"description": xsd:string
"locationName": xsd:string
"locationTag": xsd:string
"locationEndpoint": xsd:string
"credUsername": xsd:string
"credPassword": xsd:string
"credProjectId": xsd:string
"authFile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProvider|osn:cloudProvider]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderAdd?name=val0&description=val1&locationName=val2&locationTag=val3&locationEndpoint=val4&credUsername=val5&credPassword=val6&credProjectId=val7&authFile=val8&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderCredentialsAdd ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderCredentialsAdd",
"params": {
"username": xsd:string
"password": xsd:string
"providerId": xsd:string
"machine": xsd:string
"projectId": xsd:string
"authFile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProviderCredentials|osn:cloudProviderCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsAdd?username=val0&password=val1&providerId=val2&machine=val3&projectId=val4&authFile=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderCredentialsAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderCredentialsEnum ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderCredentialsEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cloudProviderCredentials|osn:cloudProviderCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderCredentialsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderCredentialsGet ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderCredentialsGet",
"params": {
"credentialId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cloudProviderCredentials|osn:cloudProviderCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsGet?credentialId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderCredentialsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderCredentialsRemove ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderCredentialsRemove",
"params": {
"credentialsId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProviderCredentials|osn:cloudProviderCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderCredentialsRemove?credentialsId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderCredentialsRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderEnum ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cloudProvider|osn:cloudProvider]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderGet ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderGet",
"params": {
"providerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cloudProvider|osn:cloudProvider]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderGet?providerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderLocationAdd ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderLocationAdd",
"params": {
"providerId": xsd:string
"name": xsd:string
"locationTag": xsd:string
"endpoint": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProviderLocation|osn:cloudProviderLocation]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationAdd?providerId=val0&name=val1&locationTag=val2&endpoint=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderLocationAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderLocationEnum ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderLocationEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cloudProviderLocation|osn:cloudProviderLocation]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderLocationEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderLocationGet ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderLocationGet",
"params": {
"locationId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cloudProviderLocation|osn:cloudProviderLocation]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationGet?locationId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderLocationGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderLocationRemove ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderLocationRemove",
"params": {
"locationId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProviderLocation|osn:cloudProviderLocation]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderLocationRemove?locationId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderLocationRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderRemove ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderRemove",
"params": {
"providerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProvider|osn:cloudProvider]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderRemove?providerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderStorageClassAdd ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderStorageClassAdd",
"params": {
"providerId": xsd:string
"storageClassTag": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProviderStorageClass|osn:cloudProviderStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderStorageClassAdd?providerId=val0&storageClassTag=val1&description=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderStorageClassAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderStorageClassEnum ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderStorageClassEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:cloudProviderStorageClass|osn:cloudProviderStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderStorageClassEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderStorageClassEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderStorageClassGet ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderStorageClassGet",
"params": {
"storageClass": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:cloudProviderStorageClass|osn:cloudProviderStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderStorageClassGet?storageClass=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderStorageClassGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== cloudProviderStorageClassRemove ==
''' Request Parameters '''
<code>
{
"method": "cloudProviderStorageClassRemove",
"params": {
"storageClass": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:cloudProviderStorageClass|osn:cloudProviderStorageClass]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/cloudProviderStorageClassRemove?storageClass=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @cloudProviderStorageClassRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clusterRingCreate ==
''' Request Parameters '''
<code>
{
"method": "clusterRingCreate",
"params": {
"siteClusterId": xsd:string
"ring": xsd:unsignedInt
"mcastPort": xsd:unsignedInt
"bindNetAddress": xsd:string
"memberAddresses": xsd:string
"options": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:clusterRing|osn:clusterRing]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingCreate?siteClusterId=val0&ring=0&mcastPort=0&bindNetAddress=val3&memberAddresses=val4&options=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clusterRingCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clusterRingDelete ==
''' Request Parameters '''
<code>
{
"method": "clusterRingDelete",
"params": {
"clusterRing": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:clusterRing|osn:clusterRing]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingDelete?clusterRing=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clusterRingDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clusterRingEnum ==
''' Request Parameters '''
<code>
{
"method": "clusterRingEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:clusterRing|osn:clusterRing]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clusterRingEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clusterRingGet ==
''' Request Parameters '''
<code>
{
"method": "clusterRingGet",
"params": {
"clusterRing": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:clusterRing|osn:clusterRing]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingGet?clusterRing=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clusterRingGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clusterRingMemberEnum ==
''' Request Parameters '''
<code>
{
"method": "clusterRingMemberEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:clusterRingMember|osn:clusterRingMember]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingMemberEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clusterRingMemberEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== clusterRingMemberGet ==
''' Request Parameters '''
<code>
{
"method": "clusterRingMemberGet",
"params": {
"clusterRingMember": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:clusterRingMember|osn:clusterRingMember]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/clusterRingMemberGet?clusterRingMember=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @clusterRingMemberGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigCreate ==
Creates a new containerConfig for a specific instance of a container

''' Request Parameters '''
<code>
{
"method": "containerConfigCreate",
"params": {
"name": xsd:string {{Note|tag of the containerServiceDef|inline=1}}
"containerServiceDefTag": xsd:string {{Note|tag of the containerServiceDef|inline=1}}
"options": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:containerConfig|osn:containerConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigCreate?name=val0&containerServiceDefTag=val1&options=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigDelete ==
''' Request Parameters '''
<code>
{
"method": "containerConfigDelete",
"params": {
"containerConfig": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:containerConfig|osn:containerConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigDelete?containerConfig=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigEnum ==
Lists all the container configs

''' Request Parameters '''
<code>
{
"method": "containerConfigEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:containerConfig|osn:containerConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigGet ==
returns a specific containerConfig

''' Request Parameters '''
<code>
{
"method": "containerConfigGet",
"params": {
"containerConfig": xsd:string {{Note|id or containerServiceDefTag of the containerConfig to be returned|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:containerConfig|osn:containerConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigGet?containerConfig=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigOptionAddRemove ==
adds/removes a set of container config options (key=value pairs) to/from a specificied containerConfig

''' Request Parameters '''
<code>
{
"method": "containerConfigOptionAddRemove",
"params": {
"containerConfig": xsd:string {{Note|id or containerServiceDefTag of the containerConfig to be modified|inline=1}}
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"options": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:containerConfig|osn:containerConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigOptionAddRemove?containerConfig=val0&modType=0&options=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigOptionAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigOptionEnum ==
returns a list of all containerConfigOptions

''' Request Parameters '''
<code>
{
"method": "containerConfigOptionEnum",
"params": {
"containerConfig": xsd:string {{Note|id or containerServiceDefTag of the containerConfig where the option is applied|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:containerConfigOption|osn:containerConfigOption]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigOptionEnum?containerConfig=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigOptionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerConfigOptionGet ==
returns the specified containerConfigOption

''' Request Parameters '''
<code>
{
"method": "containerConfigOptionGet",
"params": {
"containerConfig": xsd:string {{Note|id or containerServiceDefTag of the containerConfig where the option is applied|inline=1}}
"key": xsd:string {{Note|the key of the containerConfigOption to be returned|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:containerConfigOption|osn:containerConfigOption]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerConfigOptionGet?containerConfig=val0&key=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerConfigOptionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerEnum ==
returns a list of all containers

''' Request Parameters '''
<code>
{
"method": "containerEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:container|osn:container]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerGet ==
returns the specified container

''' Request Parameters '''
<code>
{
"method": "containerGet",
"params": {
"container": xsd:string {{Note|containerServiceDefTag or id of the containerConfig or of the container|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:container|osn:container]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerGet?container=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerServiceDefEnum ==
returns a list of all containerServiceDefs

''' Request Parameters '''
<code>
{
"method": "containerServiceDefEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:containerServiceDef|osn:containerServiceDef]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerServiceDefEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerServiceDefEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== containerServiceDefGet ==
returns the specified containerServiceDef

''' Request Parameters '''
<code>
{
"method": "containerServiceDefGet",
"params": {
"id": xsd:string {{Note|name or id of the containerServiceDef|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:containerServiceDef|osn:containerServiceDef]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/containerServiceDefGet?id=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @containerServiceDefGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== customApi ==
''' Request Parameters '''
<code>
{
"method": "customApi",
"params": {
"method": xsd:string
"params": [[#osn:keyValuePair|osn:keyValuePair]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"resultOutput": xsd:string
}
</code>

== dashboardCreate ==
''' Request Parameters '''
<code>
{
"method": "dashboardCreate",
"params": {
"name": xsd:string
"description": xsd:string
"url": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:dashboard|osn:dashboard]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardCreate?name=val0&description=val1&url=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardDelete ==
''' Request Parameters '''
<code>
{
"method": "dashboardDelete",
"params": {
"dashboard": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:dashboard|osn:dashboard]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardDelete?dashboard=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardEnum ==
''' Request Parameters '''
<code>
{
"method": "dashboardEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:dashboard|osn:dashboard]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardGet ==
''' Request Parameters '''
<code>
{
"method": "dashboardGet",
"params": {
"dashboard": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:dashboard|osn:dashboard]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardGet?dashboard=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "dashboardGroupCreate",
"params": {
"name": xsd:string
"description": xsd:string
"dashboardIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:dashboardGroup|osn:dashboardGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardGroupCreate?name=val0&description=val1&dashboardIdList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "dashboardGroupDelete",
"params": {
"dashboardGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:dashboardGroup|osn:dashboardGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardGroupDelete?dashboardGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "dashboardGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:dashboardGroup|osn:dashboardGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardGroupGet ==
''' Request Parameters '''
<code>
{
"method": "dashboardGroupGet",
"params": {
"dashboardGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:dashboardGroup|osn:dashboardGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardGroupGet?dashboardGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardGroupModify ==
''' Request Parameters '''
<code>
{
"method": "dashboardGroupModify",
"params": {
"dashboardGroup": xsd:string
"name": xsd:string
"description": xsd:string
"dashboardIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:dashboardGroup|osn:dashboardGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardGroupModify?dashboardGroup=val0&name=val1&description=val2&dashboardIdList=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== dashboardModify ==
''' Request Parameters '''
<code>
{
"method": "dashboardModify",
"params": {
"dashboard": xsd:string
"name": xsd:string
"description": xsd:string
"url": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:dashboard|osn:dashboard]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/dashboardModify?dashboard=val0&name=val1&description=val2&url=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @dashboardModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== eventEnum ==
''' Request Parameters '''
<code>
{
"method": "eventEnum",
"params": {
"startingIndex": xsd:unsignedInt
"maxEvents": xsd:unsignedInt
"serviceTimeStamp": xsd:dateTime
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:event|osn:event]]
"endingIndex": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/eventEnum?startingIndex=0&maxEvents=0&serviceTimeStamp=val2"</nowiki>

<nowiki>curl -k -u admin:password -d @eventEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== eventListenerNotify ==
''' Request Parameters '''
<code>
{
"method": "eventListenerNotify",
"params": {
"storageSystemId": xsd:string
"list": [[#osn:event|osn:event]] "epoch": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:eventListener|osn:eventListener]]
}
</code>

== eventListenerRegister ==
''' Request Parameters '''
<code>
{
"method": "eventListenerRegister",
"params": {
"eventListenerObj": [[#osn:eventListener|osn:eventListener]] }
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:eventListener|osn:eventListener]]
}
</code>

== eventListenerUnregister ==
''' Request Parameters '''
<code>
{
"method": "eventListenerUnregister",
"params": {
"listenerId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:eventListener|osn:eventListener]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/eventListenerUnregister?listenerId=val0"</nowiki>

<nowiki>curl -k -u admin:password -d @eventListenerUnregister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== eventPulse ==
updates object time stamps of all objects of type objectType. This pulses a series of events into the grid for load testing.

''' Request Parameters '''
<code>
{
"method": "eventPulse",
"params": {
"storageSystemId": xsd:string
"objectType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:object|osn:object]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/eventPulse?storageSystemId=val0&objectType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @eventPulse.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemControllerEnum ==
Enumerate all external system controllers on a specified discovered external system

''' Request Parameters '''
<code>
{
"method": "externalSystemControllerEnum",
"params": {
"externalSystem": xsd:string {{Note|name or id of a desired external system|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemController|osn:externalSystemController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemControllerEnum?externalSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemControllerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemControllerGet ==
Get a specified external system controller

''' Request Parameters '''
<code>
{
"method": "externalSystemControllerGet",
"params": {
"externalSystemController": xsd:string {{Note|name or id of the desired external system controller|inline=1}}
"externalSystem": xsd:string {{Note|name or id of the desired external system (required if only name of es controller given)|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemController|osn:externalSystemController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemControllerGet?externalSystemController=val0&externalSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemControllerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemCredentialsAddRemove ==
Add credentials for external system discovery

''' Request Parameters '''
<code>
{
"method": "externalSystemCredentialsAddRemove",
"params": {
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"name": xsd:string {{Note|user specified name of the external system creds obj|inline=1}}
"username": xsd:string {{Note|username used in the curl call to discover the external system|inline=1}}
"password": xsd:string {{Note|password used in the curl call to discover the external system|inline=1}}
"primaryIp": xsd:string {{Note|primary ip used for calls to external system discovery scripts|inline=1}}
"secondaryIp": xsd:string {{Note|secondary ip used for calls to external system discovery scripts|inline=1}}
"externalSystemType": xsd:unsignedInt {{Note|see [[#enum:externalSystemType]] where 0=WesternDigitalOpenFlex, 1=Unknown|inline=1}}
"storageSystem": xsd:string {{Note|name or id of the storage system to redirect the external system ownership to (mutualally exclusive with siteCluster)|inline=1}}
"siteCluster": xsd:string {{Note|name or id of site cluster associated with external system ownership (if 'none', ext sys objs owned by local system or storageSystem specified)|inline=1}}
"portNumber": xsd:unsignedInt {{Note|the port number to make curl calls against|inline=1}}
"insecure": xsd:boolean {{Note|use insecure http for discovery if true, else default to secure https|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:externalSystemCredentials|osn:externalSystemCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemCredentialsAddRemove?modType=0&name=val1&username=val2&password=val3&primaryIp=val4&secondaryIp=val5&externalSystemType=0&storageSystem=val7&siteCluster=val8&portNumber=0&insecure=val10&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemCredentialsAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemCredentialsEnum ==
Enumerate credentials for external system discovery

''' Request Parameters '''
<code>
{
"method": "externalSystemCredentialsEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemCredentials|osn:externalSystemCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemCredentialsEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemCredentialsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemCredentialsGet ==
Get credentials for external system discovery

''' Request Parameters '''
<code>
{
"method": "externalSystemCredentialsGet",
"params": {
"externalSystemCredentials": xsd:string {{Note|id or name of the external system credentials object|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemCredentials|osn:externalSystemCredentials]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemCredentialsGet?externalSystemCredentials=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemCredentialsGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemEnum ==
Enumerate all discovered external systems

''' Request Parameters '''
<code>
{
"method": "externalSystemEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystem|osn:externalSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemGet ==
Get a specified discovered external system

''' Request Parameters '''
<code>
{
"method": "externalSystemGet",
"params": {
"externalSystem": xsd:string {{Note|either name or id of desired external system|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystem|osn:externalSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemGet?externalSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemHostEnum ==
lists the existing external system hosts

''' Request Parameters '''
<code>
{
"method": "externalSystemHostEnum",
"params": {
"externalSystem": xsd:string {{Note|id of the external system to list hosts from, lists all local external system hosts if not specified|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemHost|osn:externalSystemHost]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemHostEnum?externalSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemHostEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemHostGet ==
returns the specified external system hosts

''' Request Parameters '''
<code>
{
"method": "externalSystemHostGet",
"params": {
"externalSystemHost": xsd:string {{Note|name or id of the externalSystemHost to return|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemHost|osn:externalSystemHost]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemHostGet?externalSystemHost=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemHostGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemHostVolumeAssocEnum ==
returns a list of all host <-> volume mappings

''' Request Parameters '''
<code>
{
"method": "externalSystemHostVolumeAssocEnum",
"params": {
"externalSystem": xsd:string {{Note|id of the external system to list host volume assocs from, lists all local external system host volume assocs if not specified|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemHostVolumeAssoc|osn:externalSystemHostVolumeAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemHostVolumeAssocEnum?externalSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemHostVolumeAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemMediaEnum ==
Enumerate all external system media devices on a given discovered external system or port group

''' Request Parameters '''
<code>
{
"method": "externalSystemMediaEnum",
"params": {
"externalSystem": xsd:string {{Note|name or id of a desired external system|inline=1}}
"externalSystemPortGroup": xsd:string {{Note|name or id of desired external system port group|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemMedia|osn:externalSystemMedia]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemMediaEnum?externalSystem=val0&externalSystemPortGroup=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemMediaEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemMediaGet ==
Get a specified external system media device

''' Request Parameters '''
<code>
{
"method": "externalSystemMediaGet",
"params": {
"externalSystemMedia": xsd:string {{Note|name or id of the desired external system media device|inline=1}}
"externalSystem": xsd:string {{Note|name or id of the desired external system (required if only the name of the desired es media specified)|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemMedia|osn:externalSystemMedia]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemMediaGet?externalSystemMedia=val0&externalSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemMediaGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemModify ==
Modify fields of an existing external system

''' Request Parameters '''
<code>
{
"method": "externalSystemModify",
"params": {
"externalSystem": xsd:string {{Note|name or id of desired external system|inline=1}}
"altName": xsd:string {{Note|user specified human friendly name|inline=1}}
"description": xsd:string {{Note|user specified description for the external system|inline=1}}
"enclosureLayoutId": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:externalSystem|osn:externalSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemModify?externalSystem=val0&altName=val1&description=val2&enclosureLayoutId=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPoolEnum ==
Enumerate all pools for a given discovered external system

''' Request Parameters '''
<code>
{
"method": "externalSystemPoolEnum",
"params": {
"externalSystem": xsd:string {{Note|name or id of a desired external system|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemPool|osn:externalSystemPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPoolEnum?externalSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPoolGet ==
Get a specified external system pool

''' Request Parameters '''
<code>
{
"method": "externalSystemPoolGet",
"params": {
"externalSystemPool": xsd:string {{Note|name or id of the desired external system pool|inline=1}}
"externalSystem": xsd:string {{Note|name or id of a desired external system (required if only name of es pool given)|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemPool|osn:externalSystemPool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPoolGet?externalSystemPool=val0&externalSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPoolGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPortEnum ==
Enumerate all ports for a given external system port group or discovered external system

''' Request Parameters '''
<code>
{
"method": "externalSystemPortEnum",
"params": {
"externalSystem": xsd:string {{Note|name or id of a desired external system|inline=1}}
"externalSystemPortGroup": xsd:string {{Note|name or id of desired external system port group|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemPort|osn:externalSystemPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPortEnum?externalSystem=val0&externalSystemPortGroup=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPortGet ==
Get a specified external system port

''' Request Parameters '''
<code>
{
"method": "externalSystemPortGet",
"params": {
"externalSystemPort": xsd:string {{Note|name or id of the desired external system port|inline=1}}
"externalSystem": xsd:string {{Note|name or id of the desired external system (required if only name of es port specified)|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemPort|osn:externalSystemPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPortGet?externalSystemPort=val0&externalSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPortGroupEnum ==
Enumerate all port groups for a given discovered external system

''' Request Parameters '''
<code>
{
"method": "externalSystemPortGroupEnum",
"params": {
"externalSystem": xsd:string {{Note|name or id of a desired external system|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemPortGroup|osn:externalSystemPortGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPortGroupEnum?externalSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPortGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPortGroupGet ==
Get a specified external system port group

''' Request Parameters '''
<code>
{
"method": "externalSystemPortGroupGet",
"params": {
"externalSystemPortGroup": xsd:string {{Note|name or id of the desired external system port group|inline=1}}
"externalSystem": xsd:string {{Note|name or id of a desired external system (required if only name of es port group given)|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemPortGroup|osn:externalSystemPortGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPortGroupGet?externalSystemPortGroup=val0&externalSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPortGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemPortModify ==
change the ip address on external system ports

''' Request Parameters '''
<code>
{
"method": "externalSystemPortModify",
"params": {
"externalSystemPort": xsd:string {{Note|the port to configure|inline=1}}
"externalSystem": xsd:string {{Note|the external system the port is on|inline=1}}
"ipAddress": xsd:string {{Note|the ip to be applied to the port|inline=1}}
"subnet": xsd:string {{Note|the subnet to be applied to the port|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:externalSystemPort|osn:externalSystemPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemPortModify?externalSystemPort=val0&externalSystem=val1&ipAddress=val2&subnet=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemPortModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemProfileApply ==
configures the external system according to the selected profile (dg+pool+volumes+host+assign volumes to host)

''' Request Parameters '''
<code>
{
"method": "externalSystemProfileApply",
"params": {
"externalSystemId": xsd:string {{Note|id of the external system to configure|inline=1}}
"externalSystemProfileId": xsd:string {{Note|id/name of the external system profile to be applied|inline=1}}
"volCount": xsd:unsignedInt {{Note|number of volumes to batch create|inline=1}}
"useMaxVolSize": xsd:boolean {{Note|if true, calculate the max vol size based on pool capacity and vol count|inline=1}}
"volSize": xsd:unsignedLong {{Note|size of batch created volumes|inline=1}}
"assignToHosts": xsd:boolean {{Note|true to assign batch created volumes to given hosts|inline=1}}
"hostList": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:externalSystemProfile|osn:externalSystemProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemProfileApply?externalSystemId=val0&externalSystemProfileId=val1&volCount=0&useMaxVolSize=val3&volSize=val4&assignToHosts=val5&hostList=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemProfileApply.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemProfileEnum ==
list all external system profiles

''' Request Parameters '''
<code>
{
"method": "externalSystemProfileEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemProfile|osn:externalSystemProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemProfileEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemProfileGet ==
get detailed info on the external system profile

''' Request Parameters '''
<code>
{
"method": "externalSystemProfileGet",
"params": {
"externalSystemProfileId": xsd:string {{Note|name or id of the external system profile|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemProfile|osn:externalSystemProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemProfileGet?externalSystemProfileId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemScan ==
Force External System discovery cycle

''' Request Parameters '''
<code>
{
"method": "externalSystemScan",
"params": {
"externalSystemCredentials": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:externalSystem|osn:externalSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemScan?externalSystemCredentials=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemSendLogs ==
downloads the External System logs to a local zip file. used for support.

''' Request Parameters '''
<code>
{
"method": "externalSystemSendLogs",
"params": {
"externalSystem": xsd:string {{Note|id of the external system to take logs from|inline=1}}
"disableUpload": xsd:boolean {{Note|if true, only downloads the logs from the external system and does not send logs to OSNEXUS support|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:externalSystem|osn:externalSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemSendLogs?externalSystem=val0&disableUpload=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemSendLogs.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemSwAdapterConfigAdd ==
create a new software adapter to assign specified external system media devices to a storage system

''' Request Parameters '''
<code>
{
"method": "externalSystemSwAdapterConfigAdd",
"params": {
"storageSystem": xsd:string {{Note|the storage system to add the software adapter to|inline=1}}
"externalSystemMediaList": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemSwAdapterConfigAdd?storageSystem=val0&externalSystemMediaList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemSwAdapterConfigAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemVolumeCreate ==
Batch create External System Volumes of the given External System Pool

''' Request Parameters '''
<code>
{
"method": "externalSystemVolumeCreate",
"params": {
"externalSystemPoolId": xsd:string {{Note|id of the external system pool to create volumes on|inline=1}}
"volPrefix": xsd:string {{Note|prefix for naming the volumes|inline=1}}
"volCount": xsd:unsignedInt {{Note|number of volumes to batch create|inline=1}}
"useMaxVolSize": xsd:boolean {{Note|if true, calculate the max vol size based on pool capacity and vol count|inline=1}}
"volSize": xsd:unsignedLong {{Note|size of batch created volumes|inline=1}}
"assignToHosts": xsd:boolean {{Note|true to assign batch created volumes to given hosts|inline=1}}
"hostList": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:externalSystemVolume|osn:externalSystemVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemVolumeCreate?externalSystemPoolId=val0&volPrefix=val1&volCount=0&useMaxVolSize=val3&volSize=val4&assignToHosts=val5&hostList=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemVolumeCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemVolumeDelete ==
Delete a given list of External System Volumes

''' Request Parameters '''
<code>
{
"method": "externalSystemVolumeDelete",
"params": {
"externalSystemVolumeIdList": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:externalSystemVolume|osn:externalSystemVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemVolumeDelete?externalSystemVolumeIdList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemVolumeDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemVolumeEnum ==
Enumerate all external system volume on a given discovered external system or pool

''' Request Parameters '''
<code>
{
"method": "externalSystemVolumeEnum",
"params": {
"externalSystem": xsd:string {{Note|name or id of a desired external system|inline=1}}
"externalSystemPool": xsd:string {{Note|name or id of desired external system pool|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:externalSystemVolume|osn:externalSystemVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemVolumeEnum?externalSystem=val0&externalSystemPool=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemVolumeEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== externalSystemVolumeGet ==
Get a specified external system volume

''' Request Parameters '''
<code>
{
"method": "externalSystemVolumeGet",
"params": {
"externalSystemVolume": xsd:string {{Note|name or id of the desired external system volume|inline=1}}
"externalSystem": xsd:string {{Note|name or id of the desired external system (required if only the name of the desired es volume specified)|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:externalSystemVolume|osn:externalSystemVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/externalSystemVolumeGet?externalSystemVolume=val0&externalSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @externalSystemVolumeGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcRemotePortEnum ==
Returns a list of all the FC ports

''' Request Parameters '''
<code>
{
"method": "fcRemotePortEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:fcRemotePort|osn:fcRemotePort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcRemotePortEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcRemotePortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcRemotePortGet ==
Returns information about a specific FC port

''' Request Parameters '''
<code>
{
"method": "fcRemotePortGet",
"params": {
"port": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:fcRemotePort|osn:fcRemotePort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcRemotePortGet?port=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcRemotePortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcTargetPortDisable ==
Disabling a FC port changes it from Target mode to Initiator mode

''' Request Parameters '''
<code>
{
"method": "fcTargetPortDisable",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:fcTargetPort|osn:fcTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortDisable?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcTargetPortDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcTargetPortEnable ==
Enabling a FC port changes it from Initiator mode to Target mode, only QLogic FC cards can be put into target mode

''' Request Parameters '''
<code>
{
"method": "fcTargetPortEnable",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:fcTargetPort|osn:fcTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortEnable?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcTargetPortEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcTargetPortEnum ==
Returns a list of all the FC ports

''' Request Parameters '''
<code>
{
"method": "fcTargetPortEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:fcTargetPort|osn:fcTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcTargetPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcTargetPortGet ==
Returns information about a specific FC port

''' Request Parameters '''
<code>
{
"method": "fcTargetPortGet",
"params": {
"port": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:fcTargetPort|osn:fcTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortGet?port=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcTargetPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== fcTargetPortIssueLip ==
Enabling a FC port changes it from Initiator mode to Target mode, only QLogic FC cards can be put into target mode

''' Request Parameters '''
<code>
{
"method": "fcTargetPortIssueLip",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:fcTargetPort|osn:fcTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/fcTargetPortIssueLip?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @fcTargetPortIssueLip.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== getLocalizedMessage ==
''' Request Parameters '''
<code>
{
"method": "getLocalizedMessage",
"params": {
"locale": xsd:string
"i18nStr": [[#osn:i18nString|osn:i18nString]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"msgLocale": xsd:string
"msgLocalized": xsd:string
}
</code>

== getMultiFactorAuthDevices ==
''' Request Parameters '''
<code>
{
"method": "getMultiFactorAuthDevices",
"params": {
"authRequestCode": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"deviceList": [[#osn:multiFactorAuthDevice|osn:multiFactorAuthDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/getMultiFactorAuthDevices?authRequestCode=val0"</nowiki>

<nowiki>curl -k -u admin:password -d @getMultiFactorAuthDevices.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostAdd ==
Adds a new Host entry so that Storage Volumes may be assigned to them. The iqn field bay be a iSCSI IQN or a FC WWPN.

''' Request Parameters '''
<code>
{
"method": "hostAdd",
"params": {
"hostname": xsd:string
"ipAddress": xsd:string
"username": xsd:string
"password": xsd:string
"hostType": xsd:unsignedInt
"description": xsd:string
"iqn": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostAdd?hostname=val0&ipAddress=val1&username=val2&password=val3&hostType=0&description=val5&iqn=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostEnum ==
Returns a list of all the [[#osn:host]] entries.

''' Request Parameters '''
<code>
{
"method": "hostEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGet ==
Returns detailed information about a specific [[#osn:host]] entry.

''' Request Parameters '''
<code>
{
"method": "hostGet",
"params": {
"host": xsd:string {{Note|UUID or name of the Host to gather information about|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGet?host=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGroupCreate ==
Creates a [[#osn:hostGroup]] which simplifies assignment of Storage Volumes to groups of [[#osn:host]]s which typically constitue a cluster.

''' Request Parameters '''
<code>
{
"method": "hostGroupCreate",
"params": {
"name": xsd:string
"description": xsd:string
"hostList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hostGroup|osn:hostGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupCreate?name=val0&description=val1&hostList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGroupDelete ==
Deletes the specified Host Group and all Storage Volume assignments associated with the group.

''' Request Parameters '''
<code>
{
"method": "hostGroupDelete",
"params": {
"hostGroup": xsd:string
"deleteAssociatedHosts": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hostGroup|osn:hostGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupDelete?hostGroup=val0&deleteAssociatedHosts=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGroupEnum ==
Returns a list of all the Host Groups

''' Request Parameters '''
<code>
{
"method": "hostGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hostGroup|osn:hostGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGroupGet ==
Returns detailed information about a specific Host Group

''' Request Parameters '''
<code>
{
"method": "hostGroupGet",
"params": {
"hostGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hostGroup|osn:hostGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupGet?hostGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGroupHostAddRemove ==
Add or removes entries to/from a Host Group

''' Request Parameters '''
<code>
{
"method": "hostGroupHostAddRemove",
"params": {
"hostGroup": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"hostList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hostGroup|osn:hostGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupHostAddRemove?hostGroup=val0&modType=0&hostList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGroupHostAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostGroupModify ==
Modifies the specified [[#osn:hostGroup]]

''' Request Parameters '''
<code>
{
"method": "hostGroupModify",
"params": {
"hostGroup": xsd:string {{Note|name or UUID of the Host Group|inline=1}}
"newName": xsd:string
"newDescription": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hostGroup|osn:hostGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostGroupModify?hostGroup=val0&newName=val1&newDescription=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostInitiatorAdd ==
Adds a [[#osn:host]] with the specified IQN or WWPN

''' Request Parameters '''
<code>
{
"method": "hostInitiatorAdd",
"params": {
"host": xsd:string {{Note|hostname or UUID of a [[#osn:host]]|inline=1}}
"iqn": xsd:string {{Note|IQN or WWPN|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorAdd?host=val0&iqn=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostInitiatorAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostInitiatorEnum ==
Returns the list of [[#osn:initatorPort]] entries associated with the [[#osn:host]]

''' Request Parameters '''
<code>
{
"method": "hostInitiatorEnum",
"params": {
"host": xsd:string {{Note|host name or UUID of the Host entry or to get all entries for all hosts|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:initiatorPort|osn:initiatorPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorEnum?host=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostInitiatorEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostInitiatorGet ==
Returns information about a specific [[#osn:initiatorPort]] entry associated with a host.

''' Request Parameters '''
<code>
{
"method": "hostInitiatorGet",
"params": {
"initiator": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:initiatorPort|osn:initiatorPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorGet?initiator=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostInitiatorGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostInitiatorRemove ==
''' Request Parameters '''
<code>
{
"method": "hostInitiatorRemove",
"params": {
"host": xsd:string
"iqn": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostInitiatorRemove?host=val0&iqn=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostInitiatorRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostModify ==
Modifies the specified host entry to change it's properties. See [[#hostInitiatorAdd]] to add additional WWPNs and IQNs.

''' Request Parameters '''
<code>
{
"method": "hostModify",
"params": {
"host": xsd:string {{Note|Host name or UUID of the [[osn:host]] entry to modify|inline=1}}
"newIpAddress": xsd:string {{Note|IP address of the Host|inline=1}}
"newUsername": xsd:string {{Note|username to associate with the host (optional)|inline=1}}
"newPassword": xsd:string {{Note|password to associate with the host (optional)|inline=1}}
"newHostType": xsd:unsignedInt {{Note|host type, see [[#enum:hostType]]|inline=1}}
"newDescription": xsd:string
"newHostName": xsd:string {{Note|new hostname for this Host entry|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostModify?host=val0&newIpAddress=val1&newUsername=val2&newPassword=val3&newHostType=0&newDescription=val5&newHostName=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hostRemove ==
Removes a [[#osn:host]] entry and removes all Storage Volume assignments associated with this host.

''' Request Parameters '''
<code>
{
"method": "hostRemove",
"params": {
"host": xsd:string {{Note|hostname or UUID of a [[#osn:host]]|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:host|osn:host]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hostRemove?host=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hostRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwAlarmEnum ==
''' Request Parameters '''
<code>
{
"method": "hwAlarmEnum",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwAlarm|osn:hwAlarm]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwAlarmEnum?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwAlarmEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwAlarmGet ==
''' Request Parameters '''
<code>
{
"method": "hwAlarmGet",
"params": {
"hwAlarm": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwAlarm|osn:hwAlarm]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwAlarmGet?hwAlarm=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwAlarmGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwBatteryBackupUnitEnum ==
''' Request Parameters '''
<code>
{
"method": "hwBatteryBackupUnitEnum",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwBatteryBackupUnit|osn:hwBatteryBackupUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwBatteryBackupUnitEnum?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwBatteryBackupUnitEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwBatteryBackupUnitGet ==
''' Request Parameters '''
<code>
{
"method": "hwBatteryBackupUnitGet",
"params": {
"hwBatteryBackupUnit": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwBatteryBackupUnit|osn:hwBatteryBackupUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwBatteryBackupUnitGet?hwBatteryBackupUnit=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwBatteryBackupUnitGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerChangeSecurityKey ==
''' Request Parameters '''
<code>
{
"method": "hwControllerChangeSecurityKey",
"params": {
"controllerId": xsd:string
"oldSecurityKey": xsd:string
"newSecurityKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerChangeSecurityKey?controllerId=val0&oldSecurityKey=val1&newSecurityKey=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerChangeSecurityKey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerClearAlarms ==
''' Request Parameters '''
<code>
{
"method": "hwControllerClearAlarms",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerClearAlarms?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerClearAlarms.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerCreateSecurityKey ==
''' Request Parameters '''
<code>
{
"method": "hwControllerCreateSecurityKey",
"params": {
"controllerId": xsd:string
"securityKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerCreateSecurityKey?controllerId=val0&securityKey=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerCreateSecurityKey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerEnum ==
''' Request Parameters '''
<code>
{
"method": "hwControllerEnum",
"params": {
"hwControllerGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerEnum?hwControllerGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerGet ==
''' Request Parameters '''
<code>
{
"method": "hwControllerGet",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerGet?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "hwControllerGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwControllerGroup|osn:hwControllerGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerGroupGet ==
''' Request Parameters '''
<code>
{
"method": "hwControllerGroupGet",
"params": {
"hwControllerGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwControllerGroup|osn:hwControllerGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerGroupGet?hwControllerGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerImportForeignUnits ==
''' Request Parameters '''
<code>
{
"method": "hwControllerImportForeignUnits",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerImportForeignUnits?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerImportForeignUnits.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerModify ==
''' Request Parameters '''
<code>
{
"method": "hwControllerModify",
"params": {
"controllerId": xsd:string
"altName": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerModify?controllerId=val0&altName=val1&description=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerRescan ==
''' Request Parameters '''
<code>
{
"method": "hwControllerRescan",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerRescan?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerRescanAll ==
''' Request Parameters '''
<code>
{
"method": "hwControllerRescanAll",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerRescanAll?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerRescanAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerSearch ==
''' Request Parameters '''
<code>
{
"method": "hwControllerSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwControllerSilenceAlarms ==
''' Request Parameters '''
<code>
{
"method": "hwControllerSilenceAlarms",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwController|osn:hwController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwControllerSilenceAlarms?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwControllerSilenceAlarms.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskClearMissing ==
''' Request Parameters '''
<code>
{
"method": "hwDiskClearMissing",
"params": {
"storageSystemId": xsd:string
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskClearMissing?storageSystemId=val0&controllerId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskClearMissing.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskEnum ==
''' Request Parameters '''
<code>
{
"method": "hwDiskEnum",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskEnum?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskGet ==
''' Request Parameters '''
<code>
{
"method": "hwDiskGet",
"params": {
"hwDisk": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskGet?hwDisk=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskIdentify ==
''' Request Parameters '''
<code>
{
"method": "hwDiskIdentify",
"params": {
"diskIdList": xsd:string
"controllerId": xsd:string
"durationInSeconds": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskIdentify?diskIdList=val0&controllerId=val1&durationInSeconds=0&blinkType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskMarkGood ==
''' Request Parameters '''
<code>
{
"method": "hwDiskMarkGood",
"params": {
"diskIdList": xsd:string
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskMarkGood?diskIdList=val0&controllerId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskMarkGood.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskMarkHotSpare ==
''' Request Parameters '''
<code>
{
"method": "hwDiskMarkHotSpare",
"params": {
"diskIdList": xsd:string
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskMarkHotSpare?diskIdList=val0&controllerId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskMarkHotSpare.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskModify ==
''' Request Parameters '''
<code>
{
"method": "hwDiskModify",
"params": {
"diskId": xsd:string
"altName": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskModify?diskId=val0&altName=val1&description=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskRemove ==
''' Request Parameters '''
<code>
{
"method": "hwDiskRemove",
"params": {
"diskIdList": xsd:string
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskRemove?diskIdList=val0&controllerId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskSearch ==
''' Request Parameters '''
<code>
{
"method": "hwDiskSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwDiskUnmarkHotSpare ==
''' Request Parameters '''
<code>
{
"method": "hwDiskUnmarkHotSpare",
"params": {
"diskIdList": xsd:string
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwDiskUnmarkHotSpare?diskIdList=val0&controllerId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwDiskUnmarkHotSpare.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureClearMissing ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureClearMissing",
"params": {
"storageSystemId": xsd:string
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwEnclosure|osn:hwEnclosure]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureClearMissing?storageSystemId=val0&controllerId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureClearMissing.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureEnum ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureEnum",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwEnclosure|osn:hwEnclosure]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureEnum?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureGet ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureGet",
"params": {
"hwEnclosure": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwEnclosure|osn:hwEnclosure]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureGet?hwEnclosure=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureLayoutEnum ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureLayoutEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwEnclosureLayout|osn:hwEnclosureLayout]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureLayoutEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureLayoutGet ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureLayoutGet",
"params": {
"hwEnclosureLayout": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwEnclosureLayout|osn:hwEnclosureLayout]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutGet?hwEnclosureLayout=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureLayoutGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureLayoutVendorGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureLayoutVendorGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwEnclosureLayoutVendorGroup|osn:hwEnclosureLayoutVendorGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutVendorGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureLayoutVendorGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureLayoutVendorGroupGet ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureLayoutVendorGroupGet",
"params": {
"hwEnclosureLayoutVendorGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwEnclosureLayoutVendorGroup|osn:hwEnclosureLayoutVendorGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureLayoutVendorGroupGet?hwEnclosureLayoutVendorGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureLayoutVendorGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureModify ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureModify",
"params": {
"diskId": xsd:string
"altName": xsd:string
"description": xsd:string
"enclosureLayout": xsd:string
"chassisTag": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwEnclosure|osn:hwEnclosure]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureModify?diskId=val0&altName=val1&description=val2&enclosureLayout=val3&chassisTag=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureSearch ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwEnclosure|osn:hwEnclosure]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwEnclosureSlotIdentify ==
''' Request Parameters '''
<code>
{
"method": "hwEnclosureSlotIdentify",
"params": {
"enclosureId": xsd:string
"slotList": xsd:string
"durationInSeconds": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"allSlots": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwEnclosure|osn:hwEnclosure]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwEnclosureSlotIdentify?enclosureId=val0&slotList=val1&durationInSeconds=0&blinkType=0&allSlots=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwEnclosureSlotIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwLogicalDriveEnum ==
''' Request Parameters '''
<code>
{
"method": "hwLogicalDriveEnum",
"params": {
"hwUnit": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwLogicalDrive|osn:hwLogicalDrive]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwLogicalDriveEnum?hwUnit=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwLogicalDriveEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwLogicalDriveGet ==
''' Request Parameters '''
<code>
{
"method": "hwLogicalDriveGet",
"params": {
"hwLogicalDrive": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwLogicalDrive|osn:hwLogicalDrive]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwLogicalDriveGet?hwLogicalDrive=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwLogicalDriveGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitAutoCreate ==
''' Request Parameters '''
<code>
{
"method": "hwUnitAutoCreate",
"params": {
"storageSystemId": xsd:string
"hwControllerId": xsd:string
"raidType": xsd:unsignedInt
"disksPerUnit": xsd:unsignedInt
"blockSizeKb": xsd:unsignedInt
"diskCategory": xsd:unsignedInt
"diskSizeMinimum": xsd:unsignedLong
"diskSizeMaximum": xsd:unsignedLong
"unitCount": xsd:unsignedInt
"options": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitAutoCreate?storageSystemId=val0&hwControllerId=val1&raidType=0&disksPerUnit=0&blockSizeKb=0&diskCategory=0&diskSizeMinimum=val6&diskSizeMaximum=val7&unitCount=0&options=val9&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitAutoCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitCreate ==
''' Request Parameters '''
<code>
{
"method": "hwUnitCreate",
"params": {
"controllerId": xsd:string
"raidType": xsd:unsignedInt
"legLength": xsd:unsignedInt
"blockSizeKb": xsd:unsignedInt
"logicalVolumeCount": xsd:unsignedInt
"diskList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitCreate?controllerId=val0&raidType=0&legLength=0&blockSizeKb=0&logicalVolumeCount=0&diskList=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitDelete ==
''' Request Parameters '''
<code>
{
"method": "hwUnitDelete",
"params": {
"unitId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitDelete?unitId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitDiskAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "hwUnitDiskAssocEnum",
"params": {
"hwUnit": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwUnitDiskAssoc|osn:hwUnitDiskAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitDiskAssocEnum?hwUnit=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitDiskAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitDiskAssocGet ==
''' Request Parameters '''
<code>
{
"method": "hwUnitDiskAssocGet",
"params": {
"hwUnit": xsd:string
"hwDisk": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwUnitDiskAssoc|osn:hwUnitDiskAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitDiskAssocGet?hwUnit=val0&hwDisk=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitDiskAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitEnableEncryption ==
''' Request Parameters '''
<code>
{
"method": "hwUnitEnableEncryption",
"params": {
"unitId": xsd:string
"options": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitEnableEncryption?unitId=val0&options=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitEnableEncryption.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitEnum ==
''' Request Parameters '''
<code>
{
"method": "hwUnitEnum",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitEnum?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitGet ==
''' Request Parameters '''
<code>
{
"method": "hwUnitGet",
"params": {
"hwUnit": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitGet?hwUnit=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitGrow ==
''' Request Parameters '''
<code>
{
"method": "hwUnitGrow",
"params": {
"unitId": xsd:string
"diskList": xsd:string
"stripeSizeKb": xsd:unsignedInt
"initPriority": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitGrow?unitId=val0&diskList=val1&stripeSizeKb=0&initPriority=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitGrow.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitIdentify ==
''' Request Parameters '''
<code>
{
"method": "hwUnitIdentify",
"params": {
"unitId": xsd:string
"durationInSeconds": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitIdentify?unitId=val0&durationInSeconds=0&blinkType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitModify ==
''' Request Parameters '''
<code>
{
"method": "hwUnitModify",
"params": {
"unitId": xsd:string
"altName": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitModify?unitId=val0&altName=val1&description=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitSearch ==
''' Request Parameters '''
<code>
{
"method": "hwUnitSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitSsdCacheCreate ==
''' Request Parameters '''
<code>
{
"method": "hwUnitSsdCacheCreate",
"params": {
"controllerId": xsd:string
"raidType": xsd:unsignedInt
"ssdDiskList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSsdCacheCreate?controllerId=val0&raidType=0&ssdDiskList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitSsdCacheCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitSsdCacheDisable ==
''' Request Parameters '''
<code>
{
"method": "hwUnitSsdCacheDisable",
"params": {
"unitId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSsdCacheDisable?unitId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitSsdCacheDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== hwUnitSsdCacheEnable ==
''' Request Parameters '''
<code>
{
"method": "hwUnitSsdCacheEnable",
"params": {
"unitId": xsd:string
"unitSsdCacheId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:hwUnit|osn:hwUnit]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/hwUnitSsdCacheEnable?unitId=val0&unitSsdCacheId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @hwUnitSsdCacheEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== ibTargetPortEnum ==
Returns a list of all the Infiniband ports

''' Request Parameters '''
<code>
{
"method": "ibTargetPortEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:ibTargetPort|osn:ibTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/ibTargetPortEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @ibTargetPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== ibTargetPortGet ==
Returns detailed information on a specific Infiniband port

''' Request Parameters '''
<code>
{
"method": "ibTargetPortGet",
"params": {
"port": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:ibTargetPort|osn:ibTargetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/ibTargetPortGet?port=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @ibTargetPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileCreate ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileCreate",
"params": {
"name": xsd:string
"description": xsd:string
"serverType": xsd:unsignedInt
"username": xsd:string
"password": xsd:string
"caCert": xsd:string
"clientCert": xsd:string
"clientKey": xsd:string
"host": xsd:string
"kmipConnectionPort": xsd:string
"protocol": xsd:unsignedInt
"connectionMode": xsd:unsignedInt
"timeout": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:keyServerProfile|osn:keyServerProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileCreate?name=val0&description=val1&serverType=0&username=val3&password=val4&caCert=val5&clientCert=val6&clientKey=val7&host=val8&kmipConnectionPort=val9&protocol=0&connectionMode=0&timeout=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileDelete ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileDelete",
"params": {
"keyServerProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:keyServerProfile|osn:keyServerProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileDelete?keyServerProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileEnum ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:keyServerProfile|osn:keyServerProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileGet ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileGet",
"params": {
"keyServerProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:keyServerProfile|osn:keyServerProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileGet?keyServerProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileKeyAdd ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileKeyAdd",
"params": {
"keyServerProfile": xsd:string
"name": xsd:string
"description": xsd:string
"keyData": xsd:string
"encoding": xsd:unsignedInt
"keyType": xsd:unsignedInt
"resourceId": xsd:string
"resourceType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:keyServerProfileKey|osn:keyServerProfileKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileKeyAdd?keyServerProfile=val0&name=val1&description=val2&keyData=val3&encoding=0&keyType=0&resourceId=val6&resourceType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileKeyAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileKeyEnum ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileKeyEnum",
"params": {
"keyServerProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:keyServerProfileKey|osn:keyServerProfileKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileKeyEnum?keyServerProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileKeyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileKeyGet ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileKeyGet",
"params": {
"keyServerProfileKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:keyServerProfileKey|osn:keyServerProfileKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileKeyGet?keyServerProfileKey=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileKeyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileKeyModify ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileKeyModify",
"params": {
"keyServerProfileKey": xsd:string
"name": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:keyServerProfileKey|osn:keyServerProfileKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileKeyModify?keyServerProfileKey=val0&name=val1&description=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileKeyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileKeyRemove ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileKeyRemove",
"params": {
"keyServerProfile": xsd:string
"name": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:keyServerProfileKey|osn:keyServerProfileKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileKeyRemove?keyServerProfile=val0&name=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileKeyRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== keyServerProfileModify ==
''' Request Parameters '''
<code>
{
"method": "keyServerProfileModify",
"params": {
"keyServerProfile": xsd:string
"name": xsd:string
"description": xsd:string
"serverType": xsd:unsignedInt
"username": xsd:string
"password": xsd:string
"caCert": xsd:string
"clientCert": xsd:string
"clientKey": xsd:string
"host": xsd:string
"kmipConnectionPort": xsd:string
"protocol": xsd:unsignedInt
"connectionMode": xsd:unsignedInt
"timeout": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:keyServerProfile|osn:keyServerProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/keyServerProfileModify?keyServerProfile=val0&name=val1&description=val2&serverType=0&username=val4&password=val5&caCert=val6&clientCert=val7&clientKey=val8&host=val9&kmipConnectionPort=val10&protocol=0&connectionMode=0&timeout=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @keyServerProfileModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseActivate ==
''' Request Parameters '''
<code>
{
"method": "licenseActivate",
"params": {
"activationKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseActivate?activationKey=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseActivate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseActivateOnline ==
''' Request Parameters '''
<code>
{
"method": "licenseActivateOnline",
"params": {
"licenseKey": xsd:string
"leaseRenewal": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseActivateOnline?licenseKey=val0&leaseRenewal=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseActivateOnline.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseAdd ==
''' Request Parameters '''
<code>
{
"method": "licenseAdd",
"params": {
"storageSystem": xsd:string
"keyBlock": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseAdd?storageSystem=val0&keyBlock=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseEnum ==
''' Request Parameters '''
<code>
{
"method": "licenseEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseGet ==
''' Request Parameters '''
<code>
{
"method": "licenseGet",
"params": {
"license": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseGet?license=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseModifySupportInfo ==
''' Request Parameters '''
<code>
{
"method": "licenseModifySupportInfo",
"params": {
"licenseKey": xsd:string
"resellerName": xsd:string
"resellerContactNumber": xsd:string
"resellerEmail": xsd:string
"supportContractRef": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseModifySupportInfo?licenseKey=val0&resellerName=val1&resellerContactNumber=val2&resellerEmail=val3&supportContractRef=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseModifySupportInfo.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== licenseRemove ==
''' Request Parameters '''
<code>
{
"method": "licenseRemove",
"params": {
"license": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:license|osn:license]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/licenseRemove?license=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @licenseRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== loadBalancerCreate ==
''' Request Parameters '''
<code>
{
"method": "loadBalancerCreate",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:loadBalancer|osn:loadBalancer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loadBalancerCreate?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @loadBalancerCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== loadBalancerDelete ==
''' Request Parameters '''
<code>
{
"method": "loadBalancerDelete",
"params": {
"loadBalancerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:loadBalancer|osn:loadBalancer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loadBalancerDelete?loadBalancerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @loadBalancerDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== loadBalancerEnum ==
''' Request Parameters '''
<code>
{
"method": "loadBalancerEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:loadBalancer|osn:loadBalancer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loadBalancerEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @loadBalancerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== loadBalancerGet ==
''' Request Parameters '''
<code>
{
"method": "loadBalancerGet",
"params": {
"loadBalancerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:loadBalancer|osn:loadBalancer]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loadBalancerGet?loadBalancerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @loadBalancerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== login ==
''' Request Parameters '''
<code>
{
"method": "login",
"params": {
"reserved": xsd:string
"multiFactorAuthToken": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"authObj": [[#osn:mfaLogin|osn:mfaLogin]]
"roleObj": [[#osn:role|osn:role]]
"userObj": [[#osn:user|osn:user]]
"devMode": xsd:boolean
"resourceGroupList": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/login?reserved=val0&multiFactorAuthToken=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @login.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== loginPrecheck ==
''' Request Parameters '''
<code>
{
"method": "loginPrecheck",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"defaultUsername": xsd:string
"progressPercent": xsd:unsignedInt
"progressMessage": xsd:string
"serviceState": xsd:unsignedInt
"systemUseNotification": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loginPrecheck?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @loginPrecheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== loginVerify ==
''' Request Parameters '''
<code>
{
"method": "loginVerify",
"params": {
"authRequestCode": xsd:string
"passcode": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"authObj": [[#osn:mfaLogin|osn:mfaLogin]]
"userObj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/loginVerify?authRequestCode=val0&passcode=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @loginVerify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== logout ==
''' Request Parameters '''
<code>
{
"method": "logout",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/logout?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @logout.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleAddRemove ==
Used to add/remove Storage Pools to/from a given maintenance schedule

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleAddRemove",
"params": {
"schedule": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"storagePoolList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleAddRemove?schedule=val0&modType=0&storagePoolList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleAssocEnum",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:maintenanceScheduleAssoc|osn:maintenanceScheduleAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleAssocEnum?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleAssocGet ==
''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleAssocGet",
"params": {
"scheduleId": xsd:string
"storagePoolId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:maintenanceScheduleAssoc|osn:maintenanceScheduleAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleAssocGet?scheduleId=val0&storagePoolId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleCreate ==
Creates a new Maintenance Schedule to automatically scrub, SSD trim, or S3 compatible object orphan cleanup of selected Storage Pools

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleCreate",
"params": {
"name": xsd:string
"description": xsd:string
"setEnabled": xsd:unsignedInt
"initialStartDate": xsd:dateTime
"minDaysBetweenMaintenance": xsd:unsignedInt
"daysOfWeekAllowStart": xsd:unsignedInt
"hoursOfDayAllowStart": xsd:unsignedInt
"hoursOfDayOffsetMinutes": xsd:unsignedInt
"maintenanceType": xsd:unsignedInt
"storagePoolList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleCreate?name=val0&description=val1&setEnabled=0&initialStartDate=val3&minDaysBetweenMaintenance=0&daysOfWeekAllowStart=0&hoursOfDayAllowStart=0&hoursOfDayOffsetMinutes=0&maintenanceType=0&storagePoolList=val9&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleDelete ==
Deletes the specified maintenance schedule.

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleDelete",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleDelete?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleDisable ==
Disables the specified maintenance schedule. The schedule will not run again until it is re-enabled.

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleDisable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleDisable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleEnable ==
Enables a maintenance schedule that is offline.

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleEnable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleEnable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleEnum ==
Returns a list of all the Maintenance Schedules

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleGet ==
Returns detail on a specific Maintenance Schedule

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleGet",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleGet?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleModify ==
Modifies the properties and settings for a Maintenance Schedule

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleModify",
"params": {
"schedule": xsd:string {{Note|Name or ID of a [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]|inline=1}}
"name": xsd:string {{Note|specify a new name to rename the schedule to|inline=1}}
"description": xsd:string
"setEnabled": xsd:unsignedInt {{Note|schedules may be enabled/disabled and will not start if disabled|inline=1}}
"initialStartDate": xsd:dateTime {{Note|used to have a delayed start for the initial run of the schedule|inline=1}}
"minDaysBetweenMaintenance": xsd:unsignedInt {{Note|SSD TRIM should typically be done daily, Storage Pool scrub can be done monthly or quarterly, orphan cleanup is usually not needed but can be employed for special use cases where the Ceph RGW GC is not properly doing cleanup|inline=1}}
"daysOfWeekAllowStart": xsd:unsignedInt
"hoursOfDayAllowStart": xsd:unsignedInt
"hoursOfDayOffsetMinutes": xsd:unsignedInt
"maintenanceType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleModify?schedule=val0&name=val1&description=val2&setEnabled=0&initialStartDate=val4&minDaysBetweenMaintenance=0&daysOfWeekAllowStart=0&hoursOfDayAllowStart=0&hoursOfDayOffsetMinutes=0&maintenanceType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== maintenanceScheduleTrigger ==
Signals the schedule manager to run the selected schedule immediately.

''' Request Parameters '''
<code>
{
"method": "maintenanceScheduleTrigger",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:maintenanceSchedule|osn:maintenanceSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/maintenanceScheduleTrigger?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @maintenanceScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== multiFactorAuthConfigCreate ==
''' Request Parameters '''
<code>
{
"method": "multiFactorAuthConfigCreate",
"params": {
"apiHost": xsd:string
"integrationKey": xsd:string
"secretKey": xsd:string
"name": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:multiFactorAuthConfig|osn:multiFactorAuthConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigCreate?apiHost=val0&integrationKey=val1&secretKey=val2&name=val3&description=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @multiFactorAuthConfigCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== multiFactorAuthConfigDelete ==
''' Request Parameters '''
<code>
{
"method": "multiFactorAuthConfigDelete",
"params": {
"mfaConfigList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:multiFactorAuthConfig|osn:multiFactorAuthConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigDelete?mfaConfigList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @multiFactorAuthConfigDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== multiFactorAuthConfigEnum ==
''' Request Parameters '''
<code>
{
"method": "multiFactorAuthConfigEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:multiFactorAuthConfig|osn:multiFactorAuthConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @multiFactorAuthConfigEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== multiFactorAuthConfigGet ==
''' Request Parameters '''
<code>
{
"method": "multiFactorAuthConfigGet",
"params": {
"mfaConfig": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:multiFactorAuthConfig|osn:multiFactorAuthConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigGet?mfaConfig=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @multiFactorAuthConfigGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== multiFactorAuthConfigModify ==
''' Request Parameters '''
<code>
{
"method": "multiFactorAuthConfigModify",
"params": {
"mfaConfig": xsd:string
"newIntegrationKey": xsd:string
"newSecretKey": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:multiFactorAuthConfig|osn:multiFactorAuthConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigModify?mfaConfig=val0&newIntegrationKey=val1&newSecretKey=val2&newName=val3&newDescription=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @multiFactorAuthConfigModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== multiFactorAuthConfigUserAssignUnassign ==
''' Request Parameters '''
<code>
{
"method": "multiFactorAuthConfigUserAssignUnassign",
"params": {
"configMappings": xsd:string
"modType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/multiFactorAuthConfigUserAssignUnassign?configMappings=val0&modType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @multiFactorAuthConfigUserAssignUnassign.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareAddGroupQuota ==
''' Request Parameters '''
<code>
{
"method": "networkShareAddGroupQuota",
"params": {
"networkShare": xsd:string
"group": xsd:string
"quota": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareAddGroupQuota?networkShare=val0&group=val1&quota=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareAddGroupQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareAddUserQuota ==
''' Request Parameters '''
<code>
{
"method": "networkShareAddUserQuota",
"params": {
"networkShare": xsd:string
"user": xsd:string
"quota": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareAddUserQuota?networkShare=val0&user=val1&quota=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareAddUserQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCifsOptionEnum ==
''' Request Parameters '''
<code>
{
"method": "networkShareCifsOptionEnum",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareCifsOption|osn:networkShareCifsOption]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCifsOptionEnum?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCifsOptionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCifsOptionGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareCifsOptionGet",
"params": {
"networkShareId": xsd:string
"key": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareCifsOption|osn:networkShareCifsOption]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCifsOptionGet?networkShareId=val0&key=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCifsOptionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareClientAdd ==
adds an NFS access entry to the share with the specified settings

''' Request Parameters '''
<code>
{
"method": "networkShareClientAdd",
"params": {
"networkShareId": xsd:string {{Note|name or UUID of the [[#osn:networkShare]]|inline=1}}
"clientFilter": xsd:string
"isAsync": xsd:boolean
"secure": xsd:boolean
"subtreeCheck": xsd:boolean
"readOnly": xsd:boolean
"customOptions": xsd:string
"filterPriority": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientAdd?networkShareId=val0&clientFilter=val1&isAsync=val2&secure=val3&subtreeCheck=val4&readOnly=val5&customOptions=val6&filterPriority=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareClientAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareClientEnum ==
Lists all NFS access entries associated with the [[#osn:networkShare]]

''' Request Parameters '''
<code>
{
"method": "networkShareClientEnum",
"params": {
"networkShare": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareClient|osn:networkShareClient]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientEnum?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareClientEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareClientGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareClientGet",
"params": {
"networkShareId": xsd:string
"networkShareClientId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareClient|osn:networkShareClient]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientGet?networkShareId=val0&networkShareClientId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareClientGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareClientModify ==
modifies the specified NFS access entry associated with the [[#osn:networkShare]]

''' Request Parameters '''
<code>
{
"method": "networkShareClientModify",
"params": {
"networkShareId": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"networkShareClientId": xsd:string {{Note|name or UUID of the access entry|inline=1}}
"readOnly": xsd:boolean
"secure": xsd:boolean
"isAsync": xsd:boolean
"subtreeCheck": xsd:boolean
"customOptions": xsd:string
"filterPriority": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientModify?networkShareId=val0&networkShareClientId=val1&readOnly=val2&secure=val3&isAsync=val4&subtreeCheck=val5&customOptions=val6&filterPriority=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareClientModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareClientRemove ==
removes an NFS access entry from the share

''' Request Parameters '''
<code>
{
"method": "networkShareClientRemove",
"params": {
"networkShareId": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"networkShareClientId": xsd:string
"retainClientConnections": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClientRemove?networkShareId=val0&networkShareClientId=val1&retainClientConnections=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareClientRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareClone ==
''' Request Parameters '''
<code>
{
"method": "networkShareClone",
"params": {
"networkShare": xsd:string
"cloneName": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"readOnly": xsd:boolean
"isActive": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareClone?networkShare=val0&cloneName=val1&description=val2&provisionableId=val3&readOnly=val4&isActive=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCopySettings ==
Copy settings from one share to the another

''' Request Parameters '''
<code>
{
"method": "networkShareCopySettings",
"params": {
"networkShare": xsd:string {{Note|name or UUID of the share for which settings are changed|inline=1}}
"copyFromnetworkShare": xsd:string {{Note|name or UUID of the share from which the settings are copied|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCopySettings?networkShare=val0&copyFromnetworkShare=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCopySettings.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCreate ==
''' Request Parameters '''
<code>
{
"method": "networkShareCreate",
"params": {
"name": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"isPublic": xsd:boolean
"isActive": xsd:boolean
"parentShareId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreate?name=val0&description=val1&provisionableId=val2&isPublic=val3&isActive=val4&parentShareId=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCreateAlias ==
Aliases are alternate names for Network Shares that can also have an alternate set of access permissions. If a subSharePath is specified then the alias will map to a subdirectory within the specified share rather than to the root of the share. Aliases do not support snapshots are they are simple pointers into an existing share.

''' Request Parameters '''
<code>
{
"method": "networkShareCreateAlias",
"params": {
"name": xsd:string
"description": xsd:string
"parentShareId": xsd:string
"subSharePath": xsd:string
"inheritParentSettings": xsd:unsignedInt
"isPublic": xsd:boolean
"isActive": xsd:boolean
"forceCreateSubDir": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreateAlias?name=val0&description=val1&parentShareId=val2&subSharePath=val3&inheritParentSettings=0&isPublic=val5&isActive=val6&forceCreateSubDir=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCreateAlias.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCreateEx ==
Create new Network Shares with this method using the provisionableId to specify the name or ID of the Storage Pool to provision from. Storage Tiers which are groups of Storage Pools may also be specified in the provisionableId field.

''' Request Parameters '''
<code>
{
"method": "networkShareCreateEx",
"params": {
"name": xsd:string {{Note|name of the share, cannot contain spaces or special characters|inline=1}}
"description": xsd:string {{Note|user specified description field saved in UTF8 format|inline=1}}
"provisionableId": xsd:string {{Note|name of UUID of the [[#osn:storagePool]] to create the share within|inline=1}}
"isPublic": xsd:boolean {{Note|enable NFS public access on creation|inline=1}}
"isActive": xsd:boolean {{Note|indicates the share is active/online and can be presented via NFS/SMB if access is configured|inline=1}}
"enableCifs": xsd:boolean {{Note|indicates SMB access is enabled|inline=1}}
"userAccessList": xsd:string
"cifsOptions": xsd:string
"disableSnapBrowsing": xsd:boolean {{Note|Disable VSS (SMB) Browsing|inline=1}}
"spaceQuota": xsd:unsignedLong {{Note|sets a share space quota (bytes)|inline=1}}
"spaceQuotaExcludeSnapshots": xsd:boolean {{Note|if true the space quota ignores space used by snapshots|inline=1}}
"syncPolicy": xsd:unsignedInt {{Note|indicates the sync mode see [[#enum:syncPolicy]]|inline=1}}
"cachePolicyPrimary": xsd:unsignedInt {{Note|see [[#enum:cachePolicy]], default is 'all'/'auto' meaning the ARC can be used for data and metadata|inline=1}}
"cachePolicySecondary": xsd:unsignedInt {{Note|see [[#enum:cachePolicy]], default is 'all'/'auto' meaning the L2ARC can be used for data and metadata|inline=1}}
"compressionType": xsd:string {{Note|select one of on,off,lzjb,zstd,gzip,zle,lz4|inline=1}}
"copies": xsd:unsignedInt {{Note|number of copies of the data, default is 1, this is additional replica copies of the data on top of the RAIDZ/RAID10 pool layout protection already in place so it is generally not recommended.|inline=1}}
"shareOwner": xsd:string {{Note|UID of share owner 'system' level permission|inline=1}}
"shareOwnerGroup": xsd:string {{Note|GID of share owner 'system' level permission|inline=1}}
"permissions": xsd:string {{Note|specified in octal format such as 755755755 for owner, group, other permissions or just 755 to only specify owner permissions.|inline=1}}
"blockSizeKb": xsd:unsignedInt {{Note|if 0 inerhits the default record size set on the pool, typically 128K|inline=1}}
"spaceReserved": xsd:unsignedLong {{Note|pre-reserved capacity in bytes, used to thick-provision space for the share|inline=1}}
"vvolType": xsd:unsignedInt
"protocolEndPointId": xsd:string
"isCloudContainerCache": xsd:boolean {{Note|used to reserve the share as caching space for Cloud Storage Containers which provide NAS gateway to object storage|inline=1}}
"nfsSecurityPolicy": xsd:unsignedInt {{Note|see [[#enum:nfsSecurityPolicy]]|inline=1}}
"parentShareId": xsd:string {{Note|when creating a nested share, this is the parent under which the share should be created|inline=1}}
"enableEncryption": xsd:boolean {{Note|enables share level encryption, this is separate from pool level encryption which is done at the block device level under the pool.|inline=1}}
"encryptionKeyPassphrase": xsd:string
"count": xsd:unsignedInt {{Note|for batch creation of a group of shares|inline=1}}
"disableSmbSnapsDir": xsd:boolean {{Note|Enables SMB _snaps folder browsing of activated GMT snapshots|inline=1}}
"disableNfsSnapsDir": xsd:boolean {{Note|Enables NFS _snaps folder browsing of activated GMT snapshots|inline=1}}
"enableNfsSnapBrowsing": xsd:boolean {{Note|Enables explicit NFS share/.zfs snapshot visibility|inline=1}}
"immutabilityMode": xsd:unsignedInt {{Note|Enables immutability so that files cannot be deleted after they're created|inline=1}}
"daysOfImmutability": xsd:unsignedInt {{Note|Disables immutability after specified number of days|inline=1}}
"smallBlockThreshold": xsd:unsignedInt {{Note|used to indicate the size below which IO is stored in the special metadata VDEV, 32K is recommended/default|inline=1}}
"fileQuota": xsd:unsignedLong {{Note|file count quota, only applies to CephFS / scale-out storage pools|inline=1}}
"permissionMask": xsd:string {{Note|specified in octal format such as 755755755 for owner, group, other|inline=1}}
"enableRansomwareDetection": xsd:boolean {{Note|if true then the share will be monitored for anomolous activity|inline=1}}
"ransomwareThresholds": xsd:string
"autoCalibrationDuration": xsd:unsignedInt {{Note|include rules for ransomware detection, directories and files that match any of these strings are included|inline=1}}
"includeRules": xsd:string
"excludeRules": xsd:string
"readOnly": xsd:boolean {{Note|indicates the share access is read-only via all protocols (NFS/SMB)|inline=1}}
"caseSensitivity": xsd:unsignedInt {{Note|indicates the case sensitivity mode see [[#enum:caseSensitivity]]|inline=1}}
"enableNfsCrossmount": xsd:boolean {{Note|Enables NFS crossmount option on the share|inline=1}}
"subPool": xsd:string {{Note|The sub-pool associated with the cephFS pool|inline=1}}
"templateId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
"list": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreateEx?name=val0&description=val1&provisionableId=val2&isPublic=val3&isActive=val4&enableCifs=val5&userAccessList=val6&cifsOptions=val7&disableSnapBrowsing=val8&spaceQuota=val9&spaceQuotaExcludeSnapshots=val10&syncPolicy=0&cachePolicyPrimary=0&cachePolicySecondary=0&compressionType=val14&copies=0&shareOwner=val16&shareOwnerGroup=val17&permissions=val18&blockSizeKb=0&spaceReserved=val20&vvolType=0&protocolEndPointId=val22&isCloudContainerCache=val23&nfsSecurityPolicy=0&parentShareId=val25&enableEncryption=val26&encryptionKeyPassphrase=val27&count=0&disableSmbSnapsDir=val29&disableNfsSnapsDir=val30&enableNfsSnapBrowsing=val31&immutabilityMode=0&daysOfImmutability=0&smallBlockThreshold=0&fileQuota=val35&permissionMask=val36&enableRansomwareDetection=val37&ransomwareThresholds=val38&autoCalibrationDuration=0&includeRules=val40&excludeRules=val41&readOnly=val42&caseSensitivity=0&enableNfsCrossmount=val44&subPool=val45&templateId=val46&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCreateEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareCreateFromTemplate ==
''' Request Parameters '''
<code>
{
"method": "networkShareCreateFromTemplate",
"params": {
"name": xsd:string
"description": xsd:string
"pool": xsd:string
"shareTemplate": xsd:string
"settingsMask": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareCreateFromTemplate?name=val0&description=val1&pool=val2&shareTemplate=val3&settingsMask=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareCreateFromTemplate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareDataPoolLayoutModify ==
Updates the Data Pool Layout of the specified Network Share

''' Request Parameters '''
<code>
{
"method": "networkShareDataPoolLayoutModify",
"params": {
"networkShare": xsd:string {{Note|Name or UUID of the share to modify|inline=1}}
"subPool": xsd:string {{Note|Name or UUID of the sub-pool to modify|inline=1}}
"recursive": xsd:boolean {{Note|Whether to apply changes recursively. If recursive is false, any new files written to the share will be placed in the new layout, but existing files will remain in the old layout.|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDataPoolLayoutModify?networkShare=val0&subPool=val1&recursive=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareDataPoolLayoutModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareDelete ==
destroys / deletes the specified share

''' Request Parameters '''
<code>
{
"method": "networkShareDelete",
"params": {
"networkShareId": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDelete?networkShareId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareDeleteEx ==
destroys / deletes the specified share

''' Request Parameters '''
<code>
{
"method": "networkShareDeleteEx",
"params": {
"networkShareList": xsd:string
"searchParams": xsd:string
"deleteOptions": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDeleteEx?networkShareList=val0&searchParams=val1&deleteOptions=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareDeleteEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareDisable ==
used disable all access to a [[#osn:networkShare]]

''' Request Parameters '''
<code>
{
"method": "networkShareDisable",
"params": {
"networkShare": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareDisable?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareEnable ==
used enable a [[#osn:networkShare]], when enabled it can be accessed via NFS/SMB as configured

''' Request Parameters '''
<code>
{
"method": "networkShareEnable",
"params": {
"networkShare": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEnable?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareEncryptionKeyExport ==
Exports encryption keys into a key block that can be easily saved to a text file and restored later

''' Request Parameters '''
<code>
{
"method": "networkShareEncryptionKeyExport",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
"keyBlock": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEncryptionKeyExport?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareEncryptionKeyExport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareEncryptionKeyImport ==
Imports previously exported encryption keys so that they may be used to unlock media and activate a pool

''' Request Parameters '''
<code>
{
"method": "networkShareEncryptionKeyImport",
"params": {
"networkShare": xsd:string
"keyBlock": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEncryptionKeyImport?networkShare=val0&keyBlock=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareEncryptionKeyImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareEnum ==
returns information about all Network Shares in the the storage grid, use networkShareSearch on larger grids with many [[#osn:networkShare]]s

''' Request Parameters '''
<code>
{
"method": "networkShareEnum",
"params": {
"networkShareList": xsd:string
"flags": xsd:unsignedInt {{Note|list of shares to limit the enumeration to, recommend using networkShareSearch for more advanced fast searching and filtering|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEnum?networkShareList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareEnumQuotas ==
''' Request Parameters '''
<code>
{
"method": "networkShareEnumQuotas",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"userSpaceList": [[#osn:networkShareQuota|osn:networkShareQuota]]
"groupSpaceList": [[#osn:networkShareQuota|osn:networkShareQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareEnumQuotas?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareEnumQuotas.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareFileCopy ==
''' Request Parameters '''
<code>
{
"method": "networkShareFileCopy",
"params": {
"networkShare": xsd:string
"sourceFilePath": xsd:string
"targetFilePath": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareFile|osn:networkShareFile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileCopy?networkShare=val0&sourceFilePath=val1&targetFilePath=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareFileCopy.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareFileCreate ==
''' Request Parameters '''
<code>
{
"method": "networkShareFileCreate",
"params": {
"networkShare": xsd:string
"filePath": xsd:string
"size": xsd:unsignedLong
"thinProvisioned": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareFile|osn:networkShareFile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileCreate?networkShare=val0&filePath=val1&size=val2&thinProvisioned=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareFileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareFileDelete ==
''' Request Parameters '''
<code>
{
"method": "networkShareFileDelete",
"params": {
"networkShare": xsd:string
"filePath": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareFile|osn:networkShareFile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileDelete?networkShare=val0&filePath=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareFileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareFileLockEnum ==
''' Request Parameters '''
<code>
{
"method": "networkShareFileLockEnum",
"params": {
"networkShareId": xsd:string
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareFileLock|osn:networkShareFileLock]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareFileLockEnum?networkShareId=val0&storageSystemId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareFileLockEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareGet ==
returns the object associated with the specified share name or UUID

''' Request Parameters '''
<code>
{
"method": "networkShareGet",
"params": {
"networkShare": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareGet?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareHealthCheck ==
''' Request Parameters '''
<code>
{
"method": "networkShareHealthCheck",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceHealthCheck|osn:resourceHealthCheck]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareHealthCheck?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareHealthCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareHoldAdd ==
holds are used to prevent a given snapshot from being deleted. When immutability is enabled a snapshot with a hold is created automatically.

''' Request Parameters '''
<code>
{
"method": "networkShareHoldAdd",
"params": {
"networkShare": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"holdTag": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareHoldAdd?networkShare=val0&holdTag=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareHoldAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareHoldRemove ==
removes the hold with the specified name

''' Request Parameters '''
<code>
{
"method": "networkShareHoldRemove",
"params": {
"networkShare": xsd:string {{Note|name of UUID of the [[#osn:networkShare]]|inline=1}}
"holdTag": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareHoldRemove?networkShare=val0&holdTag=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareHoldRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareJoinDomain ==
used to join the specified Storage System to the specified Active Directory Domain

''' Request Parameters '''
<code>
{
"method": "networkShareJoinDomain",
"params": {
"storageSystemId": xsd:string
"domain": xsd:string
"realm": xsd:string
"kdc": xsd:string
"domainAdmin": xsd:string
"password": xsd:string
"idmapMode": xsd:unsignedInt
"allowTrustedDomains": xsd:boolean
"computerActOrgUnit": xsd:string {{Note|Create the computer account in the specified OU|inline=1}}
"minUid": xsd:unsignedLong {{Note|Min value for custom UID range|inline=1}}
"maxUid": xsd:unsignedLong {{Note|Max value for custom UID range|inline=1}}
"minDefaultUid": xsd:unsignedLong {{Note|Min value for custom UID range|inline=1}}
"maxDefaultUid": xsd:unsignedLong {{Note|Max value for custom UID range|inline=1}}
"rangeSize": xsd:unsignedLong {{Note|range size for a domain when in autorid|inline=1}}
"adJoinMode": xsd:unsignedInt {{Note|Join in winbind, SSSD or SSSD with Winbind mode|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareServiceConfig|osn:networkShareServiceConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareJoinDomain?storageSystemId=val0&domain=val1&realm=val2&kdc=val3&domainAdmin=val4&password=val5&idmapMode=0&allowTrustedDomains=val7&computerActOrgUnit=val8&minUid=val9&maxUid=val10&minDefaultUid=val11&maxDefaultUid=val12&rangeSize=val13&adJoinMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareJoinDomain.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareLeaveDomain ==
used to have the specified [[#osn:storageSystem]] leave the Active Directory Domain

''' Request Parameters '''
<code>
{
"method": "networkShareLeaveDomain",
"params": {
"storageSystemId": xsd:string
"domainAdmin": xsd:string
"password": xsd:string
"preserveAdUserAccessEntries": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareServiceConfig|osn:networkShareServiceConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareLeaveDomain?storageSystemId=val0&domainAdmin=val1&password=val2&preserveAdUserAccessEntries=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareLeaveDomain.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareLoadEncryptionKey ==
''' Request Parameters '''
<code>
{
"method": "networkShareLoadEncryptionKey",
"params": {
"networkShare": xsd:string
"encryptionKeyPassphrase": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareLoadEncryptionKey?networkShare=val0&encryptionKeyPassphrase=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareLoadEncryptionKey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareModify ==
used to modify the settings of a [[#osn:networkShare]], all fields must be specified as leaving an argument blank will clear it on the object rather than preserve it

''' Request Parameters '''
<code>
{
"method": "networkShareModify",
"params": {
"networkShare": xsd:string {{Note|name or UUID of the share to be modified|inline=1}}
"name": xsd:string {{Note|name of the share, cannot contain spaces or special characters|inline=1}}
"description": xsd:string {{Note|user specified description field saved in UTF8 format|inline=1}}
"isActive": xsd:boolean {{Note|indicates the share is active/online and can be presented via NFS/SMB if access is configured|inline=1}}
"enableCifs": xsd:boolean {{Note|indicates SMB access is enabled|inline=1}}
"userAccessList": xsd:string
"cifsOptions": xsd:string
"disableSnapBrowsing": xsd:boolean {{Note|Disable VSS (SMB) Browsing|inline=1}}
"spaceQuota": xsd:unsignedLong {{Note|sets a share space quota (bytes)|inline=1}}
"spaceQuotaExcludeSnapshots": xsd:boolean {{Note|if true the space quota ignores space used by snapshots|inline=1}}
"syncPolicy": xsd:unsignedInt {{Note|indicates the sync mode see [[#enum:syncPolicy]]|inline=1}}
"cachePolicyPrimary": xsd:unsignedInt {{Note|see [[#enum:cachePolicy]], default is 'all'/'auto' meaning the ARC can be used for data and metadata|inline=1}}
"cachePolicySecondary": xsd:unsignedInt {{Note|see [[#enum:cachePolicy]], default is 'all'/'auto' meaning the L2ARC can be used for data and metadata|inline=1}}
"compressionType": xsd:string {{Note|select one of on,off,lzjb,zstd,gzip,zle,lz4|inline=1}}
"copies": xsd:unsignedInt {{Note|number of copies of the data, default is 1, this is additional replica copies of the data on top of the RAIDZ/RAID10 pool layout protection already in place so it is generally not recommended.|inline=1}}
"shareOwner": xsd:string {{Note|UID of share owner 'system' level permission|inline=1}}
"shareOwnerGroup": xsd:string {{Note|GID of share owner 'system' level permission|inline=1}}
"permissions": xsd:string {{Note|specified in octal format such as 755755755 for owner, group, other permissions or just 755 to only specify owner permissions.|inline=1}}
"blockSizeKb": xsd:unsignedInt {{Note|if 0 inerhits the default record size set on the pool, typically 128K|inline=1}}
"isActiveCheckpoint": xsd:boolean {{Note|is automatically set to true if the DR site _checkpoint this share is specified is active. Set to 'false' to clear active checkpoint state so that replication can resume.|inline=1}}
"spaceReserved": xsd:unsignedLong {{Note|pre-reserved capacity in bytes, used to thick-provision space for the share|inline=1}}
"modifyShareQuota": xsd:boolean {{Note|true shareQuota is modified, otherwise the values specified in spaceQuota are ignored|inline=1}}
"nfsSecurityPolicy": xsd:unsignedInt {{Note|see [[#enum:nfsSecurityPolicy]]|inline=1}}
"disableSmbSnapsDir": xsd:boolean {{Note|Enables SMB _snaps folder browsing of activated GMT snapshots|inline=1}}
"disableNfsSnapsDir": xsd:boolean {{Note|Enables NFS _snaps folder browsing of activated GMT snapshots|inline=1}}
"enableNfsSnapBrowsing": xsd:boolean {{Note|Enables explicit NFS share/.zfs snapshot visibility|inline=1}}
"smallBlockThreshold": xsd:unsignedInt {{Note|used to indicate the size below which IO is stored in the special metadata VDEV, 32K is recommended/default|inline=1}}
"fileQuota": xsd:unsignedLong {{Note|file count quota, only applies to CephFS / scale-out storage pools|inline=1}}
"permissionMask": xsd:string {{Note|specified in octal format such as 755755755 for owner, group, other|inline=1}}
"enableRansomwareDetection": xsd:boolean {{Note|if true then the share will be monitored for anomolous activity|inline=1}}
"ransomwareThresholds": xsd:string
"autoCalibrationDuration": xsd:unsignedInt {{Note|if 0, no ransomeware detection auto calibration is enabled|inline=1}}
"includeRules": xsd:string
"excludeRules": xsd:string
"readOnly": xsd:boolean {{Note|indicates the share access is read-only via all protocols (NFS/SMB)|inline=1}}
"enableNfsCrossmount": xsd:boolean {{Note|Enables NFS crossmount option on the share|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareModify?networkShare=val0&name=val1&description=val2&isActive=val3&enableCifs=val4&userAccessList=val5&cifsOptions=val6&disableSnapBrowsing=val7&spaceQuota=val8&spaceQuotaExcludeSnapshots=val9&syncPolicy=0&cachePolicyPrimary=0&cachePolicySecondary=0&compressionType=val13&copies=0&shareOwner=val15&shareOwnerGroup=val16&permissions=val17&blockSizeKb=0&isActiveCheckpoint=val19&spaceReserved=val20&modifyShareQuota=val21&nfsSecurityPolicy=0&disableSmbSnapsDir=val23&disableNfsSnapsDir=val24&enableNfsSnapBrowsing=val25&smallBlockThreshold=0&fileQuota=val27&permissionMask=val28&enableRansomwareDetection=val29&ransomwareThresholds=val30&autoCalibrationDuration=0&includeRules=val32&excludeRules=val33&readOnly=val34&enableNfsCrossmount=val35&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareMove ==
used to move a nested Network Share (eg homes/math/jane) to another location (eg homes/physics/jane) in the share hierarchy for a given Storage Pool. This can only be done with nested Network Shares on scale-up pools.

''' Request Parameters '''
<code>
{
"method": "networkShareMove",
"params": {
"networkShare": xsd:string {{Note|name or UUID of the share to be moved|inline=1}}
"newParent": xsd:string {{Note|new parent share location for the share. Share will be moved inside this dataset.|inline=1}}
"newShareName": xsd:string {{Note|Optionally rename the share as part of the move|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareMove?networkShare=val0&newParent=val1&newShareName=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareMove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceAddRemove ==
adds one or more shares to the specified [[#osn:networkShareNamespace]]

''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceAddRemove",
"params": {
"networkShareNamespace": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"preferredPortList": xsd:string
"shareList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceAddRemove?networkShareNamespace=val0&modType=0&preferredPortList=val2&shareList=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceCreate ==
Network Share Namespaces use NFS redirects and SMB DFS in order to present a group of shares from more than one Storage System even if the specified Storage System does not serve the share. This makes it easier for users to find Network Shares especially in large environments with many Storage Systems.

''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceCreate",
"params": {
"name": xsd:string {{Note|name for the namespace|inline=1}}
"description": xsd:string {{Note|description for the namespace|inline=1}}
"enableMicrosoftDfs": xsd:boolean {{Note|if true the namespace appears when SMB browsing|inline=1}}
"enableNfsRefferals": xsd:boolean {{Note|if true the namespace appears when NFS browsing|inline=1}}
"dfsMode": xsd:unsignedInt {{Note|see [[#enum:dfsNamespaceModeType]]|inline=1}}
"preferredPortList": xsd:string
"shareList": xsd:string
"flags": xsd:unsignedInt {{Note|list of [[#osn:networkShare]]s idenfied by UUID to be included in the [[#osn:networkShareNamespace]]|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceCreate?name=val0&description=val1&enableMicrosoftDfs=val2&enableNfsRefferals=val3&dfsMode=0&preferredPortList=val5&shareList=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceDelete ==
deletes the specified [[#osn:networkShareNamespace]]

''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceDelete",
"params": {
"networkShareNamespace": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceDelete?networkShareNamespace=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceEnum ==
enumerates a list of all the [[#osn:networkShareNamespace]] in the storage grid

''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceGet",
"params": {
"networkShareNamespace": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceGet?networkShareNamespace=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceModify ==
modifies the settings of the specified [[#osn:networkShareNamespace]]

''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceModify",
"params": {
"networkShareNamespace": xsd:string {{Note|name or UUID of the namespace|inline=1}}
"name": xsd:string {{Note|new name for the namespace|inline=1}}
"description": xsd:string {{Note|new description for the namespace|inline=1}}
"enableMicrosoftDfs": xsd:boolean {{Note|if true the namespace appears when SMB browsing|inline=1}}
"enableNfsRefferals": xsd:boolean {{Note|if true the namespace appears when NFS browsing|inline=1}}
"dfsMode": xsd:unsignedInt {{Note|see [[#enum:dfsNamespaceModeType]]|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceModify?networkShareNamespace=val0&name=val1&description=val2&enableMicrosoftDfs=val3&enableNfsRefferals=val4&dfsMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceShareAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceShareAssocEnum",
"params": {
"networkShareNamespace": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareNamespaceShareAssoc|osn:networkShareNamespaceShareAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceShareAssocEnum?networkShareNamespace=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceShareAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceShareAssocGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceShareAssocGet",
"params": {
"networkShareNamespace": xsd:string
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareNamespaceShareAssoc|osn:networkShareNamespaceShareAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceShareAssocGet?networkShareNamespace=val0&networkShare=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceShareAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceSystemAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceSystemAssocEnum",
"params": {
"networkShareNamespace": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareNamespaceSystemAssoc|osn:networkShareNamespaceSystemAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceSystemAssocEnum?networkShareNamespace=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceSystemAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNamespaceSystemAssocGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareNamespaceSystemAssocGet",
"params": {
"networkShareNamespace": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareNamespaceSystemAssoc|osn:networkShareNamespaceSystemAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNamespaceSystemAssocGet?networkShareNamespace=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNamespaceSystemAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareNfsConfig ==
''' Request Parameters '''
<code>
{
"method": "networkShareNfsConfig",
"params": {
"storageSystem": xsd:string
"nfsMode": xsd:unsignedInt
"enableKerberos": xsd:boolean
"defaultOptions": xsd:string
"reserved": xsd:string
"nfsKerberosMode": xsd:unsignedInt
"disableBrowsing": xsd:boolean
"defaultNfsSecurityPolicy": xsd:unsignedInt
"nfsServerType": xsd:unsignedInt
"nfsManageGids": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareServiceConfig|osn:networkShareServiceConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareNfsConfig?storageSystem=val0&nfsMode=0&enableKerberos=val2&defaultOptions=val3&reserved=val4&nfsKerberosMode=0&disableBrowsing=val6&defaultNfsSecurityPolicy=0&nfsServerType=0&nfsManageGids=val9&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareNfsConfig.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkSharePromote ==
Used to promote a GMT snapshot to a fast clone and promote it. Also used to promote the demoted share back to the original share

''' Request Parameters '''
<code>
{
"method": "networkSharePromote",
"params": {
"networkShare": xsd:string {{Note|name or UUID of the share to be promoted|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkSharePromote?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkSharePromote.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareRemoveGroupQuota ==
''' Request Parameters '''
<code>
{
"method": "networkShareRemoveGroupQuota",
"params": {
"networkShare": xsd:string
"group": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRemoveGroupQuota?networkShare=val0&group=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareRemoveGroupQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareRemoveUserQuota ==
''' Request Parameters '''
<code>
{
"method": "networkShareRemoveUserQuota",
"params": {
"networkShare": xsd:string
"user": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRemoveUserQuota?networkShare=val0&user=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareRemoveUserQuota.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareRestore ==
''' Request Parameters '''
<code>
{
"method": "networkShareRestore",
"params": {
"networkShare": xsd:string
"snapshotShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRestore?networkShare=val0&snapshotShare=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareRestore.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareRollback ==
''' Request Parameters '''
<code>
{
"method": "networkShareRollback",
"params": {
"networkShare": xsd:string
"snapshotShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRollback?networkShare=val0&snapshotShare=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareRollbackClone ==
''' Request Parameters '''
<code>
{
"method": "networkShareRollbackClone",
"params": {
"snapshotShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareRollbackClone?snapshotShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareRollbackClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareSearch ==
similar to networkShareEnum but enables fast searching of shares by attribute and cursor base gathering of results

''' Request Parameters '''
<code>
{
"method": "networkShareSearch",
"params": {
"searchParams": xsd:string
"maxResults": xsd:unsignedInt
"offset": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShare|osn:networkShare]]
"objCount": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSearch?searchParams=val0&maxResults=0&offset=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareServicesRestart ==
''' Request Parameters '''
<code>
{
"method": "networkShareServicesRestart",
"params": {
"storageSystem": xsd:string
"restartNfs": xsd:boolean
"restartSamba": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareServicesRestart?storageSystem=val0&restartNfs=val1&restartSamba=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareServicesRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareSessionEnum ==
''' Request Parameters '''
<code>
{
"method": "networkShareSessionEnum",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareSession|osn:networkShareSession]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSessionEnum?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareSessionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareSessionGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareSessionGet",
"params": {
"sessionId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareSession|osn:networkShareSession]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSessionGet?sessionId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareSessionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareSetPassphrase ==
''' Request Parameters '''
<code>
{
"method": "networkShareSetPassphrase",
"params": {
"networkShare": xsd:string
"oldEncryptionKeyPassphrase": xsd:string
"newEncryptionKeyPassphrase": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSetPassphrase?networkShare=val0&oldEncryptionKeyPassphrase=val1&newEncryptionKeyPassphrase=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareSetPassphrase.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareSetQuotas ==
''' Request Parameters '''
<code>
{
"method": "networkShareSetQuotas",
"params": {
"networkShare": xsd:string
"list": [[#osn:networkShareQuota|osn:networkShareQuota]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

== networkShareSnapshot ==
Creates a snapshot of the specified Network Share

''' Request Parameters '''
<code>
{
"method": "networkShareSnapshot",
"params": {
"networkShare": xsd:string {{Note|Name or UUID of the Network Share|inline=1}}
"snapshotName": xsd:string {{Note|snapshot name, if left blank a @GMT stamped snapshot will be created which is accessible via 'Previous Versions' in Windows|inline=1}}
"description": xsd:string {{Note|optional description|inline=1}}
"provisionableId": xsd:string {{Note|UUID or name of the storage pool, if blank uses the pool associated with the source share|inline=1}}
"readOnly": xsd:boolean {{Note|snapshot to be marked read-only|inline=1}}
"isActive": xsd:boolean
"uuid": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareSnapshot?networkShare=val0&snapshotName=val1&description=val2&provisionableId=val3&readOnly=val4&isActive=val5&uuid=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareSnapshot.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareTemplateApply ==
''' Request Parameters '''
<code>
{
"method": "networkShareTemplateApply",
"params": {
"networkShareTemplate": xsd:string
"networkShare": xsd:string
"settingsMask": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareTemplate|osn:networkShareTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareTemplateApply?networkShareTemplate=val0&networkShare=val1&settingsMask=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareTemplateApply.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareTemplateCreate ==
''' Request Parameters '''
<code>
{
"method": "networkShareTemplateCreate",
"params": {
"networkShareId": xsd:string
"name": xsd:string
"description": xsd:string
"isDefault": xsd:boolean
"settingsMask": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareTemplate|osn:networkShareTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareTemplateCreate?networkShareId=val0&name=val1&description=val2&isDefault=val3&settingsMask=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareTemplateCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareTemplateDelete ==
''' Request Parameters '''
<code>
{
"method": "networkShareTemplateDelete",
"params": {
"networkShareTemplate": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareTemplate|osn:networkShareTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareTemplateDelete?networkShareTemplate=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareTemplateDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareTemplateEnum ==
returns information about all Network Share Templates in the the storage grid

''' Request Parameters '''
<code>
{
"method": "networkShareTemplateEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareTemplate|osn:networkShareTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareTemplateEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareTemplateEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareTemplateGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareTemplateGet",
"params": {
"networkShareTemplate": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareTemplate|osn:networkShareTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareTemplateGet?networkShareTemplate=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareTemplateGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareTemplateModify ==
''' Request Parameters '''
<code>
{
"method": "networkShareTemplateModify",
"params": {
"networkShareTemplate": xsd:string
"name": xsd:string
"description": xsd:string
"isDefault": xsd:boolean
"settingsMask": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShareTemplate|osn:networkShareTemplate]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareTemplateModify?networkShareTemplate=val0&name=val1&description=val2&isDefault=val3&settingsMask=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareTemplateModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareUnloadEncryptionKey ==
''' Request Parameters '''
<code>
{
"method": "networkShareUnloadEncryptionKey",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:networkShare|osn:networkShare]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareUnloadEncryptionKey?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareUnloadEncryptionKey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareUserAccessEnum ==
''' Request Parameters '''
<code>
{
"method": "networkShareUserAccessEnum",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:networkShareUserAccess|osn:networkShareUserAccess]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareUserAccessEnum?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareUserAccessEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== networkShareUserAccessGet ==
''' Request Parameters '''
<code>
{
"method": "networkShareUserAccessGet",
"params": {
"networkShareUserAccessId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:networkShareUserAccess|osn:networkShareUserAccess]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/networkShareUserAccessGet?networkShareUserAccessId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @networkShareUserAccessGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectEnum ==
''' Request Parameters '''
<code>
{
"method": "objectEnum",
"params": {
"propKey": xsd:string
"propValue": xsd:string
"propType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:object|osn:object]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectEnum?propKey=val0&propValue=val1&propType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectGet ==
''' Request Parameters '''
<code>
{
"method": "objectGet",
"params": {
"objectId": xsd:string
"objectType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:object|osn:object]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectGet?objectId=val0&objectType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectPropertyDelete ==
''' Request Parameters '''
<code>
{
"method": "objectPropertyDelete",
"params": {
"objectId": xsd:string
"propKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:objectProperty|osn:objectProperty]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertyDelete?objectId=val0&propKey=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectPropertyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectPropertyEnum ==
''' Request Parameters '''
<code>
{
"method": "objectPropertyEnum",
"params": {
"objectId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:objectProperty|osn:objectProperty]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertyEnum?objectId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectPropertyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectPropertyGet ==
''' Request Parameters '''
<code>
{
"method": "objectPropertyGet",
"params": {
"objectId": xsd:string
"propKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:objectProperty|osn:objectProperty]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertyGet?objectId=val0&propKey=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectPropertyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectPropertySet ==
''' Request Parameters '''
<code>
{
"method": "objectPropertySet",
"params": {
"objectId": xsd:string
"objectType": xsd:unsignedInt
"propKey": xsd:string
"propValue": xsd:string
"propType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:objectProperty|osn:objectProperty]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectPropertySet?objectId=val0&objectType=0&propKey=val2&propValue=val3&propType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectPropertySet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectSyncPolicyCreate ==
''' Request Parameters '''
<code>
{
"method": "objectSyncPolicyCreate",
"params": {
"srcCephCluster": xsd:string
"destCephCluster": xsd:string
"policyName": xsd:string
"policyDescription": xsd:string
"policyStatus": xsd:unsignedInt
"flowDirection": xsd:unsignedInt
"flowSourceZone": xsd:string
"flowDestZone": xsd:string
"srcBucket": xsd:string
"destBucket": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:objectSyncPolicy|osn:objectSyncPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectSyncPolicyCreate?srcCephCluster=val0&destCephCluster=val1&policyName=val2&policyDescription=val3&policyStatus=0&flowDirection=0&flowSourceZone=val6&flowDestZone=val7&srcBucket=val8&destBucket=val9&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectSyncPolicyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectSyncPolicyDelete ==
''' Request Parameters '''
<code>
{
"method": "objectSyncPolicyDelete",
"params": {
"objectSyncPolicy": xsd:string
"cephCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:objectSyncPolicy|osn:objectSyncPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectSyncPolicyDelete?objectSyncPolicy=val0&cephCluster=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectSyncPolicyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectSyncPolicyEnum ==
If neither bucket nor zone are specified, all object sync policies in the cluster are returned

''' Request Parameters '''
<code>
{
"method": "objectSyncPolicyEnum",
"params": {
"cephCluster": xsd:string
"bucket": xsd:string
"zone": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:objectSyncPolicy|osn:objectSyncPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectSyncPolicyEnum?cephCluster=val0&bucket=val1&zone=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectSyncPolicyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectSyncPolicyGet ==
Returns detailed info of the specified object sync policy.

''' Request Parameters '''
<code>
{
"method": "objectSyncPolicyGet",
"params": {
"objectSyncPolicy": xsd:string {{Note|Name or ID of the sync group|inline=1}}
"cephCluster": xsd:string {{Note|Ceph cluster ID|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:objectSyncPolicy|osn:objectSyncPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectSyncPolicyGet?objectSyncPolicy=val0&cephCluster=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectSyncPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== objectSyncPolicyModify ==
''' Request Parameters '''
<code>
{
"method": "objectSyncPolicyModify",
"params": {
"objectSyncPolicy": xsd:string
"cephCluster": xsd:string
"policyStatus": xsd:unsignedInt
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:objectSyncPolicy|osn:objectSyncPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/objectSyncPolicyModify?objectSyncPolicy=val0&cephCluster=val1&policyStatus=0&description=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @objectSyncPolicyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== passwordPolicyGet ==
''' Request Parameters '''
<code>
{
"method": "passwordPolicyGet",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:passwordPolicy|osn:passwordPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/passwordPolicyGet?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @passwordPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== passwordPolicySet ==
Sets the policy for user password complexity enforcement. Use [[#passwordPolicyGet]] to get current settings then call Set to modify with adjusted values.

''' Request Parameters '''
<code>
{
"method": "passwordPolicySet",
"params": {
"allowedSpecialChars": xsd:string {{Note|set of allowed special characters|inline=1}}
"complexityReq": xsd:unsignedInt {{Note|see [[enum:passwordComplexityReq]]|inline=1}}
"minLength": xsd:unsignedInt {{Note|Minimum password length, should always be >= 8|inline=1}}
"maxLength": xsd:unsignedInt {{Note|Maximum allowed password length|inline=1}}
"allowedLoginAttemptsUntilShortLockout": xsd:unsignedInt {{Note|Number of bad logins until account hits 2 min temporary lockout, 0 indicates no lockout|inline=1}}
"allowedLoginAttemptsUntilPermLockout": xsd:unsignedInt {{Note|Number of bad logins until account is locked, 0 indicates no lockout|inline=1}}
"shortLockoutSamplePeriod": xsd:unsignedInt {{Note|Sample period over which bad logins are collected to determine if a short lockout should be applied|inline=1}}
"permLockoutSamplePeriod": xsd:unsignedInt {{Note|Sample period over which bad logins are collected to determine if a perm lockout should be applied|inline=1}}
"shortLockoutDuration": xsd:unsignedInt {{Note|Duration of temporary/short login due to bad password attempts|inline=1}}
"daysUntilExpiration": xsd:unsignedInt {{Note|Number of days until user password expires, 0 indicates no expiration.|inline=1}}
"uniquePasswordsUntilReuse": xsd:unsignedInt {{Note|prevents users from reusing passwords by recording previously used password hashes|inline=1}}
"minDaysBetweenPasswordChange": xsd:unsignedInt {{Note|minimum days between password change makes it so that passwords cannot be frequently modified, 0 indicates no min days|inline=1}}
"minutesUntilWebAutoLogout": xsd:unsignedInt {{Note|Time elapsed until automatic web logout from the WUI if user is idle|inline=1}}
"systemUseNotification": xsd:string {{Note|arbitrary notice to present in the WUI when users login|inline=1}}
"webAccessMode": xsd:unsignedInt {{Note|0 allow HTTP & HTTPS, 1 disable HTTP, 2 redirect HTTP port to HTTPS|inline=1}}
"accountInactiveDaysUntilLockout": xsd:unsignedInt {{Note|locks out inactive accounts not used for a given amount of time, set to 0 for no lockout|inline=1}}
"defaultLoginUsername": xsd:string {{Note|default username to present on login|inline=1}}
"multiAdminApprovalTypes": xsd:string
"multiAdminApprovalCount": xsd:unsignedInt
"multiAdminApprovalExpirationHours": xsd:unsignedInt
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:passwordPolicy|osn:passwordPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/passwordPolicySet?allowedSpecialChars=val0&complexityReq=0&minLength=0&maxLength=0&allowedLoginAttemptsUntilShortLockout=0&allowedLoginAttemptsUntilPermLockout=0&shortLockoutSamplePeriod=0&permLockoutSamplePeriod=0&shortLockoutDuration=0&daysUntilExpiration=0&uniquePasswordsUntilReuse=0&minDaysBetweenPasswordChange=0&minutesUntilWebAutoLogout=0&systemUseNotification=val13&webAccessMode=0&accountInactiveDaysUntilLockout=0&defaultLoginUsername=val16&multiAdminApprovalTypes=val17&multiAdminApprovalCount=0&multiAdminApprovalExpirationHours=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @passwordPolicySet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== pendingOperationRequestApprove ==
''' Request Parameters '''
<code>
{
"method": "pendingOperationRequestApprove",
"params": {
"requestIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:pendingOperationRequest|osn:pendingOperationRequest]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pendingOperationRequestApprove?requestIdList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @pendingOperationRequestApprove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== pendingOperationRequestClearAll ==
''' Request Parameters '''
<code>
{
"method": "pendingOperationRequestClearAll",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:pendingOperationRequest|osn:pendingOperationRequest]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pendingOperationRequestClearAll?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @pendingOperationRequestClearAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== pendingOperationRequestEnum ==
''' Request Parameters '''
<code>
{
"method": "pendingOperationRequestEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:pendingOperationRequest|osn:pendingOperationRequest]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pendingOperationRequestEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @pendingOperationRequestEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== pendingOperationRequestGet ==
''' Request Parameters '''
<code>
{
"method": "pendingOperationRequestGet",
"params": {
"requestId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:pendingOperationRequest|osn:pendingOperationRequest]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pendingOperationRequestGet?requestId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @pendingOperationRequestGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== pendingOperationRequestReject ==
''' Request Parameters '''
<code>
{
"method": "pendingOperationRequestReject",
"params": {
"requestIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:pendingOperationRequest|osn:pendingOperationRequest]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pendingOperationRequestReject?requestIdList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @pendingOperationRequestReject.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== permissionDefinitionEnum ==
''' Request Parameters '''
<code>
{
"method": "permissionDefinitionEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:permissionDefinition|osn:permissionDefinition]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/permissionDefinitionEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @permissionDefinitionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskCopy ==
Provide a way for 3rd party SAN FC/iSCSI LUNs (Block Device) or Storage Volume to be copied to a new Storage Volume, Network Share, or Block Device

''' Request Parameters '''
<code>
{
"method": "physicalDiskCopy",
"params": {
"sourceId": xsd:string
"targetId": xsd:string
"sourceType": xsd:unsignedInt
"targetType": xsd:unsignedInt
"targetName": xsd:string
"blockSizeKb": xsd:unsignedInt
"targetImageFileType": xsd:unsignedInt
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"storageVolumeObj": [[#osn:storageVolume|osn:storageVolume]]
"networkShareObj": [[#osn:networkShare|osn:networkShare]]
"physicalDiskObj": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskCopy?sourceId=val0&targetId=val1&sourceType=0&targetType=0&targetName=val4&blockSizeKb=0&targetImageFileType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskCopy.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskEnum ==
Returns a list of all disk/storage media devices. Optionally specific disks or filter criteria may be passed into the physical disk list including, [nopaths], [paths], [spares], [nospares], [local], [used], [unused], [N] where N is some number of unused disks to be selected, [gt:SIZE] indicating the disk size must be greater than some value SIZE, [lt:SIZE] for disks less than a specific size, and [eq:SIZE] for disks that are a specific size. Other APIs including [[#storagePoolCreate]], [[#storagePoolGrow]], [[#storagePoolSpareAddRemove]], and [[#storagePoolCacheAddRemove]] also support this filtering / disk search syntax. Other supported filter parameters includ storage system IDs, friendly disk names, device names like 'sdc', device paths, device scsiId, device serialNumber, and property filters like [vendor:VVVV], [product:PPPP], and [disktype:N].

''' Request Parameters '''
<code>
{
"method": "physicalDiskEnum",
"params": {
"physicalDiskList": xsd:string
"flags": xsd:unsignedInt {{Note|supports the NORMALIZE flag to reduce results so that multiple instances of the same disk (from different systems and/or controllers) is reduced to a unique instance of each disk|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskEnum?physicalDiskList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskFormat ==
Formats the specified physical disk with optional data shreding.

''' Request Parameters '''
<code>
{
"method": "physicalDiskFormat",
"params": {
"physicalDriveIdList": xsd:string
"quickFormat": xsd:unsignedInt
"shredMode": xsd:unsignedInt
"releaseIoFence": xsd:boolean
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskFormat?physicalDriveIdList=val0&quickFormat=0&shredMode=0&releaseIoFence=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskFormat.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskGet ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskGet",
"params": {
"physicalDrive": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskGet?physicalDrive=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskGlobalSpareAddRemove ==
Add/Removes the specified disks to the pool of global hot-spares.

''' Request Parameters '''
<code>
{
"method": "physicalDiskGlobalSpareAddRemove",
"params": {
"physicalDriveList": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskGlobalSpareAddRemove?physicalDriveList=val0&modType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskGlobalSpareAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskGlobalSpareEnum ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskGlobalSpareEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskGlobalSpareEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskGlobalSpareEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskHotspareMarkerCleanup ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskHotspareMarkerCleanup",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDiskHotspareMarker|osn:physicalDiskHotspareMarker]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerCleanup?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskHotspareMarkerCleanup.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskHotspareMarkerDelete ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskHotspareMarkerDelete",
"params": {
"markerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:physicalDiskHotspareMarker|osn:physicalDiskHotspareMarker]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerDelete?markerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskHotspareMarkerDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskHotspareMarkerEnum ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskHotspareMarkerEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:physicalDiskHotspareMarker|osn:physicalDiskHotspareMarker]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskHotspareMarkerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskHotspareMarkerGet ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskHotspareMarkerGet",
"params": {
"markerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:physicalDiskHotspareMarker|osn:physicalDiskHotspareMarker]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskHotspareMarkerGet?markerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskHotspareMarkerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskIdentify ==
Activates the LED beacon on the specified drive.

''' Request Parameters '''
<code>
{
"method": "physicalDiskIdentify",
"params": {
"physicalDrive": xsd:string
"pattern": xsd:string
"duration": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskIdentify?physicalDrive=val0&pattern=val1&duration=0&blinkType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskMultipathConfigAddRemove ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskMultipathConfigAddRemove",
"params": {
"storageSystemId": xsd:string
"modType": xsd:unsignedInt
"deviceTagList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:multipathConfig|osn:multipathConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskMultipathConfigAddRemove?storageSystemId=val0&modType=0&deviceTagList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskMultipathConfigAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskMultipathConfigEnum ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskMultipathConfigEnum",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:multipathConfig|osn:multipathConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskMultipathConfigEnum?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskMultipathConfigEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskMultipathConfigScan ==
Forces an immediate scan and configuration of multipath devices on the specified system.

''' Request Parameters '''
<code>
{
"method": "physicalDiskMultipathConfigScan",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:multipathConfig|osn:multipathConfig]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskMultipathConfigScan?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskMultipathConfigScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskPerfTest ==
Performance tests the specified physical disk.

''' Request Parameters '''
<code>
{
"method": "physicalDiskPerfTest",
"params": {
"physicalDriveIdList": xsd:string
"perfTestType": xsd:unsignedInt
"blockSize": xsd:unsignedLong
"blockCount": xsd:unsignedLong
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskPerfTest?physicalDriveIdList=val0&perfTestType=0&blockSize=val2&blockCount=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskPerfTest.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskScan ==
Forces an immediate rescan to discover disk devices

''' Request Parameters '''
<code>
{
"method": "physicalDiskScan",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskScan?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskSearch ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== physicalDiskSecureEraseHardReset ==
''' Request Parameters '''
<code>
{
"method": "physicalDiskSecureEraseHardReset",
"params": {
"physicalDriveList": xsd:string
"psidPassphrase": xsd:string
"options": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/physicalDiskSecureEraseHardReset?physicalDriveList=val0&psidPassphrase=val1&options=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @physicalDiskSecureEraseHardReset.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== pingCheck ==
''' Request Parameters '''
<code>
{
"method": "pingCheck",
"params": {
"storageSystem": xsd:string
"verifyClientIps": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/pingCheck?storageSystem=val0&verifyClientIps=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @pingCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "portalGroupCreate",
"params": {
"name": xsd:string
"storagePoolId": xsd:string
"description": xsd:string
"portalGroupOptions": xsd:unsignedInt
"portIdList": xsd:string
"storageVolumeIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:portalGroup|osn:portalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupCreate?name=val0&storagePoolId=val1&description=val2&portalGroupOptions=0&portIdList=val4&storageVolumeIdList=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "portalGroupDelete",
"params": {
"portalGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:portalGroup|osn:portalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupDelete?portalGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "portalGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:portalGroup|osn:portalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupGet ==
''' Request Parameters '''
<code>
{
"method": "portalGroupGet",
"params": {
"portalGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:portalGroup|osn:portalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupGet?portalGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupModify ==
''' Request Parameters '''
<code>
{
"method": "portalGroupModify",
"params": {
"portalGroup": xsd:string
"name": xsd:string
"description": xsd:string
"portalGroupOptions": xsd:unsignedInt
"portIdList": xsd:string
"storageVolumeIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:portalGroup|osn:portalGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupModify?portalGroup=val0&name=val1&description=val2&portalGroupOptions=0&portIdList=val4&storageVolumeIdList=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupPortAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "portalGroupPortAssocEnum",
"params": {
"portalGroupId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:portalGroupPortAssoc|osn:portalGroupPortAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupPortAssocEnum?portalGroupId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupPortAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== portalGroupPortAssocGet ==
''' Request Parameters '''
<code>
{
"method": "portalGroupPortAssocGet",
"params": {
"portalGroupId": xsd:string
"portId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:portalGroupPortAssoc|osn:portalGroupPortAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/portalGroupPortAssocGet?portalGroupId=val0&portId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @portalGroupPortAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== providerAppEnum ==
Returns a list of registered Provider Apps (ex: VMware VASA).

''' Request Parameters '''
<code>
{
"method": "providerAppEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:providerApp|osn:providerApp]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @providerAppEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== providerAppGet ==
Returns details of a specific Provider App registered on a Storage System

''' Request Parameters '''
<code>
{
"method": "providerAppGet",
"params": {
"storageSystem": xsd:string
"providerType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:providerApp|osn:providerApp]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppGet?storageSystem=val0&providerType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @providerAppGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== providerAppRegister ==
Registers an external provider component with the Storage Grid (ex: VASA)

''' Request Parameters '''
<code>
{
"method": "providerAppRegister",
"params": {
"storageSystem": xsd:string
"providerType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:providerApp|osn:providerApp]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppRegister?storageSystem=val0&providerType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @providerAppRegister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== providerAppUnregister ==
Unreigsters a provider (ex: VMware VASA)

''' Request Parameters '''
<code>
{
"method": "providerAppUnregister",
"params": {
"providerApp": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:providerApp|osn:providerApp]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/providerAppUnregister?providerApp=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @providerAppUnregister.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== qosPolicyCreate ==
''' Request Parameters '''
<code>
{
"method": "qosPolicyCreate",
"params": {
"name": xsd:string
"description": xsd:string
"qosReadIops": xsd:unsignedLong
"qosWriteIops": xsd:unsignedLong
"qosReadBandwidth": xsd:unsignedLong
"qosWriteBandwidth": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:qosPolicy|osn:qosPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyCreate?name=val0&description=val1&qosReadIops=val2&qosWriteIops=val3&qosReadBandwidth=val4&qosWriteBandwidth=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @qosPolicyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== qosPolicyDelete ==
''' Request Parameters '''
<code>
{
"method": "qosPolicyDelete",
"params": {
"qosPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:qosPolicy|osn:qosPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyDelete?qosPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @qosPolicyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== qosPolicyEnum ==
''' Request Parameters '''
<code>
{
"method": "qosPolicyEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:qosPolicy|osn:qosPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @qosPolicyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== qosPolicyGet ==
''' Request Parameters '''
<code>
{
"method": "qosPolicyGet",
"params": {
"qosPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:qosPolicy|osn:qosPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyGet?qosPolicy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @qosPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== qosPolicyModify ==
''' Request Parameters '''
<code>
{
"method": "qosPolicyModify",
"params": {
"qosPolicy": xsd:string
"name": xsd:string
"description": xsd:string
"qosReadIops": xsd:unsignedLong
"qosWriteIops": xsd:unsignedLong
"qosReadBandwidth": xsd:unsignedLong
"qosWriteBandwidth": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:qosPolicy|osn:qosPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/qosPolicyModify?qosPolicy=val0&name=val1&description=val2&qosReadIops=val3&qosWriteIops=val4&qosReadBandwidth=val5&qosWriteBandwidth=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @qosPolicyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== remoteNfsExportsEnum ==
''' Request Parameters '''
<code>
{
"method": "remoteNfsExportsEnum",
"params": {
"networkShare": xsd:string
"nfsHostname": xsd:string
"backupPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/remoteNfsExportsEnum?networkShare=val0&nfsHostname=val1&backupPolicy=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @remoteNfsExportsEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== remoteStoragePoolEnum ==
''' Request Parameters '''
<code>
{
"method": "remoteStoragePoolEnum",
"params": {
"remoteStorageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/remoteStoragePoolEnum?remoteStorageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @remoteStoragePoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaAssocDelete ==
''' Request Parameters '''
<code>
{
"method": "replicaAssocDelete",
"params": {
"assocId": xsd:string
"deleteSourceReplicatable": xsd:boolean
"deleteTargetReplicatable": xsd:boolean
"deleteReplicaAssocHead": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaAssocDelete?assocId=val0&deleteSourceReplicatable=val1&deleteTargetReplicatable=val2&deleteReplicaAssocHead=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaAssocDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "replicaAssocEnum",
"params": {
"replicatableId": xsd:string
"sourcesOnly": xsd:boolean
"targetsOnly": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaAssocEnum?replicatableId=val0&sourcesOnly=val1&targetsOnly=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaAssocGet ==
''' Request Parameters '''
<code>
{
"method": "replicaAssocGet",
"params": {
"assocId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaAssocGet?assocId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaAssocUpdate ==
''' Request Parameters '''
<code>
{
"method": "replicaAssocUpdate",
"params": {
"assocObj": [[#osn:replicaAssoc|osn:replicaAssoc]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

== replicaCreate ==
''' Request Parameters '''
<code>
{
"method": "replicaCreate",
"params": {
"replicatableId": xsd:string
"storageSystemLinkId": xsd:string
"replicaName": xsd:string
"replicaDescription": xsd:string
"targetStoragePoolId": xsd:string
"smartSync": xsd:boolean
"forcePrimary": xsd:boolean
"reserved": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaCreate?replicatableId=val0&storageSystemLinkId=val1&replicaName=val2&replicaDescription=val3&targetStoragePoolId=val4&smartSync=val5&forcePrimary=val6&reserved=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaReportEntryEnum ==
''' Request Parameters '''
<code>
{
"method": "replicaReportEntryEnum",
"params": {
"summaryId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:replicaReportEntry|osn:replicaReportEntry]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportEntryEnum?summaryId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaReportEntryEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaReportEntryGet ==
''' Request Parameters '''
<code>
{
"method": "replicaReportEntryGet",
"params": {
"entryId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:replicaReportEntry|osn:replicaReportEntry]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportEntryGet?entryId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaReportEntryGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaReportSummaryDelete ==
''' Request Parameters '''
<code>
{
"method": "replicaReportSummaryDelete",
"params": {
"summaryId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaReportSummary|osn:replicaReportSummary]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportSummaryDelete?summaryId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaReportSummaryDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaReportSummaryEnum ==
''' Request Parameters '''
<code>
{
"method": "replicaReportSummaryEnum",
"params": {
"scheduleId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:replicaReportSummary|osn:replicaReportSummary]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportSummaryEnum?scheduleId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaReportSummaryEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaReportSummaryGet ==
''' Request Parameters '''
<code>
{
"method": "replicaReportSummaryGet",
"params": {
"entryId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:replicaReportSummary|osn:replicaReportSummary]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaReportSummaryGet?entryId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaReportSummaryGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaRollback ==
''' Request Parameters '''
<code>
{
"method": "replicaRollback",
"params": {
"assocId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaRollback?assocId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaStop ==
''' Request Parameters '''
<code>
{
"method": "replicaStop",
"params": {
"assocId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaStop?assocId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaStop.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicaSync ==
''' Request Parameters '''
<code>
{
"method": "replicaSync",
"params": {
"assocId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicaSync?assocId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicaSync.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleActivateCheckpoints ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleActivateCheckpoints",
"params": {
"schedule": xsd:string
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"autoCreateAliases": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleActivateCheckpoints?schedule=val0&storageVolumeList=val1&networkShareList=val2&autoCreateAliases=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleActivateCheckpoints.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleAddRemove ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleAddRemove",
"params": {
"schedule": xsd:string
"modType": xsd:unsignedInt
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleAddRemove?schedule=val0&modType=0&storageVolumeList=val2&networkShareList=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleAssocEnum",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:replicationScheduleAssocEx|osn:replicationScheduleAssocEx]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleAssocEnum?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleAssocGet ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleAssocGet",
"params": {
"scheduleId": xsd:string
"replicatableId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:replicationScheduleAssocEx|osn:replicationScheduleAssocEx]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleAssocGet?scheduleId=val0&replicatableId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleCreate ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleCreate",
"params": {
"name": xsd:string
"description": xsd:string
"resourceGroupId": xsd:string
"storageSystemLinkId": xsd:string
"targetResourceGroupId": xsd:string
"targetProvisionableId": xsd:string
"priority": xsd:unsignedInt
"setEnabled": xsd:unsignedInt
"startDate": xsd:dateTime
"maxReplicas": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"scheduleType": xsd:unsignedInt
"delayInterval": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"retentionCountHourliesSrc": xsd:unsignedInt
"retentionCountDailiesSrc": xsd:unsignedInt
"retentionCountWeekliesSrc": xsd:unsignedInt
"retentionCountMonthliesSrc": xsd:unsignedInt
"retentionCountQuarterliesSrc": xsd:unsignedInt
"retentionCountHourliesDst": xsd:unsignedInt
"retentionCountDailiesDst": xsd:unsignedInt
"retentionCountWeekliesDst": xsd:unsignedInt
"retentionCountMonthliesDst": xsd:unsignedInt
"retentionCountQuarterliesDst": xsd:unsignedInt
"reuseSourceSnapshot": xsd:boolean
"reuseTargetChkpnt": xsd:boolean
"scheduleActivationVifId": xsd:string
"retentionCountSumReports": xsd:unsignedInt
"enableRecursiveNestedShares": xsd:boolean
"enableResumableReplication": xsd:boolean
"absorbOldSnapshots": xsd:boolean
"copyShareSettings": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleCreate?name=val0&description=val1&resourceGroupId=val2&storageSystemLinkId=val3&targetResourceGroupId=val4&targetProvisionableId=val5&priority=0&setEnabled=0&startDate=val8&maxReplicas=0&daysOfWeek=0&hoursOfDay=0&storageVolumeList=val12&networkShareList=val13&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourliesSrc=0&retentionCountDailiesSrc=0&retentionCountWeekliesSrc=0&retentionCountMonthliesSrc=0&retentionCountQuarterliesSrc=0&retentionCountHourliesDst=0&retentionCountDailiesDst=0&retentionCountWeekliesDst=0&retentionCountMonthliesDst=0&retentionCountQuarterliesDst=0&reuseSourceSnapshot=val27&reuseTargetChkpnt=val28&scheduleActivationVifId=val29&retentionCountSumReports=0&enableRecursiveNestedShares=val31&enableResumableReplication=val32&absorbOldSnapshots=val33&copyShareSettings=val34&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleDeactivateCheckpoints ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleDeactivateCheckpoints",
"params": {
"schedule": xsd:string
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"reenableSchedule": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleDeactivateCheckpoints?schedule=val0&storageVolumeList=val1&networkShareList=val2&reenableSchedule=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleDeactivateCheckpoints.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleDelete ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleDelete",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleDelete?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleDisable ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleDisable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleDisable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleEnable ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleEnable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleEnable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleEnum ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleGet ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleGet",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleGet?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleModify ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleModify",
"params": {
"schedule": xsd:string
"name": xsd:string
"description": xsd:string
"resourceGroupId": xsd:string
"setEnabled": xsd:unsignedInt
"startDate": xsd:dateTime
"maxReplicas": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"scheduleType": xsd:unsignedInt
"delayInterval": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"retentionCountHourliesSrc": xsd:unsignedInt
"retentionCountDailiesSrc": xsd:unsignedInt
"retentionCountWeekliesSrc": xsd:unsignedInt
"retentionCountMonthliesSrc": xsd:unsignedInt
"retentionCountQuarterliesSrc": xsd:unsignedInt
"retentionCountHourliesDst": xsd:unsignedInt
"retentionCountDailiesDst": xsd:unsignedInt
"retentionCountWeekliesDst": xsd:unsignedInt
"retentionCountMonthliesDst": xsd:unsignedInt
"retentionCountQuarterliesDst": xsd:unsignedInt
"reuseSourceSnapshot": xsd:boolean
"reuseTargetChkpnt": xsd:boolean
"scheduleActivationVifId": xsd:string
"retentionCountSumReports": xsd:unsignedInt
"enableRecursiveNestedShares": xsd:boolean
"enableResumableReplication": xsd:boolean
"absorbOldSnapshots": xsd:boolean
"oldScheduleId": xsd:string
"copyShareSettings": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleModify?schedule=val0&name=val1&description=val2&resourceGroupId=val3&setEnabled=0&startDate=val5&maxReplicas=0&daysOfWeek=0&hoursOfDay=0&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourliesSrc=0&retentionCountDailiesSrc=0&retentionCountWeekliesSrc=0&retentionCountMonthliesSrc=0&retentionCountQuarterliesSrc=0&retentionCountHourliesDst=0&retentionCountDailiesDst=0&retentionCountWeekliesDst=0&retentionCountMonthliesDst=0&retentionCountQuarterliesDst=0&reuseSourceSnapshot=val22&reuseTargetChkpnt=val23&scheduleActivationVifId=val24&retentionCountSumReports=0&enableRecursiveNestedShares=val26&enableResumableReplication=val27&absorbOldSnapshots=val28&oldScheduleId=val29&copyShareSettings=val30&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleTrigger ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleTrigger",
"params": {
"schedule": xsd:string
"reuseSourceSnapshot": xsd:boolean
"reuseTargetChkpnt": xsd:boolean
"copyShareSettings": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleTrigger?schedule=val0&reuseSourceSnapshot=val1&reuseTargetChkpnt=val2&copyShareSettings=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== replicationScheduleTriggerRollback ==
''' Request Parameters '''
<code>
{
"method": "replicationScheduleTriggerRollback",
"params": {
"schedule": xsd:string
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:replicationSchedule|osn:replicationSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/replicationScheduleTriggerRollback?schedule=val0&storageVolumeList=val1&networkShareList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @replicationScheduleTriggerRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportGenerate ==
Does analysis of the configuration of each Storage System and the grid as a whole and returns a report.

''' Request Parameters '''
<code>
{
"method": "reportGenerate",
"params": {
"reportType": xsd:unsignedInt
"categories": xsd:unsignedInt
"reportToEmail": xsd:string
"reportToAlertEmails": xsd:boolean
"saveReport": xsd:boolean
"saveLocation": xsd:string
"outputFormat": xsd:unsignedInt
"storagePoolIdList": xsd:string
"maxDepth": xsd:unsignedInt
"maxSubdirs": xsd:unsignedInt
"minSubdirUsedSpace": xsd:unsignedLong
"maxBuckets": xsd:unsignedInt {{Note|Limit search to maxBuckets per tenant|inline=1}}
"maxUsers": xsd:unsignedInt {{Note|Limit search to maxBuckets per user|inline=1}}
"minUserUtilizedSpace": xsd:unsignedLong {{Note|Limit search to users with minimum utilized space.|inline=1}}
"minBucketUtilizedSpace": xsd:unsignedLong {{Note|Limit search to buckets with minimum utilized space.|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:report|osn:report]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportGenerate?reportType=0&categories=0&reportToEmail=val2&reportToAlertEmails=val3&saveReport=val4&saveLocation=val5&outputFormat=0&storagePoolIdList=val7&maxDepth=0&maxSubdirs=0&minSubdirUsedSpace=val10&maxBuckets=0&maxUsers=0&minUserUtilizedSpace=val13&minBucketUtilizedSpace=val14&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportGenerate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleAddRemove ==
Used to add/remove Storage Pools to/from a given report schedule

''' Request Parameters '''
<code>
{
"method": "reportScheduleAddRemove",
"params": {
"schedule": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"reportableIdList": xsd:string
"flags": xsd:unsignedInt {{Note|Pool ID list for pool capacity and share usage reports|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleAddRemove?schedule=val0&modType=0&reportableIdList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "reportScheduleAssocEnum",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:reportScheduleAssoc|osn:reportScheduleAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleAssocEnum?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleAssocGet ==
''' Request Parameters '''
<code>
{
"method": "reportScheduleAssocGet",
"params": {
"scheduleId": xsd:string
"reportableId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:reportScheduleAssoc|osn:reportScheduleAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleAssocGet?scheduleId=val0&reportableId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleCreate ==
Creates a new report schedule to email/notify of health status and pool usage

''' Request Parameters '''
<code>
{
"method": "reportScheduleCreate",
"params": {
"name": xsd:string
"description": xsd:string
"reportToEmail": xsd:string
"reportToAlertEmails": xsd:boolean
"saveReport": xsd:boolean
"saveLocation": xsd:string
"reportTypes": xsd:unsignedInt
"outputFormat": xsd:unsignedInt
"setEnabled": xsd:unsignedInt
"scheduleType": xsd:unsignedInt
"initialStartDate": xsd:dateTime
"delayInterval": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"maxSubdirDepth": xsd:unsignedInt
"maxSubdirsPerShare": xsd:unsignedInt
"minSubdirUsedSpace": xsd:unsignedLong {{Note|Pool ID list for pool capacity and share usage reports. Only one object pool per schedule|inline=1}}
"reportableIdList": xsd:string
"maxBuckets": xsd:unsignedInt {{Note|Limit search to maxBuckets per tenant|inline=1}}
"maxUsers": xsd:unsignedInt {{Note|Limit search to maxBuckets per user|inline=1}}
"minUserUtilizedSpace": xsd:unsignedLong {{Note|Limit search to users with minimum utilized space.|inline=1}}
"minBucketUtilizedSpace": xsd:unsignedLong {{Note|Limit search to buckets with minimum utilized space.|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleCreate?name=val0&description=val1&reportToEmail=val2&reportToAlertEmails=val3&saveReport=val4&saveLocation=val5&reportTypes=0&outputFormat=0&setEnabled=0&scheduleType=0&initialStartDate=val10&delayInterval=0&daysOfWeek=0&hoursOfDay=0&offsetMinutes=0&maxSubdirDepth=0&maxSubdirsPerShare=0&minSubdirUsedSpace=val17&reportableIdList=val18&maxBuckets=0&maxUsers=0&minUserUtilizedSpace=val21&minBucketUtilizedSpace=val22&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleDelete ==
Deletes the specified report schedule.

''' Request Parameters '''
<code>
{
"method": "reportScheduleDelete",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleDelete?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleDisable ==
Disables the specified report schedule. The schedule will not run again until it is re-enabled.

''' Request Parameters '''
<code>
{
"method": "reportScheduleDisable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleDisable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleEnable ==
Enables a report schedule that is offline.

''' Request Parameters '''
<code>
{
"method": "reportScheduleEnable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleEnable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleEnum ==
Returns a list of all the Report Schedules

''' Request Parameters '''
<code>
{
"method": "reportScheduleEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleGet ==
Returns detail on a specific Report Schedule

''' Request Parameters '''
<code>
{
"method": "reportScheduleGet",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleGet?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleModify ==
Modifies the properties and replication interval schedule for a specific schedule

''' Request Parameters '''
<code>
{
"method": "reportScheduleModify",
"params": {
"schedule": xsd:string {{Note|Name or ID of a report schedule|inline=1}}
"name": xsd:string
"description": xsd:string
"reportToEmail": xsd:string
"reportToAlertEmails": xsd:boolean
"saveReport": xsd:boolean
"saveLocation": xsd:string
"reportTypes": xsd:unsignedInt
"outputFormat": xsd:unsignedInt
"setEnabled": xsd:unsignedInt
"scheduleType": xsd:unsignedInt
"initialStartDate": xsd:dateTime
"delayInterval": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"maxSubdirDepth": xsd:unsignedInt
"maxSubdirsPerShare": xsd:unsignedInt
"minSubdirUsedSpace": xsd:unsignedLong
"maxBuckets": xsd:unsignedInt {{Note|Limit search to maxBuckets per tenant|inline=1}}
"maxUsers": xsd:unsignedInt {{Note|Limit search to maxBuckets per user|inline=1}}
"minUserUtilizedSpace": xsd:unsignedLong {{Note|Limit search to users with minimum utilized space.|inline=1}}
"minBucketUtilizedSpace": xsd:unsignedLong {{Note|Limit search to buckets with minimum utilized space.|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleModify?schedule=val0&name=val1&description=val2&reportToEmail=val3&reportToAlertEmails=val4&saveReport=val5&saveLocation=val6&reportTypes=0&outputFormat=0&setEnabled=0&scheduleType=0&initialStartDate=val11&delayInterval=0&daysOfWeek=0&hoursOfDay=0&offsetMinutes=0&maxSubdirDepth=0&maxSubdirsPerShare=0&minSubdirUsedSpace=val18&maxBuckets=0&maxUsers=0&minUserUtilizedSpace=val21&minBucketUtilizedSpace=val22&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== reportScheduleTrigger ==
Signals the schedule manager to run the selected schedule immediately.

''' Request Parameters '''
<code>
{
"method": "reportScheduleTrigger",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:reportSchedule|osn:reportSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/reportScheduleTrigger?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @reportScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainAssocEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:resourceDomainAssoc|osn:resourceDomainAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainAssocEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainAssocGet ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainAssocGet",
"params": {
"resourceDomainAssocId": xsd:string
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceDomainAssoc|osn:resourceDomainAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainAssocGet?resourceDomainAssocId=val0&storageSystemId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainCreate ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainCreate",
"params": {
"name": xsd:string
"description": xsd:string
"resourceDomainType": xsd:unsignedInt
"resourceDomainParentId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceDomain|osn:resourceDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainCreate?name=val0&description=val1&resourceDomainType=0&resourceDomainParentId=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainDelete ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainDelete",
"params": {
"resourceDomain": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceDomain|osn:resourceDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainDelete?resourceDomain=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainEnum ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:resourceDomain|osn:resourceDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainGet ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainGet",
"params": {
"resourceDomain": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceDomain|osn:resourceDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainGet?resourceDomain=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainModify ==
''' Request Parameters '''
<code>
{
"method": "resourceDomainModify",
"params": {
"resourceDomainId": xsd:string
"name": xsd:string
"description": xsd:string
"resourceDomainType": xsd:unsignedInt
"resourceDomainParentId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceDomain|osn:resourceDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainModify?resourceDomainId=val0&name=val1&description=val2&resourceDomainType=0&resourceDomainParentId=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceDomainStorageSystemAddRemove ==
see [[#enum:modifyType]] where 0=add, 1=remove, 2=set

''' Request Parameters '''
<code>
{
"method": "resourceDomainStorageSystemAddRemove",
"params": {
"resourceDomain": xsd:string
"modType": xsd:unsignedInt
"storageSystemList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceDomain|osn:resourceDomain]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceDomainStorageSystemAddRemove?resourceDomain=val0&modType=0&storageSystemList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceDomainStorageSystemAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupCreate",
"params": {
"name": xsd:string
"description": xsd:string
"userList": [[#osn:resourceGroupSubjectAssoc|osn:resourceGroupSubjectAssoc]] "resourceList": [[#osn:resourceGroupResourceAssoc|osn:resourceGroupResourceAssoc]] "networkList": xsd:string
"parentResourceGroup": xsd:string
"tier": xsd:string
"organization": xsd:string
"defaultChapUsername": xsd:string
"defaultChapPassword": xsd:string
"scope": xsd:string
"scopeType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

== resourceGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupDelete",
"params": {
"resourceGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupDelete?resourceGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupGet ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupGet",
"params": {
"resourceGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupGet?resourceGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupModify ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupModify",
"params": {
"resourceGroup": xsd:string
"name": xsd:string
"description": xsd:string
"parentResourceGroup": xsd:string
"tier": xsd:string
"organization": xsd:string
"defaultChapUsername": xsd:string
"defaultChapPassword": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupModify?resourceGroup=val0&name=val1&description=val2&parentResourceGroup=val3&tier=val4&organization=val5&defaultChapUsername=val6&defaultChapPassword=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupNetworkAddRemove ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupNetworkAddRemove",
"params": {
"resourceGroup": xsd:string
"modType": xsd:unsignedInt
"networkList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupNetworkAddRemove?resourceGroup=val0&modType=0&networkList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupNetworkAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupNetworkEnum ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupNetworkEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:resourceGroupNetwork|osn:resourceGroupNetwork]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupNetworkEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupNetworkEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupNetworkGet ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupNetworkGet",
"params": {
"resourceGroupNetwork": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceGroupNetwork|osn:resourceGroupNetwork]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupNetworkGet?resourceGroupNetwork=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupNetworkGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupResourceAddRemove ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupResourceAddRemove",
"params": {
"resourceGroup": xsd:string
"modType": xsd:unsignedInt
"objectType": xsd:unsignedInt
"resourceList": [[#osn:resourceGroupResourceAssoc|osn:resourceGroupResourceAssoc]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

== resourceGroupResourceAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupResourceAssocEnum",
"params": {
"resource": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:resourceGroupResourceAssoc|osn:resourceGroupResourceAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupResourceAssocEnum?resource=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupResourceAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupResourceAssocGet ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupResourceAssocGet",
"params": {
"resourceGroup": xsd:string
"resource": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceGroupResourceAssoc|osn:resourceGroupResourceAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupResourceAssocGet?resourceGroup=val0&resource=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupResourceAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupResourceSetMode ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupResourceSetMode",
"params": {
"resourceGroup": xsd:string
"resource": xsd:string
"accessMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupResourceSetMode?resourceGroup=val0&resource=val1&accessMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupResourceSetMode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupSubjectAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupSubjectAssocEnum",
"params": {
"subject": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:resourceGroupSubjectAssoc|osn:resourceGroupSubjectAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupSubjectAssocEnum?subject=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupSubjectAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupSubjectAssocGet ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupSubjectAssocGet",
"params": {
"resourceGroup": xsd:string
"subject": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceGroupSubjectAssoc|osn:resourceGroupSubjectAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/resourceGroupSubjectAssocGet?resourceGroup=val0&subject=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @resourceGroupSubjectAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== resourceGroupUserAddRemove ==
''' Request Parameters '''
<code>
{
"method": "resourceGroupUserAddRemove",
"params": {
"resourceGroup": xsd:string
"modType": xsd:unsignedInt
"userList": [[#osn:resourceGroupSubjectAssoc|osn:resourceGroupSubjectAssoc]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:resourceGroup|osn:resourceGroup]]
}
</code>

== roleCreate ==
''' Request Parameters '''
<code>
{
"method": "roleCreate",
"params": {
"name": xsd:string
"description": xsd:string
"permissionList": [[#osn:permissionAssignment|osn:permissionAssignment]] "inheritsFrom": xsd:string
"ldapGroup": xsd:string
"wuiTabDisable": xsd:unsignedInt
"wuiSectionDisable": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:role|osn:role]]
}
</code>

== roleDelete ==
''' Request Parameters '''
<code>
{
"method": "roleDelete",
"params": {
"role": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:role|osn:role]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleDelete?role=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @roleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== roleEnum ==
''' Request Parameters '''
<code>
{
"method": "roleEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:role|osn:role]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @roleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== roleGet ==
''' Request Parameters '''
<code>
{
"method": "roleGet",
"params": {
"role": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:role|osn:role]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleGet?role=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @roleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== roleModify ==
''' Request Parameters '''
<code>
{
"method": "roleModify",
"params": {
"role": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"ldapGroup": xsd:string
"wuiTabDisable": xsd:unsignedInt
"wuiSectionDisable": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:role|osn:role]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleModify?role=val0&newName=val1&newDescription=val2&ldapGroup=val3&wuiTabDisable=0&wuiSectionDisable=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @roleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== rolePermissionAssignmentEnum ==
''' Request Parameters '''
<code>
{
"method": "rolePermissionAssignmentEnum",
"params": {
"roleId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:rolePermissionAssignment|osn:rolePermissionAssignment]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/rolePermissionAssignmentEnum?roleId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @rolePermissionAssignmentEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== rolePermissionAssignmentGet ==
''' Request Parameters '''
<code>
{
"method": "rolePermissionAssignmentGet",
"params": {
"role": xsd:string
"objectType": xsd:string
"operation": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:rolePermissionAssignment|osn:rolePermissionAssignment]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/rolePermissionAssignmentGet?role=val0&objectType=val1&operation=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @rolePermissionAssignmentGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== rolePermissionsAddRemove ==
''' Request Parameters '''
<code>
{
"method": "rolePermissionsAddRemove",
"params": {
"role": xsd:string
"modType": xsd:unsignedInt
"permissionList": [[#osn:permissionAssignment|osn:permissionAssignment]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:role|osn:role]]
}
</code>

== roleSubjectAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "roleSubjectAssocEnum",
"params": {
"role": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:roleSubjectAssoc|osn:roleSubjectAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleSubjectAssocEnum?role=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @roleSubjectAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== roleSubjectAssocGet ==
''' Request Parameters '''
<code>
{
"method": "roleSubjectAssocGet",
"params": {
"role": xsd:string
"subject": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:roleSubjectAssoc|osn:roleSubjectAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/roleSubjectAssocGet?role=val0&subject=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @roleSubjectAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3ObjectEnum ==
Returns a list of objects contained within the specified bucket

''' Request Parameters '''
<code>
{
"method": "s3ObjectEnum",
"params": {
"cephClusterId": xsd:string
"bucket": xsd:string
"startingIndex": xsd:unsignedInt
"maxEntries": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:s3Object|osn:s3Object]]
"bucketStartingIndex": xsd:unsignedInt
"bucketObjectCount": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ObjectEnum?cephClusterId=val0&bucket=val1&startingIndex=0&maxEntries=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3ObjectEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3ProxyCreate ==
''' Request Parameters '''
<code>
{
"method": "s3ProxyCreate",
"params": {
"storageSystem": xsd:string
"name": xsd:string
"description": xsd:string
"proxyServerName": xsd:string
"proxyLocationEndpoint": xsd:string
"sslCertificate": xsd:string
"sslCertificateKey": xsd:string
"portNums": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3Proxy|osn:s3Proxy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyCreate?storageSystem=val0&name=val1&description=val2&proxyServerName=val3&proxyLocationEndpoint=val4&sslCertificate=val5&sslCertificateKey=val6&portNums=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3ProxyCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3ProxyDelete ==
''' Request Parameters '''
<code>
{
"method": "s3ProxyDelete",
"params": {
"s3Proxy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3Proxy|osn:s3Proxy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyDelete?s3Proxy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3ProxyDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3ProxyEnum ==
''' Request Parameters '''
<code>
{
"method": "s3ProxyEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:s3Proxy|osn:s3Proxy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3ProxyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3ProxyGet ==
''' Request Parameters '''
<code>
{
"method": "s3ProxyGet",
"params": {
"s3Proxy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:s3Proxy|osn:s3Proxy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyGet?s3Proxy=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3ProxyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3ProxyModify ==
''' Request Parameters '''
<code>
{
"method": "s3ProxyModify",
"params": {
"s3Proxy": xsd:string
"name": xsd:string
"description": xsd:string
"proxyServerName": xsd:string
"proxyLocationEndpoint": xsd:string
"sslCertificate": xsd:string
"sslCertificateKey": xsd:string
"portNums": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3Proxy|osn:s3Proxy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3ProxyModify?s3Proxy=val0&name=val1&description=val2&proxyServerName=val3&proxyLocationEndpoint=val4&sslCertificate=val5&sslCertificateKey=val6&portNums=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3ProxyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3TenantCreate ==
''' Request Parameters '''
<code>
{
"method": "s3TenantCreate",
"params": {
"cephClusterId": xsd:string
"name": xsd:string
"displayName": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3Tenant|osn:s3Tenant]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3TenantCreate?cephClusterId=val0&name=val1&displayName=val2&description=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3TenantCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3TenantDelete ==
''' Request Parameters '''
<code>
{
"method": "s3TenantDelete",
"params": {
"tenantId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3Tenant|osn:s3Tenant]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3TenantDelete?tenantId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3TenantDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3TenantEnum ==
''' Request Parameters '''
<code>
{
"method": "s3TenantEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:s3Tenant|osn:s3Tenant]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3TenantEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3TenantEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3TenantGet ==
''' Request Parameters '''
<code>
{
"method": "s3TenantGet",
"params": {
"tenant": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:s3Tenant|osn:s3Tenant]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3TenantGet?tenant=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3TenantGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserAccessKeyAdd ==
Returns detailed info of the specified bucket access key with the added key

''' Request Parameters '''
<code>
{
"method": "s3UserAccessKeyAdd",
"params": {
"s3UserId": xsd:string
"accessKey": xsd:string
"secretKey": xsd:string
"keyType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyAdd?s3UserId=val0&accessKey=val1&secretKey=val2&keyType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserAccessKeyAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserAccessKeyEnum ==
Returns a list of all the bucket access keys, optionally filtered by Ceph Cluster

''' Request Parameters '''
<code>
{
"method": "s3UserAccessKeyEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:s3UserAccessKey|osn:s3UserAccessKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserAccessKeyEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserAccessKeyGet ==
Returns detailed info of the specified bucket access key

''' Request Parameters '''
<code>
{
"method": "s3UserAccessKeyGet",
"params": {
"accessKeyId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:s3UserAccessKey|osn:s3UserAccessKey]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyGet?accessKeyId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserAccessKeyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserAccessKeyModify ==
Returns detailed info of the specified bucket access key with the added key

''' Request Parameters '''
<code>
{
"method": "s3UserAccessKeyModify",
"params": {
"s3UserId": xsd:string
"accessKey": xsd:string
"newSecretKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyModify?s3UserId=val0&accessKey=val1&newSecretKey=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserAccessKeyModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserAccessKeyRemove ==
Returns detailed info of the specified bucket access key with the removed key

''' Request Parameters '''
<code>
{
"method": "s3UserAccessKeyRemove",
"params": {
"s3UserId": xsd:string
"accessKey": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserAccessKeyRemove?s3UserId=val0&accessKey=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserAccessKeyRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserCreate ==
''' Request Parameters '''
<code>
{
"method": "s3UserCreate",
"params": {
"cephClusterId": xsd:string
"tenant": xsd:string
"name": xsd:string
"displayName": xsd:string
"emailAddress": xsd:string
"accessKey": xsd:string
"secretKey": xsd:string
"operationMask": xsd:unsignedInt
"bucketMaxObjectCountEnable": xsd:boolean
"bucketMaxObjectCount": xsd:unsignedLong
"bucketMaxSizeEnable": xsd:boolean
"bucketMaxSize": xsd:unsignedLong
"userMaxObjectCountEnable": xsd:boolean
"userMaxObjectCount": xsd:unsignedLong
"userMaxSizeEnable": xsd:boolean
"userMaxSize": xsd:unsignedLong
"maxBucketCount": xsd:unsignedInt
"count": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
"list": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserCreate?cephClusterId=val0&tenant=val1&name=val2&displayName=val3&emailAddress=val4&accessKey=val5&secretKey=val6&operationMask=0&bucketMaxObjectCountEnable=val8&bucketMaxObjectCount=val9&bucketMaxSizeEnable=val10&bucketMaxSize=val11&userMaxObjectCountEnable=val12&userMaxObjectCount=val13&userMaxSizeEnable=val14&userMaxSize=val15&maxBucketCount=0&count=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserDelete ==
''' Request Parameters '''
<code>
{
"method": "s3UserDelete",
"params": {
"cephClusterId": xsd:string
"s3UserList": xsd:string
"deleteData": xsd:boolean
"deleteKey": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserDelete?cephClusterId=val0&s3UserList=val1&deleteData=val2&deleteKey=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserDisable ==
''' Request Parameters '''
<code>
{
"method": "s3UserDisable",
"params": {
"s3UserId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserDisable?s3UserId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserEnable ==
''' Request Parameters '''
<code>
{
"method": "s3UserEnable",
"params": {
"s3UserId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserEnable?s3UserId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserEnum ==
''' Request Parameters '''
<code>
{
"method": "s3UserEnum",
"params": {
"cephClusterId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserEnum?cephClusterId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserGet ==
''' Request Parameters '''
<code>
{
"method": "s3UserGet",
"params": {
"userId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserGet?userId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== s3UserModify ==
''' Request Parameters '''
<code>
{
"method": "s3UserModify",
"params": {
"cephClusterId": xsd:string
"s3UserId": xsd:string
"displayName": xsd:string
"emailAddress": xsd:string
"bucketMaxObjectCountEnable": xsd:boolean
"bucketMaxObjectCount": xsd:unsignedLong
"bucketMaxSizeEnable": xsd:boolean
"bucketMaxSize": xsd:unsignedLong
"userMaxObjectCountEnable": xsd:boolean
"userMaxObjectCount": xsd:unsignedLong
"userMaxSizeEnable": xsd:boolean
"userMaxSize": xsd:unsignedLong
"maxBucketCount": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:s3User|osn:s3User]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/s3UserModify?cephClusterId=val0&s3UserId=val1&displayName=val2&emailAddress=val3&bucketMaxObjectCountEnable=val4&bucketMaxObjectCount=val5&bucketMaxSizeEnable=val6&bucketMaxSize=val7&userMaxObjectCountEnable=val8&userMaxObjectCount=val9&userMaxSizeEnable=val10&userMaxSize=val11&maxBucketCount=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @s3UserModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== serviceFirewallDefEnum ==
''' Request Parameters '''
<code>
{
"method": "serviceFirewallDefEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:serviceFirewallDef|osn:serviceFirewallDef]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/serviceFirewallDefEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @serviceFirewallDefEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== sessionClose ==
''' Request Parameters '''
<code>
{
"method": "sessionClose",
"params": {
"storageVolume": xsd:string
"sessionList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:session|osn:session]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/sessionClose?storageVolume=val0&sessionList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @sessionClose.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== sessionEnum ==
''' Request Parameters '''
<code>
{
"method": "sessionEnum",
"params": {
"host": xsd:string
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:session|osn:session]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/sessionEnum?host=val0&storageVolume=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @sessionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== sessionGet ==
''' Request Parameters '''
<code>
{
"method": "sessionGet",
"params": {
"sessionId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:session|osn:session]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/sessionGet?sessionId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @sessionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== setAuthMode ==
''' Request Parameters '''
<code>
{
"method": "setAuthMode",
"params": {
"authRequestCode": xsd:string
"authMode": xsd:unsignedInt
"device": [[#osn:multiFactorAuthDevice|osn:multiFactorAuthDevice]] "passcode": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"requestStatus": xsd:string
}
</code>

== singleSignOnPolicyGet ==
''' Request Parameters '''
<code>
{
"method": "singleSignOnPolicyGet",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:singleSignOnPolicy|osn:singleSignOnPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/singleSignOnPolicyGet?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @singleSignOnPolicyGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== singleSignOnPolicySet ==
Sets the policy for user password complexity enforcement. Use [[#singleSignPolicyGet]] to get current settings then call Set to modify with adjusted values.

''' Request Parameters '''
<code>
{
"method": "singleSignOnPolicySet",
"params": {
"isEnabled": xsd:boolean
"ldapServer": xsd:string {{Note|Ldap server FQDN|inline=1}}
"ldapBaseDn": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:singleSignOnPolicy|osn:singleSignOnPolicy]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/singleSignOnPolicySet?isEnabled=val0&ldapServer=val1&ldapBaseDn=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @singleSignOnPolicySet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "siteClusterAssocEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:siteClusterAssoc|osn:siteClusterAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterAssocEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterAssocGet ==
''' Request Parameters '''
<code>
{
"method": "siteClusterAssocGet",
"params": {
"siteAssocId": xsd:string
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:siteClusterAssoc|osn:siteClusterAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterAssocGet?siteAssocId=val0&storageSystemId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterCreate ==
''' Request Parameters '''
<code>
{
"method": "siteClusterCreate",
"params": {
"name": xsd:string
"description": xsd:string
"location": xsd:string
"storageSystemList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterCreate?name=val0&description=val1&location=val2&storageSystemList=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterDelete ==
''' Request Parameters '''
<code>
{
"method": "siteClusterDelete",
"params": {
"site": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterDelete?site=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterEnum ==
''' Request Parameters '''
<code>
{
"method": "siteClusterEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterGet ==
''' Request Parameters '''
<code>
{
"method": "siteClusterGet",
"params": {
"site": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterGet?site=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterModify ==
''' Request Parameters '''
<code>
{
"method": "siteClusterModify",
"params": {
"siteClusterId": xsd:string
"name": xsd:string
"description": xsd:string
"location": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterModify?siteClusterId=val0&name=val1&description=val2&location=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterRescan ==
''' Request Parameters '''
<code>
{
"method": "siteClusterRescan",
"params": {
"siteCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterRescan?siteCluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterRestartServices ==
''' Request Parameters '''
<code>
{
"method": "siteClusterRestartServices",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterRestartServices?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterRestartServices.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterSetMaintenanceMode ==
''' Request Parameters '''
<code>
{
"method": "siteClusterSetMaintenanceMode",
"params": {
"siteCluster": xsd:string
"enable": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterSetMaintenanceMode?siteCluster=val0&enable=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterSetMaintenanceMode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteClusterSetStandbyMode ==
''' Request Parameters '''
<code>
{
"method": "siteClusterSetStandbyMode",
"params": {
"siteCluster": xsd:string
"siteClusterAssocId": xsd:string
"standbyMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteClusterAssoc|osn:siteClusterAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteClusterSetStandbyMode?siteCluster=val0&siteClusterAssocId=val1&standbyMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteClusterSetStandbyMode.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteStorageSystemAddRemove ==
see [[#enum:modifyType]] where 0=add, 1=remove, 2=set

''' Request Parameters '''
<code>
{
"method": "siteStorageSystemAddRemove",
"params": {
"site": xsd:string
"modType": xsd:unsignedInt
"storageSystemList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteCluster|osn:siteCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteStorageSystemAddRemove?site=val0&modType=0&storageSystemList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteStorageSystemAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifLocationConstraintEnum ==
''' Request Parameters '''
<code>
{
"method": "siteVifLocationConstraintEnum",
"params": {
"siteVifResource": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:siteVifLocationConstraint|osn:siteVifLocationConstraint]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifLocationConstraintEnum?siteVifResource=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifLocationConstraintEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifLocationConstraintGet ==
''' Request Parameters '''
<code>
{
"method": "siteVifLocationConstraintGet",
"params": {
"siteVifResourceId": xsd:string
"nodeSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:siteVifLocationConstraint|osn:siteVifLocationConstraint]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifLocationConstraintGet?siteVifResourceId=val0&nodeSystemId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifLocationConstraintGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifResourceCreate ==
''' Request Parameters '''
<code>
{
"method": "siteVifResourceCreate",
"params": {
"siteClusterId": xsd:string
"parentInterfaceName": xsd:string
"ipAddress": xsd:string
"gateway": xsd:string
"subnetMask": xsd:string
"macAddress": xsd:string
"description": xsd:string
"locationConfigList": xsd:string
"useCaseObjId": xsd:string
"useCase": xsd:unsignedInt
"iscsiEnabled": xsd:boolean
"nvmeEnabled": xsd:boolean
"mtu": xsd:unsignedInt
"fqdn": xsd:string
"convertVif": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceCreate?siteClusterId=val0&parentInterfaceName=val1&ipAddress=val2&gateway=val3&subnetMask=val4&macAddress=val5&description=val6&locationConfigList=val7&useCaseObjId=val8&useCase=0&iscsiEnabled=val10&nvmeEnabled=val11&mtu=0&fqdn=val13&convertVif=val14&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifResourceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifResourceDelete ==
''' Request Parameters '''
<code>
{
"method": "siteVifResourceDelete",
"params": {
"siteVifResource": xsd:string
"convertToVif": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceDelete?siteVifResource=val0&convertToVif=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifResourceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifResourceEnum ==
''' Request Parameters '''
<code>
{
"method": "siteVifResourceEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifResourceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifResourceGet ==
''' Request Parameters '''
<code>
{
"method": "siteVifResourceGet",
"params": {
"siteVifResource": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceGet?siteVifResource=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifResourceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifResourceModify ==
''' Request Parameters '''
<code>
{
"method": "siteVifResourceModify",
"params": {
"siteVifResource": xsd:string
"description": xsd:string
"locationConfigList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceModify?siteVifResource=val0&description=val1&locationConfigList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifResourceModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== siteVifResourceMove ==
''' Request Parameters '''
<code>
{
"method": "siteVifResourceMove",
"params": {
"siteVifResource": xsd:string
"moveToSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/siteVifResourceMove?siteVifResource=val0&moveToSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @siteVifResourceMove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "snapshotScheduleAssocEnum",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:snapshotScheduleAssoc|osn:snapshotScheduleAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleAssocEnum?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleAssocGet ==
''' Request Parameters '''
<code>
{
"method": "snapshotScheduleAssocGet",
"params": {
"scheduleId": xsd:string
"storageVolumeId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:snapshotScheduleAssoc|osn:snapshotScheduleAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleAssocGet?scheduleId=val0&storageVolumeId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleCreate ==
Creates a new Snapshot Schedule to automatically create snapshots of the specified Storage Volumes and/or Network Shares

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleCreate",
"params": {
"name": xsd:string
"description": xsd:string
"resourceGroupId": xsd:string
"setEnabled": xsd:unsignedInt
"startDate": xsd:dateTime
"maxSnapshots": xsd:unsignedInt
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"scheduleType": xsd:unsignedInt
"delayInterval": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"retentionCountHourlies": xsd:unsignedInt
"retentionCountDailies": xsd:unsignedInt
"retentionCountWeeklies": xsd:unsignedInt
"retentionCountMonthlies": xsd:unsignedInt
"retentionCountQuarterlies": xsd:unsignedInt
"enableRecursiveNestedShares": xsd:boolean
"absorbOldSnapshots": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleCreate?name=val0&description=val1&resourceGroupId=val2&setEnabled=0&startDate=val4&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&storageVolumeList=val8&networkShareList=val9&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&enableRecursiveNestedShares=val18&absorbOldSnapshots=val19&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleDelete ==
Deletes the specified snapshot schedule.

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleDelete",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleDelete?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleDisable ==
Disables the specified snapshot schedule. The schedule will not run again until it is re-enabled.

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleDisable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleDisable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleEnable ==
Enables a snapshot schedule that is offline.

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleEnable",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleEnable?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleEnum ==
Returns a list of all the Snapshot Schedules

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleGet ==
Returns detail on a specific Snapshot Schedule

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleGet",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleGet?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleModify ==
Modifies the properties and replication interval schedule for a specific schedule

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleModify",
"params": {
"schedule": xsd:string {{Note|Name or ID of a snapshot schedule|inline=1}}
"name": xsd:string {{Note|New name for the snapshot schedule|inline=1}}
"description": xsd:string {{Note|Description of the snapshot schedule|inline=1}}
"resourceGroupId": xsd:string {{Note|Resource Group to assocate the snapshot schedule with|inline=1}}
"setEnabled": xsd:unsignedInt {{Note|enables/disables the schedule|inline=1}}
"startDate": xsd:dateTime {{Note|start date after which the schedule is active|inline=1}}
"maxSnapshots": xsd:unsignedInt {{Note|Number of snapshots used in a rotation. Note this exludes the snapshots marked for long term rention|inline=1}}
"daysOfWeek": xsd:unsignedInt {{Note|Calendar based, days of the week to do snapshots|inline=1}}
"hoursOfDay": xsd:unsignedInt {{Note|Calendar based, hours of the day to take snapshots|inline=1}}
"scheduleType": xsd:unsignedInt {{Note|Calendar based or Interval Based|inline=1}}
"delayInterval": xsd:unsignedInt {{Note|Delay interval in seconds between snapshots|inline=1}}
"offsetMinutes": xsd:unsignedInt {{Note|Calendar based, offset in minutes for the scheduled hour(S) to take snapshots|inline=1}}
"retentionCountHourlies": xsd:unsignedInt {{Note|Long term snapshot retention rule for how many hourly snapshots to be retained.|inline=1}}
"retentionCountDailies": xsd:unsignedInt {{Note|Long term snapshot retention rule for daily snapshots|inline=1}}
"retentionCountWeeklies": xsd:unsignedInt {{Note|Long term snapshot retention rule for weekly snapshot count to be retained.|inline=1}}
"retentionCountMonthlies": xsd:unsignedInt {{Note|Long term snapshot retention rule for monthly snapshot count to be retained.|inline=1}}
"retentionCountQuarterlies": xsd:unsignedInt {{Note|Long term snapshot retention rule for quarterly snapshots to be retained.|inline=1}}
"enableRecursiveNestedShares": xsd:boolean
"absorbOldSnapshots": xsd:boolean
"oldScheduleId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleModify?schedule=val0&name=val1&description=val2&resourceGroupId=val3&setEnabled=0&startDate=val5&maxSnapshots=0&daysOfWeek=0&hoursOfDay=0&scheduleType=0&delayInterval=0&offsetMinutes=0&retentionCountHourlies=0&retentionCountDailies=0&retentionCountWeeklies=0&retentionCountMonthlies=0&retentionCountQuarterlies=0&enableRecursiveNestedShares=val17&absorbOldSnapshots=val18&oldScheduleId=val19&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleTrigger ==
Signals the schedule manager to run the selected schedule immediately.

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleTrigger",
"params": {
"schedule": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleTrigger?schedule=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleTrigger.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== snapshotScheduleVolumeAddRemove ==
Used to add/remove Storage Volumes and Network Shares to/from a given Snapshot Schedule

''' Request Parameters '''
<code>
{
"method": "snapshotScheduleVolumeAddRemove",
"params": {
"schedule": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"storageVolumeList": xsd:string
"networkShareList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:snapshotSchedule|osn:snapshotSchedule]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/snapshotScheduleVolumeAddRemove?schedule=val0&modType=0&storageVolumeList=val2&networkShareList=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @snapshotScheduleVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolCacheAddRemove ==
Adds SSDs to the specified Storage Pool to boost read and write performance.

''' Request Parameters '''
<code>
{
"method": "storagePoolCacheAddRemove",
"params": {
"storagePool": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"readCacheDeviceList": xsd:string
"writeLogDeviceList": xsd:string
"specialOffloadDeviceList": xsd:string
"dedupOffloadDeviceList": xsd:string
"smallBlockThreshold": xsd:unsignedInt {{Note|see API [[#physicalDiskEnum]] for information on supported disk selection filters|inline=1}}
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCacheAddRemove?storagePool=val0&modType=0&readCacheDeviceList=val2&writeLogDeviceList=val3&specialOffloadDeviceList=val4&dedupOffloadDeviceList=val5&smallBlockThreshold=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolCacheAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolCheckpointCreate ==
''' Request Parameters '''
<code>
{
"method": "storagePoolCheckpointCreate",
"params": {
"storagePool": xsd:string
"expirationDays": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCheckpointCreate?storagePool=val0&expirationDays=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolCheckpointCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolCheckpointDelete ==
''' Request Parameters '''
<code>
{
"method": "storagePoolCheckpointDelete",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCheckpointDelete?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolCheckpointDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolCheckpointModify ==
''' Request Parameters '''
<code>
{
"method": "storagePoolCheckpointModify",
"params": {
"storagePool": xsd:string
"expirationDays": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCheckpointModify?storagePool=val0&expirationDays=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolCheckpointModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolClearMissing ==
Clear all missing shares and volumes from the specified storage pool. This is useful when missing shares and volumes are no longer needed in the database.

''' Request Parameters '''
<code>
{
"method": "storagePoolClearMissing",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolClearMissing?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolClearMissing.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolCreate ==
Creates a new Storage Pool using the specified disk/device list. System will automatically configure the pool for enclosure redundancy where possible.

''' Request Parameters '''
<code>
{
"method": "storagePoolCreate",
"params": {
"name": xsd:string {{Note|see API [[#physicalDiskEnum]] for information on supported disk selection filters|inline=1}}
"physicalDiskList": xsd:string
"description": xsd:string
"raidType": xsd:unsignedInt
"poolType": xsd:unsignedInt
"isDefault": xsd:boolean
"enableCompression": xsd:boolean
"enableAutoTrim": xsd:boolean
"profile": xsd:string
"raidSetSize": xsd:unsignedInt
"enableEncryption": xsd:boolean
"encryptionType": xsd:string
"encryptionKeyPassphrase": xsd:string
"keyServerType": xsd:unsignedInt
"keyServerProfileId": xsd:string
"ashift": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolCreate?name=val0&physicalDiskList=val1&description=val2&raidType=0&poolType=0&isDefault=val5&enableCompression=val6&enableAutoTrim=val7&profile=val8&raidSetSize=0&enableEncryption=val10&encryptionType=val11&encryptionKeyPassphrase=val12&keyServerType=0&keyServerProfileId=val14&ashift=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDestroy ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDestroy",
"params": {
"storagePool": xsd:string
"deleteKeys": xsd:boolean
"dataShredMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDestroy?storagePool=val0&deleteKeys=val1&dataShredMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDestroy.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceEnum",
"params": {
"storagePoolId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePoolDevice|osn:storagePoolDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceEnum?storagePoolId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceGet ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceGet",
"params": {
"storagePoolDevice": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storagePoolDevice|osn:storagePoolDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGet?storagePoolDevice=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceGroupEnum",
"params": {
"storagePoolId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePoolDeviceGroup|osn:storagePoolDeviceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupEnum?storagePoolId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceGroupGet ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceGroupGet",
"params": {
"storagePoolDeviceGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storagePoolDeviceGroup|osn:storagePoolDeviceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupGet?storagePoolDeviceGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceGroupIdentify ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceGroupIdentify",
"params": {
"storagePoolDeviceGroup": xsd:string
"durationInSeconds": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolDeviceGroup|osn:storagePoolDeviceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupIdentify?storagePoolDeviceGroup=val0&durationInSeconds=0&blinkType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceGroupIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceGroupSearch ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceGroupSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storagePoolDeviceGroup|osn:storagePoolDeviceGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceGroupSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceGroupSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolDeviceSearch ==
''' Request Parameters '''
<code>
{
"method": "storagePoolDeviceSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storagePoolDevice|osn:storagePoolDevice]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolDeviceSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolDeviceSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolEncryptionKeyExport ==
Exports encryption keys into a key block that can be easily saved to a text file and restored later

''' Request Parameters '''
<code>
{
"method": "storagePoolEncryptionKeyExport",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
"keyBlock": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolEncryptionKeyExport?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolEncryptionKeyExport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolEncryptionKeyImport ==
Imports previously exported encryption keys so that they may be used to unlock media and activate a pool

''' Request Parameters '''
<code>
{
"method": "storagePoolEncryptionKeyImport",
"params": {
"storageSystem": xsd:string
"keyBlock": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolEncryptionKeyImport?storageSystem=val0&keyBlock=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolEncryptionKeyImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolExpand ==
Expands the specified storage pool using available unused space on the disk devices.

''' Request Parameters '''
<code>
{
"method": "storagePoolExpand",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolExpand?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolExpand.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolExport ==
''' Request Parameters '''
<code>
{
"method": "storagePoolExport",
"params": {
"storagePool": xsd:string
"releaseIoFence": xsd:boolean
"clearCrypttabEntries": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolExport?storagePool=val0&releaseIoFence=val1&clearCrypttabEntries=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolExport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolGet ==
''' Request Parameters '''
<code>
{
"method": "storagePoolGet",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolGet?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolGrow ==
Grows the specified pool by adding the specified devices to create and add a new Storage Pool Device Gruops (vdevs) to the storage pool.

''' Request Parameters '''
<code>
{
"method": "storagePoolGrow",
"params": {
"storagePool": xsd:string {{Note|see API [[#physicalDiskEnum]] for information on supported disk selection filters|inline=1}}
"physicalDiskList": xsd:string
"raidType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolGrow?storagePool=val0&physicalDiskList=val1&raidType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolGrow.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupActivate ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupActivate",
"params": {
"failoverGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupActivate?failoverGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupActivate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupCheckHealthStatus ==
perform failover health checks and return the various healthStatusEntries from the primary, secondary, and tertiary nodes

''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupCheckHealthStatus",
"params": {
"poolIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:healthStatusEvent|osn:healthStatusEvent]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupCheckHealthStatus?poolIdList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupCheckHealthStatus.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupCreate",
"params": {
"storagePoolId": xsd:string
"name": xsd:string
"description": xsd:string
"primaryStorageSystemId": xsd:string
"secondaryStorageSystemId": xsd:string
"tertiaryStorageSystemId": xsd:string
"settleTimeInSec": xsd:unsignedInt
"verifyClientIps": xsd:string
"haClientFailoverPolicy": xsd:unsignedInt
"haLinkStateFailoverPolicy": xsd:unsignedInt
"haFcLinkStateFailoverPolicy": xsd:unsignedInt
"exportTimeout": xsd:unsignedInt
"enforceSmbHostsAllow": xsd:boolean
"enforceNfsHostsAllow": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupCreate?storagePoolId=val0&name=val1&description=val2&primaryStorageSystemId=val3&secondaryStorageSystemId=val4&tertiaryStorageSystemId=val5&settleTimeInSec=0&verifyClientIps=val7&haClientFailoverPolicy=0&haLinkStateFailoverPolicy=0&haFcLinkStateFailoverPolicy=0&exportTimeout=0&enforceSmbHostsAllow=val12&enforceNfsHostsAllow=val13&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupDeactivate ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupDeactivate",
"params": {
"failoverGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupDeactivate?failoverGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupDeactivate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupDelete",
"params": {
"failoverGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupDelete?failoverGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupFailover ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupFailover",
"params": {
"failoverGroup": xsd:string
"targetStorageSystem": xsd:string
"failoverReason": xsd:unsignedInt
"importHealthChecks": xsd:boolean
"exportHealthChecks": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupFailover?failoverGroup=val0&targetStorageSystem=val1&failoverReason=0&importHealthChecks=val3&exportHealthChecks=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupFailover.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupGet ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupGet",
"params": {
"failoverGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupGet?failoverGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupGetHealthStatus ==
Analyze the failover ability of the given storage pool by reading the various healthStatusEntries objects from the primary, secondary, and tertiary nodes

''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupGetHealthStatus",
"params": {
"poolIdList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:healthStatusEvent|osn:healthStatusEvent]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupGetHealthStatus?poolIdList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupGetHealthStatus.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverGroupModify ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverGroupModify",
"params": {
"failoverGroup": xsd:string
"name": xsd:string
"description": xsd:string
"primaryStorageSystemId": xsd:string
"secondaryStorageSystemId": xsd:string
"tertiaryStorageSystemId": xsd:string
"settleTimeInSec": xsd:unsignedInt
"verifyClientIps": xsd:string
"haClientFailoverPolicy": xsd:unsignedInt
"haLinkStateFailoverPolicy": xsd:unsignedInt
"haFcLinkStateFailoverPolicy": xsd:unsignedInt
"exportTimeout": xsd:unsignedInt
"enforceSmbHostsAllow": xsd:boolean
"enforceNfsHostsAllow": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverGroupModify?failoverGroup=val0&name=val1&description=val2&primaryStorageSystemId=val3&secondaryStorageSystemId=val4&tertiaryStorageSystemId=val5&settleTimeInSec=0&verifyClientIps=val7&haClientFailoverPolicy=0&haLinkStateFailoverPolicy=0&haFcLinkStateFailoverPolicy=0&exportTimeout=0&enforceSmbHostsAllow=val12&enforceNfsHostsAllow=val13&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverInterfaceCreate ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverInterfaceCreate",
"params": {
"failoverGroup": xsd:string
"tag": xsd:string
"parentInterfaceName": xsd:string
"description": xsd:string
"ipAddress": xsd:string
"subnetMask": xsd:string
"macAddress": xsd:string
"locationConfigList": xsd:string
"iscsiEnabled": xsd:boolean
"nvmeofEnabled": xsd:boolean
"fqdn": xsd:string
"convertVif": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverInterface|osn:storagePoolHaFailoverInterface]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceCreate?failoverGroup=val0&tag=val1&parentInterfaceName=val2&description=val3&ipAddress=val4&subnetMask=val5&macAddress=val6&locationConfigList=val7&iscsiEnabled=val8&nvmeofEnabled=val9&fqdn=val10&convertVif=val11&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverInterfaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverInterfaceDelete ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverInterfaceDelete",
"params": {
"failoverGroup": xsd:string
"failoverInterface": xsd:string
"convertToVif": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePoolHaFailoverInterface|osn:storagePoolHaFailoverInterface]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceDelete?failoverGroup=val0&failoverInterface=val1&convertToVif=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverInterfaceDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverInterfaceEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverInterfaceEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePoolHaFailoverInterface|osn:storagePoolHaFailoverInterface]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverInterfaceEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHaFailoverInterfaceGet ==
''' Request Parameters '''
<code>
{
"method": "storagePoolHaFailoverInterfaceGet",
"params": {
"failoverGroup": xsd:string
"failoverInterface": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storagePoolHaFailoverInterface|osn:storagePoolHaFailoverInterface]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHaFailoverInterfaceGet?failoverGroup=val0&failoverInterface=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHaFailoverInterfaceGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolHealthCheck ==
Returns a health check report for the specified Storage Pool

''' Request Parameters '''
<code>
{
"method": "storagePoolHealthCheck",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceHealthCheck|osn:resourceHealthCheck]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolHealthCheck?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolHealthCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolIdentify ==
''' Request Parameters '''
<code>
{
"method": "storagePoolIdentify",
"params": {
"storagePool": xsd:string
"durationInSeconds": xsd:unsignedInt
"blinkType": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolIdentify?storagePool=val0&durationInSeconds=0&blinkType=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolIdentify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolImport ==
''' Request Parameters '''
<code>
{
"method": "storagePoolImport",
"params": {
"storageSystem": xsd:string
"storagePoolList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolImport?storageSystem=val0&storagePoolList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolImportEncrypted ==
''' Request Parameters '''
<code>
{
"method": "storagePoolImportEncrypted",
"params": {
"storageSystem": xsd:string
"storagePoolList": xsd:string
"encryptionKeyPassphrase": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolImportEncrypted?storageSystem=val0&storagePoolList=val1&encryptionKeyPassphrase=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolImportEncrypted.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolModify ==
''' Request Parameters '''
<code>
{
"method": "storagePoolModify",
"params": {
"storagePool": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"isDefault": xsd:boolean
"enableCompression": xsd:boolean
"enableAutoTrim": xsd:boolean
"profile": xsd:string
"syncPolicy": xsd:unsignedInt
"cachePolicyPrimary": xsd:unsignedInt
"cachePolicySecondary": xsd:unsignedInt
"compressionType": xsd:string
"hotspareRepairPolicy": xsd:unsignedInt
"copies": xsd:unsignedInt
"keyServerProfileId": xsd:string
"keyServerType": xsd:unsignedInt
"smallBlockThreshold": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolModify?storagePool=val0&newName=val1&newDescription=val2&isDefault=val3&enableCompression=val4&enableAutoTrim=val5&profile=val6&syncPolicy=0&cachePolicyPrimary=0&cachePolicySecondary=0&compressionType=val10&hotspareRepairPolicy=0&copies=0&keyServerProfileId=val13&keyServerType=0&smallBlockThreshold=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolPortalEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolPortalEnum",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"fcPortList": [[#osn:fcTargetPort|osn:fcTargetPort]]
"haPortList": [[#osn:storagePoolHaFailoverInterface|osn:storagePoolHaFailoverInterface]]
"svPortList": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolPortalEnum?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolPortalEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolPreimportScan ==
''' Request Parameters '''
<code>
{
"method": "storagePoolPreimportScan",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolPreimportScan?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolPreimportScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolProfileEnum ==
''' Request Parameters '''
<code>
{
"method": "storagePoolProfileEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storagePoolProfile|osn:storagePoolProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolProfileEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolProfileGet ==
''' Request Parameters '''
<code>
{
"method": "storagePoolProfileGet",
"params": {
"storagePoolProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storagePoolProfile|osn:storagePoolProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolProfileGet?storagePoolProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolPropertiesUpdate ==
''' Request Parameters '''
<code>
{
"method": "storagePoolPropertiesUpdate",
"params": {
"storagePoolId": xsd:string
"bRequiresReboot": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolPropertiesUpdate?storagePoolId=val0&bRequiresReboot=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolPropertiesUpdate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolRekey ==
''' Request Parameters '''
<code>
{
"method": "storagePoolRekey",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolRekey?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolRekey.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolRescan ==
''' Request Parameters '''
<code>
{
"method": "storagePoolRescan",
"params": {
"storageSystem": xsd:string
"options": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolRescan?storageSystem=val0&options=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolScrubStart ==
''' Request Parameters '''
<code>
{
"method": "storagePoolScrubStart",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolScrubStart?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolScrubStart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolScrubStop ==
''' Request Parameters '''
<code>
{
"method": "storagePoolScrubStop",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolScrubStop?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolScrubStop.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolSearch ==
''' Request Parameters '''
<code>
{
"method": "storagePoolSearch",
"params": {
"searchParams": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolSearch?searchParams=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolSetPassphrase ==
''' Request Parameters '''
<code>
{
"method": "storagePoolSetPassphrase",
"params": {
"storagePool": xsd:string
"oldEncryptionKeyPassphrase": xsd:string
"newEncryptionKeyPassphrase": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolSetPassphrase?storagePool=val0&oldEncryptionKeyPassphrase=val1&newEncryptionKeyPassphrase=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolSetPassphrase.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolSpareAddRemove ==
Adds a dedicated hot-spare to the specified Storage Pool. In general it is better to mark spares are global hot-spares so that any pool in the cluster may use the spare.

''' Request Parameters '''
<code>
{
"method": "storagePoolSpareAddRemove",
"params": {
"storagePool": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"physicalDiskList": xsd:string
"flags": xsd:unsignedInt {{Note|see API [[#physicalDiskEnum]] for information on supported disk selection filters|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolSpareAddRemove?storagePool=val0&modType=0&physicalDiskList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolSpareAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolStart ==
''' Request Parameters '''
<code>
{
"method": "storagePoolStart",
"params": {
"storagePool": xsd:string
"encryptionKeyPassphrase": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolStart?storagePool=val0&encryptionKeyPassphrase=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolStart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolStop ==
''' Request Parameters '''
<code>
{
"method": "storagePoolStop",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolStop?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolStop.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolTrim ==
''' Request Parameters '''
<code>
{
"method": "storagePoolTrim",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolTrim?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolTrim.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storagePoolUpdateRedirect ==
''' Request Parameters '''
<code>
{
"method": "storagePoolUpdateRedirect",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storagePoolUpdateRedirect?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storagePoolUpdateRedirect.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaCreate ==
Storage Quotas are provisioning quotas associated with a Resource Group (see [[#osn:resourceGroup]]) for multi-tenant configurations. For quotas on [[#osn:networkShare]]s please see the [[#networkShareModify]] API.

''' Request Parameters '''
<code>
{
"method": "storageQuotaCreate",
"params": {
"name": xsd:string
"description": xsd:string
"storagePoolId": xsd:string
"resourceGroupId": xsd:string
"provisionableSize": xsd:unsignedLong
"utilizableSpace": xsd:unsignedLong
"maxVolumes": xsd:unsignedInt
"maxShares": xsd:unsignedInt
"policyFlags": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaCreate?name=val0&description=val1&storagePoolId=val2&resourceGroupId=val3&provisionableSize=val4&utilizableSpace=val5&maxVolumes=0&maxShares=0&policyFlags=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaDelete ==
Deletes teh specified provisioning quota

''' Request Parameters '''
<code>
{
"method": "storageQuotaDelete",
"params": {
"storageQuota": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaDelete?storageQuota=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaEnum ==
''' Request Parameters '''
<code>
{
"method": "storageQuotaEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaGet ==
''' Request Parameters '''
<code>
{
"method": "storageQuotaGet",
"params": {
"storageQuota": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaGet?storageQuota=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaModify ==
Modifies the specified provisioning quota to limit how much capacity may be provisioned from the pool associated with the quota

''' Request Parameters '''
<code>
{
"method": "storageQuotaModify",
"params": {
"storageQuota": xsd:string
"name": xsd:string
"description": xsd:string
"resourceGroupId": xsd:string
"provisionableSize": xsd:unsignedLong
"utilizableSpace": xsd:unsignedLong
"maxVolumes": xsd:unsignedInt
"maxShares": xsd:unsignedInt
"policyFlags": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaModify?storageQuota=val0&name=val1&description=val2&resourceGroupId=val3&provisionableSize=val4&utilizableSpace=val5&maxVolumes=0&maxShares=0&policyFlags=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaShareAddRemove ==
Add/remove shares from the quota so that they're counted against the provisionable capacity

''' Request Parameters '''
<code>
{
"method": "storageQuotaShareAddRemove",
"params": {
"storageQuota": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"storageShareList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaShareAddRemove?storageQuota=val0&modType=0&storageShareList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaShareAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaShareAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "storageQuotaShareAssocEnum",
"params": {
"networkShare": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageQuotaShareAssoc|osn:storageQuotaShareAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaShareAssocEnum?networkShare=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaShareAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaShareAssocGet ==
''' Request Parameters '''
<code>
{
"method": "storageQuotaShareAssocGet",
"params": {
"storageQuotaId": xsd:string
"shareId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageQuotaShareAssoc|osn:storageQuotaShareAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaShareAssocGet?storageQuotaId=val0&shareId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaShareAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaVolumeAddRemove ==
Add/remove volumes from the quota so that they're counted against the provisionable capacity

''' Request Parameters '''
<code>
{
"method": "storageQuotaVolumeAddRemove",
"params": {
"storageQuota": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"storageVolumeList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageQuota|osn:storageQuota]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaVolumeAddRemove?storageQuota=val0&modType=0&storageVolumeList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaVolumeAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "storageQuotaVolumeAssocEnum",
"params": {
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageQuotaVolumeAssoc|osn:storageQuotaVolumeAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaVolumeAssocEnum?storageVolume=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaVolumeAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageQuotaVolumeAssocGet ==
''' Request Parameters '''
<code>
{
"method": "storageQuotaVolumeAssocGet",
"params": {
"storageQuotaId": xsd:string
"storageVolumeId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageQuotaVolumeAssoc|osn:storageQuotaVolumeAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageQuotaVolumeAssocGet?storageQuotaId=val0&storageVolumeId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @storageQuotaVolumeAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemBeep ==
Beeps in a 'Close Encounters'-like pattern to help identify the server [[#osn:storageSystem]]

''' Request Parameters '''
<code>
{
"method": "storageSystemBeep",
"params": {
"storageSystem": xsd:string
"duration": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemBeep?storageSystem=val0&duration=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemBeep.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterAssocEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystemClusterAssoc|osn:storageSystemClusterAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterAssocEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterAssocGet ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterAssocGet",
"params": {
"storageSystemClusterId": xsd:string
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageSystemClusterAssoc|osn:storageSystemClusterAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterAssocGet?storageSystemClusterId=val0&storageSystemId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterCreate ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterCreate",
"params": {
"name": xsd:string
"description": xsd:string
"storageSystemIds": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterCreate?name=val0&description=val1&storageSystemIds=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterDelete ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterDelete",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterDelete?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterEnum ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterGet ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterGet",
"params": {
"storageSystemCluster": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterGet?storageSystemCluster=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterMerge ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterMerge",
"params": {
"masterNodeIpAddress": xsd:string
"nodeAdminUsername": xsd:string
"nodeAdminPassword": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterMerge?masterNodeIpAddress=val0&nodeAdminUsername=val1&nodeAdminPassword=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterMerge.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterModify ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterModify",
"params": {
"name": xsd:string
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterModify?name=val0&description=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterNodeAdd ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterNodeAdd",
"params": {
"nodeIpAddress": xsd:string
"nodeAdminUsername": xsd:string
"nodeAdminPassword": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterNodeAdd?nodeIpAddress=val0&nodeAdminUsername=val1&nodeAdminPassword=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterNodeAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterNodeEject ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterNodeEject",
"params": {
"storageSystemClusterObj": [[#osn:storageSystemCluster|osn:storageSystemCluster]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

== storageSystemClusterNodeJoin ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterNodeJoin",
"params": {
"storageSystemClusterObj": [[#osn:storageSystemCluster|osn:storageSystemCluster]] "masterNode": [[#osn:storageSystem|osn:storageSystem]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

== storageSystemClusterNodeRemove ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterNodeRemove",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterNodeRemove?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterNodeRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterNodeSetMaster ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterNodeSetMaster",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterNodeSetMaster?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterNodeSetMaster.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterNodeSync ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterNodeSync",
"params": {
"storageSystemClusterObj": [[#osn:storageSystemCluster|osn:storageSystemCluster]] "masterNode": [[#osn:storageSystem|osn:storageSystem]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

== storageSystemClusterSendSupportLogs ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterSendSupportLogs",
"params": {
"memberIds": xsd:string
"disableLogScrub": xsd:boolean
"disableLogUpload": xsd:boolean
"disableLogTruncation": xsd:boolean
"supportTicketId": xsd:string
"supportReplyToEmail": xsd:string
"supportMessage": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterSendSupportLogs?memberIds=val0&disableLogScrub=val1&disableLogUpload=val2&disableLogTruncation=val3&supportTicketId=val4&supportReplyToEmail=val5&supportMessage=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterSendSupportLogs.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemClusterSplit ==
''' Request Parameters '''
<code>
{
"method": "storageSystemClusterSplit",
"params": {
"newGridName": xsd:string
"storageSystemIds": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemCluster|osn:storageSystemCluster]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemClusterSplit?newGridName=val0&storageSystemIds=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemClusterSplit.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemEnum ==
Returns a list of all the storage systems in the grid.

''' Request Parameters '''
<code>
{
"method": "storageSystemEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemGet ==
Returns details of a specific [[#osn:storageSystem]]

''' Request Parameters '''
<code>
{
"method": "storageSystemGet",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemGet?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkCreate ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkCreate",
"params": {
"storageSystemId": xsd:string
"remoteSystemId": xsd:string
"localIpAddress": xsd:string
"remoteIpAddress": xsd:string
"bandwidthLimit": xsd:unsignedInt
"linkType": xsd:unsignedInt
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkCreate?storageSystemId=val0&remoteSystemId=val1&localIpAddress=val2&remoteIpAddress=val3&bandwidthLimit=0&linkType=0&description=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkDelete ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkDelete",
"params": {
"linkId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkDelete?linkId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkDisconnect ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkDisconnect",
"params": {
"remoteStorageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkDisconnect?remoteStorageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkDisconnect.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkEnum ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkEstablish ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkEstablish",
"params": {
"linkObj": [[#osn:storageSystemLink|osn:storageSystemLink]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

== storageSystemLinkGet ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkGet",
"params": {
"linkId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkGet?linkId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkModify ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkModify",
"params": {
"linkId": xsd:string
"remoteIpAddress": xsd:string
"localIpAddress": xsd:string
"bandwidthLimit": xsd:unsignedInt
"linkType": xsd:unsignedInt
"description": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkModify?linkId=val0&remoteIpAddress=val1&localIpAddress=val2&bandwidthLimit=0&linkType=0&description=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkRefresh ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkRefresh",
"params": {
"linkId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkRefresh?linkId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkRefresh.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkSetCredentials ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkSetCredentials",
"params": {
"linkId": xsd:string
"remoteAdminUser": xsd:string
"remoteAdminPassword": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemLinkSetCredentials?linkId=val0&remoteAdminUser=val1&remoteAdminPassword=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemLinkSetCredentials.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemLinkVerify ==
''' Request Parameters '''
<code>
{
"method": "storageSystemLinkVerify",
"params": {
"linkObj": [[#osn:storageSystemLink|osn:storageSystemLink]] "flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemLink|osn:storageSystemLink]]
}
</code>

== storageSystemMaintenance ==
Puts specific services into maintenance mode

''' Request Parameters '''
<code>
{
"method": "storageSystemMaintenance",
"params": {
"storageSystemList": xsd:string
"maintenanceFlags": xsd:unsignedInt {{Note|see [[#enum:enterMaintenanceModeMask]] and [[#enum:exitMaintenanceModeMask]]|inline=1}}
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
"list": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemMaintenance?storageSystemList=val0&maintenanceFlags=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemMaintenance.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemModify ==
Modifies the network and other configuration settings of the storage system.

''' Request Parameters '''
<code>
{
"method": "storageSystemModify",
"params": {
"storageSystem": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"newLocation": xsd:string
"newEnclosureLayoutId": xsd:string
"domainSuffix": xsd:string
"searchSuffix": xsd:string
"arpFilterMode": xsd:unsignedInt
"bondMode": xsd:unsignedInt
"newDnsServerList": xsd:string
"externalHostName": xsd:string
"gridPreferredPort": xsd:string
"newNTPServerList": xsd:string
"multipathConfigMode": xsd:unsignedInt
"hwAutoMaintenanceMode": xsd:unsignedInt
"logCollectionMode": xsd:unsignedInt
"ethPortNaming": xsd:unsignedInt {{Note|see [[#enum:ethPortNaming]]|inline=1}}
"firewallMask": xsd:unsignedInt
"disableIoFencing": xsd:boolean
"wwnEmulationMode": xsd:unsignedInt {{Note|0=none, 1=OSNexus QuantaStor (IEEE CID), 2=PURE FlashArray, 3=IBM 2145 (Storwize)|inline=1}}
"proxyUrlHttp": xsd:string
"proxyUrlHttps": xsd:string
"proxyUrlNoProxy": xsd:string
"serviceOptionsMask": xsd:unsignedInt
"enableTelemetry": xsd:boolean
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemModify?storageSystem=val0&newName=val1&newDescription=val2&newLocation=val3&newEnclosureLayoutId=val4&domainSuffix=val5&searchSuffix=val6&arpFilterMode=0&bondMode=0&newDnsServerList=val9&externalHostName=val10&gridPreferredPort=val11&newNTPServerList=val12&multipathConfigMode=0&hwAutoMaintenanceMode=0&logCollectionMode=0&ethPortNaming=0&firewallMask=0&disableIoFencing=val18&wwnEmulationMode=0&proxyUrlHttp=val20&proxyUrlHttps=val21&proxyUrlNoProxy=val22&serviceOptionsMask=0&enableTelemetry=val24&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemNetworkCheck ==
''' Request Parameters '''
<code>
{
"method": "storageSystemNetworkCheck",
"params": {
"storageSystem": xsd:string
"verifyClientIps": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:pingData|osn:pingData]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemNetworkCheck?storageSystem=val0&verifyClientIps=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemNetworkCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemRecover ==
''' Request Parameters '''
<code>
{
"method": "storageSystemRecover",
"params": {
"storageSystem": xsd:string
"recoveryPoint": xsd:string
"recoverNetworkConfig": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemRecoveryPoint|osn:storageSystemRecoveryPoint]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemRecover?storageSystem=val0&recoveryPoint=val1&recoverNetworkConfig=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemRecover.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemRecoveryPointEnum ==
returns a list of all the internal database recovery points available for the specified [[osn:storageSystem]].

''' Request Parameters '''
<code>
{
"method": "storageSystemRecoveryPointEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystemRecoveryPoint|osn:storageSystemRecoveryPoint]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemRecoveryPointEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemRecoveryPointEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemRestart ==
Requests a restart of the specified list of systems.

''' Request Parameters '''
<code>
{
"method": "storageSystemRestart",
"params": {
"storageSystemIdList": xsd:string
"reason": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
"list": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemRestart?storageSystemIdList=val0&reason=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemSendLogs ==
Sends support logs for the specified system.

''' Request Parameters '''
<code>
{
"method": "storageSystemSendLogs",
"params": {
"storageSystemId": xsd:string
"disableLogScrub": xsd:boolean
"disableLogUpload": xsd:boolean
"disableLogTruncation": xsd:boolean
"supportTicketId": xsd:string
"supportReplyToEmail": xsd:string
"supportMessage": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemSendLogs?storageSystemId=val0&disableLogScrub=val1&disableLogUpload=val2&disableLogTruncation=val3&supportTicketId=val4&supportReplyToEmail=val5&supportMessage=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemSendLogs.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemServicesRestart ==
''' Request Parameters '''
<code>
{
"method": "storageSystemServicesRestart",
"params": {
"storageSystem": xsd:string
"servicesList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemServicesRestart?storageSystem=val0&servicesList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemServicesRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemShutdown ==
Requests a shutdown of the specified list of systems.

''' Request Parameters '''
<code>
{
"method": "storageSystemShutdown",
"params": {
"storageSystemIdList": xsd:string
"reason": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
"list": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemShutdown?storageSystemIdList=val0&reason=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemShutdown.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemSignalManager ==
''' Request Parameters '''
<code>
{
"method": "storageSystemSignalManager",
"params": {
"storageSystem": xsd:string
"managerClass": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemSignalManager?storageSystem=val0&managerClass=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemSignalManager.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTimeZoneEnum ==
Returns information about the available time zones.

''' Request Parameters '''
<code>
{
"method": "storageSystemTimeZoneEnum",
"params": {
"searchFilter": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:timeZone|osn:timeZone]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTimeZoneEnum?searchFilter=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTimeZoneEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTimeZoneSet ==
Sets the time zone for a specific system.

''' Request Parameters '''
<code>
{
"method": "storageSystemTimeZoneSet",
"params": {
"storageSystem": xsd:string
"timeZone": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTimeZoneSet?storageSystem=val0&timeZone=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTimeZoneSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableEnum ==
Returns a list of all the storage system tunables (includes ZFS adjustable paramters)

''' Request Parameters '''
<code>
{
"method": "storageSystemTunableEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystemTunable|osn:storageSystemTunable]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableGet ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableGet",
"params": {
"storageSystem": xsd:string
"tunableId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageSystemTunable|osn:storageSystemTunable]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableGet?storageSystem=val0&tunableId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableProfileApply ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableProfileApply",
"params": {
"storageSystem": xsd:string
"tunableProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemTunableProfile|osn:storageSystemTunableProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileApply?storageSystem=val0&tunableProfile=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableProfileApply.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableProfileCreate ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableProfileCreate",
"params": {
"name": xsd:string
"description": xsd:string
"tunableList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemTunableProfile|osn:storageSystemTunableProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileCreate?name=val0&description=val1&tunableList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableProfileCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableProfileDelete ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableProfileDelete",
"params": {
"tunableProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemTunableProfile|osn:storageSystemTunableProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileDelete?tunableProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableProfileDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableProfileEnum ==
Returns a list of storage system tunable profiles. These enables setting all the tunable parameters as a set for a given use case.

''' Request Parameters '''
<code>
{
"method": "storageSystemTunableProfileEnum",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageSystemTunableProfile|osn:storageSystemTunableProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableProfileGet ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableProfileGet",
"params": {
"tunableProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageSystemTunableProfile|osn:storageSystemTunableProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileGet?tunableProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableProfileModify ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableProfileModify",
"params": {
"tunableProfile": xsd:string
"name": xsd:string
"description": xsd:string
"tunableList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystemTunableProfile|osn:storageSystemTunableProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableProfileModify?tunableProfile=val0&name=val1&description=val2&tunableList=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableProfileModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemTunableSet ==
''' Request Parameters '''
<code>
{
"method": "storageSystemTunableSet",
"params": {
"storageSystem": xsd:string
"tunableList": xsd:string
"option": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storageSystemTunable|osn:storageSystemTunable]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemTunableSet?storageSystem=val0&tunableList=val1&option=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemTunableSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemUpdateCheck ==
Does an update check on the specified system to see if there are newer packages to upgrade to.

''' Request Parameters '''
<code>
{
"method": "storageSystemUpdateCheck",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"qstorManagerVersionCurrent": xsd:string
"qstorManagerVersionAvailable": xsd:string
"qstorServiceVersionCurrent": xsd:string
"qstorServiceVersionAvailable": xsd:string
"qstorTargetVersionCurrent": xsd:string
"qstorTargetVersionAvailable": xsd:string
"qstorWebServerVersionCurrent": xsd:string
"qstorWebServerVersionAvailable": xsd:string
"qstorRestVersionCurrent": xsd:string
"qstorRestVersionAvailable": xsd:string
"kernelVersionCurrent": xsd:string
"kernelVersionAvailable": xsd:string
"distroVersionAvailable": xsd:string
"cephVersionCurrent": xsd:string
"cephVersionAvailable": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemUpdateCheck?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemUpdateCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemUpgrade ==
Starts the upgrade process on the specified list of storage systems.

''' Request Parameters '''
<code>
{
"method": "storageSystemUpgrade",
"params": {
"storageSystemIdList": xsd:string
"includeKernel": xsd:boolean
"distroUpgrade": xsd:boolean
"allowReboot": xsd:boolean
"coreOnly": xsd:boolean
"cephUpgrade": xsd:boolean
"workerTask": xsd:boolean
"timeoutPaddingSec": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageSystem|osn:storageSystem]]
"list": [[#osn:storageSystem|osn:storageSystem]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemUpgrade?storageSystemIdList=val0&includeKernel=val1&distroUpgrade=val2&allowReboot=val3&coreOnly=val4&cephUpgrade=val5&workerTask=val6&timeoutPaddingSec=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemUpgrade.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageSystemVersion ==
Provides system name, id, and version without authentication. This API provides a discovery mechanism that can be used by various service discovery methods.

''' Request Parameters '''
<code>
{
"method": "storageSystemVersion",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"storageSystemName": xsd:string
"storageSystemId": xsd:string
"storageSystemVersion": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageSystemVersion?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageSystemVersion.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "storageTierAssocEnum",
"params": {
"storagePool": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageTierAssoc|osn:storageTierAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierAssocEnum?storagePool=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierAssocGet ==
''' Request Parameters '''
<code>
{
"method": "storageTierAssocGet",
"params": {
"storageTierId": xsd:string
"storagePoolId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageTierAssoc|osn:storageTierAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierAssocGet?storageTierId=val0&storagePoolId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierCreate ==
Creates a new storage provisioning tier which is essentially a group of pools with similar characteristics. Storage Tiers my be used in place of specific Storage Pool IDs when calling APIs requiring a provisionable UUID such as [[storageVolumeCreate]] and [[networkShareCreate]]. The system will intelligently select a pool within a specified tier based on the available resources when a tier is specified.

''' Request Parameters '''
<code>
{
"method": "storageTierCreate",
"params": {
"name": xsd:string
"description": xsd:string
"storageClass": xsd:string
"storageType": xsd:unsignedInt
"performanceLevel": xsd:unsignedInt
"poolList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageTier|osn:storageTier]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierCreate?name=val0&description=val1&storageClass=val2&storageType=0&performanceLevel=0&poolList=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierDelete ==
''' Request Parameters '''
<code>
{
"method": "storageTierDelete",
"params": {
"storageTier": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageTier|osn:storageTier]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierDelete?storageTier=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierEnum ==
''' Request Parameters '''
<code>
{
"method": "storageTierEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageTier|osn:storageTier]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierGet ==
''' Request Parameters '''
<code>
{
"method": "storageTierGet",
"params": {
"storageTier": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageTier|osn:storageTier]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierGet?storageTier=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierModify ==
''' Request Parameters '''
<code>
{
"method": "storageTierModify",
"params": {
"storageTier": xsd:string
"newName": xsd:string
"description": xsd:string
"storageClass": xsd:string
"storageType": xsd:unsignedInt
"performanceLevel": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageTier|osn:storageTier]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierModify?storageTier=val0&newName=val1&description=val2&storageClass=val3&storageType=0&performanceLevel=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageTierPoolAddRemove ==
''' Request Parameters '''
<code>
{
"method": "storageTierPoolAddRemove",
"params": {
"storageTier": xsd:string
"modType": xsd:unsignedInt
"poolList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageTier|osn:storageTier]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageTierPoolAddRemove?storageTier=val0&modType=0&poolList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageTierPoolAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeAclAddRemove ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeAclAddRemove",
"params": {
"storageVolume": xsd:string
"modType": xsd:unsignedInt
"hostList": xsd:string
"lun": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclAddRemove?storageVolume=val0&modType=0&hostList=val2&lun=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeAclAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeAclAddRemoveEx ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeAclAddRemoveEx",
"params": {
"host": xsd:string
"modType": xsd:unsignedInt
"storageVolumeList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclAddRemoveEx?host=val0&modType=0&storageVolumeList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeAclAddRemoveEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeAclEnum ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeAclEnum",
"params": {
"host": xsd:string
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclEnum?host=val0&storageVolume=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeAclEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeAclGet ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeAclGet",
"params": {
"host": xsd:string
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeAclGet?host=val0&storageVolume=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeAclGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeClone ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeClone",
"params": {
"storageVolume": xsd:string
"cloneName": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"accessMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeClone?storageVolume=val0&cloneName=val1&description=val2&provisionableId=val3&accessMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeCreate ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeCreate",
"params": {
"name": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"size": xsd:unsignedLong
"thinProvisioned": xsd:boolean
"accessMode": xsd:unsignedInt
"chapPolicy": xsd:unsignedInt
"chapUsername": xsd:string
"chapPassword": xsd:string
"count": xsd:unsignedInt
"qosPolicy": xsd:string
"profile": xsd:string
"disableMapping": xsd:boolean
"lun": xsd:unsignedInt
"namespaceName": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
"list": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCreate?name=val0&description=val1&provisionableId=val2&size=val3&thinProvisioned=val4&accessMode=0&chapPolicy=0&chapUsername=val7&chapPassword=val8&count=0&qosPolicy=val10&profile=val11&disableMapping=val12&lun=0&namespaceName=val14&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeCreateEx ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeCreateEx",
"params": {
"name": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"size": xsd:unsignedLong
"percentReserved": xsd:unsignedInt
"accessMode": xsd:unsignedInt
"chapPolicy": xsd:unsignedInt
"chapUsername": xsd:string
"chapPassword": xsd:string
"count": xsd:unsignedInt
"blockSizeKb": xsd:unsignedInt
"stripeSizeKb": xsd:unsignedInt
"stripeCount": xsd:unsignedInt
"syncPolicy": xsd:unsignedInt
"cachePolicyPrimary": xsd:unsignedInt
"cachePolicySecondary": xsd:unsignedInt
"compressionType": xsd:string
"copies": xsd:unsignedInt
"qosPolicy": xsd:string
"profile": xsd:string
"spaceReserved": xsd:unsignedLong
"disableMapping": xsd:boolean
"lun": xsd:unsignedInt
"namespaceName": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
"list": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCreateEx?name=val0&description=val1&provisionableId=val2&size=val3&percentReserved=0&accessMode=0&chapPolicy=0&chapUsername=val7&chapPassword=val8&count=0&blockSizeKb=0&stripeSizeKb=0&stripeCount=0&syncPolicy=0&cachePolicyPrimary=0&cachePolicySecondary=0&compressionType=val16&copies=0&qosPolicy=val18&profile=val19&spaceReserved=val20&disableMapping=val21&lun=0&namespaceName=val23&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeCreateEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeCreatePassthru ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeCreatePassthru",
"params": {
"name": xsd:string
"description": xsd:string
"physicalDiskList": xsd:string
"accessMode": xsd:unsignedInt
"chapPolicy": xsd:unsignedInt
"chapUsername": xsd:string
"chapPassword": xsd:string
"blockSizeKb": xsd:unsignedInt
"qosPolicy": xsd:string
"profile": xsd:string
"passthruMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
"list": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeCreatePassthru?name=val0&description=val1&physicalDiskList=val2&accessMode=0&chapPolicy=0&chapUsername=val5&chapPassword=val6&blockSizeKb=0&qosPolicy=val8&profile=val9&passthruMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeCreatePassthru.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeDelete ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeDelete",
"params": {
"storageVolumeList": xsd:string
"searchParams": xsd:string
"deleteOptions": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeDelete?storageVolumeList=val0&searchParams=val1&deleteOptions=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeDeleteEx ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeDeleteEx",
"params": {
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeDeleteEx?storageVolume=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeDeleteEx.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeEnum ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeEnum",
"params": {
"storageVolumeList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeEnum?storageVolumeList=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGet ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGet",
"params": {
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGet?storageVolume=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupAssocEnum",
"params": {
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolumeGroupAssoc|osn:storageVolumeGroupAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupAssocEnum?storageVolume=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupAssocGet ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupAssocGet",
"params": {
"storageVolumeGroupId": xsd:string
"storageVolumeId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageVolumeGroupAssoc|osn:storageVolumeGroupAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupAssocGet?storageVolumeGroupId=val0&storageVolumeId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupClone ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupClone",
"params": {
"storageVolumeGroup": xsd:string
"cloneNamePrefix": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"accessMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupClone?storageVolumeGroup=val0&cloneNamePrefix=val1&description=val2&provisionableId=val3&accessMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupCreate",
"params": {
"name": xsd:string
"description": xsd:string
"storageVolumeList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupCreate?name=val0&description=val1&storageVolumeList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupDelete",
"params": {
"storageVolumeGroup": xsd:string
"deleteAssociatedVolumes": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupDelete?storageVolumeGroup=val0&deleteAssociatedVolumes=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupGet ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupGet",
"params": {
"storageVolumeGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupGet?storageVolumeGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupModify ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupModify",
"params": {
"storageVolumeGroup": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupModify?storageVolumeGroup=val0&newName=val1&newDescription=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupSnapshot ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupSnapshot",
"params": {
"storageVolumeGroup": xsd:string
"snapshotNamePrefix": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"count": xsd:unsignedInt
"accessMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupSnapshot?storageVolumeGroup=val0&snapshotNamePrefix=val1&description=val2&provisionableId=val3&count=0&accessMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupSnapshot.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeGroupVolumeAddRemove ==
see [[#enum:modifyType]] where 0=add, 1=remove, 2=set

''' Request Parameters '''
<code>
{
"method": "storageVolumeGroupVolumeAddRemove",
"params": {
"storageVolumeGroup": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"storageVolumeList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolumeGroup|osn:storageVolumeGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeGroupVolumeAddRemove?storageVolumeGroup=val0&modType=0&storageVolumeList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeGroupVolumeAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeHealthCheck ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeHealthCheck",
"params": {
"storageVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:resourceHealthCheck|osn:resourceHealthCheck]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeHealthCheck?storageVolume=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeHealthCheck.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeHoldAdd ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeHoldAdd",
"params": {
"storageVolume": xsd:string
"holdTag": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeHoldAdd?storageVolume=val0&holdTag=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeHoldAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeHoldRemove ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeHoldRemove",
"params": {
"storageVolume": xsd:string
"holdTag": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeHoldRemove?storageVolume=val0&holdTag=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeHoldRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeImport ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeImport",
"params": {
"storagePool": xsd:string
"importTypes": xsd:unsignedInt
"cleanupSnapshots": xsd:boolean
"replicationScheduleId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storagePool|osn:storagePool]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeImport?storagePool=val0&importTypes=0&cleanupSnapshots=val2&replicationScheduleId=val3&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeImport.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeModify ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeModify",
"params": {
"storageVolume": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"newAccessMode": xsd:unsignedInt
"chapPolicy": xsd:unsignedInt
"chapUsername": xsd:string
"chapPassword": xsd:string
"clearSnapshotFlag": xsd:boolean
"enableCaching": xsd:boolean
"isActiveCheckpoint": xsd:boolean
"syncPolicy": xsd:unsignedInt
"cachePolicyPrimary": xsd:unsignedInt
"cachePolicySecondary": xsd:unsignedInt
"compressionType": xsd:string
"copies": xsd:unsignedInt
"qosPolicy": xsd:string
"profile": xsd:string
"spaceReserved": xsd:unsignedLong
"lun": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeModify?storageVolume=val0&newName=val1&newDescription=val2&newAccessMode=0&chapPolicy=0&chapUsername=val5&chapPassword=val6&clearSnapshotFlag=val7&enableCaching=val8&isActiveCheckpoint=val9&syncPolicy=0&cachePolicyPrimary=0&cachePolicySecondary=0&compressionType=val13&copies=0&qosPolicy=val15&profile=val16&spaceReserved=val17&lun=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeProfileEnum ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeProfileEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolumeProfile|osn:storageVolumeProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeProfileEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeProfileEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeProfileGet ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeProfileGet",
"params": {
"storageVolumeProfile": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageVolumeProfile|osn:storageVolumeProfile]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeProfileGet?storageVolumeProfile=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeProfileGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeReassignSchedule ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeReassignSchedule",
"params": {
"storageVolume": xsd:string
"schedule": xsd:string
"recursiveUpdateGmtSnaps": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeReassignSchedule?storageVolume=val0&schedule=val1&recursiveUpdateGmtSnaps=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeReassignSchedule.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeResize ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeResize",
"params": {
"storageVolume": xsd:string
"provisionableId": xsd:string
"newSizeInBytes": xsd:unsignedLong
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeResize?storageVolume=val0&provisionableId=val1&newSizeInBytes=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeResize.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeRestore ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeRestore",
"params": {
"storageVolume": xsd:string
"snapshotVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeRestore?storageVolume=val0&snapshotVolume=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeRestore.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeRollback ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeRollback",
"params": {
"storageVolume": xsd:string
"snapshotVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeRollback?storageVolume=val0&snapshotVolume=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeRollback.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeRollbackClone ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeRollbackClone",
"params": {
"snapshotVolume": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeRollbackClone?snapshotVolume=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeRollbackClone.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeSearch ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeSearch",
"params": {
"searchParams": xsd:string
"maxResults": xsd:unsignedInt
"offset": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolume|osn:storageVolume]]
"objCount": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSearch?searchParams=val0&maxResults=0&offset=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeSetQosControls ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeSetQosControls",
"params": {
"storageVolume": xsd:string
"qosReadIops": xsd:unsignedLong
"qosWriteIops": xsd:unsignedLong
"qosReadBandwidth": xsd:unsignedLong
"qosWriteBandwidth": xsd:unsignedLong
"qosPolicy": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSetQosControls?storageVolume=val0&qosReadIops=val1&qosWriteIops=val2&qosReadBandwidth=val3&qosWriteBandwidth=val4&qosPolicy=val5&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeSetQosControls.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeSnapshot ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeSnapshot",
"params": {
"storageVolume": xsd:string
"snapshotName": xsd:string
"description": xsd:string
"provisionableId": xsd:string
"accessMode": xsd:unsignedInt
"count": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
"list": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSnapshot?storageVolume=val0&snapshotName=val1&description=val2&provisionableId=val3&accessMode=0&count=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeSnapshot.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeSnapshotRevert ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeSnapshotRevert",
"params": {
"storageVolume": xsd:string
"preserveExistingSnapshot": xsd:boolean
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:storageVolume|osn:storageVolume]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeSnapshotRevert?storageVolume=val0&preserveExistingSnapshot=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeSnapshotRevert.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeUtilizationEnum ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeUtilizationEnum",
"params": {
"storageVolume": xsd:string
"offsetDays": xsd:unsignedInt
"numberOfDays": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:storageVolumeUtilization|osn:storageVolumeUtilization]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationEnum?storageVolume=val0&offsetDays=0&numberOfDays=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeUtilizationEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeUtilizationGet ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeUtilizationGet",
"params": {
"utilizationId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:storageVolumeUtilization|osn:storageVolumeUtilization]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationGet?utilizationId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeUtilizationGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeUtilizationGetRetentionPeriod ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeUtilizationGetRetentionPeriod",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"days": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationGetRetentionPeriod?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeUtilizationGetRetentionPeriod.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== storageVolumeUtilizationSetRetentionPeriod ==
''' Request Parameters '''
<code>
{
"method": "storageVolumeUtilizationSetRetentionPeriod",
"params": {
"daysToRetain": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"days": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/storageVolumeUtilizationSetRetentionPeriod?daysToRetain=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @storageVolumeUtilizationSetRetentionPeriod.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerEnum ==
''' Request Parameters '''
<code>
{
"method": "swControllerEnum",
"params": {
"swControllerGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerEnum?swControllerGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerGet ==
''' Request Parameters '''
<code>
{
"method": "swControllerGet",
"params": {
"swController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerGet?swController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "swControllerGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:swControllerGroup|osn:swControllerGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerGroupGet ==
''' Request Parameters '''
<code>
{
"method": "swControllerGroupGet",
"params": {
"swControllerGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:swControllerGroup|osn:swControllerGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerGroupGet?swControllerGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerIscsiConfigAdd ==
''' Request Parameters '''
<code>
{
"method": "swControllerIscsiConfigAdd",
"params": {
"storageSystemList": xsd:string
"storageVolumeList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerIscsiConfigAdd?storageSystemList=val0&storageVolumeList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerIscsiConfigAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerPortalAdd ==
''' Request Parameters '''
<code>
{
"method": "swControllerPortalAdd",
"params": {
"storageSystemList": xsd:string
"name": xsd:string
"description": xsd:string
"portalIpAddress": xsd:string
"portalPortNumber": xsd:unsignedInt
"controllerType": xsd:unsignedInt
"chapUsername": xsd:string
"chapPassword": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerPortalAdd?storageSystemList=val0&name=val1&description=val2&portalIpAddress=val3&portalPortNumber=0&controllerType=0&chapUsername=val6&chapPassword=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerPortalAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerPortalRemove ==
''' Request Parameters '''
<code>
{
"method": "swControllerPortalRemove",
"params": {
"hwController": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerPortalRemove?hwController=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerPortalRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerPortalScan ==
''' Request Parameters '''
<code>
{
"method": "swControllerPortalScan",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:swControllerTarget|osn:swControllerTarget]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerPortalScan?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerPortalScan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerTargetEnum ==
''' Request Parameters '''
<code>
{
"method": "swControllerTargetEnum",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:swControllerTarget|osn:swControllerTarget]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetEnum?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerTargetEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerTargetGet ==
''' Request Parameters '''
<code>
{
"method": "swControllerTargetGet",
"params": {
"swControllerTarget": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:swControllerTarget|osn:swControllerTarget]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetGet?swControllerTarget=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerTargetGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerTargetLogin ==
''' Request Parameters '''
<code>
{
"method": "swControllerTargetLogin",
"params": {
"controllerId": xsd:string
"targetList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetLogin?controllerId=val0&targetList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerTargetLogin.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swControllerTargetLogout ==
''' Request Parameters '''
<code>
{
"method": "swControllerTargetLogout",
"params": {
"controllerId": xsd:string
"targetList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:swController|osn:swController]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swControllerTargetLogout?controllerId=val0&targetList=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swControllerTargetLogout.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swDiskSessionEnum ==
''' Request Parameters '''
<code>
{
"method": "swDiskSessionEnum",
"params": {
"controllerId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:swDiskSession|osn:swDiskSession]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swDiskSessionEnum?controllerId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swDiskSessionEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== swDiskSessionGet ==
''' Request Parameters '''
<code>
{
"method": "swDiskSessionGet",
"params": {
"swDiskSession": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:swDiskSession|osn:swDiskSession]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/swDiskSessionGet?swDiskSession=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @swDiskSessionGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== systemCapabilityMetaDataGet ==
Used by VMware VASA module to gather capabilities information

''' Request Parameters '''
<code>
{
"method": "systemCapabilityMetaDataGet",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:capabilityMetaData|osn:capabilityMetaData]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/systemCapabilityMetaDataGet?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @systemCapabilityMetaDataGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortDisable ==
Disables the specified network port, this is equivalent to an if-down operation

''' Request Parameters '''
<code>
{
"method": "targetPortDisable",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortDisable?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortDisable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortEnable ==
Enabled the specified network port, this is equivalent to an if-up operation

''' Request Parameters '''
<code>
{
"method": "targetPortEnable",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortEnable?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortEnable.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortEnum ==
Returns a list of all the network ports on all the systems in the grid

''' Request Parameters '''
<code>
{
"method": "targetPortEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortGet ==
Returns information about a specific network port

''' Request Parameters '''
<code>
{
"method": "targetPortGet",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortGet?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortHide ==
Enabled the specified network port, this is equivalent to an if-up operation

''' Request Parameters '''
<code>
{
"method": "targetPortHide",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"hide": xsd:boolean
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortHide?port=val0&storageSystem=val1&hide=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortHide.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortModify ==
Modifies the specified target port. Target ports are Network Ports and are typically named ethN, bondN, or a VLAN bondN.M or virtual interface bondN:M

''' Request Parameters '''
<code>
{
"method": "targetPortModify",
"params": {
"port": xsd:string
"configType": xsd:string
"storageSystem": xsd:string
"ipAddress": xsd:string
"netmask": xsd:string
"gateway": xsd:string
"mtu": xsd:unsignedInt
"iscsiEnabled": xsd:boolean
"nvmeofEnabled": xsd:boolean
"losslessNetworkingEnabled": xsd:boolean
"description": xsd:string
"bondMode": xsd:unsignedInt
"firewallMask": xsd:unsignedInt
"firewallForceAllowMask": xsd:unsignedInt
"autoTuningEnabled": xsd:boolean
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortModify?port=val0&configType=val1&storageSystem=val2&ipAddress=val3&netmask=val4&gateway=val5&mtu=0&iscsiEnabled=val7&nvmeofEnabled=val8&losslessNetworkingEnabled=val9&description=val10&bondMode=0&firewallMask=0&firewallForceAllowMask=0&autoTuningEnabled=val14&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortRename ==
Creates a file mapping MAC address to a generic name.

''' Request Parameters '''
<code>
{
"method": "targetPortRename",
"params": {
"port": xsd:string
"name": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortRename?port=val0&name=val1&storageSystem=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortRename.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortRescan ==
Forces an immediate scan of the network ports. This is generally not needed as they're continuously monitored on a 10sec interval.

''' Request Parameters '''
<code>
{
"method": "targetPortRescan",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"list": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortRescan?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortRescan.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortRestart ==
Forces a restart of the specified network port

''' Request Parameters '''
<code>
{
"method": "targetPortRestart",
"params": {
"port": xsd:string
"storageSystemId": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortRestart?port=val0&storageSystemId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortRestart.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortStaticRouteCreate ==
''' Request Parameters '''
<code>
{
"method": "targetPortStaticRouteCreate",
"params": {
"storageSystem": xsd:string
"targetPort": xsd:string
"destinationIpAddress": xsd:string
"destinationNetmask": xsd:string
"gatewayIpAddress": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPortStaticRoute|osn:targetPortStaticRoute]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortStaticRouteCreate?storageSystem=val0&targetPort=val1&destinationIpAddress=val2&destinationNetmask=val3&gatewayIpAddress=val4&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortStaticRouteCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortStaticRouteDelete ==
''' Request Parameters '''
<code>
{
"method": "targetPortStaticRouteDelete",
"params": {
"routeId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPortStaticRoute|osn:targetPortStaticRoute]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortStaticRouteDelete?routeId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortStaticRouteDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortStaticRouteEnum ==
Returns a list of all the static routes on network ports on all the systems in the grid

''' Request Parameters '''
<code>
{
"method": "targetPortStaticRouteEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:targetPortStaticRoute|osn:targetPortStaticRoute]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortStaticRouteEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortStaticRouteEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetPortStaticRouteGet ==
Returns information about a specific network port static route

''' Request Parameters '''
<code>
{
"method": "targetPortStaticRouteGet",
"params": {
"port": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:targetPortStaticRoute|osn:targetPortStaticRoute]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetPortStaticRouteGet?port=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetPortStaticRouteGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetVirtualInterfaceCreate ==
Creates a virtual interface (eg: bond0:1) on the specified parent port (eg: bond0)

''' Request Parameters '''
<code>
{
"method": "targetVirtualInterfaceCreate",
"params": {
"storageSystemId": xsd:string
"parentPortId": xsd:string
"ipAddress": xsd:string
"netmask": xsd:string
"gateway": xsd:string
"macAddress": xsd:string
"mtu": xsd:unsignedInt
"description": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualInterfaceCreate?storageSystemId=val0&parentPortId=val1&ipAddress=val2&netmask=val3&gateway=val4&macAddress=val5&mtu=0&description=val7&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetVirtualInterfaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetVirtualPortCreate ==
Creates a teaming virtual port (eg: bond0) using the specified port list (eth0, eth1, etc)

''' Request Parameters '''
<code>
{
"method": "targetVirtualPortCreate",
"params": {
"storageSystemId": xsd:string
"ipAddress": xsd:string
"netmask": xsd:string
"gateway": xsd:string
"macAddress": xsd:string
"portList": xsd:string
"mtu": xsd:unsignedInt
"description": xsd:string
"bondMode": xsd:unsignedInt
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualPortCreate?storageSystemId=val0&ipAddress=val1&netmask=val2&gateway=val3&macAddress=val4&portList=val5&mtu=0&description=val7&bondMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetVirtualPortCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetVirtualPortDelete ==
''' Request Parameters '''
<code>
{
"method": "targetVirtualPortDelete",
"params": {
"port": xsd:string
"storageSystem": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVirtualPortDelete?port=val0&storageSystem=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetVirtualPortDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== targetVlanInterfaceCreate ==
Creates a VLAN interface on the specified parent port (eg: bond0)

''' Request Parameters '''
<code>
{
"method": "targetVlanInterfaceCreate",
"params": {
"storageSystemId": xsd:string
"parentPortId": xsd:string
"ipAddress": xsd:string
"netmask": xsd:string
"gateway": xsd:string
"vlanId": xsd:unsignedInt
"vlanQos": xsd:unsignedInt
"mtu": xsd:unsignedInt
"description": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:targetPort|osn:targetPort]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/targetVlanInterfaceCreate?storageSystemId=val0&parentPortId=val1&ipAddress=val2&netmask=val3&gateway=val4&vlanId=0&vlanQos=0&mtu=0&description=val8&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @targetVlanInterfaceCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskCancel ==
''' Request Parameters '''
<code>
{
"method": "taskCancel",
"params": {
"id": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskCancel?id=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskCancel.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskClearAll ==
Clears all completed or failed tasks. Running, queued, initializing tasks are skipped.

''' Request Parameters '''
<code>
{
"method": "taskClearAll",
"params": {
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskClearAll?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskClearAll.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskEnum ==
Returns a list of all the tasks. All QuantaStor management operations (API class) are run as async tasks within the storage grid. These Task can be monitored using the [[#taskEnum]] and [[#taskGet]] APIs.

''' Request Parameters '''
<code>
{
"method": "taskEnum",
"params": {
"taskIdlist": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskEnum?taskIdlist=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskGet ==
Returns detailed information about a specific [[#osn:task]]. Use this API to monitor the progress of tasks. All tasks run asynchronously. As the caller of an API you can block the return of your API call until the task completes bay passing flags=0 to any API. Passing flags=1 to any API will return immediately after the task is queued so that progress may be monitored via the [[taskGet]] API. For APIs which create/modify/update an object the customId field of the task object will be populated with the UUID of the created/modified object so that it may be queried after the task completes.

''' Request Parameters '''
<code>
{
"method": "taskGet",
"params": {
"id": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskGet?id=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskLockEnum ==
''' Request Parameters '''
<code>
{
"method": "taskLockEnum",
"params": {
"storageSystemId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:lock|osn:lock]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskLockEnum?storageSystemId=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskLockEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskLockRelease ==
''' Request Parameters '''
<code>
{
"method": "taskLockRelease",
"params": {
"storageSystemId": xsd:string
"taskId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:lock|osn:lock]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskLockRelease?storageSystemId=val0&taskId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskLockRelease.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskProceed ==
''' Request Parameters '''
<code>
{
"method": "taskProceed",
"params": {
"id": xsd:string
"options": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskProceed?id=val0&options=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskProceed.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== taskUpdateProgress ==
''' Request Parameters '''
<code>
{
"method": "taskUpdateProgress",
"params": {
"taskId": xsd:string
"description": xsd:string
"progress": xsd:unsignedInt
"state": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:task|osn:task]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/taskUpdateProgress?taskId=val0&description=val1&progress=0&state=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @taskUpdateProgress.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== traceLevelGet ==
''' Request Parameters '''
<code>
{
"method": "traceLevelGet",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:traceLevel|osn:traceLevel]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/traceLevelGet?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @traceLevelGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== traceLevelModify ==
''' Request Parameters '''
<code>
{
"method": "traceLevelModify",
"params": {
"traceLevel": xsd:unsignedInt
"stdOut": xsd:boolean
"traceFilter": xsd:string
"traceFilterVerbose": xsd:string
"traceOptions": xsd:string
"eventVerboseFilter": xsd:string
"memoryTrackingOption": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:traceLevel|osn:traceLevel]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/traceLevelModify?traceLevel=0&stdOut=val1&traceFilter=val2&traceFilterVerbose=val3&traceOptions=val4&eventVerboseFilter=val5&memoryTrackingOption=val6&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @traceLevelModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== traceLogMessage ==
''' Request Parameters '''
<code>
{
"method": "traceLogMessage",
"params": {
"traceLevel": xsd:unsignedInt
"messages": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:traceLevel|osn:traceLevel]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/traceLogMessage?traceLevel=0&messages=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @traceLogMessage.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userAdd ==
''' Request Parameters '''
<code>
{
"method": "userAdd",
"params": {
"username": xsd:string
"password": xsd:string
"role": xsd:string
"firstName": xsd:string
"lastName": xsd:string
"emailAddress": xsd:string
"description": xsd:string
"defaultChapUsername": xsd:string
"defaultChapPassword": xsd:string
"specifiedAlertSubscriptions": xsd:string
"alertSubscriptions": xsd:unsignedInt
"posixUid": xsd:unsignedInt
"posixGid": xsd:unsignedInt
"allowRootCliTokenAuth": xsd:boolean
"accountType": xsd:unsignedInt
"terminateTimeStamp": xsd:dateTime
"wuiTabDisable": xsd:unsignedInt
"wuiSectionDisable": xsd:unsignedInt
"enableMultiFactorAuth": xsd:boolean
"mfaConfig": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAdd?username=val0&password=val1&role=val2&firstName=val3&lastName=val4&emailAddress=val5&description=val6&defaultChapUsername=val7&defaultChapPassword=val8&specifiedAlertSubscriptions=val9&alertSubscriptions=0&posixUid=0&posixGid=0&allowRootCliTokenAuth=val13&accountType=0&terminateTimeStamp=val15&wuiTabDisable=0&wuiSectionDisable=0&enableMultiFactorAuth=val18&mfaConfig=val19&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userAdd.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userAppTokenCreate ==
''' Request Parameters '''
<code>
{
"method": "userAppTokenCreate",
"params": {
"user": xsd:string
"tokenName": xsd:string
"appKey": xsd:string
"tokenExpires": xsd:dateTime
"isReadOnly": xsd:boolean
"appAccessMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userAppToken|osn:userAppToken]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenCreate?user=val0&tokenName=val1&appKey=val2&tokenExpires=val3&isReadOnly=val4&appAccessMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userAppTokenCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userAppTokenEnum ==
''' Request Parameters '''
<code>
{
"method": "userAppTokenEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:userAppToken|osn:userAppToken]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userAppTokenEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userAppTokenGet ==
''' Request Parameters '''
<code>
{
"method": "userAppTokenGet",
"params": {
"appToken": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:userAppToken|osn:userAppToken]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenGet?appToken=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userAppTokenGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userAppTokenRegen ==
''' Request Parameters '''
<code>
{
"method": "userAppTokenRegen",
"params": {
"appToken": xsd:string
"tokenExpires": xsd:dateTime
"isReadOnly": xsd:boolean
"appAccessMode": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userAppToken|osn:userAppToken]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenRegen?appToken=val0&tokenExpires=val1&isReadOnly=val2&appAccessMode=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userAppTokenRegen.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userAppTokenRemove ==
''' Request Parameters '''
<code>
{
"method": "userAppTokenRemove",
"params": {
"appToken": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userAppToken|osn:userAppToken]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userAppTokenRemove?appToken=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userAppTokenRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userEnum ==
''' Request Parameters '''
<code>
{
"method": "userEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGenerateOtpAuthSecret ==
''' Request Parameters '''
<code>
{
"method": "userGenerateOtpAuthSecret",
"params": {
"user": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"responseSecretToken": xsd:string
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGenerateOtpAuthSecret?user=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGenerateOtpAuthSecret.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGet ==
''' Request Parameters '''
<code>
{
"method": "userGet",
"params": {
"user": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGet?user=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupAssocEnum ==
''' Request Parameters '''
<code>
{
"method": "userGroupAssocEnum",
"params": {
"user": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:userGroupAssoc|osn:userGroupAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupAssocEnum?user=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupAssocGet ==
''' Request Parameters '''
<code>
{
"method": "userGroupAssocGet",
"params": {
"userGroupId": xsd:string
"userId": xsd:string
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:userGroupAssoc|osn:userGroupAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupAssocGet?userGroupId=val0&userId=val1"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupCreate ==
''' Request Parameters '''
<code>
{
"method": "userGroupCreate",
"params": {
"name": xsd:string
"description": xsd:string
"userList": xsd:string
"posixGid": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userGroup|osn:userGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupCreate?name=val0&description=val1&userList=val2&posixGid=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupCreate.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupDelete ==
''' Request Parameters '''
<code>
{
"method": "userGroupDelete",
"params": {
"userGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userGroup|osn:userGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupDelete?userGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupDelete.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupEnum ==
''' Request Parameters '''
<code>
{
"method": "userGroupEnum",
"params": {
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:userGroup|osn:userGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupEnum?flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupGet ==
''' Request Parameters '''
<code>
{
"method": "userGroupGet",
"params": {
"userGroup": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:userGroup|osn:userGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupGet?userGroup=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupModify ==
''' Request Parameters '''
<code>
{
"method": "userGroupModify",
"params": {
"userGroup": xsd:string
"newName": xsd:string
"newDescription": xsd:string
"posixGid": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userGroup|osn:userGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupModify?userGroup=val0&newName=val1&newDescription=val2&posixGid=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupSearch ==
''' Request Parameters '''
<code>
{
"method": "userGroupSearch",
"params": {
"searchParams": xsd:string
"maxResults": xsd:unsignedInt
"offset": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:userGroup|osn:userGroup]]
"objCount": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupSearch?searchParams=val0&maxResults=0&offset=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userGroupUserAddRemove ==
see [[#enum:modifyType]] where 0=add, 1=remove, 2=set

''' Request Parameters '''
<code>
{
"method": "userGroupUserAddRemove",
"params": {
"userGroup": xsd:string
"modType": xsd:unsignedInt {{Note|see [[#enum:modifyType]] where 0=add, 1=remove, 2=set|inline=1}}
"userList": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:userGroup|osn:userGroup]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userGroupUserAddRemove?userGroup=val0&modType=0&userList=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userGroupUserAddRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userModify ==
''' Request Parameters '''
<code>
{
"method": "userModify",
"params": {
"user": xsd:string
"newName": xsd:string
"newRole": xsd:string
"newFirstName": xsd:string
"newLastName": xsd:string
"newEmailAddress": xsd:string
"newDescription": xsd:string
"newDefaultChapUsername": xsd:string
"newDefaultChapPassword": xsd:string
"newOtpSecretKey": xsd:string
"specifiedAlertSubscriptions": xsd:string
"alertSubscriptions": xsd:unsignedInt
"posixUid": xsd:unsignedInt
"posixGid": xsd:unsignedInt
"lockAccount": xsd:boolean
"allowRootCliTokenAuth": xsd:boolean
"wuiTabDisable": xsd:unsignedInt
"wuiSectionDisable": xsd:unsignedInt
"enableMultiFactorAuth": xsd:boolean
"multiFactorAuthConfig": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userModify?user=val0&newName=val1&newRole=val2&newFirstName=val3&newLastName=val4&newEmailAddress=val5&newDescription=val6&newDefaultChapUsername=val7&newDefaultChapPassword=val8&newOtpSecretKey=val9&specifiedAlertSubscriptions=val10&alertSubscriptions=0&posixUid=0&posixGid=0&lockAccount=val14&allowRootCliTokenAuth=val15&wuiTabDisable=0&wuiSectionDisable=0&enableMultiFactorAuth=val18&multiFactorAuthConfig=val19&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userModify.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userPasswordSet ==
''' Request Parameters '''
<code>
{
"method": "userPasswordSet",
"params": {
"user": xsd:string
"oldPassword": xsd:string
"newPassword": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userPasswordSet?user=val0&oldPassword=val1&newPassword=val2&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userPasswordSet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userRemove ==
''' Request Parameters '''
<code>
{
"method": "userRemove",
"params": {
"user": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"task": [[#osn:task|osn:task]]
"obj": [[#osn:user|osn:user]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userRemove?user=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userRemove.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== userSearch ==
''' Request Parameters '''
<code>
{
"method": "userSearch",
"params": {
"searchParams": xsd:string
"maxResults": xsd:unsignedInt
"offset": xsd:unsignedInt
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:user|osn:user]]
"objCount": xsd:unsignedInt
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/userSearch?searchParams=val0&maxResults=0&offset=0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @userSearch.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== virtualInterfaceAssocEnum ==
Returns a list of all the virtual interface associations

''' Request Parameters '''
<code>
{
"method": "virtualInterfaceAssocEnum",
"params": {
"storageSystem": xsd:string
"flags": xsd:unsignedInt {{Note|0=sync/blocking until task finishes, 1=async/return immediately after task has been queued|inline=1}}
}
}
</code>
''' Response Parameters '''
<code>
{
"list": [[#osn:virtualInterfaceAssoc|osn:virtualInterfaceAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/virtualInterfaceAssocEnum?storageSystem=val0&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @virtualInterfaceAssocEnum.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>

== virtualInterfaceAssocGet ==
''' Request Parameters '''
<code>
{
"method": "virtualInterfaceAssocGet",
"params": {
"virtualInterfaceId": xsd:string
"targetPortId": xsd:string
"flags": xsd:unsignedInt
}
}
</code>
''' Response Parameters '''
<code>
{
"obj": [[#osn:virtualInterfaceAssoc|osn:virtualInterfaceAssoc]]
}
</code>

''' Curl Examples '''

<nowiki>curl -k -u admin:password "https://10.10.10.10:8153/qstorapi/virtualInterfaceAssocGet?virtualInterfaceId=val0&targetPortId=val1&flags=0"</nowiki>

<nowiki>curl -k -u admin:password -d @virtualInterfaceAssocGet.json "https://10.10.10.10:8153/qstorapi/jsonrpc"</nowiki>
= Object Type Definitions =

== osn:acl ==
''' Fields '''
<code>
{
"objectId": xsd:string
"objectType": xsd:unsignedInt
"ownerId": xsd:string
"ownerType": xsd:unsignedInt
"accessLevel": xsd:unsignedInt
"reserved": xsd:unsignedInt
}
</code>

== osn:activeDirDomain ==
Represents an Active Directory domain.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"domain": xsd:string
}
</code>

== osn:activeDirUserGroup ==
Represents an Active Directory user or group, this information is gathered from the server when managing [[#osn:networkShareUserAccess]] instances.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"domain": xsd:string
"isGroup": xsd:boolean
}
</code>

== osn:alert ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"objectId": xsd:string
"objectType": xsd:unsignedInt
"severity": xsd:unsignedInt
"timeStamp": xsd:dateTime
"title": xsd:string
"description": xsd:string
"snmpTrapType": xsd:unsignedInt
"storageSystemName": xsd:string
"acknowledgedStamp": xsd:dateTime
}
</code>

== osn:alertConfigEndpoint ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"endpointModule": xsd:string
"endpointUrl": xsd:string
}
</code>

== osn:alertConfigSettings ==
Configuration of the alert settings (call-home) for the Storage System and Storage Grid

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"senderEmailAddress": xsd:string
"smtpServerIpAddress": xsd:string
"smtpServerPort": xsd:unsignedInt
"smtpUsername": xsd:string
"smtpPassword": xsd:string
"smtpAuthType": xsd:unsignedInt
"customerSupportEmailAddress": xsd:string
"poolFreeSpaceWarningThreshold": xsd:unsignedInt
"poolFreeSpaceAlertThreshold": xsd:unsignedInt
"poolFreeSpaceCriticalAlertThreshold": xsd:unsignedInt
"shareQuotaFreeSpaceWarningThreshold": xsd:unsignedInt
"shareQuotaFreeSpaceAlertThreshold": xsd:unsignedInt
"shareQuotaFreeSpaceCriticalThreshold": xsd:unsignedInt
"enableSyslogAlerts": xsd:boolean
"snmpUsername": xsd:string
"snmpPassword": xsd:string
"objectUserQuotaFreeSpaceWarningThreshold": xsd:unsignedInt
"objectUserQuotaFreeSpaceAlertThreshold": xsd:unsignedInt
"objectUserQuotaFreeSpaceCriticalThreshold": xsd:unsignedInt
"handlerList": [[#osn:alertHandler|osn:alertHandler]]
"endpointList": [[#osn:alertConfigEndpoint|osn:alertConfigEndpoint]]
}
</code>

== osn:alertHandler ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"endpointModule": xsd:string
"description": xsd:string
"docLink": xsd:string
}
</code>

== osn:alertType ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"objectType": xsd:unsignedInt
"pauseUntilDate": xsd:dateTime
"snmpTrapType": xsd:unsignedInt
"severity": xsd:unsignedInt
}
</code>

== osn:auditLogEntry ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"auditEntryType": xsd:unsignedInt
"auditEntryIndex": xsd:unsignedInt
"auditEntryMessage": xsd:string
"auditEntryStatus": xsd:string
"auditEntryUserId": xsd:string
"auditEntryClientIpAddress": xsd:string
"auditEntryTimeStamp": xsd:dateTime
"auditEntryMethod": xsd:string
"taskObjList": [[#osn:task|osn:task]]
"alertObj": [[#osn:alert|osn:alert]]
"apiArgs": [[#osn:keyValuePair|osn:keyValuePair]]
}
</code>

== osn:backupJob ==
[[#osn:networkShare]]s can have [[#osn:backupPolicy]] associated with them. Each time the Backup Policy runs a [[#osn:backupJob]] instance is created to show the progress and status of the backup job.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"pid": xsd:unsignedInt {{Note|process ID associated with the Backup Job|inline=1}}
"status": xsd:string {{Note|Current status of the Backup Job|inline=1}}
"progress": xsd:unsignedInt {{Note|Current progress of the Backup Job as a percentage complete|inline=1}}
"jobStage": xsd:unsignedInt {{Note|Current stage that the backup is in|inline=1}}
"filesScanned": xsd:unsignedInt {{Note|Number of files that were scanned on the source in prep for the transfer|inline=1}}
"filesCopied": xsd:unsignedInt {{Note|Number of files that were copied from source to destination|inline=1}}
"filesPurged": xsd:unsignedInt {{Note|Number of files that were removed due to aging out|inline=1}}
"backupPolicyId": xsd:string {{Note|Backup Policy that this Backup Job was launched from|inline=1}}
"networkShareId": xsd:string {{Note|Network Share the Backup Job is associated with|inline=1}}
"startDate": xsd:dateTime {{Note|date the Backup Job started|inline=1}}
"finishDate": xsd:dateTime {{Note|date the Backup Job completed|inline=1}}
"policyMode": xsd:string {{Note|indicates what move the Backup Policy was set to (move/copy and inbound/outbound) at the time the Backup Job was run.|inline=1}}
}
</code>

== osn:backupPolicy ==
Represents a backup policy which can be used to backup or move data to/from any NFS or SMB share on a given network. This enables QuantaStor to directly backup shares on Windows and Linux systems. It also enables one to automatically migrate files to another NAS system or server based on file age.

''' Inherits From '''
[[#osn:schedule|osn:schedule]]

''' Fields '''
<code>
{
"networkShareId": xsd:string
"remoteHostname": xsd:string
"remoteExportPath": xsd:string
"remoteMountType": xsd:unsignedInt
"retentionCriteria": xsd:unsignedInt
"policyType": xsd:unsignedInt
"scanThreads": xsd:unsignedInt
"retentionDays": xsd:unsignedInt
"purgePolicy": xsd:unsignedInt
"createBackupLogs": xsd:boolean
"backupToShareRoot": xsd:boolean
"smbUsername": xsd:string
"smbPassword": xsd:string
"maxSnapshots": xsd:unsignedInt
"minFileAgeDays": xsd:unsignedInt
"maxFileAgeDays": xsd:unsignedInt
"smbPasswordAlg": xsd:unsignedInt
"createLinks": xsd:boolean
"lastTieringTimestamp": xsd:dateTime
"smbSalt": xsd:string
"remoteExportSubPath": xsd:string
"filterRuleInclude": xsd:string
"filterRuleExclude": xsd:string
"minSizeThreshold": xsd:unsignedLong
"maxSizeThreshold": xsd:unsignedLong
"minAutoTierThreshold": xsd:unsignedLong
"autoCopy": xsd:boolean
"forceRemoveTiered": xsd:boolean
"backupJobList": [[#osn:backupJob|osn:backupJob]]
}
</code>

== osn:bucket ==
Ceph Buckets are repositories for S3 objects just the same as AWS buckets. The customId property holds the bucket ID used by Ceph.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"utilizedSpace": xsd:unsignedLong
"owner": xsd:string
"vendorType": xsd:unsignedInt
"objectLockMode": xsd:unsignedInt
"objectLockRetentionDays": xsd:unsignedInt
"enableLifecyclePolicy": xsd:boolean
"lifecyclePolicyDays": xsd:unsignedInt
"enableNetworkShareAccess": xsd:boolean
"tenantId": xsd:string
"integrationOptions": xsd:unsignedInt
"bucketUpdateRequested": xsd:boolean
"objectCount": xsd:unsignedLong
"ownerS3UserId": xsd:string
"bucketQuotaMaxObjectsEnable": xsd:boolean
"bucketQuotaMaxObjects": xsd:unsignedLong
"bucketQuotaMaxSizeEnable": xsd:boolean
"bucketQuotaMaxSize": xsd:unsignedLong
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete|inline=1}}
"versioning": xsd:unsignedInt
}
</code>

== osn:capabilityMetaData ==
Pool capability metadata used to support external integration modules like VMware VASA.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"category": xsd:string
"summary": xsd:string
"valueType": xsd:unsignedInt
"defaultValue": xsd:string
"isImmutable": xsd:boolean
"allowedValues": xsd:string
}
</code>

== osn:cephClientKeyring ==
represents a ceph RBD client [[#osn:storageSystem]]s.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"key": xsd:string
"capsMon": xsd:string
"capsOsd": xsd:string
"capsMgr": xsd:string
"capsMds": xsd:string
"clientKeyType": xsd:unsignedInt
"keyringResourceAssocList": [[#osn:cephClientKeyringResourceAssoc|osn:cephClientKeyringResourceAssoc]]
}
</code>

== osn:cephClientKeyringResourceAssoc ==
''' Fields '''
<code>
{
"cephClientKeyringId": xsd:string
"resourceType": xsd:unsignedInt
"resourceId": xsd:string
}
</code>

== osn:cephCluster ==
A ceph scale-out storage cluster which is comprised of one or more [[#osn:storageSystem]]s.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"description": xsd:string
"status": xsd:string {{Note|usually HEALTH_OK|inline=1}}
"statusSummary": xsd:string {{Note|Summary description of status.|inline=1}}
"clientadminkeyring": xsd:string {{Note|Client Admin keyring.|inline=1}}
"defaultmonitorkeyring": xsd:string {{Note|Default monitor keyring.|inline=1}}
"cephClusterFsid": xsd:string {{Note|Ceph Cluster FSID.|inline=1}}
"cephVersion": xsd:string {{Note|Ceph version.|inline=1}}
"isMaintenanceMode": xsd:boolean {{Note|Set to 'true' if Ceph Cluster in in maintenance mode.|inline=1}}
"osdWeightPolicy": xsd:unsignedInt
"encryptionType": xsd:string {{Note|default: empty, indicates encryption type, none, luks, or SED.|inline=1}}
"encryptedOSD": xsd:boolean {{Note|default: false, indicates if OSD level encryption is enabled.|inline=1}}
"keyServerProfileId": xsd:string
"compressedOSD": xsd:boolean {{Note|default: false, indicates if OSD level compression is ensabled.|inline=1}}
"clientadminkeyringAlg": xsd:unsignedInt {{Note|Client Admin keyring.|inline=1}}
"defaultmonitorkeyringAlg": xsd:unsignedInt {{Note|Default monitor keyring.|inline=1}}
"clusterAuthMode": xsd:unsignedInt {{Note|see osn__cephClusterAuthMode_t. Default is cephx which is the default and encrypts ceph cluster communication|inline=1}}
"osdOutSubtreeLimit": xsd:unsignedInt {{Note|see osn__cephMonOsdSubtreeLimit. Default is host which doesn't kick out OSDs if the whole host is offline but will kick out individual downed OSDs within a host|inline=1}}
"osdDownTimeoutSec": xsd:unsignedInt {{Note|default is 300 seconds, after no response from an OSD for this time amount it is marked as down|inline=1}}
"osdOutTimeoutSec": xsd:unsignedInt {{Note|default is 86400 seconds, after no reponse from a downed OSD for this amount of time it is kicked out|inline=1}}
"nearFillFullPercent": xsd:unsignedInt {{Note|Setup to receive a warning when your cluster is getting near to its full ratio|inline=1}}
"backFillFullPercent": xsd:unsignedInt {{Note|When cluster has reached this capacity it blocks backfills from starting|inline=1}}
"fullPercent": xsd:unsignedInt {{Note|When cluster has reached this capacity it stops clients from writing data|inline=1}}
"rawUtilizedSpace": xsd:unsignedLong
"rawFreeSpace": xsd:unsignedLong
"clustersalt": xsd:string
"userQuotaMaxObjectsEnable": xsd:boolean
"userQuotaMaxObjects": xsd:unsignedLong
"userQuotaMaxSizeEnable": xsd:boolean
"userQuotaMaxSize": xsd:unsignedLong
"bucketQuotaMaxObjectsEnable": xsd:boolean
"bucketQuotaMaxObjects": xsd:unsignedLong
"bucketQuotaMaxSizeEnable": xsd:boolean
"bucketQuotaMaxSize": xsd:unsignedLong
"designatedCoordinatorId": xsd:string
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete|inline=1}}
"memberIdList": xsd:string
"osdIdList": xsd:string
"monitorIdList": xsd:string
"pgSetIdList": xsd:string
"rgwIdList": xsd:string
"mdsIdList": xsd:string
"healthEventIdList": xsd:string
}
</code>

== osn:cephClusterHealthEvent ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"checkType": xsd:string
"severity": xsd:string
"summary": xsd:string
"count": xsd:unsignedInt
"isMuted": xsd:boolean
}
</code>

== osn:cephClusterMember ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"nodeSystemId": xsd:string
"backendInterfaceId": xsd:string
"clientInterfaceId": xsd:string
"cephCfgHash": xsd:string
"cfgModifyTimeStamp": xsd:string
"cephVersion": xsd:string
}
</code>

== osn:cephClusterServiceEvent ==
Represents a ceph crash report

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"crashId": xsd:string
"entity": xsd:string
"isArchived": xsd:boolean
}
</code>

== osn:cephCrushRule ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"ruleId": xsd:unsignedInt
"description": xsd:string
"ruleType": xsd:unsignedInt
"minSize": xsd:unsignedInt
"maxSize": xsd:unsignedInt
"listSteps": xsd:string
"cephClusterId": xsd:string
"failureDomain": xsd:string
}
</code>

== osn:cephFilesystem ==
A scale-out NAS filesystem, each of these has a [[#osn:storagePool]] associated with it.

''' Inherits From '''
[[#osn:cephPoolGroup|osn:cephPoolGroup]]

''' Fields '''
<code>
{
"activeMdsCount": xsd:unsignedInt
"standbyMdsCount": xsd:unsignedInt
}
</code>

== osn:cephJournalDevice ==
Represents a journal device used to accelerate the write performance of Ceph OSDs.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"physicalDiskId": xsd:string
"cephJournalGroupId": xsd:string
"devicePath": xsd:string
"cephOsdId": xsd:string
"cephClusterId": xsd:string
"size": xsd:unsignedLong
"journalMode": xsd:unsignedInt
"altDevicePath": xsd:string
"nodeSystemId": xsd:string
"lvmUuid": xsd:string
}
</code>

== osn:cephJournalGroup ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"primaryDiskId": xsd:string
"secondaryDiskId": xsd:string
"cephClusterId": xsd:string
"groupType": xsd:unsignedInt
"nodeSystemId": xsd:string
"size": xsd:unsignedLong
"freeSpace": xsd:unsignedLong
"primaryDiskScsiId": xsd:string
"secondaryDiskScsiId": xsd:string
"cephJournalDeviceIdList": xsd:string
}
</code>

== osn:cephMds ==
Ceph Metadata Server must be deployed before a Ceph Filesystem may be provisionioned within a given [[#osn:cephCluster]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"description": xsd:string
"status": xsd:string
"gid": xsd:unsignedInt
"ipAddress": xsd:string
"port": xsd:unsignedInt
"rank": xsd:unsignedInt
"nodeSystemId": xsd:string
"cacheLimit": xsd:unsignedLong
}
</code>

== osn:cephMonitor ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"description": xsd:string
"status": xsd:string
"monId": xsd:string
"rank": xsd:unsignedInt
"host": xsd:string
"ipAddress": xsd:string
"kbTotal": xsd:unsignedLong
"kbUsed": xsd:unsignedLong
"kbAvail": xsd:unsignedLong
"availPercent": xsd:unsignedInt
"lastUpdated": xsd:dateTime
"health": xsd:string
"bytesTotal": xsd:unsignedLong
"bytesSST": xsd:unsignedLong
"bytesLog": xsd:unsignedLong
"bytesMisc": xsd:unsignedLong
"insideQuorum": xsd:boolean
"outsideQuorum": xsd:boolean
"nodeSystemId": xsd:string
}
</code>

== osn:cephObjectPoolGroup ==
An S3 object storage zone which one may provision buckets within and give users access to via ceph user access entries.

''' Inherits From '''
[[#osn:cephPoolGroup|osn:cephPoolGroup]]

''' Fields '''
<code>
{
"zone": xsd:string
"zoneGroup": xsd:string
"objectCount": xsd:unsignedLong
"zoneId": xsd:string
"zoneGroupId": xsd:string
}
</code>

== osn:cephObjectStorageClass ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"dataPoolId": xsd:string
"zoneId": xsd:string
}
</code>

== osn:cephObjectStorageClassRule ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"ruleIndex": xsd:unsignedInt
"cephClusterId": xsd:string
"storageClass": xsd:string
"patternMatch": xsd:string
"capacityOperator": xsd:unsignedInt
"capacityThreshold": xsd:unsignedLong
"bucketPatternMatch": xsd:string
"tenantPatternMatch": xsd:string
"isForced": xsd:boolean
"ruleType": xsd:unsignedInt
"overflowThresholdPercentage": xsd:unsignedInt
"overflowProtectsDeviceClass": xsd:string
}
</code>

== osn:cephObjectZone ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"cephZoneId": xsd:string
"zoneGroupId": xsd:string
"endPoints": xsd:string
"isLocalZone": xsd:boolean
"isMaster": xsd:boolean
"storageClassIdList": xsd:string
}
</code>

== osn:cephObjectZoneGroup ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"cephClusterId": xsd:string
"cephZoneGroupId": xsd:string
"isMaster": xsd:boolean
"masterZoneId": xsd:string
"cephRealmId": xsd:string
"realmName": xsd:string
"endPoints": xsd:string
"cephObjectPoolGroupId": xsd:string
"hostnames": xsd:string
"zoneIdList": xsd:string
}
</code>

== osn:cephOsd ==
a Ceph Object Storage Daemon has a one to one relationship with a [[#osn:physicalDisk]]. HDD based OSDs are also associated with a SSD/NVMe journal device to boost write performance.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"description": xsd:string
"osdId": xsd:string
"provisionableId": xsd:string
"journalDeviceId": xsd:string
"walDeviceId": xsd:string
"dbDeviceId": xsd:string
"journalType": xsd:unsignedInt
"status": xsd:string
"mountPath": xsd:string
"devicePath": xsd:string
"cephClusterFsid": xsd:string
"osdFsid": xsd:string
"host": xsd:string
"osdType": xsd:unsignedInt
"size": xsd:unsignedLong
"utilizedSpace": xsd:unsignedLong
"weight": xsd:string
"nodeSystemId": xsd:string
"storagePoolId": xsd:string
"journalPoolId": xsd:string
"journalDeviceSize": xsd:unsignedLong
"physicalDiskScsiId": xsd:string
"diskEnclosure": xsd:string
"diskSlot": xsd:string
"replaceReady": xsd:boolean
"rekeyTimeStamp": xsd:dateTime
"deviceClass": xsd:string
"encryptedOsd": xsd:boolean
"compressedSize": xsd:unsignedLong {{Note|size of the data after compression|inline=1}}
"compressedSizeActual": xsd:unsignedLong {{Note|true compression after accounting for padding|inline=1}}
"compressedSizeOriginal": xsd:unsignedLong {{Note|original size of the data before compression|inline=1}}
"compressionRatio": xsd:string
}
</code>

== osn:cephPgSet ==
A group of placement groups within a given [[#osn:cephCluster]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"pgCount": xsd:unsignedInt
"cephClusterId": xsd:string
}
</code>

== osn:cephPool ==
A scale-out ceph pool. For pools used for block storage provisioning there is an associated [[#osn:storagePool]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"placementGroupCount": xsd:unsignedInt
"maxReplicaCount": xsd:unsignedInt
"minReplicaCount": xsd:unsignedInt
"cephPoolType": xsd:string
"size": xsd:unsignedLong
"utilizedSpace": xsd:unsignedLong
"freeSpace": xsd:unsignedLong
"cephClusterId": xsd:string
"cephObjectPoolGroupId": xsd:string
"cephFileSystemId": xsd:string
"cephCrushRuleId": xsd:string
"cephPoolProfileId": xsd:string
"storageClassId": xsd:string
"objectCount": xsd:unsignedLong
"compressionMode": xsd:string
"compressionAlgorithm": xsd:string
"compressionUsed": xsd:unsignedLong
"compressionOriginal": xsd:unsignedLong
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete or resize|inline=1}}
"cephPoolNamespaceIdList": xsd:string
}
</code>

== osn:cephPoolGroup ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"description": xsd:string
"size": xsd:unsignedLong
"utilizedSpace": xsd:unsignedLong
"freeSpace": xsd:unsignedLong
"sizeMetaData": xsd:unsignedLong
"utilizedSpaceMetaData": xsd:unsignedLong
"pendingOperationRequestId": xsd:string
"poolAssocList": [[#osn:cephPoolGroupAssoc|osn:cephPoolGroupAssoc]]
}
</code>

== osn:cephPoolGroupAssoc ==
''' Fields '''
<code>
{
"cephPoolGroupId": xsd:string
"cephPoolId": xsd:string
"isMetadataPool": xsd:boolean
}
</code>

== osn:cephPoolNamespace ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephPoolId": xsd:string
"cephClusterId": xsd:string
"description": xsd:string
}
</code>

== osn:cephPoolProfile ==
A ceph pool profile defines an erasure-coding configuration. It may be specified when new scale-out pools are created to control fault tolerance level and data distribution.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"cephClusterId": xsd:string {{Note|Ceph Cluster where this EC profile resides|inline=1}}
"dataChunkCount": xsd:unsignedInt {{Note|Indicates the number of data blocks 'k'|inline=1}}
"codeChunkCount": xsd:unsignedInt {{Note|Indicates the number of coding blocks 'm'|inline=1}}
"plugin": xsd:string {{Note|Indicates the EC plugin used, default is 'jerasure'|inline=1}}
"technique": xsd:string {{Note|Indicates the coding block technique of the EC profile, default is 'reed_sol_van'|inline=1}}
"failureDomain": xsd:string {{Note|Indicates the failure domain of the EC profile, usually 'host' but can be 'rack' or 'site'|inline=1}}
"rulesetRoot": xsd:string {{Note|Specifies the CRUSH root of the profile, typically 'default'|inline=1}}
"deviceClass": xsd:string {{Note|Specifies the device class (hdd, ssd, nvme) contraint, if empty pools using the profile will use all osds of all classes|inline=1}}
}
</code>

== osn:cephRadosGateway ==
Provides S3 and SWIFT object storage access to a [[#osn:cephCluster]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"nodeSystemId": xsd:string
"cephObjectPoolGroupId": xsd:string
"ipAddress": xsd:string
"portNumber": xsd:unsignedInt
"targetPortId": xsd:string
"serviceEngine": xsd:unsignedInt {{Note|0=civetweb, 1=beast (new default)|inline=1}}
"serviceMode": xsd:unsignedInt {{Note|0=https, 1=http (unsecure)|inline=1}}
"options": xsd:string
"certificatePemFilePath": xsd:string
"enableHttpsRedirect": xsd:boolean {{Note|Enable https port redirect to port 7480|inline=1}}
"enableLoadBalancer": xsd:boolean
"useTcpChecks": xsd:boolean
"loadBalancerMappingMode": xsd:unsignedInt {{Note|see osn__loadBalancerMappingMode_t indicates https->http, http->http, or https->https in the lb to gateway mapping|inline=1}}
"serviceSettings": xsd:unsignedInt {{Note|See [[#enum:cephRgwServiceSettings]] for bitmask of options|inline=1}}
"enableActiveMonitoring": xsd:boolean {{Note|continuously pings the RGW instance every minute to stat a specific object, not just to verify the service is running|inline=1}}
}
</code>

== osn:certificate ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"containsCertificate": xsd:boolean
"containsPrivateKey": xsd:boolean
"isSelfSigned": xsd:boolean
"certificateFilePath": xsd:string
"certificateVersion": xsd:string
"certificateStartDate": xsd:dateTime
"certificateEndDate": xsd:dateTime
"certificateSerial": xsd:string
"certificateAlgorithm": xsd:string
"certificateEmail": xsd:string
"subjectAlternativeNames": xsd:string
"certificateSubject": xsd:string
"certificateIssuer": xsd:string
"certificateModulusMd5": xsd:string
"certificateFingerprint": xsd:string
"privateKeyFilePath": xsd:string
"privateKeyType": xsd:string
"privateKeyModulusMd5": xsd:string
"modulusMatch": xsd:boolean
"certUseCase": xsd:unsignedInt
}
</code>

== osn:certificateTemplate ==
''' Inherits From '''
[[#osn:certificate|osn:certificate]]

''' Fields '''
<code>
{
"pemFileContentCertificate": xsd:string
"pemFileContentPrivateKey": xsd:string
}
</code>

== osn:clientConnection ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"pid": xsd:unsignedInt
"isOutbound": xsd:boolean
"serverIpAddress": xsd:string
"serverPort": xsd:unsignedInt
"clientIpAddress": xsd:string
"clientPort": xsd:unsignedInt
"servicePortType": xsd:unsignedInt
}
</code>

== osn:cloudContainer ==
Cloud containers represent a mapping of cloud based storage (typically S3 or S3 compatible storage) to a local Network Share so that the cloud storage may be accessed over traditional NAS protocols like SMB and NFS.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"credentialsId": xsd:string
"locationId": xsd:string
"providerType": xsd:unsignedInt
"encryptionKey": xsd:string
"storageUrl": xsd:string
"mountPoint": xsd:string
"markedDisabled": xsd:boolean
"enableNfs": xsd:boolean
"spaceUtilized": xsd:unsignedLong
"containerType": xsd:unsignedInt
"mountOptions": xsd:string
"configName": xsd:string
"storageClass": xsd:string
}
</code>

== osn:cloudContainerCacheSettings ==
Global NAS Gateway settings

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"dirCacheTime": xsd:string
"vfsCacheMode": xsd:unsignedInt
"cacheShareId": xsd:string
"bufferSize": xsd:unsignedLong
"vfsCacheMaxAge": xsd:string {{Note|Max age of objects in the cache. (default 1h0m0s)|inline=1}}
"vfsCacheMaxSize": xsd:unsignedLong {{Note|Interval to poll the cache for stale objects. (default 1m0s)|inline=1}}
}
</code>

== osn:cloudProvider ==
Represents a object storage cloud service provider like AWS, Azure, etc.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"providerType": xsd:unsignedInt
"description": xsd:string
"driverPath": xsd:string
"supportsS3Proxy": xsd:boolean
"defaultLocation": xsd:string
"credentialsList": [[#osn:cloudProviderCredentials|osn:cloudProviderCredentials]]
"locationList": [[#osn:cloudProviderLocation|osn:cloudProviderLocation]]
"storageClassList": [[#osn:cloudProviderStorageClass|osn:cloudProviderStorageClass]]
}
</code>

== osn:cloudProviderCredentials ==
Credentials used to login to a given cloud service provider for the purposes of creating, deleting, or connecting [[#osn:cloudContainer]] instances. This must be added for one or more cloud service providers (eg AWS, Azure, Dropbox, etc) before one can add or create a [[#osn:cloudContainer]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"providerId": xsd:string
"providerType": xsd:unsignedInt
"machine": xsd:string
"username": xsd:string
"password": xsd:string
"projectId": xsd:string
"authFile": xsd:string
"containerList": [[#osn:cloudContainer|osn:cloudContainer]]
}
</code>

== osn:cloudProviderLocation ==
Each cloud provider (AWS, etc) will have one or more location/regions associated with it like us-east, us-west.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"locationTag": xsd:string
"providerId": xsd:string
"endpoint": xsd:string
"locationConstraint": xsd:string
}
</code>

== osn:cloudProviderStorageClass ==
Each cloud provider (AWS, etc) will have one or storage class like GLACIER or GLACIER_IR.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storageClassTag": xsd:string
"providerId": xsd:string
"description": xsd:string
}
</code>

== osn:clusterRing ==
Each Site Cluster will have one or two heartbeat rings setup. For production deployments we require two rings so that one can go down without triggering high-availability failover activities. When a [[#osn:siteCluster]] is created it is always created with the initial cluster ring. After creation the second ring may be added.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"siteClusterId": xsd:string
"ring": xsd:unsignedInt
"mcastPort": xsd:unsignedInt
"bindNetAddress": xsd:string
"status": xsd:string
"ringMemberList": [[#osn:clusterRingMember|osn:clusterRingMember]]
}
</code>

== osn:clusterRingMember ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"siteClusterId": xsd:string
"clusterRingId": xsd:string
"memberAddress": xsd:string
}
</code>

== osn:container ==
containers are specific instances, started based on associated containerConfig, transient, managed automatically by containerManager

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"containerConfigId": xsd:string
"uptime": xsd:string
"serviceUrl": xsd:string
}
</code>

== osn:containerConfig ==
each config object represents a specific configuration of an instance of a containerized service (ftp, resilio, samba, etc)

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"containerServiceDefTag": xsd:string
"containerConfigOptionList": [[#osn:containerConfigOption|osn:containerConfigOption]]
}
</code>

== osn:containerConfigOption ==
container config options are essentially just key=value pairs, used by a containerConfig object

''' Fields '''
<code>
{
"key": xsd:string
"value": xsd:string
"containerConfigId": xsd:string
}
</code>

== osn:containerServiceDef ==
info about the containerized service, created from parsing qs_containerservice.conf

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"tag": xsd:string
"containerServiceDefType": xsd:unsignedInt {{Note|enum osn__containerServiceDefType_t: OSN_CMN_CONTAINER_SERVICE_DEF_TYPE_UNKNOWN, VSFTP, or RESILIO|inline=1}}
"containerImage": xsd:string {{Note|registry-ext.resilio.com:5000/resilio_connect_agent:2.12.10.1916|inline=1}}
"containerImageLogin": xsd:string
"imageStatus": xsd:unsignedInt
"secureKey": xsd:string
"user": xsd:string {{Note|list of options for the container service definition, eg: ftp_user, ftp_password, resilio_license_key, etc|inline=1}}
"serviceDefOptionList": [[#osn:containerServiceDefOption|osn:containerServiceDefOption]]
}
</code>

== osn:containerServiceDefOption ==
''' Fields '''
<code>
{
"containerServiceDefId": xsd:string
"paramKey": xsd:string
"paramType": xsd:string
"paramLabel": xsd:string
"paramDefaultValue": xsd:string
"paramMandatory": xsd:boolean
"paramHidden": xsd:boolean
"paramCustomOptions": xsd:string
"paramIndex": xsd:unsignedInt
"paramRangeMin": xsd:unsignedInt
"paramRangeMax": xsd:unsignedInt
"paramDescription": xsd:string
}
</code>

== osn:dashboard ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"dashboardGroupId": xsd:string
"description": xsd:string
"url": xsd:string
}
</code>

== osn:dashboardGroup ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"dashboardIdList": xsd:string
}
</code>

== osn:errorMessage ==
''' Fields '''
<code>
{
"severity": xsd:unsignedInt
"message": [[#osn:i18nString|osn:i18nString]]
"errorCode": xsd:unsignedInt
"file": xsd:string
"line": xsd:unsignedInt
"function": xsd:string
}
</code>

== osn:event ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"index": xsd:unsignedInt
"operation": xsd:string
"objectType": xsd:unsignedInt
"objectId": xsd:string
"parentId": xsd:string
"parentId2": xsd:string
"category": xsd:string
"serviceTimeStamp": xsd:dateTime
"timeStamp": xsd:dateTime
"eventId": xsd:string
"originId": xsd:string
"isSync": xsd:boolean
"isRebroadcast": xsd:boolean
"objectIdList": xsd:string
"objectDataList": xsd:string
"params": [[#osn:keyValuePair|osn:keyValuePair]]
}
</code>

== osn:eventListener ==
''' Fields '''
<code>
{
"processorSystemId": xsd:string
"broadcasterSystemId": xsd:string
"preferredIpAddress": xsd:string
"ipAddressList": xsd:string
"listenerType": xsd:unsignedInt
"listenerMode": xsd:unsignedInt
"listenerId": xsd:string
"serviceTimeStamp": xsd:dateTime
"lastRegistrationRequest": xsd:dateTime
"lastRegistrationStamp": xsd:dateTime
"maxEvents": xsd:unsignedInt
"state": xsd:unsignedInt
"resyncList": xsd:string
}
</code>

== osn:externalSystem ==
External Systems

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"description": xsd:string
"serialNumber": xsd:string
"wwn": xsd:string
"model": xsd:string
"capabilities": xsd:unsignedInt
"capacity": xsd:unsignedLong
"slots": xsd:unsignedInt
"slotNumber": xsd:unsignedInt
"indicatorLed": xsd:unsignedInt
"enclosureLayoutId": xsd:string
"externalSystemCredentialsId": xsd:string
"externalSystemPortGroupIdList": xsd:string
"externalSystemControllerIdList": xsd:string
"externalSystemPoolIdList": xsd:string
}
</code>

== osn:externalSystemController ==
External System Controllers (openflex boxes have two, IO Module A and IO Module B)

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"externalSystemId": xsd:string
"hostname": xsd:string
"serialNumber": xsd:string
"macAddress": xsd:string
"isRebootable": xsd:boolean
}
</code>

== osn:externalSystemCredentials ==
Credentials for discovering External Systems

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"username": xsd:string
"password": xsd:string
"primaryIp": xsd:string
"secondaryIp": xsd:string
"siteClusterId": xsd:string
"portNumber": xsd:unsignedInt
"insecure": xsd:boolean
"externalSystemType": xsd:unsignedInt
}
</code>

== osn:externalSystemHost ==
External System Host

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"description": xsd:string
"serialNumber": xsd:string
"externalSystemId": xsd:string
"associatedStorageSystemId": xsd:string
"initiatorA": xsd:string
"initiatorB": xsd:string
"hostVolAssocList": [[#osn:externalSystemHostVolumeAssoc|osn:externalSystemHostVolumeAssoc]]
}
</code>

== osn:externalSystemHostVolumeAssoc ==
External System Host Volume Assoc

''' Fields '''
<code>
{
"externalSystemVolumeId": xsd:string
"externalSystemHostId": xsd:string
}
</code>

== osn:externalSystemMedia ==
Media device which is part of a discovered External System

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"externalSystemId": xsd:string
"externalSystemPortGroupId": xsd:string
"externalSystemPoolId": xsd:string
"powerOn": xsd:boolean
"manufacturer": xsd:string
"protocol": xsd:unsignedInt
"capacity": xsd:unsignedLong
"slotNumber": xsd:unsignedInt
"serialNumber": xsd:string
"firmwareVersion": xsd:string
"usedById": xsd:string
"usedByType": xsd:unsignedInt
}
</code>

== osn:externalSystemPool ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"externalSystemId": xsd:string
"capacity": xsd:unsignedLong
"availableCapacity": xsd:unsignedLong
"externalSystemControllerId": xsd:string
"serialNumber": xsd:string
"raidtype": xsd:unsignedInt
"externalSystemVolumeIdList": xsd:string
}
</code>

== osn:externalSystemPort ==
Port on an External System

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"externalSystemPortGroupId": xsd:string
"externalSystemId": xsd:string
"macAddress": xsd:string
"ipAddress": xsd:string
"subnetMask": xsd:string
"mtuBytes": xsd:unsignedInt
"isManagementPort": xsd:boolean
}
</code>

== osn:externalSystemPortGroup ==
External System Port Group consist of associated ports which access the same External System Media

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"externalSystemId": xsd:string
"isManagementPortGroup": xsd:boolean
"slots": xsd:unsignedInt
"externalSystemPortIdList": xsd:string
"externalSystemMediaIdList": xsd:string
}
</code>

== osn:externalSystemProfile ==
External System Profile

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"tag": xsd:string
"description": xsd:string
"poolPrefix": xsd:string
"volPrefix": xsd:string
"dgDevices": xsd:string
"raidType": xsd:unsignedInt
"stripeWidth": xsd:string
"volumesPerPool": xsd:unsignedInt
"hostAssign": xsd:boolean
"externalSystemType": xsd:unsignedInt
}
</code>

== osn:externalSystemVolume ==
external system volume

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"altName": xsd:string
"externalSystemId": xsd:string
"externalSystemControllerId": xsd:string
"externalSystemPoolId": xsd:string
"externalSystemHostId": xsd:string
"capacity": xsd:unsignedLong
"serialNumber": xsd:string
"wwn": xsd:string
"lun": xsd:string
"raidtype": xsd:unsignedInt
"usedById": xsd:string
"usedByType": xsd:unsignedInt
}
</code>

== osn:fcRemotePort ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"fcTargetPortId": xsd:string
"portWwn": xsd:string
}
</code>

== osn:fcTargetPort ==
Represents a Fibre Channel port on a FC HBA within a QuantaStor [[#osn:storageSystem]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"isVirtualPort": xsd:boolean
"firmwareVersion": xsd:string
"driverVersion": xsd:string
"pciInfo": xsd:string
"isTargetModeEnabled": xsd:boolean
"deviceNumber": xsd:unsignedInt
"sysfsPath": xsd:string
"vendor": xsd:string
"linkState": xsd:string
"model": xsd:string
"portWwn": xsd:string
"nodeWwn": xsd:string
"activePortWwn": xsd:string
"activeNodeWwn": xsd:string
"status": xsd:string
"fabricWwn": xsd:string
"activeMode": xsd:unsignedInt
"remotePortList": [[#osn:fcRemotePort|osn:fcRemotePort]]
}
</code>

== osn:hardwareConfiguration ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"listExternalSystem": [[#osn:externalSystem|osn:externalSystem]]
"listExternalSystemController": [[#osn:externalSystemController|osn:externalSystemController]]
"listExternalSystemCredentials": [[#osn:externalSystemCredentials|osn:externalSystemCredentials]]
"listExternalSystemMedia": [[#osn:externalSystemMedia|osn:externalSystemMedia]]
"listExternalSystemPort": [[#osn:externalSystemPort|osn:externalSystemPort]]
"listExternalSystemPortGroup": [[#osn:externalSystemPortGroup|osn:externalSystemPortGroup]]
"listExternalSystemPool": [[#osn:externalSystemPool|osn:externalSystemPool]]
"listExternalSystemVolume": [[#osn:externalSystemVolume|osn:externalSystemVolume]]
"listExternalSystemProfile": [[#osn:externalSystemProfile|osn:externalSystemProfile]]
"listExternalSystemHost": [[#osn:externalSystemHost|osn:externalSystemHost]]
"listHwAlarm": [[#osn:hwAlarm|osn:hwAlarm]]
"listHwBbu": [[#osn:hwBatteryBackupUnit|osn:hwBatteryBackupUnit]]
"listHwController": [[#osn:hwController|osn:hwController]]
"listHwGroup": [[#osn:hwControllerGroup|osn:hwControllerGroup]]
"listHwDisk": [[#osn:hwDisk|osn:hwDisk]]
"listHwEnclosure": [[#osn:hwEnclosure|osn:hwEnclosure]]
"listHwEnclosureLayout": [[#osn:hwEnclosureLayout|osn:hwEnclosureLayout]]
"listHwEnclosureLayoutVendorGroup": [[#osn:hwEnclosureLayoutVendorGroup|osn:hwEnclosureLayoutVendorGroup]]
"listHwSlot": [[#osn:hwSlot|osn:hwSlot]]
"listHwLogicalDrive": [[#osn:hwLogicalDrive|osn:hwLogicalDrive]]
"listHwUnit": [[#osn:hwUnit|osn:hwUnit]]
"listHwUnitDiskAssoc": [[#osn:hwUnitDiskAssoc|osn:hwUnitDiskAssoc]]
"listSwController": [[#osn:swController|osn:swController]]
"listSwControllerGroup": [[#osn:swControllerGroup|osn:swControllerGroup]]
"listSwControllerTarget": [[#osn:swControllerTarget|osn:swControllerTarget]]
"listSwDiskSession": [[#osn:swDiskSession|osn:swDiskSession]]
}
</code>

== osn:healthStatusEvent ==
This is the type of object which is created during a health check. For example, a health status event object is created when performing a failover health check

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"objectId": xsd:string
"objectType": xsd:unsignedInt
"title": xsd:string
"description": xsd:string
"recommendedAction": xsd:string
"healthStatusSeverity": xsd:unsignedInt
}
</code>

== osn:host ==
Represents a host/server with one or more initiator ports which will login to the [[#osn:storageSystem]] to access one or more [[#osn:storageVolume]]s. Note that Storage Volumes are not accessible until they've been assigned to one or more [[#osn:host]]s. That assignment is represented by one or more [[#osn:storageVolumeAcl]]s.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"ipAddress": xsd:string
"password": xsd:string
"username": xsd:string
"hostGroupId": xsd:string
"hostOsType": xsd:unsignedInt
"hostVolumeAclList": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
"initiatorPortList": [[#osn:initiatorPort|osn:initiatorPort]]
}
</code>

== osn:hostGroup ==
Provides a convenience mechansim for grouping together [[#osn:host]]s so that Storage Volumes can be assigned to many hosts in a single operation. Typically a Host Group is created for each cluster in the environment be it a VMware cluster, Windows cluster, or some other type of cluster so that the block storage can be assigned/unassigned to all the hosts at once.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"hostGroupVolumeAclList": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
"hostList": [[#osn:host|osn:host]]
}
</code>

== osn:hwAlarm ==
Hardware RAID controllers and HBAs can generate alerts when issues are detected. These are ingested and presented as [[#osn:hwAlarm]] instances.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"timeStamp": xsd:dateTime
"severity": xsd:unsignedInt
"message": xsd:string
"suppressed": xsd:boolean
"raised": xsd:boolean
}
</code>

== osn:hwBatteryBackupUnit ==
provides information about the battery backup or supercapacitor on a RAID controller if installed.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"status": xsd:string
"model": xsd:string
"serialNumber": xsd:string
"chargePercent": xsd:unsignedInt
"isReady": xsd:boolean
"isOnline": xsd:boolean
"needsReplacement": xsd:boolean
"hoursUtilized": xsd:unsignedInt
}
</code>

== osn:hwController ==
Represents a hardware RAID controller or SAS HBA.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerGroupId": xsd:string
"vendor": xsd:string
"model": xsd:string
"driverVersion": xsd:string
"firmwareVersion": xsd:string
"biosVersion": xsd:string
"serialNum": xsd:string
"sasAddresses": xsd:string
"pciAddress": xsd:string
"ports": xsd:unsignedInt
"drives": xsd:unsignedInt
"units": xsd:unsignedInt
"controllerTemp": xsd:string
"rebuildRate": xsd:unsignedInt
"verifyRate": xsd:unsignedInt
"maxSsdCacheSize": xsd:unsignedLong
"currentSsdCacheSize": xsd:unsignedLong
"hasBatteryBackupUnit": xsd:boolean
"capabilities": xsd:unsignedInt
"altName": xsd:string
"description": xsd:string
"cacheMemorySize": xsd:unsignedLong
"enclosureList": [[#osn:hwEnclosure|osn:hwEnclosure]]
"unitList": [[#osn:hwUnit|osn:hwUnit]]
"diskList": [[#osn:hwDisk|osn:hwDisk]]
"bbuList": [[#osn:hwBatteryBackupUnit|osn:hwBatteryBackupUnit]]
}
</code>

== osn:hwControllerGroup ==
Represents a hardware controller module for specific vendor/model of RAID or HBA controller.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"vendor": xsd:string
"apiVersion": xsd:string
"controllerList": [[#osn:hwController|osn:hwController]]
}
</code>

== osn:hwDisk ==
Represents storage media (HDD, SSD, NVMe) connected to an HBA or RAID controller. When a hwDisk is passed thru to the system it appears as a [[#osn:physicalDisk]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"enclosureId": xsd:string
"enclosure": xsd:string
"enclosureSasAddress": xsd:string
"slot": xsd:string
"serialNum": xsd:string
"firmwareVersion": xsd:string
"status": xsd:string
"unit": xsd:string
"unitId": xsd:string
"size": xsd:unsignedLong
"diskType": xsd:unsignedInt
"stateDetailFlags": xsd:unsignedInt
"vendor": xsd:string
"model": xsd:string
"isSsdDevice": xsd:unsignedInt
"isSpare": xsd:boolean
"isEncrypted": xsd:boolean
"isBlinking": xsd:boolean
"capabilities": xsd:unsignedInt
"mediumErrors": xsd:unsignedInt
"predictiveErrors": xsd:unsignedInt
"ssdLifeLeft": xsd:string
"driveTemp": xsd:string
"altName": xsd:string
"description": xsd:string
"smartHealthTest": xsd:string
"sasAddress": xsd:string
"portSasAddress": xsd:string
"physicalDiskId": xsd:string
}
</code>

== osn:hwEnclosure ==
Represents a JBOD / disk chassis connected to a [[#osn:hwController]]. In a HA configuration each server will have 2x HBAs (see [[#osn:hwController]]) instances each connected to a given JBOD [[#osn:hwEnclosure]] so it will typically appear 4x times, once for each HBA.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"enclosureLayoutId": xsd:string
"slots": xsd:unsignedInt
"drives": xsd:unsignedInt
"fans": xsd:unsignedInt
"tempSensorUnits": xsd:unsignedInt
"powerSupplyUnits": xsd:unsignedInt
"alarmCount": xsd:unsignedInt
"vendor": xsd:string
"model": xsd:string
"sesType": xsd:string
"sgDevicePath": xsd:string
"logicalId": xsd:string
"sasAddress": xsd:string
"firmwareVersion": xsd:string
"altName": xsd:string
"description": xsd:string
"chassisTag": xsd:string
"serialNumber": xsd:string
"diskList": [[#osn:hwDisk|osn:hwDisk]]
}
</code>

== osn:hwEnclosureLayout ==
Each vendor and model of disk chassis (JBOD) has an associated enclosure layout object instance which provides detailed information chassis, like the number of drives, flow of drives (top->bottom, left->right) and more. Each [[#osn:hwEnclosure instance]] is associated with a [[#osn:hwEnclosureLayout]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"vendor": xsd:string
"model": xsd:string
"layoutFlow": xsd:unsignedInt
"rows": xsd:unsignedInt
"columns": xsd:unsignedInt
"excludeSlots": xsd:string
"slotsPerDrawer": xsd:unsignedInt
"diskNumberingOffset": xsd:unsignedInt
"slotStartingIndex": xsd:unsignedInt
"diskOrientation": xsd:unsignedInt
"drawerLayoutFlow": xsd:unsignedInt
"imageName": xsd:string
"sesIsEnabled": xsd:unsignedInt
"sesVendor": xsd:string
"sesProduct": xsd:string
"matchTokensVendor": xsd:string
"matchTokensProduct": xsd:string
"matchTokensSlots": xsd:string
"enclosureType": xsd:unsignedInt
"parentLayoutId": xsd:string
"vendorGroupId": xsd:string
"drawerLabel": xsd:string
"drawerOrdering": xsd:string
"slotExclusionList": [[#osn:hwEnclosureLayoutSlotExclusion|osn:hwEnclosureLayoutSlotExclusion]]
}
</code>

== osn:hwEnclosureLayoutSlotExclusion ==
some [[#osn:hwEnclosureLayout]] have drive slots which are taken up by power supplies, fans or structural elements of the chassis. This indicates what row and column that exclusion is located so that the enclosure can be properly rendered in the WUI.

''' Fields '''
<code>
{
"row": xsd:unsignedInt
"column": xsd:unsignedInt
"notation": xsd:string
}
</code>

== osn:hwEnclosureLayoutVendorGroup ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"vendorTag": xsd:string
}
</code>

== osn:hwLogicalDrive ==
In a hardware RAID controller (see [[#osn:hwController]]) the RAID units (see [[#osn:hwUnit]]) can be sliced up into multiple logical drives each of which will appear as a separate [[#osn:physicalDisk]] to the system.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"unitId": xsd:string
"size": xsd:unsignedLong
"stripeSize": xsd:unsignedLong
"status": xsd:string
"devicePath": xsd:string
"serialNumber": xsd:string
"deviceDescriptor": xsd:string
"raidType": xsd:unsignedInt
"physicalDiskId": xsd:string
}
</code>

== osn:hwSlot ==
represents status of slots, including blink status of slots thta may be empty

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"hwEnclosureId": xsd:string
"hwDiskId": xsd:string
"slot": xsd:unsignedInt
"isOccupied": xsd:boolean
"isBlinking": xsd:boolean
}
</code>

== osn:hwUnit ==
Represents a hardware RAID unit which could be RAID1/10/5/50/6/60. We only recommend the use of hardware RAID for the QuantaStor operating system boot device which should be two RAID1 mirrored SSDs which are ideally 200GB or larger in size.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"raidType": xsd:unsignedInt
"unitType": xsd:string
"serialNum": xsd:string
"status": xsd:string
"productId": xsd:string
"stripeSize": xsd:unsignedLong
"size": xsd:unsignedLong
"rebuildPercentComplete": xsd:string
"vimPercentComplete": xsd:string
"consistencyVerified": xsd:unsignedInt
"writeCacheEnabled": xsd:boolean
"isSystemDevice": xsd:boolean
"isEncrypted": xsd:boolean
"isSpare": xsd:boolean
"physicalDiskId": xsd:string
"capabilities": xsd:unsignedInt
"hwCachePolicy": xsd:unsignedInt
"isSsdCacheUnit": xsd:boolean
"ssdCachingEnabled": xsd:boolean
"altName": xsd:string
"description": xsd:string
"diskList": [[#osn:hwDisk|osn:hwDisk]]
"logicalDriveList": [[#osn:hwLogicalDrive|osn:hwLogicalDrive]]
}
</code>

== osn:hwUnitDiskAssoc ==
Each hardware RAID unit is comprised of one or more disks (HDDs or SSDs). This represents the relationship between a [[#osn:hwUnit]] and a [[#osn:hwDisk]]. Each [[#osn:hwUnit]] contains a list of these associations, one for each disk in the RAID unit.

''' Fields '''
<code>
{
"unitId": xsd:string
"diskId": xsd:string
"controllerId": xsd:string
}
</code>

== osn:i18nString ==
''' Fields '''
<code>
{
"messageId": xsd:string
"messageText": xsd:string
"insertionParams": [[#osn:keyValuePair|osn:keyValuePair]]
}
</code>

== osn:ibTargetPort ==
Represents an Infiniband network port. QuantaStor supports IB ports via IP-over-IB. Support for SRP has been deprecated in favor of iSER.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"caType": xsd:string
"firmwareVersion": xsd:string
"hwVersion": xsd:string
"sysfsPath": xsd:string
"vendor": xsd:string
"linkState": xsd:string
"model": xsd:string
"portGuid": xsd:string
"nodeGuid": xsd:string
"status": xsd:string
"rate": xsd:string
"baseLid": xsd:unsignedInt
"lmc": xsd:unsignedInt
"smLid": xsd:unsignedInt
"portNumber": xsd:unsignedInt
}
</code>

== osn:initiatorPort ==
An initiator port associated with a [[#osn:host]]. Initiator ports may be FC WWPNs or iSCSI IQNs.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"ipAddress": xsd:string
"hostId": xsd:string
"iqn": xsd:string
"wwpn": xsd:string
"initiatorType": xsd:unsignedInt
"nqn": xsd:string
}
</code>

== osn:keyServerProfile ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"host": xsd:string
"kmipConnectionPort": xsd:string
"description": xsd:string
"clientCertPath": xsd:string
"clientCertData": xsd:string
"caCertPath": xsd:string
"caCertData": xsd:string
"clientKeyPath": xsd:string
"clientKeyData": xsd:string
"username": xsd:string
"password": xsd:string
"serverType": xsd:unsignedInt
"protocol": xsd:unsignedInt
"connectionMode": xsd:unsignedInt
"timeout": xsd:unsignedInt
"supportedOps": xsd:string
"keyIdList": xsd:string
}
</code>

== osn:keyServerProfileKey ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"keyServerProfileId": xsd:string
"description": xsd:string
"keyId": xsd:string
"keyType": xsd:string
"resourceId": xsd:string
"resourceType": xsd:unsignedInt
"encoding": xsd:unsignedInt
}
</code>

== osn:keyValuePair ==
''' Fields '''
<code>
{
"key": xsd:string
"value": xsd:string
"type": xsd:unsignedInt
}
</code>

== osn:license ==
A license key associated with a [[#osn:storageSystem]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"licenseKey": xsd:string
"fullName": xsd:string
"email": xsd:string
"version": xsd:string
"orderNumber": xsd:string
"company": xsd:string
"licenseDate": xsd:dateTime
"expirationDate": xsd:dateTime
"timeUtilizedInMin": xsd:unsignedInt
"licenseEdition": xsd:unsignedInt
"licenseDuration": xsd:unsignedInt
"licenseCategory": xsd:unsignedInt
"licenseType": xsd:unsignedInt
"nodeLimit": xsd:unsignedInt
"cloudLimit": xsd:unsignedInt
"snapshotLimit": xsd:unsignedInt
"terabyteLimit": xsd:unsignedInt
"userLimit": xsd:unsignedInt
"volumeLimit": xsd:unsignedInt
"remoteReplicationEnabled": xsd:boolean
"ssdEnabled": xsd:boolean
"isNFR": xsd:boolean
"activationRequestCode": xsd:string
"activationStamp": xsd:string
"activationKey": xsd:string
"country": xsd:string
"website": xsd:string
"licenseServerFqdn": xsd:string
"customFeature": xsd:unsignedInt
"encryptionDisabled": xsd:boolean
"isHighAvailability": xsd:boolean
"parentLicenseKey": xsd:string
"replacesLicenseKey": xsd:string
"leaseEnforcementEnabled": xsd:boolean
"objectStorageDisabled": xsd:boolean
"lastLeaseRenewalDate": xsd:dateTime
"leaseRenewalKey": xsd:string
"resellerName": xsd:string
"resellerContactNumber": xsd:string
"resellerEmail": xsd:string
"supportContractRef": xsd:string
"terabytesUtilized": xsd:unsignedInt
}
</code>

== osn:licenseActivation ==
Once a license is activated it will have an activation key associated with it which binds the key to a given [[#osn:storageSystem]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"licenseKey": xsd:string
"activationRequestCode": xsd:string
"activationStamp": xsd:string
"activationKey": xsd:string
}
</code>

== osn:licenseLease ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"licenseKey": xsd:string
"lastLeaseRenewalDate": xsd:dateTime
"leaseRenewalKey": xsd:string
}
</code>

== osn:loadBalancer ==
Represents a load balancer for RGW S3 gateway

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"portNumber": xsd:unsignedInt
"balancerType": xsd:unsignedInt
"configPath": xsd:string
}
</code>

== osn:lock ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"objectId": xsd:string
"objectType": xsd:unsignedInt
"lockType": xsd:unsignedInt
"taskId": xsd:string
"taskParentId": xsd:string
"createdTimeStamp": xsd:dateTime
"lastCheckTimeStamp": xsd:dateTime
"overrideId": xsd:string
}
</code>

== osn:maintenanceSchedule ==
Used to periodially pool-scrub any bit-rot in [[#osn:storagePool]]s, pool-trim to free deleted blocks in SSD media, and s3-orphan-cleanup to search for and remove orphaned S3 objects no longer associated with a bucket

''' Inherits From '''
[[#osn:schedule|osn:schedule]]

''' Fields '''
<code>
{
"maintenanceType": xsd:unsignedInt {{Note|see osn__maintenanceType|inline=1}}
"minDaysBetweenMaintenance": xsd:unsignedInt
"lastMaintenanceStartTimeStamp": xsd:dateTime
"assocList": [[#osn:maintenanceScheduleAssoc|osn:maintenanceScheduleAssoc]]
}
</code>

== osn:maintenanceScheduleAssoc ==
''' Fields '''
<code>
{
"maintenanceScheduleId": xsd:string
"maintenanceObjectId": xsd:string
"maintenanceObjectType": xsd:unsignedInt
}
</code>

== osn:mfaLogin ==
Multi-factor authentication login request

''' Fields '''
<code>
{
"reqCode": xsd:string
"reqStatus": xsd:unsignedInt
"respMsg": xsd:string
}
</code>

== osn:multiFactorAuthConfig ==
Multi-factor Authentication configuration which is associated with a MFA provider like Cisco Duo or Google Authenticator.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"encodingMode": xsd:unsignedInt
"provider": xsd:unsignedInt
"apiHost": xsd:string
"integrationKey": xsd:string
"secretKey": xsd:string
"description": xsd:string
}
</code>

== osn:multiFactorAuthDevice ==
Represents a multi-factor authentication device like a phone

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"capabilities": xsd:unsignedInt
"device": xsd:string
"displayName": xsd:string
"nextSmsPasscode": xsd:string
"number": xsd:string
"deviceType": xsd:string
}
</code>

== osn:multipathConfig ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"vendor": xsd:string
"product": xsd:string
"wwid": xsd:string
"protocol": xsd:unsignedInt
}
</code>

== osn:networkShare ==
Represents NAS file storage which is accessible via NFS and SMB file protocols.

''' Inherits From '''
[[#osn:replicatable|osn:replicatable]]

''' Fields '''
<code>
{
"sharePath": xsd:string {{Note|path to where the share is located within a given storage system (where the share is mounted)|inline=1}}
"description": xsd:string {{Note|user defined description|inline=1}}
"isActive": xsd:boolean {{Note|true when the share is enabled allowing NFS/SMB access|inline=1}}
"shareType": xsd:unsignedInt {{Note|indicates the type of share such as scale-up or scale-out (see osn__networkShareType)|inline=1}}
"enableCifs": xsd:boolean {{Note|true if SMB/CIFS access is allowed for this share|inline=1}}
"isCloudBackup": xsd:boolean {{Note|true if this share is a osn__cloudContainer|inline=1}}
"spaceQuota": xsd:unsignedLong {{Note|a zero (0) quota indicates no limit/quota, a positive value indicates a quot size in bytes|inline=1}}
"cloudContainerId": xsd:string {{Note|UUID of an associated osn__cloudContainer, only applies if this share is a mapping to a osn__cloudContainer|inline=1}}
"disableSnapBrowsing": xsd:boolean {{Note|Disable VSS (SMB) Browsing|inline=1}}
"ownerUid": xsd:unsignedInt {{Note|Unix user ID (UID) of the share owner, this is set on the root folder of the share|inline=1}}
"ownerGid": xsd:unsignedInt {{Note|Unix group ID (GID) of the share owner, this is set on the root folder of the share|inline=1}}
"permissions": xsd:string {{Note|unix system permissions in rwx format such as 'rwxrwxrwx' or 'rwxr--r--'|inline=1}}
"aclType": xsd:unsignedInt {{Note|can be off or posixacl|inline=1}}
"spaceQuotaExcludeSnapshots": xsd:boolean {{Note|true if the quota on this share should exclude space used by snapshots|inline=1}}
"blockSizeKb": xsd:unsignedInt {{Note|record size is adjustable only for shares in ZFS based Storage Pools|inline=1}}
"parentShareId": xsd:string {{Note|parent share ID is set for snapshots, aliases, and subshares|inline=1}}
"exportPath": xsd:string {{Note|NFS export path for the share|inline=1}}
"isCloudContainerCache": xsd:boolean {{Note|true if this share is being used as a cache for osn__cloudContainers|inline=1}}
"exportId": xsd:unsignedInt {{Note|NFS export identifier used for scale-out shares|inline=1}}
"nfsSecurityPolicy": xsd:unsignedInt {{Note|see osn__nfsSecurityPolicy|inline=1}}
"isNested": xsd:boolean
"disableSmbSnapsDir": xsd:boolean {{Note|Enables SMB _snaps folder browsing of activated GMT snapshots|inline=1}}
"disableNfsSnapsDir": xsd:boolean {{Note|Enables NFS _snaps folder browsing of activated GMT snapshots|inline=1}}
"enableNfsSnapBrowsing": xsd:boolean {{Note|Enables explicit NFS share/.zfs snapshot visibility|inline=1}}
"isEncrypted": xsd:boolean {{Note|Enable zfs encryption on dataset|inline=1}}
"requiresKeyPassphrase": xsd:boolean
"cryptAlgorithm": xsd:string {{Note|key type, e.g., aes-256-gcm|inline=1}}
"cryptKeyFormat": xsd:string {{Note|key type, e.g., passphrase|inline=1}}
"cryptKeyLocation": xsd:string {{Note|key location. e.g., file path|inline=1}}
"cryptKeyStatus": xsd:string {{Note|key loaded/availability status|inline=1}}
"cryptRoot": xsd:string {{Note|key zfs root path for the encrypted share|inline=1}}
"immutabilityMode": xsd:unsignedInt {{Note|see osn__immutabilityMode for list of modes|inline=1}}
"daysOfImmutability": xsd:unsignedInt {{Note|if immutabilityMode > 0 and daysOfImmutability == 0, infinite immutability period|inline=1}}
"fullAuditEnabled": xsd:boolean
"fullAuditDefaults": xsd:boolean
"fullAuditSuccess": xsd:string
"smallBlockThreshold": xsd:unsignedInt {{Note|threshold (max) small block size in bytes that will be redirected to the special metadata offload vdev (32K recommended)|inline=1}}
"nestedName": xsd:string
"fileQuota": xsd:unsignedLong {{Note|a zero (0) quota indicates no limit/quota on number of files, a positive value indicates a quota on number of files|inline=1}}
"isMounted": xsd:boolean
"permissionMask": xsd:string {{Note|unix system mask in rwx format such as 'rwxrwxrwx' or 'rwxr--r--'|inline=1}}
"ransomwareDetectionEnabled": xsd:boolean
"hourlyModifyThreshold": xsd:unsignedLong
"hourlyDeleteThreshold": xsd:unsignedLong
"dailyModifyThreshold": xsd:unsignedLong
"dailyDeleteThreshold": xsd:unsignedLong
"thresholdAutoCalibrationEndDate": xsd:string
"includeRules": xsd:string
"excludeRules": xsd:string
"readOnly": xsd:boolean {{Note|SENSITIVE = 0, INSENSITIVE = 1, MIXED = 2|inline=1}}
"caseSensitivity": xsd:unsignedInt
"enableNfsCrossmount": xsd:boolean {{Note|Enables NFS crossmount option on the share|inline=1}}
"subPool": xsd:string {{Note|The sub-pool associated with the cephFS pool|inline=1}}
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete|inline=1}}
"subshareIdList": xsd:string
"nfsClients": [[#osn:networkShareClient|osn:networkShareClient]]
"cifsUserAccessList": [[#osn:networkShareUserAccess|osn:networkShareUserAccess]]
"cifsOptionList": [[#osn:networkShareCifsOption|osn:networkShareCifsOption]]
"backupPolicies": [[#osn:backupPolicy|osn:backupPolicy]]
}
</code>

== osn:networkShareCifsOption ==
Each [[#osn:networkShare]] has configurable SMB/CIFS options such as browsable=on, each represented by a key (eg: browsable) and a value (eg: on)

''' Fields '''
<code>
{
"networkShareId": xsd:string
"key": xsd:string
"value": xsd:string
}
</code>

== osn:networkShareClient ==
Represents an NFS access entry for a given [[#osn:networkShare]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"networkShareId": xsd:string
"hostId": xsd:string
"clientFilter": xsd:string
"readOnly": xsd:boolean
"secure": xsd:boolean
"async": xsd:boolean
"subtreeCheck": xsd:boolean
"customOptions": xsd:string
"filterPriority": xsd:unsignedInt
}
</code>

== osn:networkShareFile ==
Represents a file within a [[#osn:networkShare]]

''' Fields '''
<code>
{
"name": xsd:string
"id": xsd:string
"filePath": xsd:string
"networkShareId": xsd:string
"size": xsd:unsignedLong
}
</code>

== osn:networkShareFileLock ==
An SMB level lock on a [[#osn:networkShare]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"pid": xsd:unsignedInt
"uid": xsd:unsignedInt
"oplock": xsd:unsignedInt
"rw": xsd:unsignedInt
"networkShareId": xsd:string
"networkShareName": xsd:string
"filePath": xsd:string
"timeStamp": xsd:dateTime
}
</code>

== osn:networkShareNamespace ==
Represents a global namespace where visbility to [[#osn:networkShare]]s can be made available via a group of systems within a storage grid. Each namespace is associated with a list of systems where the shares will be presented as available and a list of shares to present. Namespaces use DFS technology for SMB connections and NFS redirects for NFS connections to route clients to the correct system where the [[#osn:networkShare]] is located.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"enableMicrosoftDfs": xsd:boolean
"enableNfsRefferals": xsd:boolean
"dfsMode": xsd:unsignedInt
"systemAssocList": [[#osn:networkShareNamespaceSystemAssoc|osn:networkShareNamespaceSystemAssoc]]
"shareAssocList": [[#osn:networkShareNamespaceShareAssoc|osn:networkShareNamespaceShareAssoc]]
}
</code>

== osn:networkShareNamespaceShareAssoc ==
Network Shares can be associated with global namespaces so that they're easier to locate by users. Each [[#osn:networkShare]] in the global namespace is associated with the namespace via a [[#osn:networkShareNamespaceShareAssoc]]. The redirectIpAddress is only used when a given [[#osn:networkShare]] is from a [[#osn:storagePool]] which does not have a HA virtual interface associated with it.

''' Fields '''
<code>
{
"networkShareId": xsd:string
"networkShareNamespaceId": xsd:string
"redirectIpAddress": xsd:string
}
</code>

== osn:networkShareNamespaceSystemAssoc ==
Represents the list of systems on which the [[#osn:networkShare]] should be visible for a given global namespace (see [[#osn:networkShareNamespace]]).

''' Fields '''
<code>
{
"storageSystemId": xsd:string
"networkShareNamespaceId": xsd:string
"preferredNetworkPortId": xsd:string
}
</code>

== osn:networkShareQuota ==
Network shares can have multiple per user/group quotas associated with them where subjectName is the name of the user or group.

''' Fields '''
<code>
{
"isGroupSpace": xsd:boolean
"subjectType": xsd:unsignedInt
"subjectName": xsd:string
"spaceUsed": xsd:unsignedLong
"spaceQuota": xsd:unsignedLong
}
</code>

== osn:networkShareServiceConfig ==
SMB and NFS configuration options for a given [[#osn:storageSystem]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"nfsMode": xsd:unsignedInt
"nfs4KerberosEnabled": xsd:boolean
"defaultOptions": xsd:string
"sambaSecurityMode": xsd:string
"realm": xsd:string
"domain": xsd:string
"kdc": xsd:string
"idmapMode": xsd:unsignedInt
"nfsKerberosMode": xsd:unsignedInt
"nfs4BrowsingDisabled": xsd:boolean
"sambaVersion": xsd:string
"allowTrustedDomains": xsd:boolean
"preserveAdUserAccessEntries": xsd:boolean
"defaultNfsSecurityPolicy": xsd:unsignedInt {{Note|see osn__nfsSecurityPolicy|inline=1}}
"nfsServerType": xsd:unsignedInt
"adJoinMode": xsd:unsignedInt
"nfsManageGids": xsd:boolean
"organizationalUnit": xsd:string
"range": xsd:string
}
</code>

== osn:networkShareSession ==
A client SMB or NFS session to a [[#osn:networkShare]]. SMB sessions provide more detailed information than NFS sessions.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"networkShareId": xsd:string
"pid": xsd:unsignedInt
"uid": xsd:unsignedInt
"gid": xsd:unsignedInt
"clientIpAddress": xsd:string
"serverIpAddress": xsd:string
"protocolVersion": xsd:string
"protocolType": xsd:unsignedInt
}
</code>

== osn:networkShareTemplate ==
list of osn__backupPolicy objects associated with this share

''' Inherits From '''
[[#osn:networkShare|osn:networkShare]]

''' Fields '''
<code>
{
"templateDescription": xsd:string
"isDefault": xsd:boolean
"settingsMask": xsd:unsignedInt
}
</code>

== osn:networkShareUserAccess ==
Represents a SMB/CIFS access entry for a given [[#osn:networkShare]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"networkShareId": xsd:string
"userId": xsd:string
"username": xsd:string
"domain": xsd:string
"userSid": xsd:string
"groupSid": xsd:string
"isGroup": xsd:boolean
"userAccessMode": xsd:unsignedInt
"posixUid": xsd:unsignedInt
"posixGid": xsd:unsignedInt
"permissions": xsd:string {{Note|POSIX ACL permissions string (e.g. rwx, r-x, r--, ---)|inline=1}}
}
</code>

== osn:nodeAssoc ==
''' Fields '''
<code>
{
"storageSystemId": xsd:string
"isRemote": xsd:boolean
}
</code>

== osn:object ==
''' Fields '''
<code>
{
"id": xsd:string
"name": xsd:string
"customId": xsd:string
"state": xsd:unsignedInt
"stateDetail": xsd:string
"type": xsd:unsignedInt
"createdTimeStamp": xsd:dateTime
"createdByUserId": xsd:string
"modifiedTimeStamp": xsd:dateTime
"modifiedByUserId": xsd:string
"isRemote": xsd:boolean
"storageSystemId": xsd:string
"ownershipRevision": xsd:unsignedInt
"internalUse": xsd:unsignedInt
"acls": [[#osn:acl|osn:acl]]
"properties": [[#osn:objectProperty|osn:objectProperty]]
}
</code>

== osn:objectProperty ==
''' Fields '''
<code>
{
"objectId": xsd:string
"objectType": xsd:unsignedInt
"key": xsd:string
"value": xsd:string
"type": xsd:unsignedInt
}
</code>

== osn:objectSyncPolicy ==
Represents ceph bucket sync policy

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string {{Note|Description of the sync group|inline=1}}
"groupStatus": xsd:unsignedInt {{Note|(enabled, allowed, forbidden)|inline=1}}
"flowDirection": xsd:unsignedInt {{Note|directional, symmetrical|inline=1}}
"flowSourceZone": xsd:string {{Note|Flow source|inline=1}}
"flowDestZone": xsd:string {{Note|Flow dest|inline=1}}
"srcBucketId": xsd:string {{Note|Source bucket|inline=1}}
"srcBucketName": xsd:string {{Note|Source bucket|inline=1}}
"destBucketName": xsd:string {{Note|Dest bucket if it is different from source bucket|inline=1}}
"srcCephClusterId": xsd:string
"destCephClusterId": xsd:string
}
</code>

== osn:passwordPolicy ==
Policy for enforcing NIST and other compliance standards to all [[#osn:user]] accounts within a given storage grid.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"allowedSpecialChars": xsd:string
"complexityReq": xsd:unsignedInt
"minLength": xsd:unsignedInt
"maxLength": xsd:unsignedInt
"allowedLoginAttemptsUntilShortLockout": xsd:unsignedInt
"allowedLoginAttemptsUntilPermLockout": xsd:unsignedInt
"daysUntilExpiration": xsd:unsignedInt
"uniquePasswordsUntilReuse": xsd:unsignedInt
"minDaysBetweenPasswordChange": xsd:unsignedInt
"minutesUntilWebAutoLogout": xsd:unsignedInt
"accountInactiveDaysUntilLockout": xsd:unsignedInt
"systemUseNotification": xsd:string
"webAccessMode": xsd:unsignedInt
"defaultLoginUsername": xsd:string
"shortLockoutSamplePeriod": xsd:unsignedInt
"permLockoutSamplePeriod": xsd:unsignedInt
"shortLockoutDuration": xsd:unsignedInt
"multiAdminApprovalTypes": xsd:string
"multiAdminApprovalCount": xsd:unsignedInt
"multiAdminApprovalExpirationHours": xsd:unsignedInt
}
</code>

== osn:pendingOperationApproval ==
''' Fields '''
<code>
{
"pendingOperationRequestId": xsd:string
"adminUuid": xsd:string
"adminName": xsd:string
"approvalTimestamp": xsd:dateTime
}
</code>

== osn:pendingOperationRequest ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"objType": xsd:string
"objUuid": xsd:string
"objName": xsd:string
"operation": xsd:string
"requestOptions": xsd:string
"requestFlags": xsd:unsignedInt
"requestInitiatorUuid": xsd:string
"requestInitiatorName": xsd:string
"requiredCount": xsd:unsignedInt
"currentCount": xsd:unsignedInt
"expiresTimestamp": xsd:dateTime
"requestStatus": xsd:unsignedInt
"requestTaskId": xsd:string
"pendingOperationApprovalList": [[#osn:pendingOperationApproval|osn:pendingOperationApproval]]
}
</code>

== osn:permissionAssignment ==
Permission definitions are assigned to [[#osn:role]]s via permission assignements.

''' Fields '''
<code>
{
"objectType": xsd:string
"operation": xsd:string
"scope": xsd:unsignedInt
}
</code>

== osn:permissionDefinition ==
QuantaStor's RBAC system provides adminitrators with the ability to give access to specific operations on specific object types. Every operation has an associated permission definition.

''' Fields '''
<code>
{
"objectType": xsd:string
"operation": xsd:string
}
</code>

== osn:physicalDisk ==
a physical disk represents a instance of some storage media in a given [[#osn:storageSystem]]. If multipathParentDiskId is set then represents a multipath path.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"devicePath": xsd:string
"altDevicePath": xsd:string
"serialNumber": xsd:string
"scsiId": xsd:string
"sasAddressPort0": xsd:string
"sasAddressPort1": xsd:string
"vpd83Id": xsd:string
"wwid": xsd:string
"deviceHBTL": xsd:string
"diskType": xsd:unsignedInt
"zoningType": xsd:unsignedInt
"partitionCount": xsd:unsignedInt
"supportsMultipath": xsd:boolean
"freeSpace": xsd:unsignedLong
"productId": xsd:string
"size": xsd:unsignedLong
"storagePoolId": xsd:string
"unitId": xsd:string
"logicalDriveId": xsd:string
"vendorId": xsd:string
"revisionLevel": xsd:string
"isSpare": xsd:boolean
"isEncrypted": xsd:boolean
"isMounted": xsd:boolean
"multipathEnabled": xsd:boolean
"ssdLifeLeft": xsd:string
"smartHealthTest": xsd:string
"driveTemp": xsd:string
"multipathParentDiskId": xsd:string
"hwDiskId": xsd:string
"hotspareMarkerId": xsd:string
"encryptionCipher": xsd:string
"passthruVolumeId": xsd:string
"sourceVolumeId": xsd:string
"hasJournal": xsd:boolean
"storagePoolDeviceId": xsd:string
"cephOsdId": xsd:string
"cephJournalGroupId": xsd:string
"correlationDeviceId": xsd:string
"correlationDeviceType": xsd:unsignedInt
"iofenceTag": xsd:string
"iofencePoolId": xsd:string
"iofenceSystemId": xsd:string
"isSsdDevice": xsd:boolean
"trimSupported": xsd:boolean
"blockSize": xsd:unsignedLong
"lastShredSignature": xsd:string
"lastShredTimeStamp": xsd:dateTime
"lastShredMode": xsd:unsignedInt
"perfTestReadBps": xsd:unsignedLong
"perfTestTimestamp": xsd:dateTime
"sedCapabilities": xsd:unsignedInt
"sedStatus": xsd:unsignedInt
"encryptionType": xsd:string
"cacheMode": xsd:unsignedInt
"compressionPercent": xsd:unsignedInt
"partitionSubDeviceCount": xsd:unsignedInt
"partitionSubDeviceParentDiskId": xsd:string
"errCountNonMedium": xsd:unsignedInt
"errCountUncorrectedRead": xsd:unsignedInt
"errCountUncorrectedWrite": xsd:unsignedInt
"pathIdList": xsd:string
}
</code>

== osn:physicalDiskHotspareMarker ==
Represents a global hot-spare which can be used to repair a Storage Pool on any system that has connectivity to the device. In this way a spare can be shared by many storage pools and multiple systems which are connected to the JBOD where the hotspare resides. Hence the hotspare marker identifies a spare by the [[#osn:physicalDisk]] serialNum and scsiId which will be the same for a given device on all systems.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"serialNumber": xsd:string
"devicePath": xsd:string
"scsiId": xsd:string
"vendorId": xsd:string
"productId": xsd:string
"size": xsd:unsignedLong
}
</code>

== osn:pingData ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"pingIpAddress": xsd:string
"pingDestType": xsd:unsignedInt
"pingIsAlive": xsd:boolean
"sourceIntfId": xsd:string
"sourceIntfName": xsd:string
"sourceIntfIpAddress": xsd:string
"sourceIntfMtu": xsd:unsignedInt
"pingRttAverage": xsd:string
"jumboFramesTest": xsd:unsignedInt
}
</code>

== osn:portalGroup ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storagePoolId": xsd:string
"description": xsd:string
"portalGroupOptions": xsd:unsignedInt
"storageVolumeIdList": xsd:string
"portAssocList": [[#osn:portalGroupPortAssoc|osn:portalGroupPortAssoc]]
}
</code>

== osn:portalGroupPortAssoc ==
list of UUIDs of associated clones osn__networkShare or osn__storageVolume snapshot objects

''' Fields '''
<code>
{
"portalGroupId": xsd:string
"portId": xsd:string
"portType": xsd:unsignedInt
}
</code>

== osn:providerApp ==
Defines an instance of a 3rd party provider integration (eg VMware VASA)

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"providerType": xsd:unsignedInt
"userAppTokenId": xsd:string
"registrationScope": xsd:unsignedInt
"nodeSystemId": xsd:string
}
</code>

== osn:provisionable ==
Base type for [[#osn:storagePool]] and [[#osn:storageTier]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"size": xsd:unsignedLong
"freeSpace": xsd:unsignedLong
}
</code>

== osn:qosPolicy ==
[[#osn:storageVolume]]s may have a QoS policy assigned to them to limit the read and write bandwidth available to a given volume. Current limiting is throughput based with separate controls for reads (qosReadBandwith) and writes (qosWriteBandwidth).

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"qosReadIops": xsd:unsignedLong
"qosWriteIops": xsd:unsignedLong
"qosReadBandwidth": xsd:unsignedLong
"qosWriteBandwidth": xsd:unsignedLong
}
</code>

== osn:replicaAssoc ==
once a [[#osn:networkShare]] or [[#osn:storageVolume]] has been replicated, a [[#osn:replicaAssoc]] instance is created to represent the relationship between the source and target resource. This is used to support rollback and to provide detailed information about when the last transfer completed and more.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"sourceStorageSystemId": xsd:string
"sourceParentId": xsd:string
"sourceId": xsd:string
"sourcePath": xsd:string
"sourceName": xsd:string
"sourceSupportsSnapshots": xsd:boolean
"targetStorageSystemId": xsd:string
"targetParentId": xsd:string
"targetId": xsd:string
"targetName": xsd:string
"targetStoragePoolId": xsd:string
"targetSupportsSnapshots": xsd:boolean
"description": xsd:string
"objectAssocType": xsd:unsignedInt
"associationType": xsd:unsignedInt
"replicationState": xsd:unsignedInt
"progress": xsd:unsignedInt
"parentReplicaAssoc": xsd:string
"syncStartedTimeStamp": xsd:dateTime
"syncCompletedTimeStamp": xsd:dateTime
"replicationProcessId": xsd:unsignedInt
"replicationScheduleId": xsd:string
"timeRemaining": xsd:string
"transferSpeed": xsd:string
"currentFileName": xsd:string
"currentFileProgress": xsd:unsignedInt
"estTotalTransfer": xsd:unsignedLong
"amountTransferred": xsd:unsignedLong
"pseudoParentTaskId": xsd:string
"taskId": xsd:string
"isResumeReplication": xsd:boolean
}
</code>

== osn:replicaReportEntry ==
Each [[#osn:replicaReportSummary]] contains a series of entries, one for each [[#osn:networkShare]] or [[#osn:storageVolume]] being replicated. This provides granular information about a specific transfer.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"sourceStorageSystemId": xsd:string
"sourceName": xsd:string
"replicationScheduleId": xsd:string
"targetStorageSystemId": xsd:string
"targetName": xsd:string
"pseudoParentTaskId": xsd:string
"summaryReportId": xsd:string
"replicationState": xsd:unsignedInt
"progress": xsd:unsignedInt
"syncStartedTimeStamp": xsd:dateTime
"syncCompletedTimeStamp": xsd:dateTime
"timeRemaining": xsd:string
"transferSpeed": xsd:string
"estTotalTransfer": xsd:unsignedLong
"amountTransferred": xsd:unsignedLong
"averageTransfer": xsd:unsignedLong
"objectEntryType": xsd:unsignedInt
}
</code>

== osn:replicaReportSummary ==
Report containing the progress and status of a given replication run of a Replication Schedule.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"sourceStorageSystemId": xsd:string
"targetProvisionableId": xsd:string
"replicationScheduleId": xsd:string
"pseudoParentTaskId": xsd:string
"replicationState": xsd:unsignedInt
"syncStartedTimeStamp": xsd:dateTime
"syncCompletedTimeStamp": xsd:dateTime
"taskCount": xsd:unsignedInt
"tasksCompleted": xsd:unsignedInt
"tasksFailed": xsd:unsignedInt
"tasksSkipped": xsd:unsignedInt
"amountTransferred": xsd:unsignedLong
"errorStatus": xsd:string
"averageTransfer": xsd:unsignedLong
"linkType": xsd:unsignedInt
"skipCount": xsd:unsignedInt
}
</code>

== osn:replicatable ==
Base type for replicatable resources like [[#osn:storageVolume]]s and [[#osn:networkShare]]s.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storagePoolId": xsd:string
"size": xsd:unsignedLong
"isSnapshot": xsd:boolean
"lazyCloneSnapshotPath": xsd:string
"snapshotParent": xsd:string
"mountPath": xsd:string
"isActiveCheckpoint": xsd:boolean
"createdBySchedule": xsd:string
"compressionRatio": xsd:string
"compressionType": xsd:string
"retentionTags": xsd:unsignedInt {{Note|see [[#enum:retentionTag]] for daily,weekly,monthly retention policies|inline=1}}
"syncPolicy": xsd:unsignedInt
"copies": xsd:unsignedInt
"spaceUtilized": xsd:unsignedLong {{Note|usedbydataset (physical) property in ZFS|inline=1}}
"logicalSpaceUtilized": xsd:unsignedLong
"spaceUtilizedBySnapshots": xsd:unsignedLong
"spaceReserved": xsd:unsignedLong
"usedByRefReservation": xsd:unsignedLong
"vvolType": xsd:unsignedInt
"vvolParentId": xsd:string
"snapshotReferenceId": xsd:string
"numHolds": xsd:unsignedInt {{Note|number of holds on a GMT snapshot used by a schedule|inline=1}}
"cachePolicyPrimary": xsd:unsignedInt {{Note|see [[#enum:cachePolicy]], default is 'all'/'auto' meaning the ARC can be used for data and metadata|inline=1}}
"cachePolicySecondary": xsd:unsignedInt {{Note|see [[#enum:cachePolicy]], default is 'all'/'auto' meaning the L2ARC can be used for data and metadata|inline=1}}
"resumeToken": xsd:string
"snapshotCount": xsd:unsignedInt
"createdByScheduleType": xsd:unsignedInt
"clones": xsd:string {{Note|list of UUIDs of associated snapshot osn__networkShare or osn__storageVolume objects|inline=1}}
"snapshotIdList": xsd:string
"cloneIdList": xsd:string
"replicaAssocList": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

== osn:replicationSchedule ==
Represents a replication schedule used to replicate one or more [[#osn:networkShare]]s and [[#osn:storageVolume]]s to a specific [[#osn:storagePool]] on a given Storage System within a grid of one or more [[#osn:storageSystem]]s.

''' Inherits From '''
[[#osn:schedule|osn:schedule]]

''' Fields '''
<code>
{
"resourceGroupId": xsd:string
"provisionableId": xsd:string
"maxReplicas": xsd:unsignedInt
"storageSystemLinkId": xsd:string
"targetResourceGroupId": xsd:string
"targetProvisionableId": xsd:string
"scheduleStatus": xsd:string
"reuseSourceSnapshot": xsd:boolean
"reuseTargetChkpnt": xsd:boolean
"retentionCountHourliesSrc": xsd:unsignedInt
"retentionCountDailiesSrc": xsd:unsignedInt
"retentionCountWeekliesSrc": xsd:unsignedInt
"retentionCountMonthliesSrc": xsd:unsignedInt
"retentionCountQuarterliesSrc": xsd:unsignedInt
"scheduleActivationVifId": xsd:string {{Note|optional Site Cluster floating VIF to associate with the schedule that will cause the schedule to activate all checkpoints with aliases in the event that the VIF moves to the target side|inline=1}}
"retentionCountSumReports": xsd:unsignedInt
"enableRecursiveNestedShares": xsd:boolean {{Note|Include nested shares|inline=1}}
"disableResumableReplication": xsd:boolean {{Note|Enables resumable replication|inline=1}}
"destSpaceUtilized": xsd:unsignedLong {{Note|Space utilized by the chkpnt|inline=1}}
"copyShareSettings": xsd:boolean {{Note|Copy source share settings to the chkpnt when doing a full replication|inline=1}}
"storageVolumeList": [[#osn:storageVolume|osn:storageVolume]]
"networkShareList": [[#osn:networkShare|osn:networkShare]]
}
</code>

== osn:replicationScheduleAssocEx ==
Represents an association betwen a replication schedule and a [[#osn:networkShare]] or [[#osn:storageVolume]

''' Fields '''
<code>
{
"replicationScheduleId": xsd:string
"replicatableId": xsd:string
"replicatableType": xsd:unsignedInt
}
</code>

== osn:report ==
A report containing a series of [[#osn:reportEntry]] each identifying some issue to be reviewed and/or addressed.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"passedCount": xsd:unsignedInt
"failedCount": xsd:unsignedInt
"reportOutput": xsd:string
"reportOutputFormat": xsd:unsignedInt {{Note|refer to osn__reportOutputFormat_t|inline=1}}
"entryList": [[#osn:reportEntry|osn:reportEntry]]
}
</code>

== osn:reportEntry ==
A configuration analysis report is comprised of a set of these entries. Each one contains details about a specific issue to be addressed and a recommended action to address it.

''' Fields '''
<code>
{
"id": xsd:string
"storageSystemId": xsd:string
"objectId": xsd:string
"objectType": xsd:unsignedInt
"timeStamp": xsd:dateTime
"title": xsd:string
"description": xsd:string
"recommendedAction": xsd:string
"reportCategory": xsd:unsignedInt
"reportImpact": xsd:unsignedInt
"reportSeverity": xsd:unsignedInt
}
</code>

== osn:reportSchedule ==
Used to periodially scrub any bit-rot in [[#osn:storagePool]]s

''' Inherits From '''
[[#osn:schedule|osn:schedule]]

''' Fields '''
<code>
{
"reportTypes": xsd:unsignedInt {{Note|see osn__reportTypes|inline=1}}
"reportToEmail": xsd:string
"reportToAlertEmails": xsd:boolean
"saveReport": xsd:boolean
"saveLocation": xsd:string
"outputFormat": xsd:unsignedInt
"maxSubdirDepth": xsd:unsignedInt
"maxSubdirsPerShare": xsd:unsignedInt
"minSubdirUsedSpace": xsd:unsignedLong
"lastReportStartTimeStamp": xsd:dateTime
"maxBuckets": xsd:unsignedInt {{Note|Limit search to maxBuckets per tenant|inline=1}}
"maxUsers": xsd:unsignedInt {{Note|Limit search to maxBuckets per user|inline=1}}
"minBucketUtilizedSpace": xsd:unsignedLong
"minUserUtilizedSpace": xsd:unsignedLong {{Note|Limit search to users with minimum utilized space.|inline=1}}
"assocList": [[#osn:reportScheduleAssoc|osn:reportScheduleAssoc]]
}
</code>

== osn:reportScheduleAssoc ==
''' Fields '''
<code>
{
"reportScheduleId": xsd:string
"reportableId": xsd:string
"reportableType": xsd:unsignedInt
}
</code>

== osn:resourceConfiguration ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"listBackupJob": [[#osn:backupJob|osn:backupJob]]
"listBackupPolicy": [[#osn:backupPolicy|osn:backupPolicy]]
"listNetworkShare": [[#osn:networkShare|osn:networkShare]]
"listNetworkShareClient": [[#osn:networkShareClient|osn:networkShareClient]]
"listNetworkShareNamespace": [[#osn:networkShareNamespace|osn:networkShareNamespace]]
"listNetworkShareSession": [[#osn:networkShareSession|osn:networkShareSession]]
"listNetworkShareUserAccess": [[#osn:networkShareUserAccess|osn:networkShareUserAccess]]
"listSnapshotReference": [[#osn:snapshotReference|osn:snapshotReference]]
"listStorageVolume": [[#osn:storageVolume|osn:storageVolume]]
"listStorageVolumeAcl": [[#osn:storageVolumeAcl|osn:storageVolumeAcl]]
}
</code>

== osn:resourceDomain ==
A node is a resource domain hierarchy. This is used to ensure fault tolerance across racks and sites by providing QuantaStor with the information needed to build Ceph CRUSH maps and Storage Pools while maintaining physcial fault tolerance at a given level like site, rack, or host

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"resourceDomainType": xsd:unsignedInt
"resourceDomainParentId": xsd:string
"description": xsd:string
"resourceAssocList": [[#osn:resourceDomainAssoc|osn:resourceDomainAssoc]]
}
</code>

== osn:resourceDomainAssoc ==
Each [[#osn:resourceDomain]] represents a site, datacenter, rack, host or other physical location entity. These are related to other resource domain instances via the [[#osn:resourceDomainAssoc]] such that a tree hierarchy is formed.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"resourceDomainId": xsd:string
"resourceId": xsd:string
"assocType": xsd:unsignedInt
}
</code>

== osn:resourceGroup ==
Resource Groups provide multi-tenancy functionality within a given Storage Grid.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"tier": xsd:string
"organization": xsd:string
"parentResourceGroupId": xsd:string
"defaultChapUsername": xsd:string
"defaultChapPassword": xsd:string
"scopeId": xsd:string {{Note|If left empty, scope is system|inline=1}}
"scopeType": xsd:unsignedInt {{Note|enum containerScope: local pool, HA pool or cephFS|inline=1}}
"resourceAssocList": [[#osn:resourceGroupResourceAssoc|osn:resourceGroupResourceAssoc]]
"subjectAssocList": [[#osn:resourceGroupSubjectAssoc|osn:resourceGroupSubjectAssoc]]
"networkList": [[#osn:resourceGroupNetwork|osn:resourceGroupNetwork]]
}
</code>

== osn:resourceGroupNetwork ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"resourceGroupId": xsd:string
"bindAddress": xsd:string
}
</code>

== osn:resourceGroupResourceAssoc ==
A resource like a Storage Volume associated with a Resource Group

''' Fields '''
<code>
{
"resourceGroupId": xsd:string
"objectId": xsd:string
"objectType": xsd:unsignedInt
"accessMode": xsd:unsignedInt
}
</code>

== osn:resourceGroupSubjectAssoc ==
''' Fields '''
<code>
{
"resourceGroupId": xsd:string
"subjectId": xsd:string
"subjectType": xsd:unsignedInt
}
</code>

== osn:resourceHealthCheck ==
''' Fields '''
<code>
{
"id": xsd:string
"name": xsd:string
"type": xsd:unsignedInt
"state": xsd:unsignedInt
"stateDetail": xsd:string
}
</code>

== osn:role ==
A security role for the management of QuantaStor systems. A role is associated with [[#osn:user]]s and some set of permissions which scopes what operations they are allowed to do.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"wuiTabDisable": xsd:unsignedInt
"wuiSectionDisable": xsd:unsignedInt
"ldapGroup": xsd:string
"permissionList": [[#osn:rolePermissionAssignment|osn:rolePermissionAssignment]]
"subjectAssocList": [[#osn:roleSubjectAssoc|osn:roleSubjectAssoc]]
}
</code>

== osn:rolePermissionAssignment ==
A permission assignment to a role.

''' Inherits From '''
[[#osn:permissionAssignment|osn:permissionAssignment]]

''' Fields '''
<code>
{
"roleId": xsd:string
}
</code>

== osn:roleSubjectAssoc ==
Represents a [[#osn:user]] assigned to a specific [[#osn:role]]

''' Fields '''
<code>
{
"roleId": xsd:string
"subjectId": xsd:string
}
</code>

== osn:s3Object ==
Ceph Buckets are repositories for S3 objects just the same as AWS buckets

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"bucketId": xsd:string
"size": xsd:unsignedLong
"accountedSize": xsd:unsignedLong
"owner": xsd:string
"ownerDisplayName": xsd:string
"contentType": xsd:string
"etag": xsd:string
"tag": xsd:string
"versionedEpoch": xsd:unsignedLong
}
</code>

== osn:s3Proxy ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"proxyServerName": xsd:string
"proxyLocationEndpoint": xsd:string
"sslCertificate": xsd:string
"sslCertificateKey": xsd:string
"portNums": xsd:string
}
</code>

== osn:s3Tenant ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"displayName": xsd:string
"utilizedSpace": xsd:unsignedLong
"bucketCount": xsd:unsignedInt
"cephClusterId": xsd:string
"objectCount": xsd:unsignedLong
"s3UserIdList": xsd:string
}
</code>

== osn:s3User ==
A user access key and secret key used to provide users with access to S3 object storage via a RADOS gateway.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"displayName": xsd:string {{Note|eg: Coca Cola, Pepsi Co|inline=1}}
"emailAddress": xsd:string {{Note|eg: sam.smith@example.com|inline=1}}
"operationMask": xsd:unsignedInt {{Note|see osn__s3UserOpMask_t|inline=1}}
"accessSuspended": xsd:boolean {{Note|'true' if user access is suspended.|inline=1}}
"tenant": xsd:string {{Note|optional - name of the associated tenant|inline=1}}
"tenantId": xsd:string {{Note|optional - id of the associated S3 tenant object|inline=1}}
"maxBuckets": xsd:unsignedInt
"utilizedSpace": xsd:unsignedLong
"bucketCount": xsd:unsignedInt
"userQuotaMaxObjectsEnable": xsd:boolean
"userQuotaMaxObjects": xsd:unsignedLong
"userQuotaMaxSizeEnable": xsd:boolean
"userQuotaMaxSize": xsd:unsignedLong
"bucketQuotaMaxObjectsEnable": xsd:boolean
"bucketQuotaMaxObjects": xsd:unsignedLong
"bucketQuotaMaxSizeEnable": xsd:boolean
"bucketQuotaMaxSize": xsd:unsignedLong
"objectCount": xsd:unsignedLong
"s3UserAccessKeyIdList": xsd:string
}
</code>

== osn:s3UserAccessKey ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"cephClusterId": xsd:string
"s3UserId": xsd:string
"user": xsd:string
"accessKey": xsd:string
"secretKey": xsd:string
"accessKeyType": xsd:unsignedInt
}
</code>

== osn:schedule ==
Base type for snapshot schedules, replication schedules, and backup policies which is managed by the QuantaStor schedule manager in the core service.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"daysOfWeek": xsd:unsignedInt
"hoursOfDay": xsd:unsignedInt
"startDate": xsd:dateTime
"isEnabled": xsd:boolean
"reserved": xsd:unsignedInt
"reservedData": xsd:string
"scheduleType": xsd:unsignedInt
"delayInterval": xsd:unsignedInt
"offsetMinutes": xsd:unsignedInt
"retentionCountHourlies": xsd:unsignedInt
"retentionCountDailies": xsd:unsignedInt
"retentionCountWeeklies": xsd:unsignedInt
"retentionCountMonthlies": xsd:unsignedInt
"retentionCountQuarterlies": xsd:unsignedInt
}
</code>

== osn:serviceFirewallDef ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"tcpPort": xsd:string
"udpPort": xsd:string
"protocolBitMask": xsd:unsignedInt
"description": xsd:string
}
</code>

== osn:session ==
An iSCSI or FC session associated with a [[#osn:storageVolume]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storageVolumeId": xsd:string
"sessionNum": xsd:string
"targetId": xsd:unsignedInt
"connectionId": xsd:unsignedInt
"lun": xsd:unsignedInt
"targetIqn": xsd:string
"initiatorIqn": xsd:string
"reads": xsd:unsignedLong
"writes": xsd:unsignedLong
"readBytes": xsd:unsignedLong
"writeBytes": xsd:unsignedLong
"initiatorIpAddress": xsd:string
"connectionState": xsd:string
}
</code>

== osn:singleSignOnPolicy ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"isEnabled": xsd:boolean
"ldapServer": xsd:string
"ldapBaseDn": xsd:string
}
</code>

== osn:siteCluster ==
Site Clusters manage floating virtual network interfaces, also known as [[#osn:siteVifResource]]s. When a system is taken offline all the of VIFs on that system will automatically move to another system within a given Site Cluster. When that happens it will trigger a [[#osn:storagePool]] HA failover if the VIF was associated with a Storage Pool.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"location": xsd:string
"description": xsd:string
"clusterStatus": xsd:string
"currentDc": xsd:string
"corosyncVersion": xsd:string
"maintenanceModeEnabled": xsd:boolean
"siteClusterAssocList": [[#osn:siteClusterAssoc|osn:siteClusterAssoc]]
"ringList": [[#osn:clusterRing|osn:clusterRing]]
"vifResources": [[#osn:siteVifResource|osn:siteVifResource]]
}
</code>

== osn:siteClusterAssoc ==
Association between a system and a site cluster.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"siteClusterId": xsd:string
"nodeSystemId": xsd:string
"corosyncNodeId": xsd:string
"stack": xsd:string
"nodesConfigured": xsd:unsignedInt
"expectedVotes": xsd:unsignedInt
"onlineNodes": xsd:unsignedInt
"offlineNodes": xsd:unsignedInt
"resourcesConfigured": xsd:unsignedInt
"standbyState": xsd:unsignedInt {{Note|0=not standby, 1=standby, 2=manual standby|inline=1}}
}
</code>

== osn:siteVifLocationConstraint ==
''' Fields '''
<code>
{
"siteVifId": xsd:string
"nodeSystemId": xsd:string
"siteClusterId": xsd:string
"weight": xsd:unsignedInt
}
</code>

== osn:siteVifResource ==
Represents a virtual interface which can float between two or more systems in a [[#osn:siteCluster]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"siteClusterId": xsd:string {{Note|UUID of the Site Cluster the VIF is associated with|inline=1}}
"parentInterfaceName": xsd:string {{Note|name of the physical port this resource will attach to when started, eg: eth0|inline=1}}
"tag": xsd:string {{Note|name of the VIF resource, eg: gridIP or sv00001|inline=1}}
"ipAddress": xsd:string {{Note|IP address to associated with the VIF resource when it is started 10.0.0.10|inline=1}}
"subnetMask": xsd:string {{Note|Subnet mask for the VIF IP address, eg: 255.255.0.0|inline=1}}
"mtu": xsd:unsignedInt {{Note|Maximum transmissible unit, inherited from the underlying physical port|inline=1}}
"gateway": xsd:string {{Note|Gateway for the VIF, generally not used|inline=1}}
"firewallMask": xsd:unsignedInt {{Note|Firewall rule mask for the port|inline=1}}
"firewallForceAllowMask": xsd:unsignedInt {{Note|Firewall allow rule mask for the port|inline=1}}
"fqdn": xsd:string {{Note|Fully qualified domain name (FQDN) to be associated with the VIF and stored in the /etc/hosts|inline=1}}
"macAddress": xsd:string
"iscsiEnabled": xsd:boolean
"nvmeofEnabled": xsd:boolean
"startedOn": xsd:string {{Note|Name of the node/system where the resource has started|inline=1}}
"useCase": xsd:unsignedInt {{Note|See osn__vifUseCase_t enum|inline=1}}
"useCaseObjId": xsd:string {{Note|depending on the useCase, could be ceph cluster, ha group, s3proxy, etc|inline=1}}
"isUnmanaged": xsd:boolean {{Note|indicates the resources are in the 'unmanaged' state where the cluster will not move, start or stop them|inline=1}}
"locationConstraintList": [[#osn:siteVifLocationConstraint|osn:siteVifLocationConstraint]]
}
</code>

== osn:snapshotReference ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"isProtected": xsd:boolean
"parentId": xsd:string
"imageId": xsd:string
"snapType": xsd:unsignedInt
"spaceUtilized": xsd:unsignedLong
}
</code>

== osn:snapshotSchedule ==
A snapshot [[#osn:schedule]] which runs periodially either on a set delay interval in minutes.

''' Inherits From '''
[[#osn:schedule|osn:schedule]]

''' Fields '''
<code>
{
"resourceGroupId": xsd:string
"provisionableId": xsd:string
"maxSnapshots": xsd:unsignedInt
"enableRecursiveNestedShares": xsd:boolean {{Note|Include nested shares|inline=1}}
"storageVolumeList": [[#osn:storageVolume|osn:storageVolume]]
"networkShareList": [[#osn:networkShare|osn:networkShare]]
}
</code>

== osn:snapshotScheduleAssoc ==
''' Fields '''
<code>
{
"snapshotScheduleId": xsd:string
"storageVolumeId": xsd:string
"assocType": xsd:unsignedInt
}
</code>

== osn:storagePool ==
Represents a group of storage devices which have been combined together for fault-tolerance using RAID or Erasure-coding technology.

''' Inherits From '''
[[#osn:provisionable|osn:provisionable]]

''' Fields '''
<code>
{
"chunkSize": xsd:unsignedLong
"description": xsd:string
"devicePath": xsd:string
"devicesActive": xsd:unsignedInt
"devicesFailed": xsd:unsignedInt
"devicesWorking": xsd:unsignedInt
"devicesSpare": xsd:unsignedInt
"devicesRaid": xsd:unsignedInt
"devicesTotal": xsd:unsignedInt
"intentBitmap": xsd:string
"isDefault": xsd:boolean
"enableCompression": xsd:boolean
"enableDeduplication": xsd:boolean
"enableAutoTrim": xsd:boolean
"isActive": xsd:boolean
"isMounted": xsd:boolean
"isDegraded": xsd:boolean
"isRecovering": xsd:boolean
"isResyncing": xsd:boolean
"isReshaping": xsd:boolean
"metadataPath": xsd:string
"metadataVersion": xsd:string
"mountPath": xsd:string
"legacyUuid": xsd:string
"status": xsd:string
"percentComplete": xsd:unsignedInt
"scanStatus": xsd:string
"scanSpeed": xsd:string
"integrityStatus": xsd:string
"recommendedAction": xsd:string
"poolType": xsd:unsignedInt
"raidType": xsd:unsignedInt
"raidTypeInternal": xsd:unsignedInt
"raidSetSize": xsd:unsignedInt
"rawSize": xsd:unsignedLong
"rawUtilizedSize": xsd:unsignedLong
"rebuildEstimateInMin": xsd:unsignedInt
"requiresFsGrow": xsd:boolean
"percentProvisioned": xsd:unsignedInt
"hotspareRepairPolicy": xsd:unsignedInt
"hotspareRepairState": xsd:unsignedInt
"lastRepairActionTimeStamp": xsd:dateTime
"disableAutoStart": xsd:boolean
"compressionRatio": xsd:string
"compressionType": xsd:string
"syncPolicy": xsd:unsignedInt
"copies": xsd:unsignedInt
"aclType": xsd:unsignedInt
"cephClusterId": xsd:string
"markedDisabled": xsd:boolean
"profileId": xsd:string
"isEncrypted": xsd:boolean
"requiresKeyPassphrase": xsd:boolean
"encryptionType": xsd:string
"keyServerType": xsd:unsignedInt
"enclosureRedundancy": xsd:unsignedInt
"keyServerProfileId": xsd:string
"errCountReads": xsd:unsignedInt
"errCountWrites": xsd:unsignedInt
"errCountChecksums": xsd:unsignedInt
"trimSupported": xsd:boolean
"cachePolicyPrimary": xsd:unsignedInt
"cachePolicySecondary": xsd:unsignedInt
"smallBlockThreshold": xsd:unsignedInt
"isExtensibleDataset": xsd:boolean
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete|inline=1}}
"checkpointEnabled": xsd:boolean
"checkpointCreationTimestamp": xsd:dateTime
"checkpointExpirationTimestamp": xsd:dateTime
"storagePoolDeviceList": [[#osn:storagePoolDevice|osn:storagePoolDevice]]
"storagePoolHaGroupList": [[#osn:storagePoolHaFailoverGroup|osn:storagePoolHaFailoverGroup]]
"storagePoolDeviceGroupList": [[#osn:storagePoolDeviceGroup|osn:storagePoolDeviceGroup]]
}
</code>

== osn:storagePoolDevice ==
Represents a device within a [[#osn:storagePool]]. Each device is associated with a [[#osn:physicalDisk]. Devices may be used for data, metadata, write logging, and more.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storagePoolId": xsd:string
"physicalDiskId": xsd:string
"physicalDiskSerialNumber": xsd:string
"physicalDiskScsiId": xsd:string
"devicePath": xsd:string
"partitionNumber": xsd:unsignedInt
"number": xsd:unsignedInt
"majorNum": xsd:unsignedInt
"minorNum": xsd:unsignedInt
"raidDeviceNum": xsd:unsignedInt
"isActive": xsd:boolean
"isSync": xsd:boolean
"isRebuilding": xsd:boolean
"isRemoved": xsd:boolean
"isFaulty": xsd:boolean
"isSpare": xsd:boolean
"isCache": xsd:boolean
"isVirtual": xsd:boolean
"cacheType": xsd:unsignedInt
"raidGroupId": xsd:string
"size": xsd:unsignedLong
"enclosure": xsd:string
"slot": xsd:string
"cephClusterId": xsd:string
"storagePoolDeviceGroupId": xsd:string
"errCountReads": xsd:unsignedInt
"errCountWrites": xsd:unsignedInt
"errCountChecksums": xsd:unsignedInt
"trimSupported": xsd:boolean
"trimStatus": xsd:unsignedInt
"physicalDiskObj": [[#osn:physicalDisk|osn:physicalDisk]]
}
</code>

== osn:storagePoolDeviceGroup ==
Represents a group of devices in a [[#osn:storagePool]] which makes up a stripe set (VDEV in ZFS terminology)

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storagePoolId": xsd:string
"groupType": xsd:unsignedInt
"raidLevel": xsd:string
"enclosureRedundant": xsd:boolean
"errCountReads": xsd:unsignedInt
"errCountWrites": xsd:unsignedInt
"errCountChecksums": xsd:unsignedInt
"size": xsd:unsignedLong
"allocSize": xsd:unsignedLong
"freeSize": xsd:unsignedLong
"storagePoolDeviceIdList": xsd:string
}
</code>

== osn:storagePoolHaFailoverGroup ==
Storage Pools can be made highly-available by creating a [[#osn:storagePoolHaFailoverGroup]]. The [[#osn:storagePool]] must be comprised of storage devices which are accessible by two QuantaStor servers which generally implies that the devices are SAS, FC, or dual-ported NVMe devices.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"storagePoolId": xsd:string
"primaryStorageSystemId": xsd:string
"secondaryStorageSystemId": xsd:string
"tertiaryStorageSystemId": xsd:string
"activeStorageSystemId": xsd:string
"failoverModuleId": xsd:string
"lastFailoverTimeStamp": xsd:dateTime
"settleTimeInSec": xsd:unsignedInt
"isActive": xsd:boolean
"encryptionKeyData": xsd:string
"encryptionKeyPath": xsd:string
"verifyClientIps": xsd:string
"deviceSerialNumbers": xsd:string
"haClientFailoverPolicy": xsd:unsignedInt
"haLinkStateFailoverPolicy": xsd:unsignedInt
"haFcLinkStateFailoverPolicy": xsd:unsignedInt
"exportTimeout": xsd:unsignedInt {{Note|maximum amount of time (in seconds) allocated for export of the pool as part of an HA failover sequence. If the timeout expires the aquiring system takes preemptive locks on the devices in order to start the pool import process and the exporting system will need a reboot.|inline=1}}
"encryptionKeySaltData": xsd:string
"encryptionKeySaltPath": xsd:string
"keyServerProfileId": xsd:string
"keyServerType": xsd:unsignedInt
"enforceSmbHostsAllow": xsd:boolean
"enforceNfsHostsAllow": xsd:boolean
"interfaceList": [[#osn:storagePoolHaFailoverInterface|osn:storagePoolHaFailoverInterface]]
}
</code>

== osn:storagePoolHaFailoverInterface ==
Represents a High-Availability Interface which is associated with a [[#osn:storagePool]] via a [[#osn:storagePoolHaFailoverGroup]].

''' Inherits From '''
[[#osn:siteVifResource|osn:siteVifResource]]

''' Fields '''
<code>
{
"failoverGroupId": xsd:string
}
</code>

== osn:storagePoolProfile ==
Pool profiles provide a set of tunings to be applied to the disks within a given [[#osn:storagePool]]. These can be changed at any time via [[storagePoolModify]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"tag": xsd:string
"description": xsd:string
"nrRequests": xsd:unsignedInt
"readAheadKb": xsd:unsignedInt
"fifoBatch": xsd:unsignedInt
"chunkSizeKb": xsd:unsignedInt
"scheduler": xsd:string
"nrRequestsMultiplier": xsd:unsignedInt
"minTargetDriverThreads": xsd:unsignedInt
"minTargetDriverTasklets": xsd:unsignedInt
"nrRequestsSsd": xsd:unsignedInt
"readAheadKbSsd": xsd:unsignedInt
"fifoBatchSsd": xsd:unsignedInt
"schedulerSsd": xsd:string
"nrRequestsMultiplierSsd": xsd:unsignedInt
"nrRequestsNvme": xsd:unsignedInt
"readAheadKbNvme": xsd:unsignedInt
"fifoBatchNvme": xsd:unsignedInt
"schedulerNvme": xsd:string
"nrRequestsMultiplierNvme": xsd:unsignedInt
}
</code>

== osn:storageQuota ==
Resource Groups ([[#osn:resourceGroup]]) provide multitenancy capabiliites. Within a Resource Group a provisioning quota may be added to allow its user members to provision a limited amount of storage from a specific [[#osn:storagePool]]. Each time a [[#osn:storageVolume]] or [[#osn:networkShare]] is provisioned it's associated with a storage provisioning quota [[#osn:storageQuota].

''' Inherits From '''
[[#osn:provisionable|osn:provisionable]]

''' Fields '''
<code>
{
"description": xsd:string
"storagePoolId": xsd:string
"resourceGroupId": xsd:string
"utilizationLimit": xsd:unsignedLong
"utilizedSpace": xsd:unsignedLong
"maxVolumes": xsd:unsignedInt
"maxShares": xsd:unsignedInt
"policyFlags": xsd:unsignedInt
"volumeAssocList": [[#osn:storageQuotaVolumeAssoc|osn:storageQuotaVolumeAssoc]]
"shareAssocList": [[#osn:storageQuotaShareAssoc|osn:storageQuotaShareAssoc]]
}
</code>

== osn:storageQuotaShareAssoc ==
''' Fields '''
<code>
{
"storageQuotaId": xsd:string
"shareId": xsd:string
}
</code>

== osn:storageQuotaVolumeAssoc ==
''' Fields '''
<code>
{
"storageQuotaId": xsd:string
"storageVolumeId": xsd:string
}
</code>

== osn:storageSystem ==
Represents a QuantaStor storage system which could be installed on physical or virtual server hardware.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"location": xsd:string
"enclosureLayoutId": xsd:string
"firmwareVersion": xsd:string
"productId": xsd:string
"serialNumber": xsd:string
"serviceVersion": xsd:string
"vendorId": xsd:string
"startupTimeStamp": xsd:dateTime
"kernelVersion": xsd:string
"nfsdServiceStatus": xsd:string
"smbdServiceStatus": xsd:string
"nmbdServiceStatus": xsd:string
"iscsiServiceStatus": xsd:string
"hadoopServiceStatus": xsd:string
"zfsServiceStatus": xsd:string
"cephServiceStatus": xsd:string
"searchSuffix": xsd:string
"domainSuffix": xsd:string
"dnsNameservers": xsd:string
"externalHostName": xsd:string
"gridPreferredPort": xsd:string
"corosyncStartTimeStamp": xsd:dateTime
"arpFilterStatus": xsd:unsignedInt
"arpFilterMode": xsd:unsignedInt
"bondMode": xsd:unsignedInt
"storageSystemClusterId": xsd:string
"clusterTargetPortId": xsd:string
"isMaster": xsd:boolean
"requiresReboot": xsd:boolean
"storageLinkId": xsd:string
"packageVerService": xsd:string
"packageVerManager": xsd:string
"packageVerTomcat": xsd:string
"packageVerTarget": xsd:string
"packageVerRest": xsd:string
"iscsiInitiatorIqn": xsd:string
"ntpServers": xsd:string
"timeZone": xsd:string
"distroVersion": xsd:string
"cephVersion": xsd:string
"multipathConfigMode": xsd:unsignedInt
"logCollectionMode": xsd:unsignedInt
"hwAutoMaintenanceMode": xsd:unsignedInt
"fipsState": xsd:unsignedInt
"fipsStateDetail": xsd:string
"networkShareServiceConfig": [[#osn:networkShareServiceConfig|osn:networkShareServiceConfig]]
"hwConfig": [[#osn:storageSystemHwConfig|osn:storageSystemHwConfig]]
"firewallMask": xsd:unsignedInt {{Note|Disable bit mask for protocols (NFS,SMB etc) based on qs_services_firewall.conf.|inline=1}}
"disableIoFencing": xsd:boolean {{Note|Used to disable IO fencing logic on scale-out systems or single node ZFS systems that don't need it.|inline=1}}
"disableMediaBeaconManagement": xsd:boolean {{Note|Used to disable disk identification/blink manager|inline=1}}
"wwnEmulationMode": xsd:unsignedInt
"proxyUrlHttp": xsd:string
"proxyUrlHttps": xsd:string
"proxyUrlNoProxy": xsd:string
"serviceOptionsMask": xsd:unsignedInt {{Note|Used to enable/disable certain services, such as Blink Manager etc|inline=1}}
"enableTelemetry": xsd:boolean
"targetPortIdList": xsd:string
"fcTargetPortIdList": xsd:string
"ibTargetPortIdList": xsd:string
"dnsServerList": xsd:string
}
</code>

== osn:storageSystemCluster ==
Represents a Storage Grid but uses the name storageSystemCluster for legacy reasons. A Storage Grid is a group of QuantaStor storage systems which can span racks, sites, and clouds.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"masterNodeId": xsd:string
"clusterPassword": xsd:string
"storageSystemIdList": xsd:string
}
</code>

== osn:storageSystemClusterAssoc ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storageSystemClusterId": xsd:string
}
</code>

== osn:storageSystemHwConfig ==
Contains all the hardware configuration information about a given [[#osn:storageSystem]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"systemManufacturer": xsd:string
"systemProduct": xsd:string
"systemSerialNumber": xsd:string
"systemManufacturerId": xsd:unsignedInt
"systemProductId": xsd:unsignedInt
"systemTemp": xsd:unsignedInt
"systemMemoryTotal": xsd:unsignedLong
"coreCount": xsd:unsignedInt
"cpuCount": xsd:unsignedInt
"cpuModel": xsd:string
"cpuTopTemp": xsd:unsignedInt
"cpuAvgTemp": xsd:unsignedInt
"pchTemp": xsd:unsignedInt
"powerSupplyCount": xsd:unsignedInt
"powerSupplyHealth": xsd:unsignedInt
"fanCount": xsd:unsignedInt
"fanHealth": xsd:unsignedInt
"ipmiFirmwareVersion": xsd:string
"ipmiIpAddress": xsd:string
"ipmiSubnetMask": xsd:string
"ipmiMacAddress": xsd:string
"ipmiGateway": xsd:string
"memoryEccType": xsd:unsignedInt
"currentPowerWatts": xsd:unsignedInt
}
</code>

== osn:storageSystemLink ==
Link between two [osn:storageSystem]s which contains information necessary for remote-replication of [[#osn:storageVolume]]s and [[#osn:networkShare]]s.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"remoteStorageSystemId": xsd:string
"remoteIpAddress": xsd:string
"remoteAdminUser": xsd:string
"remoteAdminPasswordToken": xsd:string
"publicKey": xsd:string
"localIpAddress": xsd:string
"bandwidthLimit": xsd:unsignedInt
"linkType": xsd:unsignedInt
"linkStatus": xsd:unsignedInt
"storageSystemLinkKeyId": xsd:string
"replicaAssocList": [[#osn:replicaAssoc|osn:replicaAssoc]]
}
</code>

== osn:storageSystemLinkKey ==
Security key associated with a given remote replication [[#osn:storageSystemLink]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storageSystemLinkId": xsd:string
"publicKey": xsd:string
"privateKey": xsd:string
}
</code>

== osn:storageSystemRecoveryPoint ==
QuantaStor automatically does a backup of its internal database [[#osn:storagePool]]s on a system every hour. These provide recovery points in cases where the configuration database needs to be rolled back. This is usually done after a clean ISO installation of QuantaStor on a system that has one or more storage pools. QuantaStor's internal database is forward and backward compatible with newer/older versions of the QuantaStor service.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"filePath": xsd:string
"fileName": xsd:string
"fileSize": xsd:unsignedLong
}
</code>

== osn:storageSystemTunable ==
System wide configuration tunable, typically used to adjust ZFS filesystem parameters but more broadly includes other things like network queue sizes and more. Each tunable represents a different element of the system that may be adjusted.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"title": xsd:string
"description": xsd:string
"dataType": xsd:unsignedInt
"dataValue": xsd:unsignedLong
"dataValueMin": xsd:unsignedLong
"dataValueMax": xsd:unsignedLong
"dataValueDefault": xsd:unsignedLong
"tab": xsd:string {{Note|WUI placement location, example: pool_settings|inline=1}}
"tabIndex": xsd:unsignedInt
"paramPath": xsd:string {{Note|example /sys/module/zfs/parameters/zfs_vdev_aggregation_limit|inline=1}}
"moduleConfPath": xsd:string {{Note|path to /etc/modules.d/ config file|inline=1}}
"paramSizeUnits": xsd:unsignedInt
"displaySizeUnits": xsd:unsignedInt
"rounding": xsd:unsignedInt
}
</code>

== osn:storageSystemTunableAssoc ==
''' Fields '''
<code>
{
"id": xsd:string
"tunableProfileId": xsd:string
"dataParam": xsd:string
"dataValue": xsd:unsignedInt
}
</code>

== osn:storageSystemTunableProfile ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"tunableAssocList": [[#osn:storageSystemTunableAssoc|osn:storageSystemTunableAssoc]]
}
</code>

== osn:storageTier ==
In larger configurations with many [[#osn:storagePool]]s it can be difficult to select the optimal [[#osn:storagePool]] without first looking at each one to determine which one has the most free space and has the right characteristics. Storage Provisioning Tiers provide a way to easily group together pools to simplify provisioning in large configurations. Each [[#osn:storageTier]] may be associated with one or more [[#osn:storagePool]]s. When provisioning a new [[#osn:storageVolume]] or [[#osn:networkShare]] a Storage Tier ID may be specified instead of a specific [[#osn:storagePool]]. In such a case QuantaStor will automatically select the optimal pool for a given provisioning request.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"performanceLevel": xsd:unsignedInt
"storageType": xsd:unsignedInt
"storageClass": xsd:string
"description": xsd:string
"storageTierAssocList": [[#osn:storageTierAssoc|osn:storageTierAssoc]]
}
</code>

== osn:storageTierAssoc ==
''' Fields '''
<code>
{
"storageTierId": xsd:string
"storagePoolId": xsd:string
}
</code>

== osn:storageVolume ==
Represents a block storage device that can be presented to one or more hosts as a LUN. Storage Volumes must be assigned to a [[#osn:host]] before they are accessible via iSCSI and/or FC.

''' Inherits From '''
[[#osn:replicatable|osn:replicatable]]

''' Fields '''
<code>
{
"accessMode": xsd:unsignedInt {{Note|read-write or read-only|inline=1}}
"description": xsd:string {{Note|user specified description field|inline=1}}
"devicePath": xsd:string {{Note|internal block device path|inline=1}}
"iqn": xsd:string {{Note|iSCSI target IQN of the Storage Volume|inline=1}}
"isCloudBackup": xsd:boolean {{Note|DEPRECATED, was used by Cloud Backup Schedule|inline=1}}
"useGuidIqn": xsd:boolean
"lun": xsd:unsignedInt {{Note|FC only, LUN number of the Storage Volume, else 0.|inline=1}}
"cloudContainerId": xsd:string {{Note|DEPRECATED, was used by Cloud Backup Schedule|inline=1}}
"target": xsd:unsignedInt {{Note|FC only|inline=1}}
"relativeTargetId": xsd:unsignedInt {{Note|FC only|inline=1}}
"volumeType": xsd:unsignedInt {{Note|indicates scale-up vs scale-out type storage volume|inline=1}}
"chapPolicy": xsd:unsignedInt {{Note|iSCSI CHAP policy indicating volume, user, and resource group levels.|inline=1}}
"blockSizeKb": xsd:unsignedInt {{Note|block size of the device as presented as Physical Block Size in VMware|inline=1}}
"chapUsername": xsd:string {{Note|iSCSI CHAP username when specified on a per volume basis|inline=1}}
"chapPassword": xsd:string {{Note|iSCSI CHAP password when specified on a per volume basis|inline=1}}
"storageLinkId": xsd:string {{Note|DEPRECATED, XenServer Storage Link unique ID|inline=1}}
"deviceDescriptor": xsd:string {{Note|SCSI-3 mode page 83 unique ID|inline=1}}
"enableWriteCache": xsd:boolean {{Note|Indicates target driver wb caching policy, is always disabled but can be overridden via configuration file for testing purposes|inline=1}}
"accessTimeStamp": xsd:dateTime
"qosReadIops": xsd:unsignedLong {{Note|DEPRECATED, QoS limitations are currently only bandwidth based|inline=1}}
"qosWriteIops": xsd:unsignedLong {{Note|DEPRECATED, QoS limitations are currently only bandwidth based|inline=1}}
"qosReadBandwidth": xsd:unsignedLong {{Note|Specific QoS setting to limit read bandwidth, 0 indicates no limiting|inline=1}}
"qosWriteBandwidth": xsd:unsignedLong {{Note|Specific QoS setting to limit write bandwidth, 0 indicates no limiting|inline=1}}
"qosPolicyId": xsd:string {{Note|QoS policy applied to limit read/write bandwidth|inline=1}}
"eui": xsd:string {{Note|EUI format identifier for the volume|inline=1}}
"lunAssignmentPolicy": xsd:unsignedInt {{Note|For FC access, indicates the LUN number assignment policy 0=OSN_CMN_LUN_ASSIGN_DYNAMIC, 1=OSN_CMN_LUN_ASSIGN_STATIC|inline=1}}
"cephClusterId": xsd:string {{Note|Ceph RBD only, this is the Ceph Cluster UUID where the volume resides|inline=1}}
"profileId": xsd:string {{Note|Indicates the Storage Volume I/O optimization profile applied to this volume|inline=1}}
"stripeSizeKb": xsd:unsignedInt {{Note|Ceph RBD only|inline=1}}
"stripeCount": xsd:unsignedInt {{Note|Ceph RBD only|inline=1}}
"mappingDisabled": xsd:boolean {{Note|Ceph RBD only, indicates that the device is not accessible via iSCSI/FC and may only be used for direct exclusive client RBD mapping from external hosts. This property cannot be changed after the volume has been created.|inline=1}}
"portalGroupId": xsd:string
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete|inline=1}}
"namespaceName": xsd:string {{Note|Ceph RBD only, indicates the namespace name where the volume resides|inline=1}}
}
</code>

== osn:storageVolumeAcl ==
An access control assignment of a [[#osn:storageVolume]] to a [[#osn:host]] or [[#osn:hostGroup]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"hostId": xsd:string
"hostObjType": xsd:unsignedInt
"storageVolumeId": xsd:string
"storageVolumeObjType": xsd:unsignedInt
}
</code>

== osn:storageVolumeGroup ==
Represents a group of [[#osn:storageVolume]]s. Once grouped they can be snapshot as a set.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"volumeAssocList": [[#osn:storageVolumeGroupAssoc|osn:storageVolumeGroupAssoc]]
}
</code>

== osn:storageVolumeGroupAssoc ==
''' Fields '''
<code>
{
"storageVolumeGroupId": xsd:string
"storageVolumeId": xsd:string
}
</code>

== osn:storageVolumeProfile ==
Pool profiles provide a set of tunings to be applied to the disks within a given [[#osn:storagePool]]. These can be changed at any time via [[storagePoolModify]].

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"tag": xsd:string
"description": xsd:string
"blockSizeKb": xsd:unsignedInt
"iscsiQueuedCommands": xsd:unsignedInt
"iscsiFirstBurstLength": xsd:unsignedInt
"iscsiMaxBurstLength": xsd:unsignedInt
"iscsiMaxRecvDataSegmentLength": xsd:unsignedInt
"iscsiMaxXmitDataSegmentLength": xsd:unsignedInt
}
</code>

== osn:storageVolumeUtilization ==
Records daily information about [[#osn:storageVolume]] utilization over time which can then be used for charge-back accounting.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"storageVolumeId": xsd:string
"size": xsd:unsignedLong
"sizeUtilized": xsd:unsignedLong
"ioTotal": xsd:unsignedLong
"ioReadsTotal": xsd:unsignedLong
"ioWritesTotal": xsd:unsignedLong
"ioReads00": xsd:unsignedInt
"ioReads01": xsd:unsignedInt
"ioReads02": xsd:unsignedInt
"ioReads03": xsd:unsignedInt
"ioReads04": xsd:unsignedInt
"ioReads05": xsd:unsignedInt
"ioReads06": xsd:unsignedInt
"ioReads07": xsd:unsignedInt
"ioReads08": xsd:unsignedInt
"ioReads09": xsd:unsignedInt
"ioReads10": xsd:unsignedInt
"ioReads11": xsd:unsignedInt
"ioReads12": xsd:unsignedInt
"ioReads13": xsd:unsignedInt
"ioReads14": xsd:unsignedInt
"ioReads15": xsd:unsignedInt
"ioReads16": xsd:unsignedInt
"ioReads17": xsd:unsignedInt
"ioReads18": xsd:unsignedInt
"ioReads19": xsd:unsignedInt
"ioReads20": xsd:unsignedInt
"ioReads21": xsd:unsignedInt
"ioReads22": xsd:unsignedInt
"ioReads23": xsd:unsignedInt
"ioWrites00": xsd:unsignedInt
"ioWrites01": xsd:unsignedInt
"ioWrites02": xsd:unsignedInt
"ioWrites03": xsd:unsignedInt
"ioWrites04": xsd:unsignedInt
"ioWrites05": xsd:unsignedInt
"ioWrites06": xsd:unsignedInt
"ioWrites07": xsd:unsignedInt
"ioWrites08": xsd:unsignedInt
"ioWrites09": xsd:unsignedInt
"ioWrites10": xsd:unsignedInt
"ioWrites11": xsd:unsignedInt
"ioWrites12": xsd:unsignedInt
"ioWrites13": xsd:unsignedInt
"ioWrites14": xsd:unsignedInt
"ioWrites15": xsd:unsignedInt
"ioWrites16": xsd:unsignedInt
"ioWrites17": xsd:unsignedInt
"ioWrites18": xsd:unsignedInt
"ioWrites19": xsd:unsignedInt
"ioWrites20": xsd:unsignedInt
"ioWrites21": xsd:unsignedInt
"ioWrites22": xsd:unsignedInt
"ioWrites23": xsd:unsignedInt
}
</code>

== osn:subject ==
A user or user group

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"resourceGroupAssocList": [[#osn:resourceGroupSubjectAssoc|osn:resourceGroupSubjectAssoc]]
"userGroupAssocList": [[#osn:userGroupAssoc|osn:userGroupAssoc]]
}
</code>

== osn:swController ==
Represents an iSCSI Software HBA used to connect to 3rd-party SANs or another QuantaStor SAN. This can be used to setup a QuantaStor HA configuration using VMs or physical servers connected to iSCSI block storage. In this way QuantaStor can be setup as a highly available NAS head for 3rd party SANs using physical or virtual servers.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"ipAddress": xsd:string
"portNumber": xsd:unsignedInt
"username": xsd:string
"password": xsd:string
"controllerType": xsd:unsignedInt
"targetList": [[#osn:swControllerTarget|osn:swControllerTarget]]
}
</code>

== osn:swControllerGroup ==
Represents a group of one or more [[#osn:swController]] instances.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"vendor": xsd:string
"apiVersion": xsd:string
"controllerList": [[#osn:swController|osn:swController]]
}
</code>

== osn:swControllerTarget ==
Represents a 3rd-party iSCSI SAN device which the QuantaStor is connected to via one or more [[#osn:swDiskSession]] instances.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"sessionList": [[#osn:swDiskSession|osn:swDiskSession]]
}
</code>

== osn:swDiskSession ==
Each iSCSI target connection to an external iSCSI SAN is represented a software disk session instance.

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"controllerId": xsd:string
"targetId": xsd:string
"portalIpAddress": xsd:string
"sid": xsd:unsignedInt
"txData": xsd:unsignedLong
"rxData": xsd:unsignedLong
"digestErr": xsd:unsignedLong
"timeoutErr": xsd:unsignedLong
"connectionState": xsd:unsignedInt
"sessionState": xsd:unsignedInt
}
</code>

== osn:targetPort ==
Represents a network port which could be a bonded port, VLAN, VIF, or physical port. (note, the term targetPort was used rather than networkPort due to QuantaStor's initial focus on the iSCSI protocol in early versions. The type name targetPort is retained for backward compatibility.)

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"description": xsd:string
"gateway": xsd:string
"macAddress": xsd:string
"ipAddress": xsd:string
"configType": xsd:string
"isVlan": xsd:boolean {{Note|Set to true when the port is a static VLAN|inline=1}}
"vlanId": xsd:unsignedInt
"vlanQos": xsd:unsignedInt
"isVirtualPort": xsd:boolean {{Note|Set to true when the port is any type of virtual port (VIF, VLAN, bond).|inline=1}}
"isVirtualInterface": xsd:boolean {{Note|Set to true when the port is a static virtual interface|inline=1}}
"isBond": xsd:boolean {{Note|Set to true when the port is a bond port, false if its a slave port or any other port type|inline=1}}
"iscsiEnabled": xsd:boolean
"stopFloating": xsd:boolean
"parentPort": xsd:string
"model": xsd:string
"subnetMask": xsd:string
"vendor": xsd:string
"linkState": xsd:unsignedInt
"speedMbSec": xsd:unsignedInt
"mtu": xsd:unsignedInt
"bytesRx": xsd:unsignedLong
"bytesTx": xsd:unsignedLong
"bytesCounterOffsetRx": xsd:unsignedLong
"bytesCounterOffsetTx": xsd:unsignedLong
"errorsRx": xsd:unsignedLong
"errorsTx": xsd:unsignedLong
"droppedRx": xsd:unsignedLong
"droppedTx": xsd:unsignedLong
"overrunsRx": xsd:unsignedLong
"overrunsTx": xsd:unsignedLong
"collisions": xsd:unsignedLong
"bondMode": xsd:unsignedInt
"onBootDisabled": xsd:boolean
"firewallMask": xsd:unsignedInt {{Note|Disable bit mask for protocols (NFS,SMB etc) based on qs_services_firewall.conf.|inline=1}}
"firewallForceAllowMask": xsd:unsignedInt
"bondStatus": xsd:string
"permanentMacAddress": xsd:string
"partnerMacAddress": xsd:string
"nvmeofEnabled": xsd:boolean
"autoTuningEnabled": xsd:boolean
"losslessNetworkingEnabled": xsd:boolean
"losslessNetworkingSupported": xsd:boolean
"bufferRx": xsd:unsignedInt
"bufferTx": xsd:unsignedInt
"isHidden": xsd:boolean
"childPortIdList": xsd:string
"virtualInterfaceAssocList": [[#osn:virtualInterfaceAssoc|osn:virtualInterfaceAssoc]]
"staticRouteList": [[#osn:targetPortStaticRoute|osn:targetPortStaticRoute]]
}
</code>

== osn:targetPortStaticRoute ==
''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"targetPortId": xsd:string
"destinationIpAddress": xsd:string
"destinationNetmask": xsd:string
"gatewayIpAddress": xsd:string
}
</code>

== osn:task ==
task object contains information about the progress of a given task and may be monitored via [[#taskGet]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"startTimeStamp": xsd:dateTime
"finishTimeStamp": xsd:dateTime
"progress": xsd:unsignedInt
"taskState": xsd:unsignedInt
"description": xsd:string
"parentId": xsd:string
"operation": xsd:string
"objectType": xsd:string
"clientIpAddress": xsd:string
"i18nDescription": [[#osn:i18nString|osn:i18nString]]
"errorMessage": [[#osn:errorMessage|osn:errorMessage]]
"retainState": xsd:unsignedInt
}
</code>

== osn:timeZone ==
''' Fields '''
<code>
{
"countryCode": xsd:string
"tz": xsd:string
"comments": xsd:string
}
</code>

== osn:traceLevel ==
Contains information about the debug tracing configuration of the QuantaStor service

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"traceLevel": xsd:unsignedInt
"stdOut": xsd:boolean
"traceFilterList": xsd:string
"traceFilterVerboseList": xsd:string
"traceOptionsList": xsd:string
"eventVerboseFilterList": xsd:string
}
</code>

== osn:user ==
A management user account within a QuantaStor storage grid.

''' Inherits From '''
[[#osn:subject|osn:subject]]

''' Fields '''
<code>
{
"password": xsd:string
"passwordV2": xsd:string
"roleId": xsd:string
"firstName": xsd:string
"lastName": xsd:string
"emailAddress": xsd:string
"defaultChapUsername": xsd:string
"defaultChapPassword": xsd:string
"posixUid": xsd:unsignedInt
"posixGid": xsd:unsignedInt
"alertSubscriptions": xsd:unsignedInt
"specifiedAlertSubscriptions": xsd:string
"jwtToken": xsd:string
"passwordToken": xsd:string
"passwordModifiedTimeStamp": xsd:dateTime
"isExpired": xsd:boolean
"isLocked": xsd:boolean
"recentlyUsedPasswordTokens": xsd:string
"allowRootCliTokenAuth": xsd:boolean
"accountType": xsd:unsignedInt
"terminateTimeStamp": xsd:dateTime
"failedLoginAttempts": xsd:unsignedInt
"lastSuccessfulLoginTimeStamp": xsd:dateTime
"wuiTabDisable": xsd:unsignedInt
"wuiSectionDisable": xsd:unsignedInt
"enableMultiFactorAuth": xsd:boolean
"multiFactorAuthConfigId": xsd:string
"otpSecretKeyMode": xsd:unsignedInt
"otpSecretKey": xsd:string
"otpSecretKeySalt": xsd:string
"passwordTokenAlg": xsd:unsignedInt
"isLdapUser": xsd:boolean
"passwordSalt": xsd:string
"shortLockoutTimeStamp": xsd:dateTime
"pendingOperationRequestId": xsd:string {{Note|used to track multi-admin approvals on operations like delete|inline=1}}
"customPermissionList": [[#osn:userPermissionAssignment|osn:userPermissionAssignment]]
"userAppTokenIdList": xsd:string
}
</code>

== osn:userAppToken ==
Security token associated with a [[#osn:providerApp]]

''' Inherits From '''
[[#osn:object|osn:object]]

''' Fields '''
<code>
{
"providerAppId": xsd:string
"userId": xsd:string
"appKey": xsd:string
"appAccessToken": xsd:string
"isReadOnly": xsd:boolean
"tokenExpires": xsd:dateTime
"tokenFileName": xsd:string
"appAccessMode": xsd:unsignedInt
"nodeSystemId": xsd:string
}
</code>

== osn:userGroup ==
A group of one or more users. Also maps to a posix group with the specified GID.

''' Inherits From '''
[[#osn:subject|osn:subject]]

''' Fields '''
<code>
{
"posixGid": xsd:unsignedInt
}
</code>

== osn:userGroupAssoc ==
''' Fields '''
<code>
{
"userGroupId": xsd:string
"userId": xsd:string
}
</code>

== osn:virtualInterfaceAssoc ==
''' Inherits From '''
[[#osn:nodeAssoc|osn:nodeAssoc]]

''' Fields '''
<code>
{
"virtualInterfacePortId": xsd:string
"targetPortId": xsd:string
}
</code>
= Enum Definitions =
== enum:accessKeyType ==
Used by the osn__s3UserAccessKey type to indicate the type of the key

''' Enumeration Values '''
OSN_ACCESSKEY_TYPE_S3: 0
OSN_ACCESSKEY_TYPE_SWIFT: 1
OSN_ACCESSKEY_TYPE_MAX: 2
== enum:accessType ==
Access mode for a given Storage Volume with read-write as the default

''' Enumeration Values '''
OSN_CMN_ACCESSTYPE_READWRITE: 0
OSN_CMN_ACCESSTYPE_READONLY: 1
OSN_CMN_ACCESSTYPE_NONE: 2
== enum:aclType ==
''' Enumeration Values '''
OSN_ACL_TYPE_POSIX: 0
OSN_ACL_TYPE_OFF: 1
== enum:activeDirSearchStatus ==
''' Enumeration Values '''
OSN_CMN_AD_STAT_SUCCESS: 0
OSN_CMN_AD_STAT_TOO_MANY_HITS: 1
OSN_CMN_AD_STAT_NOT_FOUND: 2
== enum:adJoinMode ==
Mode for how active directory join.

''' Enumeration Values '''
OSN_CMN_ADJOIN_MODE_NONE: 0
OSN_CMN_ADJOIN_MODE_WINBIND: 1
OSN_CMN_ADJOIN_MODE_SSSD: 2
OSN_CMN_ADJOIN_MODE_SSSD_PLUS_WINBIND: 3
== enum:alertSubscription ==
''' Enumeration Values '''
OSN_CMN_ALERT_SUBSCRIPTION_NONE: 0
OSN_CMN_ALERT_SUBSCRIPTION_CRITICAL: 1
OSN_CMN_ALERT_SUBSCRIPTION_ERROR: 2
OSN_CMN_ALERT_SUBSCRIPTION_WARNING: 4
OSN_CMN_ALERT_SUBSCRIPTION_INFO: 8
== enum:alertTypeState ==
All alerts are enabled (1) by default but alert types can be disabled (0) or paused (2) for 30 days to quiet specific alert types while maintenance is being done.

''' Enumeration Values '''
OSN_ALERT_TYPE_DISABLED: 0
OSN_ALERT_TYPE_ENABLED: 1
OSN_ALERT_TYPE_PAUSED: 2
== enum:arpFilterMode ==
''' Enumeration Values '''
OSN_ARP_FILTER_MODE_AUTO: 0
OSN_ARP_FILTER_MODE_ENABLED: 1
OSN_ARP_FILTER_MODE_DISABLED: 2
OSN_ARP_FILTER_MODE_MAX: 3
== enum:arpFilterStatus ==
''' Enumeration Values '''
OSN_ARP_FILTERING_ENABLED: 0
OSN_ARP_FILTERING_DISABLED: 1
== enum:auditLogEntryType ==
''' Enumeration Values '''
OSN_CMN_AUDIT_NONE: 0
OSN_CMN_AUDIT_TASK: 1
OSN_CMN_AUDIT_ALERT: 2
OSN_CMN_AUDIT_API: 4
OSN_CMN_AUDIT_MESSAGE: 8
== enum:backupJobStage ==
''' Enumeration Values '''
OSN_CMN_BACKUP_STAGE_INITIALIZING: 0
OSN_CMN_BACKUP_STAGE_SCANNING: 1
OSN_CMN_BACKUP_STAGE_COPYING: 2
OSN_CMN_BACKUP_STAGE_PURGING: 3
OSN_CMN_BACKUP_STAGE_COMPLETED: 4
OSN_CMN_BACKUP_STAGE_FAILED: 5
== enum:backupPolicyMountType ==
''' Enumeration Values '''
OSN_CMN_BACKUP_POLICY_MOUNT_NFS: 0
OSN_CMN_BACKUP_POLICY_MOUNT_CEPHFS: 1
OSN_CMN_BACKUP_POLICY_MOUNT_OCFS2: 2
OSN_CMN_BACKUP_POLICY_MOUNT_CIFS: 3
OSN_CMN_BACKUP_POLICY_MOUNT_CLOUD_CONTAINER: 4
== enum:backupPolicyRetentionCriteria ==
''' Enumeration Values '''
OSN_CMN_BACKUP_POLICY_RETENTION_ACCESS_TIME: 1
OSN_CMN_BACKUP_POLICY_RETENTION_MODIFY_TIME: 2
OSN_CMN_BACKUP_POLICY_RETENTION_CREATE_TIME: 4
== enum:backupPolicyType ==
''' Enumeration Values '''
OSN_CMN_BACKUP_POLICY_TYPE_COPY_INBOUND: 0
OSN_CMN_BACKUP_POLICY_TYPE_COPY_OUTBOUND: 1
OSN_CMN_BACKUP_POLICY_TYPE_MOVE_INBOUND: 2
OSN_CMN_BACKUP_POLICY_TYPE_MOVE_OUTBOUND: 3
OSN_CMN_BACKUP_POLICY_TYPE_MAX: 4
== enum:backupPurgePolicy ==
''' Enumeration Values '''
OSN_CMN_BACKUP_PURGE_POLICY_NEVER: 0
OSN_CMN_BACKUP_PURGE_POLICY_AFTER_BACKUP: 1
OSN_CMN_BACKUP_PURGE_POLICY_DAILY: 2
OSN_CMN_BACKUP_PURGE_POLICY_WEEKLY: 3
OSN_CMN_BACKUP_PURGE_POLICY_MAX: 4
== enum:blinkReason ==
Reason for why a given storage media device beacon is ON.

''' Enumeration Values '''
OSN_CMN_BLINKREASON_UNKNOWN: 0
OSN_CMN_BLINKREASON_MANUAL: 1
OSN_CMN_BLINKREASON_SPD_FAULT: 2
OSN_CMN_BLINKREASON_PD_FAULT: 4
OSN_CMN_BLINKREASON_HWD_FAULT: 8
OSN_CMN_BLINKREASON_OSD_FAULT: 16
OSN_CMN_BLINKREASON_BRICK_FAULT: 32
OSN_CMN_BLINKREASON_OTHER: 64
== enum:blinkType ==
All identify methods (eg: physicalDiskIdentify) take this as input where BLINK_ON implies that the LED beacon on the storage media should be activated.

''' Enumeration Values '''
OSN_CMN_BLINK_ON: 0
OSN_CMN_BLINK_OFF: 1
== enum:bondMode ==
''' Enumeration Values '''
OSN_BOND_MODE_ROUND_ROBIN: 0
OSN_BOND_MODE_ACTIVE_BACKUP: 1
OSN_BOND_MODE_BALANCE_XOR: 2
OSN_BOND_MODE_BROADCAST: 3
OSN_BOND_MODE_LACP: 4
OSN_BOND_MODE_BALANCE_TLB: 5
OSN_BOND_MODE_BALANCE_ALB: 6
OSN_BOND_MODE_LACP_LAYER23: 65539
OSN_BOND_MODE_LACP_LAYER34: 65540
OSN_BOND_MODE_ERROR: 65544
OSN_BOND_MODE_MAX: 65552
== enum:bucketAclType ==
''' Enumeration Values '''
OSN_BUCKETACL_PRIVATE: 0
OSN_BUCKETACL_PUBLIC_READ: 1
OSN_BUCKETACL_PUBLIC_READ_WRITE: 2
OSN_BUCKETACL_AUTH_READ: 3
== enum:bucketIntegrationOptions ==
''' Enumeration Values '''
OSN_BUCKET_INTEGRATION_OPTIONS_NONE: 0
OSN_BUCKET_INTEGRATION_OPTIONS_VEEAM: 1
== enum:bucketObjectLockMode ==
''' Enumeration Values '''
OSN_BUCKET_OBJECTLOCK_DISABLED: 0
OSN_BUCKET_OBJECTLOCK_ENABLED: 1
OSN_BUCKET_OBJECTLOCK_GOVERNANCE: 2
OSN_BUCKET_OBJECTLOCK_COMPLIANCE: 3
== enum:bucketRescanOptions ==
HTTP requests are redirected to HTTPS by default but his allows one to reconfigure that behavior.

''' Enumeration Values '''
OSN_CMN_BUCKET_RESCAN_NONE: 0
OSN_CMN_BUCKET_RESCAN_USAGE: 1
OSN_CMN_BUCKET_RESCAN_LOCK_CONFIG: 2
OSN_CMN_BUCKET_RESCAN_LIFECYCLE: 4
OSN_CMN_BUCKET_RESCAN_VEEAM: 8
OSN_CMN_BUCKET_RESCAN_SYNC_POLICY: 16
== enum:bucketType ==
''' Enumeration Values '''
OSN_BUCKET_TYPE_CEPH: 0
OSN_BUCKET_TYPE_MINIO: 1
OSN_BUCKET_TYPE_AMAZON: 2
OSN_BUCKET_TYPE_AZURE: 3
OSN_BUCKET_TYPE_GOOGLE: 4
OSN_BUCKET_TYPE_IBM_CLOUD: 5
OSN_BUCKET_TYPE_MAX: 6
== enum:bucketVersioning ==
''' Enumeration Values '''
OSN_BUCKET_VERSIONING_NONE: 0
OSN_BUCKET_VERSIONING_ENABLED: 1
OSN_BUCKET_VERSIONING_DISABLED: 2
OSN_BUCKET_VERSIONING_SUSPENDED: 3
== enum:cacheMode ==
Cache mode for block devices/media

''' Enumeration Values '''
OSN_CMN_CACHE_MODE_UNKNOWN: 0
OSN_CMN_CACHE_MODE_WRITETHROUGH: 1
OSN_CMN_CACHE_MODE_WRITEBACK: 2
== enum:cachePolicy ==
Cache policy indicates what types of data (data or metadata or both) a scale-up Storage Pool (ZFS based) should allow for the in-memory cache (ARC) or secondary flash based cache (L2ARC).

''' Enumeration Values '''
OSN_CMN_CACHETYPE_ALL: 0
OSN_CMN_CACHETYPE_NONE: 1
OSN_CMN_CACHETYPE_METADATA: 2
OSN_CMN_CACHETYPE_AUTO: 3
== enum:cacheType ==
Cache type, typcially for hardware controlelrs (see hwController)

''' Enumeration Values '''
OSN_CMN_ACCESSTYPE_WRITETHRU: 0
OSN_CMN_ACCESSTYPE_WRITEBACK: 1
== enum:capabilityValType ==
''' Enumeration Values '''
OSN_CAPABILITY_VAL_TYPE_SET: 0
OSN_CAPABILITY_VAL_TYPE_RANGE: 1
== enum:capacityRuleOperator ==
''' Enumeration Values '''
OSN_CMN_OPERATOR_NONE: 0
OSN_CMN_OPERATOR_GREATERTHAN: 1
OSN_CMN_OPERATOR_LESSTHAN: 2
OSN_CMN_OPERATOR_EQUALS: 3
OSN_CMN_OPERATOR_GREATERTHAN_OR_EQUAL: 4
OSN_CMN_OPERATOR_LESSTHAN_OR_EQUAL: 5
== enum:caseSensitivity ==
Scale-up Storage Pools (ZFS based) allow files and directories to be case-sensitive (0, default), insensitive (1), and mixed (2). These modes provide additional compatibility for importing data from filesystems that may or may not have case sensitivity. Use when creating new Network Shares.

''' Enumeration Values '''
OSN_CMN_CASE_SENSITIVITY_SENSITIVE: 0
OSN_CMN_CASE_SENSITIVITY_INSENSITIVE: 1
OSN_CMN_CASE_SENSITIVITY_MIXED: 2
== enum:cephBucketEstimatedObjectCount ==
''' Enumeration Values '''
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_NONE: 0
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_1M: 1
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_10M: 2
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_50M: 3
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_100M: 4
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_500M: 5
OSN_CEPH_BUCKET_ESIMATED_OBJECT_COUNT_1B: 6
== enum:cephClientKeyringResourceType ==
''' Enumeration Values '''
OSN_CMN_CEPH_CLIENT_KEYRING_RESOURCE_TYPE_POOL: 0
OSN_CMN_CEPH_CLIENT_KEYRING_RESOURCE_TYPE_SHARE: 1
== enum:cephClientKeyringType ==
''' Enumeration Values '''
OSN_CMN_CEPH_CLIENT_KEYRING_NONE: 0
OSN_CMN_CEPH_CLIENT_KEYRING_ADMIN: 1
OSN_CMN_CEPH_CLIENT_KEYRING_RBD: 2
OSN_CMN_CEPH_CLIENT_KEYRING_CEPHFS: 4
== enum:cephClusterAuthMode ==
''' Enumeration Values '''
OSN_CEPH_AUTH_MODE_CEPHX: 0
OSN_CEPH_AUTH_MODE_NONE: 1
== enum:cephCrushDeviceClass ==
''' Enumeration Values '''
OSN_CEPH_CRUSH_DEVICE_CLASS_HDD: 0
OSN_CEPH_CRUSH_DEVICE_CLASS_SSD: 1
OSN_CEPH_CRUSH_DEVICE_CLASS_NVME: 2
== enum:cephCrushRuleType ==
''' Enumeration Values '''
OSN_CEPH_CRUSH_RULE_REPLICATED: 1
OSN_CEPH_CRUSH_RULE_ERASURE_CODED: 3
== enum:cephDaemonType ==
''' Enumeration Values '''
OSN_CEPH_DAEMON_TYPE_INVALID: 0
OSN_CEPH_DAEMON_TYPE_MON: 1
OSN_CEPH_DAEMON_TYPE_MGR: 2
OSN_CEPH_DAEMON_TYPE_OSD: 4
OSN_CEPH_DAEMON_TYPE_MDS: 8
OSN_CEPH_DAEMON_TYPE_RGW: 16
== enum:cephECPlugin ==
''' Enumeration Values '''
OSN_CEPH_EC_PLUGIN_JERASURE: 0
OSN_CEPH_EC_PLUGIN_ISA: 1
OSN_CEPH_EC_PLUGIN_LRC: 2
OSN_CEPH_EC_PLUGIN_SHEC: 3
== enum:cephECTechnique ==
''' Enumeration Values '''
OSN_CEPH_EC_TECHNIQUE_REED_SOL_VAN: 0
OSN_CEPH_EC_TECHNIQUE_REED_SOL_R6_OP: 1
OSN_CEPH_EC_TECHNIQUE_CAUCHY_ORIG: 2
OSN_CEPH_EC_TECHNIQUE_CAUCHY_GOOD: 3
OSN_CEPH_EC_TECHNIQUE_LIBERATION: 4
OSN_CEPH_EC_TECHNIQUE_BLAUM_ROTH: 5
OSN_CEPH_EC_TECHNIQUE_LIBER_8_TION: 6
== enum:cephFailureDomain ==
''' Enumeration Values '''
OSN_CEPH_FAILURE_DOMAIN_OSD: 0
OSN_CEPH_FAILURE_DOMAIN_HOST: 1
OSN_CEPH_FAILURE_DOMAIN_RACK: 2
OSN_CEPH_FAILURE_DOMAIN_CHASSIS: 3
OSN_CEPH_FAILURE_DOMAIN_DATACENTER: 4
== enum:cephJournalGroupType ==
''' Enumeration Values '''
OSN_CMN_CEPH_JOURNAL_DEVICE_PARTITION: 0
OSN_CMN_CEPH_JOURNAL_ENTIRE_DEVICE: 1
OSN_CMN_CEPH_JOURNAL_POOL_FILE: 2
OSN_CMN_CEPH_JOURNAL_LVM_VOLUME: 3
== enum:cephJournalMode ==
''' Enumeration Values '''
OSN_CMN_CEPH_JOURNAL_MODE_UNUSED: 0
OSN_CMN_CEPH_JOURNAL_MODE_LEGACY_JOURNAL: 1
OSN_CMN_CEPH_JOURNAL_MODE_WAL: 2
OSN_CMN_CEPH_JOURNAL_MODE_DB: 4
OSN_CMN_CEPH_JOURNAL_MODE_UNKNOWN: 65535
== enum:cephMonOsdSubtreeLimit ==
''' Enumeration Values '''
OSN_CEPH_MON_OSDSUBTREELIMIT_HOST: 0
OSN_CEPH_MON_OSDSUBTREELIMIT_RACK: 1
OSN_CEPH_MON_OSDSUBTREELIMIT_MAX: 2
== enum:cephOsdType ==
''' Enumeration Values '''
OSN_CMN_FLAG_CEPH_OSD_LEGACY_FILESTORE: 0
OSN_CMN_FLAG_CEPH_OSD_BLUESTORE: 1
OSN_CMN_FLAG_CEPH_OSD_AUTO_SELECT: 15
OSN_CMN_FLAG_CEPH_OSD_UNKNOWN: 65535
== enum:cephOsdWeightPolicy ==
''' Enumeration Values '''
OSN_CMN_CEPH_WEIGHT_POLICY_LEGACY: 0
OSN_CMN_CEPH_WEIGHT_POLICY_BY_SIZE: 1
== enum:cephRadosGatewayPortNumber ==
''' Enumeration Values '''
OSN_CEPH_RADOS_GATEWAY_PORT_NUMBER_7480: 7480
OSN_CEPH_RADOS_GATEWAY_PORT_NUMBER_7481: 7481
== enum:cephRadosGatewayServiceEngine ==
''' Enumeration Values '''
OSN_CEPH_RADOS_GATEWAY_SERVICE_ENGINE_CIVETWEB: 0
OSN_CEPH_RADOS_GATEWAY_SERVICE_ENGINE_BEAST: 1
== enum:cephRadosGatewayServiceMode ==
''' Enumeration Values '''
OSN_CEPH_RADOS_GATEWAY_SERVICE_MODE_HTTPS: 0
OSN_CEPH_RADOS_GATEWAY_SERVICE_MODE_HTTP: 1
== enum:cephRgwServiceSettings ==
''' Enumeration Values '''
OSN_CMN_CEPHRGW_SRVSET_NONE: 0
OSN_CMN_CEPHRGW_SRVSET_MULTISITE_REPLICATION: 1
OSN_CMN_CEPHRGW_SRVSET_GARBAGE_COLLECTION: 2
OSN_CMN_CEPHRGW_SRVSET_LIFECYCLE: 4
OSN_CMN_CEPHRGW_SRVSET_S3_ACCESS: 8
OSN_CMN_CEPHRGW_SRVSET_NOTIFICATIONS: 16
OSN_CMN_CEPHRGW_SRVSET_BUCKET_RESHARDING: 32
OSN_CMN_CEPHRGW_SRVSET_MAX: 64
== enum:cephStorageClassRuleType ==
''' Enumeration Values '''
OSN_CEPH_STORAGECLASS_RULE_STANDARD: 0
OSN_CEPH_STORAGECLASS_RULE_OVERFLOW: 1
OSN_CEPH_STORAGECLASS_RULE_MAX: 2
== enum:cephUseCase ==
''' Enumeration Values '''
OSN_CEPH_USE_CASE_RGW: 0
OSN_CEPH_USE_CASE_RBD: 1
OSN_CEPH_USE_CASE_FILESYSTEM: 2
== enum:cephUserAccessOpMask ==
''' Enumeration Values '''
OSN_USER_ACCESS_OPMASK_NONE: 0
OSN_USER_ACCESS_OPMASK_READ: 1
OSN_USER_ACCESS_OPMASK_WRITE: 2
OSN_USER_ACCESS_OPMASK_DELETE: 4
OSN_USER_ACCESS_OPMASK_MAX: 8
== enum:certificateUseCase ==
''' Enumeration Values '''
OSN_CMN_CERT_USECASE_NONE: 0
OSN_CMN_CERT_USECASE_HAPROXY: 1
OSN_CMN_CERT_USECASE_NGINX: 2
OSN_CMN_CERT_USECASE_OBJECT_GATEWAY: 3
OSN_CMN_CERT_USECASE_OBJECT_GATEWAY_INSTANCE2: 4
OSN_CMN_CERT_USECASE_REST_SERVER: 5
OSN_CMN_CERT_USECASE_QS_SERVICE: 6
OSN_CMN_CERT_USECASE_QS_CLIENT: 7
OSN_CMN_CERT_USECASE_MAX: 8
== enum:chapPolicy ==
for Storage Volumes accessed via iSCSI one can set a storage volume specific CHAP user/pass (1), or get CHAP defaults from the user account (2), or allow the use of both the CHAP user/pass on the Volume and the User (3), or inherit the CHAP user/pass from the Resource Group the volume is a member of.

''' Enumeration Values '''
OSN_CHAP_DISABLED: 0
OSN_CHAP_USE_TARGET_CHAP: 1
OSN_CHAP_USE_USER_CHAP_DEFAULTS: 2
OSN_CHAP_USE_TARGET_AND_USER_CHAP: 3
OSN_CHAP_USE_RESOURCE_GROUP_CHAP_DEFAULTS: 4
== enum:cifsUserAccessMode ==
Access mode for a given SMB/CIFS user or user group access entry.

''' Enumeration Values '''
OSN_CMN_CIFS_USER_ACCESS_NONE: 0
OSN_CMN_CIFS_USER_ACCESS_VALID: 1
OSN_CMN_CIFS_USER_ACCESS_ADMIN: 2
OSN_CMN_CIFS_USER_ACCESS_INVALID: 3
== enum:cloudContainerCacheMode ==
''' Enumeration Values '''
OSN_CLOUD_CONTAINER_CACHE_MODE_DEFAULT: 0
OSN_CLOUD_CONTAINER_CACHE_MODE_OFF: 1
OSN_CLOUD_CONTAINER_CACHE_MODE_MIN: 2
OSN_CLOUD_CONTAINER_CACHE_MODE_WRITES: 3
OSN_CLOUD_CONTAINER_CACHE_MODE_FULL: 4
== enum:cloudContainerType ==
''' Enumeration Values '''
OSN_CLOUD_CONTAINER_S3QL: 0
OSN_CLOUD_CONTAINER_S3FS: 1
OSN_CLOUD_CONTAINER_RCLONE: 2
== enum:cloudProviderType ==
''' Enumeration Values '''
OSN_CLOUD_PROVIDER_AMAZON_S3: 0
OSN_CLOUD_PROVIDER_SFTP: 1
OSN_CLOUD_PROVIDER_GOOGLE: 2
OSN_CLOUD_PROVIDER_MICROSOFT_AZURE: 3
OSN_CLOUD_PROVIDER_OPENSTACK_SWIFT: 4
OSN_CLOUD_PROVIDER_DROPBOX: 5
OSN_CLOUD_PROVIDER_CEPH: 6
OSN_CLOUD_PROVIDER_IBMCOS: 7
OSN_CLOUD_PROVIDER_BACKBLAZE_B2: 8
OSN_CLOUD_PROVIDER_WASABI_S3: 9
OSN_CLOUD_PROVIDER_GOOGLE_DRIVE: 10
OSN_CLOUD_PROVIDER_LYVE: 11
== enum:consistencyCheck ==
''' Enumeration Values '''
OSN_CONSISTENCY_CHECK_NA: 0
OSN_CONSISTENCY_CHECK_UNVERIFIED: 1
OSN_CONSISTENCY_CHECK_VERIFIED: 2
== enum:containerScope ==
''' Enumeration Values '''
OSN_CONTAINER_SCOPE_UNKNOWN: 0
OSN_CONTAINER_SCOPE_LOCAL_POOLS: 1
OSN_CONTAINER_SCOPE_HA_POOL: 2
OSN_CONTAINER_SCOPE_CEPH_CLUSTER: 3
== enum:containerServiceDefType ==
''' Enumeration Values '''
OSN_CMN_CONTAINER_SERVICE_DEF_TYPE_UNKNOWN: 0
OSN_CMN_CONTAINER_SERVICE_DEF_TYPE_VSFTP: 1
OSN_CMN_CONTAINER_SERVICE_DEF_TYPE_RESILIO: 2
OSN_CMN_CONTAINER_SERVICE_DEF_TYPE_UNIVERSAL: 3
== enum:correlationDiskType ==
''' Enumeration Values '''
OSN_CORRELATIONDISKTYPE_UNKNOWN: 0
OSN_CORRELATIONDISKTYPE_HWUNIT: 1
OSN_CORRELATIONDISKTYPE_HWDISK: 2
== enum:createdByScheduleType ==
''' Enumeration Values '''
OSN_SCHEDULE_NONE: 0
OSN_SCHEDULE_MANUAL: 1
OSN_SCHEDULE_REPLICATION: 2
OSN_SCHEDULE_SNAPSHOT: 3
OSN_SCHEDULE_BACKUP_POLICY: 4
== enum:dataShredMode ==
Availble data shredding modes for format operations and pool destroy operations.

''' Enumeration Values '''
OSN_CMN_DATA_SHRED_MODE_DONT_SHRED: 0
OSN_CMN_DATA_SHRED_MODE_USARMY: 1
OSN_CMN_DATA_SHRED_MODE_DOD: 2
OSN_CMN_DATA_SHRED_MODE_NNSA: 3
OSN_CMN_DATA_SHRED_MODE_RANDOM: 4
OSN_CMN_DATA_SHRED_MODE_ZEROS: 5
OSN_CMN_DATA_SHRED_MODE_SED_INSTANT_ERASE: 6
OSN_CMN_DATA_SHRED_MODE_NVME_SECURE: 7
OSN_CMN_DATA_SHRED_MODE_SSD_SECURE: 8
OSN_CMN_DATA_SHRED_MODE_AUTO: 99
== enum:dataType ==
''' Enumeration Values '''
OSN_CMN_DATATYPE_STRING: 0
OSN_CMN_DATATYPE_INT: 1
OSN_CMN_DATATYPE_TIME: 2
OSN_CMN_DATATYPE_FLOAT: 3
OSN_CMN_DATATYPE_MAX: 4
== enum:daysOfWeekMask ==
''' Enumeration Values '''
OSN_CMN_DAY_SUNDAY: 1
OSN_CMN_DAY_MONDAY: 2
OSN_CMN_DAY_TUESDAY: 4
OSN_CMN_DAY_WEDNESDAY: 8
OSN_CMN_DAY_THURSDAY: 16
OSN_CMN_DAY_FRIDAY: 32
OSN_CMN_DAY_SATURDAY: 64
== enum:deleteOptions ==
when deleting groups of volumes/shares you can apply flags for (1) dry-run which will not delete anything but will indicate what was to be deleted, (2) force it to only allow deletion of snapshots, or (3) allow deletion of both snapshots and parent shares (non-snaps).

''' Enumeration Values '''
OSN_CMN_DEL_OPT_NONE: 0
OSN_CMN_DEL_OPT_DRY_RUN_ONLY: 1
OSN_CMN_DEL_OPT_SNAPS_ONLY: 2
OSN_CMN_DEL_OPT_SNAPS_AND_PARENT: 4
== enum:dfsNamespaceModeType ==
Indicates now Network Share Namespaces should present shares over CIFS/SMB where FLAT indicates no grouping and GROUPED indicates that the shares should be grouped under an export named after the Network Share Namespace.

''' Enumeration Values '''
OSN_CMN_DFS_NAMESPACE_MODE_GROUPED: 0
OSN_CMN_DFS_NAMESPACE_MODE_FLAT: 1
OSN_CMN_DFS_NAMESPACE_MODE_DISABLED: 2
== enum:diskCategory ==
''' Enumeration Values '''
OSN_DISKCAT_ANY: 0
OSN_DISKCAT_HDD: 1
OSN_DISKCAT_SSD: 2
== enum:diskEncryptionCapabilities ==
capabilities flags indicating encryption capabilities of SED media

''' Enumeration Values '''
OSN_CMN_DISK_ENCRYPTION_CAPABILITIES_NONE: 0
OSN_CMN_DISK_ENCRYPTION_CAPABILITIES_LOCK: 1
OSN_CMN_DISK_ENCRYPTION_CAPABILITIES_SECURE_ERASE: 2
OSN_CMN_DISK_ENCRYPTION_CAPABILITIES_SED_ENTERPRISE: 4
== enum:diskEncryptionStatus ==
current encryption status of SED media

''' Enumeration Values '''
OSN_CMN_DISK_ENCRYPTION_STATUS_NONE: 0
OSN_CMN_DISK_ENCRYPTION_STATUS_LOCK_ENABLED: 1
OSN_CMN_DISK_ENCRYPTION_STATUS_LOCKED: 2
== enum:diskPerfTestType ==
''' Enumeration Values '''
OSN_DISKPERFTYPE_SEQ_READ: 0
== enum:diskSmrZoningType ==
''' Enumeration Values '''
OSN_DISKSMRZONINGTYPE_NONE: 0
OSN_DISKSMRZONINGTYPE_DEVICE_MANAGED: 1
OSN_DISKSMRZONINGTYPE_HOST_MANAGED: 2
== enum:diskStateDetail ==
indicates catetory if device health issues ranging from media errors to thermal issues

''' Enumeration Values '''
OSN_CMN_DISKSTATEDETAIL_UNKNOWN: 0
OSN_CMN_DISKSTATEDETAIL_SPD_FAULT: 1
OSN_CMN_DISKSTATEDETAIL_TEMPERATURE: 2
OSN_CMN_DISKSTATEDETAIL_HEALTH: 4
OSN_CMN_DISKSTATEDETAIL_PREDICTIVE_FAILURE: 8
OSN_CMN_DISKSTATEDETAIL_MEDIA_ERROR_COUNT: 16
OSN_CMN_DISKSTATEDETAIL_OTHER: 32
== enum:diskType ==
''' Enumeration Values '''
OSN_DISKTYPE_UNKNOWN: 0
OSN_DISKTYPE_IDE: 1
OSN_DISKTYPE_SATA: 2
OSN_DISKTYPE_SCSI: 3
OSN_DISKTYPE_SSD: 4
OSN_DISKTYPE_SSHD: 5
OSN_DISKTYPE_AOE: 6
OSN_DISKTYPE_MULTI: 7
OSN_DISKTYPE_SAS: 8
OSN_DISKTYPE_PMEM: 9
OSN_DISKTYPE_NVME: 10
OSN_DISKTYPE_PARTITION: 11
== enum:encryptionMode ==
Storage Pools and scale-out clusters can use software encryption (LUKS based) or hardware encryption when Opal 2 compliant SED media is utilized.

''' Enumeration Values '''
OSN_CMN_ENCRYPTION_MODE_NONE: 0
OSN_CMN_ENCRYPTION_MODE_LUKS: 1
OSN_CMN_ENCRYPTION_MODE_SED: 2
== enum:enterMaintenanceModeMask ==
''' Enumeration Values '''
OSN_MAINTENANCE_MODE_ENTER_ALL: 0
OSN_MAINTENANCE_MODE_CEPH_ENTER: 2
OSN_MAINTENANCE_MODE_COROSYNC_ENTER: 4
== enum:errorLevel ==
''' Enumeration Values '''
OSN_CMN_SEVERITY_ALWAYS: 0
OSN_CMN_SEVERITY_CRITICAL: 1
OSN_CMN_SEVERITY_ERROR: 2
OSN_CMN_SEVERITY_WARNING: 3
OSN_CMN_SEVERITY_INFO: 4
OSN_CMN_SEVERITY_DEBUG: 5
OSN_CMN_SEVERITY_VERBOSE: 6
OSN_CMN_SEVERITY_DEBUG2: 7
== enum:ethPortNaming ==
Ethernet port naming convention to be used for naming ethernet ports in a given system. Can be ethN based (eg eth0) or use the newer Linux predictable naming conventions (eg ens0).

''' Enumeration Values '''
OSN_CMN_ETHPORT_NAMING_NOCHANGE: 0
OSN_CMN_ETHPORT_NAMING_LEGACY_ETH: 1
OSN_CMN_ETHPORT_NAMING_PREDICTABLE: 2
== enum:eventListenerMode ==
''' Enumeration Values '''
OSN_CMN_LISTENERMODE_ENQUEUE: 0
OSN_CMN_LISTENERMODE_PROCESS: 1
OSN_CMN_LISTENERMODE_FLUSH: 2
== enum:eventListenerType ==
''' Enumeration Values '''
OSN_CMN_LISTENERTYPE_OBSERVER: 0
OSN_CMN_LISTENERTYPE_SECONDARY: 1
OSN_CMN_LISTENERTYPE_PRIMARY: 2
== enum:eventType ==
''' Enumeration Values '''
OSN_CMN_EVENTTYPE_ADD: 0
OSN_CMN_EVENTTYPE_REMOVE: 1
OSN_CMN_EVENTTYPE_MODIFY: 2
== enum:exitMaintenanceModeMask ==
''' Enumeration Values '''
OSN_MAINTENANCE_MODE_CEPH_EXIT: 1
OSN_MAINTENANCE_MODE_COROSYNC_EXIT: 3
OSN_MAINTENANCE_MODE_CLEAR_ALL: 65535
== enum:externalSystemCapabilities ==
capabilities reported by a discovered external system

''' Enumeration Values '''
OSN_EXT_SYS_CAPABILITY_STORAGE: 1
OSN_EXT_SYS_CAPABILITY_BLOCKSERVER: 2
OSN_EXT_SYS_CAPABILITY_MANAGEMENTCONTROLLER: 4
OSN_EXT_SYS_CAPABILITY_CHASSISMANAGER: 8
OSN_EXT_SYS_CAPABILITY_STORAGEDEVICEENCLOSURE: 16
OSN_EXT_SYS_CAPABILITY_FLASHMEDIA: 32
== enum:externalSystemMediaProtocol ==
protocol of the External System Media Device

''' Enumeration Values '''
OSN_EXT_SYS_MEDIA_PROTOCOL_NVME: 1
OSN_EXT_SYS_MEDIA_PROTOCOL_SAS: 2
OSN_EXT_SYS_MEDIA_PROTOCOL_MAX: 3
== enum:externalSystemQueryType ==
query type when running External System discovery with simulation data

''' Enumeration Values '''
OSN_EXT_SYS_QUERY_TYPE_INIT: 1
OSN_EXT_SYS_QUERY_TYPE_SYSTEM: 2
OSN_EXT_SYS_QUERY_TYPE_CONTROLLER: 3
OSN_EXT_SYS_QUERY_TYPE_PORT: 4
OSN_EXT_SYS_QUERY_TYPE_MEDIA: 5
== enum:externalSystemType ==
Type of External System to be discovered using associated credentials

''' Enumeration Values '''
OSN_EXT_SYS_TYPE_WD_OPENFLEX_DATA24: 0
OSN_EXT_SYS_TYPE_SEAGATE_CORVAULT: 1
OSN_EXT_SYS_TYPE_UNKNOWN: 2
== enum:failoverReason ==
when a HA failover is initiated this flag indicates the category of the failover

''' Enumeration Values '''
OSN_CMN_FAILOVERREASON_UNKNOWN: 0
OSN_CMN_FAILOVERREASON_MANUAL: 1
OSN_CMN_FAILOVERREASON_AUTO: 2
OSN_CMN_FAILOVERREASON_OTHER: 3
== enum:filterMode ==
''' Enumeration Values '''
OSN_FILTER_MODE_NONE: 0
OSN_FILTER_MODE_INCLUDE: 1
OSN_FILTER_MODE_EXCLUDE: 2
OSN_FILTER_MODE_MAX: 3
== enum:fipsState ==
''' Enumeration Values '''
OSN_FIPS_STATE_DISABLED: 0
OSN_FIPS_STATE_ENABLED_VERIFIED: 1
OSN_FIPS_STATE_ENABLED_NOT_COMPLIANT: 2
== enum:flags ==
''' Enumeration Values '''
OSN_CMN_FLAG_NONE: 0
OSN_CMN_FLAG_ASYNC: 1
OSN_CMN_FLAG_FORCE: 2
OSN_CMN_FLAG_RESCAN: 4
OSN_CMN_FLAG_GENERATE_NAME: 8
OSN_CMN_FLAG_SYNC_PRIMARY: 16
OSN_CMN_FLAG_SYNC_SECONDARY: 32
OSN_CMN_FLAG_REDIRECT: 64
OSN_CMN_FLAG_SUPPRESS_ALARMS: 128
OSN_CMN_FLAG_STOP_VERIFY: 256
OSN_CMN_FLAG_USE_GUID_IQN: 512
OSN_CMN_FLAG_EXPORT: 1024
OSN_CMN_FLAG_DRYRUN: 2048
OSN_CMN_FLAG_START_REPAIR: 4096
OSN_CMN_FLAG_SPARES_ONLY: 8192
OSN_CMN_FLAG_LAZY: 16384
OSN_CMN_FLAG_SW_CONTROLLER: 32768
OSN_CMN_FLAG_WAIT_FOR_SIGNAL: 65536
OSN_CMN_FLAG_MINIMAL: 131072
OSN_CMN_FLAG_HOLD: 262144
OSN_CMN_FLAG_FREE_UNUSED_LUNS: 524288
OSN_CMN_FLAG_INSECURE: 1048576
OSN_CMN_FLAG_VASA_SUPPORT: 2097152
OSN_CMN_FLAG_METADATA: 4194304
OSN_CMN_FLAG_NORMALIZE: 8388608
OSN_CMN_FLAG_FORGET: 16777216
OSN_CMN_FLAG_SYNC_WUI: 33554432
OSN_CMN_FLAG_SYNC_NA: 67108864
OSN_CMN_FLAG_INCLUDE_SNAPSHOT: 134217728
OSN_CMN_FLAG_SKIP_METADATA: 268435456
OSN_CMN_FLAG_FORGET_MISSING: 536870912
OSN_CMN_FLAG_VERBOSE: 1073741824
OSN_CMN_FLAG_MAX: 1610612736
== enum:haClientConnectivityPolicy ==
Storage Pool HA groups an be configured to check client connectivity. If enabled a pool may be moved/failover if a majority of the specified client IPs are not responding to ping from the current pool owher but is responding to the alternate/secondary node.

''' Enumeration Values '''
OSN_CMN_HA_CLIENT_FAILOVER_DISABLED: 0
OSN_CMN_HA_CLIENT_FAILOVER_IF_NO_MAJORITY: 1
OSN_CMN_HA_CLIENT_FAILOVER_IF_NO_RESPONSE: 2
OSN_CMN_HA_CLIENT_FAILOVER_MAX: 3
== enum:haLinkStateFailoverPolicy ==
Policy for when to initiate an HA failover of a pool based ethernet port link state of the ports which have HA VIFs associated with the pool

''' Enumeration Values '''
OSN_CMN_HA_LINKSTATE_FAILOVER_IF_ALL_LINKDOWN: 0
OSN_CMN_HA_LINKSTATE_FAILOVER_IF_MAJORITY_LINKDOWN: 1
OSN_CMN_HA_LINKSTATE_FAILOVER_IF_ANY_LINKDOWN: 2
OSN_CMN_HA_LINKSTATE_FAILOVER_IGNORE_LINKDOWN: 3
OSN_CMN_HA_LINKSTATE_FAILOVER_FAILOVER_MAX: 4
== enum:healthCheckOrigin ==
health check caller

''' Enumeration Values '''
OSN_CMN_HEALTH_CHECK_MANAGER: 0
OSN_CMN_HEALTH_CHECK_MANUAL: 1
== enum:healthStatusSeverity ==
Severity of the detected issue

''' Enumeration Values '''
OSN_CMN_HEALTH_STATUS_SEVERITY_INFORMATIONAL: 0
OSN_CMN_HEALTH_STATUS_SEVERITY_MINOR: 1
OSN_CMN_HEALTH_STATUS_SEVERITY_MAJOR: 2
OSN_CMN_HEALTH_STATUS_SEVERITY_CRITICAL: 4
OSN_CMN_HEALTH_STATUS_SEVERITY_MAX: 8
== enum:hostType ==
''' Enumeration Values '''
OSN_HOSTTYPE_UNKNOWN: 0
OSN_HOSTTYPE_AIX: 1
OSN_HOSTTYPE_HPUX: 2
OSN_HOSTTYPE_LINUX: 3
OSN_HOSTTYPE_SOLARIS: 4
OSN_HOSTTYPE_VMWARE: 5
OSN_HOSTTYPE_WINDOWS: 6
OSN_HOSTTYPE_XENSERVER: 7
OSN_HOSTTYPE_OTHER: 8
OSN_HOSTTYPE_MAC: 9
OSN_HOSTTYPE_MAX: 10
== enum:hotsparePoolRepairPolicy ==
''' Enumeration Values '''
OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_AND_GLOBAL: 0
OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_ONLY: 1
OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_EXACTMATCH: 2
OSN_HOTSPARE_POOL_REPAIR_POLICY_USE_ASSIGNED_ONLY_EXACTMATCH: 3
OSN_HOTSPARE_POOL_REPAIR_POLICY_MANUAL_REPAIR: 4
OSN_HOTSPARE_POOL_REPAIR_POLICY_MAX: 5
== enum:hotsparePoolRepairState ==
''' Enumeration Values '''
OSN_HOTSPARE_POOL_REPAIR_STATE_HEALTHY: 0
OSN_HOTSPARE_POOL_REPAIR_STATE_REPAIR_NEEDED: 1
OSN_HOTSPARE_POOL_REPAIR_STATE_REPAIR_NEEDED_OPERATOR_APPROVAL_REQUIRED: 2
OSN_HOTSPARE_POOL_REPAIR_STATE_AUTO_REPAIR_IN_PROGRESS: 3
OSN_HOTSPARE_POOL_REPAIR_STATE_MAX: 4
== enum:hwAutoMaintenanceMask ==
''' Enumeration Values '''
OSN_HW_AUTO_MAINTENANCE_NONE: 0
OSN_HW_AUTO_MAINTENANCE_ENABLED_POOL: 1
OSN_HW_AUTO_MAINTENANCE_ENABLED_OSD: 2
OSN_HW_AUTO_MAINTENANCE_ENABLED_MAX: 4
== enum:hwCachePolicy ==
Caching mode options for hardware controlelrs (see hwController)

''' Enumeration Values '''
OSN_HWCACHE_UNKNOWN: 0
OSN_HWCACHE_READAHEAD: 1
OSN_HWCACHE_NOREADAHEAD: 2
OSN_HWCACHE_WRITEBACK: 4
OSN_HWCACHE_ALWAYSWRITEBACK: 8
OSN_HWCACHE_WRITETHROUGH: 16
OSN_HWCACHE_CACHED: 32
OSN_HWCACHE_DIRECT: 64
== enum:hwControllerCapabilities ==
''' Enumeration Values '''
HW_CONTROLLER_API_NONE: 0
HW_CONTROLLER_API_RESCAN: 1
HW_CONTROLLER_API_CREATE_UNIT: 2
HW_CONTROLLER_API_GROW_UNIT: 4
HW_CONTROLLER_API_GROW_UNIT_ADV_STRIPE: 8
HW_CONTROLLER_API_GROW_UNIT_ADV_PRIORITY: 16
HW_CONTROLLER_API_CREATE_SSD_CACHE: 32
HW_CONTROLLER_API_SUPPORTS_SSD_CACHE_RAID: 64
HW_CONTROLLER_API_SUPPORTS_UNIT_DISK_CORRELATION: 128
HW_CONTROLLER_API_SUPPORTS_ENCRYPTION: 256
HW_CONTROLLER_API_DISK_PASSTHRU: 512
HW_CONTROLLER_API_SUPPORTS_RAID: 1024
HW_CONTROLLER_API_SUPPORTS_JBOD: 2048
HW_CONTROLLER_API_USE_PHYSICAL_DISK_SPARES: 4096
HW_CONTROLLER_API_DISABLE_SES: 8192
HW_CONTROLLER_API_HWUNIT_PHYSICAL_DISKS: 16384
HW_CONTROLLER_API_SUPPORTS_LOGICALDRIVES: 32768
== enum:hwDiskCapabilities ==
''' Enumeration Values '''
HW_DISK_API_NONE: 0
HW_DISK_API_MARK_HOT_SPARE: 1
HW_DISK_API_IDENTIFY: 2
HW_DISK_API_REMOVE_DISK: 4
HW_DISK_API_SUPPORTS_ENCRYPTION: 8
== enum:hwEnclosureLayoutFlow ==
''' Enumeration Values '''
OSN_ENCLOSURELAYOUT_FLOW_T2B_L2R: 0
OSN_ENCLOSURELAYOUT_FLOW_T2B_R2L: 1
OSN_ENCLOSURELAYOUT_FLOW_B2T_L2R: 2
OSN_ENCLOSURELAYOUT_FLOW_B2T_R2L: 3
OSN_ENCLOSURELAYOUT_FLOW_R2L_T2B: 4
OSN_ENCLOSURELAYOUT_FLOW_R2L_B2T: 5
OSN_ENCLOSURELAYOUT_FLOW_L2R_T2B: 6
OSN_ENCLOSURELAYOUT_FLOW_L2R_B2T: 7
== enum:hwEnclosureLayoutType ==
''' Enumeration Values '''
OSN_ENCLOSURETYPE_JBOD: 0
OSN_ENCLOSURETYPE_SERVER: 1
OSN_ENCLOSURETYPE_CLUSTER: 2
OSN_ENCLOSURETYPE_INTERNAL: 3
OSN_ENCLOSURETYPE_EXTERNALSYSTEM: 4
OSN_ENCLOSURETYPE_DRAWER: 5
OSN_ENCLOSURETYPE_MAX: 6
== enum:hwUnitCapabilities ==
''' Enumeration Values '''
HW_UNIT_API_NONE: 0
HW_UNIT_API_IDENTIFY: 1
HW_UNIT_API_DELETE: 2
HW_UNIT_API_SUPPORTS_ENCRYPTION: 8
== enum:imageFileType ==
what type of data conversion required for a physicalDiskCopy

''' Enumeration Values '''
OSN_CMN_IMAGE_FILE_TYPE_RAW: 0
OSN_CMN_IMAGE_FILE_TYPE_QCOW: 1
OSN_CMN_IMAGE_FILE_TYPE_VMDK: 2
OSN_CMN_IMAGE_FILE_TYPE_VHD: 3
== enum:immutabilityMode ==
Network Share immutability is supported on scale-up Storage Pools (ZFS based), specify (1) to enable immutability, zero (0) (default) to leave it off. Once immutability is enabled it cannot be disabled.

''' Enumeration Values '''
OSN_IMU_MODE_NONE: 0
OSN_IMU_MODE_IMMUTABLE: 1
OSN_IMU_MODE_APPEND: 2
== enum:initPriorityType ==
''' Enumeration Values '''
OSN_INITPRIORITY_DEFAULT: 0
OSN_INITPRIORITY_LOW: 1
OSN_INITPRIORITY_MEDIUM: 2
OSN_INITPRIORITY_HIGH: 3
== enum:initiatorType ==
''' Enumeration Values '''
OSN_CMN_INITIATOR_ISCSI: 0
OSN_CMN_INITIATOR_FCP: 1
OSN_CMN_INITIATOR_IB: 2
OSN_CMN_INITIATOR_NVMEOF: 3
== enum:ipmiHealthState ==
''' Enumeration Values '''
OSN_IPMI_STATE_OK: 0
OSN_IPMI_STATE_NO_SENSOR: 1
OSN_IPMI_STATE_NON_CRITICAL: 2
OSN_IPMI_STATE_CRITICAL: 3
OSN_IPMI_STATE_NON_RECOVERABLE: 4
OSN_IPMI_STATE_OK_NOT_REDUNDANT: 5
OSN_IPMI_STATE_OK_NOT_DETECTED: 6
== enum:jumboFramesTest ==
''' Enumeration Values '''
OSN_CMN_PING_JUMBO_SKIPPED: 0
OSN_CMN_PING_JUMBO_PASSED: 1
OSN_CMN_PING_JUMBO_FAILED: 2
OSN_CMN_PING_JUMBO_MAX: 3
== enum:keyServerConnectionMode ==
''' Enumeration Values '''
OSN_KEYSERVER_CONNECTION_RESET: 0
OSN_KEYSERVER_CONNECTION_RECONNECT: 1
== enum:keyServerProtocol ==
indicates protocol to use when communicating with an external key server

''' Enumeration Values '''
OSN_KEYSERVER_PROTO_UNKNOWN: 0
OSN_KEYSERVER_PROTO_RAW: 1
OSN_KEYSERVER_PROTO_KMIP1: 2
OSN_KEYSERVER_PROTO_KMIP1_1: 3
OSN_KEYSERVER_PROTO_KMIP1_2: 4
OSN_KEYSERVER_PROTO_KMIP1_3: 5
OSN_KEYSERVER_PROTO_KMIP1_4: 6
OSN_KEYSERVER_PROTO_KMIP2: 7
OSN_KEYSERVER_PROTO_KMIP2_0: 8
OSN_KEYSERVER_PROTO_KMIP2_1: 9
OSN_KEYSERVER_PROTO_KMIP3: 10
OSN_KEYSERVER_PROTO_TTLV: 11
OSN_KEYSERVER_PROTO_JSON: 12
OSN_KEYSERVER_PROTO_XML: 13
OSN_KEYSERVER_PROTO_SOAP: 14
OSN_KEYSERVER_PROTO_SOAP_V: 15
OSN_KEYSERVER_PROTO_RKM15: 16
OSN_KEYSERVER_PROTO_RKM21: 17
OSN_KEYSERVER_PROTO_SUNKMS2: 18
OSN_KEYSERVER_PROTO_NAE16: 19
OSN_KEYSERVER_PROTO_NSCL: 20
OSN_KEYSERVER_PROTO_VDS: 21
OSN_KEYSERVER_PROTO_P11: 22
OSN_KEYSERVER_PROTO_P11PSE: 23
OSN_KEYSERVER_PROTO_CRDT: 24
OSN_KEYSERVER_PROTO_VED: 25
OSN_KEYSERVER_PROTO_RKM27: 26
OSN_KEYSERVER_PROTO_RKMTC: 27
OSN_KEYSERVER_PROTO_AWS: 28
OSN_KEYSERVER_PROTO_GCP: 29
OSN_KEYSERVER_PROTO_AKV: 30
OSN_KEYSERVER_PROTO_IKP: 31
== enum:keyServerType ==
indicates the KMIP server type when adding a new KMIP service entry.

''' Enumeration Values '''
OSN_KEY_SERVER_TYPE_DEFAULT: 0
OSN_KEY_SERVER_TYPE_KMIP: 1
OSN_KEY_SERVER_TYPE_IBM_KEYPROTECT: 2
== enum:keyType ==
''' Enumeration Values '''
OSN_KEY_TYPE_ALL: 0
OSN_KEY_TYPE_ROOT: 1
OSN_KEY_TYPE_DEK: 2
== enum:kmipEncoding ==
''' Enumeration Values '''
OSN_KMIPENCODING_NONE: 0
== enum:kmipKeyType ==
''' Enumeration Values '''
OSN_KMIPKEY_DEFAULT: 0
== enum:licenseCategory ==
''' Enumeration Values '''
OSN_LICENSE_CATEGORY_SYSTEM: 0
OSN_LICENSE_CATEGORY_FEATURE: 1
OSN_LICENSE_CATEGORY_FEATURE_TERABYTES: 2
OSN_LICENSE_CATEGORY_FEATURE_VOLUMES: 3
OSN_LICENSE_CATEGORY_FEATURE_SNAPSHOTS: 4
OSN_LICENSE_CATEGORY_FEATURE_CLOUDS: 5
OSN_LICENSE_CATEGORY_FEATURE_NODES: 6
OSN_LICENSE_CATEGORY_FEATURE_USERS: 7
OSN_LICENSE_CATEGORY_FEATURE_SSD: 8
OSN_LICENSE_CATEGORY_FEATURE_REPLICATION: 9
OSN_LICENSE_CATEGORY_SUPPORT: 10
== enum:licenseDuration ==
''' Enumeration Values '''
OSN_LICENSE_DURATION_PERPETUAL: 0
OSN_LICENSE_DURATION_TIMELIMITED: 1
== enum:licenseEdition ==
''' Enumeration Values '''
OSN_LICENSE_EDITION_FREE: 0
OSN_LICENSE_EDITION_TRIAL: 1
OSN_LICENSE_EDITION_STANDARD: 2
OSN_LICENSE_EDITION_ENTERPRISE: 3
OSN_LICENSE_EDITION_PLATINUM: 4
OSN_LICENSE_EDITION_CLOUD: 5
OSN_LICENSE_EDITION_MIGRATION: 6
OSN_LICENSE_EDITION_EXPRESS: 7
OSN_LICENSE_EDITION_OBJECT: 8
== enum:licenseState ==
''' Enumeration Values '''
OSN_CMN_LICSTATE_NORMAL: 0
OSN_CMN_LICSTATE_WARNING: 1
OSN_CMN_LICSTATE_BUSY: 2
OSN_CMN_LICSTATE_ERROR: 3
OSN_CMN_LICSTATE_INITALIZING: 4
OSN_CMN_LICSTATE_MISSING: 5
OSN_CMN_LICSTATE_OFFLINE: 6
OSN_CMN_LICSTATE_RETIRED: 7
== enum:licenseType ==
''' Enumeration Values '''
OSN_LICENSE_TYPE_NODE: 0
OSN_LICENSE_TYPE_VOLUME: 1
OSN_LICENSE_TYPE_SITE: 2
== enum:linkState ==
used to indicate network port and FC port link state

''' Enumeration Values '''
OSN_CMN_LINKSTATE_UP: 0
OSN_CMN_LINKSTATE_DOWN: 1
OSN_CMN_LINKSTATE_UNKNOWN: 2
OSN_CMN_LINKSTATE_DISABLED: 3
== enum:loadBalancerMappingMode ==
''' Enumeration Values '''
OSN_CMN_LB_MAPPING_MODE_AUTO: 0
OSN_CMN_LB_MAPPING_MODE_HTTP_HTTP: 1
OSN_CMN_LB_MAPPING_MODE_HTTPS_HTTP: 2
OSN_CMN_LB_MAPPING_MODE_HTTPS_HTTPS: 3
OSN_CMN_LB_MAPPING_MODE_NONE_HTTP: 4
OSN_CMN_LB_MAPPING_MODE_NONE_HTTPS: 5
OSN_CMN_LB_MAPPING_MODE_MAX: 6
== enum:loadBalancerType ==
Load balancer service type, HA-Proxy is the default.

''' Enumeration Values '''
OSN_LOADBALANCER_NONE: 0
OSN_LOADBALANCER_NGINX: 1
OSN_LOADBALANCER_HAPROXY: 2
OSN_LOADBALANCER_MAX: 3
== enum:lockType ==
''' Enumeration Values '''
OSN_LOCK_SHARED: 0
OSN_LOCK_PROTECTED: 1
OSN_LOCK_EXCLUSIVE: 2
OSN_LOCK_PRIORITY_EXCLUSIVE: 3
== enum:logCollectionMode ==
''' Enumeration Values '''
OSN_LOG_COLLECTION_NEVER: 0
OSN_LOG_COLLECTION_WEEKLY: 1
OSN_LOG_COLLECTION_BIWEEKLY: 2
OSN_LOG_COLLECTION_MONTHLY: 3
OSN_LOG_COLLECTION_MAX: 4
== enum:lunAssignmentPolicy ==
LUN numbers for iSCSI are all 0 but for FC they're dynamically assigned unless the mode is set to static.

''' Enumeration Values '''
OSN_CMN_LUN_ASSIGN_DYNAMIC: 0
OSN_CMN_LUN_ASSIGN_STATIC: 1
== enum:maintenanceType ==
''' Enumeration Values '''
OSN_CMN_MAINTENANCE_DEFAULT: 0
OSN_CMN_MAINTENANCE_POOL_SCRUB: 1
OSN_CMN_MAINTENANCE_POOL_SSD_TRIM: 2
OSN_CMN_MAINTENANCE_CEPH_RGW_S3_ORPHAN_CLEANUP: 4
OSN_CMN_MAINTENANCE_MAX: 8
== enum:managerClass ==
''' Enumeration Values '''
OSN_MANAGERCLASS_NONE: 0
OSN_MANAGERCLASS_ALUACONFIG: 1
OSN_MANAGERCLASS_BLINK: 2
OSN_MANAGERCLASS_CEPH: 3
OSN_MANAGERCLASS_DISK: 4
OSN_MANAGERCLASS_FABRIC: 5
OSN_MANAGERCLASS_FIREWALL: 6
OSN_MANAGERCLASS_DEPRECATED_7: 7
OSN_MANAGERCLASS_GRIDSYNC: 8
OSN_MANAGERCLASS_HACONNECTIVITY: 9
OSN_MANAGERCLASS_HAFAILOVER: 10
OSN_MANAGERCLASS_HARDWARE: 11
OSN_MANAGERCLASS_HOTSPARE: 12
OSN_MANAGERCLASS_INFINIBAND: 13
OSN_MANAGERCLASS_DEPRECATED_14: 14
OSN_MANAGERCLASS_PASSTHRU: 15
OSN_MANAGERCLASS_POOL: 16
OSN_MANAGERCLASS_REPLICATION: 17
OSN_MANAGERCLASS_SED: 18
OSN_MANAGERCLASS_SHARENAMESPACE: 19
OSN_MANAGERCLASS_SMART: 20
OSN_MANAGERCLASS_STATS: 21
OSN_MANAGERCLASS_TARGETPORT: 22
OSN_MANAGERCLASS_MAX: 23
== enum:memoryEccType ==
indicates the type of memory error correction (ECC) used within the Storage System server

''' Enumeration Values '''
OSN_CMN_MEMORY_ECC_TYPE_UNKNOWN: 0
OSN_CMN_MEMORY_ECC_TYPE_SINGLEBIT: 1
OSN_CMN_MEMORY_ECC_TYPE_NONE: 2
OSN_CMN_MEMORY_ECC_TYPE_MULTIBIT: 3
== enum:modifyType ==
Some APIs for adding and removing entries (ex: hostGroupAddRemove) have a mode specifier to indicate what should be done with the specified entries. Add and Remove modes add or remove the specified entries whereas the Set mode will add the specified entries if not already added and remove any not specified in the set.

''' Enumeration Values '''
OSN_CMN_MOD_OP_ADD: 0
OSN_CMN_MOD_OP_REMOVE: 1
OSN_CMN_MOD_OP_SET: 2
== enum:multiFactorAuthMode ==
Selected mode for a given login to indicate MFA method

''' Enumeration Values '''
OSN_CMN_MFA_MODE_NONE: 0
OSN_CMN_MFA_MODE_PUSH: 1
OSN_CMN_MFA_MODE_PHONE: 2
OSN_CMN_MFA_MODE_SMS: 4
OSN_CMN_MFA_MODE_TOKEN: 8
OSN_CMN_MFA_MODE_PROMPT: 16
OSN_CMN_MFA_MODE_PASSCODE: 32
OSN_CMN_MFA_MODE_MAX: 64
== enum:multiFactorAuthProvider ==
Supported multi-factor athentication providers

''' Enumeration Values '''
OSN_CMN_MFA_PROVIDER_NONE: 0
OSN_CMN_MFA_PROVIDER_DUO: 1
OSN_CMN_MFA_PROVIDER_GOOGLE: 2
OSN_CMN_MFA_PROVIDER_OKTA: 3
OSN_CMN_MFA_PROVIDER_OIDC: 4
== enum:multiFactorAuthStatus ==
Status of a MFA login

''' Enumeration Values '''
OSN_CMN_MFA_STATUS_NONE: 0
OSN_CMN_MFA_STATUS_PENDING: 1
OSN_CMN_MFA_STATUS_RUNNING: 2
OSN_CMN_MFA_STATUS_SUCCESS: 3
OSN_CMN_MFA_STATUS_FAIL: 4
OSN_CMN_MFA_STATUS_DENY: 5
OSN_CMN_MFA_STATUS_ERR: 6
OSN_CMN_MFA_STATUS_ENROLL: 7
OSN_CMN_MFA_STATUS_SENT: 8
== enum:multipathConfigMode ==
''' Enumeration Values '''
OSN_MULTIPATH_AUTOCONFIG_DISABLED: 0
OSN_MULTIPATH_AUTOCONFIG_ENABLED: 1
OSN_MULTIPATH_AUTOCONFIG_DISABLE_AND_CLEAR_CONFIG: 2
OSN_MULTIPATH_AUTOCONFIG_MAX: 3
== enum:multipathProtocol ==
protocol of multipath config entry

''' Enumeration Values '''
OSN_MPATH_PROTOCOL_SCSI: 0
OSN_MPATH_PROTOCOL_NVME: 1
OSN_MPATH_PROTOCOL_MAX: 2
== enum:networkShareFileAccess ==
''' Enumeration Values '''
OSN_CMN_FILE_ACCESS_TYPE_READONLY: 0
OSN_CMN_FILE_ACCESS_TYPE_READWRITE: 1
== enum:networkShareFileOplock ==
''' Enumeration Values '''
OSN_CMN_FILE_OPLOCK_TYPE_NONE: 0
OSN_CMN_FILE_OPLOCK_TYPE_LEVEL_II: 1
OSN_CMN_FILE_OPLOCK_TYPE_LEASE: 2
OSN_CMN_FILE_OPLOCK_TYPE_EXCLUSIVE: 3
OSN_CMN_FILE_OPLOCK_TYPE_UNKNOWN: 4
== enum:networkShareSessionType ==
Network Share session type, either NFS or SMB (see networkShareSessionEnum)

''' Enumeration Values '''
OSN_CMN_SHARE_SESSION_SMB: 0
OSN_CMN_SHARE_SESSION_NFS: 1
== enum:networkShareTemplateSettingsMask ==
''' Enumeration Values '''
OSN_TEMPLATE_ALL: 0
OSN_TEMPLATE_GENERAL: 1
OSN_TEMPLATE_USER: 2
OSN_TEMPLATE_CIFS: 4
OSN_TEMPLATE_SECURITY: 8
OSN_TEMPLATE_ADVANCED: 16
OSN_TEMPLATE_NFS: 32
OSN_TEMPLATE_PERMISSIONS: 64
OSN_TEMPLATE_MAX: 128
== enum:networkShareType ==
''' Enumeration Values '''
OSN_NETWORKSHARETYPE_STANDARD: 0
OSN_NETWORKSHARETYPE_SUBVOL_BTRFS: 1
OSN_NETWORKSHARETYPE_CLOUD: 2
OSN_NETWORKSHARETYPE_SUBVOL_ZFS: 3
OSN_NETWORKSHARETYPE_DEPRECATED_4: 4
OSN_NETWORKSHARETYPE_ALIAS: 5
OSN_NETWORKSHARETYPE_SUBSHARE: 6
OSN_NETWORKSHARETYPE_CEPHFS: 7
OSN_NETWORKSHARETYPE_CEPHRGW: 8
== enum:nfsKerberosMode ==
Indicates how export entries should be formatted to support kerberos when it is enabled.

''' Enumeration Values '''
OSN_CMN_NFS_KRB5I: 0
OSN_CMN_NFS_KRB5P: 1
OSN_CMN_NFS_KRB5: 2
== enum:nfsNamespaceModeType ==
Indicates now Network Share Namespaces should present shares over NFS where FLAT indicates no grouping and GROUPED indicates that the shares should be grouped under an export named after the Network Share Namespace. For NFS only FLAT mode is currently supported.

''' Enumeration Values '''
OSN_CMN_NFS_NAMESPACE_MODE_FLAT: 0
OSN_CMN_NFS_NAMESPACE_MODE_GROUPED: 1
OSN_CMN_NFS_NAMESPACE_MODE_DISABLED: 2
== enum:nfsSecurityPolicy ==
default security policy to be applied to network shares

''' Enumeration Values '''
OSN_CMN_NFS_SECURITY_POLICY_INHERIT: 0
OSN_CMN_NFS_SECURITY_POLICY_KERBEROS: 1
OSN_CMN_NFS_SECURITY_POLICY_SYSTEM: 2
OSN_CMN_NFS_SECURITY_POLICY_MAX: 3
== enum:nfsServerType ==
Scale-up (0) mode is the default NFS service mode and is used to deliver NFS access to Network Shares in scale-up (ZFS based) Storage Pools. Scale-out mode uses GaneshaNFS for enabling access to scale-out Network Shares.

''' Enumeration Values '''
OSN_CMN_NFS_SERVER_SCALEUP: 0
OSN_CMN_NFS_SERVER_SCALEOUT: 1
== enum:nfsServiceMode ==
NFSv3 indicates both v3 and v4 are supported whereas v4 mode (1) indicates only NFS v4 access is allowed.

''' Enumeration Values '''
OSN_CMN_NFS_MODE_V3V4: 0
OSN_CMN_NFS_MODE_V4: 1
OSN_CMN_NFS_MODE_V3: 2
== enum:objInternalUse ==
''' Enumeration Values '''
OSN_OBJ_SHALLOW: 1
== enum:objectState ==
''' Enumeration Values '''
OSN_CMN_OBJSTATE_NORMAL: 0
OSN_CMN_OBJSTATE_WARNING: 1
OSN_CMN_OBJSTATE_BUSY: 2
OSN_CMN_OBJSTATE_ERROR: 3
OSN_CMN_OBJSTATE_INITIALIZING: 4
OSN_CMN_OBJSTATE_MISSING: 5
OSN_CMN_OBJSTATE_OFFLINE: 6
OSN_CMN_OBJSTATE_DISCONNECTED: 7
OSN_CMN_OBJSTATE_PAUSED: 8
OSN_CMN_OBJSTATE_READY: 9
OSN_CMN_OBJSTATE_ORPHANED: 10
== enum:objectType ==
''' Enumeration Values '''
OSN_CMN_OBJECTTYPE_UNKNOWN: 0
OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE: 1
OSN_CMN_OBJECTTYPE_SNAPSHOT_SCHEDULE_ASSOC: 2
OSN_CMN_OBJECTTYPE_STORAGE_VOLUME: 3
OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_UTILIZATION: 4
OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP: 5
OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_GROUP_ASSOC: 6
OSN_CMN_OBJECTTYPE_STORAGE_POOL: 7
OSN_CMN_OBJECTTYPE_STORAGE_POOL_DEVICE: 8
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM: 9
OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_ACL: 10
OSN_CMN_OBJECTTYPE_HOST: 11
OSN_CMN_OBJECTTYPE_HOST_GROUP: 12
OSN_CMN_OBJECTTYPE_INITIATOR_PORT: 13
OSN_CMN_OBJECTTYPE_TARGET_PORT: 14
OSN_CMN_OBJECTTYPE_PHYSICAL_DISK: 15
OSN_CMN_OBJECTTYPE_TASK: 16
OSN_CMN_OBJECTTYPE_AUDIT_ENTRY: 17
OSN_CMN_OBJECTTYPE_DEPRECATED_18: 18
OSN_CMN_OBJECTTYPE_ALERT: 19
OSN_CMN_OBJECTTYPE_ALERT_CONFIG_SETTINGS: 20
OSN_CMN_OBJECTTYPE_LICENSE: 21
OSN_CMN_OBJECTTYPE_LICENSE_ACTIVATION: 22
OSN_CMN_OBJECTTYPE_USER: 23
OSN_CMN_OBJECTTYPE_USER_PERMISSION_ASSIGNMENT: 24
OSN_CMN_OBJECTTYPE_USER_GROUP: 25
OSN_CMN_OBJECTTYPE_USER_GROUP_ASSOC: 26
OSN_CMN_OBJECTTYPE_ROLE: 27
OSN_CMN_OBJECTTYPE_ROLE_PERMISSION_ASSIGNMENT: 28
OSN_CMN_OBJECTTYPE_ROLE_SUBJECT_ASSOC: 29
OSN_CMN_OBJECTTYPE_PERMISSION_DEFINITION: 30
OSN_CMN_OBJECTTYPE_RESOURCE_GROUP: 31
OSN_CMN_OBJECTTYPE_RESOURCE_GROUP_ASSOC: 32
OSN_CMN_OBJECTTYPE_RESOURCE_GROUP_SUBJECT_ASSOC: 33
OSN_CMN_OBJECTTYPE_SESSION: 34
OSN_CMN_OBJECTTYPE_STORAGE_TIER: 35
OSN_CMN_OBJECTTYPE_STORAGE_TIER_ASSOC: 36
OSN_CMN_OBJECTTYPE_STORAGE_QUOTA: 37
OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_ASSOC: 38
OSN_CMN_OBJECTTYPE_ACL: 39
OSN_CMN_OBJECTTYPE_OBJECT_PROPERTY: 40
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK: 41
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP: 42
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_GROUP_ASSOC: 43
OSN_CMN_OBJECTTYPE_REPLICA_ASSOC: 44
OSN_CMN_OBJECTTYPE_DEPRECATED_45: 45
OSN_CMN_OBJECTTYPE_HW_ALARM: 46
OSN_CMN_OBJECTTYPE_HW_BBU: 47
OSN_CMN_OBJECTTYPE_HW_DISK: 48
OSN_CMN_OBJECTTYPE_HW_UNIT: 49
OSN_CMN_OBJECTTYPE_HW_ENCLOSURE: 50
OSN_CMN_OBJECTTYPE_HW_CONTROLLER: 51
OSN_CMN_OBJECTTYPE_HW_CONTROLLER_GROUP: 52
OSN_CMN_OBJECTTYPE_NETWORK_SHARE: 53
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CLIENT: 54
OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE: 55
OSN_CMN_OBJECTTYPE_REPLICATION_SCHEDULE_ASSOC: 56
OSN_CMN_OBJECTTYPE_HW_LOGICAL_DRIVE: 57
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_RECOVERY_POINT: 58
OSN_CMN_OBJECTTYPE_CLOUD_CONTAINER: 59
OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER: 60
OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_CREDENTIALS: 61
OSN_CMN_OBJECTTYPE_DEPRECATED_62: 62
OSN_CMN_OBJECTTYPE_DEPRECATED_63: 63
OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_LOCATION: 64
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER: 65
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_CLUSTER_ASSOC: 66
OSN_CMN_OBJECTTYPE_DEPRECATED_67: 67
OSN_CMN_OBJECTTYPE_FC_TARGET_PORT: 68
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_SERVICE_CONFIG: 69
OSN_CMN_OBJECTTYPE_WIDGET: 70
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_LINK_KEY: 71
OSN_CMN_OBJECTTYPE_STORAGE_POOL_PROFILE: 72
OSN_CMN_OBJECTTYPE_STORAGE_QUOTA_SHARE_ASSOC: 73
OSN_CMN_OBJECTTYPE_SITE_CLUSTER: 74
OSN_CMN_OBJECTTYPE_SITE_CLUSTER_ASSOC: 75
OSN_CMN_OBJECTTYPE_VIRTUAL_INTERFACE_ASSOC: 76
OSN_CMN_OBJECTTYPE_IB_TARGET_PORT: 77
OSN_CMN_OBJECTTYPE_DEPRECATED_78: 78
OSN_CMN_OBJECTTYPE_DEPRECATED_79: 79
OSN_CMN_OBJECTTYPE_DEPRECATED_80: 80
OSN_CMN_OBJECTTYPE_DEPRECATED_81: 81
OSN_CMN_OBJECTTYPE_DEPRECATED_82: 82
OSN_CMN_OBJECTTYPE_DEPRECATED_83: 83
OSN_CMN_OBJECTTYPE_DEPRECATED_84: 84
OSN_CMN_OBJECTTYPE_DEPRECATED_85: 85
OSN_CMN_OBJECTTYPE_DEPRECATED_86: 86
OSN_CMN_OBJECTTYPE_DEPRECATED_87: 87
OSN_CMN_OBJECTTYPE_DEPRECATED_88: 88
OSN_CMN_OBJECTTYPE_DEPRECATED_89: 89
OSN_CMN_OBJECTTYPE_DEPRECATED_90: 90
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_USER_ACCESS: 91
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_CIFS_OPTION: 92
OSN_CMN_OBJECTTYPE_ALERT_TRIGGER: 93
OSN_CMN_OBJECTTYPE_HW_ENCLOSURE_LAYOUT: 94
OSN_CMN_OBJECTTYPE_HW_UNIT_DISK_ASSOC: 95
OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_GROUP: 96
OSN_CMN_OBJECTTYPE_STORAGE_POOL_HA_FAILOVER_INTERFACE: 97
OSN_CMN_OBJECTTYPE_DEPRECATED_98: 98
OSN_CMN_OBJECTTYPE_BACKUP_POLICY: 99
OSN_CMN_OBJECTTYPE_BACKUP_JOB: 100
OSN_CMN_OBJECTTYPE_DEPRECATED_101: 101
OSN_CMN_OBJECTTYPE_CEPH_POOL: 102
OSN_CMN_OBJECTTYPE_CEPH_OSD: 103
OSN_CMN_OBJECTTYPE_CEPH_POOL_OSD_ASSOC: 104
OSN_CMN_OBJECTTYPE_CEPH_CLUSTER: 105
OSN_CMN_OBJECTTYPE_CEPH_MONITOR: 106
OSN_CMN_OBJECTTYPE_DEPRECATED_107: 107
OSN_CMN_OBJECTTYPE_DEPRECATED_108: 108
OSN_CMN_OBJECTTYPE_PHYSICAL_DISK_HOTSPARE_MARKER: 109
OSN_CMN_OBJECTTYPE_SITE_VIF_RESOURCE: 110
OSN_CMN_OBJECTTYPE_CLUSTER_RING: 111
OSN_CMN_OBJECTTYPE_CLUSTER_RING_MEMBER: 112
OSN_CMN_OBJECTTYPE_CEPH_CLUSTER_MEMBER: 113
OSN_CMN_OBJECTTYPE_SW_CONTROLLER: 114
OSN_CMN_OBJECTTYPE_SW_CONTROLLER_GROUP: 115
OSN_CMN_OBJECTTYPE_SW_CONTROLLER_TARGET: 116
OSN_CMN_OBJECTTYPE_SW_DISK_SESSION: 117
OSN_CMN_OBJECTTYPE_QOS_POLICY: 118
OSN_CMN_OBJECTTYPE_CEPH_PG_SET: 119
OSN_CMN_OBJECTTYPE_CEPH_JOURNAL_DEVICE: 120
OSN_CMN_OBJECTTYPE_RESOURCE_DOMAIN: 121
OSN_CMN_OBJECTTYPE_CEPH_OBJECT_POOL_GROUP: 122
OSN_CMN_OBJECTTYPE_S3_USER: 123
OSN_CMN_OBJECTTYPE_RESOURCE_DOMAIN_ASSOC: 124
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_NAMESPACE: 125
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_NAMESPACE_SYSTEM_ASSOC: 126
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_NAMESPACE_SHARE_ASSOC: 127
OSN_CMN_OBJECTTYPE_CEPH_POOL_PROFILE: 128
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_SESSION: 129
OSN_CMN_OBJECTTYPE_PASSWORD_POLICY: 130
OSN_CMN_OBJECTTYPE_MULTIPATH_CONFIG: 131
OSN_CMN_OBJECTTYPE_REPLICA_REPORT_ENTRY: 132
OSN_CMN_OBJECTTYPE_REPLICA_REPORT_SUMMARY: 133
OSN_CMN_OBJECTTYPE_STORAGE_POOL_DEVICE_GROUP: 134
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_FILE_LOCK: 135
OSN_CMN_OBJECTTYPE_MULTIFACTORAUTH_CONFIG: 136
OSN_CMN_OBJECTTYPE_PROVIDER_APP: 137
OSN_CMN_OBJECTTYPE_USER_APP_TOKEN: 138
OSN_CMN_OBJECTTYPE_ALERT_TYPE: 139
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_HW_CONFIG: 140
OSN_CMN_OBJECTTYPE_MULTIFACTORAUTH_DEVICE: 141
OSN_CMN_OBJECTTYPE_CEPH_RADOS_GATEWAY: 142
OSN_CMN_OBJECTTYPE_CEPH_CRUSH_RULE: 143
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_TUNABLE: 144
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_TUNABLE_PROFILE: 145
OSN_CMN_OBJECTTYPE_STORAGE_SYSTEM_TUNABLE_ASSOC: 146
OSN_CMN_OBJECTTYPE_CEPH_FILESYSTEM: 147
OSN_CMN_OBJECTTYPE_CEPH_POOL_GROUP_ASSOC: 148
OSN_CMN_OBJECTTYPE_CEPH_METADATA_SERVER: 149
OSN_CMN_OBJECTTYPE_SERVICE_FIREWALL_DEF: 150
OSN_CMN_OBJECTTYPE_DEPRECATED_151: 151
OSN_CMN_OBJECTTYPE_DEPRECATED_152: 152
OSN_CMN_OBJECTTYPE_DEPRECATED_153: 153
OSN_CMN_OBJECTTYPE_BUCKET: 154
OSN_CMN_OBJECTTYPE_DEPRECATED_155: 155
OSN_CMN_OBJECTTYPE_S3_OBJECT: 156
OSN_CMN_OBJECTTYPE_DEPRECATED_157: 157
OSN_CMN_OBJECTTYPE_SNAPSHOT_REFERENCE: 158
OSN_CMN_OBJECTTYPE_S3_USER_ACCESS_KEY: 159
OSN_CMN_OBJECTTYPE_STORAGE_VOLUME_PROFILE: 160
OSN_CMN_OBJECTTYPE_S3_PROXY: 161
OSN_CMN_OBJECTTYPE_CEPH_JOURNAL_GROUP: 162
OSN_CMN_OBJECTTYPE_HW_ENCLOSURE_LAYOUT_VENDOR_GROUP: 163
OSN_CMN_OBJECTTYPE_DEPRECATED_164: 164
OSN_CMN_OBJECTTYPE_DEPRECATED_165: 165
OSN_CMN_OBJECTTYPE_SINGLE_SIGN_ON_POLICY: 166
OSN_CMN_OBJECTTYPE_REPORT_SCHEDULE: 167
OSN_CMN_OBJECTTYPE_REPORT_SCHEDULE_ASSOC: 168
OSN_CMN_OBJECTTYPE_REPORT: 169
OSN_CMN_OBJECTTYPE_CLOUD_CONTAINER_CACHE_SETTINGS: 170
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM: 171
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_PORT: 172
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_PORT_GROUP: 173
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_POOL: 174
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_VOLUME: 175
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_MEDIA: 176
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_CONTROLLER: 177
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_CREDENTIALS: 178
OSN_CMN_OBJECTTYPE_TARGET_PORT_STATIC_ROUTE: 179
OSN_CMN_OBJECTTYPE_SITE_VIF_LOCATION_CONSTRAINT: 180
OSN_CMN_OBJECTTYPE_MAINTENANCE_SCHEDULE: 181
OSN_CMN_OBJECTTYPE_MAINTENANCE_SCHEDULE_ASSOC: 182
OSN_CMN_OBJECTTYPE_KEY_SERVER_PROFILE: 183
OSN_CMN_OBJECTTYPE_KEY_SERVER_PROFILE_KEY: 184
OSN_CMN_OBJECTTYPE_NONE: 185
OSN_CMN_OBJECTTYPE_CEPH_CLUSTER_HEALTH_EVENT: 186
OSN_CMN_OBJECTTYPE_RESOURCE_GROUP_NETWORK: 187
OSN_CMN_OBJECTTYPE_ALERT_CONFIG_ENDPOINT: 188
OSN_CMN_OBJECTTYPE_CONTAINER_CONFIG: 189
OSN_CMN_OBJECTTYPE_CONTAINER_CONFIG_OPTION: 190
OSN_CMN_OBJECTTYPE_CONTAINER: 191
OSN_CMN_OBJECTTYPE_CONTAINER_SERVICE_DEF: 192
OSN_CMN_OBJECTTYPE_S3_TENANT: 193
OSN_CMN_OBJECTTYPE_CLOUD_PROVIDER_STORAGE_CLASS: 194
OSN_CMN_OBJECTTYPE_CEPH_CLIENT_KEYRING: 195
OSN_CMN_OBJECTTYPE_CEPH_CLIENT_KEYRING_RESOURCE_ASSOC: 196
OSN_CMN_OBJECTTYPE_LOAD_BALANCER: 197
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_PROFILE: 198
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_HOST: 199
OSN_CMN_OBJECTTYPE_CLIENT_CONNECTION: 200
OSN_CMN_OBJECTTYPE_PING_DATA: 201
OSN_CMN_OBJECTTYPE_EXTERNAL_SYSTEM_HOST_VOLUME_ASSOC: 202
OSN_CMN_OBJECTTYPE_CEPH_OBJECT_STORAGE_CLASS: 203
OSN_CMN_OBJECTTYPE_CEPH_OBJECT_ZONE: 204
OSN_CMN_OBJECTTYPE_CEPH_OBJECT_ZONE_GROUP: 205
OSN_CMN_OBJECTTYPE_CEPH_OBJECT_STORAGE_CLASS_RULE: 206
OSN_CMN_OBJECTTYPE_HW_SLOT: 207
OSN_CMN_OBJECTTYPE_ALERT_HANDLER: 208
OSN_CMN_OBJECTTYPE_HEALTH_STATUS_EVENT: 209
OSN_CMN_OBJECTTYPE_FC_REMOTE_PORT: 210
OSN_CMN_OBJECTTYPE_CONTAINER_SERVICE_DEF_OPTION: 211
OSN_CMN_OBJECTTYPE_CERTIFICATE: 212
OSN_CMN_OBJECTTYPE_CERTIFICATE_TEMPLATE: 213
OSN_CMN_OBJECTTYPE_OBJECT_SYNC_POLICY: 214
OSN_CMN_OBJECTTYPE_PORTAL_GROUP: 215
OSN_CMN_OBJECTTYPE_PORTAL_GROUP_PORT_ASSOC: 216
OSN_CMN_OBJECTTYPE_DASHBOARD: 217
OSN_CMN_OBJECTTYPE_DASHBOARD_GROUP: 218
OSN_CMN_OBJECTTYPE_NETWORK_SHARE_TEMPLATE: 219
OSN_CMN_OBJECTTYPE_PENDING_OPERATION_REQUEST: 220
OSN_CMN_OBJECTTYPE_PENDING_OPERATION_APPROVAL: 221
OSN_CMN_OBJECTTYPE_CEPH_POOL_NAMESPACE: 222
OSN_CMN_OBJECTTYPE_MAX: 223
== enum:otpSecretKeyMode ==
for 2FA support, indicates one-time-password secret key encryption mode

''' Enumeration Values '''
OSN_CMN_OTP_SECRET_KEY_MODE_NONE: 0
OSN_CMN_OTP_SECRET_KEY_MODE_AES256: 1
OSN_CMN_OTP_SECRET_KEY_MODE_MAX: 2
== enum:passthruMode ==
''' Enumeration Values '''
OSN_CMN_NO_PASSTHRU: 0
OSN_CMN_PASSTHRU_PARTITIONED_DEVICE: 1
OSN_CMN_PASSTHRU_RAW_DEVICE: 2
OSN_CMN_PASSTHRU_MAX: 3
== enum:passwordComplexityReq ==
Password complexity policy for management user accounts. Standard mode or higher is required for NIST compliance.

''' Enumeration Values '''
OSN_PW_COMPLEXITY_WEAK: 0
OSN_PW_COMPLEXITY_STANDARD: 1
OSN_PW_COMPLEXITY_STRONG: 2
== enum:pendingOperationRequestStatus ==
''' Enumeration Values '''
OSN_PENDING_OPERATION_REQUEST_STATUS_PENDING: 0
OSN_PENDING_OPERATION_REQUEST_STATUS_APPROVED: 1
OSN_PENDING_OPERATION_REQUEST_STATUS_REJECTED: 2
OSN_PENDING_OPERATION_REQUEST_STATUS_EXPIRED: 3
OSN_PENDING_OPERATION_REQUEST_STATUS_CANCELLED: 4
OSN_PENDING_OPERATION_REQUEST_STATUS_RUNNING: 5
OSN_PENDING_OPERATION_REQUEST_STATUS_COMPLETED_SUCCESS: 6
OSN_PENDING_OPERATION_REQUEST_STATUS_COMPLETED_FAILED: 7
OSN_PENDING_OPERATION_REQUEST_STATUS_MAX: 8
== enum:permissionScope ==
''' Enumeration Values '''
OSN_SCOPE_NONE: 0
OSN_SCOPE_USER: 1
OSN_SCOPE_RESOURCE_GROUP: 2
OSN_SCOPE_SYSTEM: 3
OSN_SCOPE_GRID: 4
== enum:pingTarget ==
''' Enumeration Values '''
OSN_CMN_PING_TARG_SERVER_IP: 0
OSN_CMN_PING_TARG_CLIENT_IP: 1
OSN_CMN_PING_TARG_USER_IP: 2
OSN_CMN_PING_TARG_MAX: 3
== enum:poolEnclosureRedundancy ==
Relationship between a storage pool and how the data is striped across disks based on which disk enclosure the disk resides in . Pool creation automatically analyzes this relationship and will select drives to ensure enclosure level reduncancy whenever possible.

''' Enumeration Values '''
OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_UNKNOWN: 0
OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_VERIFIED: 1
OSN_CMN_POOL_ENCLOSURE_NOT_REDUNDANT: 2
OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_NA: 3
OSN_CMN_POOL_ENCLOSURE_REDUNDANCY_PARTIAL: 4
== enum:portalGroupAccessOptions ==
what type of data conversion required for a physicalDiskCopy

''' Enumeration Values '''
OSN_CMN_PORTAL_GROUP_DEFAULTS: 0
OSN_CMN_PORTAL_GROUP_ALL_PREFERRED: 1
OSN_CMN_PORTAL_GROUP_SINGLE_PREFERRED: 2
== enum:portalGroupOptions ==
flags for clearing ports from portal groups

''' Enumeration Values '''
OSN_PORTALGROUP_OPTION_NONE: 0
OSN_PORTALGROUP_OPTION_USE_ALL_FC_PORTS: 1
OSN_PORTALGROUP_OPTION_USE_ALL_VIF_PORTS: 2
OSN_PORTALGROUP_OPTION_MAX: 4
== enum:protocolDisable ==
used by the firewall settings to disable/enable specific protocols

''' Enumeration Values '''
OSN_PROTOCOL_NONE_DISABLE: 0
OSN_PROTOCOL_NFS_DISABLE: 1
OSN_PROTOCOL_SMB_DISABLE: 2
OSN_PROTOCOL_GANESHA_DISABLE: 4
OSN_PROTOCOL_RESTAPI_DISABLE: 8
OSN_PROTOCOL_ISCSI_DISABLE: 16
OSN_PROTOCOL_CEPH_DISABLE: 32
OSN_PROTOCOL_WEBUI_DISABLE: 64
OSN_PROTOCOL_NVMEOF_DISABLE: 128
OSN_PROTOCOL_CHRONOGRAF_DISABLE: 256
== enum:providerRegistrationScope ==
Applies to custom integration providers like the one for VMware VASA

''' Enumeration Values '''
OSN_REGISTRATION_SCOPE_LOCAL: 0
OSN_REGISTRATION_SCOPE_CLUSTER_WIDE: 1
== enum:providerType ==
''' Enumeration Values '''
OSN_PROVIDER_TYPE_NONE: 0
OSN_PROVIDER_TYPE_VMWARE_VASA: 1
== enum:quotaPolicy ==
''' Enumeration Values '''
OSN_CMN_QUOTA_POLICY_SOFT: 0
OSN_CMN_QUOTA_POLICY_HARD: 1
== enum:quotaSubjectType ==
''' Enumeration Values '''
OSN_QUOTA_SUBJECT_POSIX_USER: 0
OSN_QUOTA_SUBJECT_POSIX_GROUP: 1
OSN_QUOTA_SUBJECT_AD_USER: 2
OSN_QUOTA_SUBJECT_AD_GROUP: 3
== enum:raidType ==
''' Enumeration Values '''
OSN_RAIDTYPE_RAID0: 0
OSN_RAIDTYPE_RAID1: 1
OSN_RAIDTYPE_RAID2: 2
OSN_RAIDTYPE_RAID3: 3
OSN_RAIDTYPE_RAID4: 4
OSN_RAIDTYPE_RAID5: 5
OSN_RAIDTYPE_RAID6: 6
OSN_RAIDTYPE_RAID7: 7
OSN_RAIDTYPE_RAID8: 8
OSN_RAIDTYPE_RAID9: 9
OSN_RAIDTYPE_RAID10: 10
OSN_RAIDTYPE_RAID_AUTO: 11
OSN_RAIDTYPE_SINGLE: 12
OSN_RAIDTYPE_JBOD: 13
OSN_RAIDTYPE_RAID50: 14
OSN_RAIDTYPE_RAID60: 15
OSN_RAIDTYPE_RAID70: 16
OSN_RAIDTYPE_MULTIPLE: 17
OSN_RAIDTYPE_ERASURECODING: 18
OSN_RAIDTYPE_REPLICA: 19
OSN_RAIDTYPE_DRAID1_1S: 20
OSN_RAIDTYPE_DRAID1_2S: 21
OSN_RAIDTYPE_DRAID1_3S: 22
OSN_RAIDTYPE_DRAID2_1S: 23
OSN_RAIDTYPE_DRAID2_2S: 24
OSN_RAIDTYPE_DRAID2_3S: 25
OSN_RAIDTYPE_DRAID3_1S: 26
OSN_RAIDTYPE_DRAID3_2S: 27
OSN_RAIDTYPE_DRAID3_3S: 28
OSN_RAIDTYPE_ADAPT: 29
OSN_RAIDTYPE_MAX: 30
== enum:replicaAssocType ==
''' Enumeration Values '''
OSN_CMN_REPLICA_CHILD: 0
OSN_CMN_REPLICA_HEAD: 1
== enum:replicaRetentionTag ==
''' Enumeration Values '''
OSN_CMN_REPLICATION_RETENTION_TAG_NONE: 0
OSN_CMN_REPLICATION_RETENTION_TAG_DELTA: 1
OSN_CMN_REPLICATION_RETENTION_TAG_DAILY: 2
OSN_CMN_REPLICATION_RETENTION_TAG_WEEKLY: 4
OSN_CMN_REPLICATION_RETENTION_TAG_BIWEEKLY: 8
OSN_CMN_REPLICATION_RETENTION_TAG_MONTHLY: 16
OSN_CMN_REPLICATION_RETENTION_TAG_BIMONTHLY: 32
OSN_CMN_REPLICATION_RETENTION_TAG_QUARTERLY: 64
OSN_CMN_REPLICATION_RETENTION_TAG_YEARLY: 128
OSN_CMN_REPLICATION_RETENTION_TAG_HOURLY: 256
OSN_CMN_REPLICATION_RETENTION_TAG_LOCAL_DELTA: 512
== enum:replicationActionType ==
''' Enumeration Values '''
OSN_CMN_REPLICATION_SETUP: 0
OSN_CMN_REPLICATION_CONNECT: 1
OSN_CMN_REPLICATION_DISCONNECT: 2
OSN_CMN_REPLICATION_RECONNECT: 3
OSN_CMN_REPLICATION_ADJUST: 4
== enum:replicationCongestionPolicy ==
''' Enumeration Values '''
OSN_CMN_REPLICATION_CONGESTION_POLICY_SYNC: 0
OSN_CMN_REPLICATION_CONGESTION_POLICY_PULL_AHEAD: 1
== enum:replicationState ==
''' Enumeration Values '''
OSN_CMN_REPLICATION_STATE_PREPARING: 0
OSN_CMN_REPLICATION_STATE_INITIALIZING: 1
OSN_CMN_REPLICATION_STATE_SYNCHRONIZING: 2
OSN_CMN_REPLICATION_STATE_SYNCHRONIZED: 3
OSN_CMN_REPLICATION_STATE_RESYNCHRONIZING: 4
OSN_CMN_REPLICATION_STATE_PAUSED: 5
OSN_CMN_REPLICATION_STATE_INIT_FAILED: 6
OSN_CMN_REPLICATION_STATE_SYNC_FAILED: 7
OSN_CMN_REPLICATION_STATE_RESYNC_FAILED: 8
OSN_CMN_REPLICATION_STATE_SKIPPED: 9
OSN_CMN_REPLICATION_STATE_CANCELLED: 10
OSN_CMN_REPLICATION_STATE_RESUMABLE_SYNC_FAILED: 11
== enum:reportCategory ==
Configuration analysis reports have each report entry marked with one or more categories via bitmask

''' Enumeration Values '''
OSN_CMN_REPORT_CATEGORY_ALL: 0
OSN_CMN_REPORT_CATEGORY_NETWORKING: 1
OSN_CMN_REPORT_CATEGORY_HIGH_AVAILABILITY: 2
OSN_CMN_REPORT_CATEGORY_REMOTE_REPLICATION: 4
OSN_CMN_REPORT_CATEGORY_SECURITY: 8
OSN_CMN_REPORT_CATEGORY_PLATFORM: 16
OSN_CMN_REPORT_CATEGORY_HARDWARE_MAINTENANCE: 32
OSN_CMN_REPORT_CATEGORY_ENCRYPTION: 64
OSN_CMN_REPORT_CATEGORY_MAX: 128
== enum:reportImpact ==
type of impact the reported issue may have if not addressed

''' Enumeration Values '''
OSN_CMN_REPORT_IMPACT_ALL: 0
OSN_CMN_REPORT_IMPACT_STABILITY: 1
OSN_CMN_REPORT_IMPACT_PERFORMANCE: 2
OSN_CMN_REPORT_IMPACT_SECURITY: 4
OSN_CMN_REPORT_IMPACT_MAX: 8
== enum:reportOutputFormat ==
Report Schedules send email reports to designated email addresses in one of four formats, (0) text mode, (1) HTML mode (default), (2) comma-separated-value CSV, and HTML Base64 (3).

''' Enumeration Values '''
OSN_CMN_REPORT_OUTPUT_FORMAT_TEXT: 0
OSN_CMN_REPORT_OUTPUT_FORMAT_HTML: 1
OSN_CMN_REPORT_OUTPUT_FORMAT_CSV: 2
OSN_CMN_REPORT_OUTPUT_FORMAT_HTML_BASE64: 3
== enum:reportSeverity ==
Severity of the detected issue

''' Enumeration Values '''
OSN_CMN_REPORT_SEVERITY_INFORMATIONAL: 0
OSN_CMN_REPORT_SEVERITY_MINOR: 1
OSN_CMN_REPORT_SEVERITY_MAJOR: 2
OSN_CMN_REPORT_SEVERITY_CRITICAL: 4
OSN_CMN_REPORT_SEVERITY_MAX: 8
== enum:reportTypes ==
''' Enumeration Values '''
OSN_REPORT_TYPE_NONE: 0
OSN_REPORT_TYPE_SYSTEM_HEALTH: 1
OSN_REPORT_TYPE_STORAGE_POOL_CAPACITY_PLANNING: 2
OSN_REPORT_TYPE_STORAGE_POOL_USAGE: 4
OSN_REPORT_TYPE_REPLICATION: 8
OSN_REPORT_TYPE_OBJECT_STORAGE_USAGE: 16
OSN_REPORT_TYPE_MAX: 32
== enum:resourceAccessMode ==
''' Enumeration Values '''
OSN_CMN_RESOURCEACCESS_AUTO: 0
OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED: 1
OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE: 2
OSN_CMN_RESOURCEACCESS_IMMUTABLE: 4
OSN_CMN_RESOURCEACCESS_MULTIGROUP_SHARED_IMMUTABLE: 5
OSN_CMN_RESOURCEACCESS_GROUP_EXCLUSIVE_IMMUTABLE: 6
== enum:resourceAccessRequestType ==
''' Enumeration Values '''
OSN_CMN_REQUEST_VIEW: 0
OSN_CMN_REQUEST_UTILIZE: 1
OSN_CMN_REQUEST_MODIFY: 2
== enum:resourceDomainTypes ==
Specifies the type of resource in a resource domain hierarchy

''' Enumeration Values '''
OSN_RESOURCE_DOMAIN_REGION: 0
OSN_RESOURCE_DOMAIN_SITE: 1
OSN_RESOURCE_DOMAIN_BUILDING: 2
OSN_RESOURCE_DOMAIN_RACK: 3
OSN_RESOURCE_DOMAIN_SERVER: 4
OSN_RESOURCE_DOMAIN_MAX: 5
== enum:retentionTag ==
''' Enumeration Values '''
OSN_RETENTIONTAG_NONE: 0
OSN_RETENTIONTAG_DAY: 1
OSN_RETENTIONTAG_WEEK: 2
OSN_RETENTIONTAG_MONTH: 4
OSN_RETENTIONTAG_YEARLY: 8
OSN_RETENTIONTAG_MAX: 9
== enum:s3QuotaScope ==
scope of a given Object quota setting

''' Enumeration Values '''
OSN_S3_QUOTA_SCOPE_ALL: 0
OSN_S3_QUOTA_SCOPE_BUCKET: 1
OSN_S3_QUOTA_SCOPE_USER: 2
OSN_S3_QUOTA_SCOPE_USER_BUCKET: 3
== enum:sambaIdmapMode ==
Mode for how SMB user and group IDs should be managed.

''' Enumeration Values '''
OSN_CMN_SAMBA_IDMAP_TDB: 0
OSN_CMN_SAMBA_IDMAP_RID: 1
OSN_CMN_SAMBA_IDMAP_AD: 2
OSN_CMN_SAMBA_IDMAP_AUTORID: 4
OSN_CMN_SAMBA_IDMAP_AD_RFC2307: 8
== enum:scheduleTimerType ==
''' Enumeration Values '''
OSN_SCHEDULE_TIMER_CALENDAR_BASED: 0
OSN_SCHEDULE_TIMER_INTERVAL_BASED: 1
OSN_SCHEDULE_TIMER_MAX: 2
== enum:securityWebAccessMode ==
HTTP requests are redirected to HTTPS by default but his allows one to reconfigure that behavior.

''' Enumeration Values '''
OSN_CMN_WEBACCESSMODE_HTTP_ENABLED: 0
OSN_CMN_WEBACCESSMODE_HTTP_DISABLED: 1
OSN_CMN_WEBACCESSMODE_HTTP_REDIRECTED: 2
== enum:serverType ==
indicates the KMIP server type when adding a new KMIP service entry.

''' Enumeration Values '''
OSN_KMIPSRV_DEFAULT: 0
OSN_KMIPSRV_KMIP: 1
OSN_KMIPSRV_IBM: 2
== enum:serviceFirewallDefState ==
allow (0) indicates the protocol/service is allowed, block (1) blocks the ports for the protocol/service, and inherit (2) indicates that it is inheriting the Storage System level firewall setting for this service/protocol.

''' Enumeration Values '''
OSN_SERVICE_FIREWALL_DEF_ALLOW: 0
OSN_SERVICE_FIREWALL_DEF_BLOCK: 1
OSN_SERVICE_FIREWALL_DEF_INHERIT: 2
== enum:serviceOptions ==
used by system obj bitmsak to disable certain managers

''' Enumeration Values '''
OSN_CMN_SERVICEOPT_NONE: 0
OSN_CMN_SERVICEOPT_DISABLE_DISK_BEACON_MANAGEMENT: 1
OSN_CMN_SERVICEOPT_DISABLE_PASSTHRU_MANAGER: 2
== enum:servicePortType ==
''' Enumeration Values '''
OSN_CMN_SERVICE_UNKNOWN: 0
OSN_CMN_SERVICE_ISCSI: 1
OSN_CMN_SERVICE_NFS: 2
OSN_CMN_SERVICE_SMB: 3
OSN_CMN_SERVICE_NVMEOF: 4
OSN_CMN_SERVICE_CEPH_MON: 5
OSN_CMN_SERVICE_LOADBALANCER: 6
OSN_CMN_SERVICE_S3GATEWAY: 7
OSN_CMN_SERVICE_SSH: 8
== enum:serviceState ==
''' Enumeration Values '''
OSN_CMN_SERVICE_OFFLINE: 0
OSN_CMN_SERVICE_INITIALIZING: 1
OSN_CMN_SERVICE_RUNNING: 2
OSN_CMN_SERVICE_STOPPING: 3
== enum:serviceUpdateMode ==
''' Enumeration Values '''
OSN_SERVICE_OP_MODE_START: 0
OSN_SERVICE_OP_MODE_RESTART: 1
OSN_SERVICE_OP_MODE_STOP: 3
== enum:shareSettingsInheritance ==
''' Enumeration Values '''
OSN_SHARE_INHERITS_NONE: 0
OSN_SHARE_INHERITS_CIFS_ACCESS: 1
OSN_SHARE_INHERITS_NFS_ACCESS: 2
== enum:siteClusterStandbyState ==
Indicates the standby state of the heartbeat / Site Cluster

''' Enumeration Values '''
OSN_STANDBY_STATE_DISABLED: 0
OSN_STANDBY_STATE_ENABLED: 1
OSN_STANDBY_STATE_ENABLED_MANUAL: 2
== enum:siteVifLocationWeight ==
Location Constraint weights refer to the 'score' value in Pacemaker where the higher the value the stronger the affinity the resource or resource group has to running on associated node

''' Enumeration Values '''
OSN_CMN_LOCATION_CONSTRAINT_WEIGHT_NONE: 0
OSN_CMN_LOCATION_CONSTRAINT_WEIGHT_LOW: 100
OSN_CMN_LOCATION_CONSTRAINT_WEIGHT_MEDIUM: 200
OSN_CMN_LOCATION_CONSTRAINT_WEIGHT_HIGH: 300
== enum:sizeUnits ==
''' Enumeration Values '''
OSN_CMN_SIZE_UNITS_B: 0
OSN_CMN_SIZE_UNITS_KB: 1
OSN_CMN_SIZE_UNITS_MB: 2
OSN_CMN_SIZE_UNITS_GB: 3
OSN_CMN_SIZE_UNITS_TB: 4
OSN_CMN_SIZE_UNITS_PB: 5
OSN_CMN_SIZE_UNITS_EB: 6
== enum:sourceType ==
type of source device for a physicalDiskCopy

''' Enumeration Values '''
OSN_CMN_SOURCETYPE_PHYSICAL_DISK: 0
OSN_CMN_SOURCETYPE_STORAGE_VOLUME: 1
== enum:storagePoolCacheType ==
''' Enumeration Values '''
OSN_STORAGEPOOLCACHETYPE_READCACHE: 1
OSN_STORAGEPOOLCACHETYPE_WRITELOG: 2
OSN_STORAGEPOOLCACHETYPE_DEDUP: 3
OSN_STORAGEPOOLCACHETYPE_SPECIAL: 4
OSN_STORAGEPOOLCACHETYPE_MAX: 5
== enum:storagePoolType ==
''' Enumeration Values '''
OSN_STORAGEPOOLTYPE_BTRFS: 0
OSN_STORAGEPOOLTYPE_EXT3: 1
OSN_STORAGEPOOLTYPE_EXT4: 2
OSN_STORAGEPOOLTYPE_XFS: 3
OSN_STORAGEPOOLTYPE_S3QL: 4
OSN_STORAGEPOOLTYPE_JFS: 5
OSN_STORAGEPOOLTYPE_ZFS: 6
OSN_STORAGEPOOLTYPE_CEPHRBD: 7
OSN_STORAGEPOOLTYPE_SWAP: 8
OSN_STORAGEPOOLTYPE_PASSTHRU: 9
OSN_STORAGEPOOLTYPE_LOCAL: 10
OSN_STORAGEPOOLTYPE_UNKNOWN: 11
OSN_STORAGEPOOLTYPE_CEPHFS: 12
OSN_STORAGEPOOLTYPE_CEPHOBJ: 13
OSN_STORAGEPOOLTYPE_MAX: 14
== enum:storageSystemLinkType ==
Indicates the mode which the storage replication link is operating in which can be with or without encryption and/or compression

''' Enumeration Values '''
OSN_LINK_TYPE_ENCRYPTED_UNCOMPRESSED: 0
OSN_LINK_TYPE_UNENCRYPTED: 1
OSN_LINK_TYPE_COMPRESSED: 2
OSN_LINK_TYPE_UNENCRYPTED_COMPRESSED: 3
OSN_LINK_TYPE_UNKNOWN: 4
OSN_LINK_TYPE_MAX: 5
== enum:storageVolumeType ==
''' Enumeration Values '''
OSN_STORAGEVOLUMETYPE_FILE: 0
OSN_STORAGEVOLUMETYPE_FILE_BTRFS: 1
OSN_STORAGEVOLUMETYPE_FILE_EXT3: 2
OSN_STORAGEVOLUMETYPE_FILE_EXT4: 3
OSN_STORAGEVOLUMETYPE_RAW_DEVICE: 4
OSN_STORAGEVOLUMETYPE_FILE_ZFS: 5
OSN_STORAGEVOLUMETYPE_FILE_XFS: 6
OSN_STORAGEVOLUMETYPE_FILE_S3QL: 7
OSN_STORAGEVOLUMETYPE_FILE_JFS: 8
OSN_STORAGEVOLUMETYPE_CEPH_RBD: 9
== enum:swControllerConnectionState ==
''' Enumeration Values '''
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_UNKNOWN: 0
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_FREE: 1
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_TRANSPORT_WAIT: 2
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_IN_LOGIN: 3
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_LOGGED_IN: 4
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_IN_LOGOUT: 5
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_LOGOUT_REQUESTED: 6
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_CLEANUP_WAIT: 7
OSN_CMN_SW_CONTROLLER_CONNECTION_STATE_MAX: 8
== enum:swControllerSessionState ==
''' Enumeration Values '''
OSN_CMN_SW_CONTROLLER_SESSION_STATE_UNKNOWN: 0
OSN_CMN_SW_CONTROLLER_SESSION_STATE_NO_CHANGE: 1
OSN_CMN_SW_CONTROLLER_SESSION_STATE_CLEANUP: 2
OSN_CMN_SW_CONTROLLER_SESSION_STATE_REOPEN: 3
OSN_CMN_SW_CONTROLLER_SESSION_STATE_REDIRECT: 4
OSN_CMN_SW_CONTROLLER_SESSION_STATE_MAX: 5
== enum:swControllerType ==
type of protocol used by software controller connecting target device to initiator

''' Enumeration Values '''
OSN_CMN_SW_CONTROLLER_TYPE_ISCSI: 0
OSN_CMN_SW_CONTROLLER_TYPE_NVME_TCP: 1
OSN_CMN_SW_CONTROLLER_TYPE_NVME_RDMA: 2
OSN_CMN_SW_CONTROLLER_TYPE_NVME_LOCAL_PCIE: 4
OSN_CMN_SW_CONTROLLER_TYPE_UNKNOWN: 255
== enum:syncFlowDirection ==
''' Enumeration Values '''
OSN_CMN_SYNC_FLOW_DIR_UNKNOWN: 0
OSN_CMN_SYNC_FLOW_DIR_SYMMETRICAL: 1
OSN_CMN_SYNC_FLOW_DIR_DIRECTIONAL: 2
== enum:syncPolicy ==
Data synchronization mode for ZFS based Storage Pools, Network Shares, and Storage Volumes

''' Enumeration Values '''
OSN_CMN_SYNCTYPE_STANDARD: 0
OSN_CMN_SYNCTYPE_ALWAYS: 1
OSN_CMN_SYNCTYPE_DISABLED: 2
OSN_CMN_SYNCTYPE_AUTO: 3
== enum:syncPolicyStatus ==
''' Enumeration Values '''
OSN_CMN_SYNC_POLICY_STATUS_UNKNOWN: 0
OSN_CMN_SYNC_POLICY_STATUS_ENABLED: 1
OSN_CMN_SYNC_POLICY_STATUS_ALLOWED: 2
OSN_CMN_SYNC_POLICY_STATUS_FORBIDDEN: 3
== enum:targetType ==
type of target device for a physicalDiskCopy

''' Enumeration Values '''
OSN_CMN_TARGETTYPE_PHYSICAL_DISK: 0
OSN_CMN_TARGETTYPE_STORAGE_VOLUME: 1
OSN_CMN_TARGETTYPE_NETWORK_SHARE: 2
== enum:taskState ==
''' Enumeration Values '''
OSN_TASKSTATE_INITIALIZING: 0
OSN_TASKSTATE_QUEUED: 1
OSN_TASKSTATE_RUNNING: 2
OSN_TASKSTATE_FAILED: 3
OSN_TASKSTATE_CANCELLED: 4
OSN_TASKSTATE_COMPLETED: 5
OSN_TASKSTATE_WAITING: 6
OSN_TASKSTATE_RECOVERED: 7
OSN_TASKSTATE_STAGED: 8
== enum:trimStatus ==
''' Enumeration Values '''
OSN_CMN_MEDIA_TRIM_UNSUPPORTED: 0
OSN_CMN_MEDIA_TRIM_UNTRIMMED: 1
OSN_CMN_MEDIA_TRIM_TRIMMING: 2
OSN_CMN_MEDIA_TRIM_TRIMMED: 3
== enum:tunableDataType ==
storage system tunables are either a range, percentage or a boolean.

''' Enumeration Values '''
OSN_CMN_TUNABLE_RANGE: 0
OSN_CMN_TUNABLE_PERCENTAGE: 1
OSN_CMN_TUNABLE_BOOLEAN: 2
== enum:tunableOption ==
applies to storageSystemTunable APIs

''' Enumeration Values '''
OSN_CMN_TUNABLE_NONE: 0
OSN_CMN_TUNABLE_RESET_TO_DEFAULTS: 1
== enum:userAccountType ==
''' Enumeration Values '''
OSN_CMN_USER_ACCOUNT_STANDARD: 0
OSN_CMN_USER_ACCOUNT_EMERGENCY: 1
OSN_CMN_USER_ACCOUNT_TEMPORARY: 2
== enum:userAppTokenAccessMode ==
''' Enumeration Values '''
OSN_APPTOKEN_DISABLED: 0
OSN_APPTOKEN_LOCAL_ONLY: 1
OSN_APPTOKEN_REMOTE_ONLY: 2
OSN_APPTOKEN_ALL: 3
== enum:vdevType ==
''' Enumeration Values '''
OSN_VDEVTYPE_NA: 0
OSN_VDEVTYPE_DATA: 1
OSN_VDEVTYPE_LOGS: 2
OSN_VDEVTYPE_CACHE: 3
OSN_VDEVTYPE_SPARES: 4
OSN_VDEVTYPE_SPECIAL: 5
OSN_VDEVTYPE_DEDUP: 6
OSN_VDEVTYPE_CONFIG: 7
OSN_VDEVTYPE_MAX: 8
== enum:vifUseCase ==
indicates the use case for a specific VIF, scale-out vifs can be used for multiple purposes but by specifying the use case additional service checks are done to ensure the VIF is only active on nodes with those services

''' Enumeration Values '''
OSN_CMN_VIF_USE_CASE_GRID_PRIMARY: 1
OSN_CMN_VIF_USE_CASE_SCALEUP_POOL: 2
OSN_CMN_VIF_USE_CASE_SCALEOUT_FILE_POOL: 4
OSN_CMN_VIF_USE_CASE_SCALEOUT_BLOCK_POOL: 8
OSN_CMN_VIF_USE_CASE_SCALEOUT_OBJ_POOL: 16
OSN_CMN_VIF_USE_CASE_S3PROXY: 32
OSN_CMN_VIF_USE_CASE_OTHER: 64
OSN_CMN_VIF_USE_CASE_MAX: 128
== enum:vvolType ==
''' Enumeration Values '''
OSN_VVOL_TYPE_NONE: 0
OSN_VVOL_TYPE_SUBVOL_CONFIG: 1
OSN_VVOL_TYPE_SUBVOL_DATA: 2
OSN_VVOL_TYPE_SUBVOL_SWAP: 3
OSN_VVOL_TYPE_PE: 4
== enum:wuiSectionDisable ==
Most expandable tree sections in the WUI may be disabled on a per user basis with the userModify method. This is helpful for simplifying the user experience for users with specific roles and job functions.

''' Enumeration Values '''
OSN_CMN_WUI_SECTION_DISABLE_NONE: 0
OSN_CMN_WUI_SECTION_DISABLE_INHERIT: 1
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_PHYS_DISKS: 2
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_HARDWARE: 4
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_POOLS: 8
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_SHARES: 16
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_VOLUMES: 32
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_SNAP_SCHED: 64
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_HOSTS: 128
OSN_CMN_WUI_SECTION_DISABLE_STORAGE_MGMT_BUCKETS: 256
OSN_CMN_WUI_SECTION_DISABLE_SCALE_OUT_KEYRINGS: 512
OSN_CMN_WUI_SECTION_DISABLE_MAX: 1024
== enum:wuiTabDisable ==
Most tabs in the web management may be disabled on a per user basis using these options with the userModify method

''' Enumeration Values '''
OSN_CMN_WUI_TAB_DISABLE_NONE: 0
OSN_CMN_WUI_TAB_DISABLE_INHERIT: 1
OSN_CMN_WUI_TAB_DISABLE_STORAGE_MGMT: 2
OSN_CMN_WUI_TAB_DISABLE_USERS_GROUPS: 4
OSN_CMN_WUI_TAB_DISABLE_REMOTE_REPLICATION: 8
OSN_CMN_WUI_TAB_DISABLE_CLOUD_CONTAINERS: 16
OSN_CMN_WUI_TAB_DISABLE_CLUSTER_MGMT: 32
OSN_CMN_WUI_TAB_DISABLE_SCALE_OUT_NAS_MGMT: 64
OSN_CMN_WUI_TAB_DISABLE_SCALE_OUT_OBJ_MGMT: 128
OSN_CMN_WUI_TAB_DISABLE_MULTITENANCY: 256
OSN_CMN_WUI_TAB_DISABLE_GRID_DASHBOARD: 512
OSN_CMN_WUI_TAB_DISABLE_DASHBOARDS: 1024
OSN_CMN_WUI_TAB_DISABLE_MAX: 2048
== enum:wwnEmulationMode ==
WWN and device vendor/product emulation modes for compatibility with 3rd party products like IBM SVC

''' Enumeration Values '''
OSN_WWN_EMULATION_NONE: 0
OSN_WWN_EMULATION_OSNEXUS: 1
OSN_WWN_EMULATION_PURE_FLASHARRAY: 2
OSN_WWN_EMULATION_IBM_STORWIZE: 3
OSN_WWN_EMULATION_MAX: 4

QuantaStor CLI Command Reference

2026-07-10T17:18:39Z

Qadmin: Update CLI command reference to 6.8.0 (build 205)

[[Category:cli_guide]]
OSNEXUS QuantaStor CLI 6.8.0
Copyright (c) 2009-2026 OSNEXUS Corporation. All rights reserved.

USAGE
qs COMMAND --mandatory-arg=value [--optional-arg=value] [--flags=force,async,...] [--server=ip,user,passwd] [-u=user,passwd] [--min [--nonames] | --noheader | --verbose | --xml | --json ]
qs imode|i : Interactive mode (CTRL-C to exit)

HELP
qs help|h [command-name|partial-command-name] [--min]

OUTPUT MODES
--min : Minimal mode prints command and required arguments plus a brief command
description.
--verbose : Verbose mode prints command and all arguments, a brief command description
plus detailed descriptions of each keyword argument.
--xml : XML output mode
--json : JSON output mode
--csv : CSV output mode
--min --nonames : Blocks automatic conversion of UUIDs to names (see disk-list, tp-list).

SERVER AUTHENTICATION
--server=ipaddress[,username,password] : Comma separated values, no spaces.

qs CLI will attempt to authenticate with the default 'admin','password' if username and password
are not supplied. You may also provide authentication credentials by setting and exporting the
QS_SERVER environment variable (export QS_SERVER=ipaddress[,username[,password]]) or by placing
the credentials in the file '~/.qs.cnf' (e.g., 192.168.0.10,admin,password).

EXAMPLES
qs help --min
qs pool-list
qs volume-list --xml
qs volume-create --name=vol1 --size=100G --pool=pool0

SEE ALSO
qs-sendlogs <companyname> : Sends a log report to support for analysis
qs-iostat : Shows device and pool IO statistics
qs-version : Shows version information about the local CLI, service, and grid nodes.
qs-status : Shows the status of the key service daemons
qs-showlog : Prints the service log, use -f to tail the log, -e to check for errors & warnings
qs-util : Various system and common RAID controller utility commands
qs-zconvert : For importing and converting foreign OpenZFS filesystems with the QuantaStor naming conventions.

COMMAND

===help===
Display help for all commands. 'qs help' provides a verbose listing of all commands with their input parameters. Use 'qs help --min' for a compacted list of commands, or use 'qs help=<search>' for help on all commands which contain the specified search value.

<pre> qs help|h [--command=value ] [--category=value ] [--wiki=value ] [--api=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>command</tt> || A specific CLI command to get detailed help with.
|-
|   || <tt>category</tt> || Category of commands to get help with (acl, alert, host, host-group, license, role, session, schedule, pool, quota, system, volume, volume-group, task, user, user-group).
|-
|   || <tt>wiki</tt> || Generates help output in a format that's importable into MediaWiki.
|-
|   || <tt>api</tt> || Generates help output in a parsable format for automating API.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}

===tc-commands===
List of commands for tab completion

<pre> qs tc-commands [--command=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>command</tt> || Command to show method args for.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force, forget-missing, min, *none]
|}

==Alert Management [ALERT]==
Alerts are generated by the system and routed to the administrators via the various call-home mechanisms which include email, SNMP, PagerDuty, Slack, and custom alert handlers. Alerts include a severity, a descriptive message, and in most cases an identifier referring to the element of the system or grid that is the subject of the alert.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===alert-clear===
Deletes the alert with the specified ID.

<pre> qs alert-clear|a-clear --filter=value [--ack=value ] [--close=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>filter</tt> || Specify a comma delimited list of one or more Alerts to be removed/cleared. Alerts may be identified by UUID or by strings which will be matched against the title and description text.
|-
|   || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
|-
|   || <tt>close</tt> || Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===alert-clear-all===
Clears all the alerts.

<pre> qs alert-clear-all|a-clear-all [--ack=value ] [--close=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
|-
|   || <tt>close</tt> || Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===alert-config-get===
Alert configuration settings indicate where alert notifications should be sent.

<pre> qs alert-config-get|ac-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===alert-config-set===
Sets the alert configuration settings such as the administrator email address, SMTP server address, etc. Be sure to use the alert-raise command to generate a test alert after you modify the alert configuration settings to ensure that emails are being properly sent.

<pre> qs alert-config-set|ac-set [--sender-email=value ] [--smtp-server=value ] [--smtp-port=value ] [--smtp-user=value ] [--smtp-password=value ] [--smtp-auth=value ] [--support-email=value ] [--pool-freespace-warning=value ] [--pool-freespace-urgent=value ] [--pool-freespace-critical=value ] [--share-freespace-warning=value ] [--share-freespace-urgent=value ] [--share-freespace-critical=value ] [--object-user-freespace-warning=value ] [--object-user-freespace-alert=value ] [--object-user-freespace-critical=value ] [--enable-syslog=value ] [--endpoints=value ] [--enable-alerts=value ] [--disable-alerts=value ] [--pause-alerts=value ] [--snmp-user=value ] [--snmp-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sender-email</tt> || Sender email address to be used for alert emails sent from the Storage System.
|-
|   || <tt>smtp-server</tt> || IP Address of the SMTP service where emails should be routed through.
|-
|   || <tt>smtp-port</tt> || Port number of the SMTP service (eg 25, 465, 587) where emails should be routed through (0 indicates auto-select).
|-
|   || <tt>smtp-user</tt> || SMTP user name to use for secure SMTP access to your SMTP server for sending alert emails.
|-
|   || <tt>smtp-password</tt> || SMTP password to use for secure SMTP access to your SMTP server.
|-
|   || <tt>smtp-auth</tt> || SMTP security mode.
|-
|   || <tt>support-email</tt> || Email address for local customer support.
|-
|   || <tt>pool-freespace-warning</tt> || The percentage (default=30) of free-space left in a pool at which a warning is sent to indicate pool growth plans should be made.
|-
|   || <tt>pool-freespace-urgent</tt> || The percentage (default=10) of free-space left in a pool at which alerts are generated.
|-
|   || <tt>pool-freespace-critical</tt> || The percentage (default=5) of free-space left in a pool at which all provisioning operations are blocked.
|-
|   || <tt>share-freespace-warning</tt> || The percentage (default=20) of free-space left in a share quota at which a 'warning' alert is raised to indicate the share is low on space.
|-
|   || <tt>share-freespace-urgent</tt> || The percentage (default=10) of free-space left in a share quota at which an 'urgent' alert is generated.
|-
|   || <tt>share-freespace-critical</tt> || The percentage (default=5) of free-space left in a share quota at which a 'critically low' alert is raised and writes will soon begin to be blocked.
|-
|   || <tt>object-user-freespace-warning</tt> || The percentage (default=20) of free-space left in a S3 user quota at which a 'warning' alert is raised to indicate the share is low on space.
|-
|   || <tt>object-user-freespace-alert</tt> || The percentage (default=10) of free-space left in a S3 user quota at which an 'urgent' alert is generated.
|-
|   || <tt>object-user-freespace-critical</tt> || The percentage (default=5) of free-space left in a S3 user quota at which a 'critically low' alert is raised and writes will soon begin to be blocked.
|-
|   || <tt>enable-syslog</tt> || Enable alerts appended to '/var/log/syslog'.
|-
|   || <tt>endpoints</tt> || Add new endpoints by specifying a comma delimited list in the format "module:endpointurl,module:endpointurl" and use the ~ prefix to remove entries.
|-
|   || <tt>enable-alerts</tt> || Enables previously disabled alerts, use '*' to enable all disabled alert triggers.
|-
|   || <tt>disable-alerts</tt> || Disables the specified alert types/triggers. Specify specific triggers by UUID or by the SNMP trap index.
|-
|   || <tt>pause-alerts</tt> || Pauses the specified alert types/triggers for 30 days.
|-
|   || <tt>snmp-user</tt> || SNMP User name
|-
|   || <tt>snmp-password</tt> || SNMP User password
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===alert-get===
Gets information about a specific alert.

<pre> qs alert-get|a-get --id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>id</tt> || Unique identifier (GUID) for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===alert-list===
Returns a list of all the alerts from all systems in the grid. Adjust the settings for the 'admin' or custom user account(s) to indicate alerts to be sent out via email call-home mechanism.

<pre> qs alert-list|a-list [--filter=value ] [--ack=value ] [--close=value ] [--filtered=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>filter</tt> || Specify a comma delimited list of one or more Alerts to be removed/cleared. Alerts may be identified by UUID or by strings which will be matched against the title and description text.
|-
|   || <tt>ack</tt> || Rather than clearing the alerts they're acknowledged and marked with a timestamp of when it was acknowledged.
|-
|   || <tt>close</tt> || Acknowledges and closes the alert by sending a 'close' event to all registered ITSM modules.
|-
|   || <tt>filtered</tt> || Returns just the 'value' most recently created.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===alert-raise===
Allows one to raise a user generated alert for testing the SMTP server configuration settings.

<pre> qs alert-raise|a-raise --title=value --message=value [--alert-severity=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>title</tt> || Title string to be echoed back from the server.
|-
|   || <tt>message</tt> || Message string to be echoed back from the server.
|-
|   || <tt>alert-severity</tt> || Severity of the user generated alert to be raise. [always, critical, error, *info, warning]
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===alert-type-get===
Returns information about a specific Alert Type/trigger.

<pre> qs alert-type-get|at-get --alert-trigger=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>alert-trigger</tt> || Alert types/triggers can be turned on, off or paused for 30 days to reduce noise during maintenance.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===alert-type-list===
Returns a list of all the Alert Types/triggers and their state (enabled/disabled/paused)

<pre> qs alert-type-list|at-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===audit-log-list===
List audit log entries from the specified Storage System.

<pre> qs audit-log-list|audit-list [--max-entries=value ] [--storage-system=value ] [--audit-user=value ] [--audit-entry-types=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>max-entries</tt> || Maximum number of audit log entries to return, default 100.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>audit-user</tt> || Only gather audit entries associated with the specified user UUID.
|-
|   || <tt>audit-entry-types</tt> || Only gather audit entries of the specified type [alert, api, message, *none, task]
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===event-list===
Returns a list of all the internal events in the event queue (used for service monitoring).

<pre> qs event-list|ev-list [--index=value ] [--max=value ] [--time-stamp=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>index</tt> || Starting event index of where to begin listing events from.
|-
|   || <tt>max</tt> || Maximum number of events to enumerate.
|-
|   || <tt>time-stamp</tt> || Time-stamp of the service.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Backup Policy Management [BACKUP-POLICY]==
Backup policies provide a mechanism for scheduling and executing automatic backups of 3rd party filers and other NFS/SMB shares in an environment directly to a Network Share.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===backup-job-cancel===
Requests cancellation of the specified Backup Job

<pre> qs backup-job-cancel|bj-cancel --job=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>job</tt> || A Backup Job contains the active state of a backup run associated with a Backup Policy including the start time and the number of files copied.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===backup-job-get===
Returns detailed information on a specific Backup Job.

<pre> qs backup-job-get|bj-get --job=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>job</tt> || A Backup Job contains the active state of a backup run associated with a Backup Policy including the start time and the number of files copied.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===backup-job-list===
Returns a list of Backup Jobs in the system.

<pre> qs backup-job-list|bj-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===backup-policy-create===
Creates a Backup Policy which can copy/move data to/from NAS shares and Cloud Containers.

<pre> qs backup-policy-create|bp-create --name=value --network-share=value --remote-hostname=value [--remote-export-path=value ] [--remote-export-type=value ] [--desc=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--force-remove-tiered=value ] [--remote-export-sub-path=value ] [--filter-rule-include=value ] [--filter-rule-exclude=value ] [--min-size-threshold=value ] [--max-size-threshold=value ] [--min-auto-tier-threshold=value ] [--auto-copy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>remote-hostname</tt> || Hostname/IP address to a remote NFS/SMB server or the UUID of a Cloud Container.
|-
|   || <tt>remote-export-path</tt> || Remote export directory path for NFS export, SMB share.
|-
|   || <tt>remote-export-type</tt> || Remote export mount type. [cloudcontainer, *nfs, smb]
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>retain-rules</tt> || Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
|-
|   || <tt>policy-type</tt> || Backup policy types. [*copy-inbound, copy-outbound, move-inbound, move-outbound]
|-
|   || <tt>scan-threads</tt> || Number of concurrent threads for walking/scanning the specified target export (default: 5)
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>interval</tt> || (interval based) Delay interval in minutes between when a scheduled run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|   || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|   || <tt>retain-period</tt> || Max age of files in days until they are purged (default: 0 / never delete files).
|-
|   || <tt>purge-policy</tt> || Indicates how old files should be cleaned up / purged from the backup. [after-backup, daily, *never, weekly]
|-
|   || <tt>backup-to-root</tt> || Indicates that the backups should go into the root folder of the Network Share.
|-
|   || <tt>maintain-logs</tt> || Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>enabled</tt> || Set to enabled to activate the backup policy.
|-
|   || <tt>smb-username</tt> || Specifies the SMB username to use to access the specified remote filer SMB share.
|-
|   || <tt>smb-password</tt> || Specifies the SMB password to use to access the specified remote filer SMB share.
|-
|   || <tt>age-days-min</tt> || Minimum number of days old the file must be for it to be backed up by the Backup Policy. Setting this to 0 indicates no minimum age.
|-
|   || <tt>age-days-max</tt> || Maximum number of days old the file may be for it to be backed up by the Backup Policy. Setting this to 0 indicates no maximum age. By setting both a minimum and a maximum of 0 all files are backed up. By setting one or both of a minimum and maximum age a file age range may be specified.
|-
|   || <tt>create-links</tt> || Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
|-
|   || <tt>force-remove-tiered</tt> || Links are created once a day. Using this option will force creation of links on every trigger.
|-
|   || <tt>remote-export-sub-path</tt> || Destination sub-directory.
|-
|   || <tt>filter-rule-include</tt> || Files which contain the specified pattern are included in the Backup Policy.
|-
|   || <tt>filter-rule-exclude</tt> || Files which contain the specified pattern are excluded from the Backup Policy.
|-
|   || <tt>min-size-threshold</tt> || The minimum file size threshold, files smaller than this are not included in the backup.
|-
|   || <tt>max-size-threshold</tt> || The maximum file size threshold, files larger than this are not included in the backup.
|-
|   || <tt>min-auto-tier-threshold</tt> || Minimum file size to be included in auto-tiering.
|-
|   || <tt>auto-copy</tt> || Supplies real-time data protection by automatically copying files to a destination share.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===backup-policy-delete===
Deletes the specified backup policy.

<pre> qs backup-policy-delete|bp-delete --policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===backup-policy-disable===
Disables the specified Backup Policy so that Backup Jobs are not automatically run.

<pre> qs backup-policy-disable|bp-disable --policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===backup-policy-enable===
Enables a backup policy that was previously disabled.

<pre> qs backup-policy-enable|bp-enable --policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===backup-policy-get===
Returns detailed information on a specific backup policy.

<pre> qs backup-policy-get|bp-get --policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===backup-policy-list===
Returns a list of backup policies in the system.

<pre> qs backup-policy-list|bp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===backup-policy-modify===
Modifies the specified backup policy settings.

<pre> qs backup-policy-modify|bp-modify --policy=value [--name=value ] [--desc=value ] [--remote-hostname=value ] [--remote-export-path=value ] [--remote-export-type=value ] [--retain-rules=value ] [--policy-type=value ] [--scan-threads=value ] [--schedule-type=value ] [--interval=value ] [--hours=value ] [--days=value ] [--offset-minutes=value ] [--max-snaps=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--retain-period=value ] [--purge-policy=value ] [--backup-to-root=value ] [--maintain-logs=value ] [--start-date=value ] [--enabled=value ] [--smb-username=value ] [--smb-password=value ] [--age-days-min=value ] [--age-days-max=value ] [--create-links=value ] [--force-remove-tiered=value ] [--remote-export-sub-path=value ] [--filter-rule-include=value ] [--filter-rule-exclude=value ] [--min-size-threshold=value ] [--max-size-threshold=value ] [--min-auto-tier-threshold=value ] [--auto-copy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>remote-hostname</tt> || Hostname/IP address to a remote NFS/SMB server or the UUID of a Cloud Container.
|-
|   || <tt>remote-export-path</tt> || Remote export directory path for NFS export, SMB share.
|-
|   || <tt>remote-export-type</tt> || Remote export mount type. [cloudcontainer, *nfs, smb]
|-
|   || <tt>retain-rules</tt> || Retention rules (atime, ctime, mtime) [atime, ctime, *mtime]
|-
|   || <tt>policy-type</tt> || Backup policy types. [*copy-inbound, copy-outbound, move-inbound, move-outbound]
|-
|   || <tt>scan-threads</tt> || Number of concurrent threads for walking/scanning the specified target export (default: 5)
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>interval</tt> || (interval based) Delay interval in minutes between when a scheduled run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|   || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|   || <tt>retain-period</tt> || Max age of files in days until they are purged (default: 0 / never delete files).
|-
|   || <tt>purge-policy</tt> || Indicates how old files should be cleaned up / purged from the backup. [after-backup, daily, *never, weekly]
|-
|   || <tt>backup-to-root</tt> || Indicates that the backups should go into the root folder of the Network Share.
|-
|   || <tt>maintain-logs</tt> || Maintain logs of all the files that were backed up in the /var/log/backup-log folder within the appliance.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>enabled</tt> || Set to enabled to activate the backup policy.
|-
|   || <tt>smb-username</tt> || Specifies the SMB username to use to access the specified remote filer SMB share.
|-
|   || <tt>smb-password</tt> || Specifies the SMB password to use to access the specified remote filer SMB share.
|-
|   || <tt>age-days-min</tt> || Minimum number of days old the file must be for it to be backed up by the Backup Policy. Setting this to 0 indicates no minimum age.
|-
|   || <tt>age-days-max</tt> || Maximum number of days old the file may be for it to be backed up by the Backup Policy. Setting this to 0 indicates no maximum age. By setting both a minimum and a maximum of 0 all files are backed up. By setting one or both of a minimum and maximum age a file age range may be specified.
|-
|   || <tt>create-links</tt> || Creates file stubs (symbolic links) for files migrated from the Network Share to a given Cloud Container so that the files may continue to be accessed from the Network Share as if they had not been moved. Only applies to Cloud Container based move-outbound backups.
|-
|   || <tt>force-remove-tiered</tt> || Links are created once a day. Using this option will force creation of links on every trigger.
|-
|   || <tt>remote-export-sub-path</tt> || Destination sub-directory.
|-
|   || <tt>filter-rule-include</tt> || Files which contain the specified pattern are included in the Backup Policy.
|-
|   || <tt>filter-rule-exclude</tt> || Files which contain the specified pattern are excluded from the Backup Policy.
|-
|   || <tt>min-size-threshold</tt> || The minimum file size threshold, files smaller than this are not included in the backup.
|-
|   || <tt>max-size-threshold</tt> || The maximum file size threshold, files larger than this are not included in the backup.
|-
|   || <tt>min-auto-tier-threshold</tt> || Minimum file size to be included in auto-tiering.
|-
|   || <tt>auto-copy</tt> || Supplies real-time data protection by automatically copying files to a destination share.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===backup-policy-trigger===
Triggers the specified backup policy which in turn starts a backup job.

<pre> qs backup-policy-trigger|bp-trigger --policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>policy</tt> || A Backup Policy name or ID which is associated with a Network Share to do backups.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Scale-out Object / Ceph Management [CEPH]==
Commands for management, monitoring, and configuration of Ceph object clusters and associated storage.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===bucket-create===
Creates a new Object Bucket in the specified Ceph Cluster.

<pre> qs bucket-create|b-create --name=value --object-user=value [--ceph-cluster=value ] [--bucket-acl=value ] [--quota-size=value ] [--enable-versioning=value ] [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-lifecycle-policy=value ] [--lifecycle-policy-days=value ] [--enable-nfs=value ] [--estimated-objects=value ] [--count=value ] [--integration-options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>bucket-acl</tt> || Indicates the type of user access provided to the bucket. [auth-read, *private, public-read, public-read-write]
|-
|   || <tt>quota-size</tt> || Size of the quota in bytes with optional suffix (MB, GB, TB)
|-
|   || <tt>enable-versioning</tt> || Enables versioning for the specified bucket.
|-
|   || <tt>object-lock-mode</tt> || Indicates the object lock mode. If object locking is disabled during bucket create, it cannot be enabled again. 'governance' mode allows modifications by an admin and 'compliance' allows no modifications (WORM mode). [compliance, *disabled, enabled, governance]
|-
|   || <tt>object-lock-duration-days</tt> || Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
|-
|   || <tt>enable-lifecycle-policy</tt> || Enables life cycle policy on the bucket.
|-
|   || <tt>lifecycle-policy-days</tt> || The number of life cycle policy days for objects in the given bucket.
|-
|   || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
|-
|   || <tt>estimated-objects</tt> || Estimated number objects in the bucket based on a 4MB object size. [100M, 10M, 1B, 1M, 500M, 50M, Dynamic]
|-
|   || <tt>count</tt> || The number of volumes to create, default is 1.
|-
|   || <tt>integration-options</tt> || Enable/disable QuantaStor third party integrations. [*none, veeam]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===bucket-delete===
Deletes the specified Object Bucket and all objects contained within the bucket.

<pre> qs bucket-delete|b-delete --bucket-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>bucket-list</tt> || Comma delimited list of the Names or IDs of Object Storage Buckets.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===bucket-get===
Returns detailed information about a specific bucket.

<pre> qs bucket-get|b-get --bucket=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>bucket</tt> || Name or ID of an object storage bucket.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===bucket-link===
Links the specified bucket to the specified object user account.

<pre> qs bucket-link|b-link --bucket=value --object-user=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>bucket</tt> || Name or ID of an object storage bucket.
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===bucket-list===
Returns a list of all the buckets.

<pre> qs bucket-list|b-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===bucket-modify===
Modify the bucket attributes.

<pre> qs bucket-modify|b-modify --bucket=value [--enable-versioning=value ] [--object-lock-mode=value ] [--object-lock-duration-days=value ] [--enable-lifecycle-policy=value ] [--lifecycle-policy-days=value ] [--enable-nfs=value ] [--integration-options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>bucket</tt> || Name or ID of an object storage bucket.
|-
|   || <tt>enable-versioning</tt> || Enables versioning for the specified bucket.
|-
|   || <tt>object-lock-mode</tt> || Indicates the object lock mode. If object locking is disabled during bucket create, it cannot be enabled again. 'governance' mode allows modifications by an admin and 'compliance' allows no modifications (WORM mode). [compliance, *disabled, enabled, governance]
|-
|   || <tt>object-lock-duration-days</tt> || Indicates the number of days the lock mode will be applied for. Minimum retention is 1 day.
|-
|   || <tt>enable-lifecycle-policy</tt> || Enables life cycle policy on the bucket.
|-
|   || <tt>lifecycle-policy-days</tt> || The number of life cycle policy days for objects in the given bucket.
|-
|   || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
|-
|   || <tt>integration-options</tt> || Enable/disable QuantaStor third party integrations. [*none, veeam]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===bucket-rescan===
Scans for any new Object Buckets that have been created but not yet picked up by an automatic scan.

<pre> qs bucket-rescan|b-rescan [--ceph-cluster=value ] [--scan-options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>scan-options</tt> || Deep scan options to gather further information about each bucket found during the next detailed bucket scan. Also starts that detailed scan in the background. [lifecycle, lock-config, *none, sync-policy, usage, veeam]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===bucket-search===
Searches for an Object Bucket based on a set of parameters.

<pre> qs bucket-search|b-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the bucket List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>max-results</tt> || Maximum number of results to return for the given search parameters.
|-
|   || <tt>offset</tt> || Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===bucket-sync-policy-create===
Creates a new bucket sync policy.

<pre> qs bucket-sync-policy-create|bsp-create --source-ceph-cluster=value --destination-ceph-cluster=value --bucket-sync-policy-name=value [--source-zone=value ] [--description=value ] [--sync-policy-status=value ] [--direction=value ] [--dest-zone=value ] [--source-bucket=value ] [--destination-bucket=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>source-ceph-cluster</tt> || Source Ceph cluster for the sync operation.
|-
|   || <tt>destination-ceph-cluster</tt> || Destination Ceph cluster for the sync operation.
|-
|   || <tt>bucket-sync-policy-name</tt> || Name of the bucket sync policy.
|-
|   || <tt>source-zone</tt> || Source zone for the data flow.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>sync-policy-status</tt> || Status of the bucket sync policy. [allowed, *enabled, forbidden, unknown]
|-
|   || <tt>direction</tt> || Direction of the data flow. [directional, *symmetrical, unknown]
|-
|   || <tt>dest-zone</tt> || Destination zone for the data flow.
|-
|   || <tt>source-bucket</tt> || Source bucket for the sync operation.
|-
|   || <tt>destination-bucket</tt> || Destination bucket for the sync operation.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===bucket-sync-policy-delete===
Deletes an existing bucket sync policy.

<pre> qs bucket-sync-policy-delete|bsp-delete --bucket-sync-policy=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>bucket-sync-policy</tt> || Name or ID of the bucket sync policy.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===bucket-sync-policy-get===
Gets information about a specific bucket sync policy.

<pre> qs bucket-sync-policy-get|bsp-get --bucket-sync-policy=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>bucket-sync-policy</tt> || Name or ID of the bucket sync policy.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===bucket-sync-policy-list===
Lists all bucket sync policies.

<pre> qs bucket-sync-policy-list|bsp-list [--ceph-cluster=value ] [--bucket=value ] [--object-store-zone=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>bucket</tt> || Name or ID of an object storage bucket.
|-
|   || <tt>object-store-zone</tt> || Ceph object storage zone. (Default: 'default')
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===bucket-sync-policy-modify===
Modifies an existing bucket sync policy.

<pre> qs bucket-sync-policy-modify|bsp-modify --bucket-sync-policy=value [--ceph-cluster=value ] [--sync-policy-status=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>bucket-sync-policy</tt> || Name or ID of the bucket sync policy.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>sync-policy-status</tt> || Status of the bucket sync policy. [allowed, *enabled, forbidden, unknown]
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===bucket-unlink===
Unlinks the specified bucket from the specified object user account.

<pre> qs bucket-unlink|b-unlink --bucket=value --object-user=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>bucket</tt> || Name or ID of an object storage bucket.
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-cluster-add-member===
Add a new Storage System to existing Ceph Cluster.

<pre> qs ceph-cluster-add-member|cc-amn --ceph-cluster=value --storage-system=value --port=value [--public-network=value ] [--cluster-network=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|   || <tt>public-network</tt> || Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
|-
|   || <tt>cluster-network</tt> || Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-cluster-create===
Create a new Ceph Cluster using the specified Storage System(s).

<pre> qs ceph-cluster-create|cc-create --name=value --client-ips=value [--backend-ips=value ] [--desc=value ] [--domain-suffix=value ] [--public-network=value ] [--cluster-network=value ] [--cluster-auth-mode=value ] [--osd-out-subtree-limit=value ] [--enable-osd-encryption=value ] [--encryption-mode=value ] [--enable-osd-compression=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--key-server-profile=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Name of the Ceph Cluster.
|-
|   || <tt>client-ips</tt> || List of IP addresses used to identify which systems and which ports to use for the Ceph Cluster front-end/client communication ports.
|-
|   || <tt>backend-ips</tt> || List of IP addresses used to identify which ports are to be used for Ceph Cluster inter-node back-end communication, if not specified the list specified for the front-end ports will be used.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>domain-suffix</tt> || The domain name suffix for your network such as example.com
|-
|   || <tt>public-network</tt> || Ceph public/client network CIDR (e.g. x.x.x.x/YY). Default: Computed from public/client interface.
|-
|   || <tt>cluster-network</tt> || Ceph cluster/backend network CIDR (e.g. x.x.x.x/YY). Default: Computed from cluster/backend interface.
|-
|   || <tt>cluster-auth-mode</tt> || Encryption mode used between Ceph services of 'cephx' or 'none', default is 'cephx'. [*cephx, none]
|-
|   || <tt>osd-out-subtree-limit</tt> || Indicates the scope at which a group of OSDs in the 'down' state should not be thrown 'out'. The default is 'host' so that OSDs are not removed from a given cluster due to server hardware maintenance activities. [*host, rack]
|-
|   || <tt>enable-osd-encryption</tt> || Enables inline encryption for OSDs using AES 256 bit encryption for data-at-rest. (default: disabled)
|-
|   || <tt>encryption-mode</tt> || Type of encryption, software (LUKS) or self-encryption (SED). [SED, *default, luks]
|-
|   || <tt>enable-osd-compression</tt> || Enables inline compression for OSDs using the 'snappy' algorithm. (default: disabled)
|-
|   || <tt>osd-down-timeout-sec</tt> || Amount of time until a given unresponsive OSD is switched to the 'down' state. OSDs in the 'down' state will auto sync and recover when they come back online.
|-
|   || <tt>osd-out-timeout-sec</tt> || Amount of time until a given OSD in the 'down' state will be assumed to be unrecoverable and thrown 'out' of the cluster.
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-cluster-delete===
Deletes the specified Ceph Cluster.

<pre> qs ceph-cluster-delete|cc-delete --ceph-cluster=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-cluster-fix-clock-skew===
Adjusts the clocks on all the member nodes in the specified Ceph Cluster in order to address any clock skew issues.

<pre> qs ceph-cluster-fix-clock-skew|cc-fcs --ceph-cluster=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-cluster-get===
Gets information about a specific Ceph Cluster.

<pre> qs ceph-cluster-get|cc-get --ceph-cluster=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-cluster-health-event-list===
Returns a list of all the active Ceph Cluster health check event.

<pre> qs ceph-cluster-health-event-list|cc-health-event-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-cluster-import===
Import an existing Ceph Cluster.

<pre> qs ceph-cluster-import|cc-import [--name=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-cluster-list===
Returns a list of all the Ceph Clusters.

<pre> qs ceph-cluster-list|cc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-cluster-member-get===
Gets information about a specific Ceph Cluster Member.

<pre> qs ceph-cluster-member-get|ccm-get --ceph-cluster-member=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster-member</tt> || Ceph Cluster Member name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-cluster-member-list===
Returns a list of all the Ceph Cluster Member systems.

<pre> qs ceph-cluster-member-list|ccm-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-cluster-modify===
Modify a Ceph Cluster using the specified Storage System(s).

<pre> qs ceph-cluster-modify|cc-modify --ceph-cluster=value [--name=value ] [--desc=value ] [--flags=value ] [--osd-down-timeout-sec=value ] [--osd-out-timeout-sec=value ] [--near-fill-full-percent=value ] [--back-fill-full-percent=value ] [--full-percent=value ] [--key-server-profile=value ] [--config-options-list=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>name</tt> || Name of the Ceph Cluster.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|-
|   || <tt>osd-down-timeout-sec</tt> || Amount of time until a given unresponsive OSD is switched to the 'down' state. OSDs in the 'down' state will auto sync and recover when they come back online.
|-
|   || <tt>osd-out-timeout-sec</tt> || Amount of time until a given OSD in the 'down' state will be assumed to be unrecoverable and thrown 'out' of the cluster.
|-
|   || <tt>near-fill-full-percent</tt> || Cluster storage percentage at which a warning will be generated to indicate the cluster is near full.
|-
|   || <tt>back-fill-full-percent</tt> || Cluster storage percentage at which cluster blocks backfills from starting.
|-
|   || <tt>full-percent</tt> || Cluster storage percentage at which cluster is full and clients are stopped from writing data.
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>config-options-list</tt> || General Ceph Cluster configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties.
|}

===ceph-cluster-remove-member===
Remove a Storage System from an existing Ceph Cluster.

<pre> qs ceph-cluster-remove-member|cc-rmn --ceph-cluster=value --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-cluster-service-event-delete===
Delete/archive a list of ceph cluster service events

<pre> qs ceph-cluster-service-event-delete|cc-srv-event-delete [--ceph-cluster=value ] [--prune-events=value ] [--service-event-id-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>prune-events</tt> || Prune specified service event. Default is to archive the event.
|-
|   || <tt>service-event-id-list</tt> || Ceph Cluster service crash event ID list.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-cluster-service-event-list===
Returns a list of Ceph Cluster service crash events.

<pre> qs ceph-cluster-service-event-list|cc-srv-event-list [--ceph-cluster=value ] [--include-old-events=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>include-old-events</tt> || List old and new events. Default is to include only new events.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-cluster-set-coordinator===
Set the designated coordinator for a Ceph Cluster, this node will handle discovery for all cluster global objects like Ceph Pools, Buckets, and more. Setting a coordinator is not required as the grid will automatically elect a coordinator. However, setting a specific coordinator can help optimize cluster performance in larger Ceph Clusters.

<pre> qs ceph-cluster-set-coordinator|cc-set-coord --coordinator-id=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>coordinator-id</tt> || The ID of the designated coordinator for the Ceph Cluster.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-crush-rule-create-erasure===
Create a custom Ceph CRUSH rule for object or block storage.

<pre> qs ceph-crush-rule-create-erasure|ccr-create-era --rule=value --ceph-cluster=value --ec-pool-profile=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>rule</tt> || Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-crush-rule-create-replicated===
Create a custom Ceph CRUSH rule for object or block storage.

<pre> qs ceph-crush-rule-create-replicated|ccr-create-rep --rule=value --ceph-cluster=value --rule-deviceclass=value [--desc=value ] [--rule-failuredomain=value ] [--rule-root=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>rule</tt> || Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>rule-deviceclass</tt> || Ceph CRUSH rule device class ( hdd | ssd | nvme )
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>rule-failuredomain</tt> || Ceph CRUSH rule failure domain ( *host | osd | rack )
|-
|   || <tt>rule-root</tt> || Ceph CRUSH rule, root ( *default )
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-crush-rule-delete===
Deletes the specified Ceph CRUSH rule.

<pre> qs ceph-crush-rule-delete|ccr-delete --rule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>rule</tt> || Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-crush-rule-get===
Gets information about a specific Ceph CRUSH rule.

<pre> qs ceph-crush-rule-get|ccr-get --rule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>rule</tt> || Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-crush-rule-list===
Returns a list of all the Ceph CRUSH rule(s) present in the cluster.

<pre> qs ceph-crush-rule-list|ccr-list --ceph-cluster=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-ec-profile-create===
Create a custom ceph pool profile for object or block storage.

<pre> qs ceph-ec-profile-create|ecp-create --k=value --m=value [--name=value ] [--ceph-cluster=value ] [--desc=value ] [--profile-failure-domain=value ] [--profile-technique=value ] [--ec-plugin=value ] [--device-class=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|   || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|   || <tt>name</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>profile-failure-domain</tt> || Failure domain for the Ceph Pool {Default: host}.
|-
|   || <tt>profile-technique</tt> || Erasure coding technique for Ceph Pool. {Default: reed-solomon-van}
|-
|   || <tt>ec-plugin</tt> || Plug-in used for erasure coded Ceph Pool {*jerasure, isa, lrc, shec}
|-
|   || <tt>device-class</tt> || Device class to pin the pool to. {hdd, ssd, nvme}
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-ec-profile-delete===
Deletes the specified ceph pool profile.

<pre> qs ceph-ec-profile-delete|ecp-delete --ec-pool-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-ec-profile-get===
Gets information about a specific ceph pool profile.

<pre> qs ceph-ec-profile-get|ecp-get --ec-pool-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-ec-profile-list===
Returns a list of all the ceph pool profile(s) present in the cluster.

<pre> qs ceph-ec-profile-list|ecp-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-metadata-server-add===
Configure a new metadata server in the Ceph Cluster.

<pre> qs ceph-metadata-server-add|cmds-add --ceph-cluster=value --ceph-cluster-member-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-cluster-member-list</tt> || List of Ceph Cluster Member name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-metadata-server-get===
Gets information about a specific CephFS metadata server in the Ceph Cluster.

<pre> qs ceph-metadata-server-get|cmds-get --ceph-metadata-server=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-metadata-server</tt> || Ceph Metadata server name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-metadata-server-list===
Returns a list of all the CephFS metadata servers configured in the Ceph Cluster.

<pre> qs ceph-metadata-server-list|cmds-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-metadata-server-remove===
Removes the specified ceph metadata server.

<pre> qs ceph-metadata-server-remove|cmds-remove --ceph-cluster=value --ceph-metadata-server=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-metadata-server</tt> || Ceph Metadata server name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-monitor-add===
Configure a new monitor for the Ceph Cluster.

<pre> qs ceph-monitor-add|cmon-add --ceph-cluster=value --ceph-cluster-member=value --monitor-ipaddress=value [--monitor-port=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-cluster-member</tt> || Ceph Cluster Member name or ID.
|-
|   || <tt>monitor-ipaddress</tt> || IP address used by Ceph Monitor daemon for communication.
|-
|   || <tt>monitor-port</tt> || Port used by ceph monitor daemon for communication (default:6789).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-monitor-get===
Gets information about a specific Ceph Monitor.

<pre> qs ceph-monitor-get|cmon-get --ceph-monitor=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-monitor</tt> || Ceph Monitor service name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-monitor-list===
Returns a list of all the Ceph Monitors.

<pre> qs ceph-monitor-list|cmon-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-monitor-remove===
Removes the specified Ceph Monitor.

<pre> qs ceph-monitor-remove|cmon-remove --ceph-cluster=value --ceph-monitor=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-monitor</tt> || Ceph Monitor service name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-delete===
Deletes the specified list of Ceph OSDs

<pre> qs ceph-osd-delete|osd-delete --osd-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-get===
Gets information about a specific Ceph Object Storage Daemon.

<pre> qs ceph-osd-get|osd-get --ceph-osd=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-osd</tt> || Ceph OSD name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-osd-identify===
Identify/blink the specified ceph OSD

<pre> qs ceph-osd-identify|osd-identify --osd-list=value [--blink-type=value ] [--duration=value ] [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-key-replace===
Replaces encryption key for encrypted OSD.

<pre> qs ceph-osd-key-replace|osd-krep --ceph-cluster=value --osd-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-list===
Returns a list of all the Ceph Object Storage Daemons

<pre> qs ceph-osd-list|osd-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-osd-modify===
Modifies the specified ceph OSD

<pre> qs ceph-osd-modify|osd-modify --ceph-cluster=value --ceph-osd=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-osd</tt> || Ceph OSD name or ID.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-multi-create===
Creates multiple new ceph OSD on the specified Ceph Cluster

<pre> qs ceph-osd-multi-create|osd-multi-create [--ceph-cluster=value ] [--physical-disk-list=value ] [--journal-ssd-list=value ] [--use-unused-journal-devices=value ] [--enable-mirror=value ] [--quick-format-disks=value ] [--allow-mixed-size-journal-media=value ] [--force-external-journal-device=value ] [--enable-dynamic-weighting=value ] [--wal-size=value ] [--db-size=value ] [--osd-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>physical-disk-list</tt> || List of comma separated physical disk ID to be used for OSD data disks during OSD create. Disk filter tags may also be used, see disk-list help for details.
|-
|   || <tt>journal-ssd-list</tt> || List of comma separated SSD disk ID to be used for OSD journal devices during OSD create. Disk filter tags may also be used, see disk-list help for details.
|-
|   || <tt>use-unused-journal-devices</tt> || Use unused journal devices on Storage System for OSD create.
|-
|   || <tt>enable-mirror</tt> || Enable mirrored Ceph Journal Devices to prevent Ceph OSD loss.
|-
|   || <tt>quick-format-disks</tt> || Quick format the disks selected for OSD and Journal Device creation.
|-
|   || <tt>allow-mixed-size-journal-media</tt> || Allow disk of different sizes to be paired for mirrored journals.
|-
|   || <tt>force-external-journal-device</tt> || When the physical disk(s) supplied for OSD create are SSD/NVME but still want a journal wal/db device.
|-
|   || <tt>enable-dynamic-weighting</tt> || Weights will be calculated based on size and applied to OSDs during creation if set to true. Weights will be auto-initialized by Ceph if set to false.
|-
|   || <tt>wal-size</tt> || Size of the Ceph Journal Device used as a Write Ahead Log (WAL).
|-
|   || <tt>db-size</tt> || Size of the Ceph Journal Device used for metadata offload.
|-
|   || <tt>osd-type</tt> || Ceph OSD type can be Bluestore or Filestore. [*auto-select, bluestore, filestore]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-replace===
Replaces prepared OSDs

<pre> qs ceph-osd-replace|osd-rep --disk=value --ceph-osd=value --storage-system=value --recreate-journal-devices=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
|-
|   || <tt>ceph-osd</tt> || Ceph OSD name or ID.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>recreate-journal-devices</tt> || Clear and recreate write log and meta data db devices (required for encrypted clusters).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-replace-prep===
Prepares selected OSDs to be replaced

<pre> qs ceph-osd-replace-prep|osd-rep-prep --ceph-osd=value [--storage-system=value ] [--allow-on-no-degraded=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-osd</tt> || Ceph OSD name or ID.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>allow-on-no-degraded</tt> || Instead of the preferred Ceph 'safe-to-destroy' check, allow replace prepare as long as there is no degraded pgs.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-reweight===
Reweight the given set of ceph OSDs to the specified weight.

<pre> qs ceph-osd-reweight|osd-rw --osd-weight-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>osd-weight-list</tt> || List of comma separated OSD IDs and the requested associated capacity percentage, given in the form '5:10,13:5,12:0' etc
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-osd-service-update===
Start/Stop/Restart the specified Ceph OSD service

<pre> qs ceph-osd-service-update|osd-serv-up --osd-list=value [--service-update-mode=value ] [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>osd-list</tt> || Lists all Ceph OSDs.
|-
|   || <tt>service-update-mode</tt> || Ceph OSD service update mode [restart, *start, stop]
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-pool-create===
Creates a new low-level Ceph Pool used as Ceph Block Pool.

<pre> qs ceph-pool-create|cpool-create --name=value --ceph-cluster=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--pool-type=value ] [--rule-name=value ] [--use-case=value ] [--cache-tier=value ] [--compression-algo=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
|   || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|   || <tt>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
|-
|   || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|   || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|   || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficient and is recommended for both scale-out file and object storage pools.
|-
|   || <tt>rule-name</tt> || Ceph crush map rule set name. ('default', if not specified)
|-
|   || <tt>use-case</tt> || Default use case is object storage but Openstack based pools may also be created in addition. [*block, file, object]
|-
|   || <tt>cache-tier</tt> || Creates an additional SSD pool as a write-back cache tier layered over the underlying HDD/EC based pool.
|-
|   || <tt>compression-algo</tt> || Compression algorithm to use for the storage pool. Supported algorithms are 'lz4', 'snappy', and 'none'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-pool-delete===
Deletes the specified Ceph Pool.

<pre> qs ceph-pool-delete|cpool-delete --ceph-cluster=value --ceph-pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-pool</tt> || Ceph Pool name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-pool-get===
Gets information about a specific Ceph Pool.

<pre> qs ceph-pool-get|cpool-get --ceph-pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-pool</tt> || Ceph Pool name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-pool-list===
Returns a list of all the Ceph storage pools.

<pre> qs ceph-pool-list|cpool-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ceph-pool-modify===
Sets the display name and/or description field for the Ceph Pool.

<pre> qs ceph-pool-modify|cpool-modify --ceph-cluster=value --ceph-pool=value [--name=value ] [--desc=value ] [--max-replicas=value ] [--rule=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-pool</tt> || Ceph Pool name or ID.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|   || <tt>rule</tt> || Custom Ceph CRUSH rule name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===load-balancer-create===
Creates a new load balancer instance for the specified system to mesh-network connect with Object Gateways within a given Ceph Cluster.

<pre> qs load-balancer-create|lb-create --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===load-balancer-delete===
Deletes the specified load balancer instance.

<pre> qs load-balancer-delete|lb-delete --load-balancer=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>load-balancer</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===load-balancer-get===
Gets information about a specific load balancer instance.

<pre> qs load-balancer-get|lb-get --load-balancer=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>load-balancer</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===load-balancer-list===
Returns a list of all the load balancers for the specified Ceph Cluster or all instances if no cluster is specified.

<pre> qs load-balancer-list|lb-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===object-gateway-add===
Configures/adds a new Object Storage Gateway (RGW) on a system within a given Ceph Cluster.

<pre> qs object-gateway-add|rgw-add --gw-ipaddress-list=value [--ceph-cluster=value ] [--gw-port=value ] [--service-engine=value ] [--service-mode=value ] [--tcp-no-delay=value ] [--certificate-pem-data=value ] [--redirect-gateway-port=value ] [--load-balancer=value ] [--mapping-mode=value ] [--use-tcp-checks=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>gw-ipaddress-list</tt> || Command separated list of IP addresses for Object Storage Gateway (Ceph RGW).
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>gw-port</tt> || Port used by Object Storage Gateway. [*7480, 7481]
|-
|   || <tt>service-engine</tt> || Service engine type for the RADOS Gateway [*beast, civetweb]
|-
|   || <tt>service-mode</tt> || Service engine mode for the RADOS Gateway [http, *https]
|-
|   || <tt>tcp-no-delay</tt> || This enables the TCP_NODELAY=1 option in beast mode to speed up object storage operations for low latency SSD and NVMe media.
|-
|   || <tt>certificate-pem-data</tt> || File path to PEM file with certificate and key block for SSL/TLS service access.
|-
|   || <tt>redirect-gateway-port</tt> || Redirect port 80 and 443 to the Gateway port 7480. Note that the Quantastor WUI will stop working on this port but may be accessed via HTTPS via alternate port 8080.
|-
|   || <tt>load-balancer</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
|   || <tt>mapping-mode</tt> || Configures what protocol the load balancer uses and how that maps to the back-end RGW Gateway. [auto, http-to-http, *https-to-http, https-to-https]
|-
|   || <tt>use-tcp-checks</tt> || By default health checks are done using HTTP, this argument allows TCP health checks instead.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-gateway-get===
Gets information about a specific Object Storage Gateway (RGW).

<pre> qs object-gateway-get|rgw-get --ceph-gateway=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-gateway</tt> || Object Storage Gateway (Ceph RGW).
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===object-gateway-list===
Returns a list of all the configured Object Storage Gateways (RGW).

<pre> qs object-gateway-list|rgw-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===object-gateway-modify===
Adds/removes custom configuration options for the specified Object Storage Gateway (RGW).

<pre> qs object-gateway-modify|rgw-modify --ceph-gateway=value [--load-balancer=value ] [--active-monitoring=value ] [--settings=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>load-balancer</tt> || Enables the load-balancer configuration manager to include this RGW instance(s) into the load balancer configuration which presents load-balanced RGW access on port 8480. If none of the RGW instances have the load-balancer option enabled then the load balancer config is disabled.
|-
|   || <tt>active-monitoring</tt> || Enables active monitoring of the S3 gateway via periodic ping checks for accessibility to objects.
|-
|   || <tt>ceph-gateway</tt> || Object Storage Gateway (Ceph RGW).
|-
|   || <tt>settings</tt> || Options to enable services and features associated with the S3 gateway (RGW). Comma delimited list of settings. Clear the settings and return to defaults by using the 'none' setting alone. [gcollect, lifecycle, multisite, *none, notify, resharding, s3access]
|-
|   || <tt>flags</tt> || Optional flags for the command. [force]
|}

===object-gateway-remove===
Removes the specified Object Storage Gateway (RGW).

<pre> qs object-gateway-remove|rgw-remove --ceph-cluster=value --ceph-gateway=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-gateway</tt> || Object Storage Gateway (Ceph RGW).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===object-gateway-restart===
Restarts the Object Storage Gateway (RGW) service.

<pre> qs object-gateway-restart|rgw-restart --ceph-gateway=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-gateway</tt> || Object Storage Gateway (Ceph RGW).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-gateway-start===
Starts the Object Storage Gateway (RGW) service.

<pre> qs object-gateway-start|rgw-start --ceph-gateway=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-gateway</tt> || Object Storage Gateway (Ceph RGW).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-gateway-stop===
Stops the Object Storage Gateway (RGW) service.

<pre> qs object-gateway-stop|rgw-stop --ceph-gateway=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-gateway</tt> || Object Storage Gateway (Ceph RGW).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Ceph Client Resource Management [CEPH-CLIENT]==
Commands for managing client connections to ceph resources.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===ceph-client-conf-export===
Exports a client ceph.conf file to default location '/etc/ceph/qs-ceph.conf', unless the 'output-file' argument is provided.

<pre> qs ceph-client-conf-export|ccc-export --ceph-cluster=value [--output-file=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>output-file</tt> || Name of file to which input is written
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-create===
Creates a ceph client registered to a set of ceph resources.

<pre> qs ceph-client-keyring-create|cckr-create --name=value --client-key-type=value --resource-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>client-key-type</tt> || An enum to identify the type of resource the client keyring is associated with. [cephfs, *rbd]
|-
|   || <tt>resource-list</tt> || A list of either RBD pools or CephFS shares to be associated with the client.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-delete===
Deletes an existing ceph client.

<pre> qs ceph-client-keyring-delete|cckr-delete --ceph-client=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-export===
Exports keyring file to default location '/etc/ceph/ceph.client.<name>.keyring', unless the 'output-file' argument is provided.

<pre> qs ceph-client-keyring-export|cckr-export --ceph-client=value [--output-file=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|   || <tt>output-file</tt> || Name of file to which input is written
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-get===
Returns ceph client by name or UUID.

<pre> qs ceph-client-keyring-get|cckr-get --ceph-client=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-list===
Lists all known ceph clients.

<pre> qs ceph-client-keyring-list|cckr-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-resource-assoc-enum===
Lists all known ceph cluster resource associations.

<pre> qs ceph-client-keyring-resource-assoc-enum|cckr-assoc-enum [--ceph-client=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-client-keyring-resource-assoc-get===
Get the keyring association, identified by composite key 'ceph-client' + 'resource'

<pre> qs ceph-client-keyring-resource-assoc-get|cckr-assoc-get --ceph-client=value --resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-client</tt> || Ceph client name or uuid
|-
|   || <tt>resource</tt> || The unique id of a volume or volume group or share or host or host group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Ceph Pool Namespace Management [CEPH-POOL-NAMESPACE]==
Manage Ceph Pool namespaces for workload isolation within Ceph block storage pools.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===ceph-pool-namespace-create===
Creates a new Ceph Pool namespace for workload isolation within the specified pool.

<pre> qs ceph-pool-namespace-create|cpns-create --name=value --description=value --ceph-cluster-id=value --ceph-pool-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || Optional text description for this object.
|-
|   || <tt>ceph-cluster-id</tt> || Name or ID of the Ceph Cluster.
|-
|   || <tt>ceph-pool-id</tt> || Name or ID of the Ceph Pool.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-pool-namespace-delete===
Deletes the specified Ceph Pool namespace.

<pre> qs ceph-pool-namespace-delete|cpns-delete --ceph-pool-namespace=value [--ceph-cluster-id=value ] [--ceph-pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-pool-namespace</tt> || Ceph Pool Namespace name or ID.
|-
|   || <tt>ceph-cluster-id</tt> || Name or ID of the Ceph Cluster.
|-
|   || <tt>ceph-pool</tt> || Ceph Pool name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-pool-namespace-get===
Gets the details of a specific Ceph Pool namespace.

<pre> qs ceph-pool-namespace-get|cpns-get --ceph-pool-namespace=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-pool-namespace</tt> || Ceph Pool Namespace name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-pool-namespace-list===
Lists all Ceph Pool namespaces.

<pre> qs ceph-pool-namespace-list|cpns-list [--ceph-cluster-id=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster-id</tt> || Name or ID of the Ceph Cluster.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Ceph Journal Management [CEPHJOURNAL]==
Commands for management, monitoring, and configuration of Ceph Journal Groups and Ceph Journal Devices.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===ceph-journal-delete===
Deletes the specified Ceph Journal and all journal partitions on the given physical disk, if a physical disk is specified. Note: This call will fail if there are one or more Journals still being used by OSDs in the system.

<pre> qs ceph-journal-delete|cj-delete --ceph-journal-device=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-journal-get===
Returns details of a specific Ceph Journal Device.

<pre> qs ceph-journal-get|cj-get --ceph-journal-device=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ceph-journal-group-create===
Creates a Ceph Journal Group out of the specified device(s). If two devices are specified, the Journal Group will create the group as a RAID1 mirrored group to ensure fault-tolerance in the event of a device failure. All systems should use mirrored Journal Groups to ensure OSDs do not need to be rebuilt due to a journal group device failure.

<pre> qs ceph-journal-group-create|cjg-create --primary-disk=value [--secondary-disk=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>primary-disk</tt> || Disk to be used as the underlying hardware for a Ceph Journal Group.
|-
|   || <tt>secondary-disk</tt> || Disk to be used as the underlying hardware for a Ceph Journal Group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-journal-group-delete===
Deletes a Ceph Journal Group and all underlying Ceph Journal Devices to free up the underlying media for reuse.

<pre> qs ceph-journal-group-delete|cjg-delete --ceph-journal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===ceph-journal-group-get===
Returns details of a specific Ceph Journal Group.

<pre> qs ceph-journal-group-get|cjg-get --ceph-journal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===ceph-journal-group-list===
Returns a list of all the Ceph Journal Groups.

<pre> qs ceph-journal-group-list|cjg-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-journal-list===
Returns a list of all the Ceph Journal Devices.

<pre> qs ceph-journal-list|cj-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-journal-migrate===
Migrate an OSD's Journal Device.

<pre> qs ceph-journal-migrate|cj-migrate --ceph-cluster=value --ceph-journal-device=value [--ceph-journal-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-journal-device</tt> || Ceph Journal Device name or ID.
|-
|   || <tt>ceph-journal-group</tt> || Ceph Journal Group name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

</div>
</div>

==CephFS Management [CEPHFS]==
Commands for scale-out NAS filesystem setup within a managed Ceph Cluster.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===ceph-filesystem-create===
Creates a new Ceph Filesystem for the Ceph Cluster to enable scale-out Network Share provisioning and access.

<pre> qs ceph-filesystem-create|cephfs-create --name=value --ceph-cluster=value --pool-type=value [--desc=value ] [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--k=value ] [--m=value ] [--rule-name=value ] [--active-mds-count=value ] [--standby-mds-count=value ] [--auto-config-nfs=value ] [--compression-algo=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficient and is recommended for both scale-out file and object storage pools.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
|   || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|   || <tt>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
|-
|   || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|   || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|   || <tt>rule-name</tt> || Ceph crush map rule set name. ('default', if not specified)
|-
|   || <tt>active-mds-count</tt> || Number of active MDS instances
|-
|   || <tt>standby-mds-count</tt> || Number of standby MDS instances
|-
|   || <tt>auto-config-nfs</tt> || Auto configure NFS services for scale-out storage.
|-
|   || <tt>compression-algo</tt> || Compression algorithm to use for the storage pool. Supported algorithms are 'lz4', 'snappy', and 'none'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-filesystem-delete===
Deletes the specified Ceph Filesystem, WARNING all associated files and Ceph Pools will be destroyed.

<pre> qs ceph-filesystem-delete|cephfs-delete --ceph-filesystem=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ceph-filesystem-get===
Returns information about a specific Ceph Filesystem instance.

<pre> qs ceph-filesystem-get|cephfs-get --ceph-filesystem=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-filesystem-list===
Returns a list of all the Ceph Filesystems.

<pre> qs ceph-filesystem-list|cephfs-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ceph-filesystem-modify===
Modifies the settings for the specified Ceph Filesystem.

<pre> qs ceph-filesystem-modify|cephfs-modify --ceph-filesystem=value [--desc=value ] [--flags=value ] [--active-mds-count=value ] [--standby-mds-count=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|-
|   || <tt>active-mds-count</tt> || Number of active MDS instances
|-
|   || <tt>standby-mds-count</tt> || Number of standby MDS instances
|}

===ceph-filesystem-pool-add===
Adds a new pool to the specified Ceph Filesystem.

<pre> qs ceph-filesystem-pool-add|cephfs-pool-add --ceph-filesystem=value --pool-type=value [--data-pool-suffix=value ] [--scaling-factor=value ] [--k=value ] [--m=value ] [--rule-name=value ] [--max-replicas=value ] [--min-replicas=value ] [--ceph-cluster=value ] [--compression-algo=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-filesystem</tt> || Ceph Filesystem with associated data and metadata Ceph Pools.
|-
|   || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficient and is recommended for both scale-out file and object storage pools.
|-
|   || <tt>data-pool-suffix</tt> || The suffix to append to the new data pool name.
|-
|   || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
|   || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|   || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|   || <tt>rule-name</tt> || Ceph crush map rule set name. ('default', if not specified)
|-
|   || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|   || <tt>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>compression-algo</tt> || Compression algorithm to use for the storage pool. Supported algorithms are 'lz4', 'snappy', and 'none'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Certificate Management [CERTIFICATE]==
Used to manage the certificates used by the system for various purposes, such as the web UI, object gateway, core service, etc.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===certificate-get===
Get details on a specific certificate.

<pre> qs certificate-get|cert-get --cert=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cert</tt> || Name or ID of the certificate.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-list===
List all the certificates applied to the systems.

<pre> qs certificate-list|cert-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-rescan===
Scans a storage system for service defined certificates in the form of PEM files.

<pre> qs certificate-rescan|cert-rescan --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-template-add===
Add a new certificate template to the system.

<pre> qs certificate-template-add|cert-tmpl-add --name=value --description=value --certificate-pem-data=value [--privatekey-pem-data=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>certificate-pem-data</tt> || File path to PEM file with certificate and key block for SSL/TLS service access.
|-
|   || <tt>privatekey-pem-data</tt> || File path to a separate optional PEM file with a private key block, not used when the certificate pem also includes the private key.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-template-get===
Get details on a specific certificate template.

<pre> qs certificate-template-get|cert-tmpl-get --cert=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cert</tt> || Name or ID of the certificate.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-template-list===
List all the certificate templates available in the system.

<pre> qs certificate-template-list|cert-tmpl-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-template-remove===
Remove a certificate template from the system.

<pre> qs certificate-template-remove|cert-tmpl-rm --cert=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cert</tt> || Name or ID of the certificate.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===certificate-update===
Update the certificate applied to a storage system.

<pre> qs certificate-update|cert-update --storage-system=value --cert-use-case=value --cert-tmpl=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>cert-use-case</tt> || Use case for the certificate.
|-
|   || <tt>cert-tmpl</tt> || Name or ID of the certificate template.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Cloud Container Management [CLOUD-CONTAINER]==
Cloud containers provide a NAS gateway mechanism to bridging Object cloud storage to a local Network Share within an appliance.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===cloud-cache-default-settings-get===
Get the default Cloud Container cache settings

<pre> qs cloud-cache-default-settings-get|cc-def-settings-get --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cloud-cache-default-settings-modify===
Modify the default Cloud Container cache settings

<pre> qs cloud-cache-default-settings-modify|cc-def-settings-mod --cloud-settings=value [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cloud-settings</tt> || Global cloud settings for a system
|-
|   || <tt>vfs-cache-mode</tt> || Cloud container cache mode [*default, full, minimal, off, writes]
|-
|   || <tt>dir-cache-time</tt> || Cloud container time to cache directory entries. Time is specified in the format 1h10m5s
|-
|   || <tt>cache-share-id</tt> || Cloud container Cache Share Id. Need to create a Network share to be used as a Cloud Container Cache.
|-
|   || <tt>buffer-size</tt> || Cloud container cache buffer size.
|-
|   || <tt>vfs-cache-max-age</tt> || Cloud container max age of objects in the cache. Time is specified in the format 1h10m5s.
|-
|   || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-add===
Recovers a cloud backup container that was previously removed or used with a prior installation.

<pre> qs cloud-container-add|clcn-add --provider-creds=value --location=value --bucket-name=value [--encryption-key=value ] [--enable-nfs=value ] [--attach-to=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|   || <tt>location</tt> || Cloud storage provider endpoint location.
|-
|   || <tt>bucket-name</tt> || The cloud container name used to identify a cloud backup container.
|-
|   || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the storage resource.
|-
|   || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
|-
|   || <tt>attach-to</tt> || Appliance to attach the Cloud Container to. If not specified it will attach to the system the CLI/API call is routed to.
|-
|   || <tt>mount-options</tt> || Customized mount options for the cloud container to optimize cache and other settings for a given workload.
|-
|   || <tt>storage-class</tt> || Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
|-
|   || <tt>vfs-cache-mode</tt> || Cloud container cache mode [*default, full, minimal, off, writes]
|-
|   || <tt>dir-cache-time</tt> || Cloud container time to cache directory entries. Time is specified in the format 1h10m5s
|-
|   || <tt>cache-share-id</tt> || Cloud container Cache Share Id. Need to create a Network share to be used as a Cloud Container Cache.
|-
|   || <tt>buffer-size</tt> || Cloud container cache buffer size.
|-
|   || <tt>vfs-cache-max-age</tt> || Cloud container max age of objects in the cache. Time is specified in the format 1h10m5s.
|-
|   || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-bucket-scan===
Scans for available buckets using the specified cloud provider credentials.

<pre> qs cloud-container-bucket-scan|clcn-bucket-scan --provider-creds=value --location-tag=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|   || <tt>location-tag</tt> || Location tag of the endpoint such as sjc01, not always required.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-create===
Creates a cloud backup container into which cloud backups of Storage Volumes can be made.

<pre> qs cloud-container-create|clcn-create --name=value --provider-creds=value --location=value [--desc=value ] [--attach-to=value ] [--enable-nfs=value ] [--mount-options=value ] [--storage-class=value ] [--vfs-cache-mode=value ] [--dir-cache-time=value ] [--cache-share-id=value ] [--buffer-size=value ] [--vfs-cache-max-age=value ] [--vfs-cache-max-size=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|   || <tt>location</tt> || Cloud storage provider endpoint location.
|-
|   || <tt>attach-to</tt> || Appliance to attach the Cloud Container to. If not specified it will attach to the system the CLI/API call is routed to.
|-
|   || <tt>enable-nfs</tt> || Enable NFS sharing of the cloud container.
|-
|   || <tt>mount-options</tt> || Customized mount options for the cloud container to optimize cache and other settings for a given workload.
|-
|   || <tt>storage-class</tt> || Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
|-
|   || <tt>vfs-cache-mode</tt> || Cloud container cache mode [*default, full, minimal, off, writes]
|-
|   || <tt>dir-cache-time</tt> || Cloud container time to cache directory entries. Time is specified in the format 1h10m5s
|-
|   || <tt>cache-share-id</tt> || Cloud container Cache Share Id. Need to create a Network share to be used as a Cloud Container Cache.
|-
|   || <tt>buffer-size</tt> || Cloud container cache buffer size.
|-
|   || <tt>vfs-cache-max-age</tt> || Cloud container max age of objects in the cache. Time is specified in the format 1h10m5s.
|-
|   || <tt>vfs-cache-max-size</tt> || Cloud container max size of objects in the cache. If not specified, there is no limit.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-delete===
Deletes the specified cloud backup container. WARNING, all data in the container will be destroyed.

<pre> qs cloud-container-delete|clcn-delete --container=value [--delete-cloud-bucket=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|   || <tt>delete-cloud-bucket</tt> || Delete the bucket from the cloud.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-disable===
Disables access to the specified cloud container without having to remove it.

<pre> qs cloud-container-disable|clcn-disable --container=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-enable===
Enables a cloud container that was previously disabled or was inaccessible due to network connection issues.

<pre> qs cloud-container-enable|clcn-enable --container=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-get===
Returns detailed information on a specific cloud backup container.

<pre> qs cloud-container-get|clcn-get --container=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cloud-container-list===
Returns a list of cloud backup containers in the system.

<pre> qs cloud-container-list|clcn-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-container-repair===
Repairs the specified cloud backup container.

<pre> qs cloud-container-repair|clcn-repair --container=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-container-rescan===
Clears stale/cached metadata so that the Cloud Container presents the most current file and directory information.

<pre> qs cloud-container-rescan|clcn-rescan --container=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>container</tt> || A cloud backup container into which Network Shares can be backed up.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-provider-add===
Adds a new private cloud object storage provider entry.

<pre> qs cloud-provider-add|clp-add --name=value --location-name=value --location-tag=value --location-endpoint=value [--desc=value ] [--access-key=value ] [--secret-key=value ] [--project-id=value ] [--auth-file=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>location-name</tt> || Friendly name of the endpoint location.
|-
|   || <tt>location-tag</tt> || Location tag of the endpoint such as sjc01, not always required.
|-
|   || <tt>location-endpoint</tt> || FQDN/URL of the end-point
|-
|   || <tt>access-key</tt> || The access key provided by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>secret-key</tt> || The secret key provided by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>project-id</tt> || The project Id provided by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>auth-file</tt> || Path to the account auth file provider by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-credentials-add===
Adds cloud provider credentials to enable cloud backup to cloud backup containers.

<pre> qs cloud-provider-credentials-add|clpc-add --provider=value --access-key=value --secret-key=value [--project-id=value ] [--auth-file=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider</tt> || Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3-compatible object storage Cloud Providers may be added for private and/or public clouds.
|-
|   || <tt>access-key</tt> || The access key provided by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>secret-key</tt> || The secret key provided by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>project-id</tt> || The project Id provided by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>auth-file</tt> || Path to the account auth file provider by your cloud storage provider for accessing your cloud storage account.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-provider-credentials-get===
Returns information about the specified cloud provider credential.

<pre> qs cloud-provider-credentials-get|clpc-get --provider-creds=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cloud-provider-credentials-list===
Returns a list of all the cloud provider credentials in the system. Passwords are masked.

<pre> qs cloud-provider-credentials-list|clpc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-credentials-remove===
Removes the specified cloud provider credentials

<pre> qs cloud-provider-credentials-remove|clpc-remove --provider-creds=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider-creds</tt> || Credential ID for accessing your cloud storage provider account.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cloud-provider-get===
Returns detailed information about the specified cloud provider.

<pre> qs cloud-provider-get|clp-get --provider=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider</tt> || Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3-compatible object storage Cloud Providers may be added for private and/or public clouds.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cloud-provider-list===
Returns the list of supported cloud providers.

<pre> qs cloud-provider-list|clp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-location-add===
Adds a new endpoint location to an existing private cloud object storage provider.

<pre> qs cloud-provider-location-add|clpl-add --provider=value --location-name=value --location-tag=value --location-endpoint=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider</tt> || Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3-compatible object storage Cloud Providers may be added for private and/or public clouds.
|-
|   || <tt>location-name</tt> || Friendly name of the endpoint location.
|-
|   || <tt>location-tag</tt> || Location tag of the endpoint such as sjc01, not always required.
|-
|   || <tt>location-endpoint</tt> || FQDN/URL of the end-point
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-location-get===
Returns details of the specified cloud provider location endpoint.

<pre> qs cloud-provider-location-get|clpl-get --location=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>location</tt> || ID or name of a cloud provider location endpoint.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cloud-provider-location-list===
Returns a list of all the object storage location endpoints in the grid.

<pre> qs cloud-provider-location-list|clpl-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-location-remove===
Removes the specified location endpoint from a cloud object storage provider entry.

<pre> qs cloud-provider-location-remove|clpl-remove --location=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>location</tt> || ID or name of a cloud provider location endpoint.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-storage-class-add===
Adds a mew storage class for a cloud provider

<pre> qs cloud-provider-storage-class-add|clpsc-add --provider=value --storage-class-tag=value --storage-description=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider</tt> || Cloud Providers include major object storage suppliers including AWS, IBM COS, Azure. Additional S3-compatible object storage Cloud Providers may be added for private and/or public clouds.
|-
|   || <tt>storage-class-tag</tt> || Tag for the Cloud Provider Storage Class
|-
|   || <tt>storage-description</tt> || Description of the Cloud Provider Storage Class
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-storage-class-get===
Returns information about the specified Cloud Provider Storage Class

<pre> qs cloud-provider-storage-class-get|clpsc-get --storage-class=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-class</tt> || Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cloud-provider-storage-class-list===
Returns a list of Cloud Provider Storage Class

<pre> qs cloud-provider-storage-class-list|clpsc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cloud-provider-storage-class-remove===
Removes the specified storage class

<pre> qs cloud-provider-storage-class-remove|clpsc-remove --storage-class=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-class</tt> || Storage Class for the bucket. IBM COS (standard, vault, cold, flex) AWS (STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA) GOOGLE CLOUD (MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE)
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Container Management [CONTAINER]==
Commands for the management of Containers which are objects that describe the instances of docker containers and their various configurations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===service-config-create===
Creates a new Service Config with the specified configuration options.

<pre> qs service-config-create|serv-conf-create --name=value --service-definition-tag=value [--service-config-options-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>service-definition-tag</tt> || The tag of the Service Definition desired for the Service. [resilio, universal, vsftp]
|-
|   || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-delete===
Deletes the specified Service Config.

<pre> qs service-config-delete|serv-conf-delete --service-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-get===
Returns the specified Service Config.

<pre> qs service-config-get|serv-conf-get --service-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-list===
Returns a list of Service Configs.

<pre> qs service-config-list|serv-conf-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-option-add===
Adds key=value style options to the given Service Config.

<pre> qs service-config-option-add|serv-conf-opt-add --service-config=value --service-config-options-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-option-get===
Returns the specified Service Config Option.

<pre> qs service-config-option-get|serv-conf-opt-get --service-config=value --key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>key</tt> || A Service Config Option key.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-option-remove===
Removes key=value style options from the given Service Config.

<pre> qs service-config-option-remove|serv-conf-opt-remove --service-config=value --service-config-options-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-option-set===
Modify key=value style options from the given Service Config.

<pre> qs service-config-option-set|serv-conf-opt-set --service-config=value --service-config-options-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>service-config-options-list</tt> || List of Service Config Options specified as key1=value1,key2=value2, etc. Valid options for FTP service are ftp_user (required), ftp_pass (required), pasv_enabled (defaults to 'no'), pasv_min_port (required if pasv_enabled = 'yes'), pasv_max_port (required if pasv_enabled = 'yes'), pasv_address (required if pasv_enabled = 'yes'). Valid options for Resilio service are agent_name (required) and sync_file (required).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-config-options-list===
Lists all key=value options associated with the given Service Config.

<pre> qs service-config-options-list|serv-conf-opt-list --service-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-config</tt> || ID or name of Service Config.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===service-def-get===
Returns the specified Service Definition.

<pre> qs service-def-get|serv-def-get --id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>id</tt> || Unique identifier (GUID) for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===service-def-list===
Returns a list of all Service Definitions.

<pre> qs service-def-list|serv-def-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===service-get===
Returns the specified Service.

<pre> qs service-get|serv-get --service-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>service-id</tt> || The name or ID of a Service.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===service-list===
Returns a list of all Services.

<pre> qs service-list|serv-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Dashboard Management [DASHBOARD]==
Commands for adding/removing custom dashboards to the web user interface.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===dashboard-create===
Creates a new dashboard with the specified name and URL.

<pre> qs dashboard-create|ds-create --name=value --description=value --url=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>url</tt> || URL to the application/dashboard to be opened in the custom dashboards area.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-delete===
Deletes the specified dashboard.

<pre> qs dashboard-delete|ds-delete --dashboard=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>dashboard</tt> || Dashboards are custom embedded URLs that can be used to extend the QuantaStor user interface with additional dashboards and other integrations.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-get===
Gets properties of the specified dashboard

<pre> qs dashboard-get|ds-get --dashboard=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>dashboard</tt> || Dashboards are custom embedded URLs that can be used to extend the QuantaStor user interface with additional dashboards and other integrations.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-group-create===
Creates a new dashboard group to organize dashboards.

<pre> qs dashboard-group-create|dsg-create --name=value --description=value --dashboard-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>dashboard-list</tt> || List of dashboard names or IDs to be used in the Dashboard Group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-group-delete===
Deletes the specified dashboard group.

<pre> qs dashboard-group-delete|dsg-delete --dashboard=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>dashboard</tt> || Dashboards are custom embedded URLs that can be used to extend the QuantaStor user interface with additional dashboards and other integrations.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-group-get===
Gets properties of the specified dashboard group.

<pre> qs dashboard-group-get|dsg-get --dashboard=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>dashboard</tt> || Dashboards are custom embedded URLs that can be used to extend the QuantaStor user interface with additional dashboards and other integrations.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-group-list===
Lists all dashboard groups in the storage grid.

<pre> qs dashboard-group-list|dsg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-group-modify===
Modifies the specified dashboard group.

<pre> qs dashboard-group-modify|dsg-modify --dashboard=value --name=value --description=value --dashboard-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>dashboard</tt> || Dashboards are custom embedded URLs that can be used to extend the QuantaStor user interface with additional dashboards and other integrations.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>dashboard-list</tt> || List of dashboard names or IDs to be used in the Dashboard Group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-list===
Lists all dashboards in the grid.

<pre> qs dashboard-list|ds-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===dashboard-modify===
Modifies the specified dashboard.

<pre> qs dashboard-modify|ds-modify --dashboard=value --name=value --description=value --url=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>dashboard</tt> || Dashboards are custom embedded URLs that can be used to extend the QuantaStor user interface with additional dashboards and other integrations.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>url</tt> || URL to the application/dashboard to be opened in the custom dashboards area.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Physical Disk Management [DISK]==
Physical Disks represent storage media (SATA, SAS, nVME, SSD, HW RAID LVs, etc) that appear to the system via HBAs and internal controllers.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===disk-copy===
Copies data from a Physical Disk or Storage Volume to a new Physical Disk, Storage Volume, or Network Share file.

<pre> qs disk-copy|disk-cp --source-id=value --target-id=value --source-type=value --target-type=value [--target-name=value ] [--blocksize-kb=value ] [--target-format=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>source-id</tt> || ID of the source Physical Disk or Storage Volume to be copied.
|-
|   || <tt>target-id</tt> || ID of the target Physical Disk, Network Share, or Storage Volume's Pool where data will be copied to.
|-
|   || <tt>source-type</tt> || Type of media where data will be copied from (Physical Disk or Storage Volume). [*disk, volume]
|-
|   || <tt>target-type</tt> || Type of media where data will be copied to (Physical Disk, Storage Volume, or Network Share [*disk, share, volume]
|-
|   || <tt>target-name</tt> || Name of the target Storage Volume or file in the target Network Share.
|-
|   || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
|   || <tt>target-format</tt> || Image type of the data once copied (Defaults to raw). [qcow, *raw, vhd, vmdk]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-format===
Removes all encryption settings, partitions, does a quick format of the device, and then optionally shreds the contents.

<pre> qs disk-format|pd-format --disk-list=value [--shred-mode=value ] [--release-io-fence=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>shred-mode</tt> || Indicates the mode used to shred data on all the disks in the pool as part of the pool destroy process. [auto, dod, nnsa, *none, nvme_secure, random, sed-instant-erase, ssd_secure, usarmy, zeros]
|-
|   || <tt>release-io-fence</tt> || Release all I/O fence reservations for the specified disk(s)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-get===
Gets information about a specific physical disk.

<pre> qs disk-get|pd-get --disk=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===disk-global-spare-add===
Adds one or more dedicated hotspares to the global hotspare pool.

<pre> qs disk-global-spare-add|hsm-add --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-global-spare-marker-cleanup===
Cleans up invalid marker records for the dedicated hotspare physical disks in the global hot-spare pool.

<pre> qs disk-global-spare-marker-cleanup|hsm-cleanup [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-global-spare-marker-delete===
Deletes the specified global hotspare marker object.

<pre> qs disk-global-spare-marker-delete|hsm-del --name=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-global-spare-marker-get===
Returns information about the specified global hotspare marker object.

<pre> qs disk-global-spare-marker-get|hsm-get --name=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-global-spare-marker-list===
Enumerates marker records for the dedicated hotspare physical disks in the global hot-spare pool.

<pre> qs disk-global-spare-marker-list|hsm-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-global-spare-remove===
Removes one or more dedicated hotspares from the global hotspare pool.

<pre> qs disk-global-spare-remove|hsm-remove --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-identify===
Pulses the disk activity light so that the specified disk can be identified in the chassis.

<pre> qs disk-identify|pd-id --disk=value [--pattern=value ] [--duration=value ] [--blink-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk</tt> || Name of the physical disk or its unique ID/serial number.
|-
|   || <tt>pattern</tt> || Pattern to flash the disk LED lights in, p = short pulse, P = long pulse, d = short delay, D = long delay, ex: pattern=pppD
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-list===
Enumerates all physical disks.

<pre> qs disk-list|pd-list [--filter=value ] [--normalize=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>filter</tt> || Filter may include disk names/IDs, Storage System names/IDs, storage pool names/IDs, and a [N] identifier to select unused disks where N is the number of unused disks to select, [nopaths] to indicate no paths of a multipath or encrypted device, [paths] to only show paths, [used] to indicate only disks that are in use, [unused] to indicate disks that are available, [eq:SIZE] such as [eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like [vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-multipath-config-add===
Adds physical disk multipath configuration entries.

<pre> qs disk-multipath-config-add|dmpc-add --device-tag-list=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>device-tag-list</tt> || List of physical disk multipath tag strings: 'vendor:product'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-multipath-config-list===
Enumerates physical disk multipath configuration entries.

<pre> qs disk-multipath-config-list|dmpc-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-multipath-config-remove===
Removes physical disk multipath configuration entries.

<pre> qs disk-multipath-config-remove|dmpc-remove --device-tag-list=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>device-tag-list</tt> || List of physical disk multipath tag strings: 'vendor:product'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-multipath-config-scan===
Scans physical disks for multipath capability.

<pre> qs disk-multipath-config-scan|dmpc-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-performance-test===
Performs performance tests on physical disks.

<pre> qs disk-performance-test|pd-perftest --disk-list=value [--perf-test-type=value ] [--block-size=value ] [--block-count=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>perf-test-type</tt> || The type of performance test to be performed. [*read-sequential]
|-
|   || <tt>block-size</tt> || Volume block size in string format, such as 512, 1k, 2k, 4k, 8k, 16k, 32k, 64k, 128k, 256k, 512k, 1M, 2M, etc
|-
|   || <tt>block-count</tt> || Number of blocks
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-scan===
Scans for any new physical disks that may have been hot-plugged into the Storage System.

<pre> qs disk-scan|pd-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===disk-search===
Returns a subset of Physical Disk objects matching the given criteria.

<pre> qs disk-search|pd-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Physical Disk List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===disk-sed-hard-reset===
Performs a hard PSID reset on the specified self-encrypting disk.

<pre> qs disk-sed-hard-reset|pd-sed-reset --disk-list=value --psid-passphrase=value [--options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>psid-passphrase</tt> || Physical Secure ID/passphrase.
|-
|   || <tt>options</tt> || Special options - reserved.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===disk-spare-list===
Enumerates dedicated hotspare physical disks in the global hotspare pool.

<pre> qs disk-spare-list|pd-spare-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==External System Managementd [EXTERNALSYSTEM]==
Commands for managing and discovering External Systems.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===external-system-assign-media===
Creates a Software Adapter to assign the specified list of External System Media devices to a Storage System.

<pre> qs external-system-assign-media|ext-sys-assign-media --storage-system=value --external-system-media-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>external-system-media-list</tt> || A comma separated list of External System Media IDs, or the name/ID of an External System or External System Credentials to add all Media from an External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-controller-get===
Returns information on the desired External System Controller.

<pre> qs external-system-controller-get|ext-sys-cntrlr-get --external-system-controller=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-controller</tt> || Name or ID of the requested External System Controller.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-controller-list===
Returns a list of the discovered External System Controllers for a specified External System.

<pre> qs external-system-controller-list|ext-sys-cntrlr-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-credentials-add===
Adds the required credentials for discovering an External System.

<pre> qs external-system-credentials-add|ext-sys-creds-add --name=value --ext-system-username=value --ext-system-password=value --primary-ip=value --secondary-ip=value [--external-system-type=value ] [--storage-system=value ] [--site-cluster=value ] [--port=value ] [--insecure=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>ext-system-username</tt> || The username for accessing the External System.
|-
|   || <tt>ext-system-password</tt> || The password for accessing the External System.
|-
|   || <tt>primary-ip</tt> || Primary IP used to discover External Systems
|-
|   || <tt>secondary-ip</tt> || Secondary IP used to discover External Systems if the primary IP fails.
|-
|   || <tt>external-system-type</tt> || Type of External System [corvault, *openflex]
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>site-cluster</tt> || The name or ID of a site cluster.
|-
|   || <tt>port</tt> || Port number to run External System discovery against.
|-
|   || <tt>insecure</tt> || Use insecure http if specified to true, else use secure https by default.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-credentials-get===
Returns the credentials information about the specified External System.

<pre> qs external-system-credentials-get|ext-sys-creds-get --ext-system-credentials=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ext-system-credentials</tt> || ID or name of the requested External System Credentials.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-credentials-list===
Returns a list of all the credentials for External System discovery.

<pre> qs external-system-credentials-list|ext-sys-creds-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-credentials-remove===
Remove credentials for discovering a specified External System.

<pre> qs external-system-credentials-remove|ext-sys-creds-remove --name=value --ext-system-username=value --ext-system-password=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>ext-system-username</tt> || The username for accessing the External System.
|-
|   || <tt>ext-system-password</tt> || The password for accessing the External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-get===
Returns information on a specified discovered External System.

<pre> qs external-system-get|ext-sys-get --external-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-host-get===
Returns information on the specified discovered External System Host

<pre> qs external-system-host-get|ext-sys-host-get --external-system-host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-host</tt> || The name or ID of the requested External System Host.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-host-list===
Returns a list of discovered External System Hosts

<pre> qs external-system-host-list|ext-sys-host-list --external-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-host-volume-assoc-list===
Returns a list of the External System Host to Volume associations.

<pre> qs external-system-host-volume-assoc-list|ext-sys-host-vol-assoc-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-list===
Returns a list of all the discovered External Systems.

<pre> qs external-system-list|ext-sys-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-media-get===
Returns information on a specified discovered External System Media device.

<pre> qs external-system-media-get|ext-sys-med-get --external-system-media=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-media</tt> || Name or ID of the requested External System Media device.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-media-list===
Returns a list of the discovered Media devices for a specified External System or specified External System Port Group.

<pre> qs external-system-media-list|ext-sys-med-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-modify===
Modifies the properties of an External System such as an alternative name, description, and enclosure layout.

<pre> qs external-system-modify|ext-sys-modify --external-system=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>alt-name</tt> || Alternate name for an External System.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>enclosure-layout</tt> || Enclosure layout for an External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-pool-get===
Returns information on a specified Pool from a specified External System.

<pre> qs external-system-pool-get|ext-sys-pool-get --external-system-pool=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-pool</tt> || Name or ID of the requested External System Pool.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-pool-list===
Returns a list of discovered Pools from a specified External System.

<pre> qs external-system-pool-list|ext-sys-pool-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-port-get===
Returns information on a specified Port on a discovered External System.

<pre> qs external-system-port-get|ext-sys-port-get --external-system-port=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-port</tt> || Name or ID of the requested External System Port.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-port-group-get===
Returns information on the desired External System Port Group.

<pre> qs external-system-port-group-get|ext-sys-port-grp-get --external-system-port-group=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-port-group-list===
Returns a list of discovered Port Groups from a specified External System.

<pre> qs external-system-port-group-list|ext-sys-port-grp-list [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-port-list===
Returns a list of discovered Ports on a specified External System or a specified External System Port Group.

<pre> qs external-system-port-list|ext-sys-port-list [--external-system=value ] [--external-system-port-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>external-system-port-group</tt> || Name or ID of the requested External System Port Group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-port-modify===
Modifies the properties of an External System Port such as IP and subnet mask.

<pre> qs external-system-port-modify|ext-sys-port-modify --external-system-port=value [--external-system=value ] [--ip-address=value ] [--subnet=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-port</tt> || Name or ID of the requested External System Port.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>subnet</tt> || The subnet of an IP address (defaults to /16)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-profile-apply===
Configures a previously discovered External System according to the given External System Profile.

<pre> qs external-system-profile-apply|ext-sys-prof-apply --external-system=value --external-system-profile=value --volume-count=value --max-volume-size=value --volume-size=value --assign-to-hosts=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>external-system-profile</tt> || Name or ID of a given External System Profile.
|-
|   || <tt>volume-count</tt> || Number of External System Volumes to batch create.
|-
|   || <tt>max-volume-size</tt> || If true, the External System Volume size will be calculated by dividing the External System Pool capacity by the given volume count.
|-
|   || <tt>volume-size</tt> || Size of batch created External System Volumes.
|-
|   || <tt>assign-to-hosts</tt> || External System Volumes will be assigned to the given list of Hosts after creation of volumes.
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-profile-get===
Returns the specified External System Profile.

<pre> qs external-system-profile-get|ext-sys-prof-get --external-system-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-profile</tt> || Name or ID of a given External System Profile.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-profile-list===
Returns a list of the available External System Profiles.

<pre> qs external-system-profile-list|ext-sys-prof-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-scan===
Scan for discoverable External Systems.

<pre> qs external-system-scan|ext-sys-scan [--ext-system-credentials=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ext-system-credentials</tt> || ID or name of the requested External System Credentials.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-send-logs===
Downloads the most recent logs from the External System specified to the '/var/log/qs/es/ directory, then sends the logs to OSNEXUS support.

<pre> qs external-system-send-logs|ext-sys-send-logs --external-system=value [--disable-upload=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>disable-upload</tt> || If true, logs are only downloaded to the local system, but not sent to OSNEXUS support.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-volume-create===
Batch creates External System Volumes on the given External System Pool.

<pre> qs external-system-volume-create|ext-sys-vol-create --external-system-pool=value --volume-name-prefix=value --volume-count=value --max-volume-size=value --volume-size=value --assign-to-hosts=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-pool</tt> || Name or ID of the requested External System Pool.
|-
|   || <tt>volume-name-prefix</tt> || Prefix to use for new External System Volumes.
|-
|   || <tt>volume-count</tt> || Number of External System Volumes to batch create.
|-
|   || <tt>max-volume-size</tt> || If true, the External System Volume size will be calculated by dividing the External System Pool capacity by the given volume count.
|-
|   || <tt>volume-size</tt> || Size of batch created External System Volumes.
|-
|   || <tt>assign-to-hosts</tt> || External System Volumes will be assigned to the given list of Hosts after creation of volumes.
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-volume-delete===
Deletes a list of External System Volumes.

<pre> qs external-system-volume-delete|ext-sys-vol-del --external-system-volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-volume-list</tt> || A comma separated list of External System Volume IDs, or the name/ID of an External System or External System Credentials to add all Volumes from an External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-volume-get===
Returns information on a specified External System Volume.

<pre> qs external-system-volume-get|ext-sys-vol-get --external-system-volume=value [--external-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system-volume</tt> || Name or ID of the requested External System Volume.
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===external-system-volume-list===
Returns a list of the discovered Volume from the specified External System or from the specified External System Pool.

<pre> qs external-system-volume-list|ext-sys-vol-list [--external-system=value ] [--external-system-pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>external-system</tt> || Name or ID of the requested External System.
|-
|   || <tt>external-system-pool</tt> || Name or ID of the requested External System Pool.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Fc Remote Port Management [FC-REMOTE-PORT]==
{CATEGORY DESCRIPTION GOES HERE}
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===fc-remote-port-get===
Details of a specific FC remote port.

<pre> qs fc-remote-port-get|fcrp-get --remote-port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>remote-port</tt> || FC WWN of a remote server's initiator port.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===fc-remote-port-list===
List all remote FC port WWNs visible to FC target ports in the Storage System.

<pre> qs fc-remote-port-list|fcrp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Storage System Grid Management [GRID]==
Commands for management and formation of Storage Grids which are comprised of one or more Storage Systems. Storage Grids simplify management and enables advanced features including HA, DR, and scale-out configurations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===grid-add===
Adds the specified Storage System to the management grid.

<pre> qs grid-add|mg-add --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>node-ipaddress</tt> || IP address of a Storage System node.
|-
|   || <tt>node-username</tt> || Admin user account with permissions to add/remove nodes from the grid.
|-
|   || <tt>node-password</tt> || Admin user account password.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-assoc-get===
Get general information about the associated Storage System management grid.

<pre> qs grid-assoc-get|mg-aget --storage-system=value [--grid=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>grid</tt> || Name or ID of the Storage System grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===grid-assoc-list===
Returns a list of the associated Storage System nodes in the grid.

<pre> qs grid-assoc-list|mg-alist [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===grid-create===
Creates a new management grid. A given Storage System can only be a member of one grid at a time.

<pre> qs grid-create|mg-create --name=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-delete===
Deletes the management grid. After the grid is deleted each node in the grid operates independently again.

<pre> qs grid-delete|mg-delete [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-get===
Get general information about the Storage System management grid.

<pre> qs grid-get|mg-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===grid-merge===
Merges two storage grids into one.

<pre> qs grid-merge|mg-merge --node-ipaddress=value [--node-username=value ] [--node-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>node-ipaddress</tt> || IP address of a Storage System node.
|-
|   || <tt>node-username</tt> || Admin user account with permissions to add/remove nodes from the grid.
|-
|   || <tt>node-password</tt> || Admin user account password.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-modify===
Modify the management grid properties.

<pre> qs grid-modify|mg-modify --name=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-remove===
Removes the specified Storage System from the management grid.

<pre> qs grid-remove|mg-remove --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-send-supportlogs===
Collect support logs from Storage Systems specified (default, all systems in the grid) and send to OSNEXUS tech support.

<pre> qs grid-send-supportlogs|mg-send-supportlogs [--system-list=value ] [--disable-scrub=value ] [--disable-upload=value ] [--disable-trunc=value ] [--support-ticket-id=value ] [--support-reply-to-email=value ] [--support-message=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>disable-scrub</tt> || Disables scrubbing of the logs before uploading. By default logs are scrubbed before uploading for improved security and GDPR compliance.
|-
|   || <tt>disable-upload</tt> || Disables uploading of the logs for systems deployed with no internet access. In this mode the logs must be manually downloaded from the system using scp or other utility and then sent to support.
|-
|   || <tt>disable-trunc</tt> || Disables truncation of large log files greater than 100MB in size.
|-
|   || <tt>support-ticket-id</tt> || Support ticket ID to associate with the log bundle upload for OSNEXUS support.
|-
|   || <tt>support-reply-to-email</tt> || Email address to receive replies from OSNEXUS support regarding the log bundle.
|-
|   || <tt>support-message</tt> || Message to include with the log bundle upload for OSNEXUS support.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-set-master===
Sets the master node for a Storage System.

<pre> qs grid-set-master|mg-set --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===grid-split===
Splits / sub-divides a storage grid into two grids.

<pre> qs grid-split|mg-split --name=value [--system-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Storage Pool HA Failover Management [HA-FAILOVER]==
Storage Pools based on ZFS can be made Highly-Available when formed using SAS/FC/iSCSI disks connected to two or more appliances. HA storage pools can be moved dynamically between a pair of appliances and activated HA groups will do automatic failover to ensure availability to the underlying pool and it's associated volume and shares.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===ha-group-activate===
Activates/enables the specified Storage Pool High-Availability Group to failover can occur on a system outage.

<pre> qs ha-group-activate|hag-activate --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-group-create===
Creates a new Storage Pool High-Availability Group.

<pre> qs ha-group-create|hag-create --pool=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--settle-time=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--enforce-smb-allowed=value ] [--enforce-nfs-allowed=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
|-
|   || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
|-
|   || <tt>sys-tertiary</tt> || Storage system associated with the failover group tertiary node
|-
|   || <tt>settle-time</tt> || Duration, in seconds, of a cooldown period for an HA Failover Group before another failover can be triggered.
|-
|   || <tt>verify-client-ips</tt> || IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
|-
|   || <tt>client-connectivity-check-policy</tt> || Client connectivity failover policy indicates policy on when to failover if the designated IPs are not responding to ping checks. [all-nonresponsive, *disabled, majority-nonresponsive]
|-
|   || <tt>port-linkstate-policy</tt> || Failover policy for Link Down ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
|-
|   || <tt>fc-port-linkstate-policy</tt> || Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
|-
|   || <tt>export-timeout</tt> || Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively. If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
|-
|   || <tt>enforce-smb-allowed</tt> || Enforces which networks are allowed to access shares over SMB/CIFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|   || <tt>enforce-nfs-allowed</tt> || Enforces which networks are allowed to access shares over NFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-group-deactivate===
Deactivates the specified Storage Pool High-Availability Group so that failover policies are disabled.

<pre> qs ha-group-deactivate|hag-deactivate --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-group-delete===
Deletes the specified Storage Pool High-Availability Group.

<pre> qs ha-group-delete|hag-delete --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-group-failover===
Manually triggers a failover of the specified storage pool using the associated storage pool HA group policy.

<pre> qs ha-group-failover|hag-failover --ha-group=value --storage-system=value --import-health-checks=value --export-health-checks=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>import-health-checks</tt> || Review failover health status events of the target Storage System.
|-
|   || <tt>export-health-checks</tt> || Review failover health status events of the source Storage System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-group-get===
Gets information about the specified storage pool HA group

<pre> qs ha-group-get|hag-get --ha-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ha-group-list===
Returns a list of all the HA groups

<pre> qs ha-group-list|hag-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===ha-group-modify===
Modifies the settings for the specified high-availability Group.

<pre> qs ha-group-modify|hag-modify --ha-group=value [--name=value ] [--desc=value ] [--sys-primary=value ] [--sys-secondary=value ] [--sys-tertiary=value ] [--enable-tertiary-node=value ] [--settle-time=value ] [--verify-client-ips=value ] [--client-connectivity-check-policy=value ] [--port-linkstate-policy=value ] [--fc-port-linkstate-policy=value ] [--export-timeout=value ] [--enforce-smb-allowed=value ] [--enforce-nfs-allowed=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>sys-primary</tt> || Storage system associated with the failover group primary node
|-
|   || <tt>sys-secondary</tt> || Storage system associated with the failover group secondary node
|-
|   || <tt>sys-tertiary</tt> || Storage system associated with the failover group tertiary node
|-
|   || <tt>enable-tertiary-node</tt> || Enable an HA group to have a tertiary failover node.
|-
|   || <tt>settle-time</tt> || Duration, in seconds, of a cooldown period for an HA Failover Group before another failover can be triggered.
|-
|   || <tt>verify-client-ips</tt> || IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
|-
|   || <tt>client-connectivity-check-policy</tt> || Client connectivity failover policy indicates policy on when to failover if the designated IPs are not responding to ping checks. [all-nonresponsive, *disabled, majority-nonresponsive]
|-
|   || <tt>port-linkstate-policy</tt> || Failover policy for Link Down ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
|-
|   || <tt>fc-port-linkstate-policy</tt> || Failover policy for Link Down Fibre Channel ports associated with the HA pool configuration. [*all-linkdown, any-linkdown, disabled, majority-linkdown]
|-
|   || <tt>export-timeout</tt> || Maximum amount of time allowed for the pool to export on the remote system before takeover of the pool devices starts preemptively. If the pool does not export in the allocated time the exporting system will require a reboot to clear state.
|-
|   || <tt>enforce-smb-allowed</tt> || Enforces which networks are allowed to access shares over SMB/CIFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|   || <tt>enforce-nfs-allowed</tt> || Enforces which networks are allowed to access shares over NFS for a given HA storage pool by limiting access via networks the pool has VIFs associated with.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-interface-create===
Creates a new virtual network interface for the specified HA failover group.

<pre> qs ha-interface-create|hai-create --ha-group=value --parent-port=value --ip-address=value [--netmask=value ] [--interface-tag=value ] [--desc=value ] [--mac-address=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--fqdn=value ] [--convert-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-group</tt> || Name or UUID of a Storage Pool High-Availability Group
|-
|   || <tt>parent-port</tt> || Parent network port like 'eth0' with which the virtual interface should be attached to. On failover the virtual interface will attach to the port with the same name on the failover/secondary node.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
|   || <tt>interface-tag</tt> || Tags are an alpha-numeric tag which is appended onto a given HA virtual interface for easy identification.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>mac-address</tt> || MAC Address
|-
|   || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
|-
|   || <tt>nvmeof-enable</tt> || Enables or disables NVMeoF TCP access to the specified port(s).
|-
|   || <tt>fqdn</tt> || When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
|-
|   || <tt>convert-vif</tt> || Convert existing local virtual IP address into an HA site VIF.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-interface-delete===
Deletes the specified virtual network interface resource from the HA group

<pre> qs ha-interface-delete|hai-delete --ha-interface=value [--convert-to-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-interface</tt> || Name or UUID of a Storage Pool High-Availability virtual network interface
|-
|   || <tt>convert-to-vif</tt> || Convert HA site VIF resource into a local virtual IP address.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ha-interface-get===
Gets information about the specified storage pool HA virtual network interface

<pre> qs ha-interface-get|hai-get --ha-interface=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ha-interface</tt> || Name or UUID of a Storage Pool High-Availability virtual network interface
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===ha-interface-list===
Returns a list of all the HA interfaces on the specified group

<pre> qs ha-interface-list|hai-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===network-check===
Verified connectivity to all clients and Storage Systems associated with the specified system as well as any additional IP addresses specified.

<pre> qs network-check|net-check [--storage-system=value ] [--verify-client-ips=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>verify-client-ips</tt> || IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===ping-check===
Pings the specified list of IP addresses and returns the list of IPs that responded to the ping check.

<pre> qs ping-check|ping --verify-client-ips=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>verify-client-ips</tt> || IP addresses of hosts that should be pinged to verify connectivity. If there's no connectivity a preemptive failover is attempted.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Health Checks [HEALTH-CHECKER]==
Operations for various health checks.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===ha-group-check-health-status===
Runs a health check to evaluate failover ability of the given Storage Pool(s) and returns the results.

<pre> qs ha-group-check-health-status|hag-check-health-status [--pool-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===ha-group-get-health-status===
Returns the health status and failover ability of the given Storage Pool(s).

<pre> qs ha-group-get-health-status|hag-get-health-status --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Host Management [HOST]==
Storage Volumes must be assigned to Host(s) before the block storage (LUNs) can be accessed. Each Host entry is identified by one or more iSCSI IQNs and/or FibreChannel WWPNs.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===host-add===
Modifies a host entry. The username/password fields are optional and are not yet leveraged by the Storage System. Later this may be used to provide additional levels of integration such as automatic host side configuration of your iSCSI initiator.

<pre> qs host-add|h-add --hostname=value [--iqn=value ] [--ip-address=value ] [--desc=value ] [--username=value ] [--password=value ] [--host-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>hostname</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
|   || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
|   || <tt>host-type</tt> || Operating system type of the host. [aix, hpux, linux, other, solaris, vmware, *windows, xenserver]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===host-get===
Gets information about a specific host.

<pre> qs host-get|h-get --host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===host-initiator-add===
Adds an additional iSCSI host initiator IQN or FC WWPN to the specified host.

<pre> qs host-initiator-add|hi-add --host=value --iqn=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===host-initiator-get===
Gets information about a specific host identified by its initiator IQN or FC WWPN.

<pre> qs host-initiator-get|hi-get --iqn=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===host-initiator-list===
Returns a list of all the initiators iSCSI IQNs and FC WWPNs of the specified host

<pre> qs host-initiator-list|hi-list --host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===host-initiator-remove===
Removes a iSCSI IQN or FC WWPN host initiator entry from the specified Host.

<pre> qs host-initiator-remove|hi-remove --host=value --iqn=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>iqn</tt> || Initiator IQN (iSCSI Qualified Name) or FC WWPN of the host's iSCSI/FC HBA
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===host-list===
Returns a list of all the Hosts that you have added to the Storage System. Host Groups allow you to assign storage to multiple host all at once. This is especially useful when you have a VMware or Windows cluster as you can assign and unassign storage to all nodes in the cluster in one operation.

<pre> qs host-list|h-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===host-modify===
Modifies a host entry which contains a list of WWPN or IQN for a given host.

<pre> qs host-modify|h-modify --host=value [--desc=value ] [--ip-address=value ] [--username=value ] [--password=value ] [--host-type=value ] [--hostname=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
|   || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
|   || <tt>host-type</tt> || Operating system type of the host. [aix, hpux, linux, other, solaris, vmware, *windows, xenserver]
|-
|   || <tt>hostname</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===host-remove===
Removes the specified host, *WARNING* host's active iSCSI sessions will be dropped.

<pre> qs host-remove|h-remove --host=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

</div>
</div>

==Host Group Management [HOST-GROUP]==
Hosts can be grouped together into Host Group(s) to simplify assignment and management of Storage Volumes assigned to a cluster of hosts (eg. VMware).
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===host-group-create===
Creates a new host group with the specified name.

<pre> qs host-group-create|hg-create --name=value --host-list=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===host-group-delete===
Removes the specified host group.

<pre> qs host-group-delete|hg-delete --host-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===host-group-get===
Gets information about a specific host group.

<pre> qs host-group-get|hg-get --host-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===host-group-host-add===
Adds a host to the specified host group.

<pre> qs host-group-host-add|hg-host-add --host-group=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===host-group-host-remove===
Removes a host from the specified host group.

<pre> qs host-group-host-remove|hg-host-remove --host-group=value --host-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===host-group-list===
Returns a list of all the host groups.

<pre> qs host-group-list|hg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===host-group-modify===
Modifies the properties of a host group such as its name and/or description.

<pre> qs host-group-modify|hg-modify --host-group=value [--name=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>host-group</tt> || An arbitrary collection of hosts used to simplify volume ACL management for grids and other groups of hosts.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

</div>
</div>

==Hardware RAID Management [HWRAID]==
Integrated hardware management modules monitor, discover, correlate and manage all the key aspects of internal SAS HBAs and RAID Controllers.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===hw-alarm-clear-all===
Clears all the Hardware Alarms/Events that have been recorded for the specified Hardware Controller.

<pre> qs hw-alarm-clear-all|hwa-clear-all --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-alarm-get===
Returns information about a specific Hardware Alarm.

<pre> qs hw-alarm-get|hwa-get --id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>id</tt> || Unique identifier (GUID) for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===hw-alarm-list===
Returns a list of all the current Hardware Alarms/Event messages generated from Hardware Controllers.

<pre> qs hw-alarm-list|hwa-list [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===hw-controller-change-security-key===
Change the security key for encryption on SED/FDE-enabled drives on Hardware Controller.

<pre> qs hw-controller-change-security-key|hwc-change-security-key --controller=value --old-security-key=value --security-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>old-security-key</tt> || Prior security key on HW Controller card, for changing key, for encryption on FDE-enabled secure disk drives.
|-
|   || <tt>security-key</tt> || Security key on HW Controller card for encryption on FDE-enabled secure disk drives.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-controller-create-security-key===
Create the security key for encryption on SED/FDE-enabled drives on Hardware Controller.

<pre> qs hw-controller-create-security-key|hwc-create-security-key --controller=value --security-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>security-key</tt> || Security key on HW Controller card for encryption on FDE-enabled secure disk drives.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-controller-get===
Returns information about a specific Hardware Controller.

<pre> qs hw-controller-get|hwc-get --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===hw-controller-group-get===
Returns information about all the support Hardware Controller Group types.

<pre> qs hw-controller-group-get|hwcg-get --controller-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller-group</tt> || Name or ID of a hardware RAID controller group.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===hw-controller-group-list===
Returns a list of all the Hardware Controller Groups.

<pre> qs hw-controller-group-list|hwcg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===hw-controller-import-units===
Scan and import foreign disks associated with Hardware Controller Groups that were attached to another Hardware Controller or that require re-importing to the local appliance.

<pre> qs hw-controller-import-units|hwc-import-units --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-controller-list===
Returns a list of all the Hardware Controllers.

<pre> qs hw-controller-list|hwc-list [--controller-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller-group</tt> || Name or ID of a hardware RAID controller group.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===hw-controller-rescan===
Rescans the Hardware Controller to look for new disks and RAID units.

<pre> qs hw-controller-rescan|hwc-rescan --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-controller-rescan-all===
Rescans the system to rediscover all Hardware Controller and to look for new disks and RAID units on all controllers.

<pre> qs hw-controller-rescan-all|hwc-rescan-all [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-controller-search===
Returns a subset of HW Controller objects matching the given criteria.

<pre> qs hw-controller-search|hwc-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Hardware Controller List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===hw-disk-clear-missing===
Clears all the hardware disk devices which are marked as missing and are no longer present. This clears that information from the internal grid database.

<pre> qs hw-disk-clear-missing|hwd-clear-missing [--controller=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-disk-delete===
Marks the specified disk so that it can be removed from the enclosure. Disks marked as hot-spares will return to normal status after being deleted.

<pre> qs hw-disk-delete|hwd-delete --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Specifies one or more disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-disk-get===
Returns information about a specific disk managed by a Hardware Controller.

<pre> qs hw-disk-get|hwd-get --disk=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk</tt> || Specifies a physical disk connected to a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===hw-disk-identify===
Flashes the LED indicator light on the specified disk so that it can be identified in the enclosure chassis.

<pre> qs hw-disk-identify|hwd-identify [--disk-list=value ] [--controller=value ] [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Specifies one or more disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-disk-list===
Returns a list of all the disks managed by the specified Hardware Controller.

<pre> qs hw-disk-list|hwd-list [--controller=value ] [--normalize=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===hw-disk-mark-good===
Marks the specified disk as 'good' or 'ready'. You can use this to correct the disk status for good disks that the Hardware Controller has in 'bad' or 'failed' state.

<pre> qs hw-disk-mark-good|hwd-mark-good --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Specifies one or more disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-disk-mark-spare===
Marks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached.

<pre> qs hw-disk-mark-spare|hwd-mark-spare --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Specifies one or more disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-disk-search===
Returns a subset of HW Disk objects matching the given criteria.

<pre> qs hw-disk-search|hwd-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Hardware Disk List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===hw-disk-unmark-spare===
Unmarks the specified disk as a universal hot spare within the group of RAID units managed by the Hardware Controller in which the disk is attached.

<pre> qs hw-disk-unmark-spare|hwd-unmark-spare --disk-list=value --controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>disk-list</tt> || Specifies one or more disks connected to a hardware RAID controller. Use 'all' to indicate all unused disks.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-enclosure-clear-missing===
Clears all the hardware enclosures which are marked as missing and are no longer present. This clears that information from the internal grid database.

<pre> qs hw-enclosure-clear-missing|hwe-clear-missing [--controller=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-enclosure-get===
Returns information about a specific enclosure managed by the specified Hardware Controller.

<pre> qs hw-enclosure-get|hwe-get --enclosure=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>enclosure</tt> || Name of a hardware RAID enclosure or its unique ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===hw-enclosure-layout-get===
Returns information about a specific enclosure layout managed by the current system.

<pre> qs hw-enclosure-layout-get|hwe-layout-get --hw-enclosure-layout=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>hw-enclosure-layout</tt> || Name of the hardware RAID enclosure layout or its unique ID
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===hw-enclosure-layout-list===
Returns a list of all the enclosure layouts managed by the current system.

<pre> qs hw-enclosure-layout-list|hwe-layout-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===hw-enclosure-layout-vendor-group-get===
Returns information about a specific enclosure layout vendor group managed by the current system.

<pre> qs hw-enclosure-layout-vendor-group-get|hwe-layout-vg-get --hw-enclosure-layout-vendor-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>hw-enclosure-layout-vendor-group</tt> || Name of the hardware RAID enclosure layout vendor group or its unique ID
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===hw-enclosure-layout-vendor-group-list===
Returns a list of all the enclosure layout vendor groups managed by the current system.

<pre> qs hw-enclosure-layout-vendor-group-list|hwe-layout-vg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===hw-enclosure-list===
Returns a list of all the enclosures managed by the specified Hardware Controller.

<pre> qs hw-enclosure-list|hwe-list [--controller=value ] [--normalize=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>normalize</tt> || Normalizes to a set of unique instances of each object by removing duplicates (child paths, multiple system views of the same disk, enclosure, etc)
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===hw-enclosure-modify===
Modifies the properties of a specific enclosure managed by the specified Hardware Controller.

<pre> qs hw-enclosure-modify|hwe-modify --enclosure=value [--alt-name=value ] [--description=value ] [--enclosure-layout=value ] [--chassis-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>enclosure</tt> || Name of a hardware RAID enclosure or its unique ID.
|-
|   || <tt>alt-name</tt> || Alternate name for an enclosure within a hardware controller.
|-
|   || <tt>description</tt> || Description for an enclosure within a hardware controller.
|-
|   || <tt>enclosure-layout</tt> || Enclosure layout for an enclosure within a hardware controller.
|-
|   || <tt>chassis-tag</tt> || Name of a chassis tag for sorting hardware disks within hardware enclosures.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===hw-enclosure-search===
Returns a subset of HW Enclosure objects matching the given criteria.

<pre> qs hw-enclosure-search|hwe-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Hardware Enclosure List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===hw-enclosure-slot-identify===
Flashes the LED indicator light on the specified slots in the RAID enclosure so that they can be identified in the enclosure.

<pre> qs hw-enclosure-slot-identify|hwe-slot-identify --enclosure=value [--slot-list=value ] [--blink-type=value ] [--duration=value ] [--all-slots=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>enclosure</tt> || Name of a hardware RAID enclosure or its unique ID.
|-
|   || <tt>slot-list</tt> || List of the enclosure's slots to be identified/blinked.
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>all-slots</tt> || Perform action on all slots in the enclosure.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===hw-unit-auto-create===
Creates new hardware RAID units automatically using available disk resources according to the selection criteria.

<pre> qs hw-unit-auto-create|hwu-auto-create --raid-level=value [--disks-per-unit=value ] [--disk-category=value ] [--min-size=value ] [--max-size=value ] [--unit-count=value ] [--options=value ] [--storage-system=value ] [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>raid-level</tt> || Hardware RAID type for a hardware RAID unit. [*RAID0, RAID1, RAID5, RAID6]
|-
|   || <tt>disks-per-unit</tt> || Number of disks to select for each new hardware RAID unit to be created. Example, 5 disks indicates 4d+1p when selected with RAID5 layout type, RAID0 default = 1.
|-
|   || <tt>disk-category</tt> || Any, SSD, or HDD, this allows filtering by disk type so that new hardware RAID units are created using the correct category of disks. [*ANY, HDD, SSD]
|-
|   || <tt>min-size</tt> || Minimum size of the disks to be selected for creation of new hardware RAID units
|-
|   || <tt>max-size</tt> || Maximum size of the disks to be selected for creation of new hardware RAID units, useful for limiting the selection to a specific group of drives.
|-
|   || <tt>unit-count</tt> || Maximum number of units to create, if 0 then all available disks will be used after filtering.
|-
|   || <tt>options</tt> || Special options to hardware encryption policy.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-unit-create===
Creates a new hardware RAID unit using the specified controller.

<pre> qs hw-unit-create|hwu-create --raid=value --disk-list=value [--logical-volume-count=value ] [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>raid</tt> || Hardware RAID type for a hardware RAID unit. [*AUTO, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60]
|-
|   || <tt>logical-volume-count</tt> || The number of logical volumes to be created and/or managed.
|-
|   || <tt>disk-list</tt> || Specifies one or more disk, either physical disks or disks connected to a HBA/RAID card, to be used to create the HW Unit.
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-unit-delete===
Deletes the specified RAID unit. Note that you must first delete the Storage Pool before you delete the RAID unit.

<pre> qs hw-unit-delete|hwu-delete --unit=value [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>unit</tt> || Name of a hardware RAID unit or its unique ID.
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-unit-encrypt===
Enable hardware SED/FDE encryption for the specified hardware RAID unit.

<pre> qs hw-unit-encrypt|hwu-encrypt --unit=value [--options=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>unit</tt> || Name of a hardware RAID unit or its unique ID.
|-
|   || <tt>options</tt> || Special options to hardware encryption policy.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-unit-get===
Returns information about a specific RAID unit managed by the specified Hardware Controller.

<pre> qs hw-unit-get|hwu-get --unit=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>unit</tt> || Name of a hardware RAID unit or its unique ID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===hw-unit-identify===
Flashes the LED indicator light on all the disks in the RAID unit so that it can be identified in the enclosure.

<pre> qs hw-unit-identify|hwu-identify --unit=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>unit</tt> || Name of a hardware RAID unit or its unique ID.
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===hw-unit-list===
Returns a list of all the RAID units managed by the specified Hardware Controller.

<pre> qs hw-unit-list|hwu-list [--controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>controller</tt> || Name or ID of a hardware RAID controller.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===hw-unit-search===
Returns a subset of HW Unit objects matching the given criteria.

<pre> qs hw-unit-search|hwu-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Hardware Unit List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

</div>
</div>

==Key Server Profile Management [KEY-SERVER-PROFILE]==
Key Server Profiles contain all of the neccessary certificate and connection information needed for KMIP operations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===key-server-profile-create===
Creates a key server profile.

<pre> qs key-server-profile-create|ksp-create --name=value --server-type=value --username=value --password=value --ca-cert=value --client-cert=value --client-key=value --host=value --kmip-connection-port=value --protocol=value --connection-mode=value --timeout=value [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>server-type</tt> || Specifies the type of KMIP compatible server is being used. [*default, ibm, kmip]
|-
|   || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
|   || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
|   || <tt>ca-cert</tt> || The file location of the Certification Authority Certificate in x509 certificate format.
|-
|   || <tt>client-cert</tt> || The file location of the Client Certificate in x509 certificate format.
|-
|   || <tt>client-key</tt> || The file location of the Client Private Key in RSA private key format.
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>kmip-connection-port</tt> || The port number for which to establish a connection with the KIMP server host.
|-
|   || <tt>protocol</tt> || Protocol and version for key server communication. [kmip1, kmip1-1, *kmip1-2, kmip1-3, kmip1-4, kmip2, kmip2-1, kmip3, raw, unknown]
|-
|   || <tt>connection-mode</tt> || Connection mode for the server. [reconnect, *reset]
|-
|   || <tt>timeout</tt> || Timeout value for client-server KMIP operations (default: 10 sec).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-delete===
Deletes the specified key server profile.

<pre> qs key-server-profile-delete|ksp-delete --key-server-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-get===
Returns the key information for the specified key.

<pre> qs key-server-profile-get|ksp-get --key-server-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-key-add===
Registers a key to the integrated key server.

<pre> qs key-server-profile-key-add|ksp-key-add --key-server-profile=value --key-data=value --encoding=value --key-type=value --resource-type=value [--name=value ] [--description=value ] [--resource-id=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>key-data</tt> || Data payload for the key object being stored on the key server.
|-
|   || <tt>encoding</tt> || Data encoding for object stored on the key server. [*none]
|-
|   || <tt>key-type</tt> || Key type sent in KMIP payload. [*all-key, data-encryption-key, root-key]
|-
|   || <tt>resource-id</tt> || GUID for the resource the key is associated with. Required if '--resource-type' is 'storage-pool' or 'ceph-cluster'.
|-
|   || <tt>resource-type</tt> || An enum to identify the type of resource the key is associated with. [none*,storage-pool,ceph-cluster] [ceph-cluster, *none, storage-pool]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-key-modify===
Modifies the name and description for a KMIP key.

<pre> qs key-server-profile-key-modify|ksp-key-modify [--key-server-profile=value ] [--name=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-key-remove===
Deletes the specified key from the key server.

<pre> qs key-server-profile-key-remove|ksp-key-remove --key-server-profile=value --name=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-list===
Returns a list of all server profiles.

<pre> qs key-server-profile-list|ksp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-modify===
Modifies the properties of a key server profile object.

<pre> qs key-server-profile-modify|ksp-modify --key-server-profile=value [--name=value ] [--description=value ] [--server-type=value ] [--username=value ] [--password=value ] [--ca-cert=value ] [--client-cert=value ] [--client-key=value ] [--host=value ] [--kmip-connection-port=value ] [--protocol=value ] [--connection-mode=value ] [--timeout=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Unique identifier (GUID) for the object.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>server-type</tt> || Specifies the type of KMIP compatible server is being used. [*default, ibm, kmip]
|-
|   || <tt>username</tt> || Administrator user name for the host, typically 'Administrator' for Windows hosts.
|-
|   || <tt>password</tt> || Administrator password for the host; enables auto-configuration of host's iSCSI initiator.
|-
|   || <tt>ca-cert</tt> || The file location of the Certification Authority Certificate in x509 certificate format.
|-
|   || <tt>client-cert</tt> || The file location of the Client Certificate in x509 certificate format.
|-
|   || <tt>client-key</tt> || The file location of the Client Private Key in RSA private key format.
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>kmip-connection-port</tt> || The port number for which to establish a connection with the KIMP server host.
|-
|   || <tt>protocol</tt> || Protocol and version for key server communication. [kmip1, kmip1-1, *kmip1-2, kmip1-3, kmip1-4, kmip2, kmip2-1, kmip3, raw, unknown]
|-
|   || <tt>connection-mode</tt> || Connection mode for the server. [reconnect, *reset]
|-
|   || <tt>timeout</tt> || Timeout value for client-server KMIP operations (default: 10 sec).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Key Server Profile Key Management [KEY-SERVER-PROFILE-KEY]==
Key object to key server profiles.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===key-server-profile-key-get===
Gets the info of specified key that is on the given key server profile.

<pre> qs key-server-profile-key-get|ksp-key-get --key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key</tt> || Identifier for KMIP key.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===key-server-profile-key-list===
Lists the key associations from the specified key server profile.

<pre> qs key-server-profile-key-list|ksp-key-list [--key-server-profile=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==License Management [LICENSE]==
Commands for management of Storage System license keys including adding, removing and listing License Keys.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===license-activate===
Activates the system using an activation key received from customer support.

<pre> qs license-activate|lic-act --activation-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>activation-key</tt> || Activation key you'll receive from customer support after you send the activation request code.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===license-activate-online===
Requests automatic activation via the online activation service.

<pre> qs license-activate-online|lic-aon [--key=value ] [--renew-lease=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|   || <tt>renew-lease</tt> || Does a lease renewal of the license, only applies to Cloud Edition keys which require lease renewal.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===license-add===
Adds a license key using a license key block specified in a key file. In general, you have 7 days to activate your license using online activation of activation via email. If you do not activate after the 7 days the system will continue to run but you will not be able to make configuration changes.

<pre> qs license-add|lic-add --key-file=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>key-file</tt> || Key file you received which contains a key block section.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===license-get===
Shows the current license key info, and any activation request code.

<pre> qs license-get|lic-get --key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===license-list===
Returns a list of all the registered license keys.

<pre> qs license-list|lic-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===license-modify-support===
Applies reseller and support contract information to the license key. This information is also written to /var/opt/osnexus/quantastor/support.info for support log collection.

<pre> qs license-modify-support|lic-modify-support --key=value [--reseller-name=value ] [--reseller-contact-number=value ] [--reseller-email=value ] [--support-contract-number=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|   || <tt>reseller-name</tt> || Full name of the reseller technical support contact.
|-
|   || <tt>reseller-contact-number</tt> || Phone number of the reseller technical support contact.
|-
|   || <tt>reseller-email</tt> || Email address of the reseller technical support contact.
|-
|   || <tt>support-contract-number</tt> || Reseller support contract reference number.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===license-remove===
Removes the specified license key.

<pre> qs license-remove|lic-remove --key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key</tt> || Unique license key identifier, use license-list to get a list of these.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Maintenance Schedule Management [MAINTENANCE-SCHEDULE]==
Operations for scheduling of Storage Pool maintenance such as scrub and SSD TRIM operations.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===maintenance-schedule-add===
Adds Storage Pools to the specified Maintenance Schedule.

<pre> qs maintenance-schedule-add|maintenance-sch-add --maintenance-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-assoc-get===
Returns details of a specific Maintenance Schedule association to a Storage Pool.

<pre> qs maintenance-schedule-assoc-get|maintenance-sch-assoc-get --maintenance-schedule=value --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===maintenance-schedule-assoc-list===
Returns a list of all the Maintenance Schedule associations to Storage Pools

<pre> qs maintenance-schedule-assoc-list|maintenance-sch-assoc-list --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-create===
Creates a new Maintenance Schedule to periodically run bit-rot scrubs on Storage Pools to ensure data integrity.

<pre> qs maintenance-schedule-create|maintenance-sch-create --name=value [--maintenance-type=value ] [--description=value ] [--pool-list=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-maint=value ] [--days=value ] [--hours=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>maintenance-type</tt> || Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and orphan-cleanup to search for and remove orphaned objects no longer associated with a bucket. [*pool-scrub, pool-trim]
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>min-days-between-maint</tt> || Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
|-
|   || <tt>days</tt> || The specified day of the week on which this schedule can run the maintenance tasks assuming the minimum time span between maintenance has expired. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || Maintenance schedule must start on the specified hour. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-delete===
Deletes the specified Maintenance Schedule.

<pre> qs maintenance-schedule-delete|maintenance-sch-delete --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-disable===
Disables the specified Maintenance Schedule.

<pre> qs maintenance-schedule-disable|maintenance-sch-disable --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-enable===
Enables the specified Maintenance Schedule.

<pre> qs maintenance-schedule-enable|maintenance-sch-enable --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-get===
Gets detailed properties of a specific Maintenance Schedule.

<pre> qs maintenance-schedule-get|maintenance-sch-get --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===maintenance-schedule-list===
Returns a list of all the Maintenance Schedules.

<pre> qs maintenance-schedule-list|maintenance-sch-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-modify===
Used to modify the properties of a Maintenance Schedule including name and description.

<pre> qs maintenance-schedule-modify|maintenance-sch-modify --maintenance-schedule=value [--name=value ] [--description=value ] [--enabled=value ] [--start-date=value ] [--min-days-between-maint=value ] [--days=value ] [--hours=value ] [--maintenance-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>min-days-between-maint</tt> || Minimum days of delay between scrubs since the last run of the schedule. [Value should be between 2-365 days]
|-
|   || <tt>days</tt> || The specified day of the week on which this schedule can run the maintenance tasks assuming the minimum time span between maintenance has expired. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || Maintenance schedule must start on the specified hour. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>maintenance-type</tt> || Type of maintenance to be done such as pool-scrub to correct bit-rot, pool-trim to free deleted blocks in SSD media, and orphan-cleanup to search for and remove orphaned objects no longer associated with a bucket. [*pool-scrub, pool-trim]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-remove===
Removes Storage Pools from the specified Maintenance Schedule.

<pre> qs maintenance-schedule-remove|maintenance-sch-remove --maintenance-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===maintenance-schedule-trigger===
Starts the specified Maintenance Schedule immediately.

<pre> qs maintenance-schedule-trigger|maintenance-sch-trigger --maintenance-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>maintenance-schedule</tt> || A schedule that runs a scrub to repair any bit-rot in the specified list of Storage Pools associated with the schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Multi-Factor Authentication Configuration Management [MULTIFACTORAUTHCONFIG]==
Multi-factor authentication configurations are required for enabling multi-factor authentication at login time for users.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===multi-factor-auth-config-create===
Creates a multi-factor authentication configuration including API host, integration key, and secret key to enable multi-factor authentication.

<pre> qs multi-factor-auth-config-create|mfa-config-create --api-host=value --integration-key=value --name=value [--secret-key=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>api-host</tt> || API host for DUO multi-factor authentication
|-
|   || <tt>integration-key</tt> || Integration key for DUO multi-factor authentication
|-
|   || <tt>secret-key</tt> || secret-key
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || Description for the multi-factor authentication configuration.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===multi-factor-auth-config-delete===
Deletes the multi-factor authentication configuration and removes it from all users which are currently using the specified configuration.

<pre> qs multi-factor-auth-config-delete|mfa-config-delete --mfa-config-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>mfa-config-list</tt> || mfa-config-list
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===multi-factor-auth-config-get===
Gets information about the specified multi-factor authentication configuration.

<pre> qs multi-factor-auth-config-get|mfa-config-get --mfa-config=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===multi-factor-auth-config-list===
Lists all multi-factor authentication configurations.

<pre> qs multi-factor-auth-config-list|mfa-config-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===multi-factor-auth-config-modify===
Modifies the properties of the multi-factor authentication configuration such as its name and description.

<pre> qs multi-factor-auth-config-modify|mfa-config-modify --mfa-config=value [--integration-key=value ] [--secret-key=value ] [--name=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
|   || <tt>integration-key</tt> || Integration key for DUO multi-factor authentication
|-
|   || <tt>secret-key</tt> || Secret key for DUO multi-factor authentication
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===multi-factor-auth-config-set-user===
Adds or removes multi-factor authentication configurations specified as 'user1=config1,user2=config2,~user3,...', prepend with tilde (~) to remove multi-factor authentication configurations from specified users.

<pre> qs multi-factor-auth-config-set-user|mfa-config-set-user --user-config-assignments=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-config-assignments</tt> || User to multi-factor authentication configuration assignments specified as 'user1:config1,user2:config2,~user3,...' prepend with tilde (~) to remove configurations.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Network Share Namespace Management [NAMESPACE]==
Commands for managing Network Shares Namespaces which controls NFS redirects and Microsoft DFS for the SMB protocol.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===share-namespace-add-shares===
Adds one or more shares to the specified Network Share Namespace.

<pre> qs share-namespace-add-shares|nspc-add-shares --namespace=value --share-list=value --preferred-ports=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>preferred-ports</tt> || List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===share-namespace-create===
Creates a new Network Share Namespace which provides the ability to combine shares across appliances into a single namespace which integrates with Microsoft DFS.

<pre> qs share-namespace-create|nspc-create --name=value --preferred-ports=value --share-list=value [--desc=value ] [--dfs-mode=value ] [--nfs-namespace-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>preferred-ports</tt> || List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>dfs-mode</tt> || dfs-mode [disabled, *flat, grouped]
|-
|   || <tt>nfs-namespace-mode</tt> || nfs-namespace-mode [disabled, *flat]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-namespace-delete===
Deletes the specified Network Share Namespace, associated Network Shares are not deleted.

<pre> qs share-namespace-delete|nspc-delete --namespace=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-namespace-get===
Returns detailed information about the specified Network Share Namespace.

<pre> qs share-namespace-get|nspc-get --namespace=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===share-namespace-list===
Returns a list of all the Network Share Namespaces in the grid.

<pre> qs share-namespace-list|nspc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===share-namespace-modify===
Modifies the selected Network Share Namespace properties including name, description, and features.

<pre> qs share-namespace-modify|nspc-modify --namespace=value [--name=value ] [--desc=value ] [--dfs-mode=value ] [--nfs-namespace-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>dfs-mode</tt> || dfs-mode [disabled, *flat, grouped]
|-
|   || <tt>nfs-namespace-mode</tt> || nfs-namespace-mode [disabled, *flat]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===share-namespace-remove-shares===
Removes one or more shares from the specified Network Share Namespace.

<pre> qs share-namespace-remove-shares|nspc-remove-shares --namespace=value [--share-list=value ] [--preferred-ports=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>namespace</tt> || Network Share Namespaces group together one or more shares from one or more systems into a distributed single namespace using Microsoft DFS and NFSv4 redirection technology.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>preferred-ports</tt> || List of the preferred IP addresses for each system to use for Network Share access redirection within the namespace.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Commands for Object Pool Group setup, Storage-Class management, Object Tenant, Object User, and Object User Access Key management. [OSM]==
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===object-pool-group-create===
Creates a new Object Storage Pool Group/Zone within the specified Ceph Cluster to enable S3-compatible Object Storage capabilities.

<pre> qs object-pool-group-create|zone-create [--ceph-cluster=value ] [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--pool-type=value ] [--min-replicas=value ] [--max-replicas=value ] [--k=value ] [--m=value ] [--ec-pool-profile=value ] [--scaling-factor=value ] [--auto-config-nfs=value ] [--compression-algo=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>object-store-zone</tt> || Ceph object storage zone. (Default: 'default')
|-
|   || <tt>object-store-zone-group</tt> || Ceph object storage zone group. (Default: 'default')
|-
|   || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficient and is recommended for both scale-out file and object storage pools.
|-
|   || <tt>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
|-
|   || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|   || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|   || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|   || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
|   || <tt>auto-config-nfs</tt> || Auto configure NFS services for scale-out storage.
|-
|   || <tt>compression-algo</tt> || Compression algorithm to use for the storage pool. Supported algorithms are 'lz4', 'snappy', and 'none'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-pool-group-delete===
Deletes the specified object pool group, WARNING all associated objects in the pool group will be destroyed.

<pre> qs object-pool-group-delete|zone-delete --ceph-object-pool-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-pool-group-get===
Returns information about a specific Object Pool Group used to store S3-compatible object data within buckets.

<pre> qs object-pool-group-get|zone-get --ceph-object-pool-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-pool-group-list===
Returns a list of all the object storage pool groups.

<pre> qs object-pool-group-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-pool-group-modify===
Modifies the settings for the object pool group.

<pre> qs object-pool-group-modify|zone-modify --ceph-object-pool-group=value [--desc=value ] [--object-store-zone=value ] [--object-store-zone-group=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>object-store-zone</tt> || Ceph object storage zone. (Default: 'default')
|-
|   || <tt>object-store-zone-group</tt> || Ceph object storage zone group. (Default: 'default')
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-pool-group-multi-site-setup===
Setup multi site S3-compatible Object Zone

<pre> qs object-pool-group-multi-site-setup|zone-multi-site-setup --primary-object-pool-group=value --secondary-object-pool-group=value --primary-rados-gateway=value --secondary-rados-gateway=value [--symmetrical=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>primary-object-pool-group</tt> || Primary Object Storage Pool for Multi Site Setup
|-
|   || <tt>secondary-object-pool-group</tt> || Secondary Object Storage Pool Group for Multi Site Setup
|-
|   || <tt>primary-rados-gateway</tt> || Primary Rados Gateway for Multi Site Setup
|-
|   || <tt>secondary-rados-gateway</tt> || Secondary Rados Gateway for Multi Site Setup
|-
|   || <tt>symmetrical</tt> || Replicate entire zone group to a secondary zone group. This is used to create a full copy of the zone group in a secondary site for disaster recovery purposes.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-pool-group-multi-site-unconfigure===
Remove pool group from a multi site setup.

<pre> qs object-pool-group-multi-site-unconfigure|zone-multi-site-unconfigure --ceph-object-pool-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-storage-class-create===
Creates a data pool for a Storage-Class in the given Object Pool Group.

<pre> qs object-storage-class-create|osc-create --ceph-object-pool-group=value --storage-class-name=value [--scaling-factor=value ] [--max-replicas=value ] [--min-replicas=value ] [--pool-type=value ] [--k=value ] [--m=value ] [--ec-pool-profile=value ] [--ceph-cluster=value ] [--custom-storage-class-name=value ] [--compression-algo=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-pool-group</tt> || Ceph object storage pool group.
|-
|   || <tt>storage-class-name</tt> || storage-class-name
|-
|   || <tt>scaling-factor</tt> || Scaling factor to adjust the number of placement groups (PGs) for the underlying pool(s). For Ceph Clusters with a single use case (eg RGW or SAN/RBD or NAS/CephFS) use 100, but for multiple use cases set this to the percentage proportion of the cluster's capacity that will be used by the pool being created.
|-
|   || <tt>max-replicas</tt> || Maximum number of replicas (redundancy level) to be created of each block in the Ceph pool.
|-
|   || <tt>min-replicas</tt> || Minimum number of replicas to have of each block while still allowing write access to the Ceph pool.
|-
|   || <tt>pool-type</tt> || Type of storage layout for the data pool which can be 'replicated' or 'erasure'. Erasure coding is more space efficient and is recommended for both scale-out file and object storage pools.
|-
|   || <tt>k</tt> || Data chunk (k) count for erasure coded Ceph Pool.
|-
|   || <tt>m</tt> || Check-sum (m) chunk count for erasure coded Ceph Pool.
|-
|   || <tt>ec-pool-profile</tt> || Custom Ceph Pool profile name (unique within a Ceph Cluster) for block or object store.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>custom-storage-class-name</tt> || Providing this argument will skip the checks for officially supported object storage class names. [ STANDARD | INTELLIGENT_TIERING | STANDARD_IA | ONEZONE_IA | GLACIER_IR | EXPRESS_ONEZONE | OUTPOSTS | REDUCED_REDUNDANCY ]
|-
|   || <tt>compression-algo</tt> || Compression algorithm to use for the storage pool. Supported algorithms are 'lz4', 'snappy', and 'none'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-storage-class-get===
Returns information about a specific object storage class used to store S3-compatible object data.

<pre> qs object-storage-class-get|osc-get --storage-class=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-class</tt> || Object Storage-Classes map to specific data pools and enable tagging of objects be efficiently stored into optimal tiers with different characteristics (nvme, ssd) and layouts (EC, replica).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-storage-class-list===
Returns a list of all the object storage class.

<pre> qs object-storage-class-list|osc-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-storage-class-rule-add===
Adds Storage-Class rules for dynamically auto-tiering S3-compatible objects.

<pre> qs object-storage-class-rule-add|oscr-add --rule-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>rule-list</tt> || List of Storage-Class auto-tiering rules "STORAGECLASS;PATTERN;OPERATOR;CAPACITY" using comma ',' delimiter between rules.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-storage-class-rule-get===
Returns information about a specific object storage class rules used to store S3-compatible object data in a specific Ceph Pool.

<pre> qs object-storage-class-rule-get|oscr-get --storage-class-rule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-class-rule</tt> || Object Storage-Class rules enables automatic tagging of objects to be stored into specific Storage Classes based on criteria including object size and object name pattern-matches.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-storage-class-rule-list===
Returns a list of all the object storage class rules.

<pre> qs object-storage-class-rule-list|oscr-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-storage-class-rule-remove===
Removes specified Storage Class rules for dynamically auto-tiering S3-compatible objects.

<pre> qs object-storage-class-rule-remove|oscr-remove --rule-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>rule-list</tt> || List of Storage-Class auto-tiering rules "STORAGECLASS;PATTERN;OPERATOR;CAPACITY" using comma ',' delimiter between rules.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-tenant-create===
Creates a new tenant entry that can then be used to create Object users under this tenant namespace.

<pre> qs object-tenant-create|object-t-create --name=value [--display-name=value ] [--ceph-cluster=value ] [--description=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>display-name</tt> || Display name for the user.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-tenant-delete===
Deletes the specified Object tenant.

<pre> qs object-tenant-delete|object-t-delete --tenant=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-tenant-get===
Gets information about the specified tenant.

<pre> qs object-tenant-get|object-t-get --tenant=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-tenant-list===
Lists all the Object tenants in the grid.

<pre> qs object-tenant-list|object-t-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-user-accesskey-add===
Adds a new Object User Access Key to an existing Object User in a Ceph Cluster.

<pre> qs object-user-accesskey-add|object-k-add --object-user=value [--object-access-key=value ] [--object-secret-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>object-access-key</tt> || The access key value of an Object User Access Key.
|-
|   || <tt>object-secret-key</tt> || The secret key value of an Object User Access Key.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-accesskey-get===
Returns information about the specified Object User Access Key.

<pre> qs object-user-accesskey-get|object-k-get --object-user-access-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user-access-key</tt> || The name, UUID or access-key value used to identify an User Access Key object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-user-accesskey-list===
Returns a list of all the Object User Access Keys.

<pre> qs object-user-accesskey-list|object-k-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-user-accesskey-modify===
Modifies the secret key of an existing Object User Access Key.

<pre> qs object-user-accesskey-modify|object-k-modify --object-user=value --object-user-access-key=value [--object-secret-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>object-user-access-key</tt> || The name, UUID or access-key value used to identify an User Access Key object.
|-
|   || <tt>object-secret-key</tt> || The new secret key for the existing Object User Access Key.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-accesskey-remove===
Removes the Object User Access Key from the existing Object User in a Ceph Cluster.

<pre> qs object-user-accesskey-remove|object-k-remove --object-user=value --object-user-access-key=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>object-user-access-key</tt> || The name, UUID or access-key value used to identify an User Access Key object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-create===
Creates a new Object User to allow Object protocol access to the Object Object Storage Group/Zone.

<pre> qs object-user-create|object-u-create --name=value [--display-name=value ] [--ceph-cluster=value ] [--tenant=value ] [--email=value ] [--object-access-key=value ] [--object-secret-key=value ] [--access-permission=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--count=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>display-name</tt> || Display name for the user.
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>tenant</tt> || Object Storage (Ceph RGW based) users can be grouped into tenant accounts to securely separate object storage bucket visibility and to facilitate charge-back accounting.
|-
|   || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
|-
|   || <tt>object-access-key</tt> || The access key value of an Object User Access Key.
|-
|   || <tt>object-secret-key</tt> || The secret key value of an Object User Access Key.
|-
|   || <tt>access-permission</tt> || Ceph object storage permission (rwx, rw-, ---) [*all, delete, read, write]
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>max-objects-enable</tt> || Enable maximum object limits per bucket.
|-
|   || <tt>max-objects</tt> || Maximum object count per bucket.
|-
|   || <tt>max-size-enable</tt> || Enable maximum bucket size limits.
|-
|   || <tt>bucket-quota-max-size</tt> || Maximum amount of data for a given bucket.
|-
|   || <tt>max-user-objects-enable</tt> || Enable maximum object count limits per user.
|-
|   || <tt>max-user-objects</tt> || Maximum aggregate number objects that a given user can create.
|-
|   || <tt>max-user-size-enable</tt> || Enable maximum aggregate capacity/size limits for a given user.
|-
|   || <tt>max-user-size</tt> || Maximum aggregate capacity limit for a given user or user(s).
|-
|   || <tt>max-buckets</tt> || Maximum buckets a user can have / create.
|-
|   || <tt>count</tt> || The number of volumes to create, default is 1.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-delete===
Deletes the specified Object User.

<pre> qs object-user-delete|object-u-delete --ceph-cluster=value --object-user-list=value [--delete-data=value ] [--key-delete=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>object-user-list</tt> || Comma delimited list of the Names or IDs of Object Users.
|-
|   || <tt>delete-data</tt> || Flag to specify deletion of user data along with this operation. (Default : false)
|-
|   || <tt>key-delete</tt> || Flag to specify deletion of user security keys along with this operation. (Default : false)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-disable===
Disable a previously active/enabled Object User.

<pre> qs object-user-disable|object-u-disable --object-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-enable===
Enable a previously suspended Object User.

<pre> qs object-user-enable|object-u-enable --object-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-user-get===
Returns information about a specific object storage Object User.

<pre> qs object-user-get|object-u-get --object-user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-user-list===
Returns a list of all the Ceph Object storage Object Users and their associated Object User Access Keys

<pre> qs object-user-list|object-u-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-user-modify===
Modifies the name and permissions for a specified Object User object.

<pre> qs object-user-modify|object-u-modify --ceph-cluster=value --object-user=value [--display-name=value ] [--email=value ] [--user=value ] [--max-objects-enable=value ] [--max-objects=value ] [--max-size-enable=value ] [--bucket-quota-max-size=value ] [--max-user-objects-enable=value ] [--max-user-objects=value ] [--max-user-size-enable=value ] [--max-user-size=value ] [--max-buckets=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>object-user</tt> || Ceph object storage User.
|-
|   || <tt>display-name</tt> || Display name for the user.
|-
|   || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>max-objects-enable</tt> || Enable maximum object limits per bucket.
|-
|   || <tt>max-objects</tt> || Maximum object count per bucket.
|-
|   || <tt>max-size-enable</tt> || Enable maximum bucket size limits.
|-
|   || <tt>bucket-quota-max-size</tt> || Maximum amount of data for a given bucket.
|-
|   || <tt>max-user-objects-enable</tt> || Enable maximum object count limits per user.
|-
|   || <tt>max-user-objects</tt> || Maximum aggregate number objects that a given user can create.
|-
|   || <tt>max-user-size-enable</tt> || Enable maximum aggregate capacity/size limits for a given user.
|-
|   || <tt>max-user-size</tt> || Maximum aggregate capacity limit for a given user or user(s).
|-
|   || <tt>max-buckets</tt> || Maximum buckets a user can have / create.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-zone-get===
Returns information about a specific object zone used to store S3-compatible object data.

<pre> qs object-zone-get|obj-zone-get --ceph-object-zone=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-zone</tt> || Ceph object zone.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-zone-group-get===
Returns information about a specific object zone group used to store S3-compatible object data.

<pre> qs object-zone-group-get|obj-zone-group-get --ceph-object-zone-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-object-zone-group</tt> || Ceph object zone group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-zone-group-list===
Returns a list of all the object zone groups.

<pre> qs object-zone-group-list|obj-zone-group-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-zone-group-modify===
Set configuration values for a specific object zone group used to store S3-compatible object data.

<pre> qs object-zone-group-modify|obj-zone-group-modify --ceph-object-zone-group=value --hostname-list=value [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>ceph-object-zone-group</tt> || Ceph object zone group.
|-
|   || <tt>hostname-list</tt> || A comma delimited list of hostnames, may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-zone-list===
Returns a list of all the object zones.

<pre> qs object-zone-list|obj-zone-list [--ceph-cluster=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ceph-cluster</tt> || Ceph Cluster name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Multi-Admin Approval Request Management [PENDING-OPERATION-REQUEST]==
Commands for managing multi-admin approval requests. The Multi-Admin Approvals feature requires that data-destructive operations (such as storage volume delete) receive approval from a configurable number of administrators before they can proceed.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===pending-operation-request-approve===
Approves a pending multi-admin approval request, casting an approval vote for the associated data-destructive operation.

<pre> qs pending-operation-request-approve|por-approve --request-ids=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>request-ids</tt> || UUID list (comma delimited) of the pending multi-admin approval requests.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pending-operation-request-clear-all===
Clears all completed/failed/cancelled pending multi-admin approval requests, allowing for manual cleanup before the automatic 48-hour removal period.

<pre> qs pending-operation-request-clear-all|por-clear-all [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pending-operation-request-get===
Gets the details of a specific pending multi-admin approval request, including its current approval status and expiry time.

<pre> qs pending-operation-request-get|por-get --request-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>request-id</tt> || UUID of the pending multi-admin approval request.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pending-operation-request-list===
Lists all pending multi-admin approval requests currently awaiting the required number of administrator approvals.

<pre> qs pending-operation-request-list|por-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pending-operation-request-reject===
Rejects a pending multi-admin approval request, preventing the associated data-destructive operation from proceeding.

<pre> qs pending-operation-request-reject|por-reject --request-ids=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>request-ids</tt> || UUID list (comma delimited) of the pending multi-admin approval requests.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Storage Pool Management [POOL]==
Storage Pools combined Physical Disks together to form fault-tolerant pools of storage that can be provisioned from. Both Storage Volumes and Network Shares are provisioned from Storage Pools where ZFS based pools are the default ans XFS based pools are used for scale-out configurations using Ceph technology.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===pool-add-dedup-offload===
Adds a pair of mirrored dedicated deduplication metadata offload devices to the specified storage pool.

<pre> qs pool-add-dedup-offload|p-add-dedup-offload --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-add-metadata-offload===
Adds a pair of mirrored dedicated metadata offload devices to the specified storage pool.

<pre> qs pool-add-metadata-offload|p-add-metadata-offload --pool=value --disk-list=value [--small-block-threshold=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-add-read-cache===
Adds a dedicated read cache to the specified storage pool.

<pre> qs pool-add-read-cache|p-add-read-cache --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-add-spare===
Adds a dedicated hot-spare to the specified storage pool.

<pre> qs pool-add-spare|p-add --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-add-write-log===
Adds a dedicated write log to the specified storage pool.

<pre> qs pool-add-write-log|p-add-write-log --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-checkpoint-create===
Creates a whole-pool ZFS checkpoint for the specified scale-up (OpenZFS) Storage Pool. Only one checkpoint may exist per pool at a time. Intended for upgrade safety: take the checkpoint immediately before a pool upgrade, then discard it once the upgrade is confirmed good. While a checkpoint exists, vdev layout changes (remove/split/reguid) are blocked.

<pre> qs pool-checkpoint-create|p-ckpt-create --pool=value [--expiration-days=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>expiration-days</tt> || Number of days after which the checkpoint will be automatically deleted. Use 0 (default) for no automatic expiration.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-checkpoint-delete===
Discards (deletes) the active ZFS checkpoint on the specified scale-up (OpenZFS) Storage Pool, freeing the space it holds. Use this after confirming a pool upgrade was successful, or to unblock vdev layout operations.

<pre> qs pool-checkpoint-delete|p-ckpt-delete --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-checkpoint-modify===
Modifies the active ZFS checkpoint on the specified scale-up (OpenZFS) Storage Pool, for example to change the number of days after which the checkpoint is automatically deleted.

<pre> qs pool-checkpoint-modify|p-ckpt-modify --pool=value [--expiration-days=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>expiration-days</tt> || Number of days after which the checkpoint will be automatically deleted. Use 0 (default) for no automatic expiration.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-clear-missing===
Clears all missing Network shares and Storage Volumes from the specified Storage Pool.

<pre> qs pool-clear-missing|p-clear-missing --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pool-create===
Creates a new storage pool from which Storage Volumes can be created.

<pre> qs pool-create|p-create --name=value --disk-list=value [--raid-type=value ] [--pool-type=value ] [--desc=value ] [--is-default=value ] [--compress=value ] [--auto-trim=value ] [--profile=value ] [--raid-set-size=value ] [--encrypt=value ] [--encryption-type=value ] [--passphrase=value ] [--key-server-type=value ] [--key-server-profile=value ] [--ashift=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters, special characters (-_.) excluding the parentheses. Size ranging from 2 to 40 characters.
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>raid-type</tt> || RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, RAID5/50/6/60/7/70 are parity based fault-tolerant layouts, and DRAID/1_1S/1_2S/1_3S/2_1S/2_2S/2_3S/3_1S/3_2S/3_3S are distributed RAID layouts. [*AUTO, DRAID1_1S, DRAID1_2S, DRAID1_3S, DRAID2_1S, DRAID2_2S, DRAID2_3S, DRAID3_1S, DRAID3_2S, DRAID3_3S, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
|-
|   || <tt>pool-type</tt> || The type of storage pool to be created. [swap, *zfs]
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>is-default</tt> || Indicates that this pool should be utilized as the default storage pool.
|-
|   || <tt>compress</tt> || Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
|-
|   || <tt>auto-trim</tt> || Enable auto-trim storage pool optimizations.
|-
|   || <tt>profile</tt> || Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.
|-
|   || <tt>raid-set-size</tt> || Number of disks to use in each set of disks (aka VDEV) when creating a new storage pool with layout RAID10, RAIDZ1/50, RAIDZ2/60, or RAIDZ3.
|-
|   || <tt>encrypt</tt> || Enables encryption on all devices in the storage pool or other storage resource. Encryption can only be enabled at the time of storage resource creation.
|-
|   || <tt>encryption-type</tt> || Sets the encryption algorithm, currently only the default aes256 is supported. [SED, aes256, *default]
|-
|   || <tt>passphrase</tt> || Locks up the storage keys into an encrypted file after the pool has been created. After this the passphrase must be provided to start the storage pool. If no storage pool is provided then the pool is started automatically at system startup time.
|-
|   || <tt>key-server-type</tt> || Type of key server associated with storage pool, used to protect and store encryption keys. [IBM-KeyProtect, *default, kmip]
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>ashift</tt> || Controls the block size offset for the devices which can impact usable capacity and performance. Recommend leaving this at 0 so that the system can automatically select based on the reported blocksize of the devices.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-destroy===
Deletes a storage pool, *WARNING* any data in the pool will be lost.

<pre> qs pool-destroy|p-destroy --pool=value [--shred-keys=value ] [--shred-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>shred-keys</tt> || Shreds the keys if the pool is an encrypted Storage Pool.
|-
|   || <tt>shred-mode</tt> || Indicates the mode used to shred data on all the disks in the pool as part of the pool destroy process. [auto, dod, nnsa, *none, nvme_secure, random, sed-instant-erase, ssd_secure, usarmy, zeros]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===pool-device-get===
Gets information about a specific storage pool device.

<pre> qs pool-device-get|spd-get --pool-device=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool-device</tt> || Name or UUID of a storage pool device
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===pool-device-group-get===
Gets information about a specific storage pool device group.

<pre> qs pool-device-group-get|spdg-get --pool-device-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool-device-group</tt> || Name or UUID of a storage pool device group
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===pool-device-group-identify===
Pulses the disk activity lights for all disks in the pool device group so they can be identified in the chassis.

<pre> qs pool-device-group-identify|spdg-ident --pool-device-group=value [--duration=value ] [--blink-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool-device-group</tt> || Name or UUID of a storage pool device group
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-device-group-list===
Returns a list of all the storage pool device groups.

<pre> qs pool-device-group-list|spdg-list [--pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===pool-device-group-search===
Returns a subset of Storage Pool Device Group objects matching the given search criteria.

<pre> qs pool-device-group-search|spdg-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Storage Pool Device Group List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===pool-device-list===
Returns a list of all the storage pool devices.

<pre> qs pool-device-list|spd-list [--pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===pool-device-search===
Returns a subset of Storage Pool Device objects matching the given search criteria.

<pre> qs pool-device-search|spd-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Storage Pool Device List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===pool-expand===
Expands a storage pool after the underlying hardware RAID unit has been grown underneath.

<pre> qs pool-expand|p-expand --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-export===
Deactivate and remove the Storage Pool from the Storage System database so that it can be exported and used on another system.

<pre> qs pool-export|p-export --pool=value [--release-io-fence=value ] [--clear-crypttab-entries=value ] [--metadata-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>release-io-fence</tt> || Release all I/O fence reservations for the specified disk(s)
|-
|   || <tt>clear-crypttab-entries</tt> || Clear crypttab entries associated with the devices in the pool on pool export.
|-
|   || <tt>metadata-only</tt> || Export a new metadata archive to the '.poolmeta' directory for the specified pool. The pool is not exported, rather this option provides for a way to make a new explicit backup of pool metadata.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-get===
Gets information about a specific storage pool.

<pre> qs pool-get|p-get --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, forget-missing, min]
|}

===pool-grow===
Grows the specified storage pool by adding an additional disk. You can only grow storage pools that are using the RAID5 or RAID6 layout.

<pre> qs pool-grow|p-grow --pool=value --disk-list=value [--raid-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>raid-type</tt> || RAID type for the storage pool where RAID0 is striping, RAID1/10 are mirroring, RAID5/50/6/60/7/70 are parity based fault-tolerant layouts, and DRAID/1_1S/1_2S/1_3S/2_1S/2_2S/2_3S/3_1S/3_2S/3_3S are distributed RAID layouts. [*AUTO, DRAID1_1S, DRAID1_2S, DRAID1_3S, DRAID2_1S, DRAID2_2S, DRAID2_3S, DRAID3_1S, DRAID3_2S, DRAID3_3S, ERASURE-CODING, LINEAR, RAID0, RAID1, RAID10, RAID5, RAID50, RAID6, RAID60, RAID7, RAID70, REPLICAS]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-health-check===
Checks the health/state of the pool and recursively checks the health of the associated disk devices to see if there are any issues anywhere in the stack.

<pre> qs pool-health-check|p-check --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pool-identify===
Pulses the disk activity lights for all disks in the pool so they can be identified in the chassis.

<pre> qs pool-identify|p-id --pool=value [--blink-type=value ] [--duration=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>blink-type</tt> || Mode for the operation to turn on/activate or turn off the device LED beacon. [off, on]
|-
|   || <tt>duration</tt> || Duration in seconds to remain ON before automatically turning off. Default = 0 (stays on until explicitly turned off). If blink-type = OFF, specify the delay time until OFF action is taken.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-import===
Imports the named storage pool(s) which have been previously exported.

<pre> qs pool-import|p-import --pool-list=value [--storage-system=value ] [--metadata-only=value ] [--skip-metadata=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool-list</tt> || List of storage pools.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>metadata-only</tt> || Import only the metadata archive from the '.poolmeta' directory for the specified pool. Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
|-
|   || <tt>skip-metadata</tt> || Import all volumes and shares but DO NOT recover the volume and share metadata using the most recent backup from the '.poolmeta' directory. Useful for when the metadata is too old or invalid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-import-encrypted===
Imports the named encrypted storage pool(s) which have been previously exported, providing the given passphrase to decrypt the pool.

<pre> qs pool-import-encrypted|p-import-crypt --storage-system=value --pool-list=value [--passphrase=value ] [--metadata-only=value ] [--skip-metadata=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>pool-list</tt> || List of storage pools.
|-
|   || <tt>passphrase</tt> || If the Storage Pool was created with an encryption passphrase then it must be specified in order to temporarily unlock the keys and start the Storage Pool.
|-
|   || <tt>metadata-only</tt> || Import only the metadata archive from the '.poolmeta' directory for the specified pool. Metadata is imported by default on all pool import operations. The metadata-only import option provides a way to reimport the metadata for an already imported pool.
|-
|   || <tt>skip-metadata</tt> || Import all volumes and shares but DO NOT recover the volume and share metadata using the most recent backup from the '.poolmeta' directory. Useful for when the metadata is too old or invalid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-key-export===
Exports all the encryption key information for the specified Storage Pool into a block that can be used in the future to re-import the keys.

<pre> qs pool-key-export|p-key-export --pool=value --key-file=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>key-file</tt> || File name to use for the exported pool key block.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pool-key-import===
Import the previously exported encryption keys for a Storage Pool to the specified Storage System.

<pre> qs pool-key-import|p-key-import --key-file=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-file</tt> || File which contains the previously exported key block to use for importing.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pool-list===
Returns a list of all the storage pools.

<pre> qs pool-list|p-list [--vasa-support-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vasa-support-only</tt> || VASA support only.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===pool-modify===
Modifies the properties of the storage pool such as its name and description.

<pre> qs pool-modify|p-modify --pool=value [--name=value ] [--is-default=value ] [--compress=value ] [--auto-trim=value ] [--profile=value ] [--desc=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--repair-policy=value ] [--approve-repair=value ] [--copies=value ] [--key-server-profile=value ] [--key-server-type=value ] [--small-block-threshold=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>is-default</tt> || Indicates that this pool should be utilized as the default storage pool.
|-
|   || <tt>compress</tt> || Enable Storage Volume compression on the pool, this boosts both read and write performance on most IO loads.
|-
|   || <tt>auto-trim</tt> || Enable auto-trim storage pool optimizations.
|-
|   || <tt>profile</tt> || Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>sync</tt> || Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
|-
|   || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|   || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|   || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|   || <tt>repair-policy</tt> || Type of automatic hotspare repair action to be applied. (assigned-and-global | assigned-only | assigned-and-global-exact | assigned-only-exact | manual-repair) [*assigned-and-global, assigned-and-global-exact, assigned-only, assigned-only-exact, manual]
|-
|   || <tt>approve-repair</tt> || Set flag to approve a pending storage pool repair action that is currently deferred and requires explicit manual approval by an operator/admin to proceed
|-
|   || <tt>copies</tt> || Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
|-
|   || <tt>key-server-profile</tt> || Identifier for Key Server Profile.
|-
|   || <tt>key-server-type</tt> || Type of key server associated with storage pool, used to protect and store encryption keys. [IBM-KeyProtect, *default, kmip]
|-
|   || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-portals-list===
List all the valid portals for the specified pool that could be used in a Portal Group associated with the Storage Pool.

<pre> qs pool-portals-list|pl-portals-list --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, forget-missing, min]
|}

===pool-preimport-scan===
Returns a list of pools that are available to import but that are not yet discovered.

<pre> qs pool-preimport-scan|ppi-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pool-profile-get===
Gets information about a specific storage pool profile.

<pre> qs pool-profile-get|pp-get --profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>profile</tt> || Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===pool-profile-list===
Returns a list of all the storage pool profiles.

<pre> qs pool-profile-list|pp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===pool-rekey===
Add a new key to available LUKS key slot. Creates a back up of valid previously used key and generates key materials for the new key.

<pre> qs pool-rekey|p-rekey --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===pool-remove-read-cache===
Removes the specified read cache from the specified pool.

<pre> qs pool-remove-read-cache|p-remove-read-cache --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-remove-spare===
Removes the specified hot-spare from the specified pool.

<pre> qs pool-remove-spare|p-remove --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-remove-write-log===
Removes the specified write log from the specified pool.

<pre> qs pool-remove-write-log|p-remove-write-log --pool=value --disk-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-scan===
Rescans the specified Storage System for storage pools.

<pre> qs pool-scan|p-scan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-scrub-start===
Starts a scrub/verify operation on a scale-up (OpenZFS) Storage Pool (verifies data integrity and auto-corrects any bit-rot). See Maintenance Schedules for configuring an automatic monthly pool scrub.

<pre> qs pool-scrub-start|p-scrub-start --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-scrub-stop===
Stops the active scrub/verify operation on a scale-up (OpenZFS) Storage Pool.

<pre> qs pool-scrub-stop|p-scrub-stop --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-search===
Returns a subset of Storage Pools matching the given search criteria.

<pre> qs pool-search|p-search --search-filter=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Storage Pool List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===pool-set-passphrase===
Sets or clears the encryption passphrase for an encrypted storage pool.

<pre> qs pool-set-passphrase|p-set-passphrase --pool=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>current-passphrase</tt> || Current encryption passphrase for the storage resource (e.g., pool or network share). If issuing user has the 'Administrator' role and the pool is already started or if the resource is not currently passphrase protected this value can be omitted.
|-
|   || <tt>new-passphrase</tt> || New encryption passphrase for storage resource (e.g., pool or network share). (For a pool, omitting this argument will clear the encryption passphrase.)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-start===
Starts up a previously stopped storage pool.

<pre> qs pool-start|p-start --pool=value [--passphrase=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>passphrase</tt> || If the Storage Pool was created with an encryption passphrase then it must be specified in order to temporarily unlock the keys and start the Storage Pool.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-stop===
Stops all volume activity to the pool and disables it for maintenance.

<pre> qs pool-stop|p-stop --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===pool-trim===
Starts a SSD/NVMe trim operation on a the specified scale-up (OpenZFS) Storage Pool. See 'zpool trim' command for additional control.

<pre> qs pool-trim|p-trim --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

</div>
</div>

==Portal Group Management [PORTAL-GROUP]==
Operations for management of Portal Groups used for scoping FC and VIF access for Storage Volumes
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===portal-group-create===
Creates a Portal Group which restricts access for a set of Storage Volumes to a specific set of cluster VIFs and FC ports.

<pre> qs portal-group-create|ptg-create --name=value --pool=value [--description=value ] [--portal-group-options=value ] [--port-id-list=value ] [--volume-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>portal-group-options</tt> || Options for preferred port access mode for a given Portal Group. [all-preferred, *defaults, single-preferred]
|-
|   || <tt>port-id-list</tt> || Cluster VIF, HA VIF, and/or FC ports to be associated with the Port Group.
|-
|   || <tt>volume-list</tt> || List of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===portal-group-delete===
Deletes the specified Portal Group

<pre> qs portal-group-delete|ptg-delete --portal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>portal-group</tt> || A Portal Group restricts access to a set of Storage Volumes to a specified set of VIFs and FC ports.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===portal-group-get===
Returns properties of the specified Portal Group.

<pre> qs portal-group-get|ptg-get --portal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>portal-group</tt> || A Portal Group restricts access to a set of Storage Volumes to a specified set of VIFs and FC ports.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===portal-group-list===
Lists all Portal Groups in the Storage Grid

<pre> qs portal-group-list|ptg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===portal-group-modify===
Modifies the port list and other settings within a Portal Group. The Storage Pool associated with the Portal Group may not be modified after a given Portal Group is created.

<pre> qs portal-group-modify|ptg-modify --portal-group=value [--name=value ] [--description=value ] [--portal-group-options=value ] [--port-id-list=value ] [--volume-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>portal-group</tt> || A Portal Group restricts access to a set of Storage Volumes to a specified set of VIFs and FC ports.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>portal-group-options</tt> || Options for preferred port access mode for a given Portal Group. [all-preferred, *defaults, single-preferred]
|-
|   || <tt>port-id-list</tt> || Cluster VIF, HA VIF, and/or FC ports to be associated with the Port Group.
|-
|   || <tt>volume-list</tt> || List of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===portal-group-port-assoc-get===
Details of the specified association.

<pre> qs portal-group-port-assoc-get|ptg-assoc-get --portal-group=value --cluster-vif=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>portal-group</tt> || A Portal Group restricts access to a set of Storage Volumes to a specified set of VIFs and FC ports.
|-
|   || <tt>cluster-vif</tt> || ID of a Cluster VIF
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===portal-group-port-assoc-list===
List the FC port and cluster VIFs associated with the Portal Group

<pre> qs portal-group-port-assoc-list|ptg-assoc-list --portal-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>portal-group</tt> || A Portal Group restricts access to a set of Storage Volumes to a specified set of VIFs and FC ports.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==QoS Policy Management [QOSPOLICY]==
Storage Volume access can be throttled to limit throughput independently for read and write IO in terms of MB/sec via Quality of Serivce (QoS) policies.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===qos-policy-create===
Creates a new Quality-of-Service (QoS) policy template, which is used to apply throughput performance limits on Storage Volumes.

<pre> qs qos-policy-create|qos-create --name=value --bw-read=value --bw-write=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>bw-read</tt> || Sets the maximum read bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the Storage Volume, 0 (default) indicates unlimited.
|-
|   || <tt>bw-write</tt> || Sets the maximum write bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the Storage Volume, 0 (default) indicates unlimited.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===qos-policy-delete===
Deletes a given QoS Policy and clears the QoS performance limits on all Storage Volumes associated with the policy.

<pre> qs qos-policy-delete|qos-delete --qos-policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===qos-policy-get===
Returns detailed information about a specific QoS policy.

<pre> qs qos-policy-get|qos-get --qos-policy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===qos-policy-list===
Returns details on the list of all QoS policy objects in the Storage System grid.

<pre> qs qos-policy-list|qos-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===qos-policy-modify===
Modifies an existing QoS policy with a new name, description, or performance limits. Changes are applied immediately to all volumes.

<pre> qs qos-policy-modify|qos-modify --qos-policy=value [--name=value ] [--desc=value ] [--bw-read=value ] [--bw-write=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>bw-read</tt> || Sets the maximum read bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the Storage Volume, 0 (default) indicates unlimited.
|-
|   || <tt>bw-write</tt> || Sets the maximum write bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the Storage Volume, 0 (default) indicates unlimited.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

</div>
</div>

==Resource Group Quota Management [QUOTA]==
Resource Groups can have quotas associated with them to limit which pools and how much storage can be provisioned from those pools by a given group of users which are members of a Resource Group
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===provisioning-quota-create===
Creates a new storage provisioning quota on a pool for the specified tenant resource cloud.

<pre> qs provisioning-quota-create|pq-create --name=value --pool=value --resource-group=value [--policy=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>policy</tt> || Indicates the type of quota to be created. [hard, *soft]
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>psize</tt> || The total thin-provisionable space allowed by this provisioning quota.
|-
|   || <tt>usize</tt> || The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
|-
|   || <tt>max-volumes</tt> || The maximum number of volumes that can be created using this quota, specify 0 for no limit.
|-
|   || <tt>max-shares</tt> || The maximum number of Shares that can be created using this quota, specify 0 for no limit.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===provisioning-quota-delete===
Deletes a storage provisioning quota, the associated volumes are not deleted.

<pre> qs provisioning-quota-delete|pq-delete --quota=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===provisioning-quota-get===
Returns information about a specific storage provisioning quota.

<pre> qs provisioning-quota-get|pq-get --quota=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===provisioning-quota-list===
Returns a list of all the storage provisioning quotas.

<pre> qs provisioning-quota-list|pq-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===provisioning-quota-modify===
Modifies one to change the name and/or description of a storage provisioning quota.

<pre> qs provisioning-quota-modify|pq-modify --quota=value --resource-group=value [--name=value ] [--desc=value ] [--psize=value ] [--usize=value ] [--max-volumes=value ] [--max-shares=value ] [--policy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>psize</tt> || The total thin-provisionable space allowed by this provisioning quota.
|-
|   || <tt>usize</tt> || The total utilizable space allowed by this provisioning quota which may be less than the provisionable space.
|-
|   || <tt>max-volumes</tt> || The maximum number of volumes that can be created using this quota, specify 0 for no limit.
|-
|   || <tt>max-shares</tt> || The maximum number of Shares that can be created using this quota, specify 0 for no limit.
|-
|   || <tt>policy</tt> || Indicates the type of quota to be created. [hard, *soft]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===provisioning-quota-share-add===
Adds one or more shares to the specified provisioning quota.

<pre> qs provisioning-quota-share-add|pqs-add --quota=value --share-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===provisioning-quota-share-assoc-list===
Returns a list of all the associated provisioning quotas of a specified share.

<pre> qs provisioning-quota-share-assoc-list|pqs-alist --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===provisioning-quota-share-remove===
Removes one or more shares from the specified provisioning quota.

<pre> qs provisioning-quota-share-remove|pqs-remove --quota=value --share-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===provisioning-quota-volume-add===
Adds one or more volumes to the specified provisioning quota.

<pre> qs provisioning-quota-volume-add|pqv-add --quota=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===provisioning-quota-volume-assoc-list===
Returns a list of all the associated provisioning quotas of a specified volume.

<pre> qs provisioning-quota-volume-assoc-list|pqv-alist --volume=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===provisioning-quota-volume-remove===
Removes one or more volumes from the specified provisioning quota

<pre> qs provisioning-quota-volume-remove|pqv-remove --quota=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>quota</tt> || Name or ID of a storage provisioning quota.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Remote Replication Management [REPLICATION]==
Remote-replication and associated replication schedules enable automatic replication to a pool of storage in a remote appliance for disaster-recovery (DR) purposes.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===replica-assoc-delete===
Deletes the specified replication association between a source/target pair of volumes or shares.

<pre> qs replica-assoc-delete|rep-assoc-delete --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replica-assoc-get===
Returns details of the specified replication association.

<pre> qs replica-assoc-get|rep-assoc-get --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===replica-assoc-list===
Returns a list of all the replication associations.

<pre> qs replica-assoc-list|rep-assoc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replica-assoc-rollback===
Reverses the replication to send the changes on the target back to the source volume/share. Requires the --force flag.

<pre> qs replica-assoc-rollback|rep-assoc-rollback --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replica-assoc-stop===
Attempts to stop the replication process between a source/target pair of volumes or shares.

<pre> qs replica-assoc-stop|rep-assoc-stop --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replica-assoc-sync===
Restarts the replication process between a source/target pair of volumes or shares.

<pre> qs replica-assoc-sync|rep-assoc-sync --replica-assoc=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>replica-assoc</tt> || Name or ID of a replica association between a source/target volume or share
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replica-report-entry-get===
Get a replication report entry.

<pre> qs replica-report-entry-get|rep-report-get --report-entry=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-entry</tt> || Name or ID of the replication report entry
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replica-report-entry-list===
Returns a list of replication report entries.

<pre> qs replica-report-entry-list|rep-report-list [--report-summary=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-summary</tt> || Name or ID of the replication report summary
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replica-report-summary-delete===
Delete a replication report summary. All the report entries for this summary will be deleted.

<pre> qs replica-report-summary-delete|rep-report-summary-delete --report-summary=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-summary</tt> || Name or ID of the replication report summary
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replica-report-summary-get===
Get a replication report summary.

<pre> qs replica-report-summary-get|rep-report-summary-get --report-summary=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-summary</tt> || Name or ID of the replication report summary
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replica-report-summary-list===
Returns a list of replication report summary.

<pre> qs replica-report-summary-list|rep-report-summary-list [--schedule=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replication-schedule-activate-checkpoints===
Activates all the Network Shares and Storage Volumes associated with the schedule as 'active replica checkpoints'. This stops the schedule from running and makes it clear to the user (see green dot in WUI and isActiveCheckpoint) that the share/volume is in use by the DR site. Optionally a subset of volumes/shares may be selected to be activated. Note also that SMB/NFS/iSCSI/FC login to a given _chkpnt marked share or volume will automatically transition it to the Active Checkpoint state. This Active Checkpoint state must be cleared for all shares/volumes in a given Replication Schedule before the schedule can resume automatic replication.

<pre> qs replication-schedule-activate-checkpoints|rsch-act-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--auto-alias=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>auto-alias</tt> || Creates Network Share aliases for all of the Network Share checkpoints so that they may be accessed using the name of the source Network Share rather than a share with the _chkpnt suffix.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===replication-schedule-add===
Adds one or more volumes/shares to the specified schedule.

<pre> qs replication-schedule-add|rsch-add --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replication-schedule-create===
Creates a new replication schedule to replicate the specified Storage Volumes and shares to the specified target pool on a schedule.

<pre> qs replication-schedule-create|rsch-create --name=value --target-pool=value [--volume-list=value ] [--share-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--rc-summary-reports=value ] [--include-nested-shares=value ] [--resumable-replication=value ] [--reclaim-old-snapshots=value ] [--copy-share-settings=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>target-pool</tt> || Target storage pool on remote system to replicate to.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>max-replicas</tt> || Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>interval</tt> || (interval based) Delay interval in minutes between when a scheduled run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>rc-src-hourly</tt> || Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-src-dailies</tt> || Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-src-weeklies</tt> || Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-src-monthlies</tt> || Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-src-quarterlies</tt> || Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-dst-hourly</tt> || Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-dst-dailies</tt> || Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
|-
|   || <tt>rc-dst-weeklies</tt> || Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
|-
|   || <tt>rc-dst-monthlies</tt> || Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
|-
|   || <tt>rc-dst-quarterlies</tt> || Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|   || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot. Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
|   || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one. This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
|   || <tt>rc-summary-reports</tt> || Number of replication summary reports to retain.
|-
|   || <tt>include-nested-shares</tt> || Include nested shares.
|-
|   || <tt>resumable-replication</tt> || Enable resumable replication. Defaults to true.
|-
|   || <tt>reclaim-old-snapshots</tt> || Reclaim Orphaned Snapshots.
|-
|   || <tt>copy-share-settings</tt> || Copy source share settings to the checkpoint network share when doing a full replication.
|}

===replication-schedule-deactivate-checkpoints===
Deactivates all the Network Shares and Storage Volumes associated with the schedule so that the schedule can resume automatic replication. If there are active sessions to any Volumes/Shares the schedule will not be able to be re-enabled.

<pre> qs replication-schedule-deactivate-checkpoints|rsch-deact-chkpnts --schedule=value [--volume-list=value ] [--share-list=value ] [--reenable=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>reenable</tt> || Re-enables the schedule so that automatic replication can resume.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===replication-schedule-delete===
Deletes a replication schedule, snapshots associated with the schedule are not removed.

<pre> qs replication-schedule-delete|rsch-delete --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===replication-schedule-disable===
Disables the specified replication schedule.

<pre> qs replication-schedule-disable|rsch-disable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===replication-schedule-enable===
Enables the specified replication schedule.

<pre> qs replication-schedule-enable|rsch-enable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===replication-schedule-get===
Returns information about a specific replication schedule.

<pre> qs replication-schedule-get|rsch-get --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===replication-schedule-list===
Returns a list of all the replication schedules.

<pre> qs replication-schedule-list|rsch-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replication-schedule-modify===
Modifies the name, description or other properties of a replication schedule.

<pre> qs replication-schedule-modify|rsch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-replicas=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-src-hourly=value ] [--rc-src-dailies=value ] [--rc-src-weeklies=value ] [--rc-src-monthlies=value ] [--rc-src-quarterlies=value ] [--rc-dst-hourly=value ] [--rc-dst-dailies=value ] [--rc-dst-weeklies=value ] [--rc-dst-monthlies=value ] [--rc-dst-quarterlies=value ] [--flags=value ] [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--rc-summary-reports=value ] [--include-nested-shares=value ] [--resumable-replication=value ] [--reclaim-old-snapshots=value ] [--reclaim-schedule-id=value ] [--copy-share-settings=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>max-replicas</tt> || Maximum number of replica snapshot checkpoints to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>interval</tt> || (interval based) Delay interval in minutes between when a scheduled run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>rc-src-hourly</tt> || Source side retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-src-dailies</tt> || Source side retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-src-weeklies</tt> || Source side retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-src-monthlies</tt> || Source side retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-src-quarterlies</tt> || Source side retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-dst-hourly</tt> || Destination side retention count of hourly snapshots of checkpoints. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-dst-dailies</tt> || Destination side retention count of daily snapshots of checkpoints. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots of checkpoints.
|-
|   || <tt>rc-dst-weeklies</tt> || Destination side retention count of weekly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots of checkpoints.
|-
|   || <tt>rc-dst-monthlies</tt> || Destination side retention count of monthly snapshots of checkpoints. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots of checkpoints.
|-
|   || <tt>rc-dst-quarterlies</tt> || Destination side retention count of quarterly snapshots of checkpoints. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots of checkpoints.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|   || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot. Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
|   || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one. This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
|   || <tt>rc-summary-reports</tt> || Number of replication summary reports to retain.
|-
|   || <tt>include-nested-shares</tt> || Include nested shares.
|-
|   || <tt>resumable-replication</tt> || Enable resumable replication. Defaults to true.
|-
|   || <tt>reclaim-old-snapshots</tt> || Reclaim Orphaned Snapshots.
|-
|   || <tt>reclaim-schedule-id</tt> || Reclaim Schedule with ID.
|-
|   || <tt>copy-share-settings</tt> || Copy source share settings to the checkpoint network share when doing a full replication.
|}

===replication-schedule-remove===
Removes one or more volumes/shares from the specified schedule.

<pre> qs replication-schedule-remove|rsch-remove --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replication-schedule-trigger===
Triggers the specified schedule to run immediately.

<pre> qs replication-schedule-trigger|rsch-trigger --schedule=value [--reuse-source-snapshot=value ] [--reuse-target-chkpnt=value ] [--copy-share-settings=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>reuse-source-snapshot</tt> || Reuses the most recent source snapshot for replication rather than making a new snapshot. Useful when trying to get multiple target _chkpnts setup with a common snapshot point.
|-
|   || <tt>reuse-target-chkpnt</tt> || Reuses a best match existing target _chkpnt rather than creating a new one. This is the default mode but can be forced with this option to repair/recreate a replication association to a remote _chkpnt in cases where the association has been removed.
|-
|   || <tt>copy-share-settings</tt> || Copy source share settings to the checkpoint network share when doing a full replication.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===replication-schedule-trigger-rollback===
Triggers a rollback replication for the specified schedule to run immediately.

<pre> qs replication-schedule-trigger-rollback|rsch-trigger-rollback --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

</div>
</div>

==Report Schedule Management [REPORT-SCHEDULE]==
Operations for sending automatic email reports on a schedule.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===report-schedule-add-pool===
Adds pools to the Report Schedule for usage and capacity reports.

<pre> qs report-schedule-add-pool|rs-add-pool --report-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-assoc-get===
Gets detailed information on a specific Report Schedule Association

<pre> qs report-schedule-assoc-get|rs-assoc-get --report-schedule=value --pool=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===report-schedule-assoc-list===
Returns a list of all the Report Schedule associations to Pools

<pre> qs report-schedule-assoc-list|rs-assoc-list --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-create===
Creates a new Report Schedule

<pre> qs report-schedule-create|rs-create --name=value [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--save-report=value ] [--save-location=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--schedule-type=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--pool-list=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>report-email</tt> || Email address to send the report to.
|-
|   || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
|-
|   || <tt>save-report</tt> || Whether or not to save a copy of the generated reports locally.
|-
|   || <tt>save-location</tt> || The path to the folder to save local report copies to.
|-
|   || <tt>report-types</tt> || Types of reports to generate and send when the schedule runs. [capacity, health, *none, objectusage, replication, usage]
|-
|   || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>interval-days</tt> || Delay interval in days between when a scheduled run completes and the next one is started.
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
|   || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
|   || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>max-buckets</tt> || Maximum buckets to be included in the report for each tenant
|-
|   || <tt>max-users</tt> || Maximum users to be included in the report for each tenant.
|-
|   || <tt>min-user-space-utilized</tt> || Minimum space utilized by a user to be included in the report.
|-
|   || <tt>min-bucket-space-utilized</tt> || Minimum utilized space of the bucket to be included in the report.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===report-schedule-delete===
Deletes the specified Report Schedule

<pre> qs report-schedule-delete|rs-delete --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-disable===
Disables the specified Report Schedule

<pre> qs report-schedule-disable|rs-disable --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-enable===
Enables the specified Report Schedule

<pre> qs report-schedule-enable|rs-enable --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-get===
Returns details of a specific Report Schedule

<pre> qs report-schedule-get|rs-get --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===report-schedule-list===
Returns a list of all the Report Schedules

<pre> qs report-schedule-list|rs-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-modify===
Modifies the specified Report Schedule

<pre> qs report-schedule-modify|rs-modify --report-schedule=value [--name=value ] [--description=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--save-report=value ] [--save-location=value ] [--report-types=value ] [--output-format=value ] [--enabled=value ] [--schedule-type=value ] [--start-date=value ] [--interval-days=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>report-email</tt> || Email address to send the report to.
|-
|   || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
|-
|   || <tt>save-report</tt> || Whether or not to save a copy of the generated reports locally.
|-
|   || <tt>save-location</tt> || The path to the folder to save local report copies to.
|-
|   || <tt>report-types</tt> || Types of reports to generate and send when the schedule runs. [capacity, health, *none, objectusage, replication, usage]
|-
|   || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>interval-days</tt> || Delay interval in days between when a scheduled run completes and the next one is started.
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
|   || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
|   || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
|   || <tt>max-buckets</tt> || Maximum buckets to be included in the report for each tenant
|-
|   || <tt>max-users</tt> || Maximum users to be included in the report for each tenant.
|-
|   || <tt>min-user-space-utilized</tt> || Minimum space utilized by a user to be included in the report.
|-
|   || <tt>min-bucket-space-utilized</tt> || Minimum utilized space of the bucket to be included in the report.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-remove-pool===
Removes pools from the Report Schedule for usage and capacity reports.

<pre> qs report-schedule-remove-pool|rs-remove-pool --report-schedule=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>pool-list</tt> || List of one or more storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===report-schedule-trigger===
Triggers the specified Report Schedule to immediately send a report.

<pre> qs report-schedule-trigger|rs-trigger --report-schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-schedule</tt> || Report Schedules send out periodic reports on a set schedule for simplified monitoring of overall grid health, capacity usage, and other system metrics.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===system-report===
Generate a configuration analysis health report of all Storage Systems in the grid.

<pre> qs system-report|sys-report [--report-type=value ] [--config-category=value ] [--output-format=value ] [--report-email=value ] [--report-to-alert-emails=value ] [--save-report=value ] [--save-location=value ] [--max-depth=value ] [--max-subdirs=value ] [--min-used=value ] [--max-buckets=value ] [--max-users=value ] [--min-user-space-utilized=value ] [--min-bucket-space-utilized=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>report-type</tt> || Type of report to generate. [capacity, health, *none, objectusage, replication, usage]
|-
|   || <tt>config-category</tt> || Category of commands to get help with (all, network, HA, remote-replication, ceph, zfs, cephfs, HA-cluster, grid, security, general, hw-maint). [*ALL, HA, hw-maint, network, platform, remote-replication, security]
|-
|   || <tt>output-format</tt> || Output format of the data to be written [csv, html, *text]
|-
|   || <tt>report-email</tt> || Email address to send the report to.
|-
|   || <tt>report-to-alert-emails</tt> || Sends the report to the users and email addresses already configured to receive system alerts.
|-
|   || <tt>save-report</tt> || Whether or not to save a copy of the generated reports locally.
|-
|   || <tt>save-location</tt> || The path to the folder to save local report copies to.
|-
|   || <tt>max-depth</tt> || If greater than zero shows usage of subshares up to N sub-directories deep. (default: 1)
|-
|   || <tt>max-subdirs</tt> || Shows the usage of the largest subdirectories up to the specified max number of subdirectories per share. (default: 10)
|-
|   || <tt>min-used</tt> || Skips subdirectories that have less used space than the specified minimum. (default: 1MB)
|-
|   || <tt>max-buckets</tt> || Maximum buckets to be included in the report for each tenant
|-
|   || <tt>max-users</tt> || Maximum users to be included in the report for each tenant.
|-
|   || <tt>min-user-space-utilized</tt> || Minimum space utilized by a user to be included in the report.
|-
|   || <tt>min-bucket-space-utilized</tt> || Minimum utilized space of the bucket to be included in the report.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Resource Domain Management [RESOURCE-DOMAIN]==
Resource Domains group appliances by site, building, and rack so that scale-out data distribution technologies (Ceph CRUSH) can be automatically configured.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===resource-domain-add-system===
Adds one or more systems to a resource domain (site, rack, etc).

<pre> qs resource-domain-add-system|rd-add-sys --domain-resource=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|   || <tt>system-list</tt> || List of one or more systems to be associated with a resource domain.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-domain-assoc-get===
Returns information about a system/appliance association with a specific domain (rack, building, site).

<pre> qs resource-domain-assoc-get|rda-get [--system-resource=value ] [--resource-domain-assoc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-resource</tt> || Storage system to be associated with a resource domain (site, rack, building) for use in automatic CRUSH map generation.
|-
|   || <tt>resource-domain-assoc</tt> || Resource domain association between a system and a resource domain (site, rack, building) for use in automatic CRUSH map generation.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===resource-domain-assoc-list===
Returns a list of all the defined resource domain association objects which represent links between appliances to sites, buildings, and racks.

<pre> qs resource-domain-assoc-list|rda-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===resource-domain-create===
Creates a new resource domain which identifies a site, building or rack of equipment.

<pre> qs resource-domain-create|rd-create --name=value [--desc=value ] [--resource-domain-type=value ] [--resource-parent=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>resource-domain-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
|-
|   || <tt>resource-parent</tt> || Parent domain resource name or ID. For example a rack resource can have a parent resource of type site or building.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===resource-domain-delete===
Deletes the specified resource domain.

<pre> qs resource-domain-delete|rd-delete --domain-resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===resource-domain-get===
Resource failure domains identify physical equipment, sites, racks so that data can be dispersed in such a way as to ensure fault-tolerance and high availability across sites and racks.

<pre> qs resource-domain-get|rd-get --domain-resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===resource-domain-list===
Returns a list of all the defined resource domain objects which can include sites, buildings, racks, and servers.

<pre> qs resource-domain-list|rd-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===resource-domain-modify===
Modifies an existing resource domain to change properties like name and description.

<pre> qs resource-domain-modify|rd-modify --domain-resource=value [--name=value ] [--desc=value ] [--resource-domain-type=value ] [--resource-parent=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>resource-domain-type</tt> || Type of the domain resource which can be a site, building, rack, or server. [appliance, building, *rack, region, site]
|-
|   || <tt>resource-parent</tt> || Parent domain resource name or ID. For example a rack resource can have a parent resource of type site or building.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===resource-domain-rm-system===
Removes one or more systems from a resource domain (site, rack, etc)

<pre> qs resource-domain-rm-system|rd-rm-sys --domain-resource=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>domain-resource</tt> || ID or name of a domain resource.
|-
|   || <tt>system-list</tt> || List of one or more systems to be associated with a resource domain.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Multitenant Resource Group Management [RESOURCE-GROUP]==
Resource Groups combine volumes, shares, and pools of storage together and so that they can be assigned to one more users (tenants). This facilitates multi-tenancy and delegation of common tasks like storage provisioning to end-users.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===resource-group-create===
Creates a new tenant resource group composed of the specified users, resources and chap information.

<pre> qs resource-group-create|rg-create --name=value --network-list=value [--desc=value ] [--subject-list=value ] [--resource-list=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--scope=value ] [--scope-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>subject-list</tt> || A list of subjects in the following format name:type. Ex: userName:user,groupName:user_group...
|-
|   || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
|-
|   || <tt>network-list</tt> || A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
|-
|   || <tt>parent-cloud</tt> || The name or unique id of a tenant resource cloud.
|-
|   || <tt>tier</tt> || The tier of the storage cloud.
|-
|   || <tt>organization</tt> || The name of the organization this tenant resource cloud is assigned to.
|-
|   || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|   || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|   || <tt>scope</tt> || Scope for the Resource Group
|-
|   || <tt>scope-type</tt> || Scope type for the Resource Group [Ceph, HA, *local]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-delete===
Deletes a tenant's resource group, the resources and users will not be deleted.

<pre> qs resource-group-delete|rg-delete --resource-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===resource-group-get===
Returns information of the specified tenant resource groups.

<pre> qs resource-group-get|rg-get --resource-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===resource-group-list===
Returns a list of all the tenant resource groups.

<pre> qs resource-group-list|rg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===resource-group-modify===
Modifies the name, description, parent resource group, tier, organization, and chap information of a resource group.

<pre> qs resource-group-modify|rg-modify --resource-group=value [--name=value ] [--desc=value ] [--parent-cloud=value ] [--tier=value ] [--organization=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>parent-cloud</tt> || The name or unique id of a tenant resource cloud.
|-
|   || <tt>tier</tt> || The tier of the storage cloud.
|-
|   || <tt>organization</tt> || The name of the organization this tenant resource cloud is assigned to.
|-
|   || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|   || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-network-add===
Add one or more network access points to the specified tenant resource group

<pre> qs resource-group-network-add|rg-net-add --resource-group=value --network-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>network-list</tt> || A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-network-enum===
Returns list of all resource group network access bindings.

<pre> qs resource-group-network-enum|rg-net-enum [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-network-get===
Returns specified resource group network access binding.

<pre> qs resource-group-network-get|rg-net-get --resource-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-network-remove===
Remove one or more network access points from the specified tenant resource group

<pre> qs resource-group-network-remove|rg-net-remove --resource-group=value --network-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>network-list</tt> || A list of network access points in either network mask (e.g. 192.168.0.0/16) or vlanId (integer value 1-4049) form, in a comma delimited list.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-resource-add===
Add one or more resources to the specified tenant resource group.

<pre> qs resource-group-resource-add|rg-res-add --resource-group=value --resource-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-resource-mode===
Set the mode of a specified resource in the tenant resource group.

<pre> qs resource-group-resource-mode|rg-res-mode --resource-group=value --resource=value --access-mode=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>resource</tt> || The unique id of a volume or volume group or share or host or host group.
|-
|   || <tt>access-mode</tt> || Access mode for the volume.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-resource-remove===
Remove one or more resources from the specified tenant resource group.

<pre> qs resource-group-resource-remove|rg-res-remove --resource-group=value --resource-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>resource-list</tt> || A list resources in the following format name:type. Ex: vol:volume,hostname:host...
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-subject-assoc-list===
Returns a list of associated tenant resource groups to the specified subject (user or user group).

<pre> qs resource-group-subject-assoc-list|rg-user-list --subject=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>subject</tt> || The unique id of a user or user group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===resource-group-user-add===
Add one or more users to the specified tenant resource group.

<pre> qs resource-group-user-add|rg-user-add --resource-group=value --subject-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>subject-list</tt> || A list of subjects in the following format name:type. Ex: userName:user,groupName:user_group...
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===resource-group-user-remove===
Remove one or more users from specified tenant resource group.

<pre> qs resource-group-user-remove|rg-user-remove --resource-group=value --subject-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>subject-list</tt> || A list of subjects in the following format name:type. Ex: userName:user,groupName:user_group...
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Object Reverse Proxy Management [REVERSE-PROXY]==
Commands for managing Object Storage Endpoint Reverse Proxies.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===object-proxy-create===
Creates a new Object Reverse Proxy configuration on the specified system.

<pre> qs object-proxy-create|object-pr-create --name=value --proxy-server-fqdn=value --proxy-endpoint-fqdn=value [--storage-system=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>proxy-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
|-
|   || <tt>proxy-endpoint-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider object storage region endpoint.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>sslcert-file</tt> || Path to a file which contains the SSL Certificate to the read and passed to the server.
|-
|   || <tt>sslkey-file</tt> || Path to a file which contains the SSL Certificate Key to be read and passed to the server.
|-
|   || <tt>port-numbers</tt> || List of port numbers to be associated with the proxy.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-proxy-delete===
Deletes the specified Object Reverse Proxy configuration.

<pre> qs object-proxy-delete|object-pr-delete --object-proxy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-proxy</tt> || Name or ID of an object Reverse Proxy configuration.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===object-proxy-get===
Returns information about a specific Object Reverse Proxy configuration.

<pre> qs object-proxy-get|object-pr-get --object-proxy=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-proxy</tt> || Name or ID of an object Reverse Proxy configuration.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===object-proxy-list===
Returns a list of all the configured Object Reverse Proxies in the system/grid.

<pre> qs object-proxy-list|object-pr-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===object-proxy-modify===
Modifies the settings/properties of an Object Reverse Proxy configuration.

<pre> qs object-proxy-modify|object-pr-modify --object-proxy=value [--name=value ] [--proxy-server-fqdn=value ] [--proxy-endpoint-fqdn=value ] [--sslcert-file=value ] [--sslkey-file=value ] [--port-numbers=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-proxy</tt> || Name or ID of an object Reverse Proxy configuration.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>proxy-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the hostname by which the proxy will be identified and routed to/from the endpoint.
|-
|   || <tt>proxy-endpoint-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the end-point the proxy will route to, this is typically a cloud service provider object storage region endpoint.
|-
|   || <tt>sslcert-file</tt> || Path to a file which contains the SSL Certificate to the read and passed to the server.
|-
|   || <tt>sslkey-file</tt> || Path to a file which contains the SSL Certificate Key to be read and passed to the server.
|-
|   || <tt>port-numbers</tt> || List of port numbers to be associated with the proxy.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==RBAC Role Management [ROLE]==
Advanced Role Based Access Controls (RBAC) allow for the creation of custom roles that limit users to specific tasks and operations within a grid or Resource Group (collection of volumes, shares, and pools).
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===login-precheck===
Returns basic service startup information usable before attempting login or commands.

<pre> qs login-precheck|lpc [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===password-policy-get===
Returns details of the current user password policy settings for the storage grid / appliances.

<pre> qs password-policy-get|pw-policy-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===password-policy-set===
Configures the password policy requirements for user accounts.

<pre> qs password-policy-set|pw-policy-set [--special-chars=value ] [--complexity=value ] [--min-length=value ] [--max-length=value ] [--login-attempts-short-lockout=value ] [--login-attempts-perm-lockout=value ] [--short-lockout-sample-sec=value ] [--perm-lockout-sample-sec=value ] [--short-lockout-duration=value ] [--days-until-exp=value ] [--unique-pw-reuse=value ] [--min-days-between-change=value ] [--inactive-days-lockout=value ] [--web-logout-timeout=value ] [--use-note=value ] [--web-access=value ] [--default-login-username=value ] [--multiadmin-approval-types=value ] [--multiadmin-approval-count=value ] [--multiadmin-approval-expiration-hours=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>special-chars</tt> || Special characters which are allowed to be used in a password.
|-
|   || <tt>complexity</tt> || Password complexity requirement where 'strong' requires a mix of numbers, letters, and special characters. [standard, strong, *weak]
|-
|   || <tt>min-length</tt> || Minimum password length (default 8)
|-
|   || <tt>max-length</tt> || Maximum password length (default 40)
|-
|   || <tt>login-attempts-short-lockout</tt> || Maximum password attempts before account is locked out for a short period. (default 5)
|-
|   || <tt>login-attempts-perm-lockout</tt> || Maximum password attempts before account is locked out and must be unlocked by an administrator. (default 0/disabled)
|-
|   || <tt>short-lockout-sample-sec</tt> || Continuous sample period (in seconds) over which bad login attempts are summed to determine if a short lockout to a User account should be applied.
|-
|   || <tt>perm-lockout-sample-sec</tt> || Continuous sample period (in seconds) over which bad login attempts are summed to determine if a permanent lockout to a User account should be applied.
|-
|   || <tt>short-lockout-duration</tt> || Duration of the short lockout due to bad login attempts.
|-
|   || <tt>days-until-exp</tt> || Days until a user's password expires and must be changed. (default 0/disabled)
|-
|   || <tt>unique-pw-reuse</tt> || Number of unique passwords that must be used before it can be reused.
|-
|   || <tt>min-days-between-change</tt> || Minimum number of days before a password may be changed again.
|-
|   || <tt>inactive-days-lockout</tt> || After N many days without a successful login for a given account this policy will automatically lock the user account unless it is the admin account (default 0/disabled).
|-
|   || <tt>web-logout-timeout</tt> || After N many minutes of no activity in the web interface users will be logged out automatically. (default 30 minutes)
|-
|   || <tt>use-note</tt> || System use notification message is an administrator supplied message that is presented to the user immediately after login. System use notification messages are required in some corporate and government environments to meet compliance standards.
|-
|   || <tt>web-access</tt> || Unsecure HTTP access mode should be disabled or redirected to HTTPS in almost all configurations. [disable-http, *enable-http, redirect-http]
|-
|   || <tt>default-login-username</tt> || Default login username presented when logging in via the web management interface.
|-
|   || <tt>multiadmin-approval-types</tt> || Indicate the object types that require multi-admin approval for changes to be applied. Object types include 'volume', 'share', 'pool', 'system', 'bucket'.
|-
|   || <tt>multiadmin-approval-count</tt> || Indicate the number of multi-admin approvals required for changes to be applied.
|-
|   || <tt>multiadmin-approval-expiration-hours</tt> || Indicate the number of hours before a multi-admin approval expires.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===role-add===
Adds a new role to the role based access control (RBAC) system.

<pre> qs role-add|r-add --name=value [--desc=value ] [--permissions=value ] [--ldap-group=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
|-
|   || <tt>ldap-group</tt> || LDAP group name associated with the role.
|-
|   || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|   || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===role-get===
Gets information about the specified role.

<pre> qs role-get|r-get --role=value [--export=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>export</tt> || Export the role in XML format for use in the security definition file.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===role-list===
Returns a list of all the defined roles in the RBAC system.

<pre> qs role-list|r-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===role-modify===
Modifies the name and/or description of a role

<pre> qs role-modify|r-modify --role=value [--name=value ] [--desc=value ] [--ldap-group=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>ldap-group</tt> || LDAP group name associated with the role.
|-
|   || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|   || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===role-permission-add===
Adds additional permissions and/or permission groups to the specified role.

<pre> qs role-permission-add|rp-add --role=value --permissions=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===role-permission-def-list===
Returns a list of all the defined permissions available to be assigned to roles in the RBAC system.

<pre> qs role-permission-def-list|rpd-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===role-permission-remove===
Removes one or more permissions and/or permission groups from the specified role.

<pre> qs role-permission-remove|rp-remove --role=value --permissions=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>permissions</tt> || List of permissions and/or permission groups to add to the specified role. Must be of the form 'object:operation:scope'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===role-remove===
Removes the specified role identified by name or ID

<pre> qs role-remove|r-remove --role=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===single-sign-on-policy-get===
Gets the Single Sign-on Policy

<pre> qs single-sign-on-policy-get|sso-policy-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===single-sign-on-policy-set===
Sets the Single Sign-on Policy

<pre> qs single-sign-on-policy-set|sso-policy-set --enable-single-sign-on=value [--ldap-server-fqdn=value ] [--ldap-server-base-dn=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>enable-single-sign-on</tt> || Enable Single Sign-on
|-
|   || <tt>ldap-server-fqdn</tt> || Fully Qualified Domain Name (FQDN) of the LDAP server. Example ldapserver.example.com
|-
|   || <tt>ldap-server-base-dn</tt> || LDAP server base DN for users. Example dc=ldapserver,dc=example,dc=com
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Snapshot Schedule Management [SCHEDULE]==
Snapshot schedules make automatic instant point-in-time snapshots of Storage Volumes and/or Network Shares on a schedule. It is highly recommended that snapshot schedule(s) be created for all mission critical volumes and shares so that data and files can be easily recovered from a previous point in time.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===snap-schedule-add===
Adds one or more volumes/shares to the specified schedule.

<pre> qs snap-schedule-add|sch-add --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===snap-schedule-assoc-list===
Returns a list of all the volume/share associations for a given snapshot schedule.

<pre> qs snap-schedule-assoc-list|scha-list --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===snap-schedule-create===
Creates a new snapshot schedule composed of the specified Storage Volumes.

<pre> qs snap-schedule-create|sch-create --name=value [--volume-list=value ] [--share-list=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] [--include-nested-shares=value ] [--reclaim-old-snapshots=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>interval</tt> || (interval based) Delay interval in minutes between when a scheduled run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|   || <tt>include-nested-shares</tt> || Include nested shares.
|-
|   || <tt>reclaim-old-snapshots</tt> || Reclaim Orphaned Snapshots.
|}

===snap-schedule-delete===
Deletes a snapshot schedule, snapshots associated with the schedule are not removed.

<pre> qs snap-schedule-delete|sch-delete --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===snap-schedule-disable===
Disables the specified snapshot schedule.

<pre> qs snap-schedule-disable|sch-disable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===snap-schedule-enable===
Enables the specified snapshot schedule.

<pre> qs snap-schedule-enable|sch-enable --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===snap-schedule-get===
Returns information about a specific snapshot schedule.

<pre> qs snap-schedule-get|sch-get --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===snap-schedule-list===
Returns a list of all the snapshot schedules.

<pre> qs snap-schedule-list|sch-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===snap-schedule-modify===
Modifies the name, description or other properties of a snapshot schedule.

<pre> qs snap-schedule-modify|sch-modify --schedule=value [--name=value ] [--start-date=value ] [--enabled=value ] [--desc=value ] [--resource-group=value ] [--max-snaps=value ] [--schedule-type=value ] [--interval=value ] [--days=value ] [--hours=value ] [--offset-minutes=value ] [--rc-hourly=value ] [--rc-dailies=value ] [--rc-weeklies=value ] [--rc-monthlies=value ] [--rc-quarterlies=value ] [--flags=value ] [--include-nested-shares=value ] [--reclaim-old-snapshots=value ] [--reclaim-schedule-id=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>start-date</tt> || Start date at which the system will begin using a given schedule. (Dec 29 2016 00:00:00 | 2016-12-29T00:00:00Z)
|-
|   || <tt>enabled</tt> || While the schedule is enabled snapshots will be taken at the designated times.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>resource-group</tt> || Name of a Resource Group or its unique id.
|-
|   || <tt>max-snaps</tt> || Maximum number of snapshots to retain for this schedule, after which the oldest snapshot is removed before a new one is created.
|-
|   || <tt>schedule-type</tt> || Specifies the timer type for the schedule. Interval schedules specify a delay interval (aka rest interval) between schedule activations and calendar schedules activate at specific days and times. Scheduled snapshot/backup/replication jobs are never run while work from a previous run for the same schedule is still active. [*calendar, interval]
|-
|   || <tt>interval</tt> || (interval based) Delay interval in minutes between when a scheduled run completes and the next one is started. Minimum schedule delay interval is 3 minutes.
|-
|   || <tt>days</tt> || (calendar based) The days of the week on which this schedule should create snapshots. [fri, mon, sat, *sun, thu, tue, wed]
|-
|   || <tt>hours</tt> || (calendar based) For the specified days of the week, snapshots will be created at the specified hours. [10am, 10pm, 11am, 11pm, 12am, 12pm, 1am, 1pm, 2am, 2pm, *3am, 3pm, 4am, 4pm, 5am, 5pm, 6am, 6pm, 7am, 7pm, 8am, 8pm, 9am, 9pm]
|-
|   || <tt>offset-minutes</tt> || (calendar based) Delay the scheduled start time by specified minutes. For example, a 30min offset with scheduled trigger time of 1am and 4am will trigger at 1:30am and 4:30am respectively.
|-
|   || <tt>rc-hourly</tt> || Retention count of hourly snapshots. A retention count of 2 will retain 2 snapshots spanning the last 2 hours.
|-
|   || <tt>rc-dailies</tt> || Retention count of daily snapshots. A retention count of 7 will retain 7 snapshots spanning the last week with a minimum of one day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-weeklies</tt> || Retention count of weekly snapshots. A retention count of 4 will retain 4 snapshots spanning the last month with a minimum of 7 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-monthlies</tt> || Retention count of monthly snapshots. A retention count of 6 will retain 6 snapshots spanning the last half-year with a minimum of 30 day spacing between snapshots/checkpoints.
|-
|   || <tt>rc-quarterlies</tt> || Retention count of quarterly snapshots. A retention count of 4 will retain 4 snapshots spanning a year with a minimum of 90 day spacing between snapshots/checkpoints.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|   || <tt>include-nested-shares</tt> || Include nested shares.
|-
|   || <tt>reclaim-old-snapshots</tt> || Reclaim Orphaned Snapshots.
|-
|   || <tt>reclaim-schedule-id</tt> || Reclaim Schedule with ID.
|}

===snap-schedule-remove===
Removes one or more volumes/shares from the specified schedule.

<pre> qs snap-schedule-remove|sch-remove --schedule=value [--volume-list=value ] [--share-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===snap-schedule-trigger===
Triggers the specified schedule to run immediately.

<pre> qs snap-schedule-trigger|sch-trigger --schedule=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>schedule</tt> || Name of a snapshot schedule or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==iSCSI/FC/NFS/SMB Session Management [SESSION]==
Commands for iSCSI/FC/NFS/SMB storage session management.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===share-session-get===
Returns information about a specific NFS/SMB session.

<pre> qs share-session-get|share-sn-get --share-session=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share-session</tt> || A Network Share session represents a NAS client connection/session via the SMB and/or NFS protocol.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===share-session-list===
Returns a list of all the open SMB sessions.

<pre> qs share-session-list|share-sn-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===volume-session-close===
Forcibly closes the specified iSCSI session; generally not recommended, use acl-remove instead.

<pre> qs volume-session-close|volume-sn-close [--volume=value ] [--session-list=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>session-list</tt> || iSCSI session identifier for an active iSCSI session.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===volume-session-get===
Returns detailed information on a specific iSCSI session.

<pre> qs volume-session-get|volume-sn-get --session=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>session</tt> || iSCSI session identifier for an active iSCSI session.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===volume-session-list===
Returns a list of all the active iSCSI sessions.

<pre> qs volume-session-list|volume-sn-list [--volume=value ] [--host=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Network Share Management [SHARE]==
Commands for managing Network Shares which are accessible via NFS and/or the SMB protocol.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===active-dir-domain-list===
Returns a list of all domains including the trusted domains.

<pre> qs active-dir-domain-list|ad-dom-list --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===active-dir-user-group-list===
Returns a list of all the users and groups in the Active Directory domain that the appliance is a member of. Search results are limited to 1000 users/groups. Consider narrowing down the search for a list of all users/groups

<pre> qs active-dir-user-group-list|ad-ug-list --storage-system=value [--is-group=value ] [--domain=value ] [--organization-unit=value ] [--filter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>is-group</tt> || List active directory users or groups. Default is users
|-
|   || <tt>domain</tt> || Search users or groups in the specified domain. If not specified the default domain will be used.
|-
|   || <tt>organization-unit</tt> || Search users or groups in the specified organization unit. If not specified, the base domain will be used to search.
|-
|   || <tt>filter</tt> || Filter to search users or groups. Example user*dom*. If not specified, all users or groups will be search.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-client-add===
Adds a NFS client access rule for the specified Network Share.

<pre> qs share-client-add|shr-cadd --share=value --filter=value [--async=value ] [--secure=value ] [--subtree=value ] [--rdonly=value ] [--options=value ] [--filter-priority=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>filter</tt> || A filter string for the client
|-
|   || <tt>async</tt> || Use asynchronous communication between NFS server and client
|-
|   || <tt>secure</tt> || Requires the requests to originate from an Internet port less than IPPORT_RESERVED
|-
|   || <tt>subtree</tt> || Enables subtree checking
|-
|   || <tt>rdonly</tt> || Allow only read requests for the NFS volume
|-
|   || <tt>options</tt> || Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
|-
|   || <tt>filter-priority</tt> || Priority of the NFS access filter within a group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-client-get===
Returns information about the specific Network Share NFS client access rule.

<pre> qs share-client-get|shr-cget --share=value [--filter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>filter</tt> || A filter string for the client
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===share-client-list===
Returns a list of NFS clients access rules for the specified Network Share.

<pre> qs share-client-list|shr-clist --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-client-modify===
Modifies a NFS client access rule for the specified Network Share.

<pre> qs share-client-modify|shr-cmodify --share=value --filter=value [--rdonly=value ] [--secure=value ] [--async=value ] [--subtree=value ] [--options=value ] [--filter-priority=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>filter</tt> || A filter string for the client
|-
|   || <tt>rdonly</tt> || Allow only read requests for the NFS volume
|-
|   || <tt>secure</tt> || Requires the requests to originate from an Internet port less than IPPORT_RESERVED
|-
|   || <tt>async</tt> || Use asynchronous communication between NFS server and client
|-
|   || <tt>subtree</tt> || Enables subtree checking
|-
|   || <tt>options</tt> || Set of custom NFS options as a comma delimited list such as no_root_squash, wdelay, ro etc
|-
|   || <tt>filter-priority</tt> || Priority of the NFS access filter within a group.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-client-remove===
Removes NFS client access rule for the specified Network Share.

<pre> qs share-client-remove|shr-cremove --share=value --filter=value [--retain-client-connection=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>filter</tt> || A filter string for the client
|-
|   || <tt>retain-client-connection</tt> || Retain client connection. Default is false.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-clone===
Creates a full copy of the specified Network Share to another storage pool.

<pre> qs share-clone|shr-clone --share=value --pool=value [--name=value ] [--desc=value ] [--active=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>name</tt> || Name for the clone, if not provided the source volume name will be used as a prefix.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-copy-settings===
Copies settings from source share to the specified Network Share. Setting include NFS access entries and CIFS settings. NFS access entries that are different on the destination share are removed.

<pre> qs share-copy-settings|shr-copy-settings --share=value --share-copy-settings-source=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>share-copy-settings-source</tt> || Copy settings from this share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-create===
Creates a new Network Share accessible via NFS v3/v4 and the SMB protocol.

<pre> qs share-create|shr-create --name=value --pool=value [--desc=value ] [--public=value ] [--active=value ] [--cifs-enable=value ] [--user-access-list=value ] [--cifs-options=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--reserved=value ] [--vvol-type=value ] [--protocol-end-point=value ] [--is-cloud-container-cache=value ] [--nfs-security-policy=value ] [--parent-share=value ] [--encrypt=value ] [--encryption-key=value ] [--count=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--disable-nfs-hidden-dir-browsing=value ] [--immutability-mode=value ] [--days-of-immutability=value ] [--small-block-threshold=value ] [--file-quota=value ] [--permissions-mask=value ] [--enable-anomaly-detection=value ] [--anomaly-thresholds=value ] [--auto-threshold-calibration-duration=value ] [--include-rules=value ] [--exclude-rules=value ] [--read-only=value ] [--case-sensitivity=value ] [--disable-nfs-crossmount=value ] [--sub-pool=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>public</tt> || Indicates that the specified Network Share should be made public and open for read/write access to all systems on the network.
|-
|   || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|   || <tt>cifs-enable</tt> || Enables Samba support for Network Share.
|-
|   || <tt>user-access-list</tt> || List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3:admin,@ugroup:valid,~DOMAIN+user7,~user33'. Prepend with tilde (~) to remove entries. Prepend with '@' to specify a user group. Optionally append POSIX ACL permissions as a third field: 'user1:valid:rwx,user2:valid:r-x,@devs:valid:rwx'.
|-
|   || <tt>cifs-options</tt> || CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties. If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
|-
|   || <tt>space-quota</tt> || Size of the quota for the Network Share (optional).
|-
|   || <tt>space-quota-exclude-snapshots</tt> || If specified there is no limit on the space utilized by snapshots of the parent share (optional).
|-
|   || <tt>sync</tt> || Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
|-
|   || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|   || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|   || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|   || <tt>copies</tt> || Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
|-
|   || <tt>share-owner</tt> || Name of the share owner
|-
|   || <tt>share-owner-group</tt> || Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
|-
|   || <tt>permissions</tt> || Permissions settings for the share in read/write/execute format for user/group/other in the standard UNIX permissions octal format (eg 755) or rwxr--r--
|-
|   || <tt>recordsize</tt> || Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
|-
|   || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>vvol-type</tt> || vvol type for VASA support. Type can be none for no VASA support, protocolEndPoint or subVol. The default is none. [*none, protocol-end-point, subvol-config, subvol-data, subvol-swap]
|-
|   || <tt>protocol-end-point</tt> || Protocol Endpoint ID only applies to VVOL based Network Shares and indicates the parent share on which the VVOL should be created.
|-
|   || <tt>is-cloud-container-cache</tt> || Indicates if this share is to be used as Cloud Container cache. 'true' if used as a cache.
|-
|   || <tt>nfs-security-policy</tt> || By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
|-
|   || <tt>parent-share</tt> || The ID or name of the Network Share to link a given alias or sub-share to.
|-
|   || <tt>encrypt</tt> || Enables encryption for the specified share. Network Share level encryption is independent from the encryption setting for the Storage Pool which may be encrypted or unencrypted. Encryption can only be enabled at the time of storage resource creation.
|-
|   || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the storage resource.
|-
|   || <tt>count</tt> || The number of volumes to create, default is 1.
|-
|   || <tt>disable-vss-snap-browsing</tt> || Disable VSS snapshot browsing.
|-
|   || <tt>disable-smb-snap-dir</tt> || Disables SMB _snaps folder browsing of activated GMT snapshots.
|-
|   || <tt>disable-nfs-snap-dir</tt> || Enables NFS _snaps folder browsing of activated GMT snapshots.
|-
|   || <tt>disable-nfs-hidden-dir-browsing</tt> || Disables explicit NFS share/.zfs snapshot visibility
|-
|   || <tt>immutability-mode</tt> || Enables file immutability/WORM support for the specified share on creation. [append, immutable, *none]
|-
|   || <tt>days-of-immutability</tt> || The number of days a new file will be marked as immutable. After the file is old enough, it will be marked mutable at midnight.
|-
|   || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
|   || <tt>file-quota</tt> || Quota on the number of files within the Network Share.
|-
|   || <tt>permissions-mask</tt> || Permissions mask settings for the share in read/write/execute format rwx
|-
|   || <tt>enable-anomaly-detection</tt> || Enable anomaly detection for the Network Share based on hourly and daily file modifications and deletes.
|-
|   || <tt>anomaly-thresholds</tt> || User specified thresholds used to determine when an anomaly alert should be raised, given in the pattern {hourlyModify:15,hourlyDelete:10,dailyModify:25,dailyDelete:20}
|-
|   || <tt>auto-threshold-calibration-duration</tt> || A number of days to gather normal Network Share activity to auto calibrate the anomaly thresholds.
|-
|   || <tt>include-rules</tt> || A list of rules describing which files should be included in Ransomware Detection.
|-
|   || <tt>exclude-rules</tt> || A list of rules describing which files should be excluded from Ransomware Detection.
|-
|   || <tt>read-only</tt> || Set share readonly
|-
|   || <tt>case-sensitivity</tt> || Set share case sensitivity [insensitive, mixed, *sensitive]
|-
|   || <tt>disable-nfs-crossmount</tt> || Disable NFS crossmount option on the share.
|-
|   || <tt>sub-pool</tt> || Sub-pool within the cephFS file system to associate with this share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-create-alias===
Creates an alias for the specified share. Aliases have their own separate permissions settings which can be customized and can inherit from it's associated parent share. Aliases can also reference a sub-directory of the parent share.

<pre> qs share-create-alias|shr-create-alias --name=value --parent-share=value [--subpath=value ] [--inherit-access=value ] [--desc=value ] [--public=value ] [--active=value ] [--force-create-sub-dir=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>parent-share</tt> || The ID or name of the Network Share to link a given alias or sub-share to.
|-
|   || <tt>subpath</tt> || Sub-directory within the parent share to associate with this sub-share. If the directory doesn't exist it will be created automatically and the sub-path can refer to a directory which is nested multiple levels deep.
|-
|   || <tt>inherit-access</tt> || Inherit access control settings from the parent share including the NFS access entries and CIFS user/group access entries. [cifs, nfs, *none]
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>public</tt> || Indicates that the specified Network Share should be made public and open for read/write access to all systems on the network.
|-
|   || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|   || <tt>force-create-sub-dir</tt> || Force creation of sub directory if not present. Without this option the existing directory will not be used if present.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-create-from-template===
Creates a new network share from a network share template.

<pre> qs share-create-from-template|shr-create-from-template --name=value --pool=value --network-share-template=value [--desc=value ] [--network-share-template-mask=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>network-share-template</tt> || Network share template.
|-
|   || <tt>network-share-template-mask</tt> || Apply only specified settings from the Share template. [advanced, *all, cifs, general, nfs, permissions, security, user]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-data-pool-layout-modify===
Modifies the data pool layout for the specified Network Share.

<pre> qs share-data-pool-layout-modify|shr-data-pool-layout-modify --share=value --new-sub-pool=value [--recursive-contents=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>new-sub-pool</tt> || New sub-pool for the specified share
|-
|   || <tt>recursive-contents</tt> || Recursively update the contents of the specified share with the new data layout.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-delete===
Deletes the specified Network Share

<pre> qs share-delete|shr-delete [--share-list=value ] [--delete-child-snaps-only=value ] [--delete-child-snaps-and-parent=value ] [--search-filter=value ] [--dry-run-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share-list</tt> || A list of one or more Network Shares.
|-
|   || <tt>delete-child-snaps-only</tt> || Deletes the child snapshots of the specified share/volume. Parent share/volume will not be deleted.
|-
|   || <tt>delete-child-snaps-and-parent</tt> || Deletes the child snapshots of the specified share/volume along with the specified parent share/volume.
|-
|   || <tt>search-filter</tt> || Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>dry-run-only</tt> || Dry run will not implement any configuration or database changes, only returns a report on the action that --would-- be taken.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-disable===
Disables/deactivates the specified Network Share

<pre> qs share-disable|shr-disable --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-enable===
Enables/activates the specified Network Share

<pre> qs share-enable|shr-enable --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-file-lock-list===
Returns a list of all the open files (SMB only) for the specified Network Share.

<pre> qs share-file-lock-list|shr-lock-list [--share=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force]
|}

===share-get===
Returns information about the specified Network Share.

<pre> qs share-get|shr-get --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===share-group-quota-add===
Set a group quota for the Network Share

<pre> qs share-group-quota-add|shr-group-quota-add --share=value --user-group=value --quota-size=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>quota-size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-group-quota-remove===
Remove a group quota for the Network Share

<pre> qs share-group-quota-remove|shr-group-quota-remove --share=value --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-health-check===
Checks the health/state of the share and recursively checks the health of the associated pool and its disk devices to see if there are any health issues anywhere in the stack.

<pre> qs share-health-check|shr-check --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-hold-add===
Add a hold on a Network Share snapshot to prevent it from getting deleted. Releasing the hold will allow deletion.

<pre> qs share-hold-add|shr-hld-add --share=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>hold-tag</tt> || Tag identifying the hold.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-hold-remove===
Remove a hold on a Network Share snapshot. Releasing the hold will allow deletion.

<pre> qs share-hold-remove|shr-hld-remove --share=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>hold-tag</tt> || Tag identifying the hold.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-join-domain===
Joins the specified Active Directory domain/realm.

<pre> qs share-join-domain|shr-jdomain --storage-system=value --domain=value --realm=value --kdc=value --ad-admin=value --ad-password=value [--idmap-mode=value ] [--allow-trusted-domains=value ] [--computer-act-ou=value ] [--min-uid=value ] [--max-uid=value ] [--min-def-uid=value ] [--max-def-uid=value ] [--range-size=value ] [--ad-join-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>domain</tt> || The name of the AD domain to have the Storage System join. (DOMAIN)
|-
|   || <tt>realm</tt> || The name of the AD realm that the domain is in. (DOMAIN.COM)
|-
|   || <tt>kdc</tt> || The name of the Active Directory server/machine.
|-
|   || <tt>ad-admin</tt> || The AD administrator account of the domain that Storage System is a member of or joining.
|-
|   || <tt>ad-password</tt> || The AD password to the administrator account of the domain that Storage System is a member of or joining.
|-
|   || <tt>idmap-mode</tt> || Specifies the Unix to Active Directory ID mapping mode (idmap config) of rid, autorid, tdb, ad, ad-rfc2307 [ad, ad-rfc2307, *autorid, rid, tdb]
|-
|   || <tt>allow-trusted-domains</tt> || Allow discovery of trusted domains (default=false)
|-
|   || <tt>computer-act-ou</tt> || Organization Unit to create the computer account in
|-
|   || <tt>min-uid</tt> || Min UID in the range
|-
|   || <tt>max-uid</tt> || Max UID in the range
|-
|   || <tt>min-def-uid</tt> || Max UID for the default TDB backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
|-
|   || <tt>max-def-uid</tt> || Min UID for the default TDB backend. This range is used to create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings
|-
|   || <tt>range-size</tt> || Defines the number of uids/gids available per domain range. Only used in idmap mode 'autorid'
|-
|   || <tt>ad-join-mode</tt> || The mode to use when joining the AD domain (winbind, sssd, sssd_winbind). [none, sssd, sssd_plus_winbind, *winbind]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-key-export===
Exports all the encryption key information for the specified Network Share into a block that can be used in the future to re-import the keys.

<pre> qs share-key-export|shr-key-export --network-share=value --key-file=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>key-file</tt> || File name to use for the exported pool key block.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-key-import===
Import the previously exported encryption keys for a Network Share to the specified Storage System.

<pre> qs share-key-import|shr-key-import --key-file=value --network-share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>key-file</tt> || File which contains the previously exported key block to use for importing.
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-leave-domain===
Leaves the current Active Directory domain.

<pre> qs share-leave-domain|shr-ldomain --storage-system=value [--ad-admin=value ] [--ad-password=value ] [--preserve-access-entries=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>ad-admin</tt> || The AD administrator account of the domain that Storage System is a member of or joining.
|-
|   || <tt>ad-password</tt> || The AD password to the administrator account of the domain that Storage System is a member of or joining.
|-
|   || <tt>preserve-access-entries</tt> || When a system is removed from an AD domain all local storage pools will have their AD user access control information scrubbed from all Network Shares unless preserve entries is specified. (default=true)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-list===
Returns a list of all the Network Shares in the system.

<pre> qs share-list|shr-list [--vasa-support-only=value ] [--include-snapshots=value ] [--snapshots-with-holds-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vasa-support-only</tt> || VASA support only.
|-
|   || <tt>include-snapshots</tt> || Include snapshots in the list
|-
|   || <tt>snapshots-with-holds-only</tt> || Include snapshots with holds in the list
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===share-load-encryption-key===
Load the encryption key of an encrypted network share so that the key is in the available state.

<pre> qs share-load-encryption-key|shr-load-key --network-share=value [--encryption-key=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>encryption-key</tt> || A passphrase which is used to encrypt all the data sent to the storage resource.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-modify===
Modifies the properties of the specified Network Share.

<pre> qs share-modify|shr-modify --share=value [--name=value ] [--desc=value ] [--active=value ] [--space-quota=value ] [--space-quota-exclude-snapshots=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--cifs-enable=value ] [--user-access-list=value ] [--group-access-list=value ] [--cifs-options=value ] [--share-owner=value ] [--share-owner-group=value ] [--permissions=value ] [--recordsize=value ] [--is-active-checkpoint=value ] [--reserved=value ] [--nfs-security-policy=value ] [--disable-vss-snap-browsing=value ] [--disable-smb-snap-dir=value ] [--disable-nfs-snap-dir=value ] [--disable-nfs-hidden-dir-browsing=value ] [--small-block-threshold=value ] [--file-quota=value ] [--permissions-mask=value ] [--enable-anomaly-detection=value ] [--anomaly-thresholds=value ] [--auto-threshold-calibration-duration=value ] [--include-rules=value ] [--exclude-rules=value ] [--read-only=value ] [--disable-nfs-crossmount=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|   || <tt>space-quota</tt> || Size of the quota for the Network Share (optional).
|-
|   || <tt>space-quota-exclude-snapshots</tt> || If specified there is no limit on the space utilized by snapshots of the parent share (optional).
|-
|   || <tt>sync</tt> || Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
|-
|   || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|   || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|   || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|   || <tt>copies</tt> || Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
|-
|   || <tt>cifs-enable</tt> || Enables Samba support for Network Share.
|-
|   || <tt>user-access-list</tt> || List of users with permission to access the Network Share for example 'user1:valid,user2:invalid,user3:admin,@ugroup:valid,~DOMAIN+user7,~user33'. Prepend with tilde (~) to remove entries. Prepend with '@' to specify a user group. Optionally append POSIX ACL permissions as a third field: 'user1:valid:rwx,user2:valid:r-x,@devs:valid:rwx'.
|-
|   || <tt>group-access-list</tt> || List of groups with permission to access the Network Share for example 'DOMAIN+group1:valid,~DOMAIN+group2' prepend with tilde (~) to remove access for specific users or groups.
|-
|   || <tt>cifs-options</tt> || CIFS/Samba configuration options specified as 'key=value,key2=value2,~key3,...', prepend with tilde (~) to remove fields/properties. If not specified on share creation the default option '[defaults]' is passed to the server to set common default values.
|-
|   || <tt>share-owner</tt> || Name of the share owner
|-
|   || <tt>share-owner-group</tt> || Name of the share owner group (Need to specify both share owner and group). Owner group must be specified as either 'valid' or 'admin' in the user access list parameter.
|-
|   || <tt>permissions</tt> || Permissions settings for the share in read/write/execute format for user/group/other in the standard UNIX permissions octal format (eg 755) or rwxr--r--
|-
|   || <tt>recordsize</tt> || Network Share record size in KB, valid values are 8, 16, 32, 64, 128 (default), 256, 512, or 1024. Larger values deliver higher performance for workloads with high sequential IO.
|-
|   || <tt>is-active-checkpoint</tt> || Network Shares and Storage Volumes marked as an active replica checkpoint cannot be replicated over by replication schedules or the replication system. Use is used to protect a given volume/share in the event of site failover to ensure the source side doesn't overwrite replicas at the DR site which are in use. Note: Checkpoints are automatically marked as active replica checkpoints whenever access is granted to them or they are accessed via a file or block storage session.
|-
|   || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>nfs-security-policy</tt> || By default each Network Share inherits the Storage System level NFS security policy but each share can have an override set to specifically set the policy to 'system' or 'kerberos'. [*inherit, kerberos, system]
|-
|   || <tt>disable-vss-snap-browsing</tt> || Disable VSS snapshot browsing.
|-
|   || <tt>disable-smb-snap-dir</tt> || Disables SMB _snaps folder browsing of activated GMT snapshots.
|-
|   || <tt>disable-nfs-snap-dir</tt> || Enables NFS _snaps folder browsing of activated GMT snapshots.
|-
|   || <tt>disable-nfs-hidden-dir-browsing</tt> || Disables explicit NFS share/.zfs snapshot visibility
|-
|   || <tt>small-block-threshold</tt> || Indicates the max size of a block of I/O for it to be categorized to be written to the SSD meta-data offload vdev. Recommend setting this to a value between 8K and 32K depending on how much SSD space is available in the mirrored metadata vdev.
|-
|   || <tt>file-quota</tt> || Quota on the number of files within the Network Share.
|-
|   || <tt>permissions-mask</tt> || Permissions mask settings for the share in read/write/execute format rwx
|-
|   || <tt>enable-anomaly-detection</tt> || Enable anomaly detection for the Network Share based on hourly and daily file modifications and deletes.
|-
|   || <tt>anomaly-thresholds</tt> || User specified thresholds used to determine when an anomaly alert should be raised, given in the pattern {hourlyModify:15,hourlyDelete:10,dailyModify:25,dailyDelete:20}
|-
|   || <tt>auto-threshold-calibration-duration</tt> || A number of days to gather normal Network Share activity to auto calibrate the anomaly thresholds.
|-
|   || <tt>include-rules</tt> || A list of rules describing which files should be included in Ransomware Detection.
|-
|   || <tt>exclude-rules</tt> || A list of rules describing which files should be excluded from Ransomware Detection.
|-
|   || <tt>read-only</tt> || Set share readonly
|-
|   || <tt>disable-nfs-crossmount</tt> || Disable NFS crossmount option on the share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-move===
Moves the specified Network Share inside an existing Network Share.

<pre> qs share-move|sh-move --share=value --new-parent=value [--new-name=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>new-parent</tt> || New parent for the specified nested share
|-
|   || <tt>new-name</tt> || New name for the share. If left name, existing name will be used for the move
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-promote===
Promotes the specified snapshot to a new dataset. Can be used to demote a previously promoted snapshot.

<pre> qs share-promote|sh-promote --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-quota-list===
Returns the user quotas for the Network Share.

<pre> qs share-quota-list|shr-quota-list --share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-restore===
Restores the specified Network Share with the contents of the specified snapshot.

<pre> qs share-restore|shr-restore --share=value --share-snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>share-snapshot</tt> || Name or ID of a snapshot of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-rollback===
Instant rollback of the specified Network Share to the specified point-in-time snapshot. Rollback is faster than the Restore operation but only works with the most recent snapshot. It use rollback with an earlier snapshot you must first remove those snapshots which were created after the desired rollback point.

<pre> qs share-rollback|shr-rollback --share=value --share-snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>share-snapshot</tt> || Name or ID of a snapshot of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-rollback-clone===
Instant rollback of the specified Network Share Clone to it's underlying snapshot.

<pre> qs share-rollback-clone|shr-rollback-clone --share-snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share-snapshot</tt> || Name or ID of a snapshot of a Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-search===
Returns a subset of Network Shares matching the given criteria.

<pre> qs share-search|shr-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>max-results</tt> || Maximum number of results to return for the given search parameters.
|-
|   || <tt>offset</tt> || Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===share-set-passphrase===
Sets or changes the encryption passphrase for an encrypted network share.

<pre> qs share-set-passphrase|shr-set-passphrase --network-share=value [--current-passphrase=value ] [--new-passphrase=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>current-passphrase</tt> || Current encryption passphrase for the storage resource (e.g., pool or network share). If issuing user has the 'Administrator' role and the pool is already started or if the resource is not currently passphrase protected this value can be omitted.
|-
|   || <tt>new-passphrase</tt> || New encryption passphrase for storage resource (e.g., pool or network share). (For a pool, omitting this argument will clear the encryption passphrase.)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===share-snapshot===
Creates and instant space efficient snapshot of the specified Network Share (requires Advanced Storage Pool)

<pre> qs share-snapshot|shr-snap --share=value [--name=value ] [--desc=value ] [--active=value ] [--lazy-clone=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>active</tt> || Indicates that the Network Share should be activated.
|-
|   || <tt>lazy-clone</tt> || Delays making the snapshot volume writable until it is assigned to a host or modified in some way. This option doesn't save space but does reduce CPU and memory usage load on the system and is recommended if you're not planning to use the snapshot right away.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-unload-encryption-key===
Unload the encryption key of an encrypted network share so that the key is in the unavailable state.

<pre> qs share-unload-encryption-key|shr-unload-key --network-share=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-user-quota-add===
Set a user quota for the Network Share

<pre> qs share-user-quota-add|shr-user-quota-add --share=value --user=value --quota-size=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>quota-size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===share-user-quota-remove===
Remove a user quota for the Network Share.

<pre> qs share-user-quota-remove|shr-user-quota-remove --share=value --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>share</tt> || Name or ID of a Network Share.
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

</div>
</div>

==Network Share Template Management [SHARE-TEMPLATE]==
Network Share Template
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===share-template-apply===
Applies the settings of the network share template to the designated network share.

<pre> qs share-template-apply|shr-tmp-apply --network-share-template=value --network-share=value [--network-share-template-mask=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share-template</tt> || Network share template.
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>network-share-template-mask</tt> || Apply only specified settings from the Share template. [advanced, *all, cifs, general, nfs, permissions, security, user]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-template-create===
Creates a new network share template using the specified network share.

<pre> qs share-template-create|shr-tmp-create --network-share=value --name=value [--description=value ] [--is-default=value ] [--network-share-template-mask=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share</tt> || Name or ID of a CIFS/NFS Network Share.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>is-default</tt> || Indicates that this template should be utilized as the default share settings.
|-
|   || <tt>network-share-template-mask</tt> || Apply only specified settings from the Share template. [advanced, *all, cifs, general, nfs, permissions, security, user]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-template-delete===
Deletes the network share template.

<pre> qs share-template-delete|shr-tmp-delete --network-share-template=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share-template</tt> || Network share template.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-template-get===
Returns information about a specific network share template.

<pre> qs share-template-get|shr-tmp-get --network-share-template=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share-template</tt> || Network share template.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-template-list===
Returns a list of all network share templates.

<pre> qs share-template-list|shr-tmp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===share-template-modify===
Modifies the properties of a network share template.

<pre> qs share-template-modify|shr-tmp-modify --network-share-template=value [--name=value ] [--description=value ] [--is-default=value ] [--network-share-template-mask=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>network-share-template</tt> || Network share template.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>is-default</tt> || Indicates that this template should be utilized as the default share settings.
|-
|   || <tt>network-share-template-mask</tt> || Apply only specified settings from the Share template. [advanced, *all, cifs, general, nfs, permissions, security, user]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

</div>
</div>

==Site Cluster Resource Management [SITE]==
Site Clusters manage virtual interfaces to which can float between cluster members to ensure high-availability to Storage Pools and other resources. Site Clusters maintain a heart-beat and control quorum for a subset of nodes so that Virtual Interfaces can be automatically moved between nodes as necessary.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===cluster-ring-create===
Creates a new cluster ring configuration for the specified site. Sites can have multiple rings to improve resiliency of the cluster in the event of a network loss on a specific port or network interface.

<pre> qs cluster-ring-create|cr-create --site=value --member-addresses=value [--ring=value ] [--bind-address=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>member-addresses</tt> || IP addresses, one from each appliance, used to form a new cluster ring for cluster communication activities.
|-
|   || <tt>ring</tt> || Unique cluster ring number starting with 0 for the first ring in the site.
|-
|   || <tt>bind-address</tt> || The bind address represents the network on which cluster communication is allowed for a specific ring.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cluster-ring-delete===
Deletes the specified cluster ring configuration.

<pre> qs cluster-ring-delete|cr-delete --cluster-ring=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cluster-ring</tt> || A cluster ring is a communication channel for heartbeat communication and cluster resource management communication activities. Ideal site configurations have two independent rings each on separate networks. For example, a site configuration may have a cluster ring 0 on 10.0.x.x/16 and ring 1 on 10.1.x.x/16
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===cluster-ring-get===
Returns the details about a specific cluster ring. A ring represents a communication channel for cluster heartbeat communication. Ideal cluster configurations have two rings.

<pre> qs cluster-ring-get|cr-get --cluster-ring=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cluster-ring</tt> || A cluster ring is a communication channel for heartbeat communication and cluster resource management communication activities. Ideal site configurations have two independent rings each on separate networks. For example, a site configuration may have a cluster ring 0 on 10.0.x.x/16 and ring 1 on 10.1.x.x/16
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cluster-ring-list===
Returns a list of the cluster ring configurations.

<pre> qs cluster-ring-list|cr-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===cluster-ring-member-get===
Returns information about the specified cluster ring member.

<pre> qs cluster-ring-member-get|crm-get --cluster-ring-member=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>cluster-ring-member</tt> || A cluster-ring-member represents a physical interface on a appliance used for cluster communication.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===cluster-ring-member-list===
Returns a list of all the cluster ring members of the site.

<pre> qs cluster-ring-member-list|crm-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===site-cluster-add-nodes===
Add the specified Storage Systems to the site cluster.

<pre> qs site-cluster-add-nodes|sc-add-nodes --site=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===site-cluster-assoc-get===
Returns detailed information about the specified site association.

<pre> qs site-cluster-assoc-get|sca-get --system=value [--site-assoc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system</tt> || The system with the site association.
|-
|   || <tt>site-assoc</tt> || A site association is a link between a system and a site.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===site-cluster-assoc-list===
Returns a list of all the configured site associations.

<pre> qs site-cluster-assoc-list|sca-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===site-cluster-create===
A site represents a group of appliances at a particular location. That location can span buildings but typically represents systems in close proximity to each other.

<pre> qs site-cluster-create|sc-create --name=value --system-ip-list=value [--desc=value ] [--location=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>system-ip-list</tt> || List of the IP addresses, one from each system to be selected to form a new Site Cluster. The selected IPs will be used to form the initial heart-beat ring and must be from the same network.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===site-cluster-delete===
Deletes the specified site configuration.

<pre> qs site-cluster-delete|sc-delete --site=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===site-cluster-get===
Returns detailed information about the specified site.

<pre> qs site-cluster-get|sc-get --site=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===site-cluster-list===
Returns a list of all the configured sites.

<pre> qs site-cluster-list|sc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===site-cluster-modify===
Modifies the configuration settings of a site like it's name, location or description.

<pre> qs site-cluster-modify|sc-modify --site=value [--name=value ] [--desc=value ] [--location=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===site-cluster-remove-nodes===
Remove the specified Storage Systems from the site cluster.

<pre> qs site-cluster-remove-nodes|sc-remove-nodes --site=value --system-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===site-cluster-rescan===
Rescans the Site Cluster configuration for a given Site Cluster.

<pre> qs site-cluster-rescan|sc-rescan [--site=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-cluster-restart-services===
Restarts the corosync/pacemaker services on the specified appliance.

<pre> qs site-cluster-restart-services|sc-restart --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===site-cluster-set-standby-mode===
Sets the specified Storage System to standby or unstandby mode. This is used to prevent the node from managing resources in order to support maintenance activities. 'manual-standby' mode indicates that the node will stay in standby mode until it is explicity unstandbyed. 'auto-standby' mode indicates that the node will automatically unstandby itself when the cluster is in a healthy state.

<pre> qs site-cluster-set-standby-mode|sc-set-standby --site=value --storage-system=value --standby-mode=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>standby-mode</tt> || Indicates the standby mode of the site cluster. Valid values are 'active' (unstandby if in standby), 'standby' (standby by auto unstandby when healthy) and 'manual-standby' (permanently remain in standby until manually transitioned to active). [*active, standby-auto-activate, standby-manual-activate]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-cluster-toggle-maintenance-mode===
Toggles maintenance mode for the given Site Cluster. Warning: when Site Cluster is in maintenance mode, all Site Cluster Vifs will become unmanaged.

<pre> qs site-cluster-toggle-maintenance-mode|sc-tog-mmode --site=value --enable-maintenance-mode=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>enable-maintenance-mode</tt> || If true, puts the Site Cluster into maintenance mode. If false, brings Site Cluster our of maintenance mode.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-vif-create===
Creates a new virtual interface for the site. Site virtual interfaces automatically float between appliances/systems to ensure availability of a management IP for a given site.

<pre> qs site-vif-create|svr-create --site=value --parent-port=value --ip-address=value [--netmask=value ] [--mac-address=value ] [--description=value ] [--location-config=value ] [--usecase-obj-id=value ] [--vif-use-case=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--mtu=value ] [--fqdn=value ] [--convert-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>site</tt> || A site is a group of appliances in a location.
|-
|   || <tt>parent-port</tt> || Parent network port like 'eth0' which the virtual interface should be attached. On failover the virtual interface will attach to the port with the same name on another system in the Site Cluster.
|-
|   || <tt>ip-address</tt> || IP address of the form x.x.x.x such as 10.0.0.10
|-
|   || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
|   || <tt>mac-address</tt> || MAC Address
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>location-config</tt> || List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
|-
|   || <tt>usecase-obj-id</tt> || Name or ID of the usecase object associated with this vif (ie, HA Group for a HA Vif, Ceph Cluster for a File pool Vif, etc)
|-
|   || <tt>vif-use-case</tt> || Specifies the use case in which the new VIF shall be used. [grid-primary, *ha, object-proxy, other, scaleout-block, scaleout-file, scaleout-obj]
|-
|   || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
|-
|   || <tt>nvmeof-enable</tt> || Enables or disables NVMeoF TCP access to the specified port(s).
|-
|   || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
|   || <tt>fqdn</tt> || When specified the FQDN for the virtual interface is added to the local /etc/hosts configuration on all systems in the QuantaStor storage grid so that the VIF's FQDN may be referenced by internal services including as Kerberos. The FQDN must be unique and cannot be a hostname already in use by one of the QuantaStor systems.
|-
|   || <tt>convert-vif</tt> || Convert existing local virtual IP address into an HA site VIF.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-vif-delete===
Deletes the virtual interface site resource and it's associated configuration information from the cluster configuration.

<pre> qs site-vif-delete|svr-delete --vif-resource=value [--convert-to-vif=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vif-resource</tt> || A site virtual interface resource.
|-
|   || <tt>convert-to-vif</tt> || Convert HA site VIF resource into a local virtual IP address.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-vif-get===
Returns the details about the specified virtual interface cluster resource in a site.

<pre> qs site-vif-get|svr-get --vif-resource=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vif-resource</tt> || A site virtual interface resource.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===site-vif-list===
Returns a list of all the virtual interface site resources.

<pre> qs site-vif-list|svr-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===site-vif-location-constraint-get===
Returns a specific location constraint for a Site Vif Resource given the Site Vif Resource and the associated Storage System Node.

<pre> qs site-vif-location-constraint-get|sv-lc-get --vif-resource=value --storage-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vif-resource</tt> || A site virtual interface resource.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-vif-location-constraint-list===
Returns a list of all the location constraints for all Site Vif Resources.

<pre> qs site-vif-location-constraint-list|sv-lc-list [--vif-resource=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vif-resource</tt> || A site virtual interface resource.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-vif-modify===
Updates a given Site Vif's use case, use case object, and/or location constraints.

<pre> qs site-vif-modify|svr-modify --vif-resource=value [--description=value ] [--location-config=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vif-resource</tt> || A site virtual interface resource.
|-
|   || <tt>description</tt> || A description for the object.
|-
|   || <tt>location-config</tt> || List describing the location configuration including Site Cluster node id and preferredness separated by a colon (ex: d1ff08a3-724d-1d83-40ff-7bb420232764:300,9306837e-2bde-5744-2ea3-6debfa41716d:200)
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===site-vif-move===
Moves the virtual interface resource from the current system it is attached to the specified Storage System. The target Storage System must be a member of the site cluster configuration.

<pre> qs site-vif-move|svr-move --vif-resource=value --move-to-system=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>vif-resource</tt> || A site virtual interface resource.
|-
|   || <tt>move-to-system</tt> || Destination system to move the virtual interface over to.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Storage Provisioning Tier Management [STORAGE-TIER]==
Storage Pools can be grouped into a Storage Provisioning Teir to simplify common provisioning tasks by pushing onto the system the task of selecting the optimial storage pool to provision a volume or share from based on the amount of free-space available and allocated.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===storage-tier-create===
Creates a new Storage Tier composed of the specified Storage Pools

<pre> qs storage-tier-create|st-create --name=value --pool-list=value [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>pool-list</tt> || List of storage pools.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>storage-class</tt> || The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
|-
|   || <tt>storage-type</tt> || Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SCSI, SSD, SSHD, UNKNOWN]
|-
|   || <tt>perf-level</tt> || An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===storage-tier-delete===
Deletes the specified Storage Tier (pools are not deleted).

<pre> qs storage-tier-delete|st-delete --tier=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===storage-tier-get===
Returns information about a specific Storage Tier.

<pre> qs storage-tier-get|st-get --tier=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===storage-tier-list===
Returns a list of all the Storage Tiers.

<pre> qs storage-tier-list|st-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===storage-tier-modify===
Modifies the name, description or other property of the specified storage tier.

<pre> qs storage-tier-modify|st-modify --tier=value [--name=value ] [--desc=value ] [--storage-class=value ] [--storage-type=value ] [--perf-level=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>storage-class</tt> || The classification/primary use case of the storage such as Backup/Archive, High-Performance, or General Purpose.
|-
|   || <tt>storage-type</tt> || Type of the storage pools included in this tier: SATA, SAS, SSD, SSHD, MULTI, Unknown [AOE, MULTI, *SAS, SATA, SCSI, SSD, SSHD, UNKNOWN]
|-
|   || <tt>perf-level</tt> || An estimation of the relative performance of the storage tier as a simplified number in the range of 1 to 100.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===storage-tier-pool-add===
Adds one or more pools to the specified storage tier.

<pre> qs storage-tier-pool-add|stp-add --tier=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
|   || <tt>pool-list</tt> || List of storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===storage-tier-pool-remove===
Removes one or more pools from the specified storage tier.

<pre> qs storage-tier-pool-remove|stp-remove --tier=value --pool-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tier</tt> || Storage tier is a group of one or more storage pools used to simplify storage provisioning by tier/category/classification.
|-
|   || <tt>pool-list</tt> || List of storage pools.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Software Controller / iSCSI SAN Adapter [SWC]==
Storage Systems may connect to other SANs via iSCSI via the additon of one or more iSCSI Software Adapters/Controllers.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===sw-controller-add===
Adds an iSCSI or NVMe SAN adapter for connecting to the specified iSCSI or NVMe SAN.

<pre> qs sw-controller-add|swc-add --storage-system=value --name=value --ip-address=value --sw-controller-type=value [--desc=value ] [--port=value ] [--chap-user=value ] [--chap-pass=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>port</tt> || Port number for the Software Controller portal, defaults to 3260 if iSCSI, or 4420 if NVMe.
|-
|   || <tt>sw-controller-type</tt> || Protocol type of Software Controller. [*iscsi, nvme-rdma, nvme-tcp]
|-
|   || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|   || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===sw-controller-autoconfig===
Creates all necessary hosts, Storage Volume assignments and iSCSI SAN adapters required to connect the specified systems to the specified Storage Volumes.

<pre> qs sw-controller-autoconfig|swc-autoconfig --system-list=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>volume-list</tt> || List of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===sw-controller-get===
Gets detailed information about a specific software SAN controller.

<pre> qs sw-controller-get|swc-get --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===sw-controller-list===
Returns a list of all the configured software SAN adapter/controllers (iSCSI, etc).

<pre> qs sw-controller-list|swc-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===sw-controller-remove===
Removes the specified iSCSI or NVMe SAN adapter

<pre> qs sw-controller-remove|swc-remove --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===sw-controller-scan===
Scans the specified iSCSI/NVMe SAN adapter for iSCSI/NVMe targets.

<pre> qs sw-controller-scan|swc-scan --sw-controller=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===sw-controller-target===
Returns the specified software controller target.

<pre> qs sw-controller-target|swc-target --target=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>target</tt> || The software controller target to operate against
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===sw-controller-target-list===
Returns a list of all the discovered software controller targets.

<pre> qs sw-controller-target-list|swc-target-list [--sw-controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===sw-controller-target-login===
Logs into the specified targets on the specified iSCSI SAN adapter.

<pre> qs sw-controller-target-login|swc-target-login --sw-controller=value --target-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>target-list</tt> || The list of targets for the software controller to operate against
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===sw-controller-target-logout===
Logs out of the specified targets on the specified iSCSI SAN adapter.

<pre> qs sw-controller-target-logout|swc-target-logout --sw-controller=value --target-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>target-list</tt> || The list of targets for the software controller to operate against
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===sw-disk-session===
Returns the specified software disk session.

<pre> qs sw-disk-session|swc-session --session=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>session</tt> || The software disk session to operate against
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===sw-disk-session-list===
Returns a list of all software disk sessions.

<pre> qs sw-disk-session-list|swc-session-list [--sw-controller=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>sw-controller</tt> || Specifies the name or ID of a software SAN controller instance.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Storage System Management [SYSTEM]==
Commands for managing all the appliance centric settings including NTP, DNS servers, hostname, ARP policies, system restart, shutdown and more.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===enter-system-maintenance===
Set the Storage System(s) in Maintenance mode.

<pre> qs enter-system-maintenance|en-maint --system-list=value [--enter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>enter</tt> || Flags to be passed to set one or more subsystems in the Storage System(s) in Maintenance Mode. [*all, ceph, corosync]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===exit-system-maintenance===
Get the Storage System(s) out of Maintenance mode.

<pre> qs exit-system-maintenance|ex-maint --system-list=value [--exit=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>exit</tt> || Flags to be passed to move one or more subsystem in the Storage System(s) out of Maintenance Mode. [*all, ceph, corosync]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===system-beacon===
Activates system LED beacon and produces an audible beep pattern for the specified duration to help physically identify a given Storage System within the environment.

<pre> qs system-beacon|sys-beep [--duration-sec=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>duration-sec</tt> || Total time duration in seconds to sustain the system audible beep pattern.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===system-get===
Get general information about the Storage System.

<pre> qs system-get|sys-get [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===system-list===
Returns a list of all the managed Storage Systems. This is always a single system unless the system is a member of a management grid.

<pre> qs system-list|sys-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===system-metadata-recovery-point-list===
Returns a list of all the available system metadata recovery points. Recovery points allow you to restore system information such as network, host, users, and other system information from a prior automatic backup.

<pre> qs system-metadata-recovery-point-list|smrp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===system-modify===
Modifies the name and/or description of the Storage System.

<pre> qs system-modify|sys-modify --storage-system=value [--name=value ] [--desc=value ] [--location=value ] [--enclosure-layout=value ] [--domain-suffix=value ] [--search=value ] [--arp-filter-mode=value ] [--bond-mode=value ] [--ext-hostname=value ] [--grid-port=value ] [--ntp-servers=value ] [--dns-servers=value ] [--multipath-autoconfig=value ] [--hw-auto-maintenance=value ] [--log-collection=value ] [--eth-naming=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--service-option=value ] [--disable-io-fencing=value ] [--wwn-emulation=value ] [--proxy-url-http=value ] [--proxy-url-https=value ] [--proxy-url-noproxy=value ] [--enable-telemetry=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>name</tt> || Storage system host name may include any alpha-numeric and hyphen '-' characters per IETF format requirements.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>location</tt> || Optional description indicating the location of the Storage System.
|-
|   || <tt>enclosure-layout</tt> || Enclosure layout for an enclosure within a hardware controller.
|-
|   || <tt>domain-suffix</tt> || The domain name suffix for your network such as example.com
|-
|   || <tt>search</tt> || The default domain search suffix for your network such as example.com
|-
|   || <tt>arp-filter-mode</tt> || ARP filtering should be enabled when you have more than one network card on the same network. [*auto, disabled, enabled]
|-
|   || <tt>bond-mode</tt> || Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer23, lacp-layer34, *round-robin]
|-
|   || <tt>ext-hostname</tt> || Specifies the external hostname for the system. This is useful for creating grids of systems in the cloud like in Amazon's EC2.
|-
|   || <tt>grid-port</tt> || Designated port for grid communication
|-
|   || <tt>ntp-servers</tt> || Comma delimited list of NTP servers to assign to the appliance.
|-
|   || <tt>dns-servers</tt> || Comma delimited list of DNS servers to assign to the appliance.
|-
|   || <tt>multipath-autoconfig</tt> || When enabled, multipathing is automatically configured for devices that support it. [disabled, enabled]
|-
|   || <tt>hw-auto-maintenance</tt> || Flags to be passed to set one or more automatic repair modes in the Storage System's storage resources. [*none, osd, pool]
|-
|   || <tt>log-collection</tt> || When enabled logs are sent periodically for automatic analysis. [biweekly, monthly, never, weekly]
|-
|   || <tt>eth-naming</tt> || Applies either Predictable (Predictable Network Interface Naming/PNIN) port naming convention (ensN, enoN, enpN) or Unified (ethN) port naming convention. Unified (ethN) based naming is the preferred mode as it applies a consistent naming across systems which is needed for highly available cluster VIF management. [*nochange, predictable, unified]
|-
|   || <tt>protocol-block</tt> || The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from the block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
|-
|   || <tt>protocol-block-reset</tt> || Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
|-
|   || <tt>service-option</tt> || The service manager that needs to be blocked specified as 'disk-beacon-management,passthru'. Prepend with tilde (~) to remove from the block list. Managers already blocked will remain blocked. [disable-disk-beacon-management, disable-passthru-manager, *none]
|-
|   || <tt>disable-io-fencing</tt> || Disables all I/O fencing operations on the system for all media devices. This should only be used on systems used in scale-out configurations and not scale-up HA pool configurations which require the I/O fencing system.
|-
|   || <tt>wwn-emulation</tt> || Enables FC WWN emulation and device naming mode to emulate 3rd party SANs. [ibm_storwize, *none, osnexus_ieee, pure_flasharray]
|-
|   || <tt>proxy-url-http</tt> || HTTP proxy server URL
|-
|   || <tt>proxy-url-https</tt> || HTTPS proxy server URL
|-
|   || <tt>proxy-url-noproxy</tt> || Space delimited list of FQDNs, hosts and IPs to not proxy.
|-
|   || <tt>enable-telemetry</tt> || Enables or disables telemetry for the storage system.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===system-ping===
Returns the name, ID, and version of the system without authentication to support discovery services.

<pre> qs system-ping|sys-ping [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===system-platform-event===
Signal the service with an event.

<pre> qs system-platform-event|sys-pe --event-type=value --event-message=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>event-type</tt> || The class of event that is being signaled.
|-
|   || <tt>event-message</tt> || The message/key of the event to signal.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===system-restart===
Restarts the entire Storage System.

<pre> qs system-restart|sys-restart --system-list=value --reason=value [--yes-i-really-mean-it=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>reason</tt> || Reason for the shutdown/restart of the Storage System(s) to be recorded in the audit log.
|-
|   || <tt>yes-i-really-mean-it</tt> || Confirms that user is sure they want to execute operation
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===system-shutdown===
Shutdown the Storage System.

<pre> qs system-shutdown|sys-shutdown --system-list=value --reason=value [--service-only=value ] [--yes-i-really-mean-it=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>service-only</tt> || Shutdown just the management service and not the system.
|-
|   || <tt>reason</tt> || Reason for the shutdown/restart of the Storage System(s) to be recorded in the audit log.
|-
|   || <tt>yes-i-really-mean-it</tt> || Confirms that user is sure they want to execute operation
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===system-signal-manager===
Send signal to named manager module.

<pre> qs system-signal-manager|sys-sigmgr --manager-class=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>manager-class</tt> || The code/identifier of the manager to receive the signal. [alua, blink, ceph, disk, fabric, firewall, gridsync, ha, haconn, hardware, hotspare, infiniband, pool, replication, sed, sharenamespace, smart, stats, targetport]
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===system-upgrade===
Upgrade to the latest version of the core packages.

<pre> qs system-upgrade|upgrade [--system-list=value ] [--include-kernel=value ] [--distro-upgrade=value ] [--allow-reboot=value ] [--core-only=value ] [--ceph-upgrade=value ] [--timeout-padding-sec=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>system-list</tt> || List of one or more Storage Systems.
|-
|   || <tt>include-kernel</tt> || Include kernel and driver updates (default=false)
|-
|   || <tt>distro-upgrade</tt> || Perform a distribution upgrade (default=false)
|-
|   || <tt>allow-reboot</tt> || Allow reboots to occur automatically when one is required.
|-
|   || <tt>core-only</tt> || Only upgrade the core Service and WUI/Manager packages.
|-
|   || <tt>ceph-upgrade</tt> || Set this option to upgrade Ceph daemons for the given cluster members.
|-
|   || <tt>timeout-padding-sec</tt> || Long running ceph upgrades have a potential timeout. To increase timeout, use this argument to increase the default timeout value by a number of seconds.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===timezone-list===
Lists all the available time zones from the system time zone table.

<pre> qs timezone-list|tz-list [--storage-system=value ] [--search-filter=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>search-filter</tt> || Filter the results of the time zone list to match the specified search string.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===timezone-set===
Sets the time zone for the specified storage appliance.

<pre> qs timezone-set|tz-set --timezone=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>timezone</tt> || System time zone, for example 'America/Los_Angeles'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-get===
Returns the value of a specific tunable for the specified system.

<pre> qs tunable-get|sst-get --tunable=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list, provide a comma delimited list in the format key:value,key:value,...
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===tunable-list===
Returns a list of all the system performance tuning which can be used to adjust cache and other settings for specific use cases.

<pre> qs tunable-list|sst-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-profile-apply===
Applies the specified Storage System tuning profile.

<pre> qs tunable-profile-apply|sstp-apply --tunable-profile=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-profile-create===
Creates a new Storage System tuning profile with the specified list of tunings.

<pre> qs tunable-profile-create|sstp-create --name=value --desc=value --tunable=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list, provide a comma delimited list in the format key:value,key:value,...
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-profile-delete===
Deletes the specified Storage System tuning profile.

<pre> qs tunable-profile-delete|sstp-delete --tunable-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-profile-get===
Returns information about the specified profile.

<pre> qs tunable-profile-get|sstp-get --tunable-profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===tunable-profile-list===
Returns a list of all the Storage System tuning profiles.

<pre> qs tunable-profile-list|sstp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-profile-modify===
Modifies the specified Storage System tuning profile.

<pre> qs tunable-profile-modify|sstp-modify --tunable-profile=value [--name=value ] [--desc=value ] [--tunable=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>tunable-profile</tt> || Storage system tunable profiles are a collection of tunable settings that are applied as a set to meet the requirements of a specific system, application, and/or workload.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list, provide a comma delimited list in the format key:value,key:value,...
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tunable-set===
Sets the value of a specific tunable for the specified system.

<pre> qs tunable-set|sst-set --tunable=value [--storage-system=value ] [--tunable-option=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>tunable-option</tt> || Options for setting or resetting all tunables for a given need like IOPS, resilvering, and system defaults. [*none, reset]
|-
|   || <tt>tunable</tt> || A Storage System tunable setting for adjusting various performance settings. When setting a series of tunables in a list, provide a comma delimited list in the format key:value,key:value,...
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Storage System Replication Link Management [SYSTEM-LINK]==
Storage System Links are a required prerequisite before remote-replication and replication schedules can be formed to move data between any given pair of appliances in a grid.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===replication-link-create===
Create a new Storage System Replication Link so that Storage Volumes may be replicated between Storage Systems.

<pre> qs replication-link-create|rl-create --storage-system=value --remote-system=value --local-ip=value --remote-ip=value [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>remote-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>local-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>remote-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>bw-limit</tt> || Limits the replication bandwidth between two Storage Systems to a set level specified in units of megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
|-
|   || <tt>compression</tt> || Links always transmit data on-the-wire using fast compression (zip based)
|-
|   || <tt>encryption</tt> || Links always transmit data on-the-wire with AES-256 bit encryption by default
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replication-link-delete===
Delete an existing replication link.

<pre> qs replication-link-delete|rl-delete --link=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>link</tt> || Storage system link ID or name.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===replication-link-get===
Get information about the replication link.

<pre> qs replication-link-get|rl-get --link=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>link</tt> || Storage system link ID or name.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===replication-link-list===
List the existing replication links.

<pre> qs replication-link-list|rl-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===replication-link-modify===
Modify the properties of the replication link.

<pre> qs replication-link-modify|rl-modify --link=value --remote-ip=value [--local-ip=value ] [--bw-limit=value ] [--compression=value ] [--encryption=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>link</tt> || Storage system link ID or name.
|-
|   || <tt>local-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>remote-ip</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>bw-limit</tt> || Limits the replication bandwidth between two Storage Systems to a set level specified in units of megabytes per second (MB/sec). All replication activity using the specified link will be evenly load balanced to a sum total throughput of the specified value. Specify 0 to indicate to use the default limit which is 100MB/sec.
|-
|   || <tt>compression</tt> || Links always transmit data on-the-wire using fast compression (zip based)
|-
|   || <tt>encryption</tt> || Links always transmit data on-the-wire with AES-256 bit encryption by default
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Tag/Object Property Management [TAG]==
Feature which allows any object within the Storage System/Grid to be tagged with user custom properties (key/value pairs). Tagging is often used to facilitate multi-tenancy deployments by applying tags containing unique IDs which identify users, customers, account, tenants and more.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===tag-delete===
Deletes a specific tag on a specific object.

<pre> qs tag-delete|prop-delete --object-id=value --tag=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
|   || <tt>tag</tt> || Name of the tag/key for the object property. Tags are used to add custom user metadata to objects which is especially important for multi-tenant environments.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tag-get===
Returns information on a specific tag on a specific object.

<pre> qs tag-get|prop-get --object-id=value --tag=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
|   || <tt>tag</tt> || Name of the tag/key for the object property. Tags are used to add custom user metadata to objects which is especially important for multi-tenant environments.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tag-list===
Lists all the tags for the object with the specified object UUID.

<pre> qs tag-list|prop-list --object-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===tag-set===
Adds a new tag/property to the specified object, use a value of hyphen '-' to clear a previously set value.

<pre> qs tag-set|prop-set --object-id=value --tag=value --value=value [--value-type=value ] [--object-type=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-id</tt> || UUID of the object to associate the tag with.
|-
|   || <tt>tag</tt> || tag
|-
|   || <tt>value</tt> || value
|-
|   || <tt>value-type</tt> || value-type [float, int, *string, time]
|-
|   || <tt>object-type</tt> || object-type [alert, disk, host, host-group, pool, port, service-config, share, task, user, user-group, *volume]
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Network Interface Management [TARGET-PORT]==
Commands for configuration, management and monitoring of network ports, teaming/bonding, VLAN configuration and more.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===bonded-interface-create===
Creates a bonded network interface by bonding/teaming together a group of one or more physical network ports.

<pre> qs bonded-interface-create|bond-create --ip-address=value --port-list=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--desc=value ] [--bond-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>port-list</tt> || List of target ports to be bonded together.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
|   || <tt>gateway</tt> || IP address of the network gateway
|-
|   || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>bond-mode</tt> || Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer23, lacp-layer34, *round-robin]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===bonded-interface-delete===
Deletes the specified bonded network interface.

<pre> qs bonded-interface-delete|bond-delete --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===client-connection-list===
Lists all active client connections to the specified system.

<pre> qs client-connection-list|ccon-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===fiber-channel-port-disable===
Disables the specified fiber channel port.

<pre> qs fiber-channel-port-disable|fcp-disable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===fiber-channel-port-enable===
Enables the specified fiber channel port.

<pre> qs fiber-channel-port-enable|fcp-enable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===fiber-channel-port-get===
Returns information about the specified fiber channel target port.

<pre> qs fiber-channel-port-get|fcp-get --port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===fiber-channel-port-issuelip===
Sends a FC LIP command to the specified fibre channel port to force a rediscovery of LUNs / Storage Volumes.

<pre> qs fiber-channel-port-issuelip|fcp-issuelip --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===fiber-channel-port-list===
Returns a list of all the fiber channel target ports in the system.

<pre> qs fiber-channel-port-list|fcp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===infiniband-port-get===
Returns information about the specified Infiniband port.

<pre> qs infiniband-port-get|ibp-get --port=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===infiniband-port-list===
Returns a list of all the Infiniband ports in the system.

<pre> qs infiniband-port-list|ibp-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===network-port-disable===
Disables the specified target port.

<pre> qs network-port-disable|np-disable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===network-port-enable===
Enables the specified target port.

<pre> qs network-port-enable|np-enable --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===network-port-get===
Returns information about the specified target port.

<pre> qs network-port-get|np-get --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force, min]
|}

===network-port-hide===
Hides the specified target port.

<pre> qs network-port-hide|np-hide --port=value [--hide=value ] [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>hide</tt> || Hide the specified object from the WUI/Manager.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===network-port-list===
Returns a list of all the target ports in the system.

<pre> qs network-port-list|np-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===network-port-modify===
Modifies target port settings including IP address, gateway, mtu, etc.

<pre> qs network-port-modify|np-modify --port=value [--port-type=value ] [--storage-system=value ] [--ip-address=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--iscsi-enable=value ] [--nvmeof-enable=value ] [--lossless-networking-enabled=value ] [--auto-tune=value ] [--desc=value ] [--bond-mode=value ] [--protocol-block=value ] [--protocol-block-reset=value ] [--protocol-allow=value ] [--protocol-allow-reset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of a target port, or 'all' to modify all ports.
|-
|   || <tt>port-type</tt> || Port configuration type. (static, dhcp)
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
|   || <tt>gateway</tt> || IP address of the network gateway
|-
|   || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
|   || <tt>iscsi-enable</tt> || Enables or disables iSCSI access to the specified port(s).
|-
|   || <tt>nvmeof-enable</tt> || Enables or disables NVMeoF TCP access to the specified port(s).
|-
|   || <tt>lossless-networking-enabled</tt> || Enables or disables lossless networking for Melanox ports.
|-
|   || <tt>auto-tune</tt> || Enables automatic configuration of the RX/TX buffers to maximize throughput for large block I/O and replication.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>bond-mode</tt> || Round-robin balancing is the default mode but if you are using bonding across switches you must use LACP and have switch infrastructure that supports it. [active-backup, balance-alb, balance-tlb, balance-xor, lacp, lacp-layer23, lacp-layer34, *round-robin]
|-
|   || <tt>protocol-block</tt> || The protocol that needs to be blocked specified as 'nfs,smb'. Prepend with tilde (~) to remove from the block list. Protocols already blocked will remain blocked. To reset the block list, use 'protocol-block-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
|-
|   || <tt>protocol-block-reset</tt> || Reset the protocol block list. Any values provided in the argument protocol-block will be ignored.
|-
|   || <tt>protocol-allow</tt> || The protocol that needs to be allowed specified as 'nfs,smb'. prepend with tilde (~) to remove from the allow list. Protocols already allowed will be retained. To reset the allow list, use 'protocol-allow-reset' argument. [ceph, chronograf, ganesha, iscsi, *nfs, nvmeof, restapi, smb, webui]
|-
|   || <tt>protocol-allow-reset</tt> || Reset the protocol allow list. Any values provided in the argument protocol-allow will be ignored.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===network-port-rename===
Creates a systemd link file to rename target port.

<pre> qs network-port-rename|np-rename --port=value --name=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>name</tt> || New name to assign to target port. It is suggested to have a static network management port with the naming prefix 'mgmt'. Avoid using the naming prefix 'eth' as it may cause naming conflicts with kernel drivers. Network interfaces are typically enumerated from a 0 index e.g. eno[0,1,2,...]
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===network-port-rescan===
Discovers new target ports and/or any manual modifications made to the configuration of the target ports.

<pre> qs network-port-rescan|np-rescan [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===network-port-restart===
Restarts the specified target port.

<pre> qs network-port-restart|np-restart --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or MAC address of the target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===provider-app-get===
Get the registered provider information.

<pre> qs provider-app-get|prov-app-get --provider-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>provider-type</tt> || Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, seagate-lyve, sftp, swift, wasabi-s3]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force]
|}

===provider-app-list===
List the registered providers.

<pre> qs provider-app-list|prov-app-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===provider-app-register===
Register a provider.

<pre> qs provider-app-register|prov-app-register --provider-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>provider-type</tt> || Provider type to register. [aws-s3, azure, backblaze-b2, *ceph-s3, dropbox, google, google-drive, ibm-cos, seagate-lyve, sftp, swift, wasabi-s3]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===provider-app-unregister===
Unregister a provider.

<pre> qs provider-app-unregister|prov-app-unregister [--provider-app=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>provider-app</tt> || Provider to unregister.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===service-firewall-definition-list===
List the firewall definitions for the services

<pre> qs service-firewall-definition-list|src-firewall-df-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===static-route-create===
Creates a new network static route for connecting to other networks.

<pre> qs static-route-create|sr-create --port=value --destination-ip-address=value --destination-netmask=value --gateway-ip-address=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|   || <tt>destination-ip-address</tt> || Destination IP address for the static route.
|-
|   || <tt>destination-netmask</tt> || Destination subnet mask for the static route.
|-
|   || <tt>gateway-ip-address</tt> || Gateway IP address for the static route
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===static-route-delete===
Deletes the specified static route identified by its UUID.

<pre> qs static-route-delete|sr-delete --route-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>route-id</tt> || UUID of a static route object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===static-route-get===
Returns information on a specific static route.

<pre> qs static-route-get|sr-get --route-id=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>route-id</tt> || UUID of a static route object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===static-route-list===
Returns a list of all the static routes.

<pre> qs static-route-list|sr-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===storage-system-capabilities-list===
List the Storage System capabilities.

<pre> qs storage-system-capabilities-list|sys-capabilities-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===virtual-interface-create===
Creates a new virtual network interface which is linked to a physical network port.

<pre> qs virtual-interface-create|vif-create --parent-port=value --ip-address=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--mtu=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>parent-port</tt> || Port that the virtual interface should initially be attached to.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
|   || <tt>gateway</tt> || IP address of the network gateway
|-
|   || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===virtual-interface-delete===
Deletes the specified virtual network interface.

<pre> qs virtual-interface-delete|vif-delete --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===vlan-interface-create===
Creates a new VLAN interface on the specified physical port.

<pre> qs vlan-interface-create|vlan-create --parent-port=value --ip-address=value --vlan-id=value [--storage-system=value ] [--netmask=value ] [--gateway=value ] [--vlan-qos=value ] [--mtu=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>parent-port</tt> || Port that the virtual interface should initially be attached to.
|-
|   || <tt>ip-address</tt> || IP Address of the host being added; if unspecified the service will look it up.
|-
|   || <tt>vlan-id</tt> || VLAN ID (typically 1-255)
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>netmask</tt> || Subnet IP mask (ex: 255.255.255.0)
|-
|   || <tt>gateway</tt> || IP address of the network gateway
|-
|   || <tt>vlan-qos</tt> || VLAN Quality of Service (QoS) can be in the range of 0 (lowest, default) to 7 (highest) and represents the Class of Service (CoS) user priority of the VLAN traffic.
|-
|   || <tt>mtu</tt> || Maximum transmission unit (MTU) for the target port, commonly set to 9000 to enable jumbo frames.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===vlan-interface-delete===
Deletes the specified VLAN interface.

<pre> qs vlan-interface-delete|vlan-delete --port=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>port</tt> || Name or unique ID of a network port/target port.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Task Management [TASK]==
Every configuration operation done within an appliance or across a group of appliances is represented in the system as a Task. Some long running tasks can be canceled while running and all tasks from all systems in a grid are visible and monitorable from all appliances.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===task-cancel===
Cancels the specified task that is in the queue or is running.

<pre> qs task-cancel|t-cancel --task=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>task</tt> || ID of a task.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===task-clear-all===
Clears all the completed and/or failed tasks from the task log so that only the running and queued tasks (if any) remain.

<pre> qs task-clear-all|t-clear-all [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===task-get===
Returns information about the specified task.

<pre> qs task-get|t-get --task=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>task</tt> || ID of a task.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===task-list===
Returns a list of all the Tasks including active, completed, and failed tasks. Whenever you run a command in the Storage Grid it is queued in the internal Task Manager and then executed automatically once the necessary resource locks are acquired.

<pre> qs task-list|t-list [--filtered=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>filtered</tt> || Returns just the 'value' most recently created.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===task-lock-list===
Returns a list of internal task object locks for the specified storage system.

<pre> qs task-lock-list|tl-list [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===task-lock-release===
Releases the specified internal task object locks on the specified storage system (internal support use only, --force flag required).

<pre> qs task-lock-release|tl-release --task=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>task</tt> || ID of a task.
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [force]
|}

===task-proceed===
Some tasks (e.g., volume-snapshot) can wait for a signal part-way through the task before proceeding. In the case of volume snapshot tasks this can be used to shorten the snapshot quiesce window.

<pre> qs task-proceed|t-proceed --task=value [--wait-for-signal=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>task</tt> || ID of a task.
|-
|   || <tt>wait-for-signal</tt> || Some tasks (volume-snapshot) have the ability to wait for a signal at a key point before proceeding. To signal the task to proceed once started use 'task-proceed'.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Trace Level Management [TRACE-LEVEL]==
Debugging facility used to increase the amount of information sent to the /var/log/qs_service.log
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===event-pulse===
Updates object timestamps of the specified type for the specified system to induce event traffic in the grid for testing purposes.

<pre> qs event-pulse|e-pulse --object-type=value [--storage-system=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>object-type</tt> || Type of the object to associate the tag with. [alert, disk, host, host-group, pool, port, service-config, share, task, user, user-group, *volume]
|-
|   || <tt>storage-system</tt> || Name or ID of a Storage System in a management grid.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, dry-run-only, force, forget-missing, min, *none]
|}

===trace-level-get===
Get the current trace level that is being used for logging.

<pre> qs trace-level-get|tl-get [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===trace-level-modify===
Modify the current parameters used for logging.

<pre> qs trace-level-modify|tl-modify [--trace-level=value ] [--stdout=value ] [--trace-filter=value ] [--verbose-filter=value ] [--trace-options=value ] [--event-verbose-filter=value ] [--memory-tracking-option=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>trace-level</tt> || This is the trace level you would like the system to use for logging. [always, critical, debug, debug2, *error, info, verbose, warning]
|-
|   || <tt>stdout</tt> || Whether or not the traces should also be logged to stdout
|-
|   || <tt>trace-filter</tt> || Specific classes that you would like to have elevated trace levels. Comma-delimited list of classes, containing optional colon-delimited function names. For example: 'service/osn_foo_util.cpp,service/osn_service_foo.cpp:func1:func2'
|-
|   || <tt>verbose-filter</tt> || Specific classes that you would like to have verbose elevated trace levels. Comma-delimited list of classes, containing optional colon-delimited function names. For example: 'service/osn_bar_util.cpp,service/osn_service_bar.cpp:funcA:funcB'
|-
|   || <tt>trace-options</tt> || Specific options for tracing [db-report,trace-report,alert-report,correlation-report,correlation-hw-report,poolcollector-report,poolcollector-clear,touchfiles,enable-cpuinfo,disable-cpuinfo,enable-meminfo,disable-meminfo,enable-calllog,disable-calllog,enable-eventlog,disable-eventlog,enable-execlog,disable-execlog,enable-volsessionlog,disable-volsessionlog,executing,enable-delta-ObjectType,disable-delta-ObjectType,lock-manager-report]
|-
|   || <tt>event-verbose-filter</tt> || Specific object types that you would like to have verbose event logging levels. Comma-delimited list of object types, containing optional colon-delimited event types. For example: 'HwEnclosure:modify:add'
|-
|   || <tt>memory-tracking-option</tt> || Memory tracking option [list-all-managers, enable-periodic-mem-tracking (for all managers), disable-periodic-mem-tracking (for all managers), mem-report-<manager-name>, mem-clear-<manager-name>]
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==User Management [USER]==
User management within an appliance is used both to facilitate access to appliance management operations as well as to create local user accounts to provide SMB access to Network Shares. Use the System Monitor role to limit users so that they cannot change the configuration of any aspect of the system except their own password.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===user-add===
Adds a new management User account to the Storage System/Grid. A matching console level account is created on all grid nodes but by default SSH access is blocked. Rather, management accounts enable the use of qs CLI commands and web management interface access as per the limits of the User's assigned Role.

<pre> qs user-add|u-add --name=value --password=value --role=value [--first-name=value ] [--last-name=value ] [--email=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--uid=value ] [--gid=value ] [--cli-auth=value ] [--specified-alerts=value ] [--alerts=value ] [--account-type=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--hours-term=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || User names may include any alpha-numeric plus '_' and '-' characters; spaces are not allowed.
|-
|   || <tt>password</tt> || Password for the user to use when accessing the Storage System via the web management interface, qs CLI, or REST API.
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>first-name</tt> || User's first name: enclosed in double-quotes if it contains spaces.
|-
|   || <tt>last-name</tt> || User's last name: enclosed in double-quotes if it contains spaces.
|-
|   || <tt>email</tt> || An email address of the form 'user@example.com' without the quotes.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>default-chap-user</tt> || Default CHAP username for Storage Volumes owned by a user account which have the CHAP policy set to 'use user default CHAP settings'
|-
|   || <tt>default-chap-pass</tt> || Default CHAP password for Storage Volumes owned by a user account which have the CHAP policy set to 'use user default CHAP settings'
|-
|   || <tt>uid</tt> || POSIX user ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
|-
|   || <tt>gid</tt> || POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|-
|   || <tt>cli-auth</tt> || Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management User account.
|-
|   || <tt>specified-alerts</tt> || Comma-separated list of specific alert type IDs or ranges (e.g. '1-5,7,9') the user is subscribed to. If left empty, all alerts matching the user's specified severity are still sent. Alerts are sent to the user's email address automatically when a SMTP server is configured.
|-
|   || <tt>alerts</tt> || Alert types to subscribe to. Alerts at the subscribed level are sent to the user's email address automatically when a SMTP server is configured. [critical, error, info, *none, warning]
|-
|   || <tt>account-type</tt> || Specifies the account type where standard accounts are the default and emergency/temporary account types are for short-term special situations (see NIST 800-53). These accounts automatically terminate after a specified number of hours. [emergency, *standard, temporary]
|-
|   || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|   || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
|   || <tt>hours-term</tt> || Hours until the account is auto-terminated. On termination emergency accounts are locked and temporary accounts are removed/deleted. Unlocking a locked emergency account will add 24 hours to the termination date.
|-
|   || <tt>enable-mfa</tt> || Enable Multi Factor Authentication for this user at login.
|-
|   || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===user-app-token-add===
Adds a user app token.

<pre> qs user-app-token-add|u-app-tkn-add --user=value [--name=value ] [--app-key=value ] [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>app-key</tt> || Application provider key
|-
|   || <tt>date-token-expires</tt> || Date on which the token expires.
|-
|   || <tt>read-only-token</tt> || User app token is read only. Default is read/write
|-
|   || <tt>user-app-token-access-mode</tt> || User app token access mode. [Token File All-nodes, *Token File Disabled, Token File Local-only, Token File Remote-only]
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===user-app-token-delete===
Removes a user app token.

<pre> qs user-app-token-delete|u-app-tkn-delete --user-app-token=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-app-token</tt> || User app token.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===user-app-token-get===
Gets information about the specified user app token.

<pre> qs user-app-token-get|u-app-tkn-get --user-app-token=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-app-token</tt> || User app token.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===user-app-token-list===
Returns a list of user app tokens.

<pre> qs user-app-token-list|u-app-tkn-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===user-app-token-regen===
Regenerates a user app token.

<pre> qs user-app-token-regen|u-app-tkn-regen --user-app-token=value [--date-token-expires=value ] [--read-only-token=value ] [--user-app-token-access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-app-token</tt> || User app token.
|-
|   || <tt>date-token-expires</tt> || Date on which the token expires.
|-
|   || <tt>read-only-token</tt> || User app token is read only. Default is read/write
|-
|   || <tt>user-app-token-access-mode</tt> || User app token access mode. [Token File All-nodes, *Token File Disabled, Token File Local-only, Token File Remote-only]
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===user-generate-otp-auth-secret===
Generate One-Time-Password (OTP) Authorization secret for the specified user

<pre> qs user-generate-otp-auth-secret|u-generate-otp-auth-secret --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===user-get===
Gets information about the specified user.

<pre> qs user-get|u-get --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===user-list===
Returns a list of all the users.

<pre> qs user-list|u-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===user-modify===
Modifies the specified user name, multi-factor authentication settings, role, and/or description.

<pre> qs user-modify|u-modify --user=value [--role=value ] [--desc=value ] [--default-chap-user=value ] [--default-chap-pass=value ] [--otp-secret-key=value ] [--uid=value ] [--gid=value ] [--lock-account=value ] [--cli-auth=value ] [--alerts=value ] [--specified-alerts=value ] [--disable-wui-tabs=value ] [--disable-wui-sections=value ] [--enable-mfa=value ] [--mfa-config=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>role</tt> || Name of a security role or its unique ID (GUID).
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>default-chap-user</tt> || Default CHAP username for Storage Volumes owned by a user account which have the CHAP policy set to 'use user default CHAP settings'
|-
|   || <tt>default-chap-pass</tt> || Default CHAP password for Storage Volumes owned by a user account which have the CHAP policy set to 'use user default CHAP settings'
|-
|   || <tt>otp-secret-key</tt> || One-Time-Password (OTP) for multifactor authentication.
|-
|   || <tt>uid</tt> || POSIX user ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this UID.
|-
|   || <tt>gid</tt> || POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|-
|   || <tt>lock-account</tt> || Set to 'true' to lock the account, 'false' to unlock the user account.
|-
|   || <tt>cli-auth</tt> || Enables the 'root' user account within a Storage System to use "[QSCLITKN]" token based password authentication for a given Management User account.
|-
|   || <tt>alerts</tt> || Alert types to subscribe to. Alerts at the subscribed level are sent to the user's email address automatically when a SMTP server is configured. [critical, error, info, *none, warning]
|-
|   || <tt>specified-alerts</tt> || Comma-separated list of specific alert type IDs or ranges (e.g. '1-5,7,9') the user is subscribed to. If left empty, all alerts matching the user's specified severity are still sent. Alerts are sent to the user's email address automatically when a SMTP server is configured.
|-
|   || <tt>disable-wui-tabs</tt> || Disables specified tabs in the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [cloud-containers, cluster-resource-mgmt, multitenancy, *none, remote-replication, scaleout-nas-mgmt, scaleout-object-mgmt, users-groups]
|-
|   || <tt>disable-wui-sections</tt> || Disables specified expandable sections in the left-hand side of the web management interface. This is useful for hiding unused features and/or simplifying the user interface for administrators assigned with specific tasks. [hardware, hosts, network-shares, *none, physical-disks, snapshot-schedules, storage-pools, storage-volumes]
|-
|   || <tt>enable-mfa</tt> || Enable Multi Factor Authentication for this user at login.
|-
|   || <tt>mfa-config</tt> || Name or ID of a multi-factor authentication configuration.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===user-password-set===
Changes the password for the specified user

<pre> qs user-password-set|passwd --user=value --new-password=value [--old-password=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>new-password</tt> || New password for the User.
|-
|   || <tt>old-password</tt> || Old password for the User.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===user-remove===
Removes the specified user identified by name or ID.

<pre> qs user-remove|u-remove --user=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user</tt> || Name or ID (GUID) of an existing user.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===user-search===
Searches for users given the specified search filter params and optional offset/max results.

<pre> qs user-search|u-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the bucket List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>max-results</tt> || Maximum number of results to return for the given search parameters.
|-
|   || <tt>offset</tt> || Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force]
|}

</div>
</div>

==User Group Management [USER-GROUP]==
Users can be grouped together to simplify management of Resource Groups.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===user-group-create===
Creates a new storage user group composed of the specified users.

<pre> qs user-group-create|ug-create --name=value [--user-list=value ] [--desc=value ] [--flags=value ] [--gid=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>user-list</tt> || A list of one or more users.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|   || <tt>gid</tt> || POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|}

===user-group-delete===
Deletes a storage user group, the users are not deleted unless the delete-users flag is set.

<pre> qs user-group-delete|ug-delete --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===user-group-get===
Returns information about a specific storage user group.

<pre> qs user-group-get|ug-get --user-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===user-group-list===
Returns a list of all the storage user groups.

<pre> qs user-group-list|ug-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===user-group-modify===
Modifies the name and/or description of a storage user group.

<pre> qs user-group-modify|ug-modify --user-group=value [--name=value ] [--desc=value ] [--gid=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>gid</tt> || POSIX group ID to be associated with the specified user account. New files and directories created within Network Shares via NFS/SMB by this user will be associated with this GID.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===user-group-search===
Searches for user groups given the specified search filter params and optional offset/max results.

<pre> qs user-group-search|ug-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the bucket List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>max-results</tt> || Maximum number of results to return for the given search parameters.
|-
|   || <tt>offset</tt> || Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force]
|}

===user-group-user-add===
Adds one or more users to the specified user group.

<pre> qs user-group-user-add|ugu-add --user-group=value --user-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>user-list</tt> || A list of one or more users.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===user-group-user-remove===
Removes one or more users from the specified user group

<pre> qs user-group-user-remove|ugu-remove --user-group=value --user-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>user-group</tt> || A group of one or more users.
|-
|   || <tt>user-list</tt> || A list of one or more users.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Storage Volume Management [VOLUME]==
Commands for the management of Storage Volumes which are block devices which can be presented to Hosts via the iSCSI and/or FC protocols.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===volume-clone===
Creates a complete block copy of the source volume.

<pre> qs volume-clone|v-clone --volume=value [--pool=value ] [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>name</tt> || Name for the clone, if not provided the source volume name will be used as a prefix.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-create===
Creates a new Storage Volume in the specified storage pool.

<pre> qs volume-create|v-create --name=value --size=value --pool=value [--desc=value ] [--percent-reserved=value ] [--access-mode=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--count=value ] [--blocksize-kb=value ] [--stripesize-kb=value ] [--stripe-count=value ] [--qos-policy=value ] [--volume-profile=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--reserved=value ] [--unmapped=value ] [--lun=value ] [--ceph-pool-namespace=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>size</tt> || Size may be specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>percent-reserved</tt> || Percentage of the Storage Volume's total size that should be set aside as reserved space deducted from the pool's free-space (default is 0)
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>chap-policy</tt> || CHAP setting can be 'target' which is unique to a Storage Volume, 'user' or 'resource-group' which inherits the chap user/pass from your user account or tenant resource cloud respectively. [cloud-defaults, *disabled, target, user-defaults]
|-
|   || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|   || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|   || <tt>count</tt> || The number of volumes to create, default is 1.
|-
|   || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
|   || <tt>stripesize-kb</tt> || Indicates the stripe unit size for the underlying Ceph RBD.
|-
|   || <tt>stripe-count</tt> || Indicates the number of objects to write to per stripe before returning to the first object.
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>volume-profile</tt> || Storage Volume IO Profile settings used to optimize performance for specific use cases.
|-
|   || <tt>sync</tt> || Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
|-
|   || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|   || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|   || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|   || <tt>copies</tt> || Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
|-
|   || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>unmapped</tt> || Applies only to scale-out (Ceph) block devices, this option disables mapping of the new Storage Volume (RBD) so that it is never connected to the iSCSI/FC/NVMeoF target driver.
|-
|   || <tt>lun</tt> || FC target Logical Unit Number (LUN) to be applied to the specified Storage Volume. LUN numbers are only relevant to FC access as all iSCSI targets have unique IQNs and use LUN 0.
|-
|   || <tt>ceph-pool-namespace</tt> || Ceph Pool Namespace name or ID.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-create-passthru===
Creates a new Storage Volume using a raw device which is simply passed through to form a Storage Volume.

<pre> qs volume-create-passthru|v-create-passthru --name=value --disk-list=value [--desc=value ] [--access-mode=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--blocksize-kb=value ] [--qos-policy=value ] [--volume-profile=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>disk-list</tt> || Comma delimited (no spaces) list of drives to be used for the operation may also include disk names, IDs, Storage System names / IDs, storage pool names / IDs, [all] to select all disks, [nopaths] to indicate no paths of a multipath or encrypted device, [unused] to indicate disks that are available and not in use by pools, [eq:SIZE] such as[eq:10TB] to only select disks of a specific size, [gt:SIZE] to select disks with a SIZE greater than that specified, [lt:SIZE] to indicate disks smaller than SIZE the specified, [spares] or [nospares] to search for or exclude spares, and property filters like[vendor:VVVV], [product:PPPP], and [disktype:N].
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>chap-policy</tt> || CHAP setting can be 'target' which is unique to a Storage Volume, 'user' or 'resource-group' which inherits the chap user/pass from your user account or tenant resource cloud respectively. [cloud-defaults, *disabled, target, user-defaults]
|-
|   || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|   || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|   || <tt>blocksize-kb</tt> || Volume block size in KB, valid values are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024. Larger values deliver higher performance for workloads with high sequential IO. Default value is 8K
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>volume-profile</tt> || Storage Volume IO Profile settings used to optimize performance for specific use cases.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-delete===
Deletes a Storage Volume, *WARNING* any data in the volume will be lost.

<pre> qs volume-delete|v-delete [--volume-list=value ] [--delete-child-snaps-only=value ] [--delete-child-snaps-and-parent=value ] [--search-filter=value ] [--dry-run-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>delete-child-snaps-only</tt> || Deletes the child snapshots of the specified share/volume. Parent share/volume will not be deleted.
|-
|   || <tt>delete-child-snaps-and-parent</tt> || Deletes the child snapshots of the specified share/volume along with the specified parent share/volume.
|-
|   || <tt>search-filter</tt> || Filter the results of the Network Share List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>dry-run-only</tt> || Dry run will not implement any configuration or database changes, only returns a report on the action that --would-- be taken.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-get===
Returns information about a specific Storage Volume.

<pre> qs volume-get|v-get --volume=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===volume-health-check===
Checks the health/state of the volume and recursively checks the health of the associated pool and it's disk devices to see if there are any health issues anywhere in the stack.

<pre> qs volume-health-check|v-check --volume=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===volume-hold-add===
Add a hold on a Storage Volume snapshot to prevent it from getting deleted. Releasing the hold will allow deletion.

<pre> qs volume-hold-add|v-hld-add --volume=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>hold-tag</tt> || Tag identifying the hold.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===volume-hold-remove===
Add a hold on a Storage Volume snapshot to prevent it from getting deleted. Releasing the hold will allow deletion.

<pre> qs volume-hold-remove|v-hld-remove --volume=value [--hold-tag=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>hold-tag</tt> || Tag identifying the hold.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [min]
|}

===volume-list===
Returns a list of all the Storage Volumes.

<pre> qs volume-list|v-list [--snapshots-with-holds-only=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>snapshots-with-holds-only</tt> || Include snapshots with holds in the list
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===volume-modify===
Modifies the name, description or other properties of the Storage Volume.

<pre> qs volume-modify|v-modify --volume=value [--name=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] [--chap-policy=value ] [--chap-user=value ] [--chap-pass=value ] [--enable-wb-cache=value ] [--is-active-checkpoint=value ] [--sync=value ] [--primarycache=value ] [--secondarycache=value ] [--compression-type=value ] [--copies=value ] [--qos-policy=value ] [--volume-profile=value ] [--lun=value ] [--reserved=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|-
|   || <tt>chap-policy</tt> || CHAP setting can be 'target' which is unique to a Storage Volume, 'user' or 'resource-group' which inherits the chap user/pass from your user account or tenant resource cloud respectively. [cloud-defaults, *disabled, target, user-defaults]
|-
|   || <tt>chap-user</tt> || An optional iSCSI CHAP username.
|-
|   || <tt>chap-pass</tt> || An optional iSCSI CHAP password.
|-
|   || <tt>enable-wb-cache</tt> || Enables the write-back cache on the iSCSI target driver, this option uses volatile system RAM for cache and is not recommended.
|-
|   || <tt>is-active-checkpoint</tt> || Network Shares and Storage Volumes marked as an active replica checkpoint cannot be replicated over by replication schedules or the replication system. Use is used to protect a given volume/share in the event of site failover to ensure the source side doesn't overwrite replicas at the DR site which are in use. Note: Checkpoints are automatically marked as active replica checkpoints whenever access is granted to them or they are accessed via a file or block storage session.
|-
|   || <tt>sync</tt> || Synchronization policy to use for handling writes to the storage pool (standard, always, none). standard mode is a hybrid of write-through and write-back caching based on the O_SYNC flag, always mode is write-through to ZIL which could be SSD cache, and disabled indicates to always use async writes. [always, disabled, *standard]
|-
|   || <tt>primarycache</tt> || Sets the cache policy for how ARC (RAM) should be used to cache data and metadata. 'all' indicates both data and metadata should be cached while 'metadata' indicates only metadata should be cached. [all, *auto, metadata, none]
|-
|   || <tt>secondarycache</tt> || Sets the cache policy for how L2ARC (SSD read cache) should be used to cache data and metadata. [all, *auto, metadata, none]
|-
|   || <tt>compression-type</tt> || Type of compression to be used. (on | off | lzjb | gzip | gzip-[1-9] | zle | lz4 | zstd | zstd-fast)
|-
|   || <tt>copies</tt> || Indicates the number of copies of each block should be maintained in the Storage Pool. This is a way of getting duplicates for bit-rot protection on a single device (supported only on ZFS based pools).
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>volume-profile</tt> || Storage Volume IO Profile settings used to optimize performance for specific use cases.
|-
|   || <tt>lun</tt> || FC target Logical Unit Number (LUN) to be applied to the specified Storage Volume. LUN numbers are only relevant to FC access as all iSCSI targets have unique IQNs and use LUN 0.
|-
|   || <tt>reserved</tt> || Amount of thick-provisioned reserved space for a Storage Volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|}

===volume-profile-get===
Gets information about a specific Storage Volume profile.

<pre> qs volume-profile-get|vp-get --profile=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>profile</tt> || Specifies an optional IO optimization profile for the storage pool. Storage pool profiles control elements like read-ahead, queue depth and other device configurable settings.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===volume-profile-list===
Returns a list of all the Storage Volume profiles.

<pre> qs volume-profile-list|vp-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===volume-reassign-schedule===
Reassigns the created by ownership for a volume and optionally it's GMT snapshots to a new replication schedule so that they can be automatically cleaned up by the new schedule.

<pre> qs volume-reassign-schedule|v-reassign-schedule --volume=value --schedule=value [--recursive=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>schedule</tt> || Name or ID of a replication schedule.
|-
|   || <tt>recursive</tt> || Recursively update the GMT snapshots of the specified parent Storage Volume.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-resize===
Re-sizes a Storage Volume to make it larger, volumes cannot be reduced in size.

<pre> qs volume-resize|v-resize --volume=value --new-size=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>new-size</tt> || New larger size for the volume specified in MiB, GiB, or TiB. examples: 4G, 100M, 1.4T
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-restore===
Restores a Storage Volume to a previous point in time using a previously created snapshot. The volume restore process uses a full copy technique which is much slower than the Volume Rollback operation but works with any point-in-time snapshot.

<pre> qs volume-restore|v-restore --volume=value --snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>snapshot</tt> || Name or ID of a snapshot volume to use as the restore point.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-rollback===
Does an instant rollback of a Storage Volume to a previous point-in-time using the most recently created snapshot volume. Rollback only works with the most recently created snapshot. To rollback using an earlier snapshot, all snapshots that were created after the snapshot to be used for rollback must be deleted. For example, volume V1 with snapshots Vt1, Vt2, Vt3 only Vt3 can be used for rollback. To use Vt1 for rollback Vt2 and Vt3 must be deleted first.

<pre> qs volume-rollback|v-rollback --volume=value --snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>snapshot</tt> || Name or ID of a snapshot volume to use as the restore point.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-rollback-clone===
Does an instant rollback of a Storage Volume Clone to it's underlying snapshot.

<pre> qs volume-rollback-clone|v-rollback-clone --snapshot=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>snapshot</tt> || Name or ID of a snapshot volume to use as the restore point.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-search===
Returns a subset of Storage Volumes matching the given criteria.

<pre> qs volume-search|v-search --search-filter=value [--max-results=value ] [--offset=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>search-filter</tt> || Filter the results of the Storage Volume List to match the specified search criteria, in the form "key:value" or "<modifier>key:value" where valid modifiers are '=' (for equal), '~' (for not), '>' (for greater than), '<' (for lesser than), or '*' (for like).
|-
|   || <tt>max-results</tt> || Maximum number of results to return for the given search parameters.
|-
|   || <tt>offset</tt> || Optionally used when maximum number of results is specified, one can offset to a row index to get objects from the grid database incrementally.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, force]
|}

===volume-set-qos===
Sets quality of service (QoS) performance maximums for IOPS and bandwidth for the specified Storage Volume.

<pre> qs volume-set-qos|v-qos --volume=value [--iops-read=value ] [--iops-write=value ] [--bw-read=value ] [--bw-write=value ] [--qos-policy=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>iops-read</tt> || Sets the maximum number of 4K read IOPS (I/O per second) as a Quality of Service (QoS) control on the Storage Volume.
|-
|   || <tt>iops-write</tt> || Sets the maximum number of 4K write IOPS (I/O per second) as a Quality of Service (QoS) control on the Storage Volume.
|-
|   || <tt>bw-read</tt> || Sets the maximum read bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the Storage Volume, 0 (default) indicates unlimited.
|-
|   || <tt>bw-write</tt> || Sets the maximum write bandwidth (e.g., 100MB) per second as a Quality of Service (QoS) control on the Storage Volume, 0 (default) indicates unlimited.
|-
|   || <tt>qos-policy</tt> || Specifies the name or ID of a Quality of Service (QoS) policy. QoS policies limit the throughput and IOPs of a Storage Volume which is especially useful in multi-tenant environments.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-snapshot===
Creates a space efficient copy of the source volume.

<pre> qs volume-snapshot|v-snap --volume=value [--name=value ] [--desc=value ] [--access-mode=value ] [--count=value ] [--lazy-clone=value ] [--wait-for-signal=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>name</tt> || Name for the snapshot, if not provided the source volume name will be used as a prefix.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>count</tt> || The number of snapshots of the specified volume to create, default is 1.
|-
|   || <tt>lazy-clone</tt> || Delays making the snapshot volume writable until it is assigned to a host or modified in some way. This option doesn't save space but does reduce CPU and memory usage load on the system and is recommended if you're not planning to use the snapshot right away.
|-
|   || <tt>wait-for-signal</tt> || Some tasks (volume-snapshot) have the ability to wait for a signal at a key point before proceeding. To signal the task to proceed once started use 'task-proceed'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-snapshot-revert===
Clears all changes to the snapshot by reverting back to the point-in-time of when the snapshot was originally created. WARNING: Any changes made to the snapshot will be lost.

<pre> qs volume-snapshot-revert|v-snap-revert --volume=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-utilization-get===
Returns a specific volume utilization metrics for a single volume and specific date.

<pre> qs volume-utilization-get|vu-get --entry=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>entry</tt> || Specifies the GUID or the name of a volume utilization entry in the form of 'VOLUMENAME:TIMESTAMP'
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===volume-utilization-list===
Returns volume utilization information for a specific Storage Volume or all Storage Volumes if no volume is specified.

<pre> qs volume-utilization-list|vu-list [--volume=value ] [--offset-days=value ] [--num-days=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>offset-days</tt> || Offset N many days back before pulling the utilization metrics.
|-
|   || <tt>num-days</tt> || Number of days of utilization metrics to pull.
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

</div>
</div>

==Storage Volume Access Control (LUN Masking) [VOLUME-ACLS]==
Volume ACLs control which Hosts have access to which Storage Volumes via block protocols like FibreChannel and iSCSI. All Storage Volumes must be assigned before they can be accessed; volumes are never made publically accessible.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===volume-assign===
Enables access to the specific volume from the specified host.

<pre> qs volume-assign|va-add --volume=value --host-list=value [--lun=value ] [--free-unused-luns=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>lun</tt> || FC target Logical Unit Number (LUN) to be applied to the specified Storage Volume. LUN numbers are only relevant to FC access as all iSCSI targets have unique IQNs and use LUN 0.
|-
|   || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume. LUN number assignments only apply to FC access as iSCSI LUNs are always accessed via unique IQN at LUN 0.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===volume-assign-list===
Returns a list of all the volume to host assignments, optionally filtered by host or Storage Volume.

<pre> qs volume-assign-list|va-list [--volume=value ] [--host=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>host</tt> || Name of the host or its unique ID (GUID).
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===volume-unassign===
Disables access to the specific volume from the specified host.

<pre> qs volume-unassign|va-remove --volume=value --host-list=value [--free-unused-luns=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>host-list</tt> || A list of one or more hosts by name or ID.
|-
|   || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume. LUN number assignments only apply to FC access as iSCSI LUNs are always accessed via unique IQN at LUN 0.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===volume-unassign-all===
Disables all access to the specified volume, host, or host group.

<pre> qs volume-unassign-all|va-remove-all --volume=value [--free-unused-luns=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume</tt> || Name of the Storage Volume or its unique ID (GUID).
|-
|   || <tt>free-unused-luns</tt> || Frees up the LUN number assignments for the respective Storage Volumes if there are no more Storage Volume to host assignments. Default is to retain the LUN number assignments making them static so that subsequent reassignment reuses the same LUN number for the Storage Volume. LUN number assignments only apply to FC access as iSCSI LUNs are always accessed via unique IQN at LUN 0.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>

==Storage Volume Group Management [VOLUME-GROUP]==
Storage Volume Groups are a convience feature to grouping together Storage Volumes so that they can be snapshot as a set.
<div class='mw-collapsible'>
<div class='mw-collapsible-content'>

===volume-group-clone===
Creates a complete block by block copy of all volumes in the group.

<pre> qs volume-group-clone|vg-clone --volume-group=value [--pool=value ] [--name-suffix=value ] [--desc=value ] [--access-mode=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>pool</tt> || Name of the storage pool or its unique ID (GUID).
|-
|   || <tt>name-suffix</tt> || Name for the snapshot/clone; if unspecified the snapshot/clone will use the original name with '_snapNN'/'_cloneNN' appended.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-group-create===
Creates a new Storage Volume group comprised of the specified Storage Volumes

<pre> qs volume-group-create|vg-create --name=value --volume-list=value [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async]
|}

===volume-group-delete===
Deletes a Storage Volume group, the volumes are not deleted unless the delete-volumes flag is set.

<pre> qs volume-group-delete|vg-delete --volume-group=value [--destroy-volumes=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>destroy-volumes</tt> || If 'true' all the volumes in the group will be deleted with the volume group, default is 'false'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-group-get===
Returns information about a specific Storage Volume group.

<pre> qs volume-group-get|vg-get --volume-group=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the command. [force, min]
|}

===volume-group-list===
Returns a list of all the Storage Volume groups.

<pre> qs volume-group-list|vg-list [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>flags</tt> || Optional flags for the command. [min]
|}

===volume-group-modify===
Modifies the name and/or description of a Storage Volume group.

<pre> qs volume-group-modify|vg-modify --volume-group=value [--name=value ] [--desc=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>name</tt> || Names may only contain alpha-numeric characters and special characters (-_.) excluding the parentheses.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async]
|}

===volume-group-snapshot===
Creates a space efficient copy of all volumes in the group.

<pre> qs volume-group-snapshot|vg-snap --volume-group=value [--name-suffix=value ] [--desc=value ] [--access-mode=value ] [--count=value ] [--wait-for-signal=value ] [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>name-suffix</tt> || Name for the snapshot/clone; if unspecified the snapshot/clone will use the original name with '_snapNN'/'_cloneNN' appended.
|-
|   || <tt>desc</tt> || A description for the object.
|-
|   || <tt>access-mode</tt> || Access mode for the volume. [none, readonly, *readwrite]
|-
|   || <tt>count</tt> || The number of snapshots of the specified volume to create, default is 1.
|-
|   || <tt>wait-for-signal</tt> || Some tasks (volume-snapshot) have the ability to wait for a signal at a key point before proceeding. To signal the task to proceed once started use 'task-proceed'.
|-
|   || <tt>flags</tt> || Optional flags for the operation. [async, force]
|}

===volume-group-volume-add===
Adds one or more volumes to the specified volume group.

<pre> qs volume-group-volume-add|vgv-add --volume-group=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

===volume-group-volume-remove===
Removes one or more volumes from the specified volume group

<pre> qs volume-group-volume-remove|vgv-remove --volume-group=value --volume-list=value [--flags=value ] </pre>
{| cellspacing='0' cellpadding='5'
|-
|   || <tt>volume-group</tt> || A group of one or more Storage Volumes.
|-
|   || <tt>volume-list</tt> || A list of one or more Storage Volumes.
|-
|   || <tt>flags</tt> || Optional flags for the command. [async, dry-run-only, force, forget-missing, min, *none]
|}

</div>
</div>