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 requirements outlined in the tables below.
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 | Host group ID. Note: To configure multiple host groups, create a dashboard widget field object for each host group. |
|
Exclude host groups | 2 | exclude_groupids | Host group ID. Note: To exclude 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. |
|
Problem | 1 | problem | Problem event name (case insensitive, full name or part of it). | |
Severity | 0 | severities | 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. |
|
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 | 0 | show_type | 0 - (default) Host groups; 1 - Totals. |
|
Layout | 0 | layout | 0 - (default) Horizontal; 1 - Vertical. Parameter Layout not available if Show is set to "Host groups". |
|
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 Hide groups without problems not available if Show is set to "Totals". |
|
Problem display | 0 | ext_ack | 0 - (default) All; 1 - Unacknowledged only; 2 - Separated. |
|
Show timeline | 0 | show_timeline | 0 - Disabled; 1 - (default) Enabled. |
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
.
Configure a Problems by severity widget that displays problem totals for all host groups.
Request:
{
"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
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response: