22 Trigger overview

22 Trigger overview

Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Trigger Overview widget in dashboard.create and dashboard.update methods.

Parameters

The following parameters are supported for the Trigger Overview widget.

Parameter		type	name	value
Refresh interval		0	rf_rate	0 - No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - (default) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes.
Show		0	show	1 - (default) Recent problems; 2 - Any; 3 - Problems.
Host groups		2	groupids	Host group ID. Note: To configure multiple host groups, create a dashboard widget field object for each host group.
Hosts		3	hostids	Host ID. Note: To configure multiple hosts, create a dashboard widget field object for each host. For multiple hosts, the parameter Host groups must either be not configured at all or configured with at least one host group that the configured hosts belong to.
Tags (the number in the property name (e.g. tags.tag.0) references tag order in the tag evaluation list)
	Evaluation type	0	evaltype	0 - (default) And/Or; 2 - Or.
	Tag name	1	tags.tag.0	Any string value. Parameter Tag name required if configuring Tags.
	Operator	0	tags.operator.0	0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. Parameter Operator required if configuring Tags.
	Tag value	1	tags.value.0	Any string value. Parameter Tag value required if configuring Tags.
Show suppressed problems		0	show_suppressed	0 - (default) Disabled; 1 - Enabled.
Hosts location		0	style	0 - (default) Left; 1 - Top.

Examples

The following examples aim to only describe the configuration of the dashboard widget field objects for the Trigger overview widget. For more information on configuring a dashboard, see dashboard.create.

Configure a Trigger overview widget that displays trigger states for all host groups that have triggers with a tag that has the name “scope” and contains value “availability”.

Request:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "trigover",
                               "name": "Trigger overview",
                               "x": 0,
                               "y": 0,
                               "width": 12,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 1,
                                       "name": "tags.tag.0",
                                       "value": "scope"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tags.operator.0",
                                       "value": 0
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.value.0",
                                       "value": "availability"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

22 Trigger overview

22 Trigger overview

Description

Parameters

Examples

Configuring a Trigger overview widget

See also