lbcli get qos-policy (2.3.16 and above)

Gets qos-policy information.

Bash
    
xxxxxxxxxx
 
lbcli get qos-policy
Copy

Gets qos-policy information.

Bash
    
xxxxxxxxxx
 
lbcli get qos-policy [flags]
Copy

Examples:

Bash
    
xxxxxxxxxx
 
# Get information of QoS policy by UUID:lbcli -J $JWT get qos-policy --uuid=929eaf28-8a13-4b3e-a3c8-723227634f2b # Get information of QoS policy by name in json format:lbcli -J $JWT get get qos-policy --name=gold-policy -o json
Copy

Flag	Short	Type	Description
--help	-h	bool	Help for qos-policy.
--name		string	Policy name. Either UUID or name must be specified, but not both.
--project-name		string	Project name.
--uuid		string	Policy UUID. Either UUID or name must be specified, but not both.

This command returns the following fields for each policy. The default output format is human-readable. The human-readable output only shows some of these fields. The json/yaml output format is also supported and includes additional fields.

Field	Type	Description
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. 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;` `}`
Project 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”.

Last updated on

Was this page helpful?