Table of Contents

> Objeto de mapa

> Objeto de mapa

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

Mapa

El objeto de mapa tiene las siguientes propiedades.

Propiedad	Tipo	Descripción
sysmapid	string	(readonly) ID del mapa.
height (obligatorio)	entero	Alto del mapa en píxeles.
name (obligatorio)	cadena	Nombre del mapa.
width (obligatorio)	entero	Ancho del mapa en píxeles.
backgroundid	cadena	ID de la imagen utilizada como fondo del mapa.
expand_macros	entero	Si se deben expandir las macros en las etiquetas al configurar el mapa. Valores posibles: 0 - (predeterminado) no expandir las macros; 1 - expandir las macros.
expandproblem	entero	Si el iniciador del problema se mostrará para métricas con un solo problema. Valores posibles: 0: siempre muestra el número de problemas; 1 - (predeterminado) muestra el iniciador del problema si solo hay un problema.
grid_align	entero	Si se debe habilitar la alineación de la cuadrícula. Valores posibles: 0 - deshabilitar la alineación de la cuadrícula; 1 - (predeterminado) habilitar la alineación de la cuadrícula.
grid_show	entero	Si se debe mostrar la cuadrícula en el mapa. Valores posibles: 0 - no mostrar la cuadrícula; 1 - (predeterminado) mostrar la cuadrícula.
grid_size	entero	Tamaño de la cuadrícula del mapa en píxeles. Valores admitidos: 20, 40, 50, 75 y 100. Predeterminado: 50.
highlight	entero	Si el resaltado de iconos está habilitado. Valores posibles: 0 - resaltado deshabilitado; 1 - (predeterminado) resaltado habilitado.
iconmapid	string	ID del mapa de iconos utilizado en el mapa.
label_format	entero	Si se deben habilitar etiquetas avanzadas. Valores posibles: 0 - (predeterminado) deshabilitar etiquetas avanzadas; 1 - habilitar etiquetas avanzadas.
label_location	entero	Ubicación de la etiqueta del elemento del mapa. Valores posibles: 0 - (predeterminado) abajo; 1 - izquierda; 2 - derecha;< br>3 - arriba.
label_string_host	string	Etiqueta personalizada para elementos de equipo. Requerido para mapas con tipo de etiqueta de equipo personalizado.
label_string_hostgroup	cadena	Etiqueta personalizada para elementos del grupo de equipos. Obligatoria para mapas con tipo de etiqueta de grupo de equipos personalizado.
label_string_image	cadena	Etiqueta personalizada para elementos de imagen. Obligatoria para mapas con tipo de etiqueta de imagen personalizada.
label_string_map	string	Etiqueta personalizada para elementos de mapa. Obligatoria para mapas con tipo de etiqueta de mapa personalizada.
label_string_trigger	cadena	Etiqueta personalizada para elementos de activación. Obligatoria para mapas con tipo de etiqueta de activación personalizada.
label_type	entero	Tipo de etiqueta del elemento del mapa. Valores posibles: 0 - etiqueta; 1 - dirección IP; 2 - (predeterminado) nombre del elemento;< br>3 - solo estado; 4 - nada.
label_type_host	entero	Tipo de etiqueta para elementos de equipo. Valores posibles: 0 - etiqueta; 1 - dirección IP; 2 - elemento (predeterminado) nombre; 3 - solo estado; 4 - nada; 5 - personalizado.
label_type_hostgroup	integer	Tipo de etiqueta para elementos del grupo de equipos. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - solo estado; 4 - nada; 5 - personalizado.
label_type_image	integer	Tipo de etiqueta para elementos del grupo de equipos. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 4 - nada; 5 - personalizado.
label_type_map	integer	Tipo de etiqueta para elementos del mapa. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - estado solamente; 4 - nada; 5 - personalizado.
label_type_trigger	integer	Tipo de etiqueta para elementos de iniciador. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - estado solamente; 4 - nada; 5 - personalizado.
markelements	integer	Si se deben resaltar elementos del mapa que han cambiado recientemente su estado. Valores posibles: 0 - (predeterminado) no resaltar elementos; 1 - resaltar elementos.
severity_min	integer	Severidad mínima de los iniciadores que se mostrarán en el mapa. Consulte la propiedad "gravedad" del iniciador para obtener una lista de gravedades de activación admitidas.
show_unack	integer	Cómo se deben mostrar los problemas. Valores posibles: 0 - (predeterminado) muestra el recuento de todos los problemas; 1 - muestra solo el recuento de los no reconocidos problemas; 2: muestra el recuento de problemas reconocidos y no reconocidos por separado.
userid	cadena	ID de usuario del propietario del mapa.
private	entero	Tipo de mapa compartido. Valores posibles: 0 - mapa público; 1 - (predeterminado) mapa privado.
show_suppressed	integer	Si se muestran los problemas suprimidos. Valores posibles: 0 - (predeterminado) oculta los problemas suprimidos; 1 - muestra los problemas suprimidos.

Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.

