Table of Contents

Objeto de mapa

Objeto de mapa

Os seguintes objetos estão diretamente relacionados à API de map.

Mapa

O objeto mapa possui as seguintes propriedades.

Propriedade	Tipo	Descrição
sysmapid	ID	ID do mapa. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização
height	integer	Altura do mapa em pixels. Comportamento da propriedade: - obrigatório para operações de criação
name	string	Nome do mapa. Comportamento da propriedade: - obrigatório para operações de criação
width	integer	Largura do mapa em pixels. Comportamento da propriedade: - obrigatório para operações de criação
backgroundid	ID	ID da imagem usada como fundo do mapa.
background_scale	integer	Se deve habilitar o redimensionamento proporcional da imagem de fundo. Valores possíveis: 0 - desabilitar redimensionamento; 1 - (padrão) habilitar redimensionamento da imagem.
expand_macros	integer	Se deve expandir macros nos rótulos ao configurar o mapa. Valores possíveis: 0 - (padrão) não expandir macros; 1 - expandir macros.
expandproblem	integer	Se o trigger de problema será exibido para elementos com um único problema. Valores possíveis: 0 - sempre exibir o número de problemas; 1 - (padrão) exibir o trigger de problema se houver apenas um problema.
grid_align	integer	Se deve habilitar o alinhamento à grade. Valores possíveis: 0 - desabilitar alinhamento à grade; 1 - (padrão) habilitar alinhamento à 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 suportados: 20, 40, 50, 75 e 100. Padrão: 50.
highlight	integer	Se o destaque de ícones está habilitado. Valores possíveis: 0 - destaque desabilitado; 1 - (padrão) destaque habilitado.
iconmapid	ID	ID do mapa de ícones usado no mapa.
label_format	integer	Se deve habilitar rótulos avançados. Valores possíveis: 0 - (padrão) desabilitar rótulos avançados; 1 - habilitar rótulos 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 de host. Comportamento da propriedade: - obrigatório se `label_type_host` estiver definido como "custom"
label_string_hostgroup	string	Rótulo personalizado para elementos de grupo de hosts. Comportamento da propriedade: - obrigatório se `label_type_hostgroup` estiver definido como "custom"
label_string_image	string	Rótulo personalizado para elementos de imagem. Comportamento da propriedade: - obrigatório se `label_type_image` estiver definido como "custom"
label_string_map	string	Rótulo personalizado para elementos de mapa. Comportamento da propriedade: - obrigatório se `label_type_map` estiver definido como "custom"
label_string_trigger	string	Rótulo personalizado para elementos de trigger. Comportamento da propriedade: - obrigatório se `label_type_trigger` estiver definido como "custom"
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 - apenas 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 - apenas status; 4 - nada; 5 - personalizado.
label_type_hostgroup	integer	Tipo de rótulo para elementos de grupo de hosts. Valores possíveis: 0 - rótulo; 2 - (padrão) nome do elemento; 3 - apenas status; 4 - nada; 5 - personalizado.
label_type_image	integer	Tipo de rótulo para elementos de 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 de mapa. Valores possíveis: 0 - rótulo; 2 - (padrão) nome do elemento; 3 - apenas status; 4 - nada; 5 - personalizado.
label_type_trigger	integer	Tipo de rótulo para elementos de trigger. Valores possíveis: 0 - rótulo; 2 - (padrão) nome do elemento; 3 - apenas status; 4 - nada; 5 - personalizado.
markelements	integer	Se deve destacar elementos do mapa que mudaram recentemente seu status. Valores possíveis: 0 - (padrão) não destacar elementos; 1 - destacar elementos.
severity_min	integer	Severidade mínima dos triggers que serão exibidos no mapa. Consulte a propriedade `severity` do trigger para uma lista das severidades de trigger suportadas.
show_element_label	integer	Como exibir os rótulos dos elementos por padrão. Valores possíveis: 0 - sempre exibir; 1 - (padrão) ocultar automaticamente.
show_link_label	integer	Como exibir os rótulos dos links por padrão. Valores possíveis: 0 - sempre exibir; 1 - (padrão) ocultar automaticamente.
show_unack	integer	Como os problemas devem ser exibidos. Valores possíveis: 0 - (padrão) exibir a contagem de todos os problemas; 1 - exibir apenas a contagem de problemas não reconhecidos; 2 - exibir a contagem de problemas reconhecidos e não reconhecidos separadamente.
userid	ID	ID do usuário que é o proprietário do mapa.
private	integer	Tipo de compartilhamento do mapa. Valores possíveis: 0 - mapa público; 1 - (padrão) mapa privado.
show_suppressed	integer	Se problemas suprimidos são exibidos. Valores possíveis: 0 - (padrão) ocultar problemas suprimidos; 1 - exibir problemas suprimidos.

