Table of Contents
21 Problems by severity
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Problems by severity 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 by severity widget, please refer to the parameter behavior outlined in the tables below.
Parameters
The following parameters are supported for the Problems by severity 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. |
|
| 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. |
|
| 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. |
|
| 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: 1, 2, 3, 4, 5 (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 | 0 | show_type | 0 - (default) Host groups; 1 - Totals. This parameter is not supported if configuring the widget on a template dashboard, and by default is set to "Totals". |
|
| Layout | 0 | layout | 0 - (default) Horizontal; 1 - Vertical. Parameter behavior: - supported if Show is set to "Totals" |
|
| 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. |
|
| Hide groups without problems | 0 | hide_empty_groups | 0 - (default) Disabled; 1 - Enabled. Parameter behavior: - supported if Show is set to "Host groups" This parameter is not supported if configuring the widget on a template dashboard. |
|
| Problem display | 0 | ext_ack | 0 - (default) All; 1 - Unacknowledged only; 2 - Separated. |
|
| Show timeline | 0 | show_timeline | 0 - Disabled; 1 - (default) Enabled. |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Problems by severity widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Problems by severity widget
Configure a Problems by severity widget that displays problem totals for all host groups.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "problemsbysv",
"name": "Problems by severity",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "show_type",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: