`orca software`¶

Heat software configs and deployments.

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

orca software¶

Heat software configs and deployments.

Usage:

orca software [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

config: Heat software configurations.
deployment: Heat software deployments.

orca software config¶

Heat software configurations.

Usage:

orca software config [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Create a Heat software config.
delete: Delete a software config.
list: List software configs.
show: Show a software config.

orca software config create¶

Create a Heat software config.

Usage:

orca software config create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--group`	text	Config group (e.g. script, ansible, puppet).	`script`
`--config`	text	Raw config payload (inline text).	None
`--config-file`	path	Read the config payload from this file.	None
`--definition-file`	path	YAML/JSON file with `inputs` / `outputs` definitions.	None
`--help`	boolean	Show this message and exit.	`False`

orca software config delete¶

Delete a software config.

Usage:

orca software config delete [OPTIONS] CONFIG_ID

Options:

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

orca software config list¶

List software configs.

Usage:

orca software config list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Server-side pagination limit.	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 software config show¶

Show a software config.

Usage:

orca software config show [OPTIONS] CONFIG_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 software deployment¶

Heat software deployments.

Usage:

orca software deployment [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Create a software deployment.
delete: Delete a software deployment.
list: List software deployments (optionally filtered by server).
metadata: Per-server deployment metadata.
output: Software deployment output access.
show: Show a software deployment.

orca software deployment create¶

Create a software deployment.

Usage:

orca software deployment create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--server`	text	Server (Nova UUID) running this deployment.	`Sentinel.UNSET`
`--config`	text	Software config to deploy.	`Sentinel.UNSET`
`--action`	choice (`CREATE` \| `UPDATE` \| `DELETE` \| `SUSPEND` \| `RESUME`)	Action to record on the deployment.	`CREATE`
`--help`	boolean	Show this message and exit.	`False`

orca software deployment delete¶

Delete a software deployment.

Usage:

orca software deployment delete [OPTIONS] DEPLOYMENT_ID

Options:

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

orca software deployment list¶

List software deployments (optionally filtered by server).

Usage:

orca software deployment list [OPTIONS]

Options:

Name	Type	Description	Default
`--server`	text	Filter by server (Nova 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 software deployment metadata¶

Per-server deployment metadata.

Usage:

orca software deployment metadata [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

show: Show the aggregated deployment metadata for a server.

orca software deployment metadata show¶

Show the aggregated deployment metadata for a server.

Heat exposes GET /v1/software_deployments/metadata/{server_id} which returns the list of metadata snippets all deployments on that server have produced.

Usage:

orca software deployment metadata show [OPTIONS] SERVER_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 software deployment output¶

Software deployment output access.

Usage:

orca software deployment output [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

show: Show a software deployment's output values.

orca software deployment output show¶

Show a software deployment's output values.

Without OUTPUT_NAME, lists every output the deployment recorded. With OUTPUT_NAME, only that key (or 404 if absent).

Usage:

orca software deployment output show [OPTIONS] DEPLOYMENT_ID [OUTPUT_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 software deployment show¶

Show a software deployment.

Usage:

orca software deployment show [OPTIONS] DEPLOYMENT_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`