Elemento do mapa

O objeto de elemento do mapa define um objeto exibido em um mapa. Ele possui as seguintes propriedades.

Propriedade	Tipo	Descrição
selementid	ID	ID do elemento do mapa. Comportamento da propriedade: - somente leitura
elements	array	Objeto de dados Elemento. Comportamento da propriedade: - obrigatório se `elementtype` estiver definido como "host", "mapa", "trigger" ou "grupo de hosts"
elementtype	integer	Tipo de elemento do mapa. Valores possíveis: 0 - host; 1 - mapa; 2 - trigger; 3 - grupo de hosts; 4 - imagem. Comportamento da propriedade: - obrigatório
iconid_off	ID	ID da imagem usada para exibir o elemento no estado padrão. Comportamento da propriedade: - obrigatório
areatype	integer	Como os hosts do grupo de hosts devem ser exibidos. Valores possíveis: 0 - (padrão) o elemento do grupo de hosts ocupará todo o mapa; 1 - o elemento do grupo de hosts terá um tamanho fixo.
elementsubtype	integer	Como um elemento de grupo de hosts deve ser exibido em um mapa. Valores possíveis: 0 - (padrão) exibir o grupo de hosts como um único elemento; 1 - exibir cada host do grupo separadamente.
evaltype	integer	Método de avaliação da condição de filtragem de tags do elemento do mapa. Valores possíveis: 0 - (padrão) AND / OR; 2 - OR.
height	integer	Altura do elemento de grupo de hosts de tamanho fixo em pixels. Padrão: 200.
iconid_disabled	ID	ID da imagem usada para exibir elementos de mapa desabilitados. Comportamento da propriedade: - suportado se `elementtype` estiver definido como "host", "mapa", "trigger" ou "grupo de hosts"
iconid_maintenance	ID	ID da imagem usada para exibir elementos de mapa em manutenção. Comportamento da propriedade: - suportado se `elementtype` estiver definido como "host", "mapa", "trigger" ou "grupo de hosts"
iconid_on	ID	ID da imagem usada para exibir elementos de mapa com problemas. Comportamento da propriedade: - suportado se `elementtype` estiver definido como "host", "mapa", "trigger" ou "grupo de hosts"
label	string	Rótulo do elemento.
label_location	integer	Localização do rótulo do elemento do mapa. Valores possíveis: -1 - (padrão) localização padrão; 0 - inferior; 1 - esquerda; 2 - direita; 3 - superior.
permission	integer	Tipo de nível de permissão. Valores possíveis: -1 - nenhum; 2 - somente leitura; 3 - leitura-escrita.
show_label	integer	Como exibir o rótulo do elemento. Valores possíveis: -1 - (padrão) padrão do mapa; 0 - sempre exibir; 1 - ocultar automaticamente.
sysmapid	ID	ID do mapa ao qual o elemento pertence. Comportamento da propriedade: - somente leitura
urls	array	URLs do elemento do mapa. O objeto de URL do elemento do mapa é descrito em detalhes abaixo.
use_iconmap	integer	Se o mapeamento de ícones deve ser usado para elementos de host. Valores possíveis: 0 - não usar mapeamento de ícones; 1 - (padrão) usar mapeamento de ícones.
viewtype	integer	Algoritmo de posicionamento do elemento do grupo de hosts. Valores possíveis: 0 - (padrão) grade.
width	integer	Largura do elemento de grupo de hosts de tamanho fixo em pixels. Padrão: 200.
x	integer	Coordenadas X do elemento em pixels. Padrão: 0.
y	integer	Coordenadas Y do elemento em pixels. Padrão: 0.
zindex	integer	Valor usado para ordenar os elementos do mapa (z-index). Padrão: 0.

Elemento de mapa Host

O objeto de elemento de mapa Host define um elemento de host.

Propriedade	Tipo	Descrição
hostid	ID	ID do host.

Elemento de mapa Grupo de hosts

O objeto de elemento de mapa Grupo de hosts define um elemento de grupo de hosts.

Propriedade	Tipo	Descrição
groupid	ID	ID do grupo de hosts.

Elemento de mapa Map

O objeto de elemento de mapa Map define um elemento de mapa.

Propriedade	Tipo	Descrição
sysmapid	ID	ID do mapa.

Elemento de mapa Trigger

O objeto de elemento de mapa Trigger define um ou mais elementos de trigger.

Propriedade	Tipo	Descrição
triggerid	ID	ID do trigger.

Tag de elemento de mapa

O objeto Tag de elemento de mapa possui as seguintes propriedades.

