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

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

Elemento do mapa

O objeto de elemento de mapa define um objeto exibido em um mapa. Tem as seguintes propriedades.

Propriedade Tipo Descrição
selementid string (somente leitura) (somente leitura) ID do elemento do mapa.
elementos
(obrigatório)
array Objeto de dados do elemento. Necessário para elementos de host, grupo de hosts, acionador e tipo de mapa.
tipo de elemento
(obrigatório)
inteiro Tipo de elemento do mapa.

Valores possíveis:
0 - host;
1 - mapa;
2 - trigger;
3 - grupo de host;
4 - imagem.
iconid_off
(obrigatório)
string ID da imagem usada para exibir o elemento no estado padrão.
tipo de área inteiro Como os hosts do grupo de hosts separados devem ser exibidos.

Valores possíveis:
0 - (padrão) o elemento de grupo de host ocupará todo o mapa;
1 - o elemento do grupo de hosts terá um tamanho fixo.
subtipo de elemento inteiro Como um elemento de grupo de hosts deve ser exibido em um mapa.

Valores possíveis:
0 - (padrão) exibe o grupo de hosts como um único elemento;
1 - exibe cada host no grupo separadamente.
tipo de avaliação inteiro Método de avaliação da condição de filtragem da tag do elemento no mapa.

Valores possíveis:
0 - (padrão) E / OU;
2 - OU.
altura inteiro Altura do elemento do grupo de hosts de tamanho fixo em pixels.

Padrão: 200.
iconid_disabled string ID da imagem usada para exibir elementos de mapa desativados. Não utilizado para elementos de imagem.
iconid_maintenance string ID da imagem usada para exibir os elementos do mapa em manutenção. Não utilizado para elementos de imagem.
iconid_on string ID da imagem usada para exibir os elementos do mapa com problemas. Não utilizado para elementos de imagem.
rótulo string Rótulo do elemento.
rótulo_local inteiro Localização do rótulo do elemento do mapa.

Valores possíveis:
-1 - (padrão) localização padrão;
0 - fundo;
1 - esquerda;
2 - direita;
3 - topo.
permissão inteiro Tipo de nível de permissão.

Valores possíveis:
-1 - nenhum;
2 - somente leitura;
3 - leitura-escrita.
sysmapid string (somente leitura) ID do mapa ao qual o elemento pertence.
URLs array URLs do elemento do mapa.

O objeto URL do elemento do mapa está descrito em detalhes abaixo.
use_iconmap inteiro Se o mapeamento de ícones deve ser usado para elementos hospedeiros.

Valores possíveis:
0 - não use mapeamento de ícones;
1 - (padrão) usa o mapeamento de ícones.
tipo de visão inteiro Algoritmo de posicionamento do elemento do grupo de hosts.

Valores possíveis:
0 - (padrão) grade.
largura inteiro Largura do elemento do grupo de hosts de tamanho fixo em pixels.

Padrão: 200.
x inteiro Coordenadas X do elemento em pixels.

Padrão: 0.
y inteiro Coordenadas Y do elemento em pixels.

Padrão: 0.

Elemento do mapa - Host

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

Propriedade Tipo Descrição
hostid string ID do Host

Elemento do mapa - Grupo de Hosts

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

Propriedade Tipo Descrição
ID de grupo string ID do grupo de hosts

Elemento do mapa - Mapa

Define um elemento de mapa.

Propriedade Tipo Descrição
sysmapid string ID do Mapa

Elemento do Mapa - Trigger

Define um ou mais elementos acionadores.

Propriedade Tipo Descrição
Trigger ID string Trigger ID

Elemento do Mapa - Etiqueta

O objeto de etiquetas possui as seguintes propriedades.

Propriedade Tipo Descrição
etiqueta
(obrigatório)
string Nome da etiqueta do elemento do mapa.
operador string Operador de condição de tag de 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.
valor string Valor da etiqueta do elemento do mapa.

Elemento do Mapa - URL

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

Propriedade Tipo Descrição
sysmapelementurlid string (somente leitura) ID da URL do elemento do mapa.
nome
(obrigatório)
string Legenda do link.
url
(obrigatório)
string URL do Link.
selementid string ID do elemento do mapa ao qual o URL pertence.

O objeto de link de mapa define um link entre dois elementos de mapa. Tem as seguintes propriedades.

Propriedade Tipo Descrição
Link ID string (somente leitura) ID do link do mapa.
selementid1
(obrigatório)
string ID do primeiro elemento do mapa vinculado em uma extremidade.
selementid2
(obrigatório)
string ID do primeiro elemento do mapa vinculado na outra extremidade.
cor string Cor da linha como um código de cor hexadecimal.

Padrão: 000000.
tipo de desenho inteiro Estilo de desenho de linha de link.

