On this page
27 Top-Hosts
Beschreibung
Diese Parameter und die möglichen Eigenschaftswerte für die jeweiligen Feldobjekte des Dashboard-Widgets ermöglichen die Konfiguration des Widgets Top hosts in den Methoden dashboard.create und dashboard.update.
Die Eigenschaften von Widget-fields werden bei der Erstellung oder Aktualisierung eines Dashboards nicht validiert.
Dadurch können Benutzer integrierte Widgets ändern und benutzerdefinierte Widgets erstellen, es besteht jedoch auch das Risiko, Widgets fehlerhaft zu erstellen oder zu aktualisieren.
Um die erfolgreiche Erstellung oder Aktualisierung des Widgets Top hosts sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Verhalten der Parameter.
Parameter
Die folgenden Parameter werden für das Widget Top-Hosts unterstützt.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Aktualisierungsintervall | 0 | rf_rate | 0 - Keine Aktualisierung; 10 - 10 Sekunden; 30 - 30 Sekunden; 60 - (Standard) 1 Minute; 120 - 2 Minuten; 600 - 10 Minuten; 900 - 15 Minuten. |
|
| Host-Gruppen | 2 | groupids.0 | ID der Host-Gruppe. Hinweis: Um mehrere Host-Gruppen zu konfigurieren, erstellen Sie für jede Host-Gruppe ein Dashboard-Widget-Feldobjekt mit einer fortlaufend erhöhten Nummer im Eigenschaftsnamen. Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Host-Gruppen (Widget) | 1 | groupids._reference | Anstelle der ID der Host-Gruppe:ABCDE._hostgroupids - Legen Sie ein kompatibles Widget (mit dem Parameter Referenz auf "ABCDE" gesetzt) als Datenquelle für Host-Gruppen fest.Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Hosts | 3 | hostids.0 | ID des Hosts. Hinweis: Um mehrere Hosts zu konfigurieren, erstellen Sie für jeden Host ein Dashboard-Widget-Feldobjekt mit einer fortlaufend erhöhten Nummer im Eigenschaftsnamen. Bei mehreren Hosts muss der Parameter Host-Gruppen entweder überhaupt nicht konfiguriert sein oder mindestens eine Host-Gruppe enthalten, der die konfigurierten Hosts angehören. Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Hosts (Widget/Dashboard) | 1 | hostids._reference | Anstelle der ID des Hosts:DASHBOARD.hostids - Legen Sie den Host-Selektor als Datenquelle für Hosts fest;ABCDE._hostids - Legen Sie ein kompatibles Widget (mit dem Parameter Referenz auf "ABCDE" gesetzt) als Datenquelle für Hosts fest.Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Host-Tags | ||||
| Auswertungstyp | 0 | evaltype | 0 - (Standard) Und/Oder; 2 - Oder. Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Tag-Name | 1 | tags.0.tag | Beliebiger Zeichenfolgenwert. Hinweis: Die Nummer im Eigenschaftsnamen verweist auf die Reihenfolge des Tags in der Tag-Auswertungsliste. Parameterverhalten: - erforderlich bei der Konfiguration von Host-Tags Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Operator | 0 | tags.0.operator | 0 - Enthält; 1 - Ist gleich; 2 - Enthält nicht; 3 - Ist nicht gleich; 4 - Ist vorhanden; 5 - Ist nicht vorhanden. Hinweis: Die Nummer im Eigenschaftsnamen verweist auf die Reihenfolge des Tags in der Tag-Auswertungsliste. Parameterverhalten: - erforderlich bei der Konfiguration von Host-Tags Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Tag-Wert | 1 | tags.0.value | Beliebiger Zeichenfolgenwert. Hinweis: Die Nummer im Eigenschaftsnamen verweist auf die Reihenfolge des Tags in der Tag-Auswertungsliste. Parameterverhalten: - erforderlich bei der Konfiguration von Host-Tags Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
| Hosts in Wartung anzeigen | 0 | maintenance | 0 - (Standard) Deaktiviert; 1 - Aktiviert. |
|
| Spalten (siehe unten) | ||||
| Sortieren nach | 0 | column | Numerischer Spaltenwert aus den konfigurierten Spalten. | |
| Reihenfolge | 0 | order | 2 - (Standard) Obere N; 3 - Untere N. |
|
| Host-Limit | 0 | show_lines | Mögliche Werte liegen zwischen 1 und 1000. Standard: 10. Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird. |
|
Spalten
Spalten haben allgemeine Parameter und zusätzliche Parameter, abhängig von der Konfiguration des Parameters Data.
Bei allen Parametern, die sich auf Spalten beziehen, verweist die Zahl im Eigenschaftsnamen (z. B. columns.0.name) auf eine Spalte, für die der Parameter konfiguriert ist.
Die folgenden Parameter werden für alle Spalten unterstützt.
| Parameter | type | name | value |
|---|---|---|---|
| Name | 1 | columns.0.name | Beliebiger Zeichenfolgenwert. Parameterverhalten: - erforderlich |
| Daten | 0 | columns.0.data | 1 - Datenpunkt-Wert; 2 - Host-Name; 3 - Text. Parameterverhalten: - erforderlich |
| Grundfarbe | 1 | columns.0.base_color | Hexadezimaler Farbcode (z. B. FF0000).Parameterverhalten: - erforderlich |
Datenpunktwert
Die folgenden Parameter werden unterstützt, wenn Daten auf „Datenpunktwert“ gesetzt ist.
Die erste Zahl im Namen der Eigenschaft Schwellenwerte (z. B. columnsthresholds.0.color.0) verweist auf die Spalte, für die Schwellenwerte konfiguriert sind, während die zweite Zahl auf die Position des Schwellenwerts in einer aufsteigend sortierten Liste verweist.
Wenn Schwellenwerte jedoch in einer anderen Reihenfolge konfiguriert werden, werden die Werte nach der Aktualisierung der Widget-Konfiguration im Zabbix Frontend aufsteigend sortiert (z. B. "threshold.0.threshold":"5" → "threshold.0.threshold":"1"; "threshold.1.threshold":"1" → "threshold.1.threshold": "5").
| Parameter | type | name | value | |
|---|---|---|---|---|
| Datenpunkt | 1 | columns.0.item | Gültiger Datenpunktname. Bei der Konfiguration des Widgets in einem Vorlagen-Dashboard dürfen nur Datenpunkte festgelegt werden, die auf der Vorlage konfiguriert sind. |
|
| Datenpunktwert anzeigen als | 0 | columns.0.display_value_as | 0 - (Standard) Numerisch; 1 - Text; 2 - Binär. |
|
| Anzeige | 0 | columns.0.display | 1 - (Standard) Wie vorhanden; 2 - Balken; 3 - Indikatoren; 6 - Sparkline. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ gesetzt ist |
|
| Min | 1 | columns.0.min | Beliebiger numerischer Wert. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Balken“ oder „Indikatoren“ gesetzt ist |
|
| Max | 1 | columns.0.max | Beliebiger numerischer Wert. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Balken“ oder „Indikatoren“ gesetzt ist |
|
| Dezimalstellen | 0 | columns.0.decimal_places | Mögliche Werte liegen zwischen 0 und 10. Standard: 2. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ gesetzt ist |
|
| Sparkline | ||||
| Breite | 0 | columns.0.sparkline.width | Mögliche Werte liegen zwischen 0 und 10. Standard: 1. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist |
|
| Füllung | 0 | columns.0.sparkline.fill | Mögliche Werte liegen zwischen 0 und 10. Standard: 3. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist |
|
| Farbe | 1 | columns.0.sparkline.color | Hexadezimaler Farbcode (z. B. FF0000).Standard: 42A5F5.Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist |
|
| Zeitraum | 1 | columns.0.sparkline.time_period._reference | DASHBOARD._timeperiod - den Zeitraumauswahlschalter als Datenquelle festlegen;ABCDE._timeperiod - ein kompatibles Widget (mit dem Parameter reference gleich ABCDE) als Datenquelle festlegen.Standard: DASHBOARD._timeperiodAlternativ können Sie den Zeitraum nur in den Parametern Von und Bis festlegen. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist |
|
| Von | 1 | columns.0.sparkline.time_period.from | Gültige Zeitangabe in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist - erforderlich, wenn columns.0.sparkline.time_period.to festgelegt ist |
|
| Bis | 1 | columns.0.sparkline.time_period.to | Gültige Zeitangabe in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist - erforderlich, wenn columns.0.sparkline.time_period.from festgelegt ist |
|
| Verlaufsdaten | 0 | columns.0.sparkline.history | 0 - (Standard) Automatisch; 1 - Verlauf; 2 - Trends. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ und Anzeige auf „Sparkline“ gesetzt ist |
|
| Schwellenwerte | ||||
| Farbe | 1 | columnsthresholds.0.color.0 | Hexadezimaler Farbcode (z. B. FF0000).Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ gesetzt ist |
|
| Schwellenwert | 1 | columnsthresholds.0.threshold.0 | Beliebiger Zeichenfolgenwert. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ gesetzt ist |
|
| Hervorhebungen | ||||
| Farbe | 1 | columns.0.highlights.0.color | Hexadezimaler Farbcode (z. B. FF0000).Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Text“ gesetzt ist |
|
| Muster | 1 | columns.0.highlights.0.pattern | Beliebiger Zeichenfolgenwert. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Text“ gesetzt ist |
|
| Miniaturansicht anzeigen | 0 | columns.0.show_thumbnail | 0 - (Standard) Deaktiviert; 1 - Aktiviert. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Binär“ gesetzt ist |
|
| Aggregationsfunktion | 0 | columns.0.aggregate_function | 0 - (Standard) nicht verwendet; 1 - min; 2 - max; 3 - avg; 4 - count; 5 - sum; 6 - first; 7 - last. |
|
| Zeitraum | 1 | columns.0.time_period._reference | DASHBOARD._timeperiod - den Zeitraumauswahlschalter als Datenquelle festlegen;ABCDE._timeperiod - ein kompatibles Widget (mit dem Parameter reference gleich ABCDE) als Datenquelle festlegen.Standard: DASHBOARD._timeperiodAlternativ können Sie den Zeitraum nur in den Parametern Von und Bis festlegen. Parameterverhalten: - unterstützt, wenn Aggregationsfunktion auf „min“, „max“, „avg“, „count“, „sum“, „first“ oder „last“ gesetzt ist |
|
| Von | 1 | columns.0.time_period.from | Gültige Zeitangabe in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).Parameterverhalten: - unterstützt, wenn Zeitraum nicht festgelegt und Aggregationsfunktion auf „min“, „max“, „avg“, „count“, „sum“, „first“ oder „last“ gesetzt ist - erforderlich, wenn columns.0.time_period.to festgelegt ist- erforderlich, wenn columns.0.time_period.to festgelegt ist |
|
| Bis | 1 | columns.0.time_period.to | Gültige Zeitangabe in absoluter (YYYY-MM-DD hh:mm:ss) oder relativer Zeitsyntax (now, now/d, now/w-1w usw.).Parameterverhalten: - unterstützt, wenn Zeitraum nicht festgelegt und Aggregationsfunktion auf „min“, „max“, „avg“, „count“, „sum“, „first“ oder „last“ gesetzt ist - erforderlich, wenn columns.0.time_period.from festgelegt ist |
|
| Verlaufsdaten | 0 | columns.0.history | 0 - (Standard) Automatisch; 1 - Verlauf; 2 - Trends. Parameterverhalten: - unterstützt, wenn Datenpunktwert anzeigen als auf „Numerisch“ gesetzt ist |
|
| Referenz | 1 | reference | Beliebiger Zeichenfolgenwert aus 5 Zeichen (z. B. ABCDE oder JBPNL). Dieser Wert muss innerhalb des Dashboards, zu dem das Widget gehört, eindeutig sein.Parameterverhalten: - erforderlich |
|
Text
Die folgenden Parameter werden unterstützt, wenn Data auf „Text“ gesetzt ist.
| Parameter | type | name | value |
|---|---|---|---|
| Text | 1 | columns.0.text | Beliebiger Zeichenfolgenwert, einschließlich Makros. Unterstützte Makros: {HOST.*}, {INVENTORY.*}. Parameterverhalten: - erforderlich, wenn Data auf „Text“ gesetzt ist |
Beispiele
Die folgenden Beispiele beschreiben nur die Konfiguration der Feldobjekte des Dashboard-Widgets für das Top hosts Widget.
Für weitere Informationen zur Konfiguration eines Dashboards siehe dashboard.create.
Konfigurieren eines Widgets Top hosts
Konfigurieren Sie ein Widget Top hosts, das die Top-Hosts nach CPU-Auslastung in der Host-Gruppe „4“ anzeigt. Konfigurieren Sie außerdem die folgenden benutzerdefinierten Spalten: „Host-Name“, „CPU-Auslastung in %“, „1m-Durchschnitt“, „5m-Durchschnitt“, „15m-Durchschnitt“, „Prozesse“.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "tophosts",
"name": "Top hosts",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 4
},
{
"type": 1,
"name": "columns.0.name",
"value": "Host"
},
{
"type": 0,
"name": "columns.0.data",
"value": 2
},
{
"type": 1,
"name": "columns.0.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.1.name",
"value": "CPU utilization in %"
},
{
"type": 0,
"name": "columns.1.data",
"value": 1
},
{
"type": 1,
"name": "columns.1.base_color",
"value": "4CAF50"
},
{
"type": 1,
"name": "columns.1.item",
"value": "CPU utilization"
},
{
"type": 0,
"name": "columns.1.display",
"value": 3
},
{
"type": 1,
"name": "columns.1.min",
"value": "0"
},
{
"type": 1,
"name": "columns.1.max",
"value": "100"
},
{
"type": 1,
"name": "columnsthresholds.1.color.0",
"value": "FFFF00"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.0",
"value": "50"
},
{
"type": 1,
"name": "columnsthresholds.1.color.1",
"value": "FF8000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.1",
"value": "80"
},
{
"type": 1,
"name": "columnsthresholds.1.color.2",
"value": "FF4000"
},
{
"type": 1,
"name": "columnsthresholds.1.threshold.2",
"value": "90"
},
{
"type": 1,
"name": "columns.2.name",
"value": "1m avg"
},
{
"type": 0,
"name": "columns.2.data",
"value": 1
},
{
"type": 1,
"name": "columns.2.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.2.item",
"value": "Load average (1m avg)"
},
{
"type": 1,
"name": "columns.3.name",
"value": "5m avg"
},
{
"type": 0,
"name": "columns.3.data",
"value": 1
},
{
"type": 1,
"name": "columns.3.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.3.item",
"value": "Load average (5m avg)"
},
{
"type": 1,
"name": "columns.4.name",
"value": "15m avg"
},
{
"type": 0,
"name": "columns.4.data",
"value": 1
},
{
"type": 1,
"name": "columns.4.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.4.item",
"value": "Load average (15m avg)"
},
{
"type": 1,
"name": "columns.5.name",
"value": "Processes"
},
{
"type": 0,
"name": "columns.5.data",
"value": 1
},
{
"type": 1,
"name": "columns.5.base_color",
"value": "FFFFFF"
},
{
"type": 1,
"name": "columns.5.item",
"value": "Number of processes"
},
{
"type": 0,
"name": "columns.5.decimal_places",
"value": 0
},
{
"type": 0,
"name": "column",
"value": 1
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Antwort:
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}