`orca stack`¶

Manage Heat orchestration stacks.

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

orca stack¶

Manage Heat stacks (orchestration).

Usage:

orca stack [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

abandon: Abandon a stack (delete without destroying resources).
adopt: Adopt existing resources into a new stack.
cancel: Cancel an in-progress stack update.
check: Check a stack (verify resource states).
create: Create a stack.
delete: Delete a stack.
diff: Compare a local template with a deployed stack's template.
environment: Inspect a stack's resolved environment.
event: Inspect stack events.
event-list: [deprecated, use 'stack event list' instead]
event-show: [deprecated, use 'stack event show' instead]
export: Export the full serialised state of a stack.
failures: Inspect failed events on a stack.
file: Inspect files referenced by a stack template.
hook: Manage pre-create / pre-update hooks on stack resources.
list: List stacks.
output: Inspect stack outputs.
output-list: [deprecated, use 'stack output list' instead]
output-show: [deprecated, use 'stack output show' instead]
resource: Per-resource actions and inspection on a stack.
resource-list: [deprecated, use 'stack resource list' instead]
resource-show: [deprecated, use 'stack resource show' instead]
resource-type: Inspect Heat resource types (compound noun).
resource-type-list: [deprecated, use 'stack resource-type list' instead]
resource-type-show: [deprecated, use 'stack resource-type show' instead]
resume: Resume a suspended stack.
show: Show stack details.
snapshot: Manage stack snapshots (Heat snapshot/restore).
suspend: Suspend a stack.
template: Inspect or validate Heat templates.
template-show: [deprecated, use 'stack template show' instead]
template-validate: [deprecated, use 'stack template validate' instead]
topology: Show stack resource topology as a tree.
update: Update a stack.

orca stack abandon¶

Abandon a stack (delete without destroying resources).

Exports the stack's resource data, then removes the stack record from Heat without actually deleting the underlying OpenStack resources.

Usage:

orca stack abandon [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--output-file`	text	Save abandoned stack data to a JSON file.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack adopt¶

Adopt existing resources into a new stack.

Usage:

orca stack adopt [OPTIONS] NAME

Options:

Name	Type	Description	Default
`-t`, `--template`	file	Template file (yaml/json).	`Sentinel.UNSET`
`--adopt-file`	file	JSON file with the adopt_stack_data payload (existing resources to adopt).	`Sentinel.UNSET`
`--parameter`	text	Parameter key=value (repeatable).	`Sentinel.UNSET`
`--timeout`	integer	Timeout in minutes.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack cancel¶

Cancel an in-progress stack update.

Usage:

orca stack cancel [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack check¶

Check a stack (verify resource states).

Usage:

orca stack check [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack create¶

Create a stack.

Examples: orca stack create my-stack -t template.yaml orca stack create my-stack -t template.yaml -e env.yaml --parameter key1=val1 orca stack create my-stack -t template.yaml --timeout 30 --wait

Usage:

orca stack create [OPTIONS] NAME

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`
`--timeout`	integer	Timeout in minutes.	None
`--wait`	boolean	Wait for stack to reach terminal state.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca stack delete¶

Delete a stack.

Usage:

orca stack delete [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--wait`	boolean	Wait for stack deletion to complete.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca stack diff¶

Compare a local template with a deployed stack's template.

Fetches the currently deployed template from Heat and diffs it against the local file so you can review changes before running orca stack update.

Examples: orca stack diff my-stack -t template.yaml orca stack diff my-stack -t updated-template.yaml

Usage:

orca stack diff [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--template`, `-t`	path	Local template file to compare against.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca stack environment¶

Inspect a stack's resolved environment.

Usage:

orca stack environment [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

show: Show the resolved environment of a stack.

orca stack environment show¶

Show the resolved environment of a stack.

Usage:

orca stack environment show [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack event¶

Inspect stack events.

Usage:

orca stack event [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List stack events.
show: Show event details.

orca stack event list¶

List stack events.

Usage:

orca stack event list [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--resource`	text	Filter by resource name.	None
`--limit`	integer	Limit number of events.	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 stack event show¶

Show event details.

Usage:

orca stack event show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME EVENT_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 stack event-list¶

List stack events.

Usage:

orca stack event-list [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--resource`	text	Filter by resource name.	None
`--limit`	integer	Limit number of events.	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 stack event-show¶

Show event details.

Usage:

orca stack event-show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME EVENT_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 stack export¶

Export the full serialised state of a stack.

Heat GET /v1/stacks/{name}/{id}/export returns the same body as abandon would, without actually removing the stack. Useful as a backup or for stack adopt later.

Usage:

orca stack export [OPTIONS] STACK_NAME

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 stack failures¶

Inspect failed events on a stack.

Usage:

orca stack failures [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List events on a stack whose resource_status is FAILED.

orca stack failures list¶

List events on a stack whose resource_status is FAILED.

Usage:

orca stack failures list [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack file¶

Inspect files referenced by a stack template.

Usage:

orca stack file [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List local files referenced by a stack template.

orca stack file list¶

List local files referenced by a stack template.

Usage:

orca stack file list [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack hook¶

Manage pre-create / pre-update hooks on stack resources.

Usage:

orca stack hook [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

clear: Clear a hook so the paused resource can proceed.
poll: List resources whose hooks are still pending on a stack.

orca stack hook clear¶

Clear a hook so the paused resource can proceed.

Usage:

orca stack hook clear [OPTIONS] STACK_NAME RESOURCE_NAME

Options:

Name	Type	Description	Default
`--hook`	choice (`pre-create` \| `pre-update` \| `pre-delete`)	Hook to clear on the resource.	`pre-create`
`--help`	boolean	Show this message and exit.	`False`

orca stack hook poll¶

List resources whose hooks are still pending on a stack.

Usage:

orca stack hook poll [OPTIONS] STACK_NAME

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 stack list¶

List stacks.

Usage:

orca stack 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 stack output¶

Inspect stack outputs.

Usage:

orca stack output [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List stack outputs.
show: Show a specific stack output value.

orca stack output list¶

List stack outputs.

Usage:

orca stack output list [OPTIONS] STACK_NAME_OR_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 stack output show¶

Show a specific stack output value.

Usage:

orca stack output show [OPTIONS] STACK_NAME_OR_ID KEY

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 stack output-list¶

List stack outputs.

Usage:

orca stack output-list [OPTIONS] STACK_NAME_OR_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 stack output-show¶

Show a specific stack output value.

Usage:

orca stack output-show [OPTIONS] STACK_NAME_OR_ID KEY

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

Per-resource actions and inspection on a stack.

Usage:

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

Options:

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

Subcommands

list: List resources in a stack.
mark-unhealthy: Mark a stack resource as unhealthy (forces re-create on update).
metadata: Show the metadata of a stack resource.
show: Show resource details.
signal: Send a signal to a stack resource (e.g. WaitCondition).

orca stack resource list¶

List resources in a stack.

Usage:

orca stack resource list [OPTIONS] STACK_NAME_OR_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 stack resource mark-unhealthy¶

Mark a stack resource as unhealthy (forces re-create on update).

Usage:

orca stack resource mark-unhealthy [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

Options:

Name	Type	Description	Default
`--reason`	text	Status reason.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack resource metadata¶

Show the metadata of a stack resource.

Usage:

orca stack resource metadata [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

Options:

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

orca stack resource show¶

Show resource details.

Usage:

orca stack resource show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

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 stack resource signal¶

Send a signal to a stack resource (e.g. WaitCondition).

Usage:

orca stack resource signal [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

Options:

Name	Type	Description	Default
`--data`	text	JSON body to send as the signal payload.	None
`--help`	boolean	Show this message and exit.	`False`

orca stack resource-list¶

List resources in a stack.

Usage:

orca stack resource-list [OPTIONS] STACK_NAME_OR_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 stack resource-show¶

Show resource details.

Usage:

orca stack resource-show [OPTIONS] STACK_NAME_OR_ID RESOURCE_NAME

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 stack resource-type¶

Inspect Heat resource types (compound noun).

Usage:

orca stack 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 stack resource-type list¶

List available Heat resource types.

Usage:

orca stack 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 stack resource-type show¶

Show the schema for a Heat resource type.

Usage:

orca stack 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 stack resource-type-list¶

List available Heat resource types.

Usage:

orca stack 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 stack resource-type-show¶

Show the schema for a Heat resource type.

Usage:

orca stack 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 stack resume¶

Resume a suspended stack.

Usage:

orca stack resume [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack show¶

Show stack details.

Usage:

orca stack show [OPTIONS] STACK_NAME_OR_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 stack snapshot¶

Manage stack snapshots (Heat snapshot/restore).

Usage:

orca stack snapshot [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Take a snapshot of a stack's current state.
delete: Delete a stack snapshot.
list: List snapshots of a stack.
restore: Restore a stack to a previous snapshot.
show: Show a stack snapshot.

orca stack snapshot create¶

Take a snapshot of a stack's current state.

Usage:

orca stack snapshot create [OPTIONS] STACK_NAME_OR_ID

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name (auto if omitted).	None
`--help`	boolean	Show this message and exit.	`False`

orca stack snapshot delete¶

Delete a stack snapshot.

Usage:

orca stack snapshot delete [OPTIONS] STACK_NAME_OR_ID SNAPSHOT_ID

Options:

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

orca stack snapshot list¶

List snapshots of a stack.

Usage:

orca stack snapshot list [OPTIONS] STACK_NAME_OR_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 stack snapshot restore¶

Restore a stack to a previous snapshot.

Usage:

orca stack snapshot restore [OPTIONS] STACK_NAME_OR_ID SNAPSHOT_ID

Options:

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

orca stack snapshot show¶

Show a stack snapshot.

Usage:

orca stack snapshot show [OPTIONS] STACK_NAME_OR_ID SNAPSHOT_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 stack suspend¶

Suspend a stack.

Usage:

orca stack suspend [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack template¶

Inspect or validate Heat templates.

Usage:

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

Options:

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

Subcommands

show: Show the stack template (YAML output).
validate: Validate a Heat template.

orca stack template show¶

Show the stack template (YAML output).

Usage:

orca stack template show [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack 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 stack 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 stack template-show¶

Show the stack template (YAML output).

Usage:

orca stack template-show [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack 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 stack 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 stack topology¶

Show stack resource topology as a tree.

Usage:

orca stack topology [OPTIONS] STACK_NAME_OR_ID

Options:

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

orca stack update¶

Update a stack.

Examples: orca stack update my-stack -t template.yaml orca stack update my-stack -t template.yaml -e env.yaml --parameter key1=val1 --wait

Usage:

orca stack update [OPTIONS] STACK_NAME_OR_ID

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`
`--timeout`	integer	Timeout in minutes.	None
`--wait`	boolean	Wait for stack to reach terminal state.	`False`
`--help`	boolean	Show this message and exit.	`False`