Skip to content

orca allocation

Placement allocations (OSC-parity top-level).

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

orca allocation

Placement allocations — OSC parity.

Usage:

orca allocation [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • candidate: Placement allocation candidates.
  • 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 allocation candidate

Placement allocation candidates.

Usage:

orca allocation candidate [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • candidate-list: List allocation candidates for the requested resources.
orca allocation candidate candidate-list

List allocation candidates for the requested resources.

Usage:

orca allocation candidate candidate-list [OPTIONS]

Options:

Name Type Description Default
--resource text Requested resource, e.g. VCPU=4. Repeatable. Sentinel.UNSET
--required text Required trait. Repeatable. Sentinel.UNSET
--forbidden text Forbidden trait. Repeatable. Sentinel.UNSET
--limit integer Max number of candidates. 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 allocation delete

Delete all allocations for a consumer.

Usage:

orca 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 allocation set

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

Usage:

orca 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 allocation show

Show allocations for a consumer.

Usage:

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