Esta é uma tradução da página de documentação original em inglês. Ajude-nos a torná-la melhor.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> Objeto de mapa

Os objetos a seguir estão diretamente relacionados à API map.

Mapa

O objeto de mapa tem as seguintes propriedades.

Propriedade Tipo Descrição
sysmapid string (somente leitura) ID of the map.
height
(requerido)
integer Altura do mapa em pixels.
name
(requerido)
string Nome do mapa.
width
(requerido)
integer Largura do mapa em pixels.
backgroundid string ID da imagem usada como plano de fundo para o mapa.
expand_macros integer Se as macros devem ser expandidas em rótulos ao configurar o mapa.

Valores possíveis:
0 - (padrão) não expande macros;
1 - expande macros.
expandproblem integer Se o acionador do problema será exibido para elementos com um único problema.

Valores possíveis:
0 - sempre exibe o número de problemas;
1 - (padrão) exibe o acionador do problema se Há apenas um problema.
grid_align integer Se deve ativar o alinhamento da grade.

Valores possíveis:
0 - desabilita o alinhamento da grade;
1 - (padrão) habilita o alinhamento da grade.
grid_show integer Se deve mostrar a grade no mapa.

Valores possíveis:
0 - não mostrar a grade;
1 - (padrão) mostrar a grade.
grid_size integer Tamanho da grade do mapa em pixels.

Valores compatíveis: 20, 40, 50, 75 e 100.

Padrão: 50.
highlight integer Se o realce do ícone está ativado.

Valores possíveis:
0 - realce desativado;
1 - (padrão) realce ativado.
iconmapid string ID do mapa de ícones usado no mapa.
label_format integer Se deve ativar marcadores avançados.

Valores possíveis:
0 - (padrão) desativar marcadores avançados;
1 - ativar marcadores avançados.
label_location integer Localização do rótulo do elemento do mapa.

Valores possíveis:
0 - (padrão) inferior;
1 - esquerda;
2 - direita;
3 - superior.
label_string_host string Rótulo personalizado para elementos do host.

Obrigatório para mapas com tipo de rótulo do host personalizado.
label_string_hostgroup string Rótulo personalizado para elementos do grupo de hosts.

Obrigatório para mapas com tipo de rótulo de grupo de hosts personalizado.
label_string_image string Rótulo personalizado para elementos de imagem.

Obrigatório para mapas com tipo de rótulo de imagem personalizado.
label_string_map string Rótulo personalizado para elementos de mapa.

Obrigatório para mapas com tipo de rótulo de mapa personalizado.
label_string_trigger string Rótulo personalizado para elementos de gatilho.

Obrigatório para mapas com tipo de rótulo de gatilho personalizado.
label_type integer Tipo de rótulo do elemento do mapa.

Valores possíveis:
0 - rótulo;
1 - endereço IP;
2 - (padrão) nome do elemento;
3 - somente status;
4 - nada.
label_type_host integer Tipo de rótulo para elementos de host.

Valores possíveis:
0 - rótulo;
1 - endereço IP;
2 - (padrão) nome do elemento;
3 - somente status ;
4 - nada;
5 - personalizado.
label_type_image integer Tipo de rótulo para elementos do grupo de hosts.

Valores possíveis:
0 - rótulo;
2 - (padrão) nome do elemento;
4 - nada;
5 - personalizado.
label_type_map integer Tipo de rótulo para elementos do mapa.

Valores possíveis:
0 - rótulo;
2 - (padrão) nome do elemento;
3 - somente status;
4 - nada;
5 - personalizado.
label_type_trigger integer Tipo de rótulo para elementos de gatilho.

Valores possíveis:
0 - rótulo;
2 - (padrão) nome do elemento;
3 - somente status;
4 - nada;
5 - personalizado.
markelements integer Se deve destacar elementos do mapa que mudaram recentemente de status.

Valores possíveis:
0 - (padrão) não destacar elementos;
1 - destacar elementos.
severity_min integer Gravidade mínima dos acionadores que serão exibidos no mapa.

Consulte a propriedade "severity" do acionador para obter uma lista de gravidades de acionadores compatíveis.
show_unack integer Como os problemas devem ser exibidos.

Valores possíveis:
0 - (padrão) exibe a contagem de todos os problemas;
1 - exibe apenas a contagem de problemas não confirmados;
2 - exibir a contagem de problemas reconhecidos e não reconhecidos separadamente.
userid string ID de usuário do proprietário do mapa.
private integer Tipo de compartilhamento de mapa.

Valores possíveis:
0 - mapa público;
1 - (padrão) mapa privado.
show_suppressed integer Se os problemas suprimidos são mostrados.

Valores possíveis:
0 - (padrão) ocultar problemas suprimidos;
1 - mostrar problemas suprimidos.

Map element

The map element object defines an object displayed on a map. It has the following properties.

Property Type Description
selementid string (readonly) ID of the map element.
elements
(required)
array Element data object. Required for host, host group, trigger and map type elements.
elementtype
(required)
integer Type of map element.

Possible values:
0 - host;
1 - map;
2 - trigger;
3 - host group;
4 - image.
iconid_off
(required)
string ID of the image used to display the element in default state.
areatype integer How separate host group hosts should be displayed.

Possible values:
0 - (default) the host group element will take up the whole map;
1 - the host group element will have a fixed size.
elementsubtype integer How a host group element should be displayed on a map.

Possible values:
0 - (default) display the host group as a single element;
1 - display each host in the group separately.
evaltype integer Map element tag filtering condition evaluation method.

Possible values:
0 - (default) AND / OR;
2 - OR.
height integer Height of the fixed size host group element in pixels.