Propriedade	Tipo	Descrição
tag	string	Nome da tag do elemento de mapa. Comportamento da propriedade: - obrigatório
operator	integer	Operador de condição da tag do elemento de mapa. Valores possíveis: 0 - (padrão) Contém; 1 - Igual; 2 - Não contém; 3 - Não é igual; 4 - Existe; 5 - Não existe.
value	string	Valor da tag do elemento de mapa.

URL do elemento do mapa

O objeto de URL do elemento do mapa define um link clicável que estará disponível para um elemento de mapa específico. Ele possui as seguintes propriedades:

Propriedade	Tipo	Descrição
sysmapelementurlid	ID	ID da URL do elemento do mapa. Comportamento da propriedade: - somente leitura
name	string	Legenda do link. Comportamento da propriedade: - obrigatório
url	string	URL do link. Comportamento da propriedade: - obrigatório
selementid	ID	ID do elemento do mapa ao qual a URL pertence.

Link de mapa

O objeto de link de mapa define um link entre dois elementos do mapa. Ele possui as seguintes propriedades.

Propriedade	Tipo	Descrição
linkid	ID	ID do link do mapa. Comportamento da propriedade: - somente leitura
sysmapid	ID	ID do mapa ao qual o link pertence.
selementid1	ID	ID do primeiro elemento do mapa vinculado em uma extremidade. Comportamento da propriedade: - obrigatório
selementid2	ID	ID do primeiro elemento do mapa vinculado na outra extremidade. Comportamento da propriedade: - obrigatório
drawtype	integer	Estilo de desenho da linha do link. Valores possíveis: 0 - (padrão) linha; 2 - linha em negrito; 3 - linha pontilhada; 4 - linha tracejada.
color	string	Cor da linha como um código de cor hexadecimal. Padrão: `000000`.
label	string	Rótulo do link.
show_label	integer	Como exibir o rótulo do link. Valores possíveis: -1 - (padrão) padrão do mapa; 0 - sempre exibir; 1 - ocultar automaticamente.
indicator_type	integer	Seleciona o tipo de indicador do link. Valores possíveis: 0 - (padrão) link estático; 1 - trigger; 2 - valor do item.
linktriggers	array	Triggers do link do mapa a serem usadas como indicadores de status do link. O objeto de trigger de link de mapa é descrito em detalhes abaixo. Comportamento da propriedade: - obrigatório se `indicator_type` estiver definido como "trigger" (1).
itemid	ID	ID do item. Comportamento da propriedade: - obrigatório se `indicator_type` estiver definido como "valor do item" (2).
highlights	array	Destaques do link do mapa a serem usados como indicadores de status do link. O objeto de indicadores de link de mapa é descrito em detalhes abaixo. Comportamento da propriedade: - obrigatório se `indicator_type` estiver definido como "valor do item" (2).
thresholds	array	Limiares do link do mapa a serem usados como indicadores de status do link. O objeto de indicadores de link de mapa é descrito em detalhes abaixo. Comportamento da propriedade: - obrigatório se `indicator_type` estiver definido como "valor do item" (2).
permission	integer	Tipo de nível de permissão. Valores possíveis: -1 - nenhum; 2 - somente leitura; 3 - leitura e gravação.

Trigger de link de mapa

O objeto de trigger de link de mapa define um indicador de status de link de mapa com base no estado de um trigger. Ele possui as seguintes propriedades:

Propriedade	Tipo	Descrição
triggerid	ID	ID do trigger usado como indicador de link. Comportamento da propriedade: - obrigatório
color	string	Cor do indicador como um código de cor hexadecimal. Padrão: `DD0000`.
drawtype	integer	Estilo de desenho do indicador. Valores possíveis: 0 - (padrão) linha; 2 - linha em negrito; 3 - linha pontilhada; 4 - linha tracejada.

Indicadores de links de mapa

O objeto de indicadores de links de mapa define um indicador de status de link de mapa com base no valor do item. Possui as seguintes propriedades:

Propriedade	Tipo	Descrição
pattern	string	Expressão regular para comparar. Disponível apenas para destaques.
sortorder	integer	Usado para definir a ordem de classificação dos destaques. Disponível apenas para destaques.
threshold	string	Valor numérico para comparar. Disponível apenas para limites.
drawtype	integer	Estilo de desenho do indicador. Valores possíveis: 0 - (padrão) linha; 2 - linha em negrito; 3 - linha pontilhada; 4 - linha tracejada.
color	string	Cor do indicador como um código de cor hexadecimal. Padrão: `DD0000`. Comportamento da propriedade: - obrigatório

URL do mapa

