6 Pegel

Beschreibung

Diese Parameter und die möglichen Eigenschaftswerte für die jeweiligen Dashboard-Widget-Feldobjekte ermöglichen die Konfiguration des Widgets Gauge in den Methoden dashboard.create und dashboard.update.

Die Eigenschaften von Widget-fields werden bei der Erstellung oder Aktualisierung eines Dashboards nicht validiert. Dies ermöglicht es Benutzern, integrierte Widgets zu ändern und benutzerdefinierte Widgets zu erstellen, birgt jedoch auch das Risiko, Widgets fehlerhaft zu erstellen oder zu aktualisieren. Um die erfolgreiche Erstellung oder Aktualisierung des Widgets Gauge sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Verhalten der Parameter.

Parameter

Die folgenden Parameter werden für das Gauge-Widget 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.
Datenpunkt 4 itemid.0 ID des Datenpunkts.

Parameterverhalten:
- erforderlich, wenn Datenpunkt (Widget) nicht gesetzt ist
Datenpunkt (Widget) 1 itemid._reference Anstelle der ID des Datenpunkts:
ABCDE._itemid - legt ein kompatibles Widget (mit dem auf "ABCDE" gesetzten Parameter Referenz) als Datenquelle für Datenpunkte fest.

Parameterverhalten:
- erforderlich, wenn Datenpunkt nicht gesetzt ist
Min 1 min Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt.

Standard: "0".
Max 1 max Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt.

Standard: "100".
Wertbogen 1 value_arc_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Bogenhintergrund 1 empty_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Hintergrund 1 bg_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Anzeigen 0 show.0 1 - Beschreibung;
2 - Wert;
3 - Zeiger;
4 - Skala;
5 - Wertbogen.

Hinweis: Um mehrere Werte zu konfigurieren, erstellen Sie für jeden Wert ein Dashboard-Widget-Feldobjekt mit einer inkrementierten Nummer im Eigenschaftsnamen.

Standard: 1, 2, 4, 5.

Die Werte "Zeiger" und "Skala" werden nicht unterstützt, wenn beides zutrifft:
- kein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Wertbogen" gesetzt ist;
- der Parameter Bogen anzeigen der erweiterten Konfiguration auf "Deaktiviert" gesetzt ist.

Parameter der erweiterten Konfiguration für Anzeigen-Optionen werden nicht unterstützt, wenn keine Dashboard-Widget-Feldobjekte mit den jeweiligen Werten gesetzt sind.
Host überschreiben 1 override_hostid._reference ABCDE._hostid - legt ein kompatibles Widget (mit dem auf "ABCDE" gesetzten Parameter Referenz) als Datenquelle für Hosts fest;
DASHBOARD._hostid - legt die Host-Auswahl des Dashboards als Datenquelle für Hosts fest.

Dieser Parameter wird nicht unterstützt, wenn das Widget auf einem Vorlagen-Dashboard konfiguriert wird.

Erweiterte Konfiguration

Die folgenden erweiterten Konfigurationsparameter werden für das Messinstrument-Widget unterstützt.

Die Zahl im Eigenschaftsnamen Thresholds (z. B. thresholds.0.color) verweist auf die Position des Schwellenwerts in einer Liste, die in aufsteigender Reihenfolge sortiert ist. Wenn Schwellenwerte jedoch in einer anderen Reihenfolge konfiguriert werden, werden die Werte nach dem Aktualisieren der Widget-Konfiguration im Zabbix Frontend in aufsteigender Reihenfolge sortiert (z. B. "thresholds.0.threshold":"5""thresholds.0.threshold":"1"; "thresholds.1.threshold":"1""thresholds.1.threshold": "5").

Parameter type name value
Winkel 0 angle Mögliche Werte: 180 (Standard) oder 270.
Beschreibung
Beschreibung 1 description Beliebiger Zeichenfolgenwert, einschließlich Makros.
Unterstützte Makros: {HOST.*}, {ITEM.*}, {INVENTORY.*}, Benutzermakros.

Standard: {ITEM.NAME}.
Größe 0 desc_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 15.
Vertikale Position 0 desc_v_pos 0 - Oben;
1 - (Standard) Unten.
Fett 0 desc_bold 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Farbe 1 desc_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Wert
Dezimalstellen 0 decimal_places Mögliche Werte liegen im Bereich von 1-10.

Standard: 2.
Größe 0 value_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 25.
Fett 0 value_bold 0 - (Standard) Deaktiviert;
1 - Aktiviert.
Farbe 1 value_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Einheiten
Einheiten (Kontrollkästchen) 0 units_show 0 - Deaktiviert;
1 - (Standard) Aktiviert.
Einheiten (Wert) 1 units Beliebiger Zeichenfolgenwert.

Parameterverhalten:
- unterstützt, wenn Einheiten (Kontrollkästchen) auf "Aktiviert" gesetzt ist
Größe 0 units_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 25.

