severity.alarms

Alarms severity

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • moduleId

The id of the alarm module to attach this severity to

type

string

  • expiration

The expiration policy of the severity. If none is provided alarms with this severity will never expire.

oneOf

REMOVE

ESCALATE

  • defaultEmptyClear

Flag to indicate that this severity is the default severity in case of empty filters.If true this severity is the default “empty clear severity” for alarm filters (must be set on at most one severity).

type

boolean

default

False

additionalProperties

False

REMOVE

type

object

properties

  • type

type

string

enum

REMOVE

default

REMOVE

  • duration

The period of time after which alarms with this expire. This duration must be expressed as _value_ and _unit_.

DurationConfigurationEntity

  • occurrence

It can be LAST to check the expiration time on the last occurrence, FIRST to check on the first occurrence or EVERY.

type

string

enum

LAST, FIRST, EVERY

  • state

The state of the alarm can be used to limit the expiration. ACKNOWLEDGED to only check on acknowledged alarm, UNACKNOWLEDGED or ALL.

type

string

enum

ALL, ACKNOWLEDGED, UNACKNOWLEDGED

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • value

The amount of time expressed with the unit

type

integer

  • unit

The unit of time expressed with the value

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

additionalProperties

False

ESCALATE

type

object

properties

  • type

type

string

enum

ESCALATE

default

ESCALATE

  • duration

The period of time after which alarms with this expire. This duration must be expressed as _value_ and _unit_.

DurationConfigurationEntity

  • occurrence

It can be LAST to check the expiration time on the last occurrence, FIRST to check on the first occurrence or EVERY.

type

string

enum

LAST, FIRST, EVERY

  • state

The state of the alarm can be used to limit the expiration. ACKNOWLEDGED to only check on acknowledged alarm, UNACKNOWLEDGED or ALL.

type

string

enum

ALL, ACKNOWLEDGED, UNACKNOWLEDGED

  • escalateToId

The id of the new severity to use on expiration for the ESCALATE type. The alarm severity will change to the given severity on expiration.

type

string

additionalProperties

False

if

properties

  • type

enum

ESCALATE

then

properties

  • occurrence

not

enum

EVERY