Objeto de mapa

Los siguientes objetos están directamente relacionados con la API map.

Mapa

El objeto mapa tiene las siguientes propiedades.

Propiedad Tipo Descripción
sysmapid ID ID del mapa.

Comportamiento de la propiedad:
- solo lectura
- requerido para operaciones de actualización
height integer Altura del mapa en píxeles.

Comportamiento de la propiedad:
- requerido para operaciones de creación
name string Nombre del mapa.

Comportamiento de la propiedad:
- requerido para operaciones de creación
width integer Ancho del mapa en píxeles.

Comportamiento de la propiedad:
- requerido para operaciones de creación
backgroundid ID ID de la imagen utilizada como fondo para el mapa.
expand_macros integer Si se deben expandir macros en las etiquetas al configurar el mapa.

Valores posibles:
0 - (por defecto) no expandir macros;
1 - expandir macros.
expandproblem integer Si el trigger de problema se mostrará para elementos con un solo problema.

Valores posibles:
0 - mostrar siempre el número de problemas;
1 - (por defecto) mostrar el trigger de problema si solo hay un problema.
grid_align integer Si se debe habilitar la alineación de la cuadrícula.

Valores posibles:
0 - deshabilitar la alineación de la cuadrícula;
1 - (por defecto) habilitar la alineación de la cuadrícula.
grid_show integer Si se debe mostrar la cuadrícula en el mapa.

Valores posibles:
0 - no mostrar la cuadrícula;
1 - (por defecto) mostrar la cuadrícula.
grid_size integer Tamaño de la cuadrícula del mapa en píxeles.

Valores soportados: 20, 40, 50, 75 y 100.

Por defecto: 50.
highlight integer Si el resaltado de iconos está habilitado.

Valores posibles:
0 - resaltado deshabilitado;
1 - (por defecto) resaltado habilitado.
iconmapid ID ID del mapa de iconos utilizado en el mapa.
label_format integer Si se deben habilitar etiquetas avanzadas.

Valores posibles:
0 - (por defecto) deshabilitar etiquetas avanzadas;
1 - habilitar etiquetas avanzadas.
label_location integer Ubicación de la etiqueta del elemento del mapa.

Valores posibles:
0 - (por defecto) abajo;
1 - izquierda;
2 - derecha;
3 - arriba.
label_string_host string Etiqueta personalizada para elementos host.

Comportamiento de la propiedad:
- requerido si label_type_host está establecido en "custom"
label_string_hostgroup string Etiqueta personalizada para elementos de grupo de hosts.

Comportamiento de la propiedad:
- requerido si label_type_hostgroup está establecido en "custom"
label_string_image string Etiqueta personalizada para elementos de imagen.

Comportamiento de la propiedad:
- requerido si label_type_image está establecido en "custom"
label_string_map string Etiqueta personalizada para elementos de mapa.

Comportamiento de la propiedad:
- requerido si label_type_map está establecido en "custom"
label_string_trigger string Etiqueta personalizada para elementos trigger.

Comportamiento de la propiedad:
- requerido si label_type_trigger está establecido en "custom"
label_type integer Tipo de etiqueta del elemento del mapa.

Valores posibles:
0 - etiqueta;
1 - dirección IP;
2 - (por defecto) nombre del elemento;
3 - solo estado;
4 - nada.
label_type_host integer Tipo de etiqueta para elementos host.

Valores posibles:
0 - etiqueta;
1 - dirección IP;
2 - (por defecto) nombre del elemento;
3 - solo estado;
4 - nada;
5 - personalizado.
label_type_hostgroup integer Tipo de etiqueta para elementos de grupo de hosts.

Valores posibles:
0 - etiqueta;
2 - (por defecto) nombre del elemento;
3 - solo estado;
4 - nada;
5 - personalizado.
label_type_image integer Tipo de etiqueta para elementos de grupo de hosts.

Valores posibles:
0 - etiqueta;
2 - (por defecto) nombre del elemento;
4 - nada;
5 - personalizado.
label_type_map integer Tipo de etiqueta para elementos de mapa.

Valores posibles:
0 - etiqueta;
2 - (por defecto) nombre del elemento;
3 - solo estado;
4 - nada;
5 - personalizado.
label_type_trigger integer Tipo de etiqueta para elementos trigger.

