`orca resource`¶

Placement resources: class / provider / usage (OSC parity).

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

orca resource¶

Placement resources (class / provider / usage) — OSC parity.

Usage:

orca resource [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

resource-class: Manage Placement resource classes (compound noun).
resource-provider: Manage Placement resource providers (compound noun).
usage: Inspect Placement usage.

orca resource resource-class¶

Manage Placement resource classes (compound noun).

Usage:

orca resource resource-class [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Create a custom resource class (must start with CUSTOM_).
delete: Delete a custom resource class.
list: List resource classes.
set: Rename a custom resource class (OSC parity).
show: Show a resource class.

orca resource resource-class create¶

Create a custom resource class (must start with CUSTOM_).

Usage:

orca resource resource-class create [OPTIONS] NAME

Options:

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

orca resource resource-class delete¶

Delete a custom resource class.

Usage:

orca resource resource-class delete [OPTIONS] NAME

Options:

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

orca resource resource-class list¶

List resource classes.

Usage:

orca resource resource-class 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 resource resource-class set¶

Rename a custom resource class (OSC parity).

Usage:

orca resource resource-class set [OPTIONS] CURRENT_NAME

Options:

Name	Type	Description	Default
`--name`	text	New resource class name (must start with CUSTOM_).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-class show¶

Show a resource class.

Usage:

orca resource resource-class show [OPTIONS] NAME

Options:

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

orca resource resource-provider¶

Manage Placement resource providers (compound noun).

Usage:

orca resource resource-provider [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

aggregate: Aggregate associations of a resource provider (OSC parity).
aggregate-delete: Remove all aggregate associations from a resource provider.
aggregate-list: List aggregates associated with a resource provider.
aggregate-set: Set (replace) aggregates on a resource provider.
allocation: Allocations against a resource provider (OSC parity).
create: Create a resource provider.
delete: Delete a resource provider.
inventory: Inventories of a resource provider (OSC parity).
inventory-delete: Delete an inventory for a resource provider.
inventory-delete-all: Delete all inventories for a resource provider.
inventory-list: List inventories for a resource provider.
inventory-set: Create or update a single inventory for a resource provider.
inventory-show: Show a single inventory for a resource provider.
list: List resource providers.
set: Update a resource provider.
show: Show a resource provider.
trait: Traits associated with a resource provider (OSC parity).
trait-delete: Remove all traits from a resource provider.
trait-list: List traits associated with a resource provider.
trait-set: Set (replace) traits on a resource provider.
usage: Per-resource-provider usage (OSC parity).

orca resource resource-provider aggregate¶

Aggregate associations of a resource provider (OSC parity).

Usage:

orca resource resource-provider aggregate [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

aggregate-delete: Remove all aggregate associations from a resource provider.
aggregate-list: List aggregates associated with a resource provider.
aggregate-set: Set (replace) aggregates on a resource provider.

orca resource resource-provider aggregate aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca resource resource-provider aggregate aggregate-delete 
    [OPTIONS] UUID

Options:

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

orca resource resource-provider aggregate aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca resource resource-provider aggregate aggregate-list [OPTIONS] UUID

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 resource resource-provider aggregate aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca resource resource-provider aggregate aggregate-set [OPTIONS] UUID
                                                        AGGREGATES...

Options:

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

orca resource resource-provider aggregate-delete¶

Remove all aggregate associations from a resource provider.

Usage:

orca resource resource-provider aggregate-delete [OPTIONS] UUID

Options:

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

orca resource resource-provider aggregate-list¶

List aggregates associated with a resource provider.

Usage:

orca resource resource-provider aggregate-list [OPTIONS] UUID

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 resource resource-provider aggregate-set¶

Set (replace) aggregates on a resource provider.

Usage:

orca resource resource-provider aggregate-set [OPTIONS] UUID AGGREGATES...

Options:

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

orca resource resource-provider allocation¶

Allocations against a resource provider (OSC parity).

Usage:

orca resource resource-provider allocation [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

delete: Delete all allocations for a consumer.
set: Set (replace) allocations for a consumer against a single resource provider.
show: Show allocations for a consumer.
unset: Drop a single resource-class allocation for a consumer.

orca resource resource-provider allocation delete¶

Delete all allocations for a consumer.

Usage:

orca resource resource-provider allocation delete [OPTIONS] CONSUMER_UUID

Options:

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

orca resource resource-provider allocation set¶

Set (replace) allocations for a consumer against a single resource provider.

Usage:

orca resource resource-provider allocation set [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-provider`	text	Resource provider UUID.	`Sentinel.UNSET`
`--resource`	text	Resource class and amount, e.g. VCPU=4. Repeatable.	`Sentinel.UNSET`
`--project-id`	text	Consumer project UUID.	`Sentinel.UNSET`
`--user-id`	text	Consumer user UUID.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider allocation show¶

Show allocations for a consumer.

Usage:

orca resource resource-provider allocation show [OPTIONS] CONSUMER_UUID

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 resource resource-provider allocation unset¶

Drop a single resource-class allocation for a consumer.

Reads the consumer's full allocations, strips rc_name from each provider entry (optionally only on --rp-uuid), then PUTs the remaining allocations back. Empty entries are dropped.

Usage:

orca resource resource-provider allocation unset [OPTIONS] CONSUMER_UUID

Options:

Name	Type	Description	Default
`--resource-class`	text	Resource class to clear (e.g. VCPU, MEMORY_MB).	`Sentinel.UNSET`
`--rp-uuid`	text	Optional: limit to allocations on this resource provider (default: all providers).	None
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider create¶

Create a resource provider.

Usage:

orca resource resource-provider create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--uuid`	text	Explicit UUID for the new provider.	None
`--parent-uuid`	text	UUID of the parent provider.	None
`--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 resource resource-provider delete¶

Delete a resource provider.

Usage:

orca resource resource-provider delete [OPTIONS] UUID

Options:

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

orca resource resource-provider inventory¶

Inventories of a resource provider (OSC parity).

Usage:

orca resource resource-provider inventory [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

class: Per-resource-class inventory verbs (OSC parity).
inventory-delete: Delete an inventory for a resource provider.
inventory-delete-all: Delete all inventories for a resource provider.
inventory-list: List inventories for a resource provider.
inventory-set: Create or update a single inventory for a resource provider.
inventory-show: Show a single inventory for a resource provider.

orca resource resource-provider inventory class¶

Per-resource-class inventory verbs (OSC parity).

Usage:

orca resource resource-provider inventory class [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

inventory-set: Create or update a single inventory for a resource provider.

# orca resource resource-provider inventory class inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory class inventory-set 
    [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider inventory inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca resource resource-provider inventory inventory-delete 
    [OPTIONS] UUID RESOURCE_CLASS

Options:

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

orca resource resource-provider inventory inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca resource resource-provider inventory inventory-delete-all 
    [OPTIONS] UUID

Options:

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

orca resource resource-provider inventory inventory-list¶

List inventories for a resource provider.

Usage:

orca resource resource-provider inventory inventory-list [OPTIONS] UUID

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 resource resource-provider inventory inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory inventory-set [OPTIONS] UUID
                                                        RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider inventory inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory inventory-show [OPTIONS] UUID
                                                         RESOURCE_CLASS

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 resource resource-provider inventory-delete¶

Delete an inventory for a resource provider.

Usage:

orca resource resource-provider inventory-delete [OPTIONS] UUID RESOURCE_CLASS

Options:

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

orca resource resource-provider inventory-delete-all¶

Delete all inventories for a resource provider.

Usage:

orca resource resource-provider inventory-delete-all [OPTIONS] UUID

Options:

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

orca resource resource-provider inventory-list¶

List inventories for a resource provider.

Usage:

orca resource resource-provider inventory-list [OPTIONS] UUID

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 resource resource-provider inventory-set¶

Create or update a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory-set [OPTIONS] UUID RESOURCE_CLASS

Options:

Name	Type	Description	Default
`--total`	integer	Total inventory units.	`Sentinel.UNSET`
`--reserved`	integer	N/A	`0`
`--min-unit`	integer	N/A	`1`
`--max-unit`	integer	N/A	None
`--step-size`	integer	N/A	`1`
`--allocation-ratio`	float	N/A	`1.0`
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider inventory-show¶

Show a single inventory for a resource provider.

Usage:

orca resource resource-provider inventory-show [OPTIONS] UUID RESOURCE_CLASS

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 resource resource-provider list¶

List resource providers.

Usage:

orca resource resource-provider list [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Filter by name.	None
`--uuid`	text	Filter by UUID.	None
`--in-tree`	text	Limit to providers in this tree.	None
`--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 resource resource-provider set¶

Update a resource provider.

Usage:

orca resource resource-provider set [OPTIONS] UUID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--parent-uuid`	text	New parent provider UUID.	None
`--help`	boolean	Show this message and exit.	`False`

orca resource resource-provider show¶

Show a resource provider.

Usage:

orca resource resource-provider show [OPTIONS] UUID

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 resource resource-provider trait¶

Traits associated with a resource provider (OSC parity).

Usage:

orca resource resource-provider trait [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

trait-delete: Remove all traits from a resource provider.
trait-list: List traits associated with a resource provider.
trait-set: Set (replace) traits on a resource provider.

orca resource resource-provider trait trait-delete¶

Remove all traits from a resource provider.

Usage:

orca resource resource-provider trait trait-delete [OPTIONS] UUID

Options:

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

orca resource resource-provider trait trait-list¶

List traits associated with a resource provider.

Usage:

orca resource resource-provider trait trait-list [OPTIONS] UUID

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 resource resource-provider trait trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca resource resource-provider trait trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca resource resource-provider trait-delete¶

Remove all traits from a resource provider.

Usage:

orca resource resource-provider trait-delete [OPTIONS] UUID

Options:

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

orca resource resource-provider trait-list¶

List traits associated with a resource provider.

Usage:

orca resource resource-provider trait-list [OPTIONS] UUID

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 resource resource-provider trait-set¶

Set (replace) traits on a resource provider.

Usage:

orca resource resource-provider trait-set [OPTIONS] UUID TRAITS...

Options:

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

orca resource resource-provider usage¶

Per-resource-provider usage (OSC parity).

Usage:

orca resource resource-provider usage [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

usage: Show usages for a resource provider.

orca resource resource-provider usage usage¶

Show usages for a resource provider.

Usage:

orca resource resource-provider usage usage [OPTIONS] UUID

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 resource usage¶

Inspect Placement usage.

Usage:

orca resource usage [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: Show aggregated usages by project/user.
list: Show aggregated usages by project/user.

orca resource usage list¶

Show aggregated usages by project/user.

Usage:

orca resource usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	None
`--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 resource usage list¶

Show aggregated usages by project/user.

Usage:

orca resource usage list [OPTIONS]

Options:

Name	Type	Description	Default
`--project-id`	text	Filter by project UUID.	None
`--user-id`	text	Filter by user UUID.	None
`--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`