Elemento de mapa

El objeto de elemento de mapa define un objeto que se muestra en un mapa. Tiene las siguientes propiedades.

Propiedad	Tipo	Descripción
selementid	cadena	(readonly) ID del elemento de mapa.
elements (obligatorio)	matriz	Objeto de datos de elemento. Requerido para elementos de tipo host, grupo de hosts, desencadenante y mapa.
elementtype (obligatorio)	entero	Tipo de elemento de mapa. Valores posibles: 0 - host; 1 - mapa; 2 - iniciador; 3 - grupo de equipos; 4 - imagen.
iconid_off (obligatorio)	cadena	ID de la imagen utilizada para mostrar el elemento en el estado predeterminado.
areatype	entero	Cómo se deben mostrar los equipos del grupo de equipos por separado. Valores posibles: 0 - (predeterminado) el elemento del grupo de equipos ocupará todo el mapa; 1 - el elemento del grupo de equipos tendrá un tamaño fijo.
elementsubtype	entero	Cómo se debe mostrar un elemento del grupo de equipos en un mapa. Valores posibles: 0 - (predeterminado) muestra el grupo de equipos como un solo elemento; 1 - mostrar cada equipo del grupo por separado.
evaltype	entero	Método de evaluación de condición de filtrado de etiqueta de elemento de mapa. Valores posibles: 0 - (predeterminado) AND / OR; 2 - OR.
height	entero	Altura del elemento del grupo de equipos de tamaño fijo en píxeles. Predeterminado: 200.
iconid_disabled	cadena	ID de la imagen utilizada para mostrar elementos de mapa deshabilitados. No utilizado para elementos de imagen.
iconid_maintenance	cadena	ID de la imagen utilizada para mostrar elementos del mapa en mantenimiento. No utilizado para elementos de imagen.
iconid_on	cadena	ID de la imagen utilizada para mostrar los elementos del mapa con problemas. No utilizado para elementos de imagen.
label	cadena	Etiqueta del elemento.
label_location	entero	Ubicación de la etiqueta del elemento del mapa. Valores posibles: -1 - (predeterminado) ubicación predeterminada; 0 - abajo; 1 - izquierda ; 2 - derecha; 3 - arriba.
permission	entero	Tipo de nivel de permiso. Valores posibles: -1 - ninguno; 2 - solo lectura; 3 - lectura-escritura.
sysmapid	cadena	(readonly) ID del mapa al que pertenece el elemento.
urls	array	URL de elementos de mapa. El objeto de URL de elemento de mapa se describe en detalle a continuación.
use_iconmap	entero	Si se debe utilizar la asignación de iconos para los elementos del equipo. Valores posibles: 0 - no usar la asignación de iconos; 1 - (predeterminado) usar la asignación de iconos .
viewtype	entero	Algoritmo de colocación de elementos del grupo de equipos. Valores posibles: 0 - (predeterminado) cuadrícula.
width	entero	Ancho del elemento del grupo de equipos de tamaño fijo en píxeles. Predeterminado: 200.
x	entero	Coordenadas X del elemento en píxeles. Predeterminado: 0.
y	entero	Coordenadas Y del elemento en píxeles. Predeterminado: 0.

