qospolicy modify

  • Updated on Feb 2, 2026
  • Published on Jan 27, 2026
  • 4 minute(s) read
Prev Next

This command modifies a QoS policy.

Usage

qospolicy modify --id ID
                [--policy-type VIEW|USER]
                [--is-default]
                [--tenant-id ID]
                [--use-total-limits|--use-separate-limits]
                [--limit-by BW_IOPS|BW|IOPS]
                [--static-total-limits STATIC_TOTAL_LIMITS]
                [--static-limits STATIC_LIMITS]
                [--mode STATIC|USED_CAPACITY|PROVISIONED_CAPACITY]
                [--capacity-total-limits CAPACITY_TOTAL_LIMITS]
                [--capacity-limits CAPACITY_LIMITS]
                [--s3-connections-limit LIMIT]

Required Parameters

--id ID

Specifies which QoS policy to modify.

Options

--policy-type VIEW|USER

Determines whether the QoS policy provisions performance for a view (VIEW) or for one or more users (USER).

--is-default

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

Caution

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

--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.

--use-total-limits

If specified, enables you to set limits that cap the total amount of read, write and metadata operations (see --static-total-limits and --capacity-total-limits).

--use-separate-limits

Disables total QoS limits.

--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-total-limits STATIC_TOTAL_LIMITS

Enables and sets static QoS limits that cap the total amount of read, write and metadata operations.

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_bw_mbps. Minimum read bandwidth to provision, in MB/s.

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

  • min_iops. Minimum read IOPS to provision,

  • max_iops. Maximum read IOPS to provision.

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

  • burst_iops. Burst IOPS for read operations.

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

  • burst_loan_iops. Maximum credit IOPS for read operations.

For example: min_bw_mbps=1024,max_iops=2048

--static-limits STATIC_LIMITS

Enables and sets static QoS limits.

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

--mode STATIC|USED_CAPACITY| PROVISIONED_CAPACITY

Determines how capacity-based limits are set:

  • STATIC. No capacity-based limits are set.

  • USED_CAPACITY. Capacity-based limits are set based on used capacity.

  • PROVISIONED_CAPACITY. Capacity-based limits are set based on provisioned capacity.

--capacity-total-limits CAPACITY_TOTAL_LIMITS

Enables and sets QoS limits per unit of used or provisioned logical capacity, depending on the provisioning mode (see --mode), that cap the total amount of read, write and metadata operations.

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

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

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

For example: max_bw_mbps_per_gb_capacity=1024,max_iops_per_gb_capacity=2048

--capacity-limits CAPACITY_LIMITS

Enables and sets QoS limits per unit of used or provisioned logical capacity, depending on the provisioning mode (see --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

--s3-connections-limit LIMIT

Sets the  maximum allowed number of S3 connections. QoS Overview

By default, no S3 connection limit is set. '0' means unlimited number of S3 connections is allowed.

Example

vcli: admin> qospolicy modify --id 3 --mode STATIC --limit-by BW_IOPS
 --static-limits max_reads_bw_mbps=1024,max_reads_iops=1024,max_writes_iops=2048

Related articles
  • qospolicy modify
    VAST Cluster > Version 5.4 > VAST Cluster 5.4 CLI Command Reference > qospolicy commands
  • qospolicy modify
    VAST Cluster > Version 5.3 > VAST Cluster 5.3 CLI Command Reference > qospolicy commands
  • qospolicy create
    VAST Cluster > Version 5.2 > VAST Cluster 5.2 CLI Command Reference > qospolicy commands