Documentation
Table of Contents
26 Top hosts
Beschrijving
Deze parameters en de mogelijke eigenschapswaarden voor de respectievelijke objecten van veldwidgets van het dashboard stellen je in staat om de Top Hosts widget te configureren in de dashboard.create en dashboard.update methoden.
Parameters
The following parameters are supported for the Top hosts 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. |
|
| 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. |
|
| 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. |
|
| Host tags | ||||
| Evaluation type | 0 | evaltype | 0 - (default) And/Or; 2 - Or. This parameter is not supported if configuring the widget on a template dashboard. |
|
| 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 Host tags This parameter is not supported if configuring the widget on a template dashboard. |
|
| 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 Host tags This parameter is not supported if configuring the widget on a template dashboard. |
|
| 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 Host tags This parameter is not supported if configuring the widget on a template dashboard. |
|
| Show hosts in maintenance | 0 | maintenance | 0 - (default) Disabled; 1 - Enabled. |
|
| Columns (see below) | ||||
| Order by | 0 | column | Column numeric value from the configured columns. | |
| Order | 0 | order | 2 - (default) Top N; 3 - Bottom N. |
|
| Host limit | 0 | show_lines | Possible values range from 1-1000. Default: 10. This parameter is not supported if configuring the widget on a template dashboard. |
|
Kolommen
Kolommen hebben algemene parameters en aanvullende parameters afhankelijk van de configuratie van de parameter Data.
Voor alle parameters die verband houden met kolommen verwijst het getal in de eigenschapsnaam (bijv. columns.name.0) naar een kolom waarvoor de parameter is geconfigureerd.
De volgende parameters worden ondersteund voor alle kolommen.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Name | 1 | columns.name.0 | Elke tekenreekswaarde. | |
| Data | 0 | columns.data.0 | 1 - Itemwaarde; 2 - Hostnaam; 3 - Tekst. Gedrag van de parameter: - verplicht |
|
| Base color | 1 | columns.base_color.0 | Hexadecimale kleurcode (bijv. FF0000).Gedrag van de parameter: - verplicht |
|
Item value
The following parameters are supported if Data is set to "Item value".
The first number in the Thresholds property name (e.g. columnsthresholds.0.color.0) references the column for which thresholds are configured, while the second number references threshold place in a list, sorted in ascending order. However, if thresholds are configured in a different order, the values will be sorted in ascending order after updating widget configuration in Zabbix frontend (e.g. "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parameter | type | name | value | |
|---|---|---|---|---|
| Item | 1 | columns.0.item | Valid item name. When configuring the widget on a template dashboard, only items configured on the template should be set. |
|
| Display item value as | 0 | columns.0.display_value_as | 0 - (default) Numeric; 1 - Text; 2 - Binary. |
|
| Display | 0 | columns.0.display | 1 - (default) As is; 2 - Bar; 3 - Indicators; 6 - Sparkline. Parameter behavior: - supported if Display item value as is set to "Numeric" |
|
| Min | 1 | columns.0.min | Any numeric value. Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Bar" or "Indicators" |
|
| Max | 1 | columns.0.max | Any numeric value. Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Bar" or "Indicators" |
|
| Decimal places | 0 | columns.0.decimal_places | Possible values range from 0-10. Default: 2. Parameter behavior: - supported if Display item value as is set to "Numeric" |
|
| Sparkline | ||||
| Width | 0 | columns.0.sparkline.width | Possible values range from 0-10. Default: 1. Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| Fill | 0 | columns.0.sparkline.fill | Possible values range from 0-10. Default: 3. Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| Color | 1 | columns.0.sparkline.color | Hexadecimal color code (e.g. FF0000).Default: 42A5F5.Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| Time period | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - set the Time period selector as the data source;ABCDE._timeperiod - set a compatible widget (with its reference parameter equal to ABCDE) as the data source.Default: DASHBOARD._timeperiodAlternatively, you can set the time period only in the From and To parameters. Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| From | 1 | columns.0.sparkline.time_period.from | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| To | 1 | columns.0.sparkline.time_period.to | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| History data | 0 | columns.0.sparkline.history | 0 - (default) Auto; 1 - History; 2 - Trends. Parameter behavior: - supported if Display item value as is set to "Numeric" and Display is set to "Sparkline" |
|
| Thresholds | ||||
| Color | 1 | columnsthresholds.0.color.0 | Hexadecimal color code (e.g. FF0000).Parameter behavior: - supported if Display item value as is set to "Numeric" |
|
| Threshold | 1 | columnsthresholds.0.threshold.0 | Any string value. Parameter behavior: - supported if Display item value as is set to "Numeric" |
|
| Highlights | ||||
| Color | 1 | columns.0.highlights.0.color | Hexadecimal color code (e.g. FF0000).Parameter behavior: - supported if Display item value as is set to "Text" |
|
| Pattern | 1 | columns.0.highlights.0.pattern | Any string value. Parameter behavior: - supported if Display item value as is set to "Text" |
|
| Show thumbnail | 0 | columns.0.show_thumbnail | 0 - (default) Disabled; 1 - Enabled. Parameter behavior: - supported if Display item value as is set to "Binary" |
|
| Aggregation function | 0 | columns.0.aggregate_function | 0 - (default) not used; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Time period | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - set the Time period selector as the data source;ABCDE._timeperiod - set a compatible widget (with its reference parameter equal to ABCDE) as the data source.Default: DASHBOARD._timeperiodAlternatively, you can set the time period only in the From and To parameters. Parameter behavior: - supported if Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last" |
|
| From | 1 | columns.0.time_period.from | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Time period is not set and Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last" |
|
| To | 1 | columns.0.time_period.to | Valid time string in absolute (YYYY-MM-DD hh:mm:ss) or relative time syntax (now, now/d, now/w-1w, etc.).Parameter behavior: - supported if Time period is not set and Aggregation function is set to "min", "max", "avg", "count", "sum", "first", "last" |
|
| History data | 0 | columns.0.history | 0 - (default) Auto; 1 - History; 2 - Trends. Parameter behavior: - supported if Display item value as is set to "Numeric" |
|
| 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 |
|
Tekst
De volgende parameters worden ondersteund als Data is ingesteld op "Tekst".
| Parameter | type | name | value |
|---|---|---|---|
| Tekst | 1 | columns.text.0 | Een willekeurige tekenreekswaarde, inclusief macro's. Ondersteunde macro's: {HOST.*}, {INVENTORY.*}. Gedrag van de parameter: - vereist als Data is ingesteld op "Tekst" |
Voorbeelden
De volgende voorbeelden hebben als doel enkel de configuratie te beschrijven van de veldobjecten van het dashboardwidget voor de Top hosts widget. Voor meer informatie over het configureren van een dashboard, zie dashboard.create.
Configuratie van een Top hosts widget
Configureer een Top hosts widget die de top hosts weergeeft op basis van CPU-gebruik in hostgroep "4". Daarnaast, configureer de volgende aangepaste kolommen: "Hostnaam", "CPU-gebruik in %", "1m gem.", "5m gem.", "15m gem.", "Processen".
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "Mijn dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids",
"value": 4
},
{
"type": 1,
"name": "columns.name.0",
"value": ""
},
{
"type": 0,
"name": "columns.data.0",
"value": 2
},
{
"type": 1,
"name": "columns.base_color.0",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.item.0",
"value": "Systeemnaam"
},
{
"type": 1,
"name": "columns.timeshift.0",
"value": ""
},
{
"type": 1,
"name": "columns.name.1",
"value": "CPU-gebruik in %"
},
{
"type": 0,
"name": "columns.data.1",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.1",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.item.1",
"value": "CPU-gebruik"
},
{
"type": 1,
"name": "columns.timeshift.1",
"value": ""
},
{
"type": 0,
"name": "columns.display.1",
"value": 3
},
{
"type": 1,
"name": "columns.min.1",
"value": "0"
},
{
"type": 1,
"name": "columns.max.1",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.color.1.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.color.1.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.color.1.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.threshold.1.2",
"value": "90"
},
{
"type": 1,
"name": "columns.name.2",
"value": "1m gem."
},
{
"type": 0,
"name": "columns.data.2",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.2",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.item.2",
"value": "Gemiddelde belasting (1m gem.)"
},
{
"type": 1,
"name": "columns.timeshift.2",
"value": ""
},
{
"type": 1,
"name": "columns.name.3",
"value": "5m gem."
},
{
"type": 0,
"name": "columns.data.3",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.3",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.item.3",
"value": "Gemiddelde belasting (5m gem.)"
},
{
"type": 1,
"name": "columns.timeshift.3",
"value": ""
},
{
"type": 1,
"name": "columns.name.4",
"value": "15m gem."
},
{
"type": 0,
"name": "columns.data.4",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.4",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.item.4",
"value": "Gemiddelde belasting (15m gem.)"
},
{
"type": 1,
"name": "columns.timeshift.4",
"value": ""
},
{
"type": 1,
"name": "columns.name.5",
"value": "Processen"
},
{
"type": 0,
"name": "columns.data.5",
"value": 1
},
{
"type": 1,
"name": "columns.base_color.5",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.item.5",
"value": "Aantal processen"
},
{
"type": 1,
"name": "columns.timeshift.5",
"value": ""
},
{
"type": 0,
"name": "columns.decimal_places.5",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Reactie: