lbcli list-qos policies (2.3.16 and above)

--help

-h

bool

Help for qos-policies.

--name

string

Policy name.

--project-name

string

Project name. This is relevant only for polices that are available for this project (global, or projects specified in scope).

--uuid

string

Policy UUID.

Name

String

QoS policy name.

Description

String

QoS policy description.

State

String

Policy state:

• Creating = 1

• Active = 2

• Updating = 3

• Deprecated = 4. This is a QoS policy that a user requested to delete. However, the policy still has some volumes associated with it, so it cannot be deleted, but is now deprecated and not available for new actions. Policy will be deleted by cluster once volumes are deleted or updated to use a different policy.

• Failed = 5. Failed to create a new QoS policy.

QoS Rate Limit Policy

Struct

The defined QOS parameters of the policy.

QoS Rate Limit Policy is a structure that contains visibility, scope, and an inner structure - as shown below (each of these are defined in create qos-policy). It will be either limitIOPS, limitBW, or limitIOPSPerGB.

message limitIOPS {

uint32 writeIOPSLimit = 1;

uint32 readIOPSLimit = 2;

}

message limitBW{

uint32 writeBWLimit = 1;

uint32 readBWLimit = 2;

}

message limitIOPSPerGB {

uint32 writeIOPSPerGBLimit = 1;

uint32 readIOPSPerGBLimit = 2;

}

Projects Names Scope

String

A list of project names that can use this policy.

Policy Visibility

Enum

This has three options:

• Unavailable - which will be returned upon get/list QoS policies to non-cluster admin callers, or to all callers of "list" QoS policies if the result is filtered out by project name.

• Global - indicates a global policy. A global policy is available to all volumes and projects in a cluster.

• Scoped - indicates a private (scoped) policy. This is available only to projects specified in “Project Names Scope”.