Valores posibles:
0 - etiqueta;
2 - (por defecto) nombre del elemento;
3 - solo estado;
4 - nada;
5 - personalizado.
markelements integer Si se deben resaltar los elementos del mapa que hayan cambiado recientemente su estado.

Valores posibles:
0 - (por defecto) no resaltar elementos;
1 - resaltar elementos.
severity_min integer Severidad mínima de los triggers que se mostrarán en el mapa.

Consulte la propiedad severity de trigger para ver una lista de severidades de trigger soportadas.
show_unack integer Cómo se deben mostrar los problemas.

Valores posibles:
0 - (por defecto) mostrar el recuento de todos los problemas;
1 - mostrar solo el recuento de problemas no reconocidos;
2 - mostrar el recuento de problemas reconocidos y no reconocidos por separado.
userid ID ID del usuario que es el propietario del mapa.
private integer Tipo de compartición del mapa.

Valores posibles:
0 - mapa público;
1 - (por defecto) mapa privado.
show_suppressed integer Si se muestran los problemas suprimidos.

Valores posibles:
0 - (por defecto) ocultar problemas suprimidos;
1 - mostrar problemas suprimidos.

Elemento de mapa

El objeto elemento de mapa define un objeto mostrado en un mapa. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
selementid ID ID del elemento de mapa.

Comportamiento de la propiedad:
- solo lectura
elements array Objeto de datos Elemento.

Comportamiento de la propiedad:
- requerido si elementtype está establecido en "host", "map", "trigger" o "host group"
elementtype integer Tipo de elemento de mapa.

Valores posibles:
0 - host;
1 - map;
2 - trigger;
3 - host group;
4 - image.

Comportamiento de la propiedad:
- requerido
iconid_off ID ID de la imagen utilizada para mostrar el elemento en estado por defecto.

Comportamiento de la propiedad:
- requerido
areatype integer Cómo se deben mostrar los hosts de un grupo de hosts.

Valores posibles:
0 - (por defecto) el elemento del grupo de hosts ocupará todo el mapa;
1 - el elemento del grupo de hosts tendrá un tamaño fijo.
elementsubtype integer Cómo se debe mostrar un elemento de grupo de hosts en un mapa.

Valores posibles:
0 - (por defecto) mostrar el grupo de hosts como un solo elemento;
1 - mostrar cada host del grupo por separado.
evaltype integer Condición de filtrado de etiquetas del elemento de mapa método de evaluación.

Valores posibles:
0 - (por defecto) And/Or;
2 - Or.
height integer Altura del elemento de grupo de hosts de tamaño fijo en píxeles.

Por defecto: 200.
iconid_disabled ID ID de la imagen utilizada para mostrar elementos de mapa deshabilitados.

Comportamiento de la propiedad:
- soportado si elementtype está establecido en "host", "map", "trigger" o "host group"
iconid_maintenance ID ID de la imagen utilizada para mostrar elementos de mapa en mantenimiento.

Comportamiento de la propiedad:
- soportado si elementtype está establecido en "host", "map", "trigger" o "host group"
iconid_on ID ID de la imagen utilizada para mostrar elementos de mapa con problemas.

Comportamiento de la propiedad:
- soportado si elementtype está establecido en "host", "map", "trigger" o "host group"
label string Etiqueta del elemento.
label_location integer Ubicación de la etiqueta del elemento de mapa.

Valores posibles:
-1 - (por defecto) ubicación por defecto;
0 - abajo;
1 - izquierda;
2 - derecha;
3 - arriba.
permission integer Tipo de nivel de permiso.

Valores posibles:
-1 - ninguno;
2 - solo lectura;
3 - lectura-escritura.
sysmapid ID ID del mapa al que pertenece el elemento.

Comportamiento de la propiedad:
- solo lectura
urls array URLs del elemento de mapa.

El objeto URL del elemento de mapa se describe en detalle más abajo.
use_iconmap integer Si se debe usar el mapeo de iconos para los elementos host.

Valores posibles:
0 - no usar mapeo de iconos;
1 - (por defecto) usar mapeo de iconos.
viewtype integer Algoritmo de colocación de elementos de grupo de hosts.