Elemento de mapa de equipos

El objeto de elemento de mapa de equipos define un elemento equipo.

Propiedad	Tipo	Descripción
hostid	cadena	ID de equipo

Elemento de mapa grupo de equipos

El objeto de elemento de mapa de grupo de equipos define un elemento del grupo de equipos.

Propiedad	Tipo	Descripción
groupid	cadena	ID del grupo de equipos

Elemento de mapa Mapa

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

Propiedad	Tipo	Descripción
sysmapid	cadena	ID de mapa

Elemento de mapa Iniciador

El objeto iniciador del elemento de mapa define uno o más elementos de iniciador.

Propiedad	Tipo	Descripción
triggerid	cadena	ID de iniciador

Etiqueta de elemento de mapa

El objeto de etiqueta del elemento de mapa tiene las siguientes propiedades.

Propiedad	Tipo	Descripción
tag (obligatorio)	cadena	Nombre de etiqueta del elemento de mapa.
operator	entero	Operador de condición de etiqueta de elemento de mapa. Valores posibles: 0 - (predeterminado) Contiene; 1 - Es igual; 2 - No contiene;<br >3 - No es igual; 4 - Existe; 5 - No existe.
value	cadena	Valor de etiqueta de elemento de mapa.

URL del elemento del mapa

El objeto URL del elemento del mapa define un enlace en el que se puede hacer clic y que estará disponible para un elemento de mapa específico. Tiene las siguientes propiedades:

Propiedad	Tipo	Descripción
sysmapelementurlid	string	(readonly) ID de la URL del elemento del mapa.
nombre (obligatorio)	cadena	Título del enlace.
url (obligatorio)	cadena	URL del enlace.
selementid	cadena	ID del elemento del mapa al que pertenece la URL.

Enlace al mapa

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

Propiedad	Tipo	Descripción
linkid	cadena	(readonly) ID del enlace del mapa.
selementid1 (obligatorio)	cadena	ID del primer elemento del mapa vinculado en un extremo.
selementid2 (obligatorio)	cadena	ID del primer elemento del mapa vinculado en el otro extremo.
color	cadena	Color de línea como código de color hexadecimal. Predeterminado: `000000`.
drawtype	entero	Estilo de dibujo de línea de enlace. Valores posibles: 0 - (predeterminado) línea; 2 - línea en negrita; 3 - línea de puntos; 4 - línea discontinua.
label	cadena	Etiqueta de enlace.
linktriggers	array	Activadores de enlace de mapa para usar como indicadores de estado de enlace. El objeto activador de enlace de mapa se describe en detalle a continuación.
permission	entero	Tipo de nivel de permiso. Valores posibles: -1 - ninguno; 2 - solo lectura; 3 - lectura-escritura.
sysmapid	cadena	ID del mapa al que pertenece el enlace.

Activador de enlace de mapa

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

Propiedad	Tipo	Descripción
linktriggerid	cadena	(readonly) ID del activador del enlace del mapa.
triggerid (obligatorio)	cadena	ID del iniciador utilizado como indicador de enlace.
color	cadena	Color del indicador como código de color hexadecimal. Predeterminado: `DD0000`.
drawtype	entero	Estilo de dibujo del indicador. Valores posibles: 0 - (predeterminado) línea; 2 - línea en negrita; 3 - línea de puntos; 4 - línea discontinua.
linkid	cadena	ID del enlace del mapa al que pertenece el activador del enlace.

URL del mapa

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

Propiedad	Tipo	Descripción
sysmapurlid	cadena	(readonly) ID de la URL del mapa.
name (obligatorio)	cadena	Título del enlace.
url (obligatorio)	cadena	URL del enlace.
elementtype	entero	Tipo de elemento de mapa para el cual la URL estará disponible. Consulte la propiedad "tipo" del elemento de mapa para obtener una lista de los tipos admitidos. < br>Predeterminado: 0.
sysmapid	cadena	ID del mapa al que pertenece la URL.