Valores possíveis:
0 - (padrão) linha;
2 - linha em negrito;
3 - linha pontilhada;
4 - linha tracejada.
rótulo string Rótulo de link.
acionadores de triggers array Mapeia acionadores de link para usar como indicadores de status de link.

O objeto acionador do link do mapa é descrito em detalhes abaixo.
permissão inteiro Tipo de nível de permissão.

Valores possíveis:
-1 - nenhum;
2 - somente leitura;
3 - leitura-escrita.
sysmapid string ID do mapa ao qual o link pertence.

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

Propriedade Tipo Descrição
linktriggerid string (somente leitura) ID da trigger do link do mapa.
triggerid
(obrigatório)
string ID da trigger usada como um indicador de link.
cor string Cor do indicador como um código de cor hexadecimal.

Padrão: DD0000.
tipo de desenho inteiro Estilo de desenho do indicador.

Valores possíveis:
0 - (padrão) linha;
2 - linha em negrito;
3 - linha pontilhada;
4 - linha tracejada.
linkid string ID do link do mapa ao qual a trigger do 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. Tem as seguintes propriedades:

Propriedade Tipo Descrição
sysmapurlid string (somente leitura ID da URL do mapa.
nome
(obrigatório)
string Legenda do link.
URL
(obrigatório)
string URL do Link.
tipo de elemento inteiro Tipo de elemento do mapa para o qual a URL estará disponível.

Consulte a propriedade "tipo" do elemento do mapa para obter uma lista de tipos suportados.

Padrão: 0.
sysmapid string ID do mapa ao qual a URL pertence.

Mapa de usuário

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

Propriedade Tipo Descrição
sysmapuserid string (somente leitura) ID do usuário do mapa.
ID do usuário
(obrigatório)
string ID do usuário.
permissão
(obrigatório)
inteiro Tipo de nível de permissão.

Valores possíveis:
2 - somente leitura;
3 - leitura-escrita;

Mapa de grupo de usuário

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

Propriedade Tipo Descrição
sysmapusrgrpid string (somente leitura) ID do grupo de usuários do mapa.
usrgrpid
(obrigatório)
string ID do grupo de usuário.
permissão
(obrigatório)
inteiro Tipo de nível de permissão.

Valores possíveis:
2 - somente leitura;
3 - leitura-escrita;

Formas de mapa

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

Propriedade Tipo Descrição
sysmap_shapeid string (somente leitura) ID do elemento de forma do mapa.
tipo (obrigatório) inteiro Tipo de elemento de forma de mapa.

Valores possíveis:
0 - retângulo;
1 - elipse.

A propriedade é necessária quando novas formas são criadas.
x inteiro X-Coordenadas X da forma em pixels.

Padrão: 0.
y inteiro Y-Coordenadas Y da forma em pixels.

Padrão: 0.
largura inteiro Largura da forma em pixels.

Padrão: 200.
altura inteiro Altura da forma em pixels.

Padrão: 200.
texto string Text da forma.
fonte inteiro 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.
tamanho da fonte inteiro Tamanho da fonte em pixels.

Padrão: 11.
cor da fonte string Cor da fonte.

Padrão: '000000'.
alinhamento horizontal do texto inteiro Alinhamento horizontal do texto.

Valores possíveis:
0 - centro;
1 - esquerda;
2 - direita.

Padrão: 0.
alinhamento vertical do texto inteiro Alinhamento vertical do texto.

Valores possíveis:
0 - meio;
1 - topo;
2 - inferior.

Padrão: 0.
tipo de borda inteiro Tipo de borda.

Valores possíveis:
0 - nenhum;
1 - —————;
2 - ·····;
3 - - - -.

Padrão: 0.
largura da borda inteiro Largura da borda em pixels.

Padrão: 0.
cor da borda string Cor da borda.

Padrão: '000000'.
cor de fundo string Cor de fundo (cor de preenchimento).

Padrão: (vazio).
zindex inteiro 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. Tem as seguintes propriedades:

Propriedade Tipo Descrição
sysmap_shapeid string (somente leitura) ID do elemento de forma do mapa.
x1 inteiro Coordenadas X do ponto de linha 1 em pixels.

Padrão: 0.
y1 inteiro Coordenadas Y do ponto de linha 1 em pixels.

Padrão: 0.
x2 inteiro Coordenadas X do ponto de linha 2 em pixels.

Padrão: 200.
y2 inteiro Coordenadas Y do ponto de linha 2 em pixels.

Padrão: 200.
tipo de linha inteiro Tipo das linhas.

Valores possíveis:
0 - nenhum;
1 - —————;
2 - ·····;
3 - - - -.

Padrão: 0.
espessura da linha inteiro Largura das linhas em pixels.

Padrão: 0.
cor da linha string Cor da linha.

Padrão: '000000'.
zindex inteiro Valor usado para ordenar todas as formas e linhas (z-index).

Padrão: 0.