Dashboard-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der dashboard API.

Dashboard

Das Dashboard-Objekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
dashboardid ID ID des Dashboards.

Verhalten der Eigenschaft:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
name string Name des Dashboards.

Verhalten der Eigenschaft:
- erforderlich für Erstellungsvorgänge
userid ID ID des Benutzers, der Eigentümer des Dashboards ist.
private integer Typ der Dashboard-Freigabe.

Mögliche Werte:
0 - öffentliches Dashboard;
1 - (Standard) privates Dashboard.
display_period integer Standard-Anzeigezeitraum der Seite (in Sekunden).

Mögliche Werte: 10, 30, 60, 120, 600, 1800, 3600.

Standard: 30.
auto_start integer Diashow automatisch starten.

Mögliche Werte:
0 - Diashow nicht automatisch starten;
1 - (Standard) Diashow automatisch starten.

Dashboard-Seite

Das Objekt der Dashboard-Seite hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
dashboard_pageid ID ID der Dashboard-Seite.

Verhalten der Eigenschaft:
- schreibgeschützt
name string Name der Dashboard-Seite.

Standard: leerer String.
display_period integer Anzeigedauer der Dashboard-Seite (in Sekunden).

Mögliche Werte: 0, 10, 30, 60, 120, 600, 1800, 3600.

Standard: 0 (verwendet die Standard-Anzeigedauer der Seite).
widgets array Array von Objekten des Typs Dashboard-Widget.

Dashboard-Widget

Das Dashboard-Widget-Objekt hat die folgenden Eigenschaften.

Property Type Description
widgetid ID ID des Dashboard-Widgets.

Property behavior:
- read-only
type string Typ des Dashboard-Widgets.

Mögliche Werte:
actionlog - Aktionsprotokoll;
clock - Uhr;
discovery - Erkennungsstatus;
favgraphs - Favoriten-Diagramme;
favmaps - Favoriten-Karten;
gauge - Messanzeige;
geomap - Geomap;
graph - Diagramm (klassisch);
graphprototype - Diagrammvorlage;
honeycomb - Honeycomb;
hostavail - Host-Verfügbarkeit;
hostcard - Host-Karte;
hostnavigator - Host-Navigator;
itemcard - Datenpunkt-Karte;
itemhistory - Datenpunktverlauf;
itemnavigator - Datenpunkt-Navigator;
item - Datenpunktwert;
map - Karte;
navtree - Karten-Navigationstree;
piechart - Kreisdiagramm;
problemhosts - Problem-Hosts;
problems - Probleme;
problemsbysv - Probleme nach Schweregrad;
slareport - SLA-Bericht;
svggraph - Diagramm;
systeminfo - Systeminformationen;
tophosts - Top-Hosts;
topitems - Top-Datenpunkte;
toptriggers - Top-Auslöser;
trigover - Auslöserübersicht;
url - URL;
web - Webüberwachung.

Property behavior:
- required
name string Benutzerdefinierter Name des Widgets.
x integer Eine horizontale Position von der linken Seite des Dashboards.

Mögliche Werte liegen zwischen 0 und 71.
y integer Eine vertikale Position von der Oberseite des Dashboards.

Mögliche Werte liegen zwischen 0 und 63.
width integer Die Breite des Widgets.

Mögliche Werte liegen zwischen 1 und 72.
height integer Die Höhe des Widgets.

Mögliche Werte liegen zwischen 1 und 64.
view_mode integer Der Ansichtsmodus des Widgets.

Mögliche Werte:
0 - (Standard) Standardansicht des Widgets;
1 - mit ausgeblendeter Kopfzeile;
fields array Array der Objekte vom Typ Dashboard-Widget-Feld.

Property behavior:
- siehe einzelne Widgets in Dashboard-Widget-Felder
Dashboard-Widget-Feld

Das Dashboard-Widget-Feldobjekt hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
type integer Typ des Widget-Feldes.

Mögliche Werte:
0 - Ganzzahl;
1 - Zeichenfolge;
2 - Host-Gruppe;
3 - Host;
4 - Datenpunkt;
5 - Datenpunkt-Prototyp;
6 - Graph;
7 - Graph-Prototyp;
8 - Karte;
9 - Service;
10 - SLA;
11 - Benutzer;
12 - Aktion;
13 - Medientyp.

Verhalten der Eigenschaft:
- erforderlich
name string Name des Widget-Feldes.

Mögliche Werte: siehe Dashboard-Widget-Felder.

Verhalten der Eigenschaft:
- erforderlich
value mixed Wert des Widget-Feldes abhängig vom Typ.

Mögliche Werte: siehe Dashboard-Widget-Felder.

Verhalten der Eigenschaft:
- erforderlich

Dashboard-Benutzergruppe

Liste der Dashboard-Berechtigungen basierend auf Benutzergruppen. Sie hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
usrgrpid ID ID der Benutzergruppe.

Property behavior:
- required
permission integer Typ der Berechtigungsstufe.

Mögliche Werte:
2 - schreibgeschützt;
3 - Lesen und Schreiben.

Property behavior:
- required

Dashboard-Benutzer

Liste der Dashboard-Berechtigungen basierend auf Benutzern. Sie hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
userid ID ID des Benutzers.

Verhalten der Eigenschaft:
- erforderlich
permission integer Typ der Berechtigungsstufe.

Mögliche Werte:
2 - schreibgeschützt;
3 - Lesen und Schreiben.

Verhalten der Eigenschaft:
- erforderlich