Parameterverhalten:
- unterstützt, wenn Einheiten (Kontrollkästchen) auf "Aktiviert" gesetzt ist
Fett 0 units_bold 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Einheiten (Kontrollkästchen) auf "Aktiviert" gesetzt ist
Position 0 units_pos 0 - Vor dem Wert;
1 - Über dem Wert;
2 - (Standard) Nach dem Wert;
3 - Unter dem Wert.

Parameterverhalten:
- unterstützt, wenn Einheiten (Kontrollkästchen) auf "Aktiviert" gesetzt ist

Dieser Parameter wird ignoriert, wenn er auf eine der folgenden zeitbezogenen Einheiten gesetzt ist: unixtime, uptime, s.
Farbe 1 units_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).
Wertbogen
Bogengröße 0 value_arc_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 20.
Zeiger
Farbe 1 needle_color Hexadezimaler Farbcode (z. B. FF0000).

Standard: "" (leer).

Parameterverhalten:
- unterstützt, wenn ein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Value arc" gesetzt ist oder Bogen anzeigen auf "Aktiviert" gesetzt ist
Skala
Einheiten anzeigen 0 scale_show_units 0 - Deaktiviert;
1 - (Standard) Aktiviert.

Parameterverhalten:
- unterstützt, wenn Einheiten (Kontrollkästchen) auf "Aktiviert" gesetzt ist und entweder ein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Value arc" gesetzt ist oder Bogen anzeigen auf "Aktiviert" gesetzt ist
Größe 0 scale_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 15.

Parameterverhalten:
- unterstützt, wenn ein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Value arc" gesetzt ist oder Bogen anzeigen auf "Aktiviert" gesetzt ist
Dezimalstellen 0 scale_decimal_places Mögliche Werte liegen im Bereich von 1-10.

Standard: 0.

Parameterverhalten:
- unterstützt, wenn ein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Value arc" gesetzt ist oder Bogen anzeigen auf "Aktiviert" gesetzt ist
Schwellenwerte
Farbe 1 thresholds.0.color Hexadezimaler Farbcode (z. B. FF0000).
Schwellenwert 1 thresholds.0.threshold Beliebiger numerischer Wert. Suffixe (z. B. "1d", "2w", "4K", "8G") werden unterstützt.
Beschriftungen anzeigen 0 th_show_labels 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Schwellenwerte gesetzt sind und entweder ein Dashboard-Widget-Feldobjekt für Anzeigen mit dem Wert "Value arc" gesetzt ist oder Bogen anzeigen auf "Aktiviert" gesetzt ist
Bogen anzeigen 0 th_show_arc 0 - (Standard) Deaktiviert;
1 - Aktiviert.

Parameterverhalten:
- unterstützt, wenn Schwellenwerte gesetzt sind
Bogengröße 0 th_arc_size Mögliche Werte liegen im Bereich von 1-100.

Standard: 5.

Parameterverhalten:
- unterstützt, wenn Bogen anzeigen auf "Aktiviert" gesetzt ist

Beispiele

Die folgenden Beispiele beschreiben nur die Konfiguration der Dashboard-Widget-Feldobjekte für das Gauge-Widget. Weitere Informationen zur Konfiguration eines Dashboards finden Sie unter dashboard.create.

Konfigurieren eines Gauge-Widgets

Konfigurieren Sie ein Gauge-Widget, das den Datenpunktwert für den Datenpunkt „44474“ (Schnittstelle enp0s3: Gesendete Bits) anzeigt. Zusätzlich können Sie das Widget mit mehreren erweiterten Optionen, einschließlich Schwellenwerten, visuell feinabstimmen.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "gauge",
                        "name": "Gauge",
                        "x": 0,
                        "y": 0,
                        "width": 18,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 44474
                            },
                            {
                                "type": 1,
                                "name": "min",
                                "value": "100000"
                            },
                            {
                                "type": 1,
                                "name": "max",
                                "value": "1000000"
                            },
                            {
                                "type": 0,
                                "name": "show.0",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "show.1",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "show.2",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "show.4",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "show.5",
                                "value": 5
                            },
                            {
                                "type": 0,
                                "name": "angle",
                                "value": 270
                            },
                            {
                                "type": 0,
                                "name": "desc_size",
                                "value": 10
                            },
                            {
                                "type": 0,
                                "name": "desc_bold",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "decimal_places",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "value_bold",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "units_size",
                                "value": 15
                            },
                            {
                                "type": 0,
                                "name": "units_pos",
                                "value": 3
                            },
                            {
                                "type": 1,
                                "name": "needle_color",
                                "value": "3C3C3C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.color",
                                "value": "FF465C"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.0.threshold",
                                "value": "700000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.color",
                                "value": "FFD54F"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.1.threshold",
                                "value": "500000"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.color",
                                "value": "0EC9AC"
                            },
                            {
                                "type": 1,
                                "name": "thresholds.2.threshold",
                                "value": "100000"
                            },
                            {
                                "type": 0,
                                "name": "th_show_labels",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "th_show_arc",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "th_arc_size",
                                "value": 15
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Siehe auch