group.alarms

Alarms group

Define a static group configuration. The member of the group are dynamic but the generation of it’s fields can only be changed using this file.

This group can be use to group the alarms by concern (Site, Type of hardware, …).

When this file is removed, the group will not be delete immediately.

1. it will be converted to a manually create group.

2. the group will follow the default configuration if it is empty.

type	object
properties
actionConfigurations	Define the behavior of the action for the group. If not all action are defined or left empty, the default define on module.alarms will be used to generate the field.
	type	array
	items	ActionGroupConfiguration
fieldConfigurations	Define the behavior of the field generation for the group. If not all field are defined or left empty, the default define on module.alarms will be used to generate the field.
	type	array
	items	FieldGroupConfiguration
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
moduleId	The id of the alarm module to attach this group to
	type	string
name	The name of the group. It will also be used as the serial for the alarm representing this group. The name must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
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
visibleIfNoChildren	Define the behavior of the field generation for the group. If not all field are defined or left empty, the default define on module.alarms will be used to generate the field. Default value is [true]
	type	boolean
	default	True
additionalProperties	False

ActionGroupConfiguration

Link an action and the actionBehavior wanted for the group where this is define.

type	object
properties
action	The action on which you want to define the behaviour for this group. The action must be unique per group configuration.
	type	string
	enum	ACKNOWLEDGE, LOCK_SEVERITY, TAG, EDIT_SUMMARY, EDIT_LOCATION, EDIT_SOURCE, EDIT_HIDE_UNTIL, EDIT_FORCE_HIDE, EDIT_ADDITIONAL_DATA, ESCALATE, JOURNAL, ARCHIVE
actionBehavior	Define how the action will behave when executed on the group. ON_NOBODY: No action will be executed on the group or its children. ON_CHILDREN: The action will be executed on the children of the group. ON_ITSELF: The action will be executed on the group. ON_BOTH: The action will be executed on the group and it’s children. When a action is executed on the children of the group, if a children is also a group, the action will be done as define on it’s configuration.
	type	string
	enum	ON_NOBODY, ON_CHILDREN, ON_ITSELF, ON_BOTH
additionalProperties	False

FieldGroupConfiguration

type	object
properties
generator	The generator to use to create the content of this field on the group.
	oneOf	INITIAL
		MAXIMUM
		MINIMUM
		SUM
		AND
		OR
		FROM_MAX_SEVERITY
		FROM_MIN_SEVERITY
		FROM_LATEST
		FROM_OLDEST
		CONCATENATE
		MERGE_ARRAY
		MERGE_OBJECT
name	The name of the field to generate. The name must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

INITIAL

type	object
properties
type	type	string
	enum	INITIAL
	default	INITIAL
value	The value to set initially on the group.
additionalProperties	False

MAXIMUM

type	object
properties
type	type	string
	enum	MAXIMUM
	default	MAXIMUM
fieldToExtract	The name of the children field to extract from the children where this field is the greater. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

MINIMUM

type	object
properties
type	type	string
	enum	MINIMUM
	default	MINIMUM
fieldToExtract	The name of the children field to extract from the children where this field is the smaller. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

SUM

type	object
properties
type	type	string
	enum	SUM
	default	SUM
fieldToExtract	The name of the children field on which the SUM will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

AND

type	object
properties
type	type	string
	enum	AND
	default	AND
fieldToExtract	The name of the children field on which the AND logic will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

OR

type	object
properties
type	type	string
	enum	OR
	default	OR
fieldToExtract	The name of the children field on which the OR will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_MAX_SEVERITY

type	object
properties
type	type	string
	enum	FROM_MAX_SEVERITY
	default	FROM_MAX_SEVERITY
fieldToExtract	The name of the children field to extract from the alarm with the highest severity of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_MIN_SEVERITY

type	object
properties
type	type	string
	enum	FROM_MIN_SEVERITY
	default	FROM_MIN_SEVERITY
fieldToExtract	The name of the children field to extract from the alarm with the lowest severity of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_LATEST

type	object
properties
type	type	string
	enum	FROM_LATEST
	default	FROM_LATEST
fieldToExtract	The name of the children field to extract from the most recent alarm of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_OLDEST

type	object
properties
type	type	string
	enum	FROM_OLDEST
	default	FROM_OLDEST
fieldToExtract	The name of the children field to extract from the oldest alarm of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

CONCATENATE

type	object
properties
type	type	string
	enum	CONCATENATE
	default	CONCATENATE
fieldToExtract	The name of the children field on which the CONCATENATE logic will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
prefix	An optional prefix to start the generated string. For example, the prefix “Test: “ will give the following result on the group “Test: Summary 1, Summary 2, Summary 3”
	type	string
additionalProperties	False

MERGE_ARRAY

type	object
properties
type	type	string
	enum	MERGE_ARRAY
	default	MERGE_ARRAY
fieldToExtract	The name of the children field to merge together. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

MERGE_OBJECT

type	object
properties
type	type	string
	enum	MERGE_OBJECT
	default	MERGE_OBJECT
fieldToExtract	The name of the children field to merge together. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False