`orca aggregate`¶

Manage Nova host aggregates (compute admin).

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

orca aggregate¶

Manage host aggregates (Nova).

Usage:

orca aggregate [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

add: OSC parity verbs (aggregate add host …).
add-host: [deprecated, use 'aggregate host add' instead]
cache: OSC parity verbs (aggregate cache image …).
cache-image: [deprecated, use 'aggregate image cache' instead]
create: Create a host aggregate.
delete: Delete a host aggregate.
host: Manage hosts inside an aggregate.
image: Manage image caching on aggregates.
list: List host aggregates.
remove: OSC parity verbs (aggregate remove host …).
remove-host: [deprecated, use 'aggregate host remove' instead]
set: Update an aggregate's name, AZ, or metadata.
show: Show aggregate details.
unset: Unset metadata properties on an aggregate.

orca aggregate add¶

OSC parity verbs (aggregate add host …).

Usage:

orca aggregate add [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

add: Add a host to an aggregate.

orca aggregate add add¶

Add a host to an aggregate.

Usage:

orca aggregate add add [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate add-host¶

Add a host to an aggregate.

Usage:

orca aggregate add-host [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate cache¶

OSC parity verbs (aggregate cache image …).

Usage:

orca aggregate cache [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

cache: Request that images be cached on hosts in an aggregate.

orca aggregate cache cache¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate image cache orca aggregate image cache

Usage:

orca aggregate cache cache [OPTIONS] AGGREGATE_ID IMAGE_IDS...

Options:

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

orca aggregate cache-image¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate image cache orca aggregate image cache

Usage:

orca aggregate cache-image [OPTIONS] AGGREGATE_ID IMAGE_IDS...

Options:

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

orca aggregate create¶

Create a host aggregate.

Usage:

orca aggregate create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--zone`	text	Availability zone name.	None
`--help`	boolean	Show this message and exit.	`False`

orca aggregate delete¶

Delete a host aggregate.

Usage:

orca aggregate delete [OPTIONS] AGGREGATE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

orca aggregate host¶

Manage hosts inside an aggregate.

Usage:

orca aggregate host [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

add: Add a host to an aggregate.
remove: Remove a host from an aggregate.

orca aggregate host add¶

Add a host to an aggregate.

Usage:

orca aggregate host add [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate host remove¶

Remove a host from an aggregate.

Usage:

orca aggregate host remove [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate image¶

Manage image caching on aggregates.

Usage:

orca aggregate image [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

cache: Request that images be cached on hosts in an aggregate.

orca aggregate image cache¶

Request that images be cached on hosts in an aggregate.

Examples: orca aggregate image cache orca aggregate image cache

Usage:

orca aggregate image cache [OPTIONS] AGGREGATE_ID IMAGE_IDS...

Options:

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

orca aggregate list¶

List host aggregates.

Usage:

orca aggregate 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 aggregate remove¶

OSC parity verbs (aggregate remove host …).

Usage:

orca aggregate remove [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

remove: Remove a host from an aggregate.

orca aggregate remove remove¶

Remove a host from an aggregate.

Usage:

orca aggregate remove remove [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate remove-host¶

Remove a host from an aggregate.

Usage:

orca aggregate remove-host [OPTIONS] AGGREGATE_ID HOST

Options:

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

orca aggregate set¶

Update an aggregate's name, AZ, or metadata.

Usage:

orca aggregate set [OPTIONS] AGGREGATE_ID

Options:

Name	Type	Description	Default
`--name`	text	New name.	None
`--zone`	text	New availability zone.	None
`--property`	text	Metadata key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca aggregate show¶

Show aggregate details.

Usage:

orca aggregate show [OPTIONS] AGGREGATE_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 aggregate unset¶

Unset metadata properties on an aggregate.

Usage:

orca aggregate unset [OPTIONS] AGGREGATE_ID

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`