Table of Contents
12 Host availability
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the Host availability widget in dashboard.create and dashboard.update methods.
Parameters
The following parameters are supported for the Host availability widget.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - (default) 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. |
|
| 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. |
|
| Interface type | 0 | interface_type.0 | 0 - None; 1 - Zabbix agent (passive checks); 2 - SNMP; 3 - IPMI; 4 - JMX; 5 - Zabbix agent (active checks). 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. |
|
| Layout | 0 | layout | 0 - (default) Horizontal; 1 - Vertical. |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (default) Disabled; 1 - Enabled. |
|
| Show only totals | 0 | only_totals | 0 - (default) Disabled; 1 - Enabled. |
|
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the Host availability widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a Host availability widget
Configure a Host availability widget that displays availability information (in a vertical layout) for hosts in host group "4" with "Zabbix agent" and "SNMP" interfaces configured.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "hostavail",
"name": "Host availability",
"x": 0,
"y": 0,
"width": 18,
"height": 3,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 0,
"name": "interface_type",
"value": 1
},
{
"type": 0,
"name": "interface_type",
"value": 2
},
{
"type": 0,
"name": "layout",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: