Objeto de mapa

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

Map

O objeto map possui as seguintes propriedades.

Property Type Description
sysmapid ID ID do map.

Property behavior:
- read-only
- required para operações de atualização
height integer Altura do map em pixels.

Property behavior:
- required para operações de criação
name string Nome do map.

Property behavior:
- required para operações de criação
width integer Largura do map em pixels.

Property behavior:
- required para operações de criação
backgroundid ID ID da imagem usada como plano de fundo do map.
expand_macros integer Se deve expandir macros nos rótulos ao configurar o map.

Valores possíveis:
0 - (default) 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 - (default) exibir o trigger de problema se houver apenas um problema.
grid_align integer Se deve ativar o alinhamento à grade.

Valores possíveis:
0 - desativar o alinhamento à grade;
1 - (default) ativar o alinhamento à grade.
grid_show integer Se deve mostrar a grade no map.

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

Valores suportados: 20, 40, 50, 75 e 100.

Padrão: 50.
highlight integer Se o realce de ícones está ativado.

Valores possíveis:
0 - realce desativado;
1 - (default) realce ativado.
iconmapid ID ID do icon map usado no map.
label_format integer Se deve ativar rótulos avançados.

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

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

Property behavior:
- required se label_type_host estiver definido como "custom"
label_string_hostgroup string Rótulo personalizado para elementos de host group.

Property behavior:
- required se label_type_hostgroup estiver definido como "custom"
label_string_image string Rótulo personalizado para elementos de imagem.

Property behavior:
- required se label_type_image estiver definido como "custom"
label_string_map string Rótulo personalizado para elementos de map.

Property behavior:
- required se label_type_map estiver definido como "custom"
label_string_trigger string Rótulo personalizado para elementos de trigger.

Property behavior:
- required se label_type_trigger estiver definido como "custom"
label_type integer Tipo de rótulo do elemento do map.

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

Valores possíveis:
0 - rótulo;
1 - endereço IP;
2 - (default) nome do elemento;
3 - apenas status;
4 - nenhum;
5 - personalizado.
label_type_hostgroup integer Tipo de rótulo para elementos de host group.

Valores possíveis:
0 - rótulo;
2 - (default) nome do elemento;
3 - apenas status;
4 - nenhum;
5 - personalizado.
label_type_image integer Tipo de rótulo para elementos de host group.

Valores possíveis:
0 - rótulo;
2 - (default) nome do elemento;
4 - nenhum;
5 - personalizado.
label_type_map integer Tipo de rótulo para elementos de map.

Valores possíveis:
0 - rótulo;
2 - (default) nome do elemento;
3 - apenas status;
4 - nenhum;
5 - personalizado.
label_type_trigger integer Tipo de rótulo para elementos de trigger.

Valores possíveis:
0 - rótulo;
2 - (default) nome do elemento;
3 - apenas status;
4 - nenhum;
5 - personalizado.
markelements integer Se deve destacar elementos do map que tiveram alteração recente de status.

Valores possíveis:
0 - (default) não destacar elementos;
1 - destacar elementos.
severity_min integer Severidade mínima dos triggers que serão exibidos no map.

Consulte a propriedade severity do trigger para obter uma lista das severidades de trigger suportadas.
show_unack integer Como os problemas devem ser exibidos.

Valores possíveis:
0 - (default) 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 map.
private integer Tipo de compartilhamento do map.

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

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

Elemento do mapa

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

Property Type Description
selementid ID ID do elemento do mapa.

Comportamento da propriedade:
- somente leitura
elements array Objeto de dados Element.

Comportamento da propriedade:
- obrigatório se elementtype estiver definido como "host", "map", "trigger" ou "host group"
elementtype integer Tipo de elemento do mapa.

Valores possíveis:
0 - host;
1 - map;
2 - trigger;
3 - host group;
4 - image.

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 host group separados devem ser exibidos.

Valores possíveis:
0 - (padrão) o elemento host group ocupará todo o mapa;
1 - o elemento host group terá um tamanho fixo.
elementsubtype integer Como um elemento host group deve ser exibido em um mapa.

Valores possíveis:
0 - (padrão) exibir o host group como um único elemento;
1 - exibir cada host do grupo separadamente.
evaltype integer Método de avaliação da condição de filtragem por tag do elemento do mapa método de avaliação.

Valores possíveis:
0 - (padrão) And/Or;
2 - Or.
height integer Altura do elemento host group de tamanho fixo em pixels.

Padrão: 200.
iconid_disabled ID ID da imagem usada para exibir elementos do mapa desativados.

Comportamento da propriedade:
- suportado se elementtype estiver definido como "host", "map", "trigger" ou "host group"
iconid_maintenance ID ID da imagem usada para exibir elementos do mapa em manutenção.

Comportamento da propriedade:
- suportado se elementtype estiver definido como "host", "map", "trigger" ou "host group"
iconid_on ID ID da imagem usada para exibir elementos do mapa com problemas.

Comportamento da propriedade:
- suportado se elementtype estiver definido como "host", "map", "trigger" ou "host group"
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 e gravação.
sysmapid ID ID do mapa ao qual o elemento pertence.

Comportamento da propriedade:
- somente leitura
urls array URLs do elemento do mapa.

O objeto URL do elemento do mapa é descrito em detalhes abaixo.
use_iconmap integer Se o mapeamento de ícones deve ser usado para elementos 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 host group.

Valores possíveis:
0 - (padrão) grade.
width integer Largura do elemento host group de tamanho fixo em pixels.

Padrão: 200.
x integer Coordenada X do elemento em pixels.

Padrão: 0.
y integer Coordenada Y do elemento em pixels.

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.

Objeto Map do elemento do mapa

O objeto Map do elemento do mapa 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 do elemento do mapa

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

Propriedade Tipo Descrição
tag string Nome da tag do elemento do mapa.

Comportamento da propriedade:
- obrigatório
operator integer Operador da condição da tag do elemento do mapa.

Valores possíveis:
0 - (padrão) Contém;
1 - Igual;
2 - Não contém;
3 - Diferente;
4 - Existe;
5 - Não existe.
value string Valor da tag do elemento do 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.

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

Property Type Description
linkid ID ID do link do mapa.

Comportamento da propriedade:
- somente leitura
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
color string Cor da linha como um código de cor hexadecimal.

Padrão: 000000.
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.
label string Rótulo do link.
linktriggers array Triggers do link do mapa a serem usadas como indicadores de status do link.

O objeto trigger do link do mapa é descrito em detalhes abaixo.
permission integer Tipo de nível de permissão.

Valores possíveis:
-1 - nenhum;
2 - somente leitura;
3 - leitura e gravação.
sysmapid ID ID do mapa ao qual o link pertence.

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

Property Type Description
linktriggerid ID ID do trigger de link do mapa.

Property behavior:
- read-only
triggerid ID ID do trigger usado como indicador de link.

Property behavior:
- required
color string Cor do indicador como um código de cor hexadecimal.

Default: DD0000.
drawtype integer Estilo de desenho do indicador.

Possible values:
0 - (default) line;
2 - bold line;
3 - dotted line;
4 - dashed line.
linkid ID ID do link do mapa ao qual o trigger de link pertence.

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-escrita.

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 - centro;
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.