Default: 200.
iconid_disabled string ID of the image used to display disabled map elements. Unused for image elements.
iconid_maintenance string ID of the image used to display map elements in maintenance. Unused for image elements.
iconid_on string ID of the image used to display map elements with problems. Unused for image elements.
label string Label of the element.
label_location integer Location of the map element label.

Possible values:
-1 - (default) default location;
0 - bottom;
1 - left;
2 - right;
3 - top.
permission integer Type of permission level.

Possible values:
-1 - none;
2 - read only;
3 - read-write.
sysmapid string (readonly) ID of the map that the element belongs to.
urls array Map element URLs.

The map element URL object is described in detail below.
use_iconmap integer Whether icon mapping must be used for host elements.

Possible values:
0 - do not use icon mapping;
1 - (default) use icon mapping.
viewtype integer Host group element placing algorithm.

Possible values:
0 - (default) grid.
width integer Width of the fixed size host group element in pixels.

Default: 200.
x integer X-coordinates of the element in pixels.

Default: 0.
y integer Y-coordinates of the element in pixels.

Default: 0.

Map element Host

The map element Host object defines one host element.

Property Type Description
hostid string Host ID

Map element Host group

The map element Host group object defines one host group element.

Property Type Description
groupid string Host group ID

Map element Map

The map element Map object defines one map element.

Property Type Description
sysmapid string Map ID

Map element Trigger

The map element Trigger object defines one or more trigger elements.

Property Type Description
triggerid string Trigger ID

Map element tag

The map element tag object has the following properties.

Property Type Description
tag
(required)
string Map element tag name.
operator string Map element tag condition operator.

Possible values:
0 - (default) Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.
value string Map element tag value.

Map element URL

The map element URL object defines a clickable link that will be available for a specific map element. It has the following properties:

Property Type Description
sysmapelementurlid string (readonly) ID of the map element URL.
name
(required)
string Link caption.
url
(required)
string Link URL.
selementid string ID of the map element that the URL belongs to.

The map link object defines a link between two map elements. It has the following properties.

Property Type Description
linkid string (readonly) ID of the map link.
selementid1
(required)
string ID of the first map element linked on one end.
selementid2
(required)
string ID of the first map element linked on the other end.
color string Line color as a hexadecimal color code.

Default: 000000.
drawtype integer Link line draw style.

Possible values:
0 - (default) line;
2 - bold line;
3 - dotted line;
4 - dashed line.
label string Link label.
linktriggers array Map link triggers to use as link status indicators.

The map link trigger object is described in detail below.
permission integer Type of permission level.

Possible values:
-1 - none;
2 - read only;
3 - read-write.
sysmapid string ID of the map the link belongs to.

The map link trigger object defines a map link status indicator based on the state of a trigger. It has the following properties:

Property Type Description
linktriggerid string (readonly) ID of the map link trigger.
triggerid
(reqiuired)
string ID of the trigger used as a link indicator.
color string Indicator color as a hexadecimal color code.

Default: DD0000.
drawtype integer Indicator draw style.

Possible values:
0 - (default) line;
2 - bold line;
3 - dotted line;
4 - dashed line.
linkid string ID of the map link that the link trigger belongs to.

Map URL

The map URL object defines a clickable link that will be available for all elements of a specific type on the map. It has the following properties:

Property Type Description
sysmapurlid string (readonly) ID of the map URL.
name
(required)
string Link caption.
url
(required)
string Link URL.
elementtype integer Type of map element for which the URL will be available.

Refer to the map element "type" property for a list of supported types.

Default: 0.
sysmapid string ID of the map that the URL belongs to.

Map user

List of map permissions based on users. It has the following properties:

Property Type Description
sysmapuserid string (readonly) ID of the map user.
userid
(required)
string User ID.
permission
(required)
integer Type of permission level.

Possible values:
2 - read only;
3 - read-write;

Map user group

List of map permissions based on user groups. It has the following properties:

Property Type Description
sysmapusrgrpid string (readonly) ID of the map user group.
usrgrpid
(required)
string User group ID.
permission
(required)
integer Type of permission level.

Possible values:
2 - read only;
3 - read-write;

Map shapes

The map shape object defines an geometric shape (with or without text) displayed on a map. It has the following properties:

Property Type Description
sysmap_shapeid string (readonly) ID of the map shape element.
type (required) integer Type of map shape element.

Possible values:
0 - rectangle;
1 - ellipse.

Property is required when new shapes are created.
x integer X-coordinates of the shape in pixels.

Default: 0.
y integer Y-coordinates of the shape in pixels.

Default: 0.
width integer Width of the shape in pixels.

Default: 200.
height integer Height of the shape in pixels.

Default: 200.
text string Text of the shape.
font integer Font of the text within shape.

Possible values:
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

Default: 9.
font_size integer Font size in pixels.

Default: 11.
font_color string Font color.

Default: '000000'.
text_halign integer Horizontal alignment of text.

Possible values:
0 - center;
1 - left;
2 - right.

Default: 0.
text_valign integer Vertical alignment of text.

Possible values:
0 - middle;
1 - top;
2 - bottom.

Default: 0.
border_type integer Type of the border.

Possible values:
0 - none;
1 - —————;
2 - ·····;
3 - - - -.

Default: 0.
border_width integer Width of the border in pixels.

Default: 0.
border_color string Border color.

Default: '000000'.
background_color string Background color (fill color).

Default: (empty).
zindex integer Value used to order all shapes and lines (z-index).

Default: 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 Type of the lines.

Possible values:
0 - none;
1 - —————;
2 - ·····;
3 - - - -.

Default: 0.
line_width integer Width of the lines 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.