Documentation
Table of Contents
> Dashboard object
Następujące obiekty są bezpośrednio związane z API dashboard.
Dashboard
Obiekt dashboard zawiera następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| dashboardid | string | (tylko do odczytu) ID pulpitu. |
| name (wymagane) |
string | Nazwa pulpitu. |
| userid | string | ID użytkownika właściciela pulpitu. |
| private | integer | Typ udostępniania pulpitu. Możliwe wartości: 0 - publiczny pulpit; 1 - (domyślnie) prywatny pulpit. |
| display_period | integer | Domyślny okres wyświetlania strony (w sekundach). Możliwe wartości: 10, 30, 60, 120, 600, 1800, 3600. Domyślnie: 30. |
| auto_start | integer | Automatycznie uruchom pokaz slajdów. Możliwe wartości: 0 - nie uruchamiaj automatycznego pokazu slajdów; 1 - (domyślnie) automatycznie uruchamian pokaz slajdów. |
Należy zauważyć, że w przypadku niektórych metod (aktualizacja, usuwanie) wymagana/opcjonalna kombinacja parametrów jest inna.
Dashboard page
Obiekt dashboard posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| dashboard_pageid | string | (tylko do odczytu) ID strony pulpitu. |
| name | string | Nazwa strony pulpitu. Domyślnie: pusty ciąg znaków. |
| display_period | integer | Okres wyświetlania strony pulpitu (w sekundach). Możliwe wartości: 0, 10, 30, 60, 120, 600, 1800, 3600. Domyślnie: 0 (użyje domyślnego okresu wyświetlania strony). |
| widgets | array | Tablica obiektów widżetów pulpitu. |
Dashboard widget
Obiekt dashboard widget posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| widgetid | string | (tylko do odczytu) ID widżetu pulpitu. |
| type (wymagany) |
string | Typ widżetu pulpitu. Możliwe wartości: actionlog - Log akcji; clock - Zegar; (przestarzałe) dataover - Przegląd danych; discovery - Stan wykrywania; favgraphs - Ulubione wykresy; favmaps - Ulubione mapy; geomap - Geomapa; graph - Wykres (klasyczny); graphprototype - Prototyp wykresu; hostavail - Dostępność hosta; item - Wartość pozycji; map - Mapa; navtree - Drzewo nawigacyjne mapy; plaintext - Zwykły tekst; problemhosts - Problemy hostów; problems - Problemy; problemsbysv - Stopień problemu; slareport - Raport SLA; svggraph - Wykres; systeminfo - Informacje o systemie; tophosts - TOP hosty; trigover - Przegląd wyzwalaczy; url - URL; web - Monitorowanie WWW. |
| name | string | Niestandardowa nazwa widżetu. |
| x | integer | Pozycja pozioma od lewej strony pulpitu. Prawidłowe wartości mieszczą się w zakresie od 0 do 23. |
| y | integer | Pozycja pionowa od góry strony pulpitu. Prawidłowe wartości mieszczą się w zakresie od 0 do 62. |
| width | integer | Szerokość widżetu. Prawidłowe wartości mieszczą się w zakresie od 1 do 24. |
| height | integer | Wysokość widżetu. Prawidłowe wartości mieszczą się w zakresie od 2 do 32. |
| view_mode | integer | Tryb widoku widżetu. Możliwe wartości: 0 - (domyślnie) ddomyślny widok widżetu; 1 - z ukrytym nagłówkiem; |
| fields | array | Tablica obiektów pól widżetu pulpitu. Wymagane w przypadku określonych widżetów; zobacz poszczególne widżety w polach widżetów panelu kontrolnego. |
Dashboard widget field
Obiekt dashboard widget field posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Typ pola widżetu. Możliwe wartości: 0 - liczba całkowita; 1 - Ciąg znaków; 2 - Grupa hostów; 3 - Host; 4 - Pozycja; 5 - Prototyp pozycji; 6 - Wykres; 7 - Prototyp wykresu; 8 - Mapa; 9 - Usługa; 10 - SLA. |
| name (wymagane) |
string | Nazwa pola widżetu. Możliwe wartości: zobacz pola widżetów pulpitu. |
| value (wymagane) |
mixed | Wartość pola widżetu w zależności od typu. Możliwe wartości: zobacz pola widżetów pulpitu. |
Dashboard user group
Lista uprawnień pulpitu na podstawie grup użytkowników. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| usrgrpid (wymagane) |
string | ID grupy użytkowników. |
| permission (wymagane) |
integer | Typ poziomu uprawnień. Możliwe wartości: 2 -tylko do odczytu; 3 - do odczytu i zapisu; |
Dashboard user
Lusta uprawnień pulpitu na podstawie użytkowników. Posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| userid (wymagane) |
string | ID użytkownika. |
| permission (wymagane) |
integer | Typ poziomu uprawnień. Możliwe wartości: 2 - tylko do odczytu; 3 - do odczytu i zapisu; |