O objeto de URL do mapa define um link clicável que estará disponível para todos os elementos de um tipo específico no mapa. Ele possui as seguintes propriedades:

Propriedade	Tipo	Descrição
sysmapurlid	ID	ID da URL do mapa. Comportamento da propriedade: - somente leitura
name	string	Legenda do link. Comportamento da propriedade: - obrigatório
url	string	URL do link. Comportamento da propriedade: - obrigatório
elementtype	integer	Tipo de elemento do mapa para o qual a URL estará disponível. Consulte a propriedade `type` do elemento do mapa para uma lista de tipos suportados. Padrão: 0.
sysmapid	ID	ID do mapa ao qual a URL pertence.

Usuário do mapa

Lista de permissões de mapa com base nos usuários. Possui as seguintes propriedades:

Propriedade	Tipo	Descrição
sysmapuserid	ID	ID do usuário do mapa. Comportamento da propriedade: - somente leitura
userid	ID	ID do usuário. Comportamento da propriedade: - obrigatório
permission	integer	Tipo de nível de permissão. Valores possíveis: 2 - somente leitura; 3 - leitura e gravação. Comportamento da propriedade: - obrigatório

Grupo de usuários do mapa

Lista de permissões de mapa com base em grupos de usuários. Possui as seguintes propriedades:

Propriedade	Tipo	Descrição
sysmapusrgrpid	ID	ID do grupo de usuários do mapa. Comportamento da propriedade: - somente leitura
usrgrpid	ID	ID do grupo de usuários. Comportamento da propriedade: - obrigatório
permission	integer	Tipo de nível de permissão. Valores possíveis: 2 - somente leitura; 3 - leitura e gravação. Comportamento da propriedade: - obrigatório

Formas do mapa

O objeto de forma do mapa define uma forma geométrica (com ou sem texto) exibida em um mapa. Possui as seguintes propriedades:

Propriedade	Tipo	Descrição
sysmap_shapeid	ID	ID do elemento de forma do mapa. Comportamento da propriedade: - somente leitura
type	integer	Tipo de elemento de forma do mapa. Valores possíveis: 0 - retângulo; 1 - elipse. A propriedade é obrigatória quando novas formas são criadas. Comportamento da propriedade: - obrigatório
x	integer	Coordenadas X da forma em pixels. Padrão: 0.
y	integer	Coordenadas Y da forma em pixels. Padrão: 0.
width	integer	Largura da forma em pixels. Padrão: 200.
height	integer	Altura da forma em pixels. Padrão: 200.
text	string	Texto da forma.
font	integer	Fonte do texto dentro da forma. Valores possíveis: 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 Padrão: 9.
font_size	integer	Tamanho da fonte em pixels. Padrão: 11.
font_color	string	Cor da fonte. Padrão: `000000`.
text_halign	integer	Alinhamento horizontal do texto. Valores possíveis: 0 - centralizado; 1 - à esquerda; 2 - à direita. Padrão: 0.
text_valign	integer	Alinhamento vertical do texto. Valores possíveis: 0 - meio; 1 - topo; 2 - inferior. Padrão: 0.
border_type	integer	Tipo da borda. Valores possíveis: 0 - nenhuma; 1 - `—————`; 2 - `·····`; 3 - `- - -`. Padrão: 0.
border_width	integer	Largura da borda em pixels. Padrão: 0.
border_color	string	Cor da borda. Padrão: `000000`.
background_color	string	Cor de fundo (cor de preenchimento). Padrão: `(vazio)`.
zindex	integer	Valor usado para ordenar todas as formas e linhas (z-index). Padrão: 0.

Linhas do mapa

O objeto de linha do mapa define uma linha exibida em um mapa. Ele possui as seguintes propriedades:

Propriedade	Tipo	Descrição
sysmap_shapeid	ID	ID do elemento de forma do mapa. Comportamento da propriedade: - somente leitura
x1	integer	Coordenadas X do ponto 1 da linha em pixels. Padrão: 0.
y1	integer	Coordenadas Y do ponto 1 da linha em pixels. Padrão: 0.
x2	integer	Coordenadas X do ponto 2 da linha em pixels. Padrão: 200.
y2	integer	Coordenadas Y do ponto 2 da linha em pixels. Padrão: 200.
line_type	integer	Tipo das linhas. Valores possíveis: 0 - nenhum; 1 - `—————`; 2 - `·····`; 3 - `- - -`. Padrão: 0.
line_width	integer	Largura das linhas em pixels. Padrão: 0.
line_color	string	Cor da linha. Padrão: `000000`.
zindex	integer	Valor usado para ordenar todas as formas e linhas (z-index). Padrão: 0.

Documentation