qospolicy create

  • Updated on Jan 30, 2026
  • Published on Jan 28, 2026
  • 3 minute(s) read
Prev Next

This command creates a QoS policy, which can be applied to a view.

Usage

qospolicy create --name
                [--mode STATIC|USED_CAPACITY|PROVISIONED_CAPACITY]
                [--limit-by BW_IOPS|BW|IOPS]
                [--static-limits STATIC_LIMITS]
                [--capacity-limits CAPACITY_LIMITS]
                [--policy-type VIEW|USER]
                [--tenant-id ID]
                [--is-default]

Required Parameters

--name

Specifies a name for the policy.

Options

--mode STATIC|USED_CAPACITY| PROVISIONED_CAPACITY

Sets the mode of provisioning quality of service per view:

  • STATIC. Lets you set minimum and maximum static limits.

  • USED_CAPACITY. Lets you set used capacity-based limits and maximum static limits.

  • PROVISIONED_CAPACITY. Lets you set provisioned capacity-based limits and maximum static limits.

For a detailed explanation of QoS limits and provisioning modes, see QoS Overview.Quality of Service Overview

--limit-by BW_IOPS|BW|IOPS

Sets performance characteristic(s) by which to limit service:

  • BW_IOPS. Lets you set limits on both bandwidth (BW) and I/O per second (IOPS).

  • BW. Lets you set limits on bandwidth only.  

    Note

    When this option is specified, the options for setting IOPS limits are not used.

  • IOPS. Lets you set limits on IOPS only.

    Note

    When this option is specified, the options for setting bandwidth limits are not used.

--static-limits STATIC_LIMITS

Enables and sets QoS limits per view.

Tip

Minimum limits can only be set when --mode STATIC is specified.

Specify STATIC_LIMITS as a comma-separated list of key=value pairs. The following keys can be used, depending on the --limit-by setting:

  • min_reads_bw_mbps. Minimum read bandwidth to provision, in MB/s.

  • max_reads_bw_mbps. Maximum read bandwidth to provision, in MB/s.

  • min_reads_iops. Minimum read IOPS to provision,

  • max_reads_iops. Maximum read IOPS to provision.

  • min_writes_bw_mbps. Minimum write bandwidth to provision, in MB/s.

  • max_writes_bw_mbps. Maximum write bandwidth to provision, in MB/s.

  • min_writes_iops. Minimum write IOPS to provision.

  • max_writes_iops. Maximum write IOPS to provision.

  • burst_reads_bw_mb. Burst bandwidth for read operations, in MB/s.

  • burst_reads_iops. Burst IOPS for read operations.

  • burst_reads_loan_mb. Maximum credit bandwidth for read operations, in MB/s.

  • burst_reads_loan_iops. Maximum credit IOPS for read operations.

  • burst_writes_bw_mb. Burst bandwidth for write operations, in MB/s.

  • burst_writes_iops. Burst IOPS for write operations.

  • burst_writes_loan_mb. Maximum credit bandwidth for write operations, in MB/s.

  • burst_writes_loan_iops.  Maximum credit IOPS for write operations.

For example:

max_reads_bw_mbps=1024,max_writes_iops=2048

--capacity-limits CAPACITY_LIMITS

Enables and sets  QoS limits per unit of used or provisioned logical capacity, depending on the provisioning mode (see also --mode).

Specify CAPACITY_LIMITS as a comma-separated list of key=value pairs, where the following keys can be used, depending on the --limit-by setting:

  • max_reads_bw_mbps_per_gb_capacity. Maximum read bandwidth to provision per GB of used logical or provisioned logical capacity, depending on the provisioning mode (set by --mode).

  • max_reads_iops_per_gb_capacity.  Maximum read IOPS to provision per GB of used logical or provisioned logical capacity, depending on the provisioning mode (set by --mode).

  • max_writes_bw_mbps_per_gb_capacity. Maximum write bandwidth  to provision per GB of used logical or provisioned logical capacity, depending on the provisioning mode (set by --mode).

  • max_writes_iops_per_gb_capacity. Maximum write IOPS to provision per GB of used logical or provisioned logical capacity,depending on the provisioning mode (set by --mode).

For example:

max_reads_bw_mbps_per_gb_capacity=1024,max_writes_iops_per_gb_capacity=2048

--policy-type VIEW|USER

Determines whether the QoS policy provisions performance for a view (VIEW) or for one or more users (USER). For more information about QoS policy types, see  QoS Policy Types.

--tenant-id ID

If the QoS policy is to be used for one or more users  (--policy-type USER), specify the ID of the tenant whose users can be assigned this QoS policy.  

Tip

To assign users to a user QoS policy, run the qospolicy attach-user command.

--is-default

When specified, the policy is used as the default user QoS policy for the tenant specified in --tenant-id.

Caution

Specifying this option resets the list of users assigned to this policy.

Example

vcli: admin> qospolicy create --name QoSpol1 --mode USED_CAPACITY --capacity-limits max_reads_bw_mbps_per_gb_capacity=1024,max_writes_bw_mbps_per_gb_capacity=2048  --limit-by BW
Related articles
  • qospolicy create
    VAST Cluster > Version 5.1 > VAST Cluster 5.1 CLI Command Reference > qospolicy commands
  • qospolicy create
    VAST Cluster > Version 5.4 > VAST Cluster 5.4 CLI Command Reference > qospolicy commands
  • qospolicy create
    VAST Cluster > Version 5.3 > VAST Cluster 5.3 CLI Command Reference > qospolicy commands