Documentation
Table of Contents
> Map object
Poniższe obiekty są bezpośrednio powiązane z interfejsem API map.
Map
Obiekt Map posiada następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapid | string | (tylko do odczytu) ID mapy. |
| height (wymagane) |
integer | Wysokość mapy w pikselach. |
| name (wymagane) |
string | Nazwa mapy. |
| width (wymagane) |
integer | Szerokość mapy w pikselach. |
| backgroundid | string | ID obrazu używanego jako tło mapy. |
| expand_macros | integer | Czy rozwijać makra w etykietach podczas konfigurowania mapy. Możliwe wartości: 0 - (domyślnie) nie rozwijaj makr; 1 - rozwijaj makra. |
| expandproblem | integer | Czy problem wyzwalacza zostanie wyświetlony dla elementów z pojedynczym problemem. Możliwe wartości: 0 - zawsze wyświetlaj liczbę problemów; 1 - (domyślnie) wyświetlaj wyzwalacz problemu, jeśli jest tylko jeden problem. |
| grid_align | integer | Czy włączyć wyrównywanie do siatki. Możliwe wartości: 0 - wyłącz wyrównywanie do siatki; 1 - (domyślnie) włącz wyrównywanie do siatki. |
| grid_show | integer | Czy pokazać siatkę na mapie. Możliwe wartości: 0 - nie pokazuj siatki; 1 - (domyślnie) pokaż siatkę. |
| grid_size | integer | Rozmiar siatki mapy w pikselach. Obsługiwane wartości: 20, 40, 50, 75 i 100. Domyślnie: 50. |
| highlight | integer | Czy jest włączone podświetlanie ikon. Możliwe wartości: 0 - wyłączone podświetlanie; 1 - (domyślnie) włączone podświetlanie. |
| iconmapid | string | ID mapy ikon używanej na mapie. |
| label_format | integer | Czy włączyć zaawansowane etykiety. Możliwe wartości: 0 - (domyślnie) wyłącz zaawansowane etykiety; 1 - włącz zaawansowane etykiety. |
| label_location | integer | Lokalizacja etykiety elementu mapy. Możliwe wartości: 0 - (domyślnie) na dole; 1 - z lewej; 2 - z prawej; 3 - na górze. |
| label_string_host | string | Niestandardowa etykieta dla elementów hosta. Wymagana dla map z niestandardowym typem etykiety hosta. |
| label_string_hostgroup | string | Niestandardowa etykieta dla elementów grupy hostów. Wymagana dla map z niestandardowym typem etykiety grupy hostów. |
| label_string_image | string | Niestandardowa etykieta dla elementów obrazu. Wymagana dla map z niestandardowym typem etykiety obrazu. |
| label_string_map | string | Niestandardowa etykieta dla elementów mapy. Wymagana dla map z niestandardowym typem etykiety mapy. |
| label_string_trigger | string | Niestandardowa etykieta dla elementów wyzwalacza. Wymagana dla map z niestandardowym typem etykiety wyzwalacza. |
| label_type | integer | Typ etykiety elementu mapy. Możliwe wartości: 0 - etykieta; 1 - adres IP; 2 - (domyślnie) nazwa elementu; 3 - tylko stan; 4 - nic. |
| label_type_host | integer | Typ etykiety dla elementów hosta. Możliwe wartości: 0 - etykieta; 1 - adres IP; 2 - (domyślnie) nazwa elementu; 3 - tylko stan; 4 - nic; 5 - własna etykieta. |
| label_type_hostgroup | integer | Typ etykiety dla elementów grupy hostów. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 3 - tylko stan; 4 - nic; 5 - własna etykieta. |
| label_type_image | integer | Typ etykiety dla elementów obrazu. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 4 - nic; 5 - własna etykieta. |
| label_type_map | integer | Typ etykiety dla elementów mapy. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 3 - tylko stan; 4 - nic; 5 - własna etykieta. |
| label_type_trigger | integer | Typ etykiety dla elementów wyzwalacza. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 3 - tylko stan; 4 - nic; 5 - własna etykieta. |
| markelements | integer | Czy podświetlać elementy mapy, które niedawno zmieniły swój status. Możliwe wartości: 0 - (domyślnie) nie podświetlaj elementów; 1 - podświetlaj elementy. |
| severity_min | integer | Minimalny poziom wyzwalaczy, które zostaną wyświetlone na mapie. Odnosząc się do właściwości "severity" wyzwalacza aby uzyskać listę obsługiwanych poziomów wyzwalaczy. |
| show_unack | integer | Sposób wyświetlania problemów. Możliwe wartości: 0 - (domyślnie) wyświetl liczbę wszystkich problemów; 1 - wyświetl tylko liczbę niezpotwierdzonych problemów; 2 - wyświetl liczbę potwierdzonych i niepotwierdzonych problemów oddzielnie. |
| userid | string | ID użytkownika właściciela mapy. |
| private | integer | Typ udostępniania mapy. Możliwe wartości: 0 - mapa publiczna; 1 - (domyślnie) mapa prywatna. |
| show_suppressed | integer | Czy pokazywać wstrzymane problemy. Możliwe wartości: 0 - (domyślnie) ukryj wstrzymane problemy; 1 - pokaż wstrzymane problemy. |
Zauważ, że dla niektórych metod (update, delete) kombinacja wymaganych/opcjonalnych parametrów jest różna.
Map element
Obiekt Map element definiuje element wyświetlany na mapie. Posiada on następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| selementid | string | (tylko do odczytu) ID elementu mapy. |
| elements (wymagane) |
array | Obiekt danych elementu. Wymagane dla elementów typu host, grupa hostów, wyzwalacz i mapa. |
| elementtype (wymagane) |
integer | Typ elementu mapy. Możliwe wartości: 0 - host; 1 - mapa; 2 - wyzwalacz; 3 - grupa hostów; 4 - obraz. |
| iconid_off (wymagane) |
string | ID obrazu używanego do wyświetlania elementu w stanie domyślnym. |
| areatype | integer | Sposób wyświetlania oddzielnych hostów grupy hostów. Możliwe wartości: 0 - (domyślnie) element grupy hostów zajmie całą mapę; 1 - element grupy hostów będzie miał ustaloną wielkość. |
| elementsubtype | integer | Sposób wyświetlania elementu grupy hostów na mapie. Możliwe wartości: 0 - (domyślnie) wyświetl grupę hostów jako pojedynczy element; 1 - wyświetl każdy host w grupie oddzielnie. |
| evaltype | integer | Metoda oceny warunku filtrowania znaczników elementu mapy. Możliwe wartości: 0 - (domyślnie) I / LUB; 2 - LUB. |
| height | integer | Wysokość ustalonego elementu grupy hostów w pikselach. Domyślnie: 200. |
| iconid_disabled | string | ID obrazu używanego do wyświetlania wyłączonych elementów mapy. Nie używane dla elementów obrazu. |
| iconid_maintenance | string | ID obrazu używanego do wyświetlania elementów mapy w trybie utrzymania. Nie używane dla elementów obrazu. |
| iconid_on | string | ID obrazu używanego do wyświetlania elementów mapy z problemami. Nie używane dla elementów obrazu. |
| label | string | Etykieta elementu. |
| label_location | integer | Lokalizacja etykiety elementu mapy. Możliwe wartości: -1 - (domyślnie) domyślna lokalizacja; 0 - na dole; 1 - z lewej; 2 - z prawej; 3 - na górze. |
| permission | integer | Typ poziomu uprawnień. Możliwe wartości: -1 - brak; 2 - tylko do odczytu; 3 - odczyt i zapis. |
| sysmapid | string | (tylko do odczytu) ID mapy, do której należy element. |
| urls | array | Adresy URL elementu mapy. Obiekt adresu URL elementu mapy jest opisany szczegółowo poniżej. |
| use_iconmap | integer | Czy należy użyć mapowania ikon dla elementów hosta. Możliwe wartości: 0 - nie używaj mapowania ikon; 1 - (domyślnie) używaj mapowania ikon. |
| viewtype | integer | Algorytm umieszczania elementu grupy hostów. Możliwe wartości: 0 - (domyślnie) siatka. |
| width | integer | Szerokość ustalonego elementu grupy hostów w pikselach. Domyślnie: 200. |
| x | integer | Współrzędne X elementu w pikselach. Domyślnie: 0. |
| y | integer | Współrzędne Y elementu w pikselach. Domyślnie: 0. |
Map element Host
Obiekt Map element Host definiuje jeden element hosta.
| Właściwość | Typ | Opis |
|---|---|---|
| hostid | string | ID hosta |
Map element Host group
Obiekt Map element Host group definiuje jeden element grupy hostów.
| Właściwość | Typ | Opis |
|---|---|---|
| groupid | string | ID grupy hostów |
Map element Map
Obiekt map element Map definiuje jeden element mapy.
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapid | string | ID mapy |
Map element Trigger
Obiekt map element Trigger definiuje jeden lub więcej elementów wyzwalacza.
| Właściwość | Typ | Opis |
|---|---|---|
| triggerid | string | ID wyzwalacza |
Map element tag
Obiekt Map element tag ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika elementu mapy. |
| operator | integer | Operator warunku znacznika elementu mapy. Możliwe wartości: 0 - (domyślne) Zawiera; 1 - Jest równy; 2 - Nie zawiera; 3 - Nie jest równy; 4 - Istnieje; 5 - Nie istnieje. |
| value | string | Wartość znacznika elementu mapy. |
Map element URL
Obiekt Map element URL definiuje klikalny link dostępny dla określonego elementu mapy. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapelementurlid | string | (tylko do odczytu) ID URL elementu mapy. |
| name (wymagane) |
string | Podpis linku. |
| url (wymagane) |
string | Adres URL linku. |
| selementid | string | ID elementu mapy, do którego należy URL. |
Map link
Obiekt Map link definiuje połączenie między dwoma elementami mapy. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| linkid | string | (tylko do odczytu) ID połączenia na mapie. |
| selementid1 (wymagane) |
string | ID pierwszego elementu mapy połączonego z jednego końca. |
| selementid2 (wymagane) |
string | ID pierwszego elementu mapy połączonego z drugiego końca. |
| color | string | Kolor linii jako kod szesnastkowy koloru. Domyślny: 000000. |
| drawtype | integer | Styl rysowania linii połączenia. Możliwe wartości: 0 - (domyślnie) linia; 2 - pogrubiona linia; 3 - linia kropkowana; 4 - linia kreskowana. |
| label | string | Etykieta połączenia. |
| linktriggers | array | Wywołania połączenia mapy do wykorzystania jako wskaźniki stanu połączenia. Obiekt wywołania połączenia mapy jest opisany szczegółowo poniżej. |
| permission | integer | Typ poziomu uprawnień. Możliwe wartości: -1 - brak; 2 - tylko do odczytu; 3 - odczyt i zapis. |
| sysmapid | string | ID mapy, do której należy połączenie. |
Map link trigger
Obiekt map link trigger definiuje wskaźnik stanu połączenia mapy oparty na stanie wyzwalacza. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| linktriggerid | string | (tylko do odczytu) ID wyzwalacza połączenia mapy. |
| triggerid (wymagane) |
string | ID wyzwalacza używanego jako wskaźnik połączenia. |
| color | string | Kolor wskaźnika jako kod szesnastkowy koloru. Domyślny: DD0000. |
| drawtype | integer | Styl rysowania wskaźnika. Możliwe wartości: 0 - (domyślnie) linia; 2 - pogrubiona linia; 3 - linia kropkowana; 4 - linia kreskowana. |
| linkid | string | ID połączenia mapy, do którego należy wyzwalacz połączenia. |
Map URL
Obiekt map URL definiuje klikalny link dostępny dla wszystkich elementów określonego typu na mapie. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapurlid | string | (tylko do odczytu) ID adresu URL mapy. |
| name (wymagane) |
string | Podpis linku. |
| url (wymagane) |
string | Adres URL linku. |
| elementtype | integer | Typ elementu mapy, dla którego będzie dostępny adres URL. Odwołaj się do właściwości "typ" elementu mapy dla listy obsługiwanych typów. Domyślnie: 0. |
| sysmapid | string | ID mapy, do której należy adres URL. |
Map user
Lista uprawnień do mapy na podstawie użytkowników. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapuserid | string | (tylko do odczytu) ID użytkownika mapy. |
| userid (wymagane) |
string | ID użytkownika. |
| permission (wymagane) |
integer | Typ poziomu uprawnień. Dopuszczalne wartości: 2 - tylko do odczytu; 3 - odczyt i zapis; |
Map user group
Lista uprawnień do mapy na podstawie grup użytkowników. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapusrgrpid | string | (tylko do odczytu) ID grupy użytkowników mapy. |
| usrgrpid (wymagane) |
string | ID grupy użytkowników. |
| permission (wymagane) |
integer | Typ poziomu uprawnień. Dopuszczalne wartości: 2 - tylko do odczytu; 3 - odczyt i zapis; |
Map shapes
Obiekt map shapes definiuje kształt geometryczny (z lub bez tekstu) wyświetlany na mapie. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmap_shapeid | string | (tylko do odczytu) ID elementu kształtu mapy. |
| type (wymagane) | integer | Typ elementu kształtu mapy. Dopuszczalne wartości: 0 - prostokąt; 1 - elipsa. Wymagana właściwość przy tworzeniu nowych kształtów. |
| x | integer | Współrzędne X kształtu w pikselach. Domyślnie: 0. |
| y | integer | Współrzędne Y kształtu w pikselach. Domyślnie: 0. |
| width | integer | Szerokość kształtu w pikselach. Domyślnie: 200. |
| height | integer | Wysokość kształtu w pikselach. Domyślnie: 200. |
| text | string | Tekst kształtu. |
| font | integer | Czcionka tekstu wewnątrz kształtu. Dopuszczalne wartości: 0 - Georgia, serif 1 - “Palatino Linotype”, “Book Antiqua”, Palatino, serif 2 - “Times New Roman”, Times, serif 3 - Arial, Helvetica, sans-serif 4 - “Arial Black”, Gadget, sans-serif 5 - “Comic Sans MS”, cursive, sans-serif 6 - Impact, Charcoal, sans-serif 7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif 8 - Tahoma, Geneva, sans-serif 9 - “Trebuchet MS”, Helvetica, sans-serif 10 - Verdana, Geneva, sans-serif 11 - “Courier New”, Courier, monospace 12 - “Lucida Console”, Monaco, monospace Domyślnie: 9. |
| font_size | integer | Rozmiar czcionki w pikselach. Domyślnie: 11. |
| font_color | string | Kolor czcionki. Domyślnie: '000000'. |
| text_halign | integer | Poziome wyrównanie tekstu. Dopuszczalne wartości: 0 - środek; 1 - z lewej; 2 - z prawej. Domyślnie: 0. |
| text_valign | integer | Pionowe wyrównanie tekstu. Dopuszczalne wartości: 0 - środek; 1 - na górze; 2 - na dole. Domyślnie: 0. |
| border_type | integer | Typ obramowania. Dopuszczalne wartości: 0 - brak; 1 - —————;2 - ·····;3 - - - -.Domyślnie: 0. |
| border_width | integer | Szerokość obramowania w pikselach. Domyślnie: 0. |
| border_color | string | Kolor obramowania. Domyślnie: '000000'. |
| background_color | string | Kolor tła (kolor wypełnienia). Domyślnie: (puste). |
| zindex | integer | Wartość używana do uporządkowania wszystkich kształtów i linii (indeks z). Domyślnie: 0. |
Map lines
Obiekt map lines definiuje linię wyświetlaną na mapie. Posiada następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmap_shapeid | string | (tylko do odczytu) ID elementu kształtu mapy. |
| x1 | integer | Współrzędne X punktu 1 linii w pikselach. Domyślnie: 0. |
| y1 | integer | Współrzędne Y punktu 1 linii w pikselach. Domyślnie: 0. |
| x2 | integer | Współrzędne X punktu 2 linii w pikselach. Domyślnie: 200. |
| y2 | integer | Współrzędne Y punktu 2 linii w pikselach. Domyślnie: 200. |
| line_type | integer | Typ linii. Dopuszczalne wartości: 0 - brak; 1 - —————;2 - ·····;3 - - - -.Domyślnie: 0. |
| line_width | integer | Szerokość linii w pikselach. Domyślnie: 0. |
| line_color | string | Kolor linii. Domyślnie: '000000'. |
| zindex | integer | Wartość używana do uporządkowania wszystkich kształtów i linii (indeks z). Domyślnie: 0. |