`orca qos`¶

Manage Neutron QoS policies and rules.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca qos¶

Manage Neutron QoS policies and rules.

Usage:

orca qos [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

policy: Manage QoS policies.
policy-create: [deprecated, use 'qos policy create' instead]
policy-delete: [deprecated, use 'qos policy delete' instead]
policy-list: [deprecated, use 'qos policy list' instead]
policy-set: [deprecated, use 'qos policy set' instead]
policy-show: [deprecated, use 'qos policy show' instead]
rule: Manage QoS rules attached to a policy.
rule-create: [deprecated, use 'qos rule create' instead]
rule-delete: [deprecated, use 'qos rule delete' instead]
rule-list: [deprecated, use 'qos rule list' instead]
rule-type: Inspect QoS rule types Neutron knows how to enforce (read-only).

orca qos policy¶

Manage QoS policies.

Usage:

orca qos policy [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a QoS policy.
delete: Delete a QoS policy.
list: List QoS policies.
set: Update a QoS policy.
show: Show a QoS policy.

orca qos policy create¶

Create a QoS policy.

Usage:

orca qos policy create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	`Sentinel.UNSET`
`--shared`	boolean	Share with all projects.	`False`
`--default`	boolean	Set as default policy.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy delete¶

Delete a QoS policy.

Usage:

orca qos policy delete [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca qos policy list¶

List QoS policies.

Usage:

orca qos policy list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared policies.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos policy set¶

Update a QoS policy.

Usage:

orca qos policy set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--shared` / `--no-shared`	boolean	Share or un-share.	None
`--default` / `--no-default`	boolean	Set or unset as default.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy show¶

Show a QoS policy.

Usage:

orca qos policy show [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-create¶

Create a QoS policy.

Usage:

orca qos policy-create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Policy name.	`Sentinel.UNSET`
`--shared`	boolean	Share with all projects.	`False`
`--default`	boolean	Set as default policy.	`False`
`--description`	text	Description.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-delete¶

Delete a QoS policy.

Usage:

orca qos policy-delete [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-list¶

List QoS policies.

Usage:

orca qos policy-list [OPTIONS]

Options:

Name	Type	Description	Default
`--shared`	boolean	Show only shared policies.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-set¶

Update a QoS policy.

Usage:

orca qos policy-set [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--description`	text	New description.	None
`--shared` / `--no-shared`	boolean	Share or un-share.	None
`--default` / `--no-default`	boolean	Set or unset as default.	None
`--help`	boolean	Show this message and exit.	`False`

orca qos policy-show¶

Show a QoS policy.

Usage:

orca qos policy-show [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule¶

Manage QoS rules attached to a policy.

Usage:

orca qos rule [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a QoS rule.
delete: Delete a QoS rule.
list: List QoS rules for a policy.
set: Update an existing QoS rule.
show: Show details of a QoS rule.

orca qos rule create¶

Create a QoS rule.

Examples: orca qos rule-create --type bandwidth-limit --max-kbps 1000 orca qos rule-create --type dscp-marking --dscp-mark 14 orca qos rule-create --type minimum-bandwidth --min-kbps 500

Usage:

orca qos rule create [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	Maximum bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	Maximum burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	Traffic direction (bandwidth-limit, minimum-bandwidth).	`egress`
`--dscp-mark`	integer	DSCP mark value 0-56 (dscp-marking).	None
`--min-kbps`	integer	Minimum bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca qos rule delete¶

Delete a QoS rule.

Usage:

orca qos rule delete [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule list¶

List QoS rules for a policy.

Usage:

orca qos rule list [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule set¶

Update an existing QoS rule.

Example: orca qos rule set --type bandwidth-limit --max-kbps 2000

Usage:

orca qos rule set [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	New max bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	New max burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	New traffic direction (bandwidth-limit, minimum-bandwidth).	None
`--dscp-mark`	integer	New DSCP mark value (dscp-marking).	None
`--min-kbps`	integer	New min bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca qos rule show¶

Show details of a QoS rule.

Usage:

orca qos rule show [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-create¶

Create a QoS rule.

Examples: orca qos rule-create --type bandwidth-limit --max-kbps 1000 orca qos rule-create --type dscp-marking --dscp-mark 14 orca qos rule-create --type minimum-bandwidth --min-kbps 500

Usage:

orca qos rule-create [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--max-kbps`	integer	Maximum bandwidth in kbps (bandwidth-limit).	None
`--max-burst-kbps`	integer	Maximum burst bandwidth in kbps (bandwidth-limit).	None
`--direction`	choice (`ingress` \| `egress`)	Traffic direction (bandwidth-limit, minimum-bandwidth).	`egress`
`--dscp-mark`	integer	DSCP mark value 0-56 (dscp-marking).	None
`--min-kbps`	integer	Minimum bandwidth in kbps (minimum-bandwidth).	None
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-delete¶

Delete a QoS rule.

Usage:

orca qos rule-delete [OPTIONS] POLICY_ID RULE_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-list¶

List QoS rules for a policy.

Usage:

orca qos rule-list [OPTIONS] POLICY_ID

Options:

Name	Type	Description	Default
`--type`	choice (`bandwidth-limit` \| `dscp-marking` \| `minimum-bandwidth` \| `minimum-packet-rate`)	Rule type.	`bandwidth-limit`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-type¶

Inspect QoS rule types Neutron knows how to enforce (read-only).

Usage:

orca qos rule-type [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

list: List supported QoS rule types.
show: Show the directions a QoS rule type supports.

orca qos rule-type list¶

List supported QoS rule types.

Usage:

orca qos rule-type list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca qos rule-type show¶

Show the directions a QoS rule type supports.

Usage:

orca qos rule-type show [OPTIONS] RULE_TYPE

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`