Usuario del mapa

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

Propiedad	Tipo	Descripción
sysmapuserid	cadena	(readonly) ID del usuario del mapa.
userid (obligatorio)	cadena	ID de usuario.
permission (obligatorio)	entero	Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura;

Grupo de usuarios del mapa

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

Propiedad	Tipo	Descripción
sysmapusrgrpid	string	(readonly) ID del grupo de usuarios del mapa.
usrgrpid (obligatorio)	cadena	ID del grupo de usuarios.
permission (obligatorio)	entero	Tipo de nivel de permiso. Valores posibles: 2 - solo lectura; 3 - lectura-escritura;

Formas del 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	cadena	(readonly) ID del elemento de forma del mapa.
type (obligatorio)	entero	Tipo de elemento de forma de mapa. Valores posibles: 0 - rectángulo; 1 - elipse. Propiedad obligatoria cuando se crean nuevas formas.
x	entero	Coordenadas X de la forma en píxeles. Predeterminado: 0.
y	entero	Coordenadas Y de la forma en píxeles. Predeterminado: 0.
width	entero	Ancho de la forma en píxeles. Predeterminado: 200.
height	entero	Altura de la forma en píxeles. Predeterminado: 200.
text	cadena	Texto de la forma.
font	entero	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”, cursiva , sans-serif 6 - Impact, Charcoal, sans-serif 7 - “Lucida Sans Unicode”, “Lucida Grande”, sans-serif 8 - Tahoma, Ginebra, sans-serif 9 - “Trebuchet MS”, Helvetica, sans-serif 10 - Verdana, Ginebra, sans-serif 11 - “Courier New”, Courier, monoespaciado 12 - “Lucida Console”, Mónaco, monoespaciado Predeterminado: 9.
font_size	entero	Tamaño de fuente en píxeles. Predeterminado: 11.
font_color	cadena	Color de fuente. Predeterminado: '000000'.
text_halign	entero	Alineación horizontal del texto. Valores posibles: 0 - centro; 1 - izquierda; 2 - derecha. Predeterminado: 0.
text_valign	entero	Alineación vertical del texto. Valores posibles: 0 - medio; 1 - arriba; 2 - abajo. Predeterminado: 0.
border_type	entero	Tipo de borde. Valores posibles: 0 - ninguno; 1 - `—————`; 2 - `··· ··`; 3 - `- - -`. Predeterminado: 0.
border_width	entero	Ancho del borde en píxeles. Predeterminado: 0.
border_color	cadena	Color del borde. Predeterminado: '000000'.
background_color	cadena	Color de fondo (color de relleno). Predeterminado: `(vacío)`.
zindex	entero	Valor utilizado para ordenar todas las formas y líneas (índice z). Predeterminado: 0.

Líneas del mapa

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

Propiedad	Tipo	Descripción
sysmap_shapeid	cadena	(readonly) ID del elemento de forma del mapa.
x1	entero	Coordenadas X del punto de línea 1 en píxeles. Predeterminado: 0.
y1	entero	Coordenadas Y del punto de línea 1 en píxeles. Predeterminado: 0.
x2	entero	Coordenadas X del punto de línea 2 en píxeles. Predeterminado: 200.
y2	entero	Coordenadas Y del punto de línea 2 en píxeles. Predeterminado: 200.
line_type	integer	Tipo de las líneas. Valores posibles: 0 - ninguno; 1 - `—————`; 2 - `··· ··`; 3 - `- - -`. Predeterminado: 0.
line_width	entero	Ancho de las líneas en píxeles. Predeterminado: 0.
line_color	cadena	Color de línea. Predeterminado: '000000'.
zindex	entero	Valor utilizado para ordenar todas las formas y líneas (índice z). Predeterminado: 0.

Documentation