Obiekt mapy
Następujące obiekty są bezpośrednio powiązane z API map.
Mapa
Obiekt mapy ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapid | ID | ID mapy. Zachowanie właściwości: - tylko do odczytu - wymagane dla operacji aktualizacji |
| height | integer | Wysokość mapy w pikselach. Zachowanie właściwości: - wymagane dla operacji tworzenia |
| name | string | Nazwa mapy. Zachowanie właściwości: - wymagane dla operacji tworzenia |
| width | integer | Szerokość mapy w pikselach. Zachowanie właściwości: - wymagane dla operacji tworzenia |
| backgroundid | ID | ID obrazu używanego jako tło mapy. |
| background_scale | integer | Czy włączyć proporcjonalne skalowanie obrazu tła. Możliwe wartości: 0 - wyłącz skalowanie; 1 - (domyślnie) włącz skalowanie obrazu. |
| 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 wyzwalacz problemu będzie wyświetlany 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 istnieje 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 wyświetlać siatkę na mapie. Możliwe wartości: 0 - nie wyświetlaj siatki; 1 - (domyślnie) wyświetlaj 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 podświetlanie ikon jest włączone. Możliwe wartości: 0 - podświetlanie wyłączone; 1 - (domyślnie) podświetlanie włączone. |
| iconmapid | ID | 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 | Położenie etykiety elementu mapy. Możliwe wartości: 0 - (domyślnie) dół; 1 - lewo; 2 - prawo; 3 - góra. |
| label_string_host | string | Niestandardowa etykieta dla elementów typu host. Zachowanie właściwości: - wymagane, jeśli label_type_host jest ustawione na "custom" |
| label_string_hostgroup | string | Niestandardowa etykieta dla elementów grupy hostów. Zachowanie właściwości: - wymagane, jeśli label_type_hostgroup jest ustawione na "custom" |
| label_string_image | string | Niestandardowa etykieta dla elementów obrazu. Zachowanie właściwości: - wymagane, jeśli label_type_image jest ustawione na "custom" |
| label_string_map | string | Niestandardowa etykieta dla elementów mapy. Zachowanie właściwości: - wymagane, jeśli label_type_map jest ustawione na "custom" |
| label_string_trigger | string | Niestandardowa etykieta dla elementów wyzwalacza. Zachowanie właściwości: - wymagane, jeśli label_type_trigger jest ustawione na "custom" |
| label_type | integer | Typ etykiety elementu mapy. Możliwe wartości: 0 - etykieta; 1 - adres IP; 2 - (domyślnie) nazwa elementu; 3 - tylko status; 4 - nic. |
| label_type_host | integer | Typ etykiety dla elementów typu host. Możliwe wartości: 0 - etykieta; 1 - adres IP; 2 - (domyślnie) nazwa elementu; 3 - tylko status; 4 - nic; 5 - niestandardowa. |
| 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 status; 4 - nic; 5 - niestandardowa. |
| label_type_image | integer | Typ etykiety dla elementów grupy hostów. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 4 - nic; 5 - niestandardowa. |
| label_type_map | integer | Typ etykiety dla elementów mapy. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 3 - tylko status; 4 - nic; 5 - niestandardowa. |
| label_type_trigger | integer | Typ etykiety dla elementów wyzwalacza. Możliwe wartości: 0 - etykieta; 2 - (domyślnie) nazwa elementu; 3 - tylko status; 4 - nic; 5 - niestandardowa. |
| markelements | integer | Czy podświetlać elementy mapy, których status ostatnio się zmienił. Możliwe wartości: 0 - (domyślnie) nie podświetlaj elementów; 1 - podświetlaj elementy. |
| severity_min | integer | Minimalny poziom ważności wyzwalaczy, które będą wyświetlane na mapie. Zobacz właściwość severity wyzwalacza, aby uzyskać listę obsługiwanych poziomów ważności wyzwalaczy. |
| show_element_label | integer | Jak domyślnie wyświetlać etykiety elementów. Możliwe wartości: 0 - zawsze wyświetlaj; 1 - (domyślnie) ukrywaj automatycznie. |
| show_link_label | integer | Jak domyślnie wyświetlać etykiety łączy. Możliwe wartości: 0 - zawsze wyświetlaj; 1 - (domyślnie) ukrywaj automatycznie. |
| show_unack | integer | Jak mają być wyświetlane problemy. Możliwe wartości: 0 - (domyślnie) wyświetlaj liczbę wszystkich problemów; 1 - wyświetlaj tylko liczbę niepotwierdzonych problemów; 2 - wyświetlaj osobno liczbę potwierdzonych i niepotwierdzonych problemów. |
| userid | ID | ID użytkownika będącego właścicielem mapy. |
| private | integer | Typ udostępniania mapy. Możliwe wartości: 0 - mapa publiczna; 1 - (domyślnie) mapa prywatna. |
| show_suppressed | integer | Czy wyciszone problemy są wyświetlane. Możliwe wartości: 0 - (domyślnie) ukrywaj wyciszone problemy; 1 - wyświetlaj wyciszone problemy. |
Element mapy
Obiekt elementu mapy definiuje obiekt wyświetlany na mapie. Ma on następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| selementid | ID | ID elementu mapy. Zachowanie właściwości: - tylko do odczytu |
| elements | array | Obiekt danych elementu. Zachowanie właściwości: - wymagane, jeśli elementtype jest ustawione na "host", "map", "trigger" lub "host group" |
| elementtype | integer | Typ elementu mapy. Możliwe wartości: 0 - host; 1 - mapa; 2 - wyzwalacz; 3 - grupa hostów; 4 - obraz. Zachowanie właściwości: - wymagane |
| iconid_off | ID | ID obrazu używanego do wyświetlania elementu w stanie domyślnym. Zachowanie właściwości: - wymagane |
| 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ł stały rozmiar. |
| 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 | Warunek filtrowania tagów elementu mapy, metoda obliczania. Możliwe wartości: 0 - (domyślnie) And/Or; 2 - Or. |
| height | integer | Wysokość elementu grupy hostów o stałym rozmiarze w pikselach. Domyślnie: 200. |
| iconid_disabled | ID | ID obrazu używanego do wyświetlania wyłączonych elementów mapy. Zachowanie właściwości: - obsługiwane, jeśli elementtype jest ustawione na "host", "map", "trigger" lub "host group" |
| iconid_maintenance | ID | ID obrazu używanego do wyświetlania elementów mapy w konserwacji. Zachowanie właściwości: - obsługiwane, jeśli elementtype jest ustawione na "host", "map", "trigger" lub "host group" |
| iconid_on | ID | ID obrazu używanego do wyświetlania elementów mapy z problemami. Zachowanie właściwości: - obsługiwane, jeśli elementtype jest ustawione na "host", "map", "trigger" lub "host group" |
| label | string | Etykieta elementu. |
| label_location | integer | Położenie etykiety elementu mapy. Możliwe wartości: -1 - (domyślnie) położenie domyślne; 0 - dół; 1 - lewo; 2 - prawo; 3 - góra. |
| permission | integer | Typ poziomu uprawnień. Możliwe wartości: -1 - brak; 2 - tylko do odczytu; 3 - odczyt-zapis. |
| show_label | integer | Sposób wyświetlania etykiety elementu. Możliwe wartości: -1 - (domyślnie) domyślne ustawienie mapy; 0 - zawsze wyświetlaj; 1 - ukrywaj automatycznie. |
| sysmapid | ID | ID mapy, do której należy element. Zachowanie właściwości: - tylko do odczytu |
| urls | array | Adresy URL elementu mapy. Obiekt URL elementu mapy jest opisany szczegółowo poniżej. |
| use_iconmap | integer | Czy mapowanie ikon musi być używane dla elementów typu host. Możliwe wartości: 0 - nie używaj mapowania ikon; 1 - (domyślnie) używaj mapowania ikon. |
| viewtype | integer | Algorytm rozmieszczania elementu grupy hostów. Możliwe wartości: 0 - (domyślnie) siatka. |
| width | integer | Szerokość elementu grupy hostów o stałym rozmiarze w pikselach. Domyślnie: 200. |
| x | integer | Współrzędna X elementu w pikselach. Domyślnie: 0. |
| y | integer | Współrzędna Y elementu w pikselach. Domyślnie: 0. |
| zindex | integer | Wartość używana do porządkowania elementów mapy (z-index). Domyślnie: 0. |
Element mapy Host
Obiekt elementu mapy Host definiuje jeden element hosta.
| Właściwość | Typ | Opis |
|---|---|---|
| hostid | ID | ID hosta. |
Element mapy Grupa hostów
Obiekt elementu mapy Grupa hostów definiuje jeden element grupy hostów.
| Właściwość | Typ | Opis |
|---|---|---|
| groupid | ID | ID grupy hostów. |
Obiekt elementu mapy Map
Obiekt elementu mapy Map definiuje jeden element mapy.
| Właściwość | Type | Opis |
|---|---|---|
| sysmapid | ID | ID mapy. |
Wyzwalacz elementu mapy
Obiekt wyzwalacza elementu mapy definiuje jeden lub więcej elementów wyzwalacza.
| Właściwość | Type | Opis |
|---|---|---|
| triggerid | ID | ID wyzwalacza. |
Tag elementu mapy
Obiekt Tag elementu mapy ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag | string | Nazwa tagu elementu mapy. Zachowanie właściwości: - wymagane |
| operator | integer | Warunek operatora tagu elementu mapy. Możliwe wartości: 0 - (domyślnie) Zawiera; 1 - Równa się; 2 - Nie zawiera; 3 - Nie równa się; 4 - Istnieje; 5 - Nie istnieje. |
| value | string | Wartość tagu elementu mapy. |
URL elementu mapy
Obiekt URL elementu mapy definiuje klikalny link, który będzie dostępny dla określonego elementu mapy. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapelementurlid | ID | ID URL elementu mapy. Zachowanie właściwości: - tylko do odczytu |
| name | string | Podpis linku. Zachowanie właściwości: - wymagane |
| url | string | URL linku. Zachowanie właściwości: - wymagane |
| selementid | ID | ID elementu mapy, do którego należy URL. |
Łącze mapy
Obiekt łącza mapy definiuje połączenie między dwoma elementami mapy. Ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| linkid | ID | ID łącza mapy. Zachowanie właściwości: - tylko do odczytu |
| sysmapid | ID | ID mapy, do której należy łącze. |
| selementid1 | ID | ID pierwszego elementu mapy połączonego z jednej strony. Zachowanie właściwości: - wymagane |
| selementid2 | ID | ID pierwszego elementu mapy połączonego z drugiej strony. Zachowanie właściwości: - wymagane |
| drawtype | integer | Styl rysowania linii łącza. Możliwe wartości: 0 - (domyślnie) linia; 2 - linia pogrubiona; 3 - linia kropkowana; 4 - linia kreskowana. |
| color | string | Kolor linii jako szesnastkowy kod koloru. Domyślnie: 000000. |
| label | string | Etykieta łącza. |
| show_label | integer | Sposób wyświetlania etykiety łącza. Możliwe wartości: -1 - (domyślnie) domyślne ustawienie mapy; 0 - zawsze wyświetlaj; 1 - ukrywaj automatycznie. |
| indicator_type | integer | Wybór typu wskaźnika łącza. Możliwe wartości: 0 - (domyślnie) łącze statyczne; 1 - wyzwalacz; 2 - wartość pozycji. |
| linktriggers | array | Wyzwalacze łącza mapy używane jako wskaźniki stanu łącza. Obiekt wyzwalacza łącza mapy jest opisany szczegółowo poniżej. Zachowanie właściwości: - wymagane, jeśli indicator_type jest ustawione na "trigger" (1). |
| itemid | ID | ID pozycji. Zachowanie właściwości: - wymagane, jeśli indicator_type jest ustawione na "item value" (2). |
| highlights | array | Wyróżnienia łącza mapy używane jako wskaźniki stanu łącza. Obiekt wskaźników łącza mapy jest opisany szczegółowo poniżej. Zachowanie właściwości: - wymagane, jeśli indicator_type jest ustawione na "item value" (2). |
| thresholds | array | Progi łącza mapy używane jako wskaźniki stanu łącza. Obiekt wskaźników łącza mapy jest opisany szczegółowo poniżej. Zachowanie właściwości: - wymagane, jeśli indicator_type jest ustawione na "item value" (2). |
| permission | integer | Typ poziomu uprawnień. Możliwe wartości: -1 - brak; 2 - tylko do odczytu; 3 - odczyt-zapis. |
Wyzwalacz łącza mapy
Obiekt wyzwalacza łącza mapy definiuje wskaźnik stanu łącza mapy na podstawie stanu wyzwalacza. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| triggerid | ID | ID wyzwalacza używanego jako wskaźnik łącza. Zachowanie właściwości: - wymagane |
| color | string | Kolor wskaźnika jako szesnastkowy kod koloru. Domyślnie: DD0000. |
| drawtype | integer | Styl rysowania wskaźnika. Możliwe wartości: 0 - (domyślnie) linia; 2 - linia pogrubiona; 3 - linia kropkowana; 4 - linia przerywana. |
Wskaźniki łączy mapy
Obiekt wskaźników łączy mapy definiuje wskaźnik stanu łącza mapy na podstawie wartości pozycji. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| pattern | string | Wyrażenie regularne do porównania. Dostępne tylko dla wyróżnień. |
| sortorder | integer | Używane do definiowania kolejności sortowania wyróżnień. Dostępne tylko dla wyróżnień. |
| threshold | string | Wartość liczbowa do porównania. Dostępne tylko dla progów. |
| drawtype | integer | Styl rysowania wskaźnika. Możliwe wartości: 0 - (domyślnie) linia; 2 - linia pogrubiona; 3 - linia kropkowana; 4 - linia kreskowana. |
| color | string | Kolor wskaźnika jako szesnastkowy kod koloru. Domyślnie: DD0000.Zachowanie właściwości: - wymagane |
URL mapy
Obiekt URL mapy definiuje klikalny link, który będzie dostępny dla wszystkich elementów określonego typu na mapie. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapurlid | ID | ID URL mapy. Zachowanie właściwości: - tylko do odczytu |
| name | string | Podpis linku. Zachowanie właściwości: - wymagane |
| url | string | URL linku. Zachowanie właściwości: - wymagane |
| elementtype | integer | Typ elementu mapy, dla którego URL będzie dostępny. Listę obsługiwanych typów można znaleźć we właściwości type elementu mapy.Domyślnie: 0. |
| sysmapid | ID | ID mapy, do której należy URL. |
Użytkownik mapy
Lista uprawnień do mapy na podstawie użytkowników. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmapuserid | ID | ID użytkownika mapy. Zachowanie właściwości: - tylko do odczytu |
| userid | ID | ID użytkownika. Zachowanie właściwości: - wymagane |
| permission | integer | Typ poziomu uprawnień. Możliwe wartości: 2 - tylko do odczytu; 3 - odczyt-zapis. Zachowanie właściwości: - wymagane |
Grupa użytkowników mapy
Lista uprawnień do mapy opartych na grupach użytkowników. Ma następujące właściwości:
| Właściwość | Type | Opis |
|---|---|---|
| sysmapusrgrpid | ID | ID grupy użytkowników mapy. Property behavior: - tylko do odczytu |
| usrgrpid | ID | ID grupy użytkowników. Property behavior: - wymagane |
| permission | integer | Typ poziomu uprawnień. Możliwe wartości: 2 - tylko do odczytu; 3 - odczyt-zapis. Property behavior: - wymagane |
Kształty mapy
Obiekt kształtu mapy definiuje kształt geometryczny (z tekstem lub bez) wyświetlany na mapie. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmap_shapeid | ID | ID elementu kształtu mapy. Zachowanie właściwości: - tylko do odczytu |
| type | integer | Typ elementu kształtu mapy. Możliwe wartości: 0 - prostokąt; 1 - elipsa. Właściwość jest wymagana podczas tworzenia nowych kształtów. Zachowanie właściwości: - wymagane |
| 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. Możliwe 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. Możliwe wartości: 0 - środek; 1 - do lewej; 2 - do prawej. Domyślnie: 0. |
| text_valign | integer | Pionowe wyrównanie tekstu. Możliwe wartości: 0 - środek; 1 - góra; 2 - dół. Domyślnie: 0. |
| border_type | integer | Typ obramowania. Możliwe 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 porządkowania wszystkich kształtów i linii (z-index). Domyślnie: 0. |
Linie mapy
Obiekt linii mapy definiuje linię wyświetlaną na mapie. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| sysmap_shapeid | ID | ID elementu kształtu mapy. Zachowanie właściwości: - tylko do odczytu |
| 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. Możliwe 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 porządkowania wszystkich kształtów i linii (z-index). Domyślnie: 0. |