Valores posibles:
0 - (por defecto) grid.
width integer Ancho del elemento de grupo de hosts de tamaño fijo en píxeles.

Por defecto: 200.
x integer Coordenadas X del elemento en píxeles.

Por defecto: 0.
y integer Coordenadas Y del elemento en píxeles.

Por defecto: 0.

Elemento de mapa Host

El objeto de elemento de mapa Host define un elemento de host.

Propiedad Tipo Descripción
hostid ID ID del host.

Elemento de mapa Grupo de hosts

El objeto de elemento de mapa Grupo de hosts define un elemento de grupo de hosts.

Propiedad Tipo Descripción
groupid ID ID del grupo de hosts.

Objeto Map de elemento de mapa

El objeto Map de elemento de mapa define un elemento de mapa.

Propiedad Tipo Descripción
sysmapid ID ID del mapa.

Elemento de mapa Trigger

El objeto de elemento de mapa Trigger define uno o más elementos de trigger.

Propiedad Tipo Descripción
triggerid ID ID del trigger.

Etiqueta de elemento de mapa

El objeto Etiqueta de elemento de mapa tiene las siguientes propiedades.

Propiedad Tipo Descripción
tag string Nombre de la etiqueta del elemento de mapa.

Comportamiento de la propiedad:
- obligatorio
operator integer Operador de condición de etiqueta de elemento de mapa.

Valores posibles:
0 - (por defecto) Contiene;
1 - Es igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
value string Valor de la etiqueta del elemento de mapa.

URL del elemento del mapa

El objeto URL del elemento del mapa define un enlace clicable que estará disponible para un elemento de mapa específico. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
sysmapelementurlid ID ID de la URL del elemento del mapa.

Comportamiento de la propiedad:
- solo lectura
name string Título del enlace.

Comportamiento de la propiedad:
- requerido
url string URL del enlace.

Comportamiento de la propiedad:
- requerido
selementid ID ID del elemento del mapa al que pertenece la URL.

Enlace de mapa

El objeto enlace de mapa define un enlace entre dos elementos de mapa. Tiene las siguientes propiedades.

Propiedad Tipo Descripción
linkid ID ID del enlace de mapa.

Comportamiento de la propiedad:
- solo lectura
selementid1 ID ID del primer elemento de mapa enlazado en un extremo.

Comportamiento de la propiedad:
- requerido
selementid2 ID ID del primer elemento de mapa enlazado en el otro extremo.

Comportamiento de la propiedad:
- requerido
color string Color de la línea como código de color hexadecimal.

Por defecto: 000000.
drawtype integer Estilo de dibujo de la línea de enlace.

Valores posibles:
0 - (por defecto) línea;
2 - línea en negrita;
3 - línea punteada;
4 - línea discontinua.
label string Etiqueta del enlace.
linktriggers array Triggers de enlace de mapa a utilizar como indicadores de estado del enlace.

El objeto trigger de enlace de mapa se describe en detalle a continuación.
permission integer Tipo de nivel de permiso.

Valores posibles:
-1 - ninguno;
2 - solo lectura;
3 - lectura-escritura.
sysmapid ID ID del mapa al que pertenece el enlace.

Trigger de enlace de mapa

El objeto trigger de enlace de mapa define un indicador de estado de enlace de mapa basado en el estado de un trigger. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
linktriggerid ID ID del trigger de enlace de mapa.

Comportamiento de la propiedad:
- solo lectura
triggerid ID ID del trigger utilizado como indicador de enlace.

Comportamiento de la propiedad:
- obligatorio
color string Color del indicador como código de color hexadecimal.

Por defecto: DD0000.
drawtype integer Estilo de dibujo del indicador.

Valores posibles:
0 - (por defecto) línea;
2 - línea en negrita;
3 - línea de puntos;
4 - línea discontinua.
linkid ID ID del enlace de mapa al que pertenece el trigger de enlace.

URL de mapa

El objeto URL de mapa define un enlace clicable que estará disponible para todos los elementos de un tipo específico en el mapa. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
sysmapurlid ID ID de la URL del mapa.

Comportamiento de la propiedad:
- solo lectura
name string Título del enlace.

