`orca alarm`¶

Manage Aodh alarms.

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

orca alarm¶

Manage Aodh alarms.

Usage:

orca alarm [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

capabilities: Show Aodh API capabilities.
create: Create an alarm.
delete: Delete an alarm.
history: Show the change history of an alarm.
list: List alarms.
metrics: Show Aodh evaluator metrics (OSC alarm metrics).
quota: Inspect or set Aodh per-project alarm quota.
quota-set: [deprecated, use 'alarm quota set' instead]
set: Update an alarm.
set: Update an alarm.
show: Show an alarm.
state: Inspect or override an alarm's evaluation state.
state-get: [deprecated, use 'alarm state get' instead]
state-set: [deprecated, use 'alarm state set' instead]

orca alarm capabilities¶

Show Aodh API capabilities.

Usage:

orca alarm capabilities [OPTIONS]

Options:

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

orca alarm create¶

Create an alarm.

Usage:

orca alarm create [OPTIONS]

Options:

Name	Type	Description	Default
`--name`	text	Alarm name.	`Sentinel.UNSET`
`--type`	choice (`gnocchi_resources_threshold` \| `gnocchi_aggregation_by_metrics_threshold` \| `gnocchi_aggregation_by_resources_threshold` \| `event` \| `composite` \| `loadbalancer_member_health` \| `threshold`)	Alarm type.	`Sentinel.UNSET`
`--rule`	text	Type-specific rule as a JSON string.	`Sentinel.UNSET`
`--description`	text	Alarm description.	``
`--severity`	choice (`low` \| `moderate` \| `critical`)	Alarm severity.	`low`
`--enabled` / `--disabled`	boolean	Enable or disable the alarm.	`True`
`--repeat-actions` / `--no-repeat-actions`	boolean	Re-trigger actions on each evaluation while in alarm state.	`False`
`--alarm-action`	text	Webhook URL to call when entering alarm state. Repeatable.	`Sentinel.UNSET`
`--ok-action`	text	Webhook URL to call when entering ok state. Repeatable.	`Sentinel.UNSET`
`--insufficient-data-action`	text	Webhook URL to call on insufficient data. Repeatable.	`Sentinel.UNSET`
`--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 alarm delete¶

Delete an alarm.

Usage:

orca alarm delete [OPTIONS] ALARM_ID

Options:

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

orca alarm history¶

Show the change history of an alarm.

Usage:

orca alarm history [OPTIONS] ALARM_ID

Options:

Name	Type	Description	Default
`--limit`	integer	Max number of history entries.	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 alarm list¶

List alarms.

Usage:

orca alarm list [OPTIONS]

Options:

Name	Type	Description	Default
`--type`	text	Filter by alarm type.	None
`--state`	choice (`ok` \| `alarm` \| `insufficient_data`)	Filter by state.	None
`--enabled` / `--disabled`	boolean	Filter by enabled status.	None
`--name`	text	Filter by alarm name.	None
`--limit`	integer	Max number of alarms to return.	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 alarm metrics¶

Show Aodh evaluator metrics (OSC alarm metrics).

Usage:

orca alarm metrics [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 alarm quota¶

Inspect or set Aodh per-project alarm quota.

Usage:

orca alarm quota [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

set: Set alarm quota for a project.
show: Show the alarm quota for a project (OSC alarm quota show).

orca alarm quota set¶

Set alarm quota for a project.

Usage:

orca alarm quota set [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
`--alarms`	integer	Maximum number of alarms for the project.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm quota show¶

Show the alarm quota for a project (OSC alarm quota show).

Usage:

orca alarm quota show [OPTIONS]

Options:

Name	Type	Description	Default
`--project`	text	Project to query (default: caller's project).	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 alarm quota-set¶

Set alarm quota for a project.

Usage:

orca alarm quota-set [OPTIONS] PROJECT_ID

Options:

Name	Type	Description	Default
`--alarms`	integer	Maximum number of alarms for the project.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm set¶

Update an alarm.

Usage:

orca alarm set [OPTIONS] ALARM_ID

Options:

Name	Type	Description	Default
`--name`	text	New alarm name.	None
`--description`	text	New description.	None
`--severity`	choice (`low` \| `moderate` \| `critical`)	N/A	None
`--enabled` / `--disabled`	boolean	Enable or disable.	None
`--repeat-actions` / `--no-repeat-actions`	boolean	N/A	None
`--rule`	text	Updated type-specific rule as JSON.	None
`--alarm-action`	text	N/A	`Sentinel.UNSET`
`--ok-action`	text	N/A	`Sentinel.UNSET`
`--insufficient-data-action`	text	N/A	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm set¶

Update an alarm.

Usage:

orca alarm set [OPTIONS] ALARM_ID

Options:

Name	Type	Description	Default
`--name`	text	New alarm name.	None
`--description`	text	New description.	None
`--severity`	choice (`low` \| `moderate` \| `critical`)	N/A	None
`--enabled` / `--disabled`	boolean	Enable or disable.	None
`--repeat-actions` / `--no-repeat-actions`	boolean	N/A	None
`--rule`	text	Updated type-specific rule as JSON.	None
`--alarm-action`	text	N/A	`Sentinel.UNSET`
`--ok-action`	text	N/A	`Sentinel.UNSET`
`--insufficient-data-action`	text	N/A	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca alarm show¶

Show an alarm.

Usage:

orca alarm show [OPTIONS] ALARM_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 alarm state¶

Inspect or override an alarm's evaluation state.

Usage:

orca alarm state [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

get: Get the current state of an alarm.
set: Set the state of an alarm.

orca alarm state get¶

Get the current state of an alarm.

Usage:

orca alarm state get [OPTIONS] ALARM_ID

Options:

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

orca alarm state set¶

Set the state of an alarm.

Usage:

orca alarm state set [OPTIONS] ALARM_ID {ok|alarm|insufficient_data}

Options:

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

orca alarm state-get¶

Get the current state of an alarm.

Usage:

orca alarm state-get [OPTIONS] ALARM_ID

Options:

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

orca alarm state-set¶

Set the state of an alarm.

Usage:

orca alarm state-set [OPTIONS] ALARM_ID {ok|alarm|insufficient_data}

Options:

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