Kyvernon

Reference For: developers, administrators

kyvernon alarms

The alarms command of the kyvernon CLI with its subcommands and arguments.

kyvernon alarms

Alarms

Usage
kyvernon alarms <COMMAND>

Subcommands: list, get, create, delete, update, acknowledge, clear-triggered

kyvernon alarms list

Alarm definitions with their states

Usage
kyvernon alarms list [OPTIONS]
ArgumentDescriptionRequired
--targetOnly states on this target

API operation: GET /v1/alarms

kyvernon alarms get

One alarm definition with its states

Usage
kyvernon alarms get <ID>
ArgumentDescriptionRequired
<ID>Alarm idyes

API operation: GET /v1/alarms/{id}

kyvernon alarms create

Define an alarm from a JSON body (CreateAlarmRequest schema)

Usage
kyvernon alarms create [OPTIONS]
ArgumentDescriptionRequired
--bodyInline JSON body
--body-fileFile with the JSON body (- for stdin)

API operation: POST /v1/alarms

kyvernon alarms delete

Delete an alarm definition

Usage
kyvernon alarms delete <ID>
ArgumentDescriptionRequired
<ID>Alarm idyes

API operation: DELETE /v1/alarms/{id}

kyvernon alarms update

Change an alarm definition: name, description, on or off, trigger

Usage
kyvernon alarms update [OPTIONS] <ID>
ArgumentDescriptionRequired
<ID>Alarm idyes
--nameNew name
--descriptionNew description
--enableTurn the alarm on
--disableTurn the alarm off
--triggerNew trigger as JSON (AlarmTrigger schema)

API operation: PUT /v1/alarms/{id}

kyvernon alarms acknowledge

Acknowledge an alarm on a target

Usage
kyvernon alarms acknowledge <ID> <TARGET>
ArgumentDescriptionRequired
<ID>Alarm idyes
<TARGET>Target object idyes

API operation: POST /v1/alarms/{id}/acknowledge

kyvernon alarms clear-triggered

Reset triggered (non-green) states to green (ClearTriggeredAlarms)

Usage
kyvernon alarms clear-triggered [OPTIONS]
ArgumentDescriptionRequired
--statusOnly clear these statuses (red, yellow, gray); omit to clear all non-green

API operation: POST /v1/alarms/clear-triggered

Version 0.1.