Comportamiento de la propiedad:
- requerido
url string URL del enlace.

Comportamiento de la propiedad:
- requerido
elementtype integer Tipo de elemento de mapa para el que estará disponible la URL.

Consulte la propiedad type del elemento de mapa para ver una lista de los tipos soportados.

Por defecto: 0.
sysmapid ID ID del mapa al que pertenece la URL.

Usuario de mapa

Lista de permisos de mapa basados en usuarios. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
sysmapuserid ID ID del usuario de mapa.

Comportamiento de la propiedad:
- solo lectura
userid ID ID del usuario.

Comportamiento de la propiedad:
- requerido
permission integer Tipo de nivel de permiso.

Valores posibles:
2 - solo lectura;
3 - lectura-escritura.

Comportamiento de la propiedad:
- requerido

Grupo de usuarios del mapa

Lista de permisos de mapas basados en grupos de usuarios. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
sysmapusrgrpid ID ID del grupo de usuarios del mapa.

Comportamiento de la propiedad:
- solo lectura
usrgrpid ID ID del grupo de usuarios.

Comportamiento de la propiedad:
- requerido
permission integer Tipo de nivel de permiso.

Valores posibles:
2 - solo lectura;
3 - lectura-escritura.

Comportamiento de la propiedad:
- requerido

Formas de mapa

El objeto de forma de mapa define una forma geométrica (con o sin texto) mostrada en un mapa. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
sysmap_shapeid ID ID del elemento de forma de mapa.

Comportamiento de la propiedad:
- solo lectura
type integer Tipo de elemento de forma de mapa.

Valores posibles:
0 - rectángulo;
1 - elipse.

La propiedad es obligatoria cuando se crean nuevas formas.

Comportamiento de la propiedad:
- obligatorio
x integer Coordenadas X de la forma en píxeles.

Por defecto: 0.
y integer Coordenadas Y de la forma en píxeles.

Por defecto: 0.
width integer Ancho de la forma en píxeles.

Por defecto: 200.
height integer Alto de la forma en píxeles.

Por defecto: 200.
text string Texto de la forma.
font integer Fuente del texto dentro de la forma.

Valores posibles:
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

Por defecto: 9.
font_size integer Tamaño de la fuente en píxeles.

Por defecto: 11.
font_color string Color de la fuente.

Por defecto: 000000.
text_halign integer Alineación horizontal del texto.

Valores posibles:
0 - centro;
1 - izquierda;
2 - derecha.

Por defecto: 0.
text_valign integer Alineación vertical del texto.

Valores posibles:
0 - medio;
1 - arriba;
2 - abajo.

Por defecto: 0.
border_type integer Tipo de borde.

Valores posibles:
0 - ninguno;
1 - —————;
2 - ·····;
3 - - - -.

Por defecto: 0.
border_width integer Ancho del borde en píxeles.

Por defecto: 0.
border_color string Color del borde.

Por defecto: 000000.
background_color string Color de fondo (color de relleno).

Por defecto: (vacío).
zindex integer Valor utilizado para ordenar todas las formas y líneas (z-index).

Por defecto: 0.

Líneas del mapa

El objeto línea de mapa define una línea que se muestra en un mapa. Tiene las siguientes propiedades:

Propiedad Tipo Descripción
sysmap_shapeid ID ID del elemento de forma del mapa.

Comportamiento de la propiedad:
- solo lectura
x1 integer Coordenadas X del punto 1 de la línea en píxeles.

Por defecto: 0.
y1 integer Coordenadas Y del punto 1 de la línea en píxeles.

Por defecto: 0.
x2 integer Coordenadas X del punto 2 de la línea en píxeles.

Por defecto: 200.
y2 integer Coordenadas Y del punto 2 de la línea en píxeles.

Por defecto: 200.
line_type integer Tipo de línea.

Valores posibles:
0 - ninguno;
1 - —————;
2 - ·····;
3 - - - -.

Por defecto: 0.
line_width integer Ancho de la línea en píxeles.

Por defecto: 0.
line_color string Color de la línea.

Por defecto: 000000.
zindex integer Valor utilizado para ordenar todas las formas y líneas (z-index).

Por defecto: 0.