Documentation
Table of Contents
> Объект карты сети
Следующие объекты напрямую связаны с map API.
Карта сети
Объект карты сети имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| sysmapid | строка | (только чтение) ID карты сети. |
| height (требуется) |
целое число | Высота карты сети в пикселях. |
| name (требуется) |
строка | Имя карты сети. |
| width (требуется) |
целое число | Ширина карты сети в пикселях. |
| backgroundid | строка | ID изображения, которое используется в качестве фона на карте сети. |
| expand_macros | целое число | Необходимо ли раскрывать макросы в подписях при настройке карты сети. Возможные значения: 0 - (по умолчанию) не раскрывать макросы; 1 - раскрывать макросы. |
| expandproblem | целое число | Необходимо ли отображать проблемный триггер по всем элементам с единственной проблемой. Возможные значения: 0 - всегда отображать количество проблем; 1 - (по умолчанию) отображать проблемный триггер, если имеется только одна проблема. |
| grid_align | целое число | Требуется ли включить выравнивание по сетке. Возможные значения: 0 - отключение выравнивания по сетке; 1 - (по умолчанию) включение выравнивания по сетке. |
| grid_show | целое число | Требуется ли отображать сетку на карте. Возможные значения: 0 - не отображать сетку; 1 - (по умолчанию) отображать сетку. |
| grid_size | целое число | Размер сетки карты сети в пикселях. Возможные значения: 20, 40, 50, 75 и 100. По умолчанию: 50. |
| highlight | целое число | Необходимо ли активировать подсветку иконок. Возможные значения: 0 - подсветка отключена; 1 - (по умолчанию) подсветка включена. |
| iconmapid | строка | ID соответствия иконок, которое используется картой сети. |
| label_format | целое число | Необходимо ли активировать расширенные подписи. Возможные значения: 0 - (по умолчанию) расширенные подписи отключены; 1 - расширенные подписи включены. |
| label_location | целое число | Размещение подписи к элементу карты. Возможные значения: 0 - (по умолчанию) снизу; 1 - слева; 2 - справа; 3 - сверху. |
| label_string_host | строка | Пользовательская подпись к элементам узлов сети. Требуется для карт сетей с пользовательским типом подписей к узлам сети. |
| label_string_hostgroup | строка | Пользовательская подпись к элементам групп узлов сети. Требуется для карт сетей с пользовательским типом подписей к группам узлов сетей. |
| label_string_image | строка | Пользовательская подпись к элементам изображений. Требуется для карт сетей с пользовательским типом подписей к изображениям. |
| label_string_map | строка | Пользовательская подпись к элементам карт. Требуется для карт сетей с пользовательским типом подписей к картам. |
| label_string_trigger | строка | Пользовательская подпись к элементам триггеров. Требуется для карт сетей с пользовательским типом подписей к триггерам. |
| label_type | целое число | Тип подписи к элементам карт сетей. Возможные значения: 0 - подпись; 1 - IP адрес; 2 - (по умолчанию) имя элемента; 3 - только состояние; 4 - ничего. |
| label_type_host | целое число | Тип подписи к элементам узлов сетей. Возможные значения: 0 - подпись; 1 - IP адрес; 2 - (по умолчанию) имя элемента; 3 - только состояние; 4 - ничего; 5 - пользовательский. |
| label_type_hostgroup | целое число | Тип подписи к элементам групп узлов сетей. Возможные значения: 0 - подпись; 2 - (по умолчанию) имя элемента; 3 - только состояние; 4 - ничего; 5 - пользовательский. |
| label_type_image | целое число | Тип подписи к элементам изображений. Возможные значения: 0 - подпись; 2 - (по умолчанию) имя элемента; 4 - ничего; 5 - пользовательский. |
| label_type_map | целое число | Тип подписи к элементам карт сетей. Возможные значения: 0 - подпись; 2 - (по умолчанию) имя элемента; 3 - только состояние; 4 - ничего; 5 - пользовательский. |
| label_type_trigger | целое число | Тип подписи к элементам триггеров. Возможные значения: 0 - подпись; 2 - (по умолчанию) имя элемента; 3 - только состояние; 4 - ничего; 5 - пользовательский. |
| markelements | целое число | Требуется ли подсвечивать элементы карты сети, которые недавно изменили свое состояние. Возможные значения: 0 - (по умолчанию) не подсвечивать элементы; 1 - подсвечивать элементы. |
| severity_min | целое число | Минимальная важность триггеров, которые будут отображаться на карте сети. Обратитесь к свойству "severity" триггера для получения списка поддерживаемых важностей триггера. |
| show_unack | целое число | Каким образом отображать проблемы. Возможные значения: 0 - (по умолчанию) отображать количество всех проблем; 1 - отображать только количество неподтвержденных проблем; 2 - отображать количество подтвержденных и неподтвержденных проблем раздельно. |
| userid | строка | ID пользователя владельца карты сети. |
| private | целое число | Тип общего доступа карты сети. Возможные значения: 0 - публичная карта сети; 1 - (по умолчанию) приватная карта сети. |
| show_suppressed | целое число | Нужно ли отображать подавленные проблемы. Возможные значения: 0 - (по умолчанию) скрывать подавленные проблемы; 1 - отображать подавленные проблемы. |
Элемент карты
Объект элемента карты определяет отображаемый объект на карте сети. Этот объект имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| selementid | строка | (только чтение) ID элемента карты. |
| elements (требуется) |
массив | Объект данных элементов. Требуется для типов элементов узла сети, группы узлов сети, триггера и карты сети. |
| elementtype (требуется) |
целое число | Тип элемента карты. Возможные значения: 0 - узел сети; 1 - карта сети; 2 - триггер; 3 - группа узлов сети; 4 - изображение. |
| iconid_off (требуется) |
строка | ID изображения, которое используется для отображения элемента в состоянии по умолчанию. |
| areatype | целое число | Каким образом необходимо отображать разделение узлов сети групп узлов сети. Возможные значения: 0 - (по умолчанию) элемент группы узлов сети будет занимать всю карту сети; 1 - элемент группы узлов сети будет занимать фиксированный размер. |
| application | строка | Имя группы элементов данных из которой необходимо отображать проблемы. Используется только для элементов карты узла сети и группы узлов сети. |
| elementsubtype | целое число | Каким образом отображать элемент группы узлов сети на карте сети. Возможные значения: 0 - (по умолчанию) отображать группу узлов сети одним элементом; 1 - отображать каждый узел сети группы отдельно. |
| height | целое число | Высота фиксированного размера элемента группы узлов сети в пикселях. По умолчанию: 200. |
| iconid_disabled | строка | ID изображения, которое используется для отображения элемента в деактивированном состоянии. Не используется для элементов изображений. |
| iconid_maintenance | строка | ID изображения, которое используется для отображения элемента в состоянии обслуживания. Не используется для элементов изображений. |
| iconid_on | строка | ID изображения, которое используется для отображения элемента карты сети с имеющимися проблемами. Не используется для элементов изображений. |
| label | строка | Подпись к элементу. |
| label_location | целое число | Размещение подписи к элементу карты сети. Возможные значения: -1 - (по умолчанию) размещение по умолчанию; 0 - снизу; 1 - слева; 2 - справа; 3 - сверху. |
| permission | целое число | Тип уровня прав доступа. Возможные значения: -1 - отсутствуют; 2 - только чтение; 3 - чтение-запись. |
| sysmapid | строка | (только чтение) ID карты сети, которой принадлежит элемент. |
| urls | array | URL'ы элемента карты. Объект URL элемента карты детально описан ниже. |
| use_iconmap | целое число | Необходимо ли использовать соответствие иконок для элементов узлов сети. Возможные значения: 0 - не использовать соответствие иконок; 1 - (по умолчанию) использовать соответствие иконок. |
| viewtype | целое число | Алгоритм размещения элемента группы узлов сети. Возможные значения: 0 - (по умолчанию) сетка. |
| width | целое число | Ширина фиксированного размера элемента группы узлов сети в пикселях. По умолчанию: 200. |
| x | целое число | X-координата элемента в пикселях. По умолчанию: 0. |
| y | целое число | Y-координата элемента в пикселях. По умолчанию: 0. |
Элемент карты Узел сети
Объект элемента карты Узел сети задает один элемент узла сети.
| Свойство | Тип | Описание |
|---|---|---|
| hostid | строка | ID узла сети |
Элемент карты Группа узлов сети
Объект элемента карты Группы узлов сети задает один элемент группы узлов сети.
| Свойство | Тип | Описание |
|---|---|---|
| groupid | строка | ID группы узлов сети |
Элемент карты Карта сети
Объект элемента карты Карты сети задает один элемент карты сети.
| Свойство | Тип | Описание |
|---|---|---|
| sysmapid | строка | ID карты сети |
Элемент карты URL
Объект URL элемента карты задает нажимаемую ссылку, которая будет доступна определенному элементу карты сети. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| sysmapelementurlid | строка | (только чтение) ID URL элемента карты. |
| name (требуется) |
строка | Подпись к ссылке. |
| url (требуется) |
строка | URL ссылки. |
| selementid | строка | ID элемента карты, которому принадлежит URL. |
Связь карты
Объект связи карты задает связь между двумя элементами карты сети. Этот объект имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| linkid | строка | (только чтение) ID связи карты. |
| selementid1 (требуется) |
строка | ID первого элемента карты сети, присоединенного с одного конца. |
| selementid2 (требуется) |
строка | ID второго элемента карты сети, присоединенного с другого конца. |
| color | строка | Цвет линии в виде шестнадцатеричного кода цвета. По умолчанию: 000000. |
| drawtype | целое число | Стиль отрисовки линии связи. Возможные значения: 0 - (по умолчанию) линия; 2 - жирная линия; 3 - точечная линия; 4 - пунктирная линия. |
| label | строка | Подпись к связи. |
| linktriggers | массив | Триггеры связи на карте сети, которые используются в качестве индикатров состояния связи. Объект триггеров связи на карте сети детально описан ниже. |
| permission | целое число | Тип уровня прав доступа. Возможные значения: -1 - отсутствуют; 2 - только чтение; 3 - чтение-запись. |
| sysmapid | строка | ID карты сети, которой принадлежит связь. |
Триггера связи на карте
Объект триггера связи на карте задаёт индикатор состояния связи карты, основываясь на состоянии триггера. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| linktriggerid | строка | (только чтение) ID триггера связи на карте. |
| triggerid (требуется) |
строка | ID триггера, который используется индикатором связи. |
| color | строка | Цвет индикатора в виде шестнадцатеричного кода цвета. По умолчанию: DD0000. |
| drawtype | целое число | Стиль отрисовки индикатора. Возможные значения: 0 - (по умолчанию) линия; 2 - жирная линия; 3 - точечная линия; 4 - пунктирная линия. |
| linkid | строка | ID связи карты сети, которой принадлежит триггер связи. |
URL карты
Объект URL карты задает нажимаемую ссылку, которая становится доступной всем элементам определенного типа карты сети. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| sysmapurlid | строка | (только чтение) ID URL карты. |
| name (требуется) |
строка | Подпись к ссылке. |
| url (требуется) |
строка | URL ссылки. |
| elementtype | целое число | Тип элемента карты сети, которому будет доступен URL. Обратитесь к свойству "type" элемента карты для получения списка поддерживаемых типов. По умолчанию: 0. |
| sysmapid | строка | ID карты сети, которой принадлежит URL. |
Пользователь карты
Список прав доступа к карте сети основанный на пользователях. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| sysmapuserid | строка | (только чтение) ID пользователя карты. |
| userid (требуется) |
строка | ID пользователя. |
| permission (требуется) |
целое число | Тип уровня прав доступа. Возможные значения: 2 - только чтение; 3 - чтение-запись; |
Группа пользователей карты
Список прав доступа к карте сети основанный на группах пользователей. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| sysmapusrgrpid | строка | (только чтение) ID группы пользователей карты. |
| usrgrpid (требуется) |
строка | ID группы пользователей. |
| permission (требуется) |
целое число | Тип уровня прав доступа. Возможные значения: 2 - только чтение; 3 - чтение-запись; |
Фигуры карты
Объект фигуры карты задает геометрическую фигуру (с или без текста), которая отображается на карте сети. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| sysmap_shapeid | строка | (только чтение) ID элемента фигуры карты. |
| type (требуется) | целое число | Тип элемента фигуры карты. Возможные значения: 0 - прямоугольник; 1 - эллипс. Свойство требуется указывать при создании новых фигур. |
| x | целое число | X-координата фигуры в пикселях. По умолчанию: 0. |
| y | целое число | Y-координата фигуры в пикселях. По умолчанию: 0. |
| width | целое число | Ширина фигуры в пикселях. По умолчанию: 200. |
| height | целое число | Высота фигуры в пикселях. По умолчанию: 200. |
| text | строка | Текст к фигуре. |
| font | целое число | Шрифт текста внутри фигуры. Возможные значения: 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 По умолчанию: 9. |
| font_size | целое число | Размер шрифта в пикселях. По умолчанию: 11. |
| font_color | строка | Цвет шрифта. По умолчанию: '000000'. |
| text_halign | целое число | Выравнивание текста по горизонтали. Возможные значения: 0 - по центру; 1 - слева; 2 - справа. По умолчанию: 0. |
| text_valign | целое число | Выравнивание текста по вертикали. Возможные значения: 0 - по центру; 1 - сверху; 2 - снизу. По умолчанию: 0. |
| border_type | целое число | Тип рамки. Возможные значения: 0 - нет; 1 - —————;2 - ·····;3 - - - -.По умолчанию: 0. |
| border_width | целое число | Ширина рамки в пикселях. По умолчанию: 0. |
| border_color | строка | Цвет рамки. По умолчанию: '000000'. |
| background_color | строка | Цвет фона (заполнение цветом). По умолчанию: (пусто). |
| zindex | целое число | Значение, используемое для упорядочивания фигур (z-index). По умолчанию: 0. |
Линии карты
Объект линии карты задает линию, которая отображается на карте сети. Этот объект имеет следующие свойства:
| Свойство | Тип | Описание |
|---|---|---|
| sysmap_shapeid | строка | (только чтение) ID элемента линии карты. |
| x1 | целое число | X-координата 1 точки линии в пикселях. По умолчанию: 0. |
| y1 | целое число | Y-координата 1 точки линии в пикселях. По умолчанию: 0. |
| x2 | целое число | X-координата 2 точки линии в пикселях. По умолчанию: 200. |
| y2 | целое число | Y-координата 2 точки линии в пикселях. По умолчанию: 200. |
| line_type | целое число | Тип рамки. Возможные значения: 0 - none; 1 - —————;2 - ·····;3 - - - -.По умолчанию: 0. |
| line_width | целое число | Ширина рамки в пикселях. По умолчанию: 0. |
| line_color | строка | Цвет рамки. По умолчанию: '000000'. |
| zindex | целое число | Значение, используемое для упорядочивания фигур (z-index). По умолчанию: 0. |
Map lines
The map line object defines an line displayed on a map. It has the following properties:
| Property | Type | Description |
|---|---|---|
| sysmap_shapeid | string | (readonly) ID of the map shape element. |
| x1 | integer | X-coordinates of the line point 1 in pixels. Default: 0. |
| y1 | integer | Y-coordinates of the line point 1 in pixels. Default: 0. |
| x2 | integer | X-coordinates of the line point 2 in pixels. Default: 200. |
| y2 | integer | Y-coordinates of the line point 2 in pixels. Default: 200. |
| line_type | integer | Line type. Possible values: 0 - none; 1 - —————;2 - ·····;3 - - - -.Default: 0. |
| line_width | integer | Line width in pixels. Default: 0. |
| line_color | string | Line color. Default: '000000'. |
| zindex | integer | Value used to order all shapes and lines (z-index). Default: 0. |