OSNEXUS Online Documentation Site - User contributions [en]

Security Configuration

2026-09-28T20:33:17Z

Umbe: /* Multi-admin approvals from the CLI */

[[Category:admin_guide]]

QuantaStor provides a layered set of security controls: grid-wide password and login policy, role based access control over every management operation, multi-factor authentication, an integrated firewall, TLS certificate management, and endpoint detection and response agent deployment. This page covers each of them.

Many industries require compliance with government security standards covering everything from audit logging to password policies. These include Health and Human Services security standards [https://www.hhs.gov/hipaa/index.html (HIPAA)], federal law enforcement security standards [https://www.fbi.gov/services/cjis/cjis-security-policy-resource-center (CJIS)], and the general standards outlined by NIST for Controlled Unclassified Information (CUI) in Non-Federal Information Systems and Organizations, covered in NIST 800-53 and [https://csrc.nist.gov/publications/detail/sp/800-171/rev-2/final 800-171].

Nearly all of the settings on this page are reached from the '''Security''' tab of the QuantaStor web management interface, which contains these sections:

{| class="wikitable"
! Security tab section !! Covers !! On this page
|-
| '''Management Users''' || User accounts, password policy, multi-factor authentication || [[#Security Settings Management|Security Settings]], [[#User Management|Users]], [[#Multi-factor Authentication|MFA]]
|-
| '''Management Groups''' || User groups and their shared POSIX GID || [[#User Group Management|User Groups]]
|-
| '''Management Roles''' || RBAC roles and their permission assignments || [[#Role Based Access Controls (RBAC)|RBAC]]
|-
| '''Object Users & Tenants''' || S3/object storage users and tenants || [[#Multitenancy / Resource Group Management|Multitenancy]]
|-
| '''Scale-out File & Block Keyrings''' || Keyrings for scale-out storage || not covered here
|-
| '''Certificates''' || The grid-wide TLS certificate inventory || [[#Certificate Management|Certificate Management]]
|-
| '''Key Server Profiles''' || External key server (KMIP) profiles || not covered here
|-
| '''EDR Agents''' || Endpoint detection and response agents || [[#Endpoint Detection & Response (EDR)|EDR]]
|}

Also on this page: [[#Firewall Configuration|Firewall Configuration]],
[[#SSL/TLS Certificate & Web Access Security|SSL/TLS and Web Access Security]],
[[#System Setup Security Checks|System Setup Security Checks]],
[[#Security Updates|Security Updates]] and
[[#Multi-admin Approvals|Multi-admin Approvals]].

== Security Settings Management ==

[[File:security_manager_general.png|thumb|right|530px|Security Manager, General tab -- grid-wide password and login policy.]]

The '''Security Manager''' holds the password and login policy for the entire Storage Grid. These settings apply to all user accounts on all systems in the grid, not per-system.

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)''}}

Choosing '''Suggested Defaults''' automatically configures the password and lockout policies to meet the standards listed above. This is the recommended starting point -- apply it first, then tune individual settings for the requirements of your deployment. '''Discard Changes''' reverts the dialog to the currently saved policy.

The '''General''' tab controls:

* '''Password Complexity''' -- the required character-class mix. The factory default is ''Weak''; raise this for any production or compliance-bound deployment.
* '''Allowed Special Characters''' -- which non-alphanumeric characters are permitted in passwords.
* '''Minimum / Maximum Password Length''' -- both in the range 8 to 80.
* '''Login Attempts Until Short Lockout''' and '''Login Attempts Until Lockout''' -- consecutive failures before a temporary and then a permanent lockout. Set the second to 0 to disable permanent lockout.
* '''Bad Logins Sample Period''' (short and permanent) -- the window, in seconds, over which failed attempts are counted.
* '''Bad Logins Short Lockout Duration''' -- how long, in seconds, a short lockout lasts.
* '''Days Until Password Expires''' -- 0 to 1000; 0 disables expiry.
* '''Unique Passwords Until Reuse''' -- 0 to 20; how many previous passwords are remembered and refused.
* '''Minimum Days Between Password Change''' -- prevents a user cycling straight back to a previous password.
* '''Maximum Days Account Inactive Until Lockout''' -- locks out dormant accounts.
* '''Auto Logout From N Minutes Of Inactivity''' -- idle timeout for the web interface; 0 disables it.
* '''Default Login Username''' -- the username pre-filled on the login page.

The '''Multi-admin Approvals''' tab chooses which deletes are held until a set number of administrators approve them; see '''[[#Multi-admin Approvals|Multi-admin Approvals]]'''.

The '''Advanced Settings''' tab holds the '''Web Access Mode''' (see '''[[#Web Access Mode|Web Access Mode]]'''), an optional '''System Use Notification''' banner shown to users at login, and the LDAP single-sign-on settings described next.

'''Note:''' saving a change to the password or login policy prompts a confirmation that the change may log users out of the interface and cause passwords to expire. Plan policy changes accordingly. Changes made only on the '''Multi-admin Approvals''' tab save without this prompt.

=== LDAP Single-Sign-On Authentication ===

[[File:security_manager_advanced.png|thumb|right|530px|Security Manager, Advanced Settings -- Web Access Mode and LDAP single sign-on.]]

The Advanced Settings tab can connect the Storage Grid to an LDAP or Active Directory domain for '''management user''' authentication.

To configure this:

* In your LDAP/AD environment, create one or more groups for QuantaStor administration -- for example {{Code|1=QS-Administrator}} and {{Code|1=QS-Monitor}} -- and add the appropriate users to them.
* In QuantaStor, edit the Role you want each LDAP group to map to and set its '''LDAP Group''' field. For example set the '''Administrator''' role's LDAP Group to {{Code|1=QS-Administrator}}, and the '''System Monitor''' role's to {{Code|1=QS-Monitor}}. The LDAP Group field is on the Create Role and Modify Role dialogs.
* Set your DNS and NTP servers to point at your AD server, in the Storage System Modify dialog. Do this '''before''' enabling single sign-on.
* Return to Security Manager --> Advanced Settings, tick '''Enable Single Sign-on''', and fill in the LDAP settings. The two fields are greyed out until the checkbox is ticked.

The LDAP fields are:

* '''LDAP Server (FQDN)''' -- the fully qualified domain name of the LDAP/AD server, for example {{Code|1=dc01.example.com}}
* '''LDAP Server Base DN for Users''' -- the base DN under which user accounts are searched, for example {{Code|1=dc=example,dc=com}}

This integration provides single sign-on for '''administrative''' access to the Storage Grid via the QuantaStor web interface, CLI, and REST API. It does '''not''' provide Active Directory integration for SMB network share access. For that, join each system to the domain via '''Storage Management --> Storage Systems --> Active Directory ''(toolbar)'' --> Join AD Domain'''.

=== Audit Logging ===

Audit logging of management operations is on by default on all QuantaStor systems and cannot be disabled. Every API, CLI, and web interface operation passes through the same core service and is recorded.

The audit log is at:

<pre style="font-size: smaller">
/var/log/qs/qs_audit.log
</pre>

It is written in a NIST compliant CEE JSON format, one JSON object per line, so it can be ingested directly by a log aggregator or SIEM without custom parsing. Each record identifies the operation, the user account that invoked it, the source address, and the outcome.

To ship the audit log to a central collector, point your syslog or log agent at this file; QuantaStor does not rotate it out from under a reader.

=== Sending Logs to Support ===

QuantaStor can collect and upload system logs to OSNEXUS Support, scrubbing usernames and other security related information first so that no personally-identifiable information is transmitted, and never including data files from Storage Pools. That makes the collection GDPR compliant.

Full detail is on its own page: '''[[Send System Log Report|Sending Logs to Support]]'''.

== Multi-admin Approvals ==

Multi-admin approvals stop a single administrator from destroying data on their own. When the policy covers an object type, a delete of that type does not run when it is requested. QuantaStor holds it as a pending request until enough other administrators approve it, and only then carries out the delete. A mistaken click, a compromised administrator account or a lone insider can therefore no longer remove a pool, volume, share or bucket unnoticed.

The policy is part of the grid-wide password and login policy held by the [[#Security Settings Management|Security Manager]], so it applies to every system in the Storage Grid.

=== Enabling multi-admin approvals ===

[[File:security_madm_policy.png|thumb|right|532px|Security Manager, Multi-admin Approvals tab -- the approval count, the expiry and the object types whose deletes need approval.]]

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)'' → Multi-admin Approvals ''(tab)''}}

Tick '''Enable Multi-admin Approvals''', then set the two fields under '''Approval Settings''' and choose the object types under '''Required Approval Types'''.

* '''Minimum Approvals''' -- how many administrators must agree to a delete, '''counting the administrator who requested it'''. The default and the minimum are both 2, which means one other administrator has to approve. Set 3 to require two approvers besides the requester.
* '''Hours Until Auto-expiration''' -- how long a request stays open for approval. The default and the minimum are both 48 hours, so a request raised on a Friday is still open on Monday. An expired request can no longer be approved; request the delete again to start over.
* '''Required Approval Types''' -- the deletes that need approval. '''Select All''' and '''Clear All''' tick or clear the whole list.

{| class="wikitable"
! Required Approval Type !! Held for approval
|-
| Storage Volume : Delete || Deleting a Storage Volume, including a volume snapshot
|-
| Network Share : Delete || Deleting a Network Share
|-
| Bucket : Delete || Deleting an object storage bucket
|-
| Scale-up Storage Pool : Delete || Deleting a ZFS-based [[Storage Pools|Storage Pool]]
|-
| Scale-out Block Pool : Delete || Deleting a Ceph block storage pool
|-
| Scale-out File Pool : Delete || Deleting a Ceph file system
|-
| Scale-out Object Pool : Delete || Deleting an object storage pool group
|-
| Object Storage Class : Delete || Deleting an object storage class
|-
| Ceph Cluster : Delete || Deleting a Ceph cluster
|}

Tick at least one type. With the checkbox enabled but no type ticked, nothing is held for approval, and the tab shows the feature as disabled the next time you open it.

To turn the feature off, clear '''Enable Multi-admin Approvals''' and click '''OK'''. Requests that are already open stay in the list until they are approved, rejected or expire.

Saving changes that touch only this tab does not raise the Security Manager's "may log users out" confirmation, because approval settings do not affect sessions or passwords.

=== How a held delete proceeds ===

# '''An administrator requests the delete''' in the usual way. Instead of deleting, the task completes with a description such as ''"Multi-admin approval pending for Storage Volume 'vol1' (1 of 2 approvals met). The delete will proceed once the required number of approvals is met."'' The object stays in place, and its state detail reads ''"Delete requested, pending approvals."''
# '''Other administrators approve it''' from the '''Approve''' dialog described below. Each approval raises the count by one.
# '''When the count reaches Minimum Approvals''', the request becomes approved and QuantaStor starts the delete straight away as a new task, run as the administrator who requested it. The options chosen with the original request carry through. For example, a Storage Pool delete keeps its '''Shred Encryption Keys''' and '''Shred Data''' choices.
# '''QuantaStor records the result.''' The request is marked completed once the object is gone, or failed if the object still exists after the delete task has finished.

A few rules apply throughout:

* '''The requester cannot approve their own request''', and each administrator can approve a request only once.
* '''One request per object.''' QuantaStor keeps a single open request for each object and operation. When a different administrator requests the same delete again, that counts as their approval rather than opening a second request. If the original requester issues the same delete again, it is refused, because they cannot approve their own request.
* '''Rejecting ends the request.''' Any administrator can reject an open request, and the delete does not happen. To delete the object later, start a new request.
* '''Expired requests are closed automatically.''' QuantaStor checks for expired requests periodically, so a request can still show as pending for a short time after its expiry time. It cannot be approved once it has expired.

=== Approving and rejecting requests ===

[[File:security_madm_approve.png|thumb|right|800px|Multi-admin Approval Request. Select one or more pending requests, then click Approve.]]

{{Navigation|Security → Management Users → Multi-admin Approval ''(toolbar group)'' → Approve}}

The '''Approve''' dialog lists every request still waiting for approval under '''Pending Multi-admin Approval Requests'''. For each request it shows the object's name, type and ID, the '''Request Status''', the '''Required Count''' and '''Current Count''', the '''Request Originator''' and the '''Expires Time'''. Select one or more requests and click '''Approve''', then confirm.

To refuse a request instead, open '''Reject''' from the same toolbar group. It lists the same pending requests. Select the ones to stop and click '''Reject'''.

Approving and rejecting need the '''Administrator''' role, or a custom role granted the approve and reject operations on the ''PendingOperationRequest'' object type. The built-in '''Security Administrator''' role does not currently include them (see [[#Role Based Access Controls (RBAC)|Role Based Access Controls]]).

You can approve from any system in the grid. QuantaStor forwards each approval to the system that owns the request, and the delete itself runs on the system that owns the object.

=== Request status ===

{| class="wikitable"
! Status !! Meaning
|-
| Pending || Waiting for approvals. It can be approved or rejected.
|-
| Approved || Enough approvals have been received. The delete is about to start.
|-
| Running || The delete task is running.
|-
| Completed Success || The delete finished and the object is gone.
|-
| Completed Failed || The delete ran but the object still exists, or the object or the requesting user no longer existed when the delete was due to run.
|-
| Rejected || An administrator rejected the request. The delete did not run.
|-
| Expired || The request reached its expiry time before it was approved.
|}

QuantaStor removes finished requests (completed, rejected and expired) automatically after 48 hours.

=== Multi-admin approvals from the CLI ===

Set the policy with <code>qs password-policy-set</code>. The object types are the internal type names, comma separated: {{Code|1=StorageVolume}}, {{Code|1=NetworkShare}}, {{Code|1=Bucket}}, {{Code|1=StoragePool}}, {{Code|1=CephPool}}, {{Code|1=CephFilesystem}}, {{Code|1=CephObjectPoolGroup}}, {{Code|1=CephObjectStorageClass}} and {{Code|1=CephCluster}}. Give the count and expiry explicitly: the CLI does not apply the minimums the web interface enforces. To turn the feature off from the CLI, clear the type list and set the count and expiry to 0 in one command, which is what clearing '''Enable Multi-admin Approvals''' in the Security Manager does.

<pre style="font-size: smaller">
qs password-policy-set --multiadmin-approval-types=StorageVolume,NetworkShare,StoragePool --multiadmin-approval-count=2 --multiadmin-approval-expiration-hours=48
qs password-policy-set --multiadmin-approval-types="" --multiadmin-approval-count=0 --multiadmin-approval-expiration-hours=0
</pre>

Manage requests with the {{Code|1=por-*}} (por refers to pending-object-request) commands. <code>qs por-list</code> shows each request's object, status ({{Code|1=pending}}, {{Code|1=approved}}, {{Code|1=running}}, {{Code|1=completed-success}}, {{Code|1=completed-failed}}, {{Code|1=rejected}} or {{Code|1=expired}}), current and required counts, expiry time and request ID, and <code>qs por-approve</code> and <code>qs por-reject</code> take a comma-separated list of request IDs:

<pre style="font-size: smaller">
qs por-list
qs por-get --request-id=<request-id>
qs por-approve --request-ids=<request-id>,<request-id>
qs por-reject --request-ids=<request-id>
qs por-clear-all
</pre>

<code>qs por-clear-all</code> removes every finished request (completed, rejected and expired) without waiting for the 48-hour automatic cleanup. It leaves pending requests alone.

== Role Based Access Controls (RBAC) ==

[[File:security_roles_section.png|thumb|right|800px|Management Roles section with the default roles.]]

QuantaStor's '''R'''ole '''B'''ased '''A'''ccess '''C'''ontrol system lets IT and security administrators grant access limited to a job function, following the [https://en.wikipedia.org/wiki/Principle_of_least_privilege principle of least privilege].

The RBAC system is highly granular. Each '''permission''' has three parts:

* an '''object type''' -- for example Network Share, Storage Volume, Storage Pool
* an '''operation''' -- for example create, delete, modify, view
* a '''scope''' -- system, resource group, user, or none

Every QuantaStor API, CLI, and web interface command goes through the same core service, and every call passes an authentication and an authorization check. Because of that shared path, RBAC applies uniformly no matter how the account connects -- web interface, {{Code|1=qs}} CLI, or REST API.

This granularity is especially useful for automation: a dedicated account can be created for a script whose role permits only the task it performs, such as creating and deleting a nightly snapshot of a Network Share.

QuantaStor ships with four default roles:

* '''Administrator''' -- full access to all functions on all systems in the grid.
* '''Security Administrator''' -- full control over security-related functions.
* '''Object Tenant Admin''' -- for users managing object storage tenants.
* '''System Monitor''' -- view only; no configuration changes.

=== Role Management ===

[[File:security_role_create.png|thumb|right|570px|Create Role, showing the permission assignment grid.]]

{{Navigation|Security → Management Roles → Role → Create ''(toolbar)''}}

Each user is assigned a single Role, and a role change takes effect immediately. If a user logged in as '''Administrator''' has their role changed to '''System Monitor''', which has only view permissions, the new permissions apply to their next action. Tasks already running -- a Storage Volume create, for example -- complete at the authorization level held when the task started.

The Create Role dialog takes a '''Name''', a '''Description''', and an optional '''LDAP Group''' used for '''[[#LDAP Single-Sign-On Authentication|single sign-on]]'''.

Because a role carries hundreds of individual permissions, the dialog provides two shortcuts:

* '''Copy Permissions from Role''' -- start from an existing role's permission set (pick the source role in the adjacent dropdown) and adjust from there. This is by far the fastest way to build a new role.
* '''Apply Permission Scope to Selected''' -- tick a set of rows in the grid, choose a scope, and apply it to all of them at once.

The '''Web Interface Customization''' tab hides web interface tab panels and sections for every user holding the role -- the same mechanism described under '''[[#Web Interface Customization|Web Interface Customization]]''', but applied per role rather than per user.

=== Role Permissions - Object Types ===

The '''Permission Assignments''' grid lists every permission as a row of '''Object Type''', '''Operation''', and '''Permission Scope'''.

There are '''207 object types''' and '''662 individual permissions''', covering everything from the common types such as Storage Volume, Network Share, and Object Bucket through to internal types such as Acl, AlertConfiguration, and TargetPort.

Because that list is long, use the '''<Show All Object Types>''' filter above the grid to narrow it to the object type you are working on, then set the operations for that type.

=== Role Permissions - Operation Types ===

Every permission is a combination of an object type and an '''operation''' that can be performed on it. Across the default Administrator role there are 120 distinct operations; the most common are '''view''', '''modify''', '''create''', and '''delete''', with more specific ones such as '''add''', '''remove''', '''rescan''', '''enable''', '''disable''', '''identify''', '''set''', and '''clear''' on the object types that support them.

This per-operation granularity is what lets a role fit a job function. A "Provisioning Administrator" role, for example, can be given '''create''' but not '''delete''', so the routine task of provisioning storage can be delegated without the risk of data deletion.

All object types also have a '''view''' permission, and this one deserves attention: some parts of the web management interface require view permission on a type in order to function. Removing '''view''' is useful when a role should have no visibility of a type at all -- an administrator responsible only for Network Shares could have '''view''' on '''StorageVolume''' set to '''None''', so that no Storage Volumes are visible to them.

=== Role Permissions - Operation Scope ===

Each permission's '''scope''' determines the breadth of the grant. Click a '''Permission Scope''' cell in the grid to change it.

* '''Global/System''' -- grid-wide access to the operation on all systems.
* '''None''' -- access to the operation is blocked entirely.
* '''User''' -- access is limited to objects the user owns. A role with the permission '''Storage Volume + delete + User''' allows deleting only Storage Volumes for which that user is the owner.
* '''Resource Group''' -- access is limited to the objects in the Resource Group the user is assigned to. This is how QuantaStor implements multi-tenancy; see '''[[#Multitenancy / Resource Group Management|Multitenancy]]'''.
== User Management ==

[[File:security_users_section.png|thumb|right|800px|Security tab, Management Users section.]]

Users in QuantaStor are '''management users''' -- accounts with access to the management interface under a specific Role.

These accounts are also created as local (Linux/Unix) users on '''every''' Storage System in the grid, with the same POSIX UID and GID on each. This enables management accounts to be used for SMB file access, which matters in environments where AD/LDAP is not configured, or where direct non-AD user access is needed.

For security, the local accounts created for SMB access are given {{Code|1=/usr/sbin/nologin}} as their shell, so they cannot log in over SSH or at the console. By default the only accounts with a login shell are '''qadmin''' and '''root''', and those should be reserved for maintenance activities. That restriction can be overridden with standard Linux user management commands, but doing so widens your attack surface and is not recommended.

=== Adding New Users ===

[[File:security_user_add.png|thumb|right|610px|Add User dialog, General tab.]]

{{Navigation|Security → Management Users → User → Add ''(toolbar)''}}

The '''General''' tab takes:

* '''Username''' -- also becomes the local POSIX account name on every system in the grid.
* '''Password''' and '''Repeat Password''' -- must satisfy the grid password policy set in the '''[[#Security Settings Management|Security Manager]]'''. The factory default policy is deliberately permissive; raising it with '''Suggested Defaults''' is recommended.
* '''Role''' -- see '''[[#Role Based Access Controls (RBAC)|RBAC]]'''. Assign '''System Monitor''' to an account that only needs to observe, rather than '''Administrator'''.
* '''Enable Multi-Factor Auth''' and '''Multi-Factor Auth Config''' -- require a second factor for this account; see '''[[#Multi-factor Authentication|Multi-factor Authentication]]'''. These are greyed out until at least one MFA configuration exists.
* '''User Information''' -- optional First Name, Last Name, and Description.

The default '''admin''' account can be modified but cannot be deleted, and cannot be assigned any role other than '''Administrator'''.

A newly created user appears in the Users grid with its assigned Role and the POSIX User ID allocated to it, and the matching local account exists on every system in the grid immediately.

==== Alert Subscriptions ====

[[File:security_user_alerts.png|thumb|right|610px|Add User, Alert Subscriptions tab.]]

Entering a user's email address and selecting the alert severity levels to subscribe to routes email alerts to that administrator. Several users can subscribe at different severities, so that (for example) only critical alerts page the on-call administrator while an operations mailbox receives everything.

Once configured, use the '''Alert Manager''' to send a test alert and confirm delivery end to end.

==== Web Interface Customization ====

[[File:security_user_webcustom.png|thumb|right|610px|Add User, Web Interface Customization tab.]]

In larger deployments with many administrators, or on systems built for a narrow use case, it can help to hide the interface tab panels and sections a given user does not need. This reduces complexity and makes the interface clearer for admins with a narrow remit.

Un-check the panels and sections to hide them. The user must '''log out and back in''' for the customized layout to take effect.

The same customization can be applied to a Role instead of an individual user, which is usually preferable when several people share a job function -- see '''[[#Role Management|Role Management]]'''.

==== User Account Advanced Settings ====

[[File:security_user_advanced.png|thumb|right|610px|Add User, Advanced Settings tab.]]

The '''Advanced Settings''' tab holds three things:

* '''User Default CHAP settings''' -- a '''CHAP User''' and '''CHAP Password''' used as this account's defaults for iSCSI authentication.
* '''Customize UID/GID''' -- tick this to set an explicit '''POSIX UID''' and '''POSIX GID''' rather than letting QuantaStor allocate them. Set these deliberately when the account is used for SMB and NFS access and must match UIDs already in use elsewhere in your environment; the fields are greyed out until the box is ticked.
* '''Enable '[QSCLITKN]' token based authentication for QS CLI via 'root' console account''' -- lets someone logged into a QuantaStor system as '''root''' run {{Code|1=qs}} CLI commands without supplying a password each time.

To use the token authentication, tick that checkbox for the account, then, as '''root''' on the system, write a {{Code|1=~/.qs.cnf}} naming the account:

<pre style="font-size: smaller">
echo "localhost,admin,[QSCLITKN]" > ~/.qs.cnf
</pre>

Replace {{Code|1=admin}} with whichever account you enabled the option for.

'''Note:''' the first one or two {{Code|1=qs}} commands after creating this file fail with ''"Service authentication token check failed ... remote caller will update token"'' while the token is being established. This is expected -- retry and the command succeeds, after which authentication is transparent.

The same mechanism can be used with a remote host rather than {{Code|1=localhost}} by changing the first field.

=== Modifying Users ===

[[File:security_user_modify.png|thumb|right|610px|Modify User dialog.]]

{{Navigation|Security → Management Users → ''select a user'' → User → Modify ''(toolbar)''}}

The Modify User dialog exposes the same settings as Create User across the same four tabs, so a user's role, alert subscriptions, interface customization, and advanced settings can all be changed after the fact. Changes take effect on the user's next action.

To change only a password, use '''Set Password''' from the User group in the toolbar rather than the full Modify dialog.

More information: [[User_Modify|Modify User]].

=== Removing Users ===

[[File:security_user_remove.png|thumb|right|390px|Remove User dialog.]]

{{Navigation|Security → Management Users → ''select a user'' → User → Remove ''(toolbar)''}}

The dialog confirms the '''Username''' and shows the account's properties before removal.

Removal takes effect immediately and grid-wide. A user who is logged into the web interface when their account is removed loses access to all systems in the grid at once, and the matching local POSIX account is deleted from every Storage System.

The default '''admin''' account cannot be removed.

More information: [[User_Remove|Removing Users]].

== User Group Management ==

[[File:security_usergroup_create.png|thumb|right|534px|Create User Group dialog.]]

User Groups collect users under a common POSIX GID, which is useful when several users need to be owners of the same Network Share.

{{Navigation|Security → Management Groups → User Group → Create ''(toolbar)''}}

The Create User Group dialog takes a '''Name''', an optional '''Description''', an optional '''POSIX GID''' (allocated automatically if left blank), and a grid from which to '''select one or more users for the group'''.

Group membership can be changed later with '''Add/Remove Users''', and the group's other properties with '''Modify'''. '''Delete''' removes the group; the user accounts themselves are unaffected.

== Multitenancy / Resource Group Management ==

[[File:security_multitenancy.png|thumb|right|800px|Multitenancy tab.]]

Resource Groups are multi-tenant containers that group users together with resources -- [[Storage Volumes]], [[Network Shares]] -- and with provisioning quotas for self-service provisioning from Storage Pools.

{{Navigation|Multitenancy ''(main tab)''}}

The '''Resource Group''' toolbar group provides '''Add/Remove Users''', '''Add/Remove Tenants''', '''Add/Remove Service Configs''', and '''Add Network Association''' / '''Remove Network Association''' for binding a group to specific networks. The '''Provisioning Quota''' group provides '''Create''', '''Modify''', and '''Delete''' for quotas, plus '''Add/Remove Volumes''' and '''Add/Remove Shares''' to place resources into a group.

Users assigned to a Resource Group should hold a role whose permissions are scoped to '''Resource Group''' rather than '''Global/System''', so that their view of the grid is limited to the resources in their group. The '''Object Tenant Admin''' role is the shipped starting point for object storage tenants; for file and block multi-tenancy, create a role with the permissions you want at '''Resource Group''' scope -- see '''[[#Role Permissions - Operation Scope|Operation Scope]]'''.

Further information: [[Create_Resource_Group|Create a Resource Group]].
== System Setup Security Checks ==

The steps in this section are the minimum hardening pass for a newly deployed QuantaStor system. All of them should be completed before the system carries production data.

# Change the '''qadmin''' console password from its default.
# Change the '''admin''' management password from its default.
# Apply '''Suggested Defaults''' in the '''[[#Security Settings Management|Security Manager]]''' to raise the password and lockout policy.
# Set '''[[#Web Access Mode|Web Access Mode]]''' to ''HTTP redirects to HTTPS'' or ''HTTP disabled''.
# Replace the shipped self-signed certificate -- see '''[[#Installing Your Own Certificate|Installing Your Own Certificate]]'''.
# Block unused protocols in the '''[[#Firewall Configuration|firewall]]'''.
# Consider enabling '''[[#Multi-factor Authentication|multi-factor authentication]]''' for administrative accounts.

=== Change Passwords ===

QuantaStor ships with two default accounts that must both be changed. They are separate accounts with separate passwords: '''qadmin''' is the console/SSH account, '''admin''' is the management interface account.

==== Change SSH Console Administrator Account 'qadmin' Password ====

One of the most important steps in configuring a new QuantaStor system is changing the '''qadmin''' console password from its default of '''qadmin''' on each Storage System.

Log in at the console as '''qadmin''', or connect over '''SSH''' as '''qadmin''', then run:

<pre style="font-size: smaller">
passwd
</pre>

Choose a strong password containing upper and lower case letters, numbers, and symbols. Repeat this on every Storage System in the grid -- this is a local console account, so changing it on one system does not change it on the others.

Note that this password is independent of the grid password policy configured in the Security Manager, which governs '''management''' users only.

==== Change Management Administrator Account 'admin' Password ====

[[File:security_set_password.png|thumb|right|361px|Set Password dialog.]]

Log in to the web management interface as '''admin''' and change the default password, which is '''password'''.

{{Navigation|Security → Management Users → ''select the'' admin ''user'' → User → Set Password ''(toolbar)''}}

The new password must satisfy the grid password policy. Use at least 10 characters with upper and lower case letters and numbers -- or raise the policy first with '''Suggested Defaults''' so the requirement is enforced for every account rather than relying on convention.

'''Old Password''' is disabled while the session is logged in as <code>admin</code>, so changing that account's password needs only the new password and its confirmation. For every other account the field is required and the current password has to be entered as well. The permitted length range comes from the grid password policy rather than being fixed by the dialog.

Unlike '''qadmin''', this is a grid-wide management account: changing it once changes it for the whole Storage Grid.

== Firewall Configuration ==

[[File:security_firewall.png|thumb|right|600px|Storage System Modify, Firewall tab.]]

QuantaStor has an integrated firewall management system that controls protocol access both at the system level and per network port. For high-security environments it is recommended to block every protocol that will not be used.

'''Navigation (system level):''' Storage Management --> ''select a Storage System'' --> Modify ''(toolbar)'' --> Firewall ''(tab)''

'''Navigation (per port):''' Storage Management --> Network Ports --> ''select a port'' --> Modify Network Port ''(toolbar or right-click)'' --> Firewall ''(tab)''

The Firewall tab lists each service with a description and an '''Allow''' checkbox. The services managed are:

* '''QS Web Management''' -- web management interface access
* '''QS REST API''' -- REST API access to management functions
* '''iSCSI Target''' -- iSCSI protocol access to Storage Volumes
* '''NVMeoF Target''' -- NVMe over Fabrics access
* '''SMB''' -- SMB/CIFS file access
* '''NFS''' and '''NFS Ganesha''' -- NFS file access, scale-up and scale-out respectively
* '''Ceph''' -- scale-out cluster communication
* '''Grafana''' -- Grafana monitoring and statistics
* '''Prometheus''' -- Prometheus monitoring and alerting
* '''Chronograf''' -- Chronograf monitoring

Clear the '''Allow''' box for any service you do not use. A common hardening pass on a file-only deployment, for example, is to leave SMB and NFS enabled and clear iSCSI Target, NVMeoF Target, and Ceph.

Be careful not to block the protocol you are managing the system with: clearing '''QS Web Management''' on the port you are connected through will cut off your own session. Note also that '''[[#Web Access Mode|Web Access Mode]]''' set to ''HTTP disabled'' installs its own rule dropping port 80, independently of these checkboxes.

Use '''Apply''' to commit changes without closing the dialog.
== SSL/TLS Certificate & Web Access Security ==

QuantaStor serves the web management interface, the REST API, and the internal grid communication channels over TLS. The web management interface is served by '''nginx''' and the TLS settings, ciphers, and certificates are all managed by QuantaStor.

=== Web Access Mode ===

The single most important web security setting is the '''Web Access Mode''', which controls whether plain HTTP is served at all.

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)'' → Advanced Settings}}

The three modes are:

* '''HTTP enabled (INSECURE)''' -- port 80 serves the interface over plain, unencrypted HTTP. This is the factory default so that a newly-imaged appliance is reachable before certificates are in place; it is '''not''' appropriate for production.
* '''HTTP redirects to HTTPS (recommended)''' -- port 80 answers with a 301 redirect to HTTPS. Nothing sensitive traverses the network in the clear, but a user who types the bare hostname still lands on the interface.
* '''HTTP disabled''' -- port 80 is dropped at the firewall entirely. Use this in high-security environments where an open port 80, even one that only redirects, is not acceptable.

Changing this setting switches the active nginx site configuration and, for '''HTTP disabled''', also installs a firewall rule that drops port 80. The change applies immediately -- no reboot is required.

The Web Access Mode affects '''port 80 only'''. The HTTPS listener on port 443 uses the same TLS versions, cipher list, and certificate in every mode, so switching modes does not change the encryption offered to HTTPS clients -- it only determines whether an unencrypted alternative is reachable. Setting the mode to '''HTTP redirects to HTTPS''' should nonetheless be treated as a required hardening step on every production deployment.

Changing this setting prompts a confirmation warning that the change may log users out of the interface and cause passwords to expire; the mode change itself takes effect as soon as you confirm.

=== Supported TLS Versions and Ciphers ===

QuantaStor's nginx configuration accepts '''TLS 1.2 and TLS 1.3''' only, in all web access modes, with server cipher preference enabled and the cipher list restricted to modern AEAD suites: ''(Note: due to the frequency of security updates this may be out of date and system configuration files should be referenced.)''

<pre style="font-size: smaller">
ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:
ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256
</pre>

SSLv3, TLS 1.0, and TLS 1.1 are not accepted. ''(Note: due to the frequency of security updates this may be out of date and system configuration files should be referenced.)'' The interface also sends an HSTS header ({{Code|1=Strict-Transport-Security}}) with a one year max-age.

The shipped defaults live in this file, which is replaced on upgrade and should '''not''' be edited in place:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/nginx_quantastor_ssl_default.conf
</pre>

To customize the TLS settings or point nginx at your own certificate, use the {{Code|1=qs-util}} helper to copy the defaults to a user-editable location that upgrades will not overwrite:

<pre style="font-size: smaller">
qs-util wuicustomcerts
</pre>

This creates the following file, which you then edit:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf
</pre>

Cipher settings for the QuantaStor grid communication channels (separate from the web interface) are controlled by:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/qsciphers
</pre>

That shipped file is replaced on upgrade, so it should not be edited in place. To customize the grid communication ciphers, place your own copy at the override location below. The override does not exist by default -- create it only when you intend to depart from the shipped cipher list, and QuantaStor will use it in preference to the shipped file and leave it untouched across upgrades:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/qsciphers
</pre>

=== Default Certificate ===

QuantaStor ships with a common self-signed certificate that is pre-generated and included with all deployments. Because it is self-signed and shared across all deployments, browsers will warn on first connection, and it provides no identity assurance. Replacing it is recommended for any deployment reachable beyond a trusted management network.

The certificate and key used by the web interface and REST service are here:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/qsrestsrv.pem
</pre>

Grid communication uses a separate pair:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/qsserver.pem
/opt/osnexus/common/lib/qsclient.pem
</pre>

All of these are discovered and monitored automatically -- see '''[[#Certificate Management|Certificate Management]]''' below, which is the recommended way to review and replace them.

=== Installing a Custom Certificate ===

The '''recommended''' way to install your own certificate is through '''[[#Certificate Management|Certificate Management]]''' -- add the certificate as a template once, then apply it to the '''NGINX''' use case on each Storage System. That keeps the certificate inventory, expiry monitoring, and alerting accurate, and avoids editing nginx configuration by hand. See '''[[#Installing Your Own Certificate|Installing Your Own Certificate]]'''.

Use the manual procedure below only when you need to change nginx TLS directives themselves (for example to further restrict the cipher list), since those are not expressible as a certificate template:

* Run {{Code|1=qs-util wuicustomcerts}} to copy the shipped defaults to an editable file that upgrades will not overwrite.
* Edit {{Code|1=/var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf}}.
* Reload nginx to apply:

<pre style="font-size: smaller">
systemctl reload nginx
</pre>

* Verify the negotiated protocol and cipher from a client:

<pre style="font-size: smaller">
openssl s_client -connect <system-ip>:443 </dev/null 2>/dev/null \
| grep -E 'Protocol|Cipher is'
</pre>

Repeat on each Storage System in the grid, or use the Certificate Management section to confirm all systems at once.

'''Note:''' if you are using Firefox and have previously accepted the old self-signed certificate, clear the cached certificate exception for the host or Firefox will continue to present the stale certificate warning.
=== [[Custom SSL_TLS Security|Custom SSL Certificates and TLS Security]] ===
* Generating and installing custom SSL certificates, and applying custom TLS security settings. For most deployments the '''[[#Certificate Management|Certificate Management]]''' section above is the better route, since it keeps the certificate inventory and expiry alerting accurate.

=== [[Custom SSH Security|Custom SSH Ciphers and Key Exchange Algorithms]] ===
* Customizing the SSH service to enforce strong ciphers and key exchange algorithms for SSH communication.
== Certificate Management ==

[[File:security_certificates.png|thumb|right|800px|Certificates section showing every certificate on every Storage System in the grid.]]

QuantaStor discovers, inventories, and monitors every TLS certificate in use across the Storage Grid, so administrators can see at a glance what is installed, what it is used for, and when it expires.

{{Navigation|Security → Certificates}}

The Certificates section lists certificates grouped by Storage System. For each certificate the grid shows its file path, '''State''', '''Use Case''', description, certificate modulus MD5, serial number, and the start and end of its validity period. Because the view spans the whole grid, a single screen confirms that every system is using the certificate you expect.

=== Certificate Use Cases ===

Each certificate is tagged with the service that consumes it:

* '''NGINX''' -- the certificate served to browsers for the web management interface.
* '''Rest Service''' -- the certificate presented by the QuantaStor REST API service.
* '''QuantaStor Service [Grid Communication]''' -- the server-side certificate for inter-node grid communication.
* '''Client [Grid Communication]''' -- the client-side certificate a node presents to its peers.
* '''HAProxy''' -- the certificate used by the integrated load balancer, when configured.
* '''Object Gateway''' -- the certificate used by the Ceph S3/Object Gateway. Two use cases are available, for a first and second gateway instance ({{Code|1=cephrgw-1}} and {{Code|1=cephrgw-2}} on the CLI).

Note that the same PEM file may appear more than once with different use cases when one certificate serves several roles -- for example {{Code|1=qsrestsrv.pem}} is used for both '''NGINX''' and '''Rest Service'''.

=== Certificate Expiration Alerts ===

QuantaStor monitors validity dates and raises alerts as a certificate approaches expiry, so a certificate never lapses unnoticed. Alerts are raised at '''90, 60, 30, 7, and 2 days''' before expiry, and again once the certificate has actually expired.

The longer-lead warnings are only raised for certificates with a correspondingly long lifetime -- the 90 day warning applies to certificates valid for more than 18 months, the 60 day warning to those valid for more than a year, and the 30 day warning to those valid for more than 90 days. This prevents short-lived certificates from generating alerts the moment they are installed. The 7 day, 2 day, and expired alerts always apply.

Alerts are delivered through the standard QuantaStor alerting system, so they reach whatever email and SNMP destinations you have configured in the Alert Manager.

=== Certificate Templates ===

A '''certificate template''' holds a certificate (and its private key) that you have obtained from your CA, stored once in the grid so it can be applied to any service on any Storage System. Templates are what make it possible to roll out your own certificate across the grid from the management interface instead of copying PEM files onto each node by hand.

{{Navigation|Security → Certificates → ''Certificate Templates'' ''(tab)''}}

The toolbar provides '''Add Template''', '''Update''', '''Remove Template''', and '''Certificate Template Manager''' for reviewing and maintaining templates.

=== Installing Your Own Certificate ===

This is the recommended way to replace any of QuantaStor's default self-signed certificates, including the one served by the web management interface.

* Obtain a certificate and private key from your CA.
* '''Add a template''' from the certificate. Supply a name, a description, and the PEM file containing the certificate and key block. If the private key is in a separate file, supply it as well.
* '''Apply the template''' to the use case you want it to serve on a given Storage System -- for example apply it to the '''NGINX''' use case to change the certificate browsers see for the web management interface.
* Repeat the apply step for each Storage System, and for each use case the certificate should cover.

'''IMPORTANT -- the certificate must contain a Subject Alternative Name (SAN).''' QuantaStor validates certificates before accepting them as a template and rejects any certificate without a SAN extension, with the error ''"Certificate validation failed. Unable to create certificate template out of invalid certificate."'' A Common Name alone is not sufficient. Include every name and address the systems will be reached by -- the FQDN, the short hostname, and the management IP. When generating a self-signed certificate with {{Code|1=openssl req}}, add the SAN explicitly:

<pre style="font-size: smaller">
openssl req -x509 -newkey rsa:2048 -nodes -days 365 \
-subj "/C=US/ST=<state>/L=<city>/O=<org>/CN=<fqdn>" \
-addext "subjectAltName=DNS:<fqdn>,DNS:<hostname>,IP:<system-ip>" \
-keyout mycert.key -out mycert.crt

cat mycert.crt mycert.key > mycert.pem
</pre>

You can check a certificate against QuantaStor's validation rules before importing it:

<pre style="font-size: smaller">
/opt/osnexus/quantastor/bin/qs_certutil.sh validate --pem-file <path-to-pem>
</pre>

From the CLI the two steps are:

<pre style="font-size: smaller">
qs cert-tmpl-add --name=<template-name> --description=<text> \
--certificate-pem-data=<path-to-pem> \
[--privatekey-pem-data=<path-to-key-pem>]

qs cert-update --storage-system=<system> --cert-use-case=2 \
--cert-tmpl=<template-name>
</pre>

'''Note:''' {{Code|1=--cert-use-case}} currently requires the numeric use case value rather than its name. The values are ''0'' none, ''1'' haproxy, ''2'' nginx, ''3'' cephrgw-1, ''4'' cephrgw-2, ''5'' qsrest, ''6'' qsserver, ''7'' qsclient.

QuantaStor reloads the affected service automatically once the certificate is applied, so the new certificate is served without further action -- nginx for the '''NGINX''' and '''Rest Service''' use cases, HAProxy for '''HAProxy''', and the Object Gateway services for the gateway use cases. nginx is reloaded rather than restarted, so applying a web interface certificate does not disconnect your own management session.

'''Note for QuantaStor releases prior to 6.9:''' the nginx reload was not performed automatically, and the appliance would continue to present the previous certificate until nginx was reloaded by hand:

<pre style="font-size: smaller">
systemctl reload nginx
</pre>

Confirm what is actually being served, including the SAN:

<pre style="font-size: smaller">
openssl s_client -connect <system-ip>:443 </dev/null 2>/dev/null \
| openssl x509 -noout -subject -dates -ext subjectAltName
</pre>

=== Rescanning Certificates ===

If a certificate is replaced outside of QuantaStor -- for example by editing the nginx configuration directly, or by a external renewal process dropping in a new PEM -- use '''Rescan''' to re-read the certificates from disk and refresh the inventory, validity dates, and alert state.

{{Navigation|Security → Certificates → Rescan ''(toolbar)''}}

=== Reviewing Certificates from the CLI ===

The same inventory is available from the QuantaStor CLI, which is convenient for scripted compliance checks:

<pre style="font-size: smaller">
qs cert-list
qs cert-get --cert=<name-or-id>
qs cert-rescan --storage-system=<system>
</pre>

Certificate templates have a matching set of commands:

<pre style="font-size: smaller">
qs cert-tmpl-list
qs cert-tmpl-get --cert=<name-or-id>
qs cert-tmpl-rm --cert=<name-or-id>
</pre>

For TLS version and cipher settings, see '''[[#Supported TLS Versions and Ciphers|Supported TLS Versions and Ciphers]]'''.
== Endpoint Detection & Response (EDR) ==

[[File:security_edr_agents.png|thumb|right|800px|EDR Agents section. Agents are installed per Storage System and report vendor, status, version, and enabled features.]]

Many security standards and cyber-insurance policies require an endpoint detection and response (EDR) agent on every server, including storage appliances. QuantaStor can deploy and manage a vendor EDR agent on each Storage System in the grid directly from the web management interface, so the appliances are covered by the same endpoint security tooling as the rest of the fleet without hand-installing agents over SSH.

{{Navigation|Security → EDR Agents}}

The EDR Agents section lists the installed agents with their '''Name''', '''State''', '''Storage System''', '''Vendor''', '''Status''', '''Version''', and the set of '''Features''' the agent has enabled.

=== Supported EDR Vendors ===

'''Bitdefender GravityZone''' is the currently supported EDR platform, on Ubuntu 22.04, Ubuntu 24.04, RHEL 8, and RHEL 9. Additional vendor modules use the same framework and are being added; contact OSNEXUS at info@osnexus.com if you need a specific EDR platform supported.

Vendor modules are defined on the appliance in:

<pre style="font-size: smaller">
/opt/osnexus/quantastor/conf/qs_endpoint_security.conf
</pre>

=== Installing an EDR Agent ===

[[File:security_edr_install.png|thumb|right|500px|Install EDR Security Agent dialog.]]

Before starting, create an installation package for Linux servers in your Bitdefender GravityZone console and note either the '''package id''' or the full '''setup downloader URL''' the console provides. The feature set of the agent (which protection modules are enabled) is chosen in the GravityZone console when the package is created, and QuantaStor reads that selection back from the installer. Individual protection modules can optionally be overridden from the QuantaStor side at install time -- see the {{Code|1=--feature-flags}} argument in the CLI section below.

{{Navigation|Security → EDR Agents → Install Agent ''(toolbar)''}}

You can also right-click a Storage System to install an agent on it.

In the '''Install EDR Security Agent''' dialog:

* '''EDR Module''' -- select the vendor module, e.g. ''Bitdefender''.
* '''Install Key / URL''' -- paste either the short GravityZone package id (e.g. {{Code|1=aabbccdd}}) or the full {{Code|1=setup_downloader.tar}} URL copied from the GravityZone console. Both forms are accepted, which matters because the vendor's URL format changes from time to time.
* '''Storage Systems''' -- tick each system to install the agent on. The grid shows the service, kernel, and distribution version of each system so you can confirm platform support before installing.

QuantaStor then downloads the installer package from GravityZone onto each selected system, installs the agent, and registers it. Because the appliance must reach the GravityZone service to download the package, ensure outbound access to your GravityZone endpoint is permitted -- see '''[[#Firewall Configuration|Firewall Configuration]]'''.

Note that the registration key is supplied at install time and stored per node; it is not kept in the vendor module configuration file.

=== Monitoring and Removing Agents ===

Once installed, an agent's '''Status''' and '''Version''' are refreshed automatically and shown in the EDR Agents grid, so an agent that has stopped running is visible from the management interface rather than only from the vendor console.

To remove an agent, select it and choose '''Uninstall Agent'''.

{{Navigation|Security → EDR Agents → Uninstall Agent ''(toolbar)''}}

=== EDR Management from the CLI ===

The same operations are available from the QuantaStor CLI:

<pre style="font-size: smaller">
qs edr-agent-list
qs edr-agent-get --edr-agent=<name-or-id>
qs edr-agent-create --system-list=<systems> --module=bitdefender \
--registration-key=<package-id-or-url>
qs edr-agent-delete --edr-agent=<name-or-id>
qs edr-agent-rescan
</pre>

The create command also accepts an optional {{Code|1=--feature-flags}} argument taking a JSON object, to override individual protection modules without changing the GravityZone package:

<pre style="font-size: smaller">
qs edr-agent-create --system-list=qs-node-a --module=bitdefender \
--registration-key=aabbccdd \
--feature-flags='{"FileScan":1,"Firewall":0}'
</pre>

To review the available vendor modules and their supported platforms:

<pre style="font-size: smaller">
qs edr-agent-module-list
qs edr-agent-module-get --module=bitdefender
</pre>

== [[Custom S3 SSl/TLS Certificate|Custom S3 SSL/TLS Certificate]] ==
* Installing a custom certificate for the S3/Object Gateway endpoint. See also the '''Object Gateway''' certificate use cases under '''[[#Certificate Use Cases|Certificate Use Cases]]'''.

== Multi-factor Authentication ==

[[File:security_mfa_manager.png|thumb|right|615px|Multi-Factor Authentication Manager.]]

Multi-factor authentication (MFA) requires a user to present a second factor, such as a device, in addition to their password. QuantaStor supports MFA for management logins.

{{Navigation|Security → Management Users → User → Multi-Factor Auth Manager ''(toolbar)''}}

An MFA '''configuration''' must exist before MFA can be enabled on any account. The manager lists the existing configurations by '''Name''' and '''Provider''' and provides '''Create...''', '''Modify...''', '''Delete...''', and '''Assign/Unassign...''' for attaching a configuration to user accounts.

The supported providers are:

* '''Cisco Duo''' -- see [[Duo Multi-Factor Authentication|Cisco Duo Multi-Factor Authentication]] for the full setup walkthrough
* '''OKTA'''

Creating a configuration takes a '''Provider''', a '''Name''', an optional '''Description''', the '''API Host''' for your tenant, and the '''Integration Key''' and '''Secret Key''' issued by the provider. Obtain those values from your Duo or Okta administration console.

Once a configuration exists, enable MFA per account with '''Enable Multi-Factor Auth''' and '''Multi-Factor Auth Config''' on the Add User or Modify User dialog. The '''Force (required when in use)''' option in the manager makes the second factor mandatory rather than optional.

Contact OSNEXUS at info@osnexus.com for guidance on additional MFA options.

== Security Updates ==

QuantaStor supports automatic security updates through the '''[[Upgrade Manager]]''' in the web management interface.

{{Navigation|Storage Management → Upgrade Manager ''(toolbar)''}}

Applying security updates through the Upgrade Manager is the supported path -- it applies the updates OSNEXUS has qualified against the running QuantaStor release, in the correct order, across the systems you select. Installing distribution packages directly with {{Code|1=apt}} is not recommended, as it can introduce package versions that have not been qualified against the release.

== Encrypting NFS/SMB/iSCSI via IPsec ==

Protocols such as NFSv3 do not encrypt data on the wire. Where the storage network is not itself trusted, set up an encrypted tunnel between the client and the QuantaStor system so that protocol traffic is protected in transit.

More information on configuring IPsec on QuantaStor systems is available [[IPSec|here]].

Note that IPsec protects data '''in transit'''. For data '''at rest''', QuantaStor provides [[Storage Pools|Storage Pool]] encryption, which is configured when the pool is created and is covered separately in the administrator guide.

== Related pages ==

* [[Send System Log Report]] -- collecting and sending a scrubbed log bundle to support
* [[Duo Multi-Factor Authentication]] -- setting up the Cisco Duo MFA provider
* [[Custom SSH Security]] -- hardening the SSH service and managing key access
* [[Custom S3 SSl/TLS Certificate|Custom S3 SSL/TLS Certificate]] -- certificates for the S3 gateway
* [[IPSec]] -- encrypting protocol traffic in transit between client and appliance
* [[Storage Pools]] -- pool encryption, which protects data at rest
* [[Upgrade Manager]] -- applying security patches and QuantaStor updates
* [[Call-home / Alerting|Alert Manager]] -- alert delivery, including certificate expiry alerts
* [[Storage System]] -- system-level configuration and the Modify dialog

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

Clustered SCSI-3 Persistent Reservations

2026-09-28T20:29:18Z

Umbe: /* Disabling clustered reservations */

[[Category:admin_guide]]

Clustered SCSI-3 persistent reservations let the reservations a client cluster places on QuantaStor [[Storage Volumes]] survive an HA failover. Windows Server Failover Clustering -- including Hyper-V with Cluster Shared Volumes and SQL Server Failover Cluster Instances -- depends on them. This page explains why those clusters need the feature, how to turn it on for an HA pool, and what QuantaStor does when you do.

'''The feature is off by default. If you present HA pool volumes to a Windows failover cluster, turn it on in the HA group's Modify Group dialog before the cluster starts using the disks.'''

{| class="wikitable"
! Section !! Purpose
|-
| [[#Why Windows failover clusters need it|Why Windows failover clusters need it]] || What persistent reservations do for WSFC, and what goes wrong without this feature
|-
| [[#How it works|How it works]] || How reservations are shared between the appliances of an HA group
|-
| [[#Requirements|Requirements]] || Pool type, protocols, operating system, release and cluster prerequisites
|-
| [[#Enabling clustered reservations|Enabling clustered reservations]] || The HA group setting, in the web interface and from the CLI
|-
| [[#Setting up a Hyper-V or WSFC cluster|Setting up a Hyper-V or WSFC cluster]] || End-to-end walkthrough from HA group to Cluster Shared Volume
|-
| [[#When to leave it disabled|When to leave it disabled]] || What the feature costs, and why it is not on by default
|-
| [[#Disabling clustered reservations|Disabling clustered reservations]] || What turning it off does to a running cluster
|-
| [[#Allow Reboot / Lock Recovery|Allow Reboot / Lock Recovery]] || The companion setting in the same dialog
|-
| [[#Checking the state on an appliance|Checking the state on an appliance]] || Confirming every volume is sharing its reservations
|-
| [[#Troubleshooting|Troubleshooting]] || When the setting is on but reservations are not shared
|}

== Why Windows failover clusters need it ==

A Windows Server Failover Cluster arbitrates ownership of its shared disks with SCSI-3 persistent reservations (PR). Each cluster node registers a key with every clustered LUN, and the node that owns a disk holds a reservation on it. When a node stops responding, the surviving nodes remove its registration, which fences it off the disk so it cannot keep writing to storage the cluster has handed to someone else. Cluster Shared Volumes, where every node reads and writes the same LUN at once, rely on this to keep a failed node away from the volume. SQL Server Failover Cluster Instances use the same cluster disks and depend on it in the same way.

Because the whole cluster depends on reservations behaving correctly, Microsoft's '''Validate a Configuration''' wizard tests them. Its storage tests register, reserve, preempt and release keys against every candidate disk, and a disk that fails the SCSI-3 persistent reservation test cannot be used as a supported cluster disk.

A reservation is state held by the SCSI target, not data on the disk. On a QuantaStor HA pool the target that recorded the reservation is the appliance that currently owns the pool. Without clustered reservations, that record exists only on that appliance. When the pool fails over, the receiving appliance starts serving the same LUNs with an empty reservation table: every key the Windows nodes registered, and the reservation that says which node owns each disk, is gone. The pool came back, but from the cluster's point of view the disks no longer carry the registrations it placed on them, and it treats them as failed. Cluster disks go offline and Cluster Shared Volumes stop, which is exactly the outage an HA pool is meant to prevent.

With '''Clustered SCSI3-PR Reservations''' enabled, every appliance in the HA group holds the same reservation state for every volume in the pool, so the appliance that takes the pool over already knows every registration and reservation, and the Windows cluster sees no change.

This is a different thing from the persistent reservations QuantaStor places on the pool's own disks. Those are I/O fencing: QuantaStor arbitrating which appliance may import the pool, described in [[HA Cluster Setup (JBODs)#I/O fencing and SCSI-3 persistent reservations|I/O fencing and SCSI-3 persistent reservations]]. Clustered reservations concern the reservations that '''clients''' place on the storage volumes QuantaStor exports, and the two are independent.

== How it works ==

QuantaStor shares reservation state between the appliances of an HA group through the Linux distributed lock manager (DLM), which runs as a resource of the site cluster's Corosync and Pacemaker stack.

* Every exported storage volume in the pool gets its own DLM lockspace, named after the volume's SCSI device identifier. The reservation state lives in that lockspace rather than in a single appliance's memory.
* The appliance that owns the pool serves the volume and is a member of its lockspace.
* Every other appliance in the HA group -- the secondary, and the tertiary if the group has one -- holds a placeholder device with the same identity, which keeps it a member of the same lockspace. It carries no data; its job is to hold a copy of the reservation state.
* During a failover the appliances swap roles device by device, so at every moment at least one appliance is holding each volume's reservations. The appliance taking over joins with the state already in place.

Setting the HA group to Enabled is the whole of the configuration. QuantaStor installs the DLM, creates and starts the Pacemaker DLM resource, and switches the pool's volumes into clustered mode on every appliance in the group. Appliances that did not run the operation converge on their own shortly afterwards, and an appliance that was down or rebuilt catches up when it returns. Volumes created in the pool later pick the setting up when they are created.

== Requirements ==

* '''QuantaStor scale-up Storage Pool (ZFS) protected by an HA group.''' Clustered reservations are a property of the HA group, so a pool without one cannot use them. See [[HA Cluster Setup (JBODs)]] and [[HA Cluster Setup (external SAN)]].
* '''iSCSI or Fibre Channel.''' The feature applies to storage volumes exported over iSCSI and Fibre Channel. It does not apply to NVMe over Fabrics.
* '''QuantaStor 6.9 or newer''' The DLM and SCSI target driver changes the feature depends on are built for standard QuantaStor installs on 6.9 and newer and is not yet available on RHEL based configurations. Non-Ubuntu based QuantaStor configurations will refuse to put volumes into clustered mode rather than risk the target stack.
* '''Every appliance in the HA group at QuantaStor 6.9.0 or newer, and rebooted onto its current target driver.''' Enabling the setting is refused, naming the appliance, if any member of the group is on an older release, or if an appliance has had new target drivers installed but has not rebooted since. Complete the upgrade on every node, including the reboot, before turning the feature on.
* '''A healthy site cluster.''' The appliances must be members of a [[Site Cluster Setup|site cluster]] with Corosync and Pacemaker running. QuantaStor gives the Corosync cluster a name if it does not have one, because the DLM cannot start without it; this is done across the cluster under maintenance mode, and needs no action from you.

The operating system on the Windows side needs nothing beyond what a failover cluster already requires: multipath I/O configured for the iSCSI or Fibre Channel paths to the QuantaStor appliances, and the cluster nodes' initiators registered as hosts on QuantaStor.

== Enabling clustered reservations ==

{{Navigation|Storage Management → Storage Pools ''(section)'' → ''select the pool'' → Storage Pool HA Resource Group ''(toolbar group)'' → Modify Group}}

[[File:hagroup_modify_clusterpr.png|thumb|right|470px|The General tab of Modify Storage Pool High-Availability Group. Clustered SCSI3-PR Reservations shows Disabled, the default for a new HA group; Allow Reboot / Lock Recovery sits directly below it.]]

On the '''General''' tab of the '''Modify Storage Pool High-Availability Group''' dialog, set '''Clustered SCSI3-PR Reservations''' to '''Enabled''' and click '''OK'''.

The same field is on the Create Group dialog, so you can enable it when you first create the HA group. On both dialogs it offers '''Enabled''' and '''Disabled''', and a new HA group starts at '''Disabled'''.

The change applies to the running pool. No failover, service restart or reboot is needed: existing volumes are switched into clustered mode in place, and the other appliances in the group converge within a short time. The Modify Group task reports "Enabling SCSI3-PR distributed locking" while it works. On an appliance that has never had the DLM installed, the first enable includes the package install and takes longer.

If the DLM cannot be configured -- the site cluster is not running, for example -- the HA group is still created or modified, because it is useful without clustered reservations. QuantaStor records the reason in the service log -- and, on a create, raises a warning on the group -- and keeps retrying on its own, and the volumes take up clustered mode once the condition is cleared.

'''Enable it before the Windows cluster takes reservations on the volumes.''' The walkthrough below does it first for that reason.

=== From the command line ===

[[QuantaStor CLI Command Reference#ha-group-modify|qs ha-group-modify]] and [[QuantaStor CLI Command Reference#ha-group-create|qs ha-group-create]] take {{Code|1=--enable-cluster-pr}}:

<pre style="font-size: smaller">
qs ha-group-modify --ha-group=pool-1-ha-group --enable-cluster-pr=enabled
</pre>

It accepts {{Code|1=enabled}}, {{Code|1=disabled}} and {{Code|1=auto}}, and {{Code|1=auto}} is what you get when you leave the argument out. On a modify, {{Code|1=auto}} leaves the current setting unchanged, so a command that changes some other property of the group never switches clustered reservations off as a side effect. On a create, {{Code|1=auto}} resolves to disabled unless the pool's volumes are already in clustered mode. Pass {{Code|1=enabled}} explicitly when you want the feature.

== Setting up a Hyper-V or WSFC cluster ==

This is the order to follow when presenting QuantaStor volumes to a new Windows Server Failover Cluster, whether for Hyper-V Cluster Shared Volumes or for a SQL Server Failover Cluster Instance.

=== 1. Enable clustered reservations on the HA group ===

Set '''Clustered SCSI3-PR Reservations''' to '''Enabled''' on the pool's HA group, as described in [[#Enabling clustered reservations|Enabling clustered reservations]]. Do this first, so that every reservation the cluster ever takes is shared between the appliances from the start.

=== 2. Create the volumes ===

Create the volumes the cluster will use in the HA pool -- see [[Storage Volumes#Creating a Storage Volume|Creating a Storage Volume]]. A small volume for the cluster's disk witness, if you intend to use one, belongs in the same pool.

=== 3. Present the volumes to every cluster node ===

Add each Windows cluster node as a host with its iSCSI IQN or Fibre Channel WWPNs, put all of the nodes in one Host Group, and assign the volumes to that Host Group. [[Hosts and Host Groups#Host Groups|Host Groups]] covers why a group assignment is the right tool for a cluster; for Fibre Channel, [[Fibre Channel Target Port Management#Assigning a storage volume over FC|Assigning a storage volume over FC]] covers zoning and WWPNs.

For iSCSI, have each node log in to the pool's HA virtual interface rather than an appliance's own address, so its sessions follow the pool when it fails over. For Fibre Channel, configure multipath on each node; QuantaStor advertises the paths through the owning appliance as active and the others as standby.

=== 4. Bring the disks online on one node ===

On one cluster node, rescan storage, bring the new disks online, initialize them and create the volumes you intend to use, in the usual way for disks that will become cluster disks. The other nodes see the same LUNs through the host group and need no preparation of their own.

=== 5. Run cluster validation ===

Run the '''Validate a Configuration''' wizard in Failover Cluster Manager, or the {{Code|1=Test-Cluster}} PowerShell cmdlet, against all of the nodes and include the storage tests. The SCSI-3 persistent reservation test should pass on every QuantaStor disk.

If you want proof that reservations survive a failover before going into production, fail the pool over to the other appliance with '''Manual Failover''' (see [[HA Cluster Setup (JBODs)#Deliberate failover|Deliberate failover]]) and run the storage validation again, or confirm in Failover Cluster Manager that the cluster disks stayed online throughout.

=== 6. Add the disks to the cluster and to Cluster Shared Volumes ===

Add the validated disks to the cluster as cluster disks, then add the ones Hyper-V will use to Cluster Shared Volumes. For a SQL Server Failover Cluster Instance, select the cluster disks during SQL Server's failover cluster setup instead.

== When to leave it disabled ==

Leave the setting Disabled on HA groups whose clients never take SCSI-3 reservations -- VMware vSphere datastores, Linux hosts, file shares, and single Windows servers. The feature is off by default because it has a cost:

* '''One DLM lockspace for every exported volume''', held on every appliance in the HA group, including the ones not serving the pool. A pool whose clients never reserve a LUN gains nothing from that.
* '''A dependency on the cluster's lock manager.''' A volume in clustered mode relies on the DLM being able to form and recover its lockspace. QuantaStor gates every step on the DLM being verified healthy on the appliance, precisely because a lockspace that cannot be joined or recovered can stall the appliance's SCSI target. That is a risk worth taking for a Windows cluster that needs the feature, and not one to take by default.

== Disabling clustered reservations ==

Set '''Clustered SCSI3-PR Reservations''' back to '''Disabled''' in Modify Group. The dialog asks you to confirm, and means it:

<blockquote>''Disabling Clustered Persistent Reservations is disruptive to connected clustered clients such as Windows Server with Hyper-V. Reservations are no longer shared across the HA cluster, so any reservation a client is holding will be LOST the next time this pool fails over. Are you sure you want to do this?''</blockquote>

The pool's volumes are taken back out of clustered mode straight away but note that the Pacemaker DLM resource itself is left in place as HA groups can be recreated as part of maintenance operations.

Deleting the HA group does '''not''' turn the feature off. Removing an HA group is a routine step in HA pool maintenance, and tearing the DLM down with it would drop the reservations a running Windows cluster is holding, so the lockspaces and the devices holding them are deliberately left as they are. Removing the DLM configuration entirely is a support operation; contact OSNEXUS support if you need it.

== Allow Reboot / Lock Recovery ==

The General tab carries a second, related checkbox: '''Allow Reboot / Lock Recovery'''. It is off by default, and it applies to HA pools whether or not clustered reservations are enabled.

It exists for one situation. When an appliance has been fenced away from a pool -- its peer took the pool over and preempted its reservations on the pool's disks -- the pool on the fenced appliance goes SUSPENDED or FAILED, and ZFS cannot bring a suspended pool back without a reboot. Until that reboot the appliance serves nothing, and it cannot always be shut down cleanly either, because I/O already submitted to the suspended pool never completes. Left alone, the appliance sits in that state until an administrator restarts it by hand.

Ticking the checkbox allows the appliance to restart itself to recover. QuantaStor does not otherwise reboot appliances on its own, so the restart is hedged with three conditions, all of which must hold:

# at least one pool imported on the appliance is SUSPENDED or FAILED;
# every such pool's HA group has '''Allow Reboot / Lock Recovery''' ticked -- one group that has not opted in vetoes the restart;
# the appliance holds no other healthy pool, so an appliance that is still serving storage is never restarted.

When the conditions hold, QuantaStor raises an alert and starts a three-minute countdown task before restarting. Cancel the task to stop the restart; the veto lasts until the appliance next reboots. The conditions are checked again just before the restart, so failing a pool back to the appliance during the countdown also stops it. The appliance does not re-import the pool when it comes back -- the pool belongs to its peer by then -- which is why the restart cannot loop.

From the command line the equivalent is {{Code|1=--allow-lock-recovery-reboot=enabled}} on [[QuantaStor CLI Command Reference#ha-group-modify|qs ha-group-modify]] or [[QuantaStor CLI Command Reference#ha-group-create|qs ha-group-create]]; as with {{Code|1=--enable-cluster-pr}}, leaving it out leaves the setting unchanged.

== Checking the state on an appliance ==

Two read-only commands, run as root (with {{Code|1=sudo}}) from a shell on an appliance in the HA group, show whether reservations are being shared.

{{Code|1=qs-scstdlm check}} reports whether the appliance's distributed lock manager is ready, and if not, the first thing standing in the way:

<pre style="font-size: smaller">
sudo qs-scstdlm check
</pre>

A ready appliance prints lines beginning {{Code|1=READY:}}. A line beginning {{Code|1=NOTREADY:}} names the problem -- the DLM daemon not installed, the Pacemaker DLM resource not created, Corosync with no cluster name, and so on. On an HA group that has never had the feature enabled it reports the following, which is expected until you enable the setting and is not a fault:

<pre style="font-size: smaller">
NOTREADY: the Pacemaker 'dlm' resource has not been created in the cluster.
</pre>

{{Code|1=qs-scstdlm inspect}} lists every SCSI target device on the appliance with its clustered-mode flag, whether the appliance has joined that device's lockspace, and the persistent reservations the device currently holds:

<pre style="font-size: smaller">
sudo qs-scstdlm inspect
sudo qs-scstdlm inspect --no-prs
</pre>

Add {{Code|1=--no-prs}} to list the devices without their reservations, which keeps the output short on an appliance exporting many volumes.

In the {{Code|1=CLM}} column, {{Code|1=1}} means the device is in clustered mode. The {{Code|1=LOCKSPACE}} column should read {{Code|1=joined}} for every such device. {{Code|1=NOT-JOINED}} alongside {{Code|1=CLM}} 1 means that volume's reservations are not being shared and would not survive a failover. An appliance with no volumes in clustered mode prints {{Code|1=(no SCST devices with a cluster_mode attribute on this node)}}. On the appliance that does not own the pool, the devices are the placeholders described in [[#How it works|How it works]] and show no backing file. Run it on both appliances: after the Windows cluster has taken its reservations, both should list the same registrations for each volume.

== Troubleshooting ==

'''Enabling is refused with a version error.''' The message names the appliance holding it up. Either it is on a release older than 6.9.0, or it has had new target drivers installed and has not rebooted onto them. Finish upgrading that appliance, including the reboot, and try again.

'''The setting is Enabled but volumes are not in clustered mode.''' Run {{Code|1=qs-scstdlm check}} on each appliance. QuantaStor holds volumes out of clustered mode until the appliance is running a supported platform, is a member of a site cluster, has Corosync and Pacemaker running with a named cluster, and has a running DLM daemon, and it records which condition is missing in the service log. Once the condition clears, the volumes switch over on their own.

'''Validation fails the SCSI-3 persistent reservation test.''' Confirm the setting is Enabled on the pool's HA group, and that {{Code|1=qs-scstdlm inspect}} shows every volume in clustered mode and joined on both appliances. A disk presented from a pool that is not in an HA group, or through an appliance's own address rather than the HA virtual interface, is not covered by the feature.

'''Cluster disks went offline after a failover.''' Check whether the setting was Enabled at the time. Reservations taken while it was Disabled are not shared, and are lost when the pool moves. Enable the setting, then bring the cluster disks back online in Failover Cluster Manager.

== Related pages ==

* [[Storage Volumes]] -- creating volumes, assigning them to hosts, and the multi-host caution
* [[Hosts and Host Groups]] -- host records, initiators, and Host Groups for clusters
* [[Fibre Channel Target Port Management]] -- presenting volumes over Fibre Channel
* [[HA Cluster Setup (JBODs)]] -- HA groups, failover, and I/O fencing on the pool's own disks
* [[HA Cluster Setup (external SAN)]] -- HA pools on LUNs from a back-end array
* [[Site Cluster Setup]] -- the Corosync and Pacemaker cluster the DLM runs on
* [[Multipath Configuration]] -- multipath on the client
* [[QuantaStor CLI Command Reference]] -- full argument lists for the commands above

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

Clustered SCSI-3 Persistent Reservations

2026-09-28T20:27:58Z

Umbe: /* Requirements */

[[Category:admin_guide]]

Clustered SCSI-3 persistent reservations let the reservations a client cluster places on QuantaStor [[Storage Volumes]] survive an HA failover. Windows Server Failover Clustering -- including Hyper-V with Cluster Shared Volumes and SQL Server Failover Cluster Instances -- depends on them. This page explains why those clusters need the feature, how to turn it on for an HA pool, and what QuantaStor does when you do.

'''The feature is off by default. If you present HA pool volumes to a Windows failover cluster, turn it on in the HA group's Modify Group dialog before the cluster starts using the disks.'''

{| class="wikitable"
! Section !! Purpose
|-
| [[#Why Windows failover clusters need it|Why Windows failover clusters need it]] || What persistent reservations do for WSFC, and what goes wrong without this feature
|-
| [[#How it works|How it works]] || How reservations are shared between the appliances of an HA group
|-
| [[#Requirements|Requirements]] || Pool type, protocols, operating system, release and cluster prerequisites
|-
| [[#Enabling clustered reservations|Enabling clustered reservations]] || The HA group setting, in the web interface and from the CLI
|-
| [[#Setting up a Hyper-V or WSFC cluster|Setting up a Hyper-V or WSFC cluster]] || End-to-end walkthrough from HA group to Cluster Shared Volume
|-
| [[#When to leave it disabled|When to leave it disabled]] || What the feature costs, and why it is not on by default
|-
| [[#Disabling clustered reservations|Disabling clustered reservations]] || What turning it off does to a running cluster
|-
| [[#Allow Reboot / Lock Recovery|Allow Reboot / Lock Recovery]] || The companion setting in the same dialog
|-
| [[#Checking the state on an appliance|Checking the state on an appliance]] || Confirming every volume is sharing its reservations
|-
| [[#Troubleshooting|Troubleshooting]] || When the setting is on but reservations are not shared
|}

== Why Windows failover clusters need it ==

A Windows Server Failover Cluster arbitrates ownership of its shared disks with SCSI-3 persistent reservations (PR). Each cluster node registers a key with every clustered LUN, and the node that owns a disk holds a reservation on it. When a node stops responding, the surviving nodes remove its registration, which fences it off the disk so it cannot keep writing to storage the cluster has handed to someone else. Cluster Shared Volumes, where every node reads and writes the same LUN at once, rely on this to keep a failed node away from the volume. SQL Server Failover Cluster Instances use the same cluster disks and depend on it in the same way.

Because the whole cluster depends on reservations behaving correctly, Microsoft's '''Validate a Configuration''' wizard tests them. Its storage tests register, reserve, preempt and release keys against every candidate disk, and a disk that fails the SCSI-3 persistent reservation test cannot be used as a supported cluster disk.

A reservation is state held by the SCSI target, not data on the disk. On a QuantaStor HA pool the target that recorded the reservation is the appliance that currently owns the pool. Without clustered reservations, that record exists only on that appliance. When the pool fails over, the receiving appliance starts serving the same LUNs with an empty reservation table: every key the Windows nodes registered, and the reservation that says which node owns each disk, is gone. The pool came back, but from the cluster's point of view the disks no longer carry the registrations it placed on them, and it treats them as failed. Cluster disks go offline and Cluster Shared Volumes stop, which is exactly the outage an HA pool is meant to prevent.

With '''Clustered SCSI3-PR Reservations''' enabled, every appliance in the HA group holds the same reservation state for every volume in the pool, so the appliance that takes the pool over already knows every registration and reservation, and the Windows cluster sees no change.

This is a different thing from the persistent reservations QuantaStor places on the pool's own disks. Those are I/O fencing: QuantaStor arbitrating which appliance may import the pool, described in [[HA Cluster Setup (JBODs)#I/O fencing and SCSI-3 persistent reservations|I/O fencing and SCSI-3 persistent reservations]]. Clustered reservations concern the reservations that '''clients''' place on the storage volumes QuantaStor exports, and the two are independent.

== How it works ==

QuantaStor shares reservation state between the appliances of an HA group through the Linux distributed lock manager (DLM), which runs as a resource of the site cluster's Corosync and Pacemaker stack.

* Every exported storage volume in the pool gets its own DLM lockspace, named after the volume's SCSI device identifier. The reservation state lives in that lockspace rather than in a single appliance's memory.
* The appliance that owns the pool serves the volume and is a member of its lockspace.
* Every other appliance in the HA group -- the secondary, and the tertiary if the group has one -- holds a placeholder device with the same identity, which keeps it a member of the same lockspace. It carries no data; its job is to hold a copy of the reservation state.
* During a failover the appliances swap roles device by device, so at every moment at least one appliance is holding each volume's reservations. The appliance taking over joins with the state already in place.

Setting the HA group to Enabled is the whole of the configuration. QuantaStor installs the DLM, creates and starts the Pacemaker DLM resource, and switches the pool's volumes into clustered mode on every appliance in the group. Appliances that did not run the operation converge on their own shortly afterwards, and an appliance that was down or rebuilt catches up when it returns. Volumes created in the pool later pick the setting up when they are created.

== Requirements ==

* '''QuantaStor scale-up Storage Pool (ZFS) protected by an HA group.''' Clustered reservations are a property of the HA group, so a pool without one cannot use them. See [[HA Cluster Setup (JBODs)]] and [[HA Cluster Setup (external SAN)]].
* '''iSCSI or Fibre Channel.''' The feature applies to storage volumes exported over iSCSI and Fibre Channel. It does not apply to NVMe over Fabrics.
* '''QuantaStor 6.9 or newer''' The DLM and SCSI target driver changes the feature depends on are built for standard QuantaStor installs on 6.9 and newer and is not yet available on RHEL based configurations. Non-Ubuntu based QuantaStor configurations will refuse to put volumes into clustered mode rather than risk the target stack.
* '''Every appliance in the HA group at QuantaStor 6.9.0 or newer, and rebooted onto its current target driver.''' Enabling the setting is refused, naming the appliance, if any member of the group is on an older release, or if an appliance has had new target drivers installed but has not rebooted since. Complete the upgrade on every node, including the reboot, before turning the feature on.
* '''A healthy site cluster.''' The appliances must be members of a [[Site Cluster Setup|site cluster]] with Corosync and Pacemaker running. QuantaStor gives the Corosync cluster a name if it does not have one, because the DLM cannot start without it; this is done across the cluster under maintenance mode, and needs no action from you.

The operating system on the Windows side needs nothing beyond what a failover cluster already requires: multipath I/O configured for the iSCSI or Fibre Channel paths to the QuantaStor appliances, and the cluster nodes' initiators registered as hosts on QuantaStor.

== Enabling clustered reservations ==

{{Navigation|Storage Management → Storage Pools ''(section)'' → ''select the pool'' → Storage Pool HA Resource Group ''(toolbar group)'' → Modify Group}}

[[File:hagroup_modify_clusterpr.png|thumb|right|470px|The General tab of Modify Storage Pool High-Availability Group. Clustered SCSI3-PR Reservations shows Disabled, the default for a new HA group; Allow Reboot / Lock Recovery sits directly below it.]]

On the '''General''' tab of the '''Modify Storage Pool High-Availability Group''' dialog, set '''Clustered SCSI3-PR Reservations''' to '''Enabled''' and click '''OK'''.

The same field is on the Create Group dialog, so you can enable it when you first create the HA group. On both dialogs it offers '''Enabled''' and '''Disabled''', and a new HA group starts at '''Disabled'''.

The change applies to the running pool. No failover, service restart or reboot is needed: existing volumes are switched into clustered mode in place, and the other appliances in the group converge within a short time. The Modify Group task reports "Enabling SCSI3-PR distributed locking" while it works. On an appliance that has never had the DLM installed, the first enable includes the package install and takes longer.

If the DLM cannot be configured -- the site cluster is not running, for example -- the HA group is still created or modified, because it is useful without clustered reservations. QuantaStor records the reason in the service log -- and, on a create, raises a warning on the group -- and keeps retrying on its own, and the volumes take up clustered mode once the condition is cleared.

'''Enable it before the Windows cluster takes reservations on the volumes.''' The walkthrough below does it first for that reason.

=== From the command line ===

[[QuantaStor CLI Command Reference#ha-group-modify|qs ha-group-modify]] and [[QuantaStor CLI Command Reference#ha-group-create|qs ha-group-create]] take {{Code|1=--enable-cluster-pr}}:

<pre style="font-size: smaller">
qs ha-group-modify --ha-group=pool-1-ha-group --enable-cluster-pr=enabled
</pre>

It accepts {{Code|1=enabled}}, {{Code|1=disabled}} and {{Code|1=auto}}, and {{Code|1=auto}} is what you get when you leave the argument out. On a modify, {{Code|1=auto}} leaves the current setting unchanged, so a command that changes some other property of the group never switches clustered reservations off as a side effect. On a create, {{Code|1=auto}} resolves to disabled unless the pool's volumes are already in clustered mode. Pass {{Code|1=enabled}} explicitly when you want the feature.

== Setting up a Hyper-V or WSFC cluster ==

This is the order to follow when presenting QuantaStor volumes to a new Windows Server Failover Cluster, whether for Hyper-V Cluster Shared Volumes or for a SQL Server Failover Cluster Instance.

=== 1. Enable clustered reservations on the HA group ===

Set '''Clustered SCSI3-PR Reservations''' to '''Enabled''' on the pool's HA group, as described in [[#Enabling clustered reservations|Enabling clustered reservations]]. Do this first, so that every reservation the cluster ever takes is shared between the appliances from the start.

=== 2. Create the volumes ===

Create the volumes the cluster will use in the HA pool -- see [[Storage Volumes#Creating a Storage Volume|Creating a Storage Volume]]. A small volume for the cluster's disk witness, if you intend to use one, belongs in the same pool.

=== 3. Present the volumes to every cluster node ===

Add each Windows cluster node as a host with its iSCSI IQN or Fibre Channel WWPNs, put all of the nodes in one Host Group, and assign the volumes to that Host Group. [[Hosts and Host Groups#Host Groups|Host Groups]] covers why a group assignment is the right tool for a cluster; for Fibre Channel, [[Fibre Channel Target Port Management#Assigning a storage volume over FC|Assigning a storage volume over FC]] covers zoning and WWPNs.

For iSCSI, have each node log in to the pool's HA virtual interface rather than an appliance's own address, so its sessions follow the pool when it fails over. For Fibre Channel, configure multipath on each node; QuantaStor advertises the paths through the owning appliance as active and the others as standby.

=== 4. Bring the disks online on one node ===

On one cluster node, rescan storage, bring the new disks online, initialize them and create the volumes you intend to use, in the usual way for disks that will become cluster disks. The other nodes see the same LUNs through the host group and need no preparation of their own.

=== 5. Run cluster validation ===

Run the '''Validate a Configuration''' wizard in Failover Cluster Manager, or the {{Code|1=Test-Cluster}} PowerShell cmdlet, against all of the nodes and include the storage tests. The SCSI-3 persistent reservation test should pass on every QuantaStor disk.

If you want proof that reservations survive a failover before going into production, fail the pool over to the other appliance with '''Manual Failover''' (see [[HA Cluster Setup (JBODs)#Deliberate failover|Deliberate failover]]) and run the storage validation again, or confirm in Failover Cluster Manager that the cluster disks stayed online throughout.

=== 6. Add the disks to the cluster and to Cluster Shared Volumes ===

Add the validated disks to the cluster as cluster disks, then add the ones Hyper-V will use to Cluster Shared Volumes. For a SQL Server Failover Cluster Instance, select the cluster disks during SQL Server's failover cluster setup instead.

== When to leave it disabled ==

Leave the setting Disabled on HA groups whose clients never take SCSI-3 reservations -- VMware vSphere datastores, Linux hosts, file shares, and single Windows servers. The feature is off by default because it has a cost:

* '''One DLM lockspace for every exported volume''', held on every appliance in the HA group, including the ones not serving the pool. A pool whose clients never reserve a LUN gains nothing from that.
* '''A dependency on the cluster's lock manager.''' A volume in clustered mode relies on the DLM being able to form and recover its lockspace. QuantaStor gates every step on the DLM being verified healthy on the appliance, precisely because a lockspace that cannot be joined or recovered can stall the appliance's SCSI target. That is a risk worth taking for a Windows cluster that needs the feature, and not one to take by default.

== Disabling clustered reservations ==

Set '''Clustered SCSI3-PR Reservations''' back to '''Disabled''' in Modify Group. The dialog asks you to confirm, and means it:

<blockquote>''Disabling Clustered Persistent Reservations is disruptive to connected clustered clients such as Windows Server with Hyper-V. Reservations are no longer shared across the HA cluster, so any reservation a client is holding will be LOST the next time this pool fails over. Are you sure you want to do this?''</blockquote>

The pool's volumes are taken back out of clustered mode straight away. The Pacemaker DLM resource itself is left in place.

Deleting the HA group does '''not''' turn the feature off. Removing an HA group is a routine step in HA pool maintenance, and tearing the DLM down with it would drop the reservations a running Windows cluster is holding, so the lockspaces and the devices holding them are deliberately left as they are. Removing the DLM configuration entirely is a support operation; contact OSNEXUS support if you need it.

== Allow Reboot / Lock Recovery ==

The General tab carries a second, related checkbox: '''Allow Reboot / Lock Recovery'''. It is off by default, and it applies to HA pools whether or not clustered reservations are enabled.

It exists for one situation. When an appliance has been fenced away from a pool -- its peer took the pool over and preempted its reservations on the pool's disks -- the pool on the fenced appliance goes SUSPENDED or FAILED, and ZFS cannot bring a suspended pool back without a reboot. Until that reboot the appliance serves nothing, and it cannot always be shut down cleanly either, because I/O already submitted to the suspended pool never completes. Left alone, the appliance sits in that state until an administrator restarts it by hand.

Ticking the checkbox allows the appliance to restart itself to recover. QuantaStor does not otherwise reboot appliances on its own, so the restart is hedged with three conditions, all of which must hold:

# at least one pool imported on the appliance is SUSPENDED or FAILED;
# every such pool's HA group has '''Allow Reboot / Lock Recovery''' ticked -- one group that has not opted in vetoes the restart;
# the appliance holds no other healthy pool, so an appliance that is still serving storage is never restarted.

When the conditions hold, QuantaStor raises an alert and starts a three-minute countdown task before restarting. Cancel the task to stop the restart; the veto lasts until the appliance next reboots. The conditions are checked again just before the restart, so failing a pool back to the appliance during the countdown also stops it. The appliance does not re-import the pool when it comes back -- the pool belongs to its peer by then -- which is why the restart cannot loop.

From the command line the equivalent is {{Code|1=--allow-lock-recovery-reboot=enabled}} on [[QuantaStor CLI Command Reference#ha-group-modify|qs ha-group-modify]] or [[QuantaStor CLI Command Reference#ha-group-create|qs ha-group-create]]; as with {{Code|1=--enable-cluster-pr}}, leaving it out leaves the setting unchanged.

== Checking the state on an appliance ==

Two read-only commands, run as root (with {{Code|1=sudo}}) from a shell on an appliance in the HA group, show whether reservations are being shared.

{{Code|1=qs-scstdlm check}} reports whether the appliance's distributed lock manager is ready, and if not, the first thing standing in the way:

<pre style="font-size: smaller">
sudo qs-scstdlm check
</pre>

A ready appliance prints lines beginning {{Code|1=READY:}}. A line beginning {{Code|1=NOTREADY:}} names the problem -- the DLM daemon not installed, the Pacemaker DLM resource not created, Corosync with no cluster name, and so on. On an HA group that has never had the feature enabled it reports the following, which is expected until you enable the setting and is not a fault:

<pre style="font-size: smaller">
NOTREADY: the Pacemaker 'dlm' resource has not been created in the cluster.
</pre>

{{Code|1=qs-scstdlm inspect}} lists every SCSI target device on the appliance with its clustered-mode flag, whether the appliance has joined that device's lockspace, and the persistent reservations the device currently holds:

<pre style="font-size: smaller">
sudo qs-scstdlm inspect
sudo qs-scstdlm inspect --no-prs
</pre>

Add {{Code|1=--no-prs}} to list the devices without their reservations, which keeps the output short on an appliance exporting many volumes.

In the {{Code|1=CLM}} column, {{Code|1=1}} means the device is in clustered mode. The {{Code|1=LOCKSPACE}} column should read {{Code|1=joined}} for every such device. {{Code|1=NOT-JOINED}} alongside {{Code|1=CLM}} 1 means that volume's reservations are not being shared and would not survive a failover. An appliance with no volumes in clustered mode prints {{Code|1=(no SCST devices with a cluster_mode attribute on this node)}}. On the appliance that does not own the pool, the devices are the placeholders described in [[#How it works|How it works]] and show no backing file. Run it on both appliances: after the Windows cluster has taken its reservations, both should list the same registrations for each volume.

== Troubleshooting ==

'''Enabling is refused with a version error.''' The message names the appliance holding it up. Either it is on a release older than 6.9.0, or it has had new target drivers installed and has not rebooted onto them. Finish upgrading that appliance, including the reboot, and try again.

'''The setting is Enabled but volumes are not in clustered mode.''' Run {{Code|1=qs-scstdlm check}} on each appliance. QuantaStor holds volumes out of clustered mode until the appliance is running a supported platform, is a member of a site cluster, has Corosync and Pacemaker running with a named cluster, and has a running DLM daemon, and it records which condition is missing in the service log. Once the condition clears, the volumes switch over on their own.

'''Validation fails the SCSI-3 persistent reservation test.''' Confirm the setting is Enabled on the pool's HA group, and that {{Code|1=qs-scstdlm inspect}} shows every volume in clustered mode and joined on both appliances. A disk presented from a pool that is not in an HA group, or through an appliance's own address rather than the HA virtual interface, is not covered by the feature.

'''Cluster disks went offline after a failover.''' Check whether the setting was Enabled at the time. Reservations taken while it was Disabled are not shared, and are lost when the pool moves. Enable the setting, then bring the cluster disks back online in Failover Cluster Manager.

== Related pages ==

* [[Storage Volumes]] -- creating volumes, assigning them to hosts, and the multi-host caution
* [[Hosts and Host Groups]] -- host records, initiators, and Host Groups for clusters
* [[Fibre Channel Target Port Management]] -- presenting volumes over Fibre Channel
* [[HA Cluster Setup (JBODs)]] -- HA groups, failover, and I/O fencing on the pool's own disks
* [[HA Cluster Setup (external SAN)]] -- HA pools on LUNs from a back-end array
* [[Site Cluster Setup]] -- the Corosync and Pacemaker cluster the DLM runs on
* [[Multipath Configuration]] -- multipath on the client
* [[QuantaStor CLI Command Reference]] -- full argument lists for the commands above

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

Product EOL Notifications

2026-09-22T23:32:47Z

Umbe: /* End-Of-Life EOL Version Information */

[[CATEGORY:support_guide]]

== What Does EOL Mean? ==
EOL, or End-of-Life for a given version means that that version should no longer be used for new installations. '''OSNexus supports all systems with active licenses irrespective of what version there on.''' That said, QuantaStor is Linux based and systems must be periodically upgraded to ensure we can keep your system up to date with the latest QuantaStor software and Linux security patches. As such if a system is on an older EOL version of QuantaStor we may require the system to be upgraded to resolve a given support ticket. OSNexus provides assistance with upgrades and we recommend getting a support ticket opened if you're system is running an older Linux distro where a distro upgrade is required.

== What Determines EOL? ==

QuantaStor product Security Updates EOL timeline follows the Ubuntu Server LTS EOL timelines. When a given underlying Linux distro no longer has security updates available for it we move that series of QuantaStor releases over to EOL so that we don't get any new deployments using those versions. One should always setup new systems with the latest version of QuantaStor as there is compatibility for having newer and older versions of QuantaStor in the same storage grid.

If you're running QuantaStor on a different distro like RHEL or a RHEL derivative your EOL timeline may be different. Again, OSNEXUS supports QuantaStor installations through their full subscription term irrespective of the QuantaStor version but EOL versions may require an upgrade to address a given support ticket. We urge customers to upgrade at least annually to keep their QuantaStor deployments current and assistance is available for upgrades, simply email support to schedule a Zoom call to get assistance. Some deployments may require a maintenance windows for upgrades especially when moving up from very old Linux distributions. Keeping current with releases also keeps a deployment current with the latest security updates from the Linux community.

== End-Of-Life EOL Version Information ==
* '''QuantaStor v7.0 [ETA October 2026]'''
** Derivative of Ubuntu 24.04.x LTS w/ Ceph v20/Tentacle
** ETA Tech Preview June, 2026
** ETA General Availability August, 2026
* '''QuantaStor v6.7 and newer releases [CURRENT RELEASE]'''
** Derivative of Ubuntu 22.04.x LTS with Ubuntu 24.04 LTS Hardware Enablement Kernel
** Distro upgrade support for moving forward from Ubuntu 20.04 (Focal) to Ubuntu 22.04 (Jammy) is now available with QuantaStor 6.5.1 and newer.
** EOL July, 2027
* '''QuantaStor v6.x releases [EOL - UPGRADE REQUIRED]'''
** Derivative of Ubuntu 20.04.x LTS with Ubuntu 22.04 LTS Hardware Enablement Kernel
** EOL July, 2025
* '''QuantaStor v5.x releases [EOL - UPGRADE REQUIRED]'''
** Derivative of Ubuntu 18.04.x LTS
** EOL April, 2023
* '''QuantaStor v5.x releases [EOL - UPGRADE REQUIRED]'''
** Derivative of Ubuntu 16.04.x LTS
** EOL April, 2021
* '''QuantaStor v4.x and older releases [EOL - UPGRADE REQUIRED]'''

QuantaStor Systems refer to the Ubuntu LTS security package servers so that important security updates can be quickly applied as they are made available by the community.
To maintain support on proper security compliance of QuantaStor Systems they should be upgraded on a regular basis using the QuantaStor Upgrade Manager dialog via the web management interface (alternatively upgrades can be run using SSH/console using 'sudo qs-upgrade').
.

== Hardware Enablement Kernel Updates ==

QuantaStor releases occasionally include new kernel updates to support the latest storage and networking hardware. Kernel updates come out typically once or twice a year at most and generally align with the Ubuntu LTS Kernel [https://wiki.ubuntu.com/Kernel/Support?action=AttachFile&do=get&target=LTS+Kernel+Support+Schedule.png releases].

QuantaStor REST API Reference v6.8

2026-09-22T18:45:45Z

Umbe: Created page with "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..."

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

+ Developer Guide Overview

2026-09-22T18:45:18Z

Umbe: /* Archived Versions */

[[Category:dev_guide]]
== Overview ==
QuantaStor was designed from the start with a service oriented architecture so that all aspects of system, cluster, and storage grid configuration may be automated. There are multiple ways to automate QuantaStor management operations including the REST API, CLI, Ansible modules, and SOAP. The Developer Guide focuses on integration with QuantaStor via the REST APIs.

== Supported Languages ==
You can use just about any programming language you like to communicate with QuantaStor via our RESTful API. Recommended tools:

* C/C++ - [http://curl.haxx.se/libcurl/ libcurl]
* Python - [http://pypi.python.org/pypi/pycurl PyCurl]
* Unix/Linux/VMware/XenServer scripting - [http://curl.haxx.se/docs/httpscripting.html curl]
* PHP - [http://php.net/manual/en/book.curl.php curl]

== Browser Tools ==

We highly recommend installing a tool like [http://jsonview.com/ JSONView] or other similar browser tool so that you can view the JSON output from the various API calls in an easy to read format. When experimenting with various APIs you can then use your browser to call the API, see the results, and plan for how to integrate it into your script or application.

== Examples ==

Here's are some examples of how to enumerate various objects using the RESTful API and the curl utility:

<pre>
curl -u admin:password https://192.168.0.116:8153/qstorapi/hostEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/storageVolumeEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/storageSystemGet -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/storagePoolEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/userEnum -k
curl -u admin:password https://192.168.0.116:8153/qstorapi/networkShareEnum -k
</pre>

One quick way to test is to just enter one of these URLs (https://192.168.0.116:8153/qstorapi/hostEnum) into your web browser which will work as long as your system admin account is still using the default password. Pretty much every known language has a curl type library/module for it so the above technique will work everywhere, you just need to get up to speed with your preferred language's curl API mechanism.

Note you can even access APIs using wget which in this example will store the results into a file called hostEnum:
<pre>
wget --no-check-certificate https://192.168.0.135:8153/qstorapi/hostEnum
</pre>

=== Passing Args as a File ===

You can also call one of our RESTful APIs by passing a file instead of command line arguments. To do this your command will look something like this:

<pre>
curl -k -u admin:password -d @file.json https://192.168.0.116:8153/qstorapi/jsonrpc
</pre>

An example of how the file should be formatted looks like this:
<pre>
{
"method": "echo",
"params": {
"inputMessage": "Message"
}
}
</pre>

The format being used is JSON. You specify the command you would like to call using the key "method". Then the parameters are passed in using the key "params". If more than one parameter is specified, separate them with a comma.

<pre>
{
"method": "command",
"params": {
"param1": "<value1>",
"param2": "<value2>",
"param3": "<value3>"
}
}
</pre>

== Reflection ==
The RESTful API has basic support for reflection, meaning that you can learn about all the arguments for a given API just by calling it with the 'help' parameter like so:
<pre>
curl -k -u admin:password https://192.168.0.116:8153/qstorapi/hostAdd?help
</pre>

== Calling APIs with Parameters ==
To call an API with parameters you'll need to add a & between each parameter you specify and a ? between the API name and the start of the parameters like so:
<pre>
curl -k -u admin:password "https://192.168.0.116:8153/qstorapi/hostAdd?iqn=iqn.1991-05.com.microsoft:osn-mediaserver3&hostname=mediaserver3&flags=0"
</pre>
Which will return JSON output like this (note the quotes so that the ampersand is not interpreted by the shell). Also note that sometimes it can be hard to read the JSON output so we recommend using a [http://jsonviewer.stack.hu/ JSON Formatter] when you're developing your integration code.
<pre>
{
"task":{
"i18nDescription":{
"messageText":null,
"messageId":null
},
"operation":"add",
"id":"ca54a531-6386-a4f7-b9de-30f505329bb1",
"objectType":"Host",
"finishTimeStamp":"1969-12-31 16:00:00",
"isRemote":false,
"createdTimeStamp":"2012-08-23 21:53:40",
"state":0,
"acls":[
{
"reserved":0,
"objectId":"ca54a531-6386-a4f7-b9de-30f505329bb1",
"ownerType":23,
"ownerId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
"accessLevel":2,
"objectType":16
}
],
"clientIpAddress":"127.0.0.1",
"parentId":null,
"modifiedByUserId":null,
"progress":0,
"customId":null,
"type":16,
"description":"Adding host 'mediaserver3' to service with iSCSI initiator IQN 'iqn.1991-05.com.microsoft:osn-mediaserver3'.",
"errorMessage":{
"function":null,
"severity":0,
"errorCode":0,
"file":null,
"message":{
"messageText":null,
"messageId":null
},
"line":0
},
"modifiedTimeStamp":"1969-12-31 16:00:00",
"storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604",
"createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
"name":"Add Host",
"startTimeStamp":"2012-08-23 21:53:40",
"taskState":2
},
"obj":{
"username":null,
"storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604",
"isRemote":false,
"hostGroupId":null,
"name":"mediaserver3",
"ipAddress":null,
"createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
"modifiedTimeStamp":"1969-12-31 16:00:00",
"createdTimeStamp":"2012-08-23 21:53:40",
"state":0,
"hostOsType":0,
"initiatorPortList":[
{
"storageSystemId":"50ce62e6-6846-c5b3-d8a1-27061a696604",
"isRemote":false,
"hostId":"4fb8c2da-235a-18f9-2620-1d8aa5da89c5",
"name":"iqn.1991-05.com.microsoft:osn-mediaserver3",
"ipAddress":null,
"createdByUserId":"252d4786-b19f-ae43-1ff6-453bee8a652e",
"modifiedTimeStamp":"1969-12-31 16:00:00",
"createdTimeStamp":"2012-08-23 21:53:40",
"wwpn":null,
"state":0,
"iqn":"iqn.1991-05.com.microsoft:osn-mediaserver3",
"initiatorType":0,
"modifiedByUserId":null,
"customId":null,
"type":13,
"id":"535abed2-830a-a437-d6fd-5af7c5b5c263"
}
],
"modifiedByUserId":null,
"customId":null,
"password":"********",
"type":11,
"id":"4fb8c2da-235a-18f9-2620-1d8aa5da89c5",
"description":"None"
}
}
</pre>

== Async vs. Sync (blocking vs non-blocking) API calls ==

All of the APIs for QuantaStor that modify the configuration in any way will start a task in the system. If you call any API with the flags parameter set to 0 it'll be treated as a blocking call which wait for the task to complete before returning. If you want to call the function and have it return immediately you can pass a 1 as the flags parameter which indicates to the server that the caller wants this to be an asynchronous non-blocking call. With asynchronous calls you'll get the task object back so that you can use the taskGet API to monitor the progress of the operation. When the task completes it will populate the customId property of the task to contain the ID(s) of the objects which were created/deleted/modified by the task.

== Task Monitoring ==

As indicated above, sometimes you'll want to call an API asynchronously so that you can monitor the progress of the task and/or because you want to queue up multiple operations to run simultaneously. In such cases where you call an API asynchronously (flags=1) you can monitor the progress of the task using the tastGet API or the tastEnum API if you want to see all running tasks. When the task is completed you can check the customId property to see the ID(s) of the objects created/modified.

== API Error Code Definitions ==

For all APIs a 0 is returned for SUCCESS and a non-zero error code is returned if there is a command failure along with a description of the error. Full list of error codes are available [[Error Codes | here]].

== Security ==

QuantaStor REST interface always uses SSL via HTTPS. You can change the pem keys on your system by replacing the qstorapi_server.pem file located in /opt/osnexus/quantastor/restsrv/ with your own. If you want to use plain HTTP without SSL you can rename or remove the qstorapi_server.pem and the RESTful service will automatically fall back to using HTTP. After removing the file just restart the RESTful service interface with:
<pre>service restsrv restart</pre>
If you want to block access to the restful interface you can stop the service and/or you can remove access to port 8153 by removing the entry associated with that port number from the /etc/init.d/iptables configuration file and then restart iptables like so:
<pre>service iptables restart</pre>
In a similar manner you can block access to the web management interface on port 80/8080.

== Supported SOAP / WebServices Implementations ==

* gSOAP (C++, all platforms)
* Apache Axis (Java, all platforms)
* .NET (C# & Visual Basic, Windows)

== API List ==
The following represents the full API list for every API in QuantaStor. Nothing is left out, if you can do it from the web management interface or the CLI, it's here.

=== Examples ===
<pre>
curl -u username:password -k https://hostname:8153/qstorapi/aclAdd?objectId=<id>&ownerType=<int>&ownerId=<id>&accessLevel=<int>&objectType=<int>

curl -u username:password -k https://hostname:8153/userAdd?username=tiger&password=passWORD1&firstName=Tiger&lastName=Woods&role=Administrator

curl -u username:password -k -d @data.json https://hostname:8153/qstorapi/jsonrpc

</pre>

==== Example Script ====
Here is an example script in python. To use this example replace the ip address with your QuantaStor boxes ip.

<pre>

import json
import subprocess

print "I am getting the storage system info..."
#To get the data make an http request (such as a curl call)

proc = subprocess.Popen(["curl", "-k", "-u", "admin:password",
"https://192.168.0.142:8153/qstorapi/storageSystemGet?"], stdout=subprocess.PIPE)

(out, err) = proc.communicate()

print
print "Here is what the returned data looks like when I get it:"
print
print str(out)
print

#call json.loads to turn it into a python dictionary
out = json.loads(out)
print "Here is how to get a single field from the output:"
print
storageSystemId = out["id"]
print storageSystemId

</pre>

== QuantaStor [[REST API Reference Guide]] ==
All efforts are made to keep existing REST API from changing but on rare occasions API changes to existing APIs and objects may change. As such the following sections document the APIs as per a specific released version of QuantaStor. New versions of QuantaStor generally introduce some new APIs and object types but these are added in a backwards compatible fashion.

[[REST API Reference Guide|Current Version]]

=== Archived Versions ===

[[QuantaStor REST API Reference v7.0 ]]

[[QuantaStor REST API Reference v6.9 ]]

[[QuantaStor REST API Reference v6.8 ]]

[[QuantaStor REST API Reference v6.6 ]]

[[QuantaStor REST API Reference v5.2 ]]

[[QuantaStor REST API Reference v4.2, v4.1]]

[[QuantaStor REST API Reference v4.0 and earlier]]

== Enumeration Types ==

The enumeration types listed below are used with APIs noted above. Many of the enumerations have assigned values like "OSN_CMN_FLAG_ASYNC = 0x0001" but for those that do not have assigned values note that they are 0 indexed.
For example, OSN_CMN_ACCESSTYPE_READWRITE should be specified as 0 and OSN_CMN_ACCESSTYPE_READONLY specified as a 1 to the storageVolumeModify API as the accessMode for changing the configuration of a storage volume.

* [[REST_API_Reference_Guide#Enum_Definitions|QS API Enumerations v5.5]]

== Ansible Documentation ==

Currently, OsNexus does not package the python client or the Ansible modules with the QuantaStor installation package. Individual installation instructions can be found on GitHub (Ansible modules) and PyPi (qsclient).

[https://github.com/OSNEXUS/QSPyClient OSNEXUS Python client in Git: OSNEXUS QSPyClient]

[https://pypi.org/project/quantastor-qsclient OSNEXUS QuantaStor Python Client Library ]

[https://github.com/OSNEXUS/qsansible OSNEXUS Ansible Modules in Git: OSNEXUS qsansible]

For more information about QuantaStor Ansible automation,
<br>checkout our blog post
[https://blog.osnexus.com/2019/11/12/automating-storage-provisioning-using-ansible-with-quantastor Automating storage provisioning using Ansible with Quantastor.]

Bucket Synchronization Policies

2026-09-04T20:08:07Z

Umbe:

[[Category:admin_guide]]

A '''bucket sync policy''' selects which individual Object Buckets replicate between two zones of a multi-site Ceph object storage configuration, so that only the buckets you name are copied to the second site rather than the whole zone. It solves the problem of a multi-site object cluster where the two sites do not need the same data: a bucket holding regulated records has to exist at both sites, while a bucket of scratch data or local build artifacts should stay where it is and not consume capacity or replication bandwidth at the far end. Sync policies are enforced by the Ceph RADOS Gateway (RGW), and you can manage them from the QuantaStor web interface and the CLI.

Everything on this page lives under the '''Remote Replication''' tab, in the '''Bucket Sync Policies''' section. Bucket sync policies apply only to scale-out object storage -- see [[Scale-out Object Setup (ceph)]] for building the object cluster and the multi-site pairing that this feature depends on.

{| class="wikitable"
! Section !! Purpose
|-
| [[Bucket Synchronization Policies#Choosing between bucket sync, remote replication and backup policies|Choosing between bucket sync, remote replication and backup policies]]|| Which QuantaStor replication feature solves your problem
|-
| [[Bucket Synchronization Policies#The multi-site model|The multi-site model]]|| Zones, zone groups, and the two multi-site modes that decide whether bucket sync policies are possible at all
|-
| [[Bucket Synchronization Policies#Multi-site topologies|Multi-site topologies]]|| Worked diagrams of full zone replication, selective bucket sync, and storage class behaviour
|-
| [[Bucket Synchronization Policies#Requirements|Requirements]]|| What must be in place before you can create a policy
|-
| [[Bucket Synchronization Policies#Creating a bucket sync policy|Creating a bucket sync policy]]|| The Create dialog, field by field
|-
| [[Bucket Synchronization Policies#Policy Status and Direction|Policy Status and Direction]]|| What the two enumerations mean, and whether sync is one-way or two-way
|-
| [[Bucket Synchronization Policies#What the create operation does on the appliance|What the create operation does on the appliance]]|| The RGW commands issued, and the limits and preconditions enforced
|-
| [[Bucket Synchronization Policies#Modifying a bucket sync policy|Modifying a bucket sync policy]]|| What can and cannot be changed after creation
|-
| [[Bucket Synchronization Policies#Deleting a bucket sync policy|Deleting a bucket sync policy]]|| What is removed, and what is left behind
|-
| [[Bucket Synchronization Policies#Viewing policies and discovering existing ones|Viewing policies and discovering existing ones]]|| The grid columns, and picking up policies made outside QuantaStor
|-
| [[Bucket Synchronization Policies#Scheduling, conflicts and failures|Scheduling, conflicts and failures]]|| Why there is no schedule, how conflicting writes are handled, and where failures appear
|-
| [[Bucket Synchronization Policies#Managing bucket sync policies from the CLI|Managing bucket sync policies from the CLI]]|| The five <code>qs</code> commands and their arguments
|}

== Choosing between bucket sync, remote replication and backup policies ==

QuantaStor has three unrelated mechanisms for getting data to a second location, and they operate on different objects. Pick by what you are copying.

{| class="wikitable"
! Feature !! Copies !! Between !! Driven by
|-
| '''Bucket sync policies''' ''(this page)'' || S3 objects in an Object Bucket || Two zones of one RGW multi-site zone group || Continuous RGW multi-site sync; no schedule
|-
| [[Remote-replication (DR)|Remote replication]]|| [[Storage Volumes]] and [[Network Shares]]|| Two [[Storage Pools]] on different QuantaStor systems || Replication schedules, block-level incremental, with replica checkpoints and DR failover
|-
| [[Backup Policies|Backup policies]]|| Files in a [[Network Shares|Network Share]]|| A Network Share and an NFS/SMB export or a [[Cloud Containers / NAS Gateway|Cloud Container]]|| Backup schedules, file-level, with per-run Backup Job objects
|}

Two distinctions catch people out:

* A bucket sync policy is '''not''' a DR feature in the [[Remote-replication (DR)|Remote replication]] sense. There is no replica checkpoint to activate, no failover or failback operation, and no schedule to trigger. Ceph keeps the two zones converged continuously, and both zones are live members of the same zone group rather than a source and a standby.
* A [[Cloud Containers / NAS Gateway|Cloud Container]] is also about buckets, but it points the other way: it maps '''one external bucket''' onto a QuantaStor Network Share so that NFS and SMB clients can read and write object storage as a file share. It is a gateway into somebody else's object storage, not replication between two QuantaStor object clusters. Bucket sync policies never involve a Cloud Container, cloud provider credentials, or a Network Share.

Bucket sync policies act on Object Buckets in a QuantaStor-managed Ceph cluster. Buckets themselves are created and managed under the Scale-out Storage Configuration tab; this page covers only the replication of their contents.

== The multi-site model ==

Scale-out object storage in QuantaStor is organized as RGW '''zones''' inside a '''zone group'''. Each zone corresponds to one Object Storage Pool Group on one Ceph cluster, fronted by an RGW gateway. Pairing two of them into a zone group is what makes replication possible at all, and it is done once, from the Setup Object Storage Multi-Site Configuration dialog -- see [[Scale-out Object Setup (ceph)]].

'''The choice you make when pairing the zones decides whether bucket sync policies are usable.''' The Multi-Site Setup dialog has a '''Bucket Sync Settings''' section with two radio options:

{| class="wikitable"
! Option !! What it configures !! Bucket sync policies
|-
| '''Sync selected buckets''' ''(default)'' || A zone-level policy named <code>default-deny-''<primary zone>''-''<secondary zone>''</code> with status ''allowed''. Nothing replicates until you say what should. || Required. This is the mode this page is about.
|-
| '''Full zone replication (no individual bucket sync)''' || A zone-level policy named <code>default-enabled-''<primary zone>''-''<secondary zone>''</code> with status ''enabled'', with a symmetrical flow across both zones. Everything in the zone replicates. || Refused. Creating one fails with ''"Cannot add individual bucket sync policies. Multi-site setup cannot be in full zone replication mode."''
|}

The equivalent CLI argument is <code>--symmetrical</code> on [[QuantaStor CLI Command Reference#object-pool-group-multi-site-setup|qs object-pool-group-multi-site-setup]], whose help text describes full zone replication as being for "a full copy of the zone group in a secondary site for disaster recovery purposes".

Two consequences of how the default rule is created are worth knowing before you plan a topology:

* '''The bucket exists in both zones either way.''' Bucket names are zone-group-wide, so a bucket created in one zone shows up in the other as soon as the zone group knows about it. What a sync policy governs is whether the '''object data''' inside it is copied. In ''Sync selected buckets'' mode you will see empty buckets at the second site until a policy enables them.
* '''Only the pair you configured gets a default rule.''' Multi-site setup pairs one primary zone with one secondary zone, so if you pair a primary with two secondaries, the two secondary zones have no default rule between them and no sync between them. Establishing sync directly between two secondary zones needs a zone-level policy covering that pair, created deliberately.

RGW does not support replicating a bucket to another bucket '''within the same zone''', so a policy always crosses zones. The Create dialog enforces this by refusing to offer the source cluster as its own destination.

[[File:Bucket Sync Policy - Zone.png|thumb|right|271px|Bucket-to-bucket replication inside a single zone is not supported by RGW, so a sync policy always spans two zones.]]

== Multi-site topologies ==

These diagrams work through the combinations of multi-site mode and bucket sync policy, using one primary zone (us-east-1) and two secondary zones (us-west-1, us-west-2). A shaded bucket holds object data; an unshaded bucket exists but is empty. <code><<<>>></code> marks a symmetrical policy and <code>>>></code> a directional one.

[[File:Bucket Sync - Multi-Site Full Zone Replication.jpg|thumb|right|618px|Full zone replication to both secondaries. Zone-level <code>default-enabled-</code> policies with status ''enabled'' copy every bucket, and no per-bucket policies are possible.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 02.jpg|thumb|right|618px|Mixed modes. us-west-1 is paired for full zone replication and holds everything; us-west-2 is paired for selective sync, so its <code>default-deny-</code> policy sits at status ''allowed'' and its buckets are still empty.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 03.jpg|thumb|right|618px|Both secondaries paired for selective sync, with no bucket sync policies added yet. All four buckets exist at both secondary sites and none of them hold data.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 04.jpg|thumb|right|618px|Selective sync in use. Symmetrical policies send bucket-1 and bucket-2 to us-west-1 and bucket-3 and bucket-4 to us-west-2; the buckets with no policy stay empty at the far site.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 05.jpg|thumb|right|618px|The same arrangement with Direction set to ''Directional'' for the us-west-1 policies, so bucket-1 and bucket-2 replicate one way only, from us-east-1 outward.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 06.jpg|thumb|right|763px|Sync between two secondary zones. bucket-5 exists only at the secondaries, and syncing it between them requires a zone-level policy for that zone pair -- multi-site setup never creates one, because it only ever pairs a primary with a secondary.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 07.jpg|thumb|right|794px|Storage classes with no storage class named in the policy, which is what QuantaStor creates. Replicated objects inherit the source zone's storage class and the destination zone's own tiering rules do not re-classify them, so an object can carry a <code>storage_class</code> tag naming a class the destination zone does not have.]]

[[File:Bucket Sync - Multi-Site Full Zone Replication 08.jpg|thumb|right|794px|The same topology with a storage class named on the sync pipe. Where the class exists at the destination the objects are placed in it; where it does not, they land in STANDARD while still carrying the original tag. QuantaStor does not offer a storage class option, so reaching this state means editing the pipe with <code>radosgw-admin</code> directly.]]

The storage class behavior in the last two diagrams is the most common surprise. '''Policies created by QuantaStor never name a storage class''', so the first of the two applies: objects arrive at the destination zone in whatever storage class they had at the source, and any auto-tiering or lifecycle rules configured at the destination are not applied to them on arrival.

== Requirements ==

* '''Two Ceph clusters''', each with an Object Storage Pool Group and an RGW gateway. A policy's destination must be a different Ceph cluster from its source; the Create dialog will not offer the source cluster as the destination.
* '''A multi-site zone group''' spanning those two zones. Until a zone group contains more than one zone, the Create dialog reports ''"No Ceph Cluster Multi-site Configurations are available."'' and closes.
* '''The zone pair configured for Sync selected buckets''', not full zone replication. See [[Bucket Synchronization Policies#The multi-site model|The multi-site model]].
* '''At least one Object Bucket''' in the source cluster to attach the policy to.
* A valid license. Create, modify and delete are all license-checked operations.

== Creating a bucket sync policy ==

{{Navigation|Remote Replication → Bucket Sync Policies → Create ''(toolbar)''}}

The same dialog is on the right-click menu of the Bucket Sync Policies grid. The dialog is wide because it does two jobs at once: the left panel searches the source cluster for candidate buckets, and the right panel holds the policy settings and the bucket you picked.

[[File:bsync_create.png|thumb|right|800px|The Create Bucket Sync Policy dialog. Search the source cluster on the left, then set the policy and move exactly one bucket into the right-hand list.]]

=== Search Criteria ===

This panel finds the bucket the policy will apply to. Wildcards are accepted in the bucket name: <code>*</code> matches any number of characters and <code>?</code> matches a single character.

* '''Bucket Name''' -- enabled by default, with a match mode of ''Match Any'' and a pattern of <code>*</code>, so an immediate '''Search''' returns everything. Narrow it if the cluster holds a large namespace.
* '''Source Ceph Cluster''' -- '''always required, and deliberately not switchable off.''' The checkbox is checked and greyed out because every candidate bucket in the result list has to come from one cluster; the cluster you choose here becomes the policy's source. Choosing it also filters the '''Destination Ceph Cluster''' list on the right to exclude it.
* '''Tenant''' -- off by default. Enable it to restrict the search to buckets owned by one multitenancy tenant. Tenant-owned buckets are addressed to RGW as <code>''<tenant>''/''<bucket>''</code>, and the policy records them that way.
* '''Max Results''' -- 25 by default. This is a page size, not a cap; use '''Next >''' below the bucket list to page through the rest.
* '''Offset''' -- 0 by default. The starting position in the result set.

'''Search''' runs the query and fills the left-hand bucket list; '''Clear''' resets the fields and empties both lists. The '''Range Start''', '''Range End''' and '''Total Matches''' fields under the bucket list report where you are in the result set.

=== Policy Settings ===

* '''Destination Ceph Cluster''' -- the cluster holding the zone the bucket replicates to. The list excludes whatever you selected as the source.
* '''Name''' -- pre-filled with the next free <code>bucket-sync-policy-''<n>''</code>. This becomes the RGW sync group id, so keep it to a plain identifier. A name must be unique for the bucket: reusing one fails with ''"Object Sync Policy with name '...', already exists for bucket '...'"''.
* '''Description''' -- free text, stored by QuantaStor only. It is never passed to RGW.
* '''Policy Status''' -- ''Enabled'' (default), ''Allowed'' or ''Forbidden''. See [[Bucket Synchronization Policies#Policy Status and Direction|Policy Status and Direction]].
* '''Direction''' -- ''Symmetrical'' (default) or ''Directional''. See [[Bucket Synchronization Policies#Policy Status and Direction|Policy Status and Direction]].
* '''Select the Object Bucket to Replicate''' -- move the bucket from the search results on the left into the selected list on the right. '''Exactly one bucket is allowed.''' Selecting none fails with ''"Invalid Object Bucket selection, no Buckets were selected for the sync operation."'' and selecting more than one with ''"...only one bucket can be selected for the sync operation."'' To replicate several buckets, create one policy per bucket.

Once a bucket and both clusters are chosen, a '''Bucket Sync Summary''' line appears under the two panels showing the resulting data flow, in the form <code>''bucket'' (''source zone'') << >> ''bucket'' (''destination zone'')</code> for a symmetrical policy, or <code>>>>></code> in place of <code><< >></code> for a directional one. It is worth reading before clicking '''OK''' -- it is the only place the dialog spells out which zone is which.

'''OK''' starts an asynchronous task; the dialog closes and the task appears in the Tasks pane.

== Policy Status and Direction ==

These two fields carry straight through to RGW, and they are the substance of the policy.

'''Policy Status''' sets the sync group's status:

{| class="wikitable"
! Value !! Meaning
|-
| '''Enabled''' ''(default)'' || Sync is active for this policy. This is what you want for a policy whose bucket should be replicating now.
|-
| '''Allowed''' || Sync is permitted but not itself active. This is the status the zone-level <code>default-deny-</code> policy uses: it opens the door without moving any data, so that bucket-level policies can opt individual buckets in.
|-
| '''Forbidden''' || Sync is blocked for this policy's scope. Use it to stop a bucket replicating without deleting the policy, so the configuration is preserved and can be switched back.
|}

Status is the one setting [[Bucket Synchronization Policies#Modifying a bucket sync policy|Modify]] can change after the fact, which makes ''Forbidden'' the practical way to pause a bucket's replication.

'''Direction''' sets the data flow, and cannot be changed after the policy is created:

{| class="wikitable"
! Value !! Flow !! Behaviour
|-
| '''Symmetrical''' ''(default)'' || Two-way || Both zones accept writes to the bucket and each replicates to the other. The summary line shows <code><< >></code>.
|-
| '''Directional''' || One-way || Only writes at the source zone replicate outward; writes made at the destination zone are not sent back. The summary line shows <code>>>>></code>.
|}

Choose '''Directional''' when one site is authoritative and the other is a read copy -- it is also the safer choice, because it removes the possibility of the same object being written at both ends. To change a policy's direction, delete it and create a replacement.

== What the create operation does on the appliance ==

Knowing what the task actually runs makes a failed task readable. Creating a policy issues three <code>radosgw-admin</code> commands in sequence, against the bucket for a bucket-level policy:

<pre style="font-size: smaller">
radosgw-admin sync group create --group-id=<name> --status=<enabled|allowed|forbidden> --bucket=<bucket>
radosgw-admin sync group flow create --group-id=<name> --flow-id=<name> --flow-type=<symmetrical|directional> ... --bucket=<bucket>
radosgw-admin sync group pipe create --group-id=<name> --pipe-id=<name> --source-zones=... --dest-zones=... --source-bucket=<bucket> --bucket=<bucket>
</pre>

A symmetrical flow is created with <code>--zones=''<source>'',''<destination>''</code> and a pipe spanning all zones; a directional flow names <code>--source-zone</code> and <code>--dest-zone</code> explicitly and pipes only between those two.

Three behaviours follow from this that are not visible in the dialog:

* '''The operation runs on the appliance that owns the master object zone''', whichever grid member you launch it from. QuantaStor redirects the request there, because that is where the sync group has to be defined.
* '''A bucket-level policy does not require an RGW period commit''', and none is issued. A zone-level policy -- one created with no bucket, which the CLI can do and the web interface cannot -- is followed by <code>radosgw-admin period update --commit</code>.
* '''Policies are capped at 2,000 per appliance.''' Beyond that, create fails with ''"Only 2,000 bucket sync policies are allowed. Please contact support."''

== Modifying a bucket sync policy ==

{{Navigation|Remote Replication → Bucket Sync Policies → Modify ''(toolbar)''}}

[[File:bsync_modify.png|thumb|right|521px|The Modify Bucket Sync Policy dialog. Only Policy Status and Description can be changed.]]

The dialog carries three fields:

* '''Bucket Sync Policy''' -- the policy to change. It is pre-selected if you had one selected in the grid; otherwise pick it here, and the other two fields refresh to that policy's current values.
* '''Policy Status''' -- ''Enabled'', ''Allowed'' or ''Forbidden'', pre-set to the policy's current status. Changing it is the only part of this dialog that reaches RGW, as <code>radosgw-admin sync group modify --status=''<status>''</code>. If you leave it alone, no RGW command is issued at all.
* '''Description''' -- free text held by QuantaStor only.

'''Everything else about a policy is fixed once created.''' There is no way to change the source or destination cluster, the bucket, the name, or the Direction -- the dialog has no field for any of them. To change those, delete the policy and create a new one.

== Deleting a bucket sync policy ==

{{Navigation|Remote Replication → Bucket Sync Policies → Delete ''(toolbar)''}}

[[File:bsync_delete.png|thumb|right|521px|The Delete Bucket Sync Policy dialog. The read-only Summary restates the data flow that is about to be removed.]]

Pick the policy in the '''Bucket Sync Policy''' list. The read-only '''Summary''' field below it restates the flow in the same notation the Create dialog uses, so you can confirm you are removing the policy you meant to before the confirmation prompt. Deleting runs <code>radosgw-admin sync group remove --group-id=''<name>''</code> for the policy's bucket.

'''Deleting a policy removes only the policy.''' The Object Buckets stay, and objects already replicated to the destination zone stay there -- what stops is any further syncing. If the intent is to remove the copy at the far site as well, delete the bucket there separately.

If you only want to stop replication temporarily, set the policy's status to ''Forbidden'' with '''Modify''' instead, which keeps the configuration intact.

== Viewing policies and discovering existing ones ==

{{Navigation|Remote Replication → Bucket Sync Policies}}

[[File:bsync_section.png|thumb|right|800px|The Bucket Sync Policies section under the Remote Replication tab, with its toolbar group and the policy grid.]]

The grid shows '''Name''', '''Source Bucket''', '''Bucket Sync Summary''', '''Policy Status''' and '''Description''' by default. Eight further columns are available from the column menu on any header: '''State''', '''Source Ceph Cluster''', '''Destination Bucket''', '''Destination Ceph Cluster''', '''Direction''', '''Source Zone''', '''Destination Zone''' and '''Storage System'''.

Two things about those columns are easy to misread:

* '''Zone-level policies appear here too''', including the <code>default-deny-</code> or <code>default-enabled-</code> policy that multi-site setup created. They are the rows with an empty '''Source Bucket''', and their Bucket Sync Summary names the two zones rather than a bucket. Do not delete them -- they are what makes the zone pair work.
* '''Source Zone and Destination Zone are blank for policies created from the web interface''', which does not send zone names, and '''Destination Bucket''' reads <code>*</code> because no separate destination bucket was requested. Populated values in those columns indicate a policy that was discovered from RGW or created from the CLI with the zone arguments given.

=== Picking up policies created outside QuantaStor ===

Policies created directly with <code>radosgw-admin</code> are found by bucket detail discovery, which reads each bucket's policy with <code>radosgw-admin sync group get --bucket=''<bucket>''</code>. Discovery is '''skipped entirely unless at least one policy whose name contains <code>deny-</code> already exists''' for the local system, which is the same test as saying the zone pair is in selective-sync rather than full-zone-replication mode. In full zone replication mode there are no per-bucket policies to find, so nothing is scanned.

To force a rescan, use '''Rescan Object Storage Buckets''' in the same toolbar group, select '''Deep Scan''', and tick '''Enable Sync Policies''' under Deep Scan Options. The default '''Quick Scan''' refreshes bucket usage only and will not pick up policy changes. Note the dialog's own warning: a deep scan can take hours on a large namespace and continues in the background after the task is reported complete. The CLI equivalent is [[QuantaStor CLI Command Reference#bucket-rescan|qs bucket-rescan]].

== Scheduling, conflicts and failures ==

'''There is no schedule, and that is by design.''' None of the three dialogs has a schedule field and the API has no schedule parameter, because a bucket sync policy is not a job that runs -- it is a standing rule. Once a policy is ''Enabled'', RGW's own multi-site sync copies objects continuously in the background, and the two zones converge without anything on the QuantaStor side triggering a run. This is the sharpest practical difference from [[Remote-replication (DR)|remote replication]] and [[Backup Policies|backup policies]], both of which are schedule-driven and produce a per-run object you can inspect.

'''Conflicting writes are resolved by RGW, not by QuantaStor.''' A symmetrical policy makes the bucket writable in both zones, and QuantaStor adds no conflict detection or resolution of its own -- it only tells RGW which buckets and zones are in scope. If concurrent writes to the same object from two sites are a possibility you need to reason about, use '''Directional''' so that only one zone is authoritative. The resolution rules RGW itself applies are outside what this page documents.

'''Failures surface as failed tasks.''' Create, modify and delete all run asynchronously and appear in the Tasks pane with descriptions of the form ''"Create Object Sync Policy '<name>' in Ceph Cluster '<cluster>'."'' A failed task carries the <code>radosgw-admin</code> command that failed together with its output and exit code, which is usually enough to diagnose it directly. Two failures have specific messages worth recognising:

* ''"Cannot add individual bucket sync policies. Multi-site setup cannot be in full zone replication mode."'' -- the zone pair was configured with '''Full zone replication'''. Bucket-level policies are not possible against that pairing.
* ''"Only 2,000 bucket sync policies are allowed. Please contact support."'' -- the per-appliance policy limit.

'''No alert type is defined for bucket sync policies''', so nothing is raised through the [[Alert Manager]] for a policy or for the state of the sync itself. The policy object records the status you configured, not a runtime sync state or progress figure, so ongoing sync health is a question to put to Ceph on the appliance rather than to QuantaStor.

== Managing bucket sync policies from the CLI ==

Five commands cover the feature. Each has a short alias.

{| class="wikitable"
! Command !! Alias !! Purpose
|-
| [[QuantaStor CLI Command Reference#bucket-sync-policy-create|qs bucket-sync-policy-create]]|| <code>bsp-create</code> || Create a policy
|-
| [[QuantaStor CLI Command Reference#bucket-sync-policy-list|qs bucket-sync-policy-list]]|| <code>bsp-list</code> || List all policies
|-
| [[QuantaStor CLI Command Reference#bucket-sync-policy-get|qs bucket-sync-policy-get]]|| <code>bsp-get</code> || Show one policy in detail
|-
| [[QuantaStor CLI Command Reference#bucket-sync-policy-modify|qs bucket-sync-policy-modify]]|| <code>bsp-modify</code> || Change status or description
|-
| [[QuantaStor CLI Command Reference#bucket-sync-policy-delete|qs bucket-sync-policy-delete]]|| <code>bsp-delete</code> || Remove a policy
|}

Create takes three mandatory arguments and seven optional ones:

<pre style="font-size: smaller">
qs bucket-sync-policy-create --source-ceph-cluster=<cluster> --destination-ceph-cluster=<cluster> \
--bucket-sync-policy-name=<name> [--source-bucket=<bucket>] [--destination-bucket=<bucket>] \
[--sync-policy-status=<allowed|enabled|forbidden>] [--direction=<directional|symmetrical>] \
[--source-zone=<zone>] [--dest-zone=<zone>] [--description=<text>]
</pre>

The defaults match the dialog: <code>--sync-policy-status</code> defaults to <code>enabled</code> and <code>--direction</code> to <code>symmetrical</code>. Four arguments have no equivalent in the web interface:

* '''<code>--source-bucket</code> is optional here.''' Omitting it creates a '''zone-level''' policy covering the whole zone pair rather than one bucket -- the only supported way to create the zone-level policy that a secondary-to-secondary pairing needs. The web interface always requires exactly one bucket.
* '''<code>--destination-bucket</code>''' replicates into a differently-named bucket at the destination. Left unset, the destination bucket matches the source and the policy records <code>*</code>.
* '''<code>--source-zone</code>''' and '''<code>--dest-zone</code>''' name the flow's zones explicitly, which is what fills in the Source Zone and Destination Zone grid columns.

Modify and delete take the policy by name or ID, with the Ceph cluster optional:

<pre style="font-size: smaller">
qs bucket-sync-policy-modify --bucket-sync-policy=<name|id> [--ceph-cluster=<cluster>] \
[--sync-policy-status=<allowed|enabled|forbidden>] [--description=<text>]
qs bucket-sync-policy-delete --bucket-sync-policy=<name|id> [--ceph-cluster=<cluster>]
qs bucket-sync-policy-list [--ceph-cluster=<cluster>] [--bucket=<bucket>] [--object-store-zone=<zone>]
</pre>

On <code>bucket-sync-policy-list</code>, supplying both <code>--bucket</code> and <code>--object-store-zone</code> ignores the zone and filters by the bucket; supplying neither returns every policy in the cluster.

Related commands: [[QuantaStor CLI Command Reference#bucket-list|qs bucket-list]] and [[QuantaStor CLI Command Reference#object-zone-list|qs object-zone-list]] to find the bucket and zone names to use, and [[QuantaStor CLI Command Reference#object-pool-group-multi-site-setup|qs object-pool-group-multi-site-setup]] to build the zone pairing in the first place.

== Related pages ==

* [[Scale-out Object Setup (ceph)]] -- building the object cluster, the Object Storage Pool Groups and RGW gateways, and the multi-site zone pairing this feature requires
* [[Remote-replication (DR)]] -- replicating Storage Volumes and Network Shares between Storage Pools, on a schedule, with DR failover
* [[Backup Policies]] -- file-level copy and auto-tiering between a Network Share and an NFS/SMB export or a Cloud Container
* [[Cloud Containers / NAS Gateway]] -- presenting a single external object bucket as an NFS/SMB file share
* [[Storage Pools]] -- the pools that back both object storage and the file and block features
* [[QuantaStor CLI Command Reference]] -- full argument lists for the commands above

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

Backup Policies

2026-09-03T02:39:11Z

Umbe: /* Backup Modes and Transfer Direction */

[[Category:admin_guide]]
A '''Backup Policy''' copies or moves file data between a QuantaStor [[Network Shares|Network Share]] and a remote data source, on a schedule. The remote source can be an SMB or NFS export on another server or NAS filer, or a [[Cloud Containers / NAS Gateway|Cloud Container]] backed by S3-compatible object storage. Policies transfer data in either direction, so the same mechanism covers pulling a filer onto QuantaStor, pushing a share out to the cloud, and tiering cold files off a share to object storage.

Scanning and copying are parallelized, so filers with 100 million or more files can be scanned for changes in a practical amount of time. Each run creates a '''Backup Job''' object you can monitor while it works.

{| class="wikitable"
! Section !! Covers
|-
| [[#Backup Modes and Transfer Direction|Backup Modes and Transfer Direction]] || Copy, move and auto-tier; inbound versus outbound transfers
|-
| [[#Creating a Backup Policy|Creating a Backup Policy]] || Every tab of the Create dialog, field by field
|-
| [[#Modifying a Backup Policy|Modifying a Backup Policy]] || What can and cannot be changed after creation
|-
| [[#Running a Policy on Demand|Running a Policy on Demand]] || Triggering a backup outside its schedule
|-
| [[#Enabling and Disabling a Policy|Enabling and Disabling a Policy]] || Suspending a policy without deleting it
|-
| [[#Deleting a Backup Policy|Deleting a Backup Policy]] || Removing a policy, and what happens to the data
|-
| [[#Monitoring Backup Jobs|Monitoring Backup Jobs]] || The Backup Jobs tab and the backup logs
|-
| [[#Managing Backup Policies from the CLI|Managing Backup Policies from the CLI]] || The equivalent <code>qs</code> commands
|}

{{Navigation|Storage Management → Schedules ''(section)'' → Backup Policies & Jobs ''(tab)'' → Backup Policy ''(toolbar group)''}}

The '''Backup Policy''' toolbar group holds all six operations -- Create, Modify, Delete, Run, Enable and Disable -- and the '''Backup Policies & Jobs''' tab in the center pane lists the policies and the jobs they have produced.

[[File:bkuppol_grid.png|thumb|right|800px|The Backup Policy toolbar group and the Backup Policies & Jobs tab.]]

You can also create a policy from the share it will be attached to: right-click a '''Network Share''' and choose '''Create Backup Policy'''.

== Backup Modes and Transfer Direction ==

Mode and direction are chosen independently on the '''Policy Settings''' tab, and together they determine what the policy does. Getting these two right matters more than any other setting on the dialog, because they decide whether source files survive the transfer.

{| class="wikitable"
! Backup Mode !! Effect
|-
| '''Copy Files''' || Files are copied and the source copy is left in place. This is the default and the safe choice.
|-
| '''Move Files''' || Files are copied and then '''removed from the source'''. Use this to migrate data off a filer, not to back it up.
|-
| '''Auto-tier Files''' || Files are moved to the destination and replaced at the source with a stub, so they still appear in the share and can still be opened. Selecting this forces '''Outbound''', and is intended for tiering cold data to a Cloud Container.
|}

{| class="wikitable"
! Backup Direction !! Data flows
|-
| '''Inbound Data Transfer''' || Network Share ← Remote Storage Export. QuantaStor pulls from the remote source. This is the default.
|-
| '''Outbound Data Transfer''' || Network Share → Remote Storage Export. QuantaStor pushes to the remote target.
|}

'''Enable Continuous Data Protection''' is only available for '''Outbound''' policies; it is greyed out while '''Inbound''' is selected. It copies files to the destination as they change rather than waiting for the scheduled run, which reduces the amount of data each scheduled run has to move. This is important for Network Shares with millions of files as it allows one to run the Backup Policy jobs less frequently as the files will already be copied to the destination. The Backup Policy still needs to run in order to catch anything that may have been missed as a verification pass.

== Creating a Backup Policy ==

{{Navigation|Storage Management → Schedules ''(section)'' → Backup Policy ''(toolbar group)'' → Create}}

The dialog has six tabs. '''Network Share''' and the remote export are the only required selections; everything else has a working default.

=== General ===

[[File:bkuppol_general.png|thumb|right|700px|The General tab: the Network Share the policy is attached to, and the policy name.]]

* '''Network Share''' -- the QuantaStor share the policy is attached to. For an inbound policy this is the destination; for an outbound policy it is the source. Only one share can be selected, and the share type matters: long-term snapshot retention is unavailable for '''cloud''' type shares.
* '''Policy Name''' -- pre-filled with a generated name such as <code>backup-policy-1</code>. The name is also used as the destination subdirectory when '''Store files to policy specific subdirectory on destination''' is enabled, so choose something meaningful.
* '''Description''' -- free text for your own reference.
* '''Enable Policy''' -- checked by default; the policy becomes active as soon as it is created. Clear it to create the policy in a disabled state and start it later.

=== Policy Settings ===

[[File:bkuppol_policy_settings.png|thumb|right|700px|The Policy Settings tab: backup mode, transfer direction, and the remote storage export.]]

Backup Mode and Backup Direction are covered in '''[[#Backup Modes and Transfer Direction|Backup Modes and Transfer Direction]]''' above. The rest of the tab identifies the remote side of the transfer.

'''Remote Storage Export''' selects the protocol, and the fields below it change to match:

* '''SMB''' -- an SMB3 or SMB2.1 share. Requires '''Username''' and '''Password'''.
* '''NFS''' -- an NFSv3 or NFSv4 export. No credentials are used; access is controlled by the export's own host permissions.
* '''Cloud Container''' -- a [[Cloud Containers / NAS Gateway|Cloud Container]] already configured on this system, pointing at S3-compatible or other blob storage. You select the container rather than entering a hostname.

For SMB and NFS:

* '''Hostname / IP Address''' -- the remote NAS filer or server.
* '''Username''' / '''Password''' -- SMB only. For a domain, enter the username as <code>DOMAIN/username</code>. The username itself cannot contain a <code>%</code> character.
* '''Scan''' -- contacts the host and enumerates its exports. Nothing appears in the list below until you run it.
* '''Select Share/Export''' -- the specific export to transfer, populated by '''Scan'''.

'''Enter the credentials in the Username and Password fields.''' Do not put them in the '''Hostname / IP Address''' field -- the dialog assembles the internal <code>//user%password@host</code> form for you. The '''Policy Summary''' box at the bottom restates the resulting transfer in a sentence, and is the quickest way to confirm the direction is what you intended before clicking OK.

=== Schedule Interval ===

[[File:bkuppol_schedule.png|thumb|right|700px|The Schedule Interval tab, with the default Monday-Friday, every-four-hours calendar schedule.]]

'''Schedule Type''' picks between two mutually exclusive models:

* '''Use day/hour selections''' (default) -- a calendar schedule. Select the days and the hours; the policy runs at each selected hour on each selected day. The default selects '''Monday through Friday''' at '''12 AM, 4 AM, 8 AM, 12 PM, 4 PM and 8 PM'''. '''All Days''' and '''All Hours''' select everything at once, and '''Offset''' delays each trigger by up to 59 minutes, so a 30 minute offset turns a 1 AM trigger into 1:30 AM.
* '''Use timer interval''' -- a rest interval instead of fixed times. The policy waits the specified number of minutes '''after a run completes''' before starting the next one, so runs never overlap. The minimum is 3 minutes.

A scheduled run is skipped rather than queued if the previous run for the same policy is still active.

=== Snapshot Settings ===

[[File:bkuppol_snapshots.png|thumb|right|700px|The Snapshot Settings tab. These controls are greyed out for cloud type shares.]]

Each run can leave a snapshot of the destination share behind as a recovery checkpoint. '''Short term''' snapshots follow the schedule; '''long term''' ones are promoted from the short-term set and kept longer.

* '''Long Term Snapshot Retention Settings''' -- how many hourly, daily, weekly, monthly and quarterly checkpoints to keep. Each defaults to '''2'''. A count of 7 dailies keeps 7 snapshots spanning the last week, with at least a day between them. '''Suggested Defaults''' fills in a sensible spread and '''Clear''' empties all five.
* '''Max Short Term Snapshots''' -- the schedule-driven snapshots to retain, '''3''' by default. Once the limit is reached the oldest is removed before a new one is created. To keep one permanently, rename it or set a description on it.
* '''Max Total Source Snapshots''' -- the computed total of the above, shown for reference.

'''These settings apply to ZFS and CephFS shares only.''' The whole tab is disabled when the selected Network Share is a '''cloud''' type share.

=== File Selection Settings ===

[[File:bkuppol_file_selection.png|thumb|right|700px|The File Selection Settings tab: purge behavior, age and size thresholds, and filename filters.]]

This tab decides which files are transferred and which are removed from the destination.

'''Purge Options'''

* '''Purge Frequency''' -- when the destination is reconciled against the source. '''Never Purge Files From Backup''' is the default, and it never deletes anything. The alternatives are '''Purge Expired/Deleted Files Immediately After Backup''', '''...Daily''' and '''...Weekly'''. Purging is a separate scan from the backup itself, so running it nightly rather than after every job is usually the efficient choice.
* '''Purge Files Older Than''' -- the retention period in days. Files older than this are removed from the destination on the next purge.
* '''Backup Concurrency''' -- the number of parallel scan and copy streams. The default is '''Parallelized Backup (12 streams)'''; the options are '''Serialized Backup''' (one stream) and '''6''', '''12''', '''24''', '''32''' or '''Highly Parallelized Backup (64)'''. More streams help most on filers with very large file counts. This field is disabled when purging is set to never, because there is nothing to reconcile.

'''Be careful when purging is enabled.''' A purge removes files from the destination that are no longer present on the source. If you attach such a policy to a share that already holds unrelated data, that data will be deleted. With purging on, a '''Copy Files''' inbound policy maintains a mirror of the source, not an accumulating archive.

'''File Age Options'''

* '''Minimum Age Threshold''' -- files newer than this are skipped. Useful to avoid copying files still being written.
* '''Maximum Age Threshold''' -- files older than this are skipped.

Setting both to 0, or leaving both unchecked, transfers files of any age. Setting one or both defines an age window. Which timestamp is used is controlled by '''Include file access time-stamp in file age checks''' on the '''Advanced Settings''' tab; without it, age is based on creation and modification time only.

'''File Size Options'''

* '''Minimum Size Threshold''' -- files smaller than this are skipped.
* '''Maximum Size Threshold''' -- files larger than this are skipped.
* '''Minimum Size for Auto-tiering''' -- only stub files larger than this. Applies to '''Auto-tier Files''' mode only and is greyed out otherwise.

'''Filtering Options'''

* ''''Include' File Filtering''' with a '''Match Pattern''' -- transfer only files matching the pattern, for example <code>/subdir/*</code>.
* ''''Exclude' File Filtering''' with a '''Match Pattern''' -- transfer everything except files matching the pattern, for example <code>*.txt</code>.

Using both filters at once is '''not recommended'''; if you do, make sure the two patterns cannot contradict each other.

=== Advanced Settings ===

[[File:bkuppol_advanced.png|thumb|right|700px|The Advanced Settings tab.]]

* '''Start date''' -- the date the schedule becomes active. Defaults to today, so the policy begins at its next scheduled slot.
* '''Store files to policy specific subdirectory on destination''' -- '''unchecked by default'''. Leave it unchecked and the policy writes into the '''root''' of the destination, which makes an exact mirror and limits the share to a single policy. Check it and each policy writes into its own subdirectory, which is what allows '''several policies to share one Network Share'''. For an inbound policy the subdirectory is named after the policy automatically; for an outbound policy it is the '''Destination Subdirectory''' field below.
* '''Destination Subdirectory''' -- only enabled with the option above; required when it is.
* '''Maintain a log of each backup''' -- '''checked by default'''. See '''[[#Monitoring Backup Jobs|Monitoring Backup Jobs]]''' for where the logs are written.
* '''Include file access time-stamp in file age checks''' -- also considers access time when evaluating the age thresholds, so recently-read but unmodified files count as recent.
* '''Stub Creation Policy''' -- '''Create stubs nightly''' or '''Create stubs on every backup'''. Applies to '''Auto-tier Files''' mode only and is greyed out otherwise. It does not affect files copied by Continuous Data Protection.
* '''Reclaim Orphaned Snapshots''' -- adopts snapshots left behind by a previously deleted schedule so they are counted against this policy's retention rules instead of accumulating.

== Modifying a Backup Policy ==

{{Navigation|Storage Management → Schedules ''(section)'' → Backup Policy ''(toolbar group)'' → Modify}}

[[File:bkuppol_modify.png|thumb|right|700px|The Modify Backup Policy dialog, pre-filled from the selected policy.]]

Modify presents the same six tabs, pre-filled from the selected policy. Schedule, filters, thresholds, purge behavior and credentials can all be changed on an existing policy, and the change applies from the next scheduled run.

The '''Network Share''' the policy is attached to is fixed at creation. To retarget a policy at a different share, delete it and create a new one.

== Running a Policy on Demand ==

{{Navigation|Storage Management → Schedules ''(section)'' → Backup Policy ''(toolbar group)'' → Run}}

[[File:bkuppol_run.png|thumb|right|700px|Run starts a backup job immediately, outside the schedule.]]

'''Run''' starts a Backup Job for the selected policy immediately, without waiting for the schedule and without altering it. Use it to test a new policy or to catch up after a source outage. The toolbar button is labelled '''Run'''; the dialog it opens is titled '''Trigger Backup Policy'''.

== Enabling and Disabling a Policy ==

{{Navigation|Storage Management → Schedules ''(section)'' → Backup Policy ''(toolbar group)'' → Enable / Disable}}

'''Disable''' stops a policy from running on its schedule while keeping the policy and its history intact; '''Enable''' resumes it. Prefer this over deleting a policy you expect to use again -- for example while a source filer is down for maintenance.

== Deleting a Backup Policy ==

{{Navigation|Storage Management → Schedules ''(section)'' → Backup Policy ''(toolbar group)'' → Delete}}

[[File:bkuppol_delete.png|thumb|right|700px|Deleting a policy removes the policy and its job history, not the data.]]

Deleting a policy removes the policy and the '''Backup Jobs''' associated with it. '''It does not delete any backed-up data''' -- the files already transferred stay on the destination share. A policy can also be deleted by right-clicking it and choosing the delete option.

== Monitoring Backup Jobs ==

Each run creates a '''Backup Job''' object. Select the '''Network Share''' the policy is attached to and open the '''Backup Jobs''' tab in the center pane to watch progress, or use the '''Backup Policies & Jobs''' tab under '''Schedules''' to see jobs across all policies.

With '''Maintain a log of each backup''' enabled, each job writes a log on the QuantaStor system under:

<pre style="font-size: smaller">
/var/log/qs/backup-log/POLICY-NAME/
</pre>

The backup phase writes a <code>.changelog</code> file and the purge phase a <code>.purgelog</code> file. Each log lists the full path of every file the job handled, which makes them usable as input to tape backup software such as IBM TSM.

== Managing Backup Policies from the CLI ==

Every operation above has a CLI equivalent, which is the practical way to create policies in bulk. The full argument list for each is in the [[QuantaStor CLI Command Reference]].

{| class="wikitable"
! Command !! Purpose
|-
| [[QuantaStor CLI Command Reference#backup-policy-create|<code>qs backup-policy-create</code>]] || Create a policy
|-
| [[QuantaStor CLI Command Reference#backup-policy-modify|<code>qs backup-policy-modify</code>]] || Change an existing policy
|-
| [[QuantaStor CLI Command Reference#backup-policy-list|<code>qs backup-policy-list</code>]] || List policies
|-
| [[QuantaStor CLI Command Reference#backup-policy-get|<code>qs backup-policy-get</code>]] || Show one policy in detail
|-
| [[QuantaStor CLI Command Reference#backup-policy-trigger|<code>qs backup-policy-trigger</code>]] || Start a backup job now
|-
| [[QuantaStor CLI Command Reference#backup-policy-enable|<code>qs backup-policy-enable</code>]] || Resume a disabled policy
|-
| [[QuantaStor CLI Command Reference#backup-policy-disable|<code>qs backup-policy-disable</code>]] || Suspend a policy
|-
| [[QuantaStor CLI Command Reference#backup-policy-delete|<code>qs backup-policy-delete</code>]] || Delete a policy
|-
| [[QuantaStor CLI Command Reference#backup-job-list|<code>qs backup-job-list</code>]] || List backup jobs
|-
| [[QuantaStor CLI Command Reference#backup-job-get|<code>qs backup-job-get</code>]] || Show one job
|-
| [[QuantaStor CLI Command Reference#backup-job-cancel|<code>qs backup-job-cancel</code>]] || Cancel a running job
|}

A minimal inbound policy pulling an NFS export onto an existing share:

<pre style="font-size: smaller">
qs backup-policy-create --name=nightly-archive --network-share=archive \
--remote-hostname=10.0.10.50 --remote-export-type=nfs \
--remote-export-path=/export/projects --policy-type=copy-inbound
</pre>

The same for an SMB source, with credentials passed as separate arguments:

<pre style="font-size: smaller">
qs backup-policy-create --name=filer-backup --network-share=archive \
--remote-hostname=10.0.10.60 --remote-export-type=smb \
--smb-username=DOMAIN/backupsvc --smb-password=aAbBcCdDeEfF0123 \
--policy-type=copy-inbound --purge-policy=daily --retain-period=60
</pre>

Note that the CLI and the web interface do not share every default. <code>--scan-threads</code> defaults to '''5''' from the CLI while the dialog defaults to '''12''' streams, <code>--remote-export-type</code> defaults to '''nfs''' while the dialog pre-selects '''SMB''', and <code>--policy-type</code> defaults to '''copy-inbound''' in both. Set the values you want explicitly in scripts rather than relying on either default.

== Data Mover Utility / pwalk ==

The scanning and copying is performed by '''pwalk''', an open source command line utility extended by OSNEXUS and shipped with QuantaStor. It is what makes the parallel scan possible, and it can be used directly for ad-hoc copies and scans -- see [[Pwalk utility|the pwalk page]].

== Related pages ==

* [[Network Shares]] -- creating the share a policy attaches to
* [[Cloud Containers / NAS Gateway]] -- configuring a Cloud Container as a policy target
* [[Snapshot Schedules]] -- scheduled snapshots independent of a backup policy
* [[Remote-replication (DR)]] -- replicating whole shares and volumes between QuantaStor systems
* [[Pwalk utility]] -- the underlying scan and copy tool
* [[Storage Pools]] -- the pool the destination share is provisioned from

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

Security Configuration

2026-09-03T01:03:36Z

Umbe: /* EDR Management from the CLI */

[[Category:admin_guide]]

QuantaStor provides a layered set of security controls: grid-wide password and login policy, role based access control over every management operation, multi-factor authentication, an integrated firewall, TLS certificate management, and endpoint detection and response agent deployment. This page covers each of them.

Many industries require compliance with government security standards covering everything from audit logging to password policies. These include Health and Human Services security standards [https://www.hhs.gov/hipaa/index.html (HIPAA)], federal law enforcement security standards [https://www.fbi.gov/services/cjis/cjis-security-policy-resource-center (CJIS)], and the general standards outlined by NIST for Controlled Unclassified Information (CUI) in Non-Federal Information Systems and Organizations, covered in NIST 800-53 and [https://csrc.nist.gov/publications/detail/sp/800-171/rev-2/final 800-171].

Nearly all of the settings on this page are reached from the '''Security''' tab of the QuantaStor web management interface, which contains these sections:

{| class="wikitable"
! Security tab section !! Covers !! On this page
|-
| '''Management Users''' || User accounts, password policy, multi-factor authentication || [[#Security Settings Management|Security Settings]], [[#User Management|Users]], [[#Multi-factor Authentication|MFA]]
|-
| '''Management Groups''' || User groups and their shared POSIX GID || [[#User Group Management|User Groups]]
|-
| '''Management Roles''' || RBAC roles and their permission assignments || [[#Role Based Access Controls (RBAC)|RBAC]]
|-
| '''Object Users & Tenants''' || S3/object storage users and tenants || [[#Multitenancy / Resource Group Management|Multitenancy]]
|-
| '''Scale-out File & Block Keyrings''' || Keyrings for scale-out storage || not covered here
|-
| '''Certificates''' || The grid-wide TLS certificate inventory || [[#Certificate Management|Certificate Management]]
|-
| '''Key Server Profiles''' || External key server (KMIP) profiles || not covered here
|-
| '''EDR Agents''' || Endpoint detection and response agents || [[#Endpoint Detection & Response (EDR)|EDR]]
|}

Also on this page: [[#Firewall Configuration|Firewall Configuration]],
[[#SSL/TLS Certificate & Web Access Security|SSL/TLS and Web Access Security]],
[[#System Setup Security Checks|System Setup Security Checks]] and
[[#Security Updates|Security Updates]].

== Security Settings Management ==

[[File:security_manager_general.png|thumb|right|546px|Security Manager, General tab -- grid-wide password and login policy.]]

The '''Security Manager''' holds the password and login policy for the entire Storage Grid. These settings apply to all user accounts on all systems in the grid, not per-system.

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)''}}

Choosing '''Suggested Defaults''' automatically configures the password and lockout policies to meet the standards listed above. This is the recommended starting point -- apply it first, then tune individual settings for the requirements of your deployment. '''Discard Changes''' reverts the dialog to the currently saved policy.

The '''General''' tab controls:

* '''Password Complexity''' -- the required character-class mix. The factory default is ''Weak''; raise this for any production or compliance-bound deployment.
* '''Allowed Special Characters''' -- which non-alphanumeric characters are permitted in passwords.
* '''Minimum / Maximum Password Length''' -- both in the range 8 to 80.
* '''Login Attempts Until Short Lockout''' and '''Login Attempts Until Lockout''' -- consecutive failures before a temporary and then a permanent lockout. Set the second to 0 to disable permanent lockout.
* '''Bad Logins Sample Period''' (short and permanent) -- the window, in seconds, over which failed attempts are counted.
* '''Bad Logins Short Lockout Duration''' -- how long, in seconds, a short lockout lasts.
* '''Days Until Password Expires''' -- 0 to 1000; 0 disables expiry.
* '''Unique Passwords Until Reuse''' -- 0 to 20; how many previous passwords are remembered and refused.
* '''Minimum Days Between Password Change''' -- prevents a user cycling straight back to a previous password.
* '''Maximum Days Account Inactive Until Lockout''' -- locks out dormant accounts.
* '''Auto Logout From N Minutes Of Inactivity''' -- idle timeout for the web interface; 0 disables it.
* '''Default Login Username''' -- the username pre-filled on the login page.

The '''Multi-admin Approvals''' tab configures which operation types require a second administrator's approval before they run; approvals are then granted or refused from the '''Multi-admin Approval''' group in the Security toolbar.

The '''Advanced Settings''' tab holds the '''Web Access Mode''' (see '''[[#Web Access Mode|Web Access Mode]]'''), an optional '''System Use Notification''' banner shown to users at login, and the LDAP single-sign-on settings described next.

'''Note:''' saving the Security Manager prompts a confirmation that the change may log users out of the interface and cause passwords to expire. Plan policy changes accordingly.

=== LDAP Single-Sign-On Authentication ===

[[File:security_manager_advanced.png|thumb|right|546px|Security Manager, Advanced Settings -- Web Access Mode and LDAP single sign-on.]]

The Advanced Settings tab can connect the Storage Grid to an LDAP or Active Directory domain for '''management user''' authentication.

To configure this:

* In your LDAP/AD environment, create one or more groups for QuantaStor administration -- for example {{Code|1=QS-Administrator}} and {{Code|1=QS-Monitor}} -- and add the appropriate users to them.
* In QuantaStor, edit the Role you want each LDAP group to map to and set its '''LDAP Group''' field. For example set the '''Administrator''' role's LDAP Group to {{Code|1=QS-Administrator}}, and the '''System Monitor''' role's to {{Code|1=QS-Monitor}}. The LDAP Group field is on the Create Role and Modify Role dialogs.
* Set your DNS and NTP servers to point at your AD server, in the Storage System Modify dialog. Do this '''before''' enabling single sign-on.
* Return to Security Manager --> Advanced Settings, tick '''Enable Single Sign-on''', and fill in the LDAP settings. The two fields are greyed out until the checkbox is ticked.

The LDAP fields are:

* '''LDAP Server (FQDN)''' -- the fully qualified domain name of the LDAP/AD server, for example {{Code|1=dc01.example.com}}
* '''LDAP Server Base DN for Users''' -- the base DN under which user accounts are searched, for example {{Code|1=dc=example,dc=com}}

This integration provides single sign-on for '''administrative''' access to the Storage Grid via the QuantaStor web interface, CLI, and REST API. It does '''not''' provide Active Directory integration for SMB network share access. For that, join each system to the domain via '''Storage Management --> Storage Systems --> Active Directory ''(toolbar)'' --> Join AD Domain'''.

=== Audit Logging ===

Audit logging of management operations is on by default on all QuantaStor systems and cannot be disabled. Every API, CLI, and web interface operation passes through the same core service and is recorded.

The audit log is at:

<pre style="font-size: smaller">
/var/log/qs/qs_audit.log
</pre>

It is written in a NIST compliant CEE JSON format, one JSON object per line, so it can be ingested directly by a log aggregator or SIEM without custom parsing. Each record identifies the operation, the user account that invoked it, the source address, and the outcome.

To ship the audit log to a central collector, point your syslog or log agent at this file; QuantaStor does not rotate it out from under a reader.

=== Sending Logs to Support ===

QuantaStor can collect and upload system logs to OSNEXUS Support, scrubbing usernames and other security related information first so that no personally-identifiable information is transmitted, and never including data files from Storage Pools. That makes the collection GDPR compliant.

Full detail is on its own page: '''[[Send System Log Report|Sending Logs to Support]]'''.

== Role Based Access Controls (RBAC) ==

[[File:security_roles_section.png|thumb|right|800px|Management Roles section with the default roles.]]

QuantaStor's '''R'''ole '''B'''ased '''A'''ccess '''C'''ontrol system lets IT and security administrators grant access limited to a job function, following the [https://en.wikipedia.org/wiki/Principle_of_least_privilege principle of least privilege].

The RBAC system is highly granular. Each '''permission''' has three parts:

* an '''object type''' -- for example Network Share, Storage Volume, Storage Pool
* an '''operation''' -- for example create, delete, modify, view
* a '''scope''' -- system, resource group, user, or none

Every QuantaStor API, CLI, and web interface command goes through the same core service, and every call passes an authentication and an authorization check. Because of that shared path, RBAC applies uniformly no matter how the account connects -- web interface, {{Code|1=qs}} CLI, or REST API.

This granularity is especially useful for automation: a dedicated account can be created for a script whose role permits only the task it performs, such as creating and deleting a nightly snapshot of a Network Share.

QuantaStor ships with four default roles:

* '''Administrator''' -- full access to all functions on all systems in the grid.
* '''Security Administrator''' -- full control over security-related functions.
* '''Object Tenant Admin''' -- for users managing object storage tenants.
* '''System Monitor''' -- view only; no configuration changes.

=== Role Management ===

[[File:security_role_create.png|thumb|right|586px|Create Role, showing the permission assignment grid.]]

{{Navigation|Security → Management Roles → Role → Create ''(toolbar)''}}

Each user is assigned a single Role, and a role change takes effect immediately. If a user logged in as '''Administrator''' has their role changed to '''System Monitor''', which has only view permissions, the new permissions apply to their next action. Tasks already running -- a Storage Volume create, for example -- complete at the authorization level held when the task started.

The Create Role dialog takes a '''Name''', a '''Description''', and an optional '''LDAP Group''' used for '''[[#LDAP Single-Sign-On Authentication|single sign-on]]'''.

Because a role carries hundreds of individual permissions, the dialog provides two shortcuts:

* '''Copy Permissions from Role''' -- start from an existing role's permission set (pick the source role in the adjacent dropdown) and adjust from there. This is by far the fastest way to build a new role.
* '''Apply Permission Scope to Selected''' -- tick a set of rows in the grid, choose a scope, and apply it to all of them at once.

The '''Web Interface Customization''' tab hides web interface tab panels and sections for every user holding the role -- the same mechanism described under '''[[#Web Interface Customization|Web Interface Customization]]''', but applied per role rather than per user.

=== Role Permissions - Object Types ===

The '''Permission Assignments''' grid lists every permission as a row of '''Object Type''', '''Operation''', and '''Permission Scope'''.

On QuantaStor 6.9 there are '''207 object types''' and '''662 individual permissions''', covering everything from the common types such as Storage Volume, Network Share, and Object Bucket through to internal types such as Acl, AlertConfiguration, and TargetPort.

Because that list is long, use the '''<Show All Object Types>''' filter above the grid to narrow it to the object type you are working on, then set the operations for that type.

=== Role Permissions - Operation Types ===

Every permission is a combination of an object type and an '''operation''' that can be performed on it. Across the default Administrator role there are 120 distinct operations; the most common are '''view''', '''modify''', '''create''', and '''delete''', with more specific ones such as '''add''', '''remove''', '''rescan''', '''enable''', '''disable''', '''identify''', '''set''', and '''clear''' on the object types that support them.

This per-operation granularity is what lets a role fit a job function. A "Provisioning Administrator" role, for example, can be given '''create''' but not '''delete''', so the routine task of provisioning storage can be delegated without the risk of data deletion.

All object types also have a '''view''' permission, and this one deserves attention: some parts of the web management interface require view permission on a type in order to function. Removing '''view''' is useful when a role should have no visibility of a type at all -- an administrator responsible only for Network Shares could have '''view''' on '''StorageVolume''' set to '''None''', so that no Storage Volumes are visible to them.

=== Role Permissions - Operation Scope ===

Each permission's '''scope''' determines the breadth of the grant. Click a '''Permission Scope''' cell in the grid to change it.

* '''Global/System''' -- grid-wide access to the operation on all systems.
* '''None''' -- access to the operation is blocked entirely.
* '''User''' -- access is limited to objects the user owns. A role with the permission '''Storage Volume + delete + User''' allows deleting only Storage Volumes for which that user is the owner.
* '''Resource Group''' -- access is limited to the objects in the Resource Group the user is assigned to. This is how QuantaStor implements multi-tenancy; see '''[[#Multitenancy / Resource Group Management|Multitenancy]]'''.
== User Management ==

[[File:security_users_section.png|thumb|right|800px|Security tab, Management Users section.]]

Users in QuantaStor are '''management users''' -- accounts with access to the management interface under a specific Role.

These accounts are also created as local (Linux/Unix) users on '''every''' Storage System in the grid, with the same POSIX UID and GID on each. This enables management accounts to be used for SMB file access, which matters in environments where AD/LDAP is not configured, or where direct non-AD user access is needed.

For security, the local accounts created for SMB access are given {{Code|1=/usr/sbin/nologin}} as their shell, so they cannot log in over SSH or at the console. By default the only accounts with a login shell are '''qadmin''' and '''root''', and those should be reserved for maintenance activities. That restriction can be overridden with standard Linux user management commands, but doing so widens your attack surface and is not recommended.

=== Adding New Users ===

[[File:security_user_add.png|thumb|right|626px|Add User dialog, General tab.]]

{{Navigation|Security → Management Users → User → Add ''(toolbar)''}}

The '''General''' tab takes:

* '''Username''' -- also becomes the local POSIX account name on every system in the grid.
* '''Password''' and '''Repeat Password''' -- must satisfy the grid password policy set in the '''[[#Security Settings Management|Security Manager]]'''. The factory default policy is deliberately permissive; raising it with '''Suggested Defaults''' is recommended.
* '''Role''' -- see '''[[#Role Based Access Controls (RBAC)|RBAC]]'''. Assign '''System Monitor''' to an account that only needs to observe, rather than '''Administrator'''.
* '''Enable Multi-Factor Auth''' and '''Multi-Factor Auth Config''' -- require a second factor for this account; see '''[[#Multi-factor Authentication|Multi-factor Authentication]]'''. These are greyed out until at least one MFA configuration exists.
* '''User Information''' -- optional First Name, Last Name, and Description.

The default '''admin''' account can be modified but cannot be deleted, and cannot be assigned any role other than '''Administrator'''.

A newly created user appears in the Users grid with its assigned Role and the POSIX User ID allocated to it, and the matching local account exists on every system in the grid immediately.

==== Alert Subscriptions ====

[[File:security_user_alerts.png|thumb|right|626px|Add User, Alert Subscriptions tab.]]

Entering a user's email address and selecting the alert severity levels to subscribe to routes email alerts to that administrator. Several users can subscribe at different severities, so that (for example) only critical alerts page the on-call administrator while an operations mailbox receives everything.

Once configured, use the '''Alert Manager''' to send a test alert and confirm delivery end to end.

==== Web Interface Customization ====

[[File:security_user_webcustom.png|thumb|right|626px|Add User, Web Interface Customization tab.]]

In larger deployments with many administrators, or on systems built for a narrow use case, it can help to hide the interface tab panels and sections a given user does not need. This reduces complexity and makes the interface clearer for admins with a narrow remit.

Un-check the panels and sections to hide them. The user must '''log out and back in''' for the customized layout to take effect.

The same customization can be applied to a Role instead of an individual user, which is usually preferable when several people share a job function -- see '''[[#Role Management|Role Management]]'''.

==== User Account Advanced Settings ====

[[File:security_user_advanced.png|thumb|right|626px|Add User, Advanced Settings tab.]]

The '''Advanced Settings''' tab holds three things:

* '''User Default CHAP settings''' -- a '''CHAP User''' and '''CHAP Password''' used as this account's defaults for iSCSI authentication.
* '''Customize UID/GID''' -- tick this to set an explicit '''POSIX UID''' and '''POSIX GID''' rather than letting QuantaStor allocate them. Set these deliberately when the account is used for SMB and NFS access and must match UIDs already in use elsewhere in your environment; the fields are greyed out until the box is ticked.
* '''Enable '[QSCLITKN]' token based authentication for QS CLI via 'root' console account''' -- lets someone logged into a QuantaStor system as '''root''' run {{Code|1=qs}} CLI commands without supplying a password each time.

To use the token authentication, tick that checkbox for the account, then, as '''root''' on the system, write a {{Code|1=~/.qs.cnf}} naming the account:

<pre style="font-size: smaller">
echo "localhost,admin,[QSCLITKN]" > ~/.qs.cnf
</pre>

Replace {{Code|1=admin}} with whichever account you enabled the option for.

'''Note:''' the first one or two {{Code|1=qs}} commands after creating this file fail with ''"Service authentication token check failed ... remote caller will update token"'' while the token is being established. This is expected -- retry and the command succeeds, after which authentication is transparent.

The same mechanism can be used with a remote host rather than {{Code|1=localhost}} by changing the first field.

=== Modifying Users ===

[[File:security_user_modify.png|thumb|right|626px|Modify User dialog.]]

{{Navigation|Security → Management Users → ''select a user'' → User → Modify ''(toolbar)''}}

The Modify User dialog exposes the same settings as Create User across the same four tabs, so a user's role, alert subscriptions, interface customization, and advanced settings can all be changed after the fact. Changes take effect on the user's next action.

To change only a password, use '''Set Password''' from the User group in the toolbar rather than the full Modify dialog.

More information: [[User_Modify|Modify User]].

=== Removing Users ===

[[File:security_user_remove.png|thumb|right|406px|Remove User dialog.]]

{{Navigation|Security → Management Users → ''select a user'' → User → Remove ''(toolbar)''}}

The dialog confirms the '''Username''' and shows the account's properties before removal.

Removal takes effect immediately and grid-wide. A user who is logged into the web interface when their account is removed loses access to all systems in the grid at once, and the matching local POSIX account is deleted from every Storage System.

The default '''admin''' account cannot be removed.

More information: [[User_Remove|Removing Users]].

== User Group Management ==

[[File:security_usergroup_create.png|thumb|right|550px|Create User Group dialog.]]

User Groups collect users under a common POSIX GID, which is useful when several users need to be owners of the same Network Share.

{{Navigation|Security → Management Groups → User Group → Create ''(toolbar)''}}

The Create User Group dialog takes a '''Name''', an optional '''Description''', an optional '''POSIX GID''' (allocated automatically if left blank), and a grid from which to '''select one or more users for the group'''.

Group membership can be changed later with '''Add/Remove Users''', and the group's other properties with '''Modify'''. '''Delete''' removes the group; the user accounts themselves are unaffected.

== Multitenancy / Resource Group Management ==

[[File:security_multitenancy.png|thumb|right|800px|Multitenancy tab.]]

Resource Groups are multi-tenant containers that group users together with resources -- [[Storage Volumes]], [[Network Shares]] -- and with provisioning quotas for self-service provisioning from Storage Pools.

{{Navigation|Multitenancy ''(main tab)''}}

The '''Resource Group''' toolbar group provides '''Add/Remove Users''', '''Add/Remove Tenants''', '''Add/Remove Service Configs''', and '''Add Network Association''' / '''Remove Network Association''' for binding a group to specific networks. The '''Provisioning Quota''' group provides '''Create''', '''Modify''', and '''Delete''' for quotas, plus '''Add/Remove Volumes''' and '''Add/Remove Shares''' to place resources into a group.

Users assigned to a Resource Group should hold a role whose permissions are scoped to '''Resource Group''' rather than '''Global/System''', so that their view of the grid is limited to the resources in their group. The '''Object Tenant Admin''' role is the shipped starting point for object storage tenants; for file and block multi-tenancy, create a role with the permissions you want at '''Resource Group''' scope -- see '''[[#Role Permissions - Operation Scope|Operation Scope]]'''.

Further information: [[Create_Resource_Group|Create a Resource Group]].
== System Setup Security Checks ==

The steps in this section are the minimum hardening pass for a newly deployed QuantaStor system. All of them should be completed before the system carries production data.

# Change the '''qadmin''' console password from its default.
# Change the '''admin''' management password from its default.
# Apply '''Suggested Defaults''' in the '''[[#Security Settings Management|Security Manager]]''' to raise the password and lockout policy.
# Set '''[[#Web Access Mode|Web Access Mode]]''' to ''HTTP redirects to HTTPS'' or ''HTTP disabled''.
# Replace the shipped self-signed certificate -- see '''[[#Installing Your Own Certificate|Installing Your Own Certificate]]'''.
# Block unused protocols in the '''[[#Firewall Configuration|firewall]]'''.
# Consider enabling '''[[#Multi-factor Authentication|multi-factor authentication]]''' for administrative accounts.

=== Change Passwords ===

QuantaStor ships with two default accounts that must both be changed. They are separate accounts with separate passwords: '''qadmin''' is the console/SSH account, '''admin''' is the management interface account.

==== Change SSH Console Administrator Account 'qadmin' Password ====

One of the most important steps in configuring a new QuantaStor system is changing the '''qadmin''' console password from its default of '''qadmin''' on each Storage System.

Log in at the console as '''qadmin''', or connect over '''SSH''' as '''qadmin''', then run:

<pre style="font-size: smaller">
passwd
</pre>

Choose a strong password containing upper and lower case letters, numbers, and symbols. Repeat this on every Storage System in the grid -- this is a local console account, so changing it on one system does not change it on the others.

Note that this password is independent of the grid password policy configured in the Security Manager, which governs '''management''' users only.

==== Change Management Administrator Account 'admin' Password ====

[[File:security_set_password.png|thumb|right|377px|Set Password dialog.]]

Log in to the web management interface as '''admin''' and change the default password, which is '''password'''.

{{Navigation|Security → Management Users → ''select the'' admin ''user'' → User → Set Password ''(toolbar)''}}

The new password must satisfy the grid password policy. Use at least 10 characters with upper and lower case letters and numbers -- or raise the policy first with '''Suggested Defaults''' so the requirement is enforced for every account rather than relying on convention.

Unlike '''qadmin''', this is a grid-wide management account: changing it once changes it for the whole Storage Grid.

== Firewall Configuration ==

[[File:security_firewall.png|thumb|right|616px|Storage System Modify, Firewall tab.]]

QuantaStor has an integrated firewall management system that controls protocol access both at the system level and per network port. For high-security environments it is recommended to block every protocol that will not be used.

'''Navigation (system level):''' Storage Management --> ''select a Storage System'' --> Modify ''(toolbar)'' --> Firewall ''(tab)''

'''Navigation (per port):''' Storage Management --> Network Ports --> ''select a port'' --> Modify Network Port ''(toolbar or right-click)'' --> Firewall ''(tab)''

The Firewall tab lists each service with a description and an '''Allow''' checkbox. The services managed are:

* '''QS Web Management''' -- web management interface access
* '''QS REST API''' -- REST API access to management functions
* '''iSCSI Target''' -- iSCSI protocol access to Storage Volumes
* '''NVMeoF Target''' -- NVMe over Fabrics access
* '''SMB''' -- SMB/CIFS file access
* '''NFS''' and '''NFS Ganesha''' -- NFS file access, scale-up and scale-out respectively
* '''Ceph''' -- scale-out cluster communication
* '''Grafana''' -- Grafana monitoring and statistics
* '''Prometheus''' -- Prometheus monitoring and alerting
* '''Chronograf''' -- Chronograf monitoring

Clear the '''Allow''' box for any service you do not use. A common hardening pass on a file-only deployment, for example, is to leave SMB and NFS enabled and clear iSCSI Target, NVMeoF Target, and Ceph.

Be careful not to block the protocol you are managing the system with: clearing '''QS Web Management''' on the port you are connected through will cut off your own session. Note also that '''[[#Web Access Mode|Web Access Mode]]''' set to ''HTTP disabled'' installs its own rule dropping port 80, independently of these checkboxes.

Use '''Apply''' to commit changes without closing the dialog.
== SSL/TLS Certificate & Web Access Security ==

QuantaStor serves the web management interface, the REST API, and the internal grid communication channels over TLS. The web management interface is served by '''nginx''' and the TLS settings, ciphers, and certificates are all managed by QuantaStor.

'''Note for administrators upgrading from QuantaStor v4:''' older releases served the web interface from Apache Tomcat and required generating a Java keystore with {{Code|1=keytool}}. That is no longer the case. There is no keystore, no {{Code|1=server.xml}}, and no tomcat service on QuantaStor v5 and newer -- use the procedures below instead.

=== Web Access Mode ===

The single most important web security setting is the '''Web Access Mode''', which controls whether plain HTTP is served at all.

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)'' → Advanced Settings}}

The three modes are:

* '''HTTP enabled (INSECURE)''' -- port 80 serves the interface over plain, unencrypted HTTP. This is the factory default so that a newly-imaged appliance is reachable before certificates are in place; it is '''not''' appropriate for production.
* '''HTTP redirects to HTTPS (recommended)''' -- port 80 answers with a 301 redirect to HTTPS. Nothing sensitive traverses the network in the clear, but a user who types the bare hostname still lands on the interface.
* '''HTTP disabled''' -- port 80 is dropped at the firewall entirely. Use this in high-security environments where an open port 80, even one that only redirects, is not acceptable.

Changing this setting switches the active nginx site configuration and, for '''HTTP disabled''', also installs a firewall rule that drops port 80. The change applies immediately -- no reboot is required.

The Web Access Mode affects '''port 80 only'''. The HTTPS listener on port 443 uses the same TLS versions, cipher list, and certificate in every mode, so switching modes does not change the encryption offered to HTTPS clients -- it only determines whether an unencrypted alternative is reachable. Setting the mode to '''HTTP redirects to HTTPS''' should nonetheless be treated as a required hardening step on every production deployment.

Changing this setting prompts a confirmation warning that the change may log users out of the interface and cause passwords to expire; the mode change itself takes effect as soon as you confirm.

=== Supported TLS Versions and Ciphers ===

QuantaStor's nginx configuration accepts '''TLS 1.2 and TLS 1.3''' only, in all web access modes, with server cipher preference enabled and the cipher list restricted to modern AEAD suites: ''(Note: due to the frequency of security updates this may be out of date and system configuration files should be referenced.)''

<pre style="font-size: smaller">
ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:
ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256
</pre>

SSLv3, TLS 1.0, and TLS 1.1 are not accepted. ''(Note: due to the frequency of security updates this may be out of date and system configuration files should be referenced.)'' The interface also sends an HSTS header ({{Code|1=Strict-Transport-Security}}) with a one year max-age.

The shipped defaults live in this file, which is replaced on upgrade and should '''not''' be edited in place:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/nginx_quantastor_ssl_default.conf
</pre>

To customize the TLS settings or point nginx at your own certificate, use the {{Code|1=qs-util}} helper to copy the defaults to a user-editable location that upgrades will not overwrite:

<pre style="font-size: smaller">
qs-util wuicustomcerts
</pre>

This creates the following file, which you then edit:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf
</pre>

Cipher settings for the QuantaStor grid communication channels (separate from the web interface) are controlled by:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/qsciphers
</pre>

That shipped file is replaced on upgrade, so it should not be edited in place. To customize the grid communication ciphers, place your own copy at the override location below. The override does not exist by default -- create it only when you intend to depart from the shipped cipher list, and QuantaStor will use it in preference to the shipped file and leave it untouched across upgrades:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/qsciphers
</pre>

=== Default Certificate ===

QuantaStor ships with a common self-signed certificate that is pre-generated and included with all deployments. Because it is self-signed and shared across all deployments, browsers will warn on first connection, and it provides no identity assurance. Replacing it is recommended for any deployment reachable beyond a trusted management network.

The certificate and key used by the web interface and REST service are here:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/qsrestsrv.pem
</pre>

Grid communication uses a separate pair:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/qsserver.pem
/opt/osnexus/common/lib/qsclient.pem
</pre>

All of these are discovered and monitored automatically -- see '''[[#Certificate Management|Certificate Management]]''' below, which is the recommended way to review and replace them.

=== Installing a Custom Certificate ===

The '''recommended''' way to install your own certificate is through '''[[#Certificate Management|Certificate Management]]''' -- add the certificate as a template once, then apply it to the '''NGINX''' use case on each Storage System. That keeps the certificate inventory, expiry monitoring, and alerting accurate, and avoids editing nginx configuration by hand. See '''[[#Installing Your Own Certificate|Installing Your Own Certificate]]'''.

Use the manual procedure below only when you need to change nginx TLS directives themselves (for example to further restrict the cipher list), since those are not expressible as a certificate template:

* Run {{Code|1=qs-util wuicustomcerts}} to copy the shipped defaults to an editable file that upgrades will not overwrite.
* Edit {{Code|1=/var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf}}.
* Reload nginx to apply:

<pre style="font-size: smaller">
systemctl reload nginx
</pre>

* Verify the negotiated protocol and cipher from a client:

<pre style="font-size: smaller">
openssl s_client -connect <system-ip>:443 </dev/null 2>/dev/null \
| grep -E 'Protocol|Cipher is'
</pre>

Repeat on each Storage System in the grid, or use the Certificate Management section to confirm all systems at once.

'''Note:''' if you are using Firefox and have previously accepted the old self-signed certificate, clear the cached certificate exception for the host or Firefox will continue to present the stale certificate warning.
=== [[Custom SSL_TLS Security|Custom SSL Certificates and TLS Security]] ===
* Generating and installing custom SSL certificates, and applying custom TLS security settings. For most deployments the '''[[#Certificate Management|Certificate Management]]''' section above is the better route, since it keeps the certificate inventory and expiry alerting accurate.

=== [[Custom SSH Security|Custom SSH Ciphers and Key Exchange Algorithms]] ===
* Customizing the SSH service to enforce strong ciphers and key exchange algorithms for SSH communication.
== Certificate Management ==

[[File:security_certificates.png|thumb|right|800px|Certificates section showing every certificate on every Storage System in the grid.]]

QuantaStor discovers, inventories, and monitors every TLS certificate in use across the Storage Grid, so administrators can see at a glance what is installed, what it is used for, and when it expires.

{{Navigation|Security → Certificates}}

The Certificates section lists certificates grouped by Storage System. For each certificate the grid shows its file path, '''State''', '''Use Case''', description, certificate modulus MD5, serial number, and the start and end of its validity period. Because the view spans the whole grid, a single screen confirms that every system is using the certificate you expect.

=== Certificate Use Cases ===

Each certificate is tagged with the service that consumes it:

* '''NGINX''' -- the certificate served to browsers for the web management interface.
* '''Rest Service''' -- the certificate presented by the QuantaStor REST API service.
* '''QuantaStor Service [Grid Communication]''' -- the server-side certificate for inter-node grid communication.
* '''Client [Grid Communication]''' -- the client-side certificate a node presents to its peers.
* '''HAProxy''' -- the certificate used by the integrated load balancer, when configured.
* '''Object Gateway''' -- the certificate used by the Ceph S3/Object Gateway. Two use cases are available, for a first and second gateway instance ({{Code|1=cephrgw-1}} and {{Code|1=cephrgw-2}} on the CLI).

Note that the same PEM file may appear more than once with different use cases when one certificate serves several roles -- for example {{Code|1=qsrestsrv.pem}} is used for both '''NGINX''' and '''Rest Service'''.

=== Certificate Expiration Alerts ===

QuantaStor monitors validity dates and raises alerts as a certificate approaches expiry, so a certificate never lapses unnoticed. Alerts are raised at '''90, 60, 30, 7, and 2 days''' before expiry, and again once the certificate has actually expired.

The longer-lead warnings are only raised for certificates with a correspondingly long lifetime -- the 90 day warning applies to certificates valid for more than 18 months, the 60 day warning to those valid for more than a year, and the 30 day warning to those valid for more than 90 days. This prevents short-lived certificates from generating alerts the moment they are installed. The 7 day, 2 day, and expired alerts always apply.

Alerts are delivered through the standard QuantaStor alerting system, so they reach whatever email and SNMP destinations you have configured in the Alert Manager.

=== Certificate Templates ===

A '''certificate template''' holds a certificate (and its private key) that you have obtained from your CA, stored once in the grid so it can be applied to any service on any Storage System. Templates are what make it possible to roll out your own certificate across the grid from the management interface instead of copying PEM files onto each node by hand.

{{Navigation|Security → Certificates → ''Certificate Templates'' ''(tab)''}}

The toolbar provides '''Add Template''', '''Update''', '''Remove Template''', and '''Certificate Template Manager''' for reviewing and maintaining templates.

=== Installing Your Own Certificate ===

This is the recommended way to replace any of QuantaStor's default self-signed certificates, including the one served by the web management interface.

* Obtain a certificate and private key from your CA.
* '''Add a template''' from the certificate. Supply a name, a description, and the PEM file containing the certificate and key block. If the private key is in a separate file, supply it as well.
* '''Apply the template''' to the use case you want it to serve on a given Storage System -- for example apply it to the '''NGINX''' use case to change the certificate browsers see for the web management interface.
* Repeat the apply step for each Storage System, and for each use case the certificate should cover.

'''IMPORTANT -- the certificate must contain a Subject Alternative Name (SAN).''' QuantaStor validates certificates before accepting them as a template and rejects any certificate without a SAN extension, with the error ''"Certificate validation failed. Unable to create certificate template out of invalid certificate."'' A Common Name alone is not sufficient. Include every name and address the systems will be reached by -- the FQDN, the short hostname, and the management IP. When generating a self-signed certificate with {{Code|1=openssl req}}, add the SAN explicitly:

<pre style="font-size: smaller">
openssl req -x509 -newkey rsa:2048 -nodes -days 365 \
-subj "/C=US/ST=<state>/L=<city>/O=<org>/CN=<fqdn>" \
-addext "subjectAltName=DNS:<fqdn>,DNS:<hostname>,IP:<system-ip>" \
-keyout mycert.key -out mycert.crt

cat mycert.crt mycert.key > mycert.pem
</pre>

You can check a certificate against QuantaStor's validation rules before importing it:

<pre style="font-size: smaller">
/opt/osnexus/quantastor/bin/qs_certutil.sh validate --pem-file <path-to-pem>
</pre>

From the CLI the two steps are:

<pre style="font-size: smaller">
qs cert-tmpl-add --name=<template-name> --description=<text> \
--certificate-pem-data=<path-to-pem> \
[--privatekey-pem-data=<path-to-key-pem>]

qs cert-update --storage-system=<system> --cert-use-case=2 \
--cert-tmpl=<template-name>
</pre>

'''Note:''' {{Code|1=--cert-use-case}} currently requires the numeric use case value rather than its name. The values are ''0'' none, ''1'' haproxy, ''2'' nginx, ''3'' cephrgw-1, ''4'' cephrgw-2, ''5'' qsrest, ''6'' qsserver, ''7'' qsclient.

QuantaStor reloads the affected service automatically once the certificate is applied, so the new certificate is served without further action -- nginx for the '''NGINX''' and '''Rest Service''' use cases, HAProxy for '''HAProxy''', and the Object Gateway services for the gateway use cases. nginx is reloaded rather than restarted, so applying a web interface certificate does not disconnect your own management session.

'''Note for QuantaStor releases prior to 6.9:''' the nginx reload was not performed automatically, and the appliance would continue to present the previous certificate until nginx was reloaded by hand:

<pre style="font-size: smaller">
systemctl reload nginx
</pre>

Confirm what is actually being served, including the SAN:

<pre style="font-size: smaller">
openssl s_client -connect <system-ip>:443 </dev/null 2>/dev/null \
| openssl x509 -noout -subject -dates -ext subjectAltName
</pre>

=== Rescanning Certificates ===

If a certificate is replaced outside of QuantaStor -- for example by editing the nginx configuration directly, or by a external renewal process dropping in a new PEM -- use '''Rescan''' to re-read the certificates from disk and refresh the inventory, validity dates, and alert state.

{{Navigation|Security → Certificates → Rescan ''(toolbar)''}}

=== Reviewing Certificates from the CLI ===

The same inventory is available from the QuantaStor CLI, which is convenient for scripted compliance checks:

<pre style="font-size: smaller">
qs cert-list
qs cert-get --cert=<name-or-id>
qs cert-rescan --storage-system=<system>
</pre>

Certificate templates have a matching set of commands:

<pre style="font-size: smaller">
qs cert-tmpl-list
qs cert-tmpl-get --cert=<name-or-id>
qs cert-tmpl-rm --cert=<name-or-id>
</pre>

For TLS version and cipher settings, see '''[[#Supported TLS Versions and Ciphers|Supported TLS Versions and Ciphers]]'''.
== Endpoint Detection & Response (EDR) ==

[[File:security_edr_agents.png|thumb|right|800px|EDR Agents section. Agents are installed per Storage System and report vendor, status, version, and enabled features.]]

Many security standards and cyber-insurance policies require an endpoint detection and response (EDR) agent on every server, including storage appliances. QuantaStor can deploy and manage a vendor EDR agent on each Storage System in the grid directly from the web management interface, so the appliances are covered by the same endpoint security tooling as the rest of the fleet without hand-installing agents over SSH.

{{Navigation|Security → EDR Agents}}

The EDR Agents section lists the installed agents with their '''Name''', '''State''', '''Storage System''', '''Vendor''', '''Status''', '''Version''', and the set of '''Features''' the agent has enabled.

=== Supported EDR Vendors ===

'''Bitdefender GravityZone''' is the currently supported EDR platform, on Ubuntu 22.04, Ubuntu 24.04, RHEL 8, and RHEL 9. Additional vendor modules use the same framework and are being added; contact OSNEXUS at info@osnexus.com if you need a specific EDR platform supported.

Vendor modules are defined on the appliance in:

<pre style="font-size: smaller">
/opt/osnexus/quantastor/conf/qs_endpoint_security.conf
</pre>

=== Installing an EDR Agent ===

[[File:security_edr_install.png|thumb|right|516px|Install EDR Security Agent dialog.]]

Before starting, create an installation package for Linux servers in your Bitdefender GravityZone console and note either the '''package id''' or the full '''setup downloader URL''' the console provides. The feature set of the agent (which protection modules are enabled) is chosen in the GravityZone console when the package is created, and QuantaStor reads that selection back from the installer. Individual protection modules can optionally be overridden from the QuantaStor side at install time -- see the {{Code|1=--feature-flags}} argument in the CLI section below.

{{Navigation|Security → EDR Agents → Install Agent ''(toolbar)''}}

You can also right-click a Storage System to install an agent on it.

In the '''Install EDR Security Agent''' dialog:

* '''EDR Module''' -- select the vendor module, e.g. ''Bitdefender''.
* '''Install Key / URL''' -- paste either the short GravityZone package id (e.g. {{Code|1=aabbccdd}}) or the full {{Code|1=setup_downloader.tar}} URL copied from the GravityZone console. Both forms are accepted, which matters because the vendor's URL format changes from time to time.
* '''Storage Systems''' -- tick each system to install the agent on. The grid shows the service, kernel, and distribution version of each system so you can confirm platform support before installing.

QuantaStor then downloads the installer package from GravityZone onto each selected system, installs the agent, and registers it. Because the appliance must reach the GravityZone service to download the package, ensure outbound access to your GravityZone endpoint is permitted -- see '''[[#Firewall Configuration|Firewall Configuration]]'''.

Note that the registration key is supplied at install time and stored per node; it is not kept in the vendor module configuration file.

=== Monitoring and Removing Agents ===

Once installed, an agent's '''Status''' and '''Version''' are refreshed automatically and shown in the EDR Agents grid, so an agent that has stopped running is visible from the management interface rather than only from the vendor console.

To remove an agent, select it and choose '''Uninstall Agent'''.

{{Navigation|Security → EDR Agents → Uninstall Agent ''(toolbar)''}}

=== EDR Management from the CLI ===

The same operations are available from the QuantaStor CLI:

<pre style="font-size: smaller">
qs edr-agent-list
qs edr-agent-get --edr-agent=<name-or-id>
qs edr-agent-create --system-list=<systems> --module=bitdefender \
--registration-key=<package-id-or-url>
qs edr-agent-delete --edr-agent=<name-or-id>
qs edr-agent-rescan
</pre>

The create command also accepts an optional {{Code|1=--feature-flags}} argument taking a JSON object, to override individual protection modules without changing the GravityZone package:

<pre style="font-size: smaller">
qs edr-agent-create --system-list=qs-node-a --module=bitdefender \
--registration-key=aabbccdd \
--feature-flags='{"FileScan":1,"Firewall":0}'
</pre>

To review the available vendor modules and their supported platforms:

<pre style="font-size: smaller">
qs edr-agent-module-list
qs edr-agent-module-get --module=bitdefender
</pre>

== [[Custom S3 SSl/TLS Certificate|Custom S3 SSL/TLS Certificate]] ==
* Installing a custom certificate for the S3/Object Gateway endpoint. See also the '''Object Gateway''' certificate use cases under '''[[#Certificate Use Cases|Certificate Use Cases]]'''.

== Multi-factor Authentication ==

[[File:security_mfa_manager.png|thumb|right|631px|Multi-Factor Authentication Manager.]]

Multi-factor authentication (MFA) requires a user to present a second factor, such as a device, in addition to their password. QuantaStor supports MFA for management logins.

{{Navigation|Security → Management Users → User → Multi-Factor Auth Manager ''(toolbar)''}}

An MFA '''configuration''' must exist before MFA can be enabled on any account. The manager lists the existing configurations by '''Name''' and '''Provider''' and provides '''Create...''', '''Modify...''', '''Delete...''', and '''Assign/Unassign...''' for attaching a configuration to user accounts.

The supported providers are:

* '''Cisco Duo''' -- see [[Duo Multi-Factor Authentication|Cisco Duo Multi-Factor Authentication]] for the full setup walkthrough
* '''OKTA'''

Creating a configuration takes a '''Provider''', a '''Name''', an optional '''Description''', the '''API Host''' for your tenant, and the '''Integration Key''' and '''Secret Key''' issued by the provider. Obtain those values from your Duo or Okta administration console.

Once a configuration exists, enable MFA per account with '''Enable Multi-Factor Auth''' and '''Multi-Factor Auth Config''' on the Add User or Modify User dialog. The '''Force (required when in use)''' option in the manager makes the second factor mandatory rather than optional.

Contact OSNEXUS at info@osnexus.com for guidance on additional MFA options.

== Security Updates ==

QuantaStor supports automatic security updates through the '''[[Upgrade Manager]]''' in the web management interface.

{{Navigation|Storage Management → Upgrade Manager ''(toolbar)''}}

Applying security updates through the Upgrade Manager is the supported path -- it applies the updates OSNEXUS has qualified against the running QuantaStor release, in the correct order, across the systems you select. Installing distribution packages directly with {{Code|1=apt}} is not recommended, as it can introduce package versions that have not been qualified against the release.

== Encrypting NFS/SMB/iSCSI via IPsec ==

Protocols such as NFSv3 do not encrypt data on the wire. Where the storage network is not itself trusted, set up an encrypted tunnel between the client and the QuantaStor system so that protocol traffic is protected in transit.

More information on configuring IPsec on QuantaStor systems is available [[IPSec|here]].

Note that IPsec protects data '''in transit'''. For data '''at rest''', QuantaStor provides [[Storage Pools|Storage Pool]] encryption, which is configured when the pool is created and is covered separately in the administrator guide.

== Related pages ==

* [[Send System Log Report]] -- collecting and sending a scrubbed log bundle to support
* [[Duo Multi-Factor Authentication]] -- setting up the Cisco Duo MFA provider
* [[Custom SSH Security]] -- hardening the SSH service and managing key access
* [[Custom S3 SSl/TLS Certificate|Custom S3 SSL/TLS Certificate]] -- certificates for the S3 gateway
* [[IPSec]] -- encrypting protocol traffic in transit between client and appliance
* [[Storage Pools]] -- pool encryption, which protects data at rest
* [[Upgrade Manager]] -- applying security patches and QuantaStor updates
* [[Call-home / Alerting|Alert Manager]] -- alert delivery, including certificate expiry alerts
* [[Storage System]] -- system-level configuration and the Modify dialog

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

Security Configuration

2026-09-03T01:03:14Z

Umbe: /* Installing an EDR Agent */

[[Category:admin_guide]]

QuantaStor provides a layered set of security controls: grid-wide password and login policy, role based access control over every management operation, multi-factor authentication, an integrated firewall, TLS certificate management, and endpoint detection and response agent deployment. This page covers each of them.

Many industries require compliance with government security standards covering everything from audit logging to password policies. These include Health and Human Services security standards [https://www.hhs.gov/hipaa/index.html (HIPAA)], federal law enforcement security standards [https://www.fbi.gov/services/cjis/cjis-security-policy-resource-center (CJIS)], and the general standards outlined by NIST for Controlled Unclassified Information (CUI) in Non-Federal Information Systems and Organizations, covered in NIST 800-53 and [https://csrc.nist.gov/publications/detail/sp/800-171/rev-2/final 800-171].

Nearly all of the settings on this page are reached from the '''Security''' tab of the QuantaStor web management interface, which contains these sections:

{| class="wikitable"
! Security tab section !! Covers !! On this page
|-
| '''Management Users''' || User accounts, password policy, multi-factor authentication || [[#Security Settings Management|Security Settings]], [[#User Management|Users]], [[#Multi-factor Authentication|MFA]]
|-
| '''Management Groups''' || User groups and their shared POSIX GID || [[#User Group Management|User Groups]]
|-
| '''Management Roles''' || RBAC roles and their permission assignments || [[#Role Based Access Controls (RBAC)|RBAC]]
|-
| '''Object Users & Tenants''' || S3/object storage users and tenants || [[#Multitenancy / Resource Group Management|Multitenancy]]
|-
| '''Scale-out File & Block Keyrings''' || Keyrings for scale-out storage || not covered here
|-
| '''Certificates''' || The grid-wide TLS certificate inventory || [[#Certificate Management|Certificate Management]]
|-
| '''Key Server Profiles''' || External key server (KMIP) profiles || not covered here
|-
| '''EDR Agents''' || Endpoint detection and response agents || [[#Endpoint Detection & Response (EDR)|EDR]]
|}

Also on this page: [[#Firewall Configuration|Firewall Configuration]],
[[#SSL/TLS Certificate & Web Access Security|SSL/TLS and Web Access Security]],
[[#System Setup Security Checks|System Setup Security Checks]] and
[[#Security Updates|Security Updates]].

== Security Settings Management ==

[[File:security_manager_general.png|thumb|right|546px|Security Manager, General tab -- grid-wide password and login policy.]]

The '''Security Manager''' holds the password and login policy for the entire Storage Grid. These settings apply to all user accounts on all systems in the grid, not per-system.

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)''}}

Choosing '''Suggested Defaults''' automatically configures the password and lockout policies to meet the standards listed above. This is the recommended starting point -- apply it first, then tune individual settings for the requirements of your deployment. '''Discard Changes''' reverts the dialog to the currently saved policy.

The '''General''' tab controls:

* '''Password Complexity''' -- the required character-class mix. The factory default is ''Weak''; raise this for any production or compliance-bound deployment.
* '''Allowed Special Characters''' -- which non-alphanumeric characters are permitted in passwords.
* '''Minimum / Maximum Password Length''' -- both in the range 8 to 80.
* '''Login Attempts Until Short Lockout''' and '''Login Attempts Until Lockout''' -- consecutive failures before a temporary and then a permanent lockout. Set the second to 0 to disable permanent lockout.
* '''Bad Logins Sample Period''' (short and permanent) -- the window, in seconds, over which failed attempts are counted.
* '''Bad Logins Short Lockout Duration''' -- how long, in seconds, a short lockout lasts.
* '''Days Until Password Expires''' -- 0 to 1000; 0 disables expiry.
* '''Unique Passwords Until Reuse''' -- 0 to 20; how many previous passwords are remembered and refused.
* '''Minimum Days Between Password Change''' -- prevents a user cycling straight back to a previous password.
* '''Maximum Days Account Inactive Until Lockout''' -- locks out dormant accounts.
* '''Auto Logout From N Minutes Of Inactivity''' -- idle timeout for the web interface; 0 disables it.
* '''Default Login Username''' -- the username pre-filled on the login page.

The '''Multi-admin Approvals''' tab configures which operation types require a second administrator's approval before they run; approvals are then granted or refused from the '''Multi-admin Approval''' group in the Security toolbar.

The '''Advanced Settings''' tab holds the '''Web Access Mode''' (see '''[[#Web Access Mode|Web Access Mode]]'''), an optional '''System Use Notification''' banner shown to users at login, and the LDAP single-sign-on settings described next.

'''Note:''' saving the Security Manager prompts a confirmation that the change may log users out of the interface and cause passwords to expire. Plan policy changes accordingly.

=== LDAP Single-Sign-On Authentication ===

[[File:security_manager_advanced.png|thumb|right|546px|Security Manager, Advanced Settings -- Web Access Mode and LDAP single sign-on.]]

The Advanced Settings tab can connect the Storage Grid to an LDAP or Active Directory domain for '''management user''' authentication.

To configure this:

* In your LDAP/AD environment, create one or more groups for QuantaStor administration -- for example {{Code|1=QS-Administrator}} and {{Code|1=QS-Monitor}} -- and add the appropriate users to them.
* In QuantaStor, edit the Role you want each LDAP group to map to and set its '''LDAP Group''' field. For example set the '''Administrator''' role's LDAP Group to {{Code|1=QS-Administrator}}, and the '''System Monitor''' role's to {{Code|1=QS-Monitor}}. The LDAP Group field is on the Create Role and Modify Role dialogs.
* Set your DNS and NTP servers to point at your AD server, in the Storage System Modify dialog. Do this '''before''' enabling single sign-on.
* Return to Security Manager --> Advanced Settings, tick '''Enable Single Sign-on''', and fill in the LDAP settings. The two fields are greyed out until the checkbox is ticked.

The LDAP fields are:

* '''LDAP Server (FQDN)''' -- the fully qualified domain name of the LDAP/AD server, for example {{Code|1=dc01.example.com}}
* '''LDAP Server Base DN for Users''' -- the base DN under which user accounts are searched, for example {{Code|1=dc=example,dc=com}}

This integration provides single sign-on for '''administrative''' access to the Storage Grid via the QuantaStor web interface, CLI, and REST API. It does '''not''' provide Active Directory integration for SMB network share access. For that, join each system to the domain via '''Storage Management --> Storage Systems --> Active Directory ''(toolbar)'' --> Join AD Domain'''.

=== Audit Logging ===

Audit logging of management operations is on by default on all QuantaStor systems and cannot be disabled. Every API, CLI, and web interface operation passes through the same core service and is recorded.

The audit log is at:

<pre style="font-size: smaller">
/var/log/qs/qs_audit.log
</pre>

It is written in a NIST compliant CEE JSON format, one JSON object per line, so it can be ingested directly by a log aggregator or SIEM without custom parsing. Each record identifies the operation, the user account that invoked it, the source address, and the outcome.

To ship the audit log to a central collector, point your syslog or log agent at this file; QuantaStor does not rotate it out from under a reader.

=== Sending Logs to Support ===

QuantaStor can collect and upload system logs to OSNEXUS Support, scrubbing usernames and other security related information first so that no personally-identifiable information is transmitted, and never including data files from Storage Pools. That makes the collection GDPR compliant.

Full detail is on its own page: '''[[Send System Log Report|Sending Logs to Support]]'''.

== Role Based Access Controls (RBAC) ==

[[File:security_roles_section.png|thumb|right|800px|Management Roles section with the default roles.]]

QuantaStor's '''R'''ole '''B'''ased '''A'''ccess '''C'''ontrol system lets IT and security administrators grant access limited to a job function, following the [https://en.wikipedia.org/wiki/Principle_of_least_privilege principle of least privilege].

The RBAC system is highly granular. Each '''permission''' has three parts:

* an '''object type''' -- for example Network Share, Storage Volume, Storage Pool
* an '''operation''' -- for example create, delete, modify, view
* a '''scope''' -- system, resource group, user, or none

Every QuantaStor API, CLI, and web interface command goes through the same core service, and every call passes an authentication and an authorization check. Because of that shared path, RBAC applies uniformly no matter how the account connects -- web interface, {{Code|1=qs}} CLI, or REST API.

This granularity is especially useful for automation: a dedicated account can be created for a script whose role permits only the task it performs, such as creating and deleting a nightly snapshot of a Network Share.

QuantaStor ships with four default roles:

* '''Administrator''' -- full access to all functions on all systems in the grid.
* '''Security Administrator''' -- full control over security-related functions.
* '''Object Tenant Admin''' -- for users managing object storage tenants.
* '''System Monitor''' -- view only; no configuration changes.

=== Role Management ===

[[File:security_role_create.png|thumb|right|586px|Create Role, showing the permission assignment grid.]]

{{Navigation|Security → Management Roles → Role → Create ''(toolbar)''}}

Each user is assigned a single Role, and a role change takes effect immediately. If a user logged in as '''Administrator''' has their role changed to '''System Monitor''', which has only view permissions, the new permissions apply to their next action. Tasks already running -- a Storage Volume create, for example -- complete at the authorization level held when the task started.

The Create Role dialog takes a '''Name''', a '''Description''', and an optional '''LDAP Group''' used for '''[[#LDAP Single-Sign-On Authentication|single sign-on]]'''.

Because a role carries hundreds of individual permissions, the dialog provides two shortcuts:

* '''Copy Permissions from Role''' -- start from an existing role's permission set (pick the source role in the adjacent dropdown) and adjust from there. This is by far the fastest way to build a new role.
* '''Apply Permission Scope to Selected''' -- tick a set of rows in the grid, choose a scope, and apply it to all of them at once.

The '''Web Interface Customization''' tab hides web interface tab panels and sections for every user holding the role -- the same mechanism described under '''[[#Web Interface Customization|Web Interface Customization]]''', but applied per role rather than per user.

=== Role Permissions - Object Types ===

The '''Permission Assignments''' grid lists every permission as a row of '''Object Type''', '''Operation''', and '''Permission Scope'''.

On QuantaStor 6.9 there are '''207 object types''' and '''662 individual permissions''', covering everything from the common types such as Storage Volume, Network Share, and Object Bucket through to internal types such as Acl, AlertConfiguration, and TargetPort.

Because that list is long, use the '''<Show All Object Types>''' filter above the grid to narrow it to the object type you are working on, then set the operations for that type.

=== Role Permissions - Operation Types ===

Every permission is a combination of an object type and an '''operation''' that can be performed on it. Across the default Administrator role there are 120 distinct operations; the most common are '''view''', '''modify''', '''create''', and '''delete''', with more specific ones such as '''add''', '''remove''', '''rescan''', '''enable''', '''disable''', '''identify''', '''set''', and '''clear''' on the object types that support them.

This per-operation granularity is what lets a role fit a job function. A "Provisioning Administrator" role, for example, can be given '''create''' but not '''delete''', so the routine task of provisioning storage can be delegated without the risk of data deletion.

All object types also have a '''view''' permission, and this one deserves attention: some parts of the web management interface require view permission on a type in order to function. Removing '''view''' is useful when a role should have no visibility of a type at all -- an administrator responsible only for Network Shares could have '''view''' on '''StorageVolume''' set to '''None''', so that no Storage Volumes are visible to them.

=== Role Permissions - Operation Scope ===

Each permission's '''scope''' determines the breadth of the grant. Click a '''Permission Scope''' cell in the grid to change it.

* '''Global/System''' -- grid-wide access to the operation on all systems.
* '''None''' -- access to the operation is blocked entirely.
* '''User''' -- access is limited to objects the user owns. A role with the permission '''Storage Volume + delete + User''' allows deleting only Storage Volumes for which that user is the owner.
* '''Resource Group''' -- access is limited to the objects in the Resource Group the user is assigned to. This is how QuantaStor implements multi-tenancy; see '''[[#Multitenancy / Resource Group Management|Multitenancy]]'''.
== User Management ==

[[File:security_users_section.png|thumb|right|800px|Security tab, Management Users section.]]

Users in QuantaStor are '''management users''' -- accounts with access to the management interface under a specific Role.

These accounts are also created as local (Linux/Unix) users on '''every''' Storage System in the grid, with the same POSIX UID and GID on each. This enables management accounts to be used for SMB file access, which matters in environments where AD/LDAP is not configured, or where direct non-AD user access is needed.

For security, the local accounts created for SMB access are given {{Code|1=/usr/sbin/nologin}} as their shell, so they cannot log in over SSH or at the console. By default the only accounts with a login shell are '''qadmin''' and '''root''', and those should be reserved for maintenance activities. That restriction can be overridden with standard Linux user management commands, but doing so widens your attack surface and is not recommended.

=== Adding New Users ===

[[File:security_user_add.png|thumb|right|626px|Add User dialog, General tab.]]

{{Navigation|Security → Management Users → User → Add ''(toolbar)''}}

The '''General''' tab takes:

* '''Username''' -- also becomes the local POSIX account name on every system in the grid.
* '''Password''' and '''Repeat Password''' -- must satisfy the grid password policy set in the '''[[#Security Settings Management|Security Manager]]'''. The factory default policy is deliberately permissive; raising it with '''Suggested Defaults''' is recommended.
* '''Role''' -- see '''[[#Role Based Access Controls (RBAC)|RBAC]]'''. Assign '''System Monitor''' to an account that only needs to observe, rather than '''Administrator'''.
* '''Enable Multi-Factor Auth''' and '''Multi-Factor Auth Config''' -- require a second factor for this account; see '''[[#Multi-factor Authentication|Multi-factor Authentication]]'''. These are greyed out until at least one MFA configuration exists.
* '''User Information''' -- optional First Name, Last Name, and Description.

The default '''admin''' account can be modified but cannot be deleted, and cannot be assigned any role other than '''Administrator'''.

A newly created user appears in the Users grid with its assigned Role and the POSIX User ID allocated to it, and the matching local account exists on every system in the grid immediately.

==== Alert Subscriptions ====

[[File:security_user_alerts.png|thumb|right|626px|Add User, Alert Subscriptions tab.]]

Entering a user's email address and selecting the alert severity levels to subscribe to routes email alerts to that administrator. Several users can subscribe at different severities, so that (for example) only critical alerts page the on-call administrator while an operations mailbox receives everything.

Once configured, use the '''Alert Manager''' to send a test alert and confirm delivery end to end.

==== Web Interface Customization ====

[[File:security_user_webcustom.png|thumb|right|626px|Add User, Web Interface Customization tab.]]

In larger deployments with many administrators, or on systems built for a narrow use case, it can help to hide the interface tab panels and sections a given user does not need. This reduces complexity and makes the interface clearer for admins with a narrow remit.

Un-check the panels and sections to hide them. The user must '''log out and back in''' for the customized layout to take effect.

The same customization can be applied to a Role instead of an individual user, which is usually preferable when several people share a job function -- see '''[[#Role Management|Role Management]]'''.

==== User Account Advanced Settings ====

[[File:security_user_advanced.png|thumb|right|626px|Add User, Advanced Settings tab.]]

The '''Advanced Settings''' tab holds three things:

* '''User Default CHAP settings''' -- a '''CHAP User''' and '''CHAP Password''' used as this account's defaults for iSCSI authentication.
* '''Customize UID/GID''' -- tick this to set an explicit '''POSIX UID''' and '''POSIX GID''' rather than letting QuantaStor allocate them. Set these deliberately when the account is used for SMB and NFS access and must match UIDs already in use elsewhere in your environment; the fields are greyed out until the box is ticked.
* '''Enable '[QSCLITKN]' token based authentication for QS CLI via 'root' console account''' -- lets someone logged into a QuantaStor system as '''root''' run {{Code|1=qs}} CLI commands without supplying a password each time.

To use the token authentication, tick that checkbox for the account, then, as '''root''' on the system, write a {{Code|1=~/.qs.cnf}} naming the account:

<pre style="font-size: smaller">
echo "localhost,admin,[QSCLITKN]" > ~/.qs.cnf
</pre>

Replace {{Code|1=admin}} with whichever account you enabled the option for.

'''Note:''' the first one or two {{Code|1=qs}} commands after creating this file fail with ''"Service authentication token check failed ... remote caller will update token"'' while the token is being established. This is expected -- retry and the command succeeds, after which authentication is transparent.

The same mechanism can be used with a remote host rather than {{Code|1=localhost}} by changing the first field.

=== Modifying Users ===

[[File:security_user_modify.png|thumb|right|626px|Modify User dialog.]]

{{Navigation|Security → Management Users → ''select a user'' → User → Modify ''(toolbar)''}}

The Modify User dialog exposes the same settings as Create User across the same four tabs, so a user's role, alert subscriptions, interface customization, and advanced settings can all be changed after the fact. Changes take effect on the user's next action.

To change only a password, use '''Set Password''' from the User group in the toolbar rather than the full Modify dialog.

More information: [[User_Modify|Modify User]].

=== Removing Users ===

[[File:security_user_remove.png|thumb|right|406px|Remove User dialog.]]

{{Navigation|Security → Management Users → ''select a user'' → User → Remove ''(toolbar)''}}

The dialog confirms the '''Username''' and shows the account's properties before removal.

Removal takes effect immediately and grid-wide. A user who is logged into the web interface when their account is removed loses access to all systems in the grid at once, and the matching local POSIX account is deleted from every Storage System.

The default '''admin''' account cannot be removed.

More information: [[User_Remove|Removing Users]].

== User Group Management ==

[[File:security_usergroup_create.png|thumb|right|550px|Create User Group dialog.]]

User Groups collect users under a common POSIX GID, which is useful when several users need to be owners of the same Network Share.

{{Navigation|Security → Management Groups → User Group → Create ''(toolbar)''}}

The Create User Group dialog takes a '''Name''', an optional '''Description''', an optional '''POSIX GID''' (allocated automatically if left blank), and a grid from which to '''select one or more users for the group'''.

Group membership can be changed later with '''Add/Remove Users''', and the group's other properties with '''Modify'''. '''Delete''' removes the group; the user accounts themselves are unaffected.

== Multitenancy / Resource Group Management ==

[[File:security_multitenancy.png|thumb|right|800px|Multitenancy tab.]]

Resource Groups are multi-tenant containers that group users together with resources -- [[Storage Volumes]], [[Network Shares]] -- and with provisioning quotas for self-service provisioning from Storage Pools.

{{Navigation|Multitenancy ''(main tab)''}}

The '''Resource Group''' toolbar group provides '''Add/Remove Users''', '''Add/Remove Tenants''', '''Add/Remove Service Configs''', and '''Add Network Association''' / '''Remove Network Association''' for binding a group to specific networks. The '''Provisioning Quota''' group provides '''Create''', '''Modify''', and '''Delete''' for quotas, plus '''Add/Remove Volumes''' and '''Add/Remove Shares''' to place resources into a group.

Users assigned to a Resource Group should hold a role whose permissions are scoped to '''Resource Group''' rather than '''Global/System''', so that their view of the grid is limited to the resources in their group. The '''Object Tenant Admin''' role is the shipped starting point for object storage tenants; for file and block multi-tenancy, create a role with the permissions you want at '''Resource Group''' scope -- see '''[[#Role Permissions - Operation Scope|Operation Scope]]'''.

Further information: [[Create_Resource_Group|Create a Resource Group]].
== System Setup Security Checks ==

The steps in this section are the minimum hardening pass for a newly deployed QuantaStor system. All of them should be completed before the system carries production data.

# Change the '''qadmin''' console password from its default.
# Change the '''admin''' management password from its default.
# Apply '''Suggested Defaults''' in the '''[[#Security Settings Management|Security Manager]]''' to raise the password and lockout policy.
# Set '''[[#Web Access Mode|Web Access Mode]]''' to ''HTTP redirects to HTTPS'' or ''HTTP disabled''.
# Replace the shipped self-signed certificate -- see '''[[#Installing Your Own Certificate|Installing Your Own Certificate]]'''.
# Block unused protocols in the '''[[#Firewall Configuration|firewall]]'''.
# Consider enabling '''[[#Multi-factor Authentication|multi-factor authentication]]''' for administrative accounts.

=== Change Passwords ===

QuantaStor ships with two default accounts that must both be changed. They are separate accounts with separate passwords: '''qadmin''' is the console/SSH account, '''admin''' is the management interface account.

==== Change SSH Console Administrator Account 'qadmin' Password ====

One of the most important steps in configuring a new QuantaStor system is changing the '''qadmin''' console password from its default of '''qadmin''' on each Storage System.

Log in at the console as '''qadmin''', or connect over '''SSH''' as '''qadmin''', then run:

<pre style="font-size: smaller">
passwd
</pre>

Choose a strong password containing upper and lower case letters, numbers, and symbols. Repeat this on every Storage System in the grid -- this is a local console account, so changing it on one system does not change it on the others.

Note that this password is independent of the grid password policy configured in the Security Manager, which governs '''management''' users only.

==== Change Management Administrator Account 'admin' Password ====

[[File:security_set_password.png|thumb|right|377px|Set Password dialog.]]

Log in to the web management interface as '''admin''' and change the default password, which is '''password'''.

{{Navigation|Security → Management Users → ''select the'' admin ''user'' → User → Set Password ''(toolbar)''}}

The new password must satisfy the grid password policy. Use at least 10 characters with upper and lower case letters and numbers -- or raise the policy first with '''Suggested Defaults''' so the requirement is enforced for every account rather than relying on convention.

Unlike '''qadmin''', this is a grid-wide management account: changing it once changes it for the whole Storage Grid.

== Firewall Configuration ==

[[File:security_firewall.png|thumb|right|616px|Storage System Modify, Firewall tab.]]

QuantaStor has an integrated firewall management system that controls protocol access both at the system level and per network port. For high-security environments it is recommended to block every protocol that will not be used.

'''Navigation (system level):''' Storage Management --> ''select a Storage System'' --> Modify ''(toolbar)'' --> Firewall ''(tab)''

'''Navigation (per port):''' Storage Management --> Network Ports --> ''select a port'' --> Modify Network Port ''(toolbar or right-click)'' --> Firewall ''(tab)''

The Firewall tab lists each service with a description and an '''Allow''' checkbox. The services managed are:

* '''QS Web Management''' -- web management interface access
* '''QS REST API''' -- REST API access to management functions
* '''iSCSI Target''' -- iSCSI protocol access to Storage Volumes
* '''NVMeoF Target''' -- NVMe over Fabrics access
* '''SMB''' -- SMB/CIFS file access
* '''NFS''' and '''NFS Ganesha''' -- NFS file access, scale-up and scale-out respectively
* '''Ceph''' -- scale-out cluster communication
* '''Grafana''' -- Grafana monitoring and statistics
* '''Prometheus''' -- Prometheus monitoring and alerting
* '''Chronograf''' -- Chronograf monitoring

Clear the '''Allow''' box for any service you do not use. A common hardening pass on a file-only deployment, for example, is to leave SMB and NFS enabled and clear iSCSI Target, NVMeoF Target, and Ceph.

Be careful not to block the protocol you are managing the system with: clearing '''QS Web Management''' on the port you are connected through will cut off your own session. Note also that '''[[#Web Access Mode|Web Access Mode]]''' set to ''HTTP disabled'' installs its own rule dropping port 80, independently of these checkboxes.

Use '''Apply''' to commit changes without closing the dialog.
== SSL/TLS Certificate & Web Access Security ==

QuantaStor serves the web management interface, the REST API, and the internal grid communication channels over TLS. The web management interface is served by '''nginx''' and the TLS settings, ciphers, and certificates are all managed by QuantaStor.

'''Note for administrators upgrading from QuantaStor v4:''' older releases served the web interface from Apache Tomcat and required generating a Java keystore with {{Code|1=keytool}}. That is no longer the case. There is no keystore, no {{Code|1=server.xml}}, and no tomcat service on QuantaStor v5 and newer -- use the procedures below instead.

=== Web Access Mode ===

The single most important web security setting is the '''Web Access Mode''', which controls whether plain HTTP is served at all.

{{Navigation|Security → Management Users → User → Security Manager ''(toolbar)'' → Advanced Settings}}

The three modes are:

* '''HTTP enabled (INSECURE)''' -- port 80 serves the interface over plain, unencrypted HTTP. This is the factory default so that a newly-imaged appliance is reachable before certificates are in place; it is '''not''' appropriate for production.
* '''HTTP redirects to HTTPS (recommended)''' -- port 80 answers with a 301 redirect to HTTPS. Nothing sensitive traverses the network in the clear, but a user who types the bare hostname still lands on the interface.
* '''HTTP disabled''' -- port 80 is dropped at the firewall entirely. Use this in high-security environments where an open port 80, even one that only redirects, is not acceptable.

Changing this setting switches the active nginx site configuration and, for '''HTTP disabled''', also installs a firewall rule that drops port 80. The change applies immediately -- no reboot is required.

The Web Access Mode affects '''port 80 only'''. The HTTPS listener on port 443 uses the same TLS versions, cipher list, and certificate in every mode, so switching modes does not change the encryption offered to HTTPS clients -- it only determines whether an unencrypted alternative is reachable. Setting the mode to '''HTTP redirects to HTTPS''' should nonetheless be treated as a required hardening step on every production deployment.

Changing this setting prompts a confirmation warning that the change may log users out of the interface and cause passwords to expire; the mode change itself takes effect as soon as you confirm.

=== Supported TLS Versions and Ciphers ===

QuantaStor's nginx configuration accepts '''TLS 1.2 and TLS 1.3''' only, in all web access modes, with server cipher preference enabled and the cipher list restricted to modern AEAD suites: ''(Note: due to the frequency of security updates this may be out of date and system configuration files should be referenced.)''

<pre style="font-size: smaller">
ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:
ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256
</pre>

SSLv3, TLS 1.0, and TLS 1.1 are not accepted. ''(Note: due to the frequency of security updates this may be out of date and system configuration files should be referenced.)'' The interface also sends an HSTS header ({{Code|1=Strict-Transport-Security}}) with a one year max-age.

The shipped defaults live in this file, which is replaced on upgrade and should '''not''' be edited in place:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/nginx_quantastor_ssl_default.conf
</pre>

To customize the TLS settings or point nginx at your own certificate, use the {{Code|1=qs-util}} helper to copy the defaults to a user-editable location that upgrades will not overwrite:

<pre style="font-size: smaller">
qs-util wuicustomcerts
</pre>

This creates the following file, which you then edit:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf
</pre>

Cipher settings for the QuantaStor grid communication channels (separate from the web interface) are controlled by:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/qsciphers
</pre>

That shipped file is replaced on upgrade, so it should not be edited in place. To customize the grid communication ciphers, place your own copy at the override location below. The override does not exist by default -- create it only when you intend to depart from the shipped cipher list, and QuantaStor will use it in preference to the shipped file and leave it untouched across upgrades:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/qsciphers
</pre>

=== Default Certificate ===

QuantaStor ships with a common self-signed certificate that is pre-generated and included with all deployments. Because it is self-signed and shared across all deployments, browsers will warn on first connection, and it provides no identity assurance. Replacing it is recommended for any deployment reachable beyond a trusted management network.

The certificate and key used by the web interface and REST service are here:

<pre style="font-size: smaller">
/var/opt/osnexus/quantastor/ssl/qsrestsrv.pem
</pre>

Grid communication uses a separate pair:

<pre style="font-size: smaller">
/opt/osnexus/common/lib/qsserver.pem
/opt/osnexus/common/lib/qsclient.pem
</pre>

All of these are discovered and monitored automatically -- see '''[[#Certificate Management|Certificate Management]]''' below, which is the recommended way to review and replace them.

=== Installing a Custom Certificate ===

The '''recommended''' way to install your own certificate is through '''[[#Certificate Management|Certificate Management]]''' -- add the certificate as a template once, then apply it to the '''NGINX''' use case on each Storage System. That keeps the certificate inventory, expiry monitoring, and alerting accurate, and avoids editing nginx configuration by hand. See '''[[#Installing Your Own Certificate|Installing Your Own Certificate]]'''.

Use the manual procedure below only when you need to change nginx TLS directives themselves (for example to further restrict the cipher list), since those are not expressible as a certificate template:

* Run {{Code|1=qs-util wuicustomcerts}} to copy the shipped defaults to an editable file that upgrades will not overwrite.
* Edit {{Code|1=/var/opt/osnexus/quantastor/ssl/nginx_quantastor_ssl_custom.conf}}.
* Reload nginx to apply:

<pre style="font-size: smaller">
systemctl reload nginx
</pre>

* Verify the negotiated protocol and cipher from a client:

<pre style="font-size: smaller">
openssl s_client -connect <system-ip>:443 </dev/null 2>/dev/null \
| grep -E 'Protocol|Cipher is'
</pre>

Repeat on each Storage System in the grid, or use the Certificate Management section to confirm all systems at once.

'''Note:''' if you are using Firefox and have previously accepted the old self-signed certificate, clear the cached certificate exception for the host or Firefox will continue to present the stale certificate warning.
=== [[Custom SSL_TLS Security|Custom SSL Certificates and TLS Security]] ===
* Generating and installing custom SSL certificates, and applying custom TLS security settings. For most deployments the '''[[#Certificate Management|Certificate Management]]''' section above is the better route, since it keeps the certificate inventory and expiry alerting accurate.

=== [[Custom SSH Security|Custom SSH Ciphers and Key Exchange Algorithms]] ===
* Customizing the SSH service to enforce strong ciphers and key exchange algorithms for SSH communication.
== Certificate Management ==

[[File:security_certificates.png|thumb|right|800px|Certificates section showing every certificate on every Storage System in the grid.]]

QuantaStor discovers, inventories, and monitors every TLS certificate in use across the Storage Grid, so administrators can see at a glance what is installed, what it is used for, and when it expires.

{{Navigation|Security → Certificates}}

The Certificates section lists certificates grouped by Storage System. For each certificate the grid shows its file path, '''State''', '''Use Case''', description, certificate modulus MD5, serial number, and the start and end of its validity period. Because the view spans the whole grid, a single screen confirms that every system is using the certificate you expect.

=== Certificate Use Cases ===

Each certificate is tagged with the service that consumes it:

* '''NGINX''' -- the certificate served to browsers for the web management interface.
* '''Rest Service''' -- the certificate presented by the QuantaStor REST API service.
* '''QuantaStor Service [Grid Communication]''' -- the server-side certificate for inter-node grid communication.
* '''Client [Grid Communication]''' -- the client-side certificate a node presents to its peers.
* '''HAProxy''' -- the certificate used by the integrated load balancer, when configured.
* '''Object Gateway''' -- the certificate used by the Ceph S3/Object Gateway. Two use cases are available, for a first and second gateway instance ({{Code|1=cephrgw-1}} and {{Code|1=cephrgw-2}} on the CLI).

Note that the same PEM file may appear more than once with different use cases when one certificate serves several roles -- for example {{Code|1=qsrestsrv.pem}} is used for both '''NGINX''' and '''Rest Service'''.

=== Certificate Expiration Alerts ===

QuantaStor monitors validity dates and raises alerts as a certificate approaches expiry, so a certificate never lapses unnoticed. Alerts are raised at '''90, 60, 30, 7, and 2 days''' before expiry, and again once the certificate has actually expired.

The longer-lead warnings are only raised for certificates with a correspondingly long lifetime -- the 90 day warning applies to certificates valid for more than 18 months, the 60 day warning to those valid for more than a year, and the 30 day warning to those valid for more than 90 days. This prevents short-lived certificates from generating alerts the moment they are installed. The 7 day, 2 day, and expired alerts always apply.

Alerts are delivered through the standard QuantaStor alerting system, so they reach whatever email and SNMP destinations you have configured in the Alert Manager.

=== Certificate Templates ===

A '''certificate template''' holds a certificate (and its private key) that you have obtained from your CA, stored once in the grid so it can be applied to any service on any Storage System. Templates are what make it possible to roll out your own certificate across the grid from the management interface instead of copying PEM files onto each node by hand.

{{Navigation|Security → Certificates → ''Certificate Templates'' ''(tab)''}}

The toolbar provides '''Add Template''', '''Update''', '''Remove Template''', and '''Certificate Template Manager''' for reviewing and maintaining templates.

=== Installing Your Own Certificate ===

This is the recommended way to replace any of QuantaStor's default self-signed certificates, including the one served by the web management interface.

* Obtain a certificate and private key from your CA.
* '''Add a template''' from the certificate. Supply a name, a description, and the PEM file containing the certificate and key block. If the private key is in a separate file, supply it as well.
* '''Apply the template''' to the use case you want it to serve on a given Storage System -- for example apply it to the '''NGINX''' use case to change the certificate browsers see for the web management interface.
* Repeat the apply step for each Storage System, and for each use case the certificate should cover.

'''IMPORTANT -- the certificate must contain a Subject Alternative Name (SAN).''' QuantaStor validates certificates before accepting them as a template and rejects any certificate without a SAN extension, with the error ''"Certificate validation failed. Unable to create certificate template out of invalid certificate."'' A Common Name alone is not sufficient. Include every name and address the systems will be reached by -- the FQDN, the short hostname, and the management IP. When generating a self-signed certificate with {{Code|1=openssl req}}, add the SAN explicitly:

<pre style="font-size: smaller">
openssl req -x509 -newkey rsa:2048 -nodes -days 365 \
-subj "/C=US/ST=<state>/L=<city>/O=<org>/CN=<fqdn>" \
-addext "subjectAltName=DNS:<fqdn>,DNS:<hostname>,IP:<system-ip>" \
-keyout mycert.key -out mycert.crt

cat mycert.crt mycert.key > mycert.pem
</pre>

You can check a certificate against QuantaStor's validation rules before importing it:

<pre style="font-size: smaller">
/opt/osnexus/quantastor/bin/qs_certutil.sh validate --pem-file <path-to-pem>
</pre>

From the CLI the two steps are:

<pre style="font-size: smaller">
qs cert-tmpl-add --name=<template-name> --description=<text> \
--certificate-pem-data=<path-to-pem> \
[--privatekey-pem-data=<path-to-key-pem>]

qs cert-update --storage-system=<system> --cert-use-case=2 \
--cert-tmpl=<template-name>
</pre>

'''Note:''' {{Code|1=--cert-use-case}} currently requires the numeric use case value rather than its name. The values are ''0'' none, ''1'' haproxy, ''2'' nginx, ''3'' cephrgw-1, ''4'' cephrgw-2, ''5'' qsrest, ''6'' qsserver, ''7'' qsclient.

QuantaStor reloads the affected service automatically once the certificate is applied, so the new certificate is served without further action -- nginx for the '''NGINX''' and '''Rest Service''' use cases, HAProxy for '''HAProxy''', and the Object Gateway services for the gateway use cases. nginx is reloaded rather than restarted, so applying a web interface certificate does not disconnect your own management session.

'''Note for QuantaStor releases prior to 6.9:''' the nginx reload was not performed automatically, and the appliance would continue to present the previous certificate until nginx was reloaded by hand:

<pre style="font-size: smaller">
systemctl reload nginx
</pre>

Confirm what is actually being served, including the SAN:

<pre style="font-size: smaller">
openssl s_client -connect <system-ip>:443 </dev/null 2>/dev/null \
| openssl x509 -noout -subject -dates -ext subjectAltName
</pre>

=== Rescanning Certificates ===

If a certificate is replaced outside of QuantaStor -- for example by editing the nginx configuration directly, or by a external renewal process dropping in a new PEM -- use '''Rescan''' to re-read the certificates from disk and refresh the inventory, validity dates, and alert state.

{{Navigation|Security → Certificates → Rescan ''(toolbar)''}}

=== Reviewing Certificates from the CLI ===

The same inventory is available from the QuantaStor CLI, which is convenient for scripted compliance checks:

<pre style="font-size: smaller">
qs cert-list
qs cert-get --cert=<name-or-id>
qs cert-rescan --storage-system=<system>
</pre>

Certificate templates have a matching set of commands:

<pre style="font-size: smaller">
qs cert-tmpl-list
qs cert-tmpl-get --cert=<name-or-id>
qs cert-tmpl-rm --cert=<name-or-id>
</pre>

For TLS version and cipher settings, see '''[[#Supported TLS Versions and Ciphers|Supported TLS Versions and Ciphers]]'''.
== Endpoint Detection & Response (EDR) ==

[[File:security_edr_agents.png|thumb|right|800px|EDR Agents section. Agents are installed per Storage System and report vendor, status, version, and enabled features.]]

Many security standards and cyber-insurance policies require an endpoint detection and response (EDR) agent on every server, including storage appliances. QuantaStor can deploy and manage a vendor EDR agent on each Storage System in the grid directly from the web management interface, so the appliances are covered by the same endpoint security tooling as the rest of the fleet without hand-installing agents over SSH.

{{Navigation|Security → EDR Agents}}

The EDR Agents section lists the installed agents with their '''Name''', '''State''', '''Storage System''', '''Vendor''', '''Status''', '''Version''', and the set of '''Features''' the agent has enabled.

=== Supported EDR Vendors ===

'''Bitdefender GravityZone''' is the currently supported EDR platform, on Ubuntu 22.04, Ubuntu 24.04, RHEL 8, and RHEL 9. Additional vendor modules use the same framework and are being added; contact OSNEXUS at info@osnexus.com if you need a specific EDR platform supported.

Vendor modules are defined on the appliance in:

<pre style="font-size: smaller">
/opt/osnexus/quantastor/conf/qs_endpoint_security.conf
</pre>

=== Installing an EDR Agent ===

[[File:security_edr_install.png|thumb|right|516px|Install EDR Security Agent dialog.]]

Before starting, create an installation package for Linux servers in your Bitdefender GravityZone console and note either the '''package id''' or the full '''setup downloader URL''' the console provides. The feature set of the agent (which protection modules are enabled) is chosen in the GravityZone console when the package is created, and QuantaStor reads that selection back from the installer. Individual protection modules can optionally be overridden from the QuantaStor side at install time -- see the {{Code|1=--feature-flags}} argument in the CLI section below.

{{Navigation|Security → EDR Agents → Install Agent ''(toolbar)''}}

You can also right-click a Storage System to install an agent on it.

In the '''Install EDR Security Agent''' dialog:

* '''EDR Module''' -- select the vendor module, e.g. ''Bitdefender''.
* '''Install Key / URL''' -- paste either the short GravityZone package id (e.g. {{Code|1=aabbccdd}}) or the full {{Code|1=setup_downloader.tar}} URL copied from the GravityZone console. Both forms are accepted, which matters because the vendor's URL format changes from time to time.
* '''Storage Systems''' -- tick each system to install the agent on. The grid shows the service, kernel, and distribution version of each system so you can confirm platform support before installing.

QuantaStor then downloads the installer package from GravityZone onto each selected system, installs the agent, and registers it. Because the appliance must reach the GravityZone service to download the package, ensure outbound access to your GravityZone endpoint is permitted -- see '''[[#Firewall Configuration|Firewall Configuration]]'''.

Note that the registration key is supplied at install time and stored per node; it is not kept in the vendor module configuration file.

=== Monitoring and Removing Agents ===

Once installed, an agent's '''Status''' and '''Version''' are refreshed automatically and shown in the EDR Agents grid, so an agent that has stopped running is visible from the management interface rather than only from the vendor console.

To remove an agent, select it and choose '''Uninstall Agent'''.

{{Navigation|Security → EDR Agents → Uninstall Agent ''(toolbar)''}}

=== EDR Management from the CLI ===

The same operations are available from the QuantaStor CLI:

<pre style="font-size: smaller">
qs edr-agent-list
qs edr-agent-get --edr-agent=<name-or-id>
qs edr-agent-create --system-list=<systems> --module=bitdefender \
--registration-key=<package-id-or-url>
qs edr-agent-delete --edr-agent=<name-or-id>
qs edr-agent-rescan
</pre>

The create command also accepts an optional {{Code|1=--feature-flags}} argument taking a JSON object, to override individual protection modules without changing the GravityZone package:

<pre style="font-size: smaller">
qs edr-agent-create --system-list=qs-node-a --module=bitdefender \
--registration-key=6oOK8y \
--feature-flags='{"FileScan":1,"Firewall":0}'
</pre>

To review the available vendor modules and their supported platforms:

<pre style="font-size: smaller">
qs edr-agent-module-list
qs edr-agent-module-get --module=bitdefender
</pre>
== [[Custom S3 SSl/TLS Certificate|Custom S3 SSL/TLS Certificate]] ==
* Installing a custom certificate for the S3/Object Gateway endpoint. See also the '''Object Gateway''' certificate use cases under '''[[#Certificate Use Cases|Certificate Use Cases]]'''.

== Multi-factor Authentication ==

[[File:security_mfa_manager.png|thumb|right|631px|Multi-Factor Authentication Manager.]]

Multi-factor authentication (MFA) requires a user to present a second factor, such as a device, in addition to their password. QuantaStor supports MFA for management logins.

{{Navigation|Security → Management Users → User → Multi-Factor Auth Manager ''(toolbar)''}}

An MFA '''configuration''' must exist before MFA can be enabled on any account. The manager lists the existing configurations by '''Name''' and '''Provider''' and provides '''Create...''', '''Modify...''', '''Delete...''', and '''Assign/Unassign...''' for attaching a configuration to user accounts.

The supported providers are:

* '''Cisco Duo''' -- see [[Duo Multi-Factor Authentication|Cisco Duo Multi-Factor Authentication]] for the full setup walkthrough
* '''OKTA'''

Creating a configuration takes a '''Provider''', a '''Name''', an optional '''Description''', the '''API Host''' for your tenant, and the '''Integration Key''' and '''Secret Key''' issued by the provider. Obtain those values from your Duo or Okta administration console.

Once a configuration exists, enable MFA per account with '''Enable Multi-Factor Auth''' and '''Multi-Factor Auth Config''' on the Add User or Modify User dialog. The '''Force (required when in use)''' option in the manager makes the second factor mandatory rather than optional.

Contact OSNEXUS at info@osnexus.com for guidance on additional MFA options.

== Security Updates ==

QuantaStor supports automatic security updates through the '''[[Upgrade Manager]]''' in the web management interface.

{{Navigation|Storage Management → Upgrade Manager ''(toolbar)''}}

Applying security updates through the Upgrade Manager is the supported path -- it applies the updates OSNEXUS has qualified against the running QuantaStor release, in the correct order, across the systems you select. Installing distribution packages directly with {{Code|1=apt}} is not recommended, as it can introduce package versions that have not been qualified against the release.

== Encrypting NFS/SMB/iSCSI via IPsec ==

Protocols such as NFSv3 do not encrypt data on the wire. Where the storage network is not itself trusted, set up an encrypted tunnel between the client and the QuantaStor system so that protocol traffic is protected in transit.

More information on configuring IPsec on QuantaStor systems is available [[IPSec|here]].

Note that IPsec protects data '''in transit'''. For data '''at rest''', QuantaStor provides [[Storage Pools|Storage Pool]] encryption, which is configured when the pool is created and is covered separately in the administrator guide.

== Related pages ==

* [[Send System Log Report]] -- collecting and sending a scrubbed log bundle to support
* [[Duo Multi-Factor Authentication]] -- setting up the Cisco Duo MFA provider
* [[Custom SSH Security]] -- hardening the SSH service and managing key access
* [[Custom S3 SSl/TLS Certificate|Custom S3 SSL/TLS Certificate]] -- certificates for the S3 gateway
* [[IPSec]] -- encrypting protocol traffic in transit between client and appliance
* [[Storage Pools]] -- pool encryption, which protects data at rest
* [[Upgrade Manager]] -- applying security patches and QuantaStor updates
* [[Call-home / Alerting|Alert Manager]] -- alert delivery, including certificate expiry alerts
* [[Storage System]] -- system-level configuration and the Modify dialog

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

MediaWiki:Common.css

2026-09-02T23:14:47Z

Umbe: Use the sans-serif body font for h1/h2 instead of the Vector legacy serif stack, and darken the pre block background one step off almost-white

/* CSS placed here will be applied to all skins */

ul, p {
margin-left: 15px;
}
p {
padding-left: 10px;
}

h2 {
margin-top: 15px;
margin-bottom: 15px;
}

img {
padding-top: 15px;
padding-bottom: 15px;
}

.toc {
margin-bottom:15px;
}

#ca-talk {
display: none !important;
}

/* --- Documentation conventions; see Template:Navigation and Template:Code --- */

/* Vector legacy sets h1/h2 in a serif stack ('Linux Libertine','Georgia',
'Times'), which reads as Times New Roman and clashes with the sans-serif
body text. h3 and below are already sans-serif, so only h1/h2 need this. */
.mw-body h1,
.mw-body-content h1,
.mw-body-content h2,
.mw-body .mw-heading1,
.mw-body-content .mw-heading1,
.mw-body-content .mw-heading2 {
font-family: inherit;
}

/* pre blocks default to #f8f9fa, which is almost white and barely separates
from the page. One step darker on the same Wikimedia grey ramp, with a
slightly stronger border so the block stays defined. Survives the DarkMode
extension, which applies filter: invert(1) hue-rotate(180deg) -- lightness
flips, hue is preserved. Inline code is styled by Template:Code instead. */
pre,
.mw-code {
background-color: #eaecf0;
border-color: #c8ccd1;
}