action.alarms

Alarms action rule

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 reference to the module to attach this action rule to

type

string

  • period

The period between two periodic executions of the action

DurationConfigurationEntity

  • beginBatch

Notify when a batch of alarms has begun

type

string

  • endBatch

Notify when a batch of alarms has ended

type

string

  • criteria

Conditional selection of alarms to apply the action to inside the script

type

string

  • scriptFile

The source of the script containing functions of the action rule

type

string

  • execute

The actions to apply to each alarms matching the criteria

type

string

  • accessedValues

The list of the value id used by this action rule. The wildcard ‘*’ can be used to match multiple value (For example, ‘root.*.test’ will match ‘root.device.1.test’, ‘root.server.test’).

type

array

default

items

type

string

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