owner-alarm.ip-rct

IP-RCT alarm owner

type	object
properties
alarmTypes	Types of alarm linked to this value : ALARM : A complete state of the alarm. The linked value has to be TEXT. PRIMARY_ATP : The state of the primary ATP (the primary path is usually an internet physical link). The linked value has to be BOOLEAN. ALTERNATIVE_ATP : The state of the alternative ATP (the secondary path is usually a GSM link). The linked value has to be BOOLEAN. ATS : The global state of the ATS (the ATS is viewed as true if at least one path is connected). The linked value has to be BOOLEAN. Learn more about IP-RCT ↗️. Default value is [[“ALARM”]]
	type	array
	default	ALARM
	items	type	string
		enum	ALARM, PRIMARY_ATP, ALTERNATIVE_ATP, ATS
criteriaExpression	A regular expression that filters alarms/restores based on their criteria. For example, the regular expression Nri1/OP.* is a valid expression. It will get you every criteria that fall in this regular expression. Learn more about IP-RCT ↗️.
	type	string
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
linkedAction	The action to execute when an alarm is received. For more information about actions ↗️.
	LinkedActionConfigurationEntity
linkedDevice	The IP-RCT device device.ip-rct ↗️ that this output will use to communicate. For example servers.ip-rct.device.ip-rct could be a path of the IP-RCT device.
	type	string
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
additionalProperties	False

LinkedActionConfigurationEntity

type	object
properties
actionId	The itemId of the action.ospp to execute
	type	string
expiration	The duration after which the action will be timed out
	DurationConfigurationEntity
moduleId	The module that will execute the action, this can be used for example if the action is a ping who can be executed by multiples instance of osp-network-monitor
	type	string
parameters	The parameters are allowing to choice the parameters who will be sent to the action. Each action required different parameters base on the type.
	type	object
	additionalProperties	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

CONSTANT

type	object
properties
type	type	string
	enum	CONSTANT
	default	CONSTANT
value	A constant value
additionalProperties	False

LIST

type	object
properties
type	type	string
	enum	LIST
	default	LIST
values	A list of value accessors
	type	array
	items	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

PROPERTIES

type	object
properties
type	type	string
	enum	PROPERTIES
	default	PROPERTIES
properties	An object of value accessors
	type	object
	additionalProperties	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

FIELD

type	object
properties
type	type	string
	enum	FIELD
	default	FIELD
field	A field of the value
	type	string
	enum	ID, CONTENT, ERROR, TYPE, TIMESTAMP, NAME, DESCRIPTION
fieldParser	An expression to access a field of the JSON content of the value
	type	string
additionalProperties	False