Table of Contents
22 Problems
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Problems widget in dashboard.create and dashboard.update methods.
Widget fields properties are not validated during the creation or update of a dashboard. This allows users to modify built-in widgets and create custom widgets, but also introduces the risk of creating or updating widgets incorrectly. To ensure the successful creation or update of the Problems widget, please refer to the parameter behavior outlined in the tables below.
Parameters
The following parameters are supported for the Problems 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 - History; 3 - Problems. |
|
| Host groups | 2 | groupids.0 | Host group ID. Note: To configure multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name. This parameter is not supported if configuring the widget on a template dashboard. |
|
| Host groups (Widget) | 1 | groupids._reference | Instead of Host group ID:ABCDE._hostgroupids - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for host groups.This parameter is not supported if configuring the widget on a template dashboard. |
|
| Exclude host groups | 2 | exclude_groupids.0 | Host group ID. Note: To exclude multiple host groups, create a dashboard widget field object for each host group with an incremented number in the property name. This parameter is not supported if configuring the widget on a template dashboard. |
|
| Hosts | 3 | hostids.0 | Host ID. Note: To configure multiple hosts, create a dashboard widget field object for each host with an incremented number in the property name. 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. This parameter is not supported if configuring the widget on a template dashboard. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Instead of Host ID:DASHBOARD.hostids - set the Host selector as the data source for hosts;ABCDE._hostids - set a compatible widget (with its Reference parameter set to "ABCDE") as the data source for hosts.This parameter is not supported if configuring the widget on a template dashboard. |
|
| Problem | 1 | problem | Problem event name (case insensitive, full name or part of it). | |
| Severity | 0 | severities.0 | 0 - Not classified; 1 - Information; 2 - Warning; 3 - Average; 4 - High; 5 - Disaster. Default: empty (all enabled). Note: To configure multiple values, create a dashboard widget field object for each value with an incremented number in the property name. |
|
| Problem tags | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. |
|
| Tag name | 1 | tags.0.tag | Any string value. Note: The number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Problem tags |
|
| Operator | 0 | tags.0.operator | 0 - Contains; 1 - Equals; 2 - Does not contain; 3 - Does not equal; 4 - Exists; 5 - Does not exist. Note: The number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Problem tags |
|
| Tag value | 1 | tags.0.value | Any string value. Note: The number in the property name references tag order in the tag evaluation list. Parameter behavior: - required if configuring Problem tags |
|
| Show tags | 0 | show_tags | 0 - (default) None; 1 - 1; 2 - 2; 3 - 3. |
|
| Tag name (format) | 0 | tag_name_format | 0 - (default) Full; 1 - Shortened; 2 - None. Parameter behavior: - supported if Show tags is set to "1", "2", or "3" |
|
| Tag display priority | 1 | tag_priority | Comma-separated list of tags. Parameter behavior: - supported if Show tags is set to "1", "2", or "3" |
|
| Show operational data | 0 | show_opdata | 0 - (default) None; 1 - Separately; 2 - With problem name. |
|
| Show suppressed problems | 0 | show_suppressed | 0 - (default) Disabled; 1 - Enabled. |
|
| Acknowledgement status | 0 | acknowledgement_status | 0 - (default) all; 1 - Unacknowledged; 2 - Acknowledged. |
|
| By me | 0 | acknowledged_by_me | 0 - (default) Disabled; 1 - Enabled. |
|
| Sort entries by | 0 | sort_triggers | 1 - Severity (descending); 2 - Host (ascending); 3 - Time (ascending); 4 - (default) Time (descending); 13 - Severity (ascending); 14 - Host (descending); 15 - Problem (ascending); 16 - Problem (descending). For all values, except "Time (descending)" and "Time (ascending)", the Show timeline parameter must be set to "Disabled". Values "Host (ascending)" and "Host (descending)" are not supported if configuring the widget on a template dashboard. |
|
| Show timeline | 0 | show_timeline | 0 - Disabled; 1 - (default) Enabled. Parameter behavior: - supported if Sort entries by is set to "Time (descending)" or "Time (ascending)" |
|
| Show lines | 0 | show_lines | Possible values range from 1-100. Default: 25. |
|
| Reference | 1 | reference | Any string value consisting of 5 characters (e.g., ABCDE or JBPNL). This value must be unique within the dashboard to which the widget belongs.Parameter behavior: - required |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Problems widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Problems widget
Configure a Problems widget that displays problems for host group "4" that satisfy the following conditions:
- Problems that have a tag with the name "scope" that contains values "performance" or "availability", or "capacity".
- Problems that have the following severities: "Warning", "Average", "High", "Disaster".
In addition, configure the widget to show tags and operational data.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problems",
"name": "Problems",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "tags.0.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "performance"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 0
},
{
"type": 1,
"name": "tags.1.value",
"value": "availability"
},
{
"type": 1,
"name": "tags.2.tag",
"value": "scope"
},
{
"type": 0,
"name": "tags.2.operator",
"value": 0
},
{
"type": 1,
"name": "tags.2.value",
"value": "capacity"
},
{
"type": 0,
"name": "severities.0",
"value": 2
},
{
"type": 0,
"name": "severities.1",
"value": 3
},
{
"type": 0,
"name": "severities.2",
"value": 4
},
{
"type": 0,
"name": "severities.3",
"value": 5
},
{
"type": 0,
"name": "show_tags",
"value": 1
},
{
"type": 0,
"name": "show_opdata",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: