`orca orchestration`¶

Heat: build info, service list, template versions/functions, resource-type.

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

orca orchestration¶

Heat orchestration — OSC parity top-level.

Usage:

orca orchestration [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

build: Heat build info.
resource-type: Inspect Heat resource types (compound noun).
service: Heat engine services.
template: Heat template inspection (OSC parity).

orca orchestration build¶

Heat build info.

Usage:

orca orchestration build [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

info: Show Heat engine + API build info (GET /v1/build_info).

orca orchestration build info¶

Show Heat engine + API build info (GET /v1/build_info).

Usage:

orca orchestration build info [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 orchestration resource-type¶

Inspect Heat resource types (compound noun).

Usage:

orca orchestration resource-type [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List available Heat resource types.
show: Show the schema for a Heat resource type.

orca orchestration resource-type list¶

List available Heat resource types.

Usage:

orca orchestration resource-type list [OPTIONS]

Options:

Name	Type	Description	Default
`--filter`	text	Filter resource types by name substring.	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 orchestration resource-type show¶

Show the schema for a Heat resource type.

Usage:

orca orchestration resource-type show [OPTIONS] RESOURCE_TYPE

Options:

Name	Type	Description	Default
`--template-type`	choice (`cfn` \| `hot`)	Template format for the resource schema.	`hot`
`--help`	boolean	Show this message and exit.	`False`

orca orchestration service¶

Heat engine services.

Usage:

orca orchestration service [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List heat-engine workers (GET /v1/services).

orca orchestration service list¶

List heat-engine workers (GET /v1/services).

Usage:

orca orchestration service 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 orchestration template¶

Heat template inspection (OSC parity).

Usage:

orca orchestration template [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

function: Heat template functions per version.
validate: Validate a Heat template.
version: Heat template versions.

orca orchestration template function¶

Heat template functions per version.

Usage:

orca orchestration template function [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List the intrinsic functions available in a template version.

orca orchestration template function list¶

List the intrinsic functions available in a template version.

Usage:

orca orchestration template function list [OPTIONS] VERSION

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 orchestration template validate¶

Validate a Heat template.

Examples: orca stack template-validate -t template.yaml orca stack template-validate -t template.yaml -e env.yaml

Usage:

orca orchestration template validate [OPTIONS]

Options:

Name	Type	Description	Default
`--template`, `-t`	text	Template file path or URL.	`Sentinel.UNSET`
`--environment`, `-e`	text	Environment file path.	None
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca orchestration template version¶

Heat template versions.

Usage:

orca orchestration template version [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List Heat template versions accepted by the engine.

orca orchestration template version list¶

List Heat template versions accepted by the engine.

Usage:

orca orchestration template version 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`