These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Web monitoring 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 Web monitoring widget, please refer to the parameter behavior outlined in the tables below.
The following parameters are supported for the Web monitoring 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. |
|
Scenario 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 Scenario 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 Scenario 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 Scenario tags |
|
Show hosts in maintenance | 0 | maintenance | 0 - Disabled; 1 - (default) Enabled. |
The following examples aim to only describe the configuration of the dashboard widget field objects for the Web monitoring widget. For more information on configuring a dashboard, see dashboard.create
.
Configure a Web monitoring widget that displays a status summary of the active web monitoring scenarios for host group "4".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "web",
"name": "Web monitoring",
"x": 0,
"y": 0,
"width": 6,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
Response: