Objeto de mapa
Los siguientes objetos están directamente relacionados con la API de map.
Map
El objeto map tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| sysmapid | ID | ID del map. Property behavior: - solo lectura - obligatorio para operaciones de actualización |
| height | integer | Altura del map en píxeles. Property behavior: - obligatorio para operaciones de creación |
| name | string | Nombre del map. Property behavior: - obligatorio para operaciones de creación |
| width | integer | Anchura del map en píxeles. Property behavior: - obligatorio para operaciones de creación |
| backgroundid | ID | ID de la imagen utilizada como fondo del map. |
| expand_macros | integer | Indica si se deben expandir macros en las etiquetas al configurar el map. Valores posibles: 0 - (predeterminado) no expandir macros; 1 - expandir macros. |
| expandproblem | integer | Indica si el trigger de problema se mostrará para elementos con un único problema. Valores posibles: 0 - mostrar siempre el número de problemas; 1 - (predeterminado) mostrar el trigger de problema si solo hay un problema. |
| grid_align | integer | Indica si se debe habilitar la alineación a la cuadrícula. Valores posibles: 0 - deshabilitar la alineación a la cuadrícula; 1 - (predeterminado) habilitar la alineación a la cuadrícula. |
| grid_show | integer | Indica si se debe mostrar la cuadrícula en el map. Valores posibles: 0 - no mostrar la cuadrícula; 1 - (predeterminado) mostrar la cuadrícula. |
| grid_size | integer | Tamaño de la cuadrícula del map en píxeles. Valores admitidos: 20, 40, 50, 75 y 100. Predeterminado: 50. |
| highlight | integer | Indica si está habilitado el resaltado de iconos. Valores posibles: 0 - resaltado deshabilitado; 1 - (predeterminado) resaltado habilitado. |
| iconmapid | ID | ID del icon map utilizado en el map. |
| label_format | integer | Indica si se deben habilitar las etiquetas avanzadas. Valores posibles: 0 - (predeterminado) deshabilitar las etiquetas avanzadas; 1 - habilitar las etiquetas avanzadas. |
| label_location | integer | Ubicación de la etiqueta del elemento del map. Valores posibles: 0 - (predeterminado) abajo; 1 - izquierda; 2 - derecha; 3 - arriba. |
| label_string_host | string | Etiqueta personalizada para elementos de host. Property behavior: - obligatorio si label_type_host está establecido en "custom" |
| label_string_hostgroup | string | Etiqueta personalizada para elementos de grupo de host. Property behavior: - obligatorio si label_type_hostgroup está establecido en "custom" |
| label_string_image | string | Etiqueta personalizada para elementos de imagen. Property behavior: - obligatorio si label_type_image está establecido en "custom" |
| label_string_map | string | Etiqueta personalizada para elementos de map. Property behavior: - obligatorio si label_type_map está establecido en "custom" |
| label_string_trigger | string | Etiqueta personalizada para elementos de trigger. Property behavior: - obligatorio si label_type_trigger está establecido en "custom" |
| label_type | integer | Tipo de etiqueta para elementos del map. Valores posibles: 0 - etiqueta; 1 - dirección IP; 2 - (predeterminado) nombre del elemento; 3 - solo estado; 4 - nada. |
| label_type_host | integer | Tipo de etiqueta para elementos de host. Valores posibles: 0 - etiqueta; 1 - dirección IP; 2 - (predeterminado) nombre del elemento; 3 - solo estado; 4 - nada; 5 - personalizado. |
| label_type_hostgroup | integer | Tipo de etiqueta para elementos de grupo de host. 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 de grupo de host. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 4 - nada; 5 - personalizado. |
| label_type_map | integer | Tipo de etiqueta para elementos de map. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - solo estado; 4 - nada; 5 - personalizado. |
| label_type_trigger | integer | Tipo de etiqueta para elementos de trigger. Valores posibles: 0 - etiqueta; 2 - (predeterminado) nombre del elemento; 3 - solo estado; 4 - nada; 5 - personalizado. |
| markelements | integer | Indica si se deben resaltar los elementos del map que han cambiado recientemente su estado. Valores posibles: 0 - (predeterminado) no resaltar elementos; 1 - resaltar elementos. |
| severity_min | integer | Severidad mínima de los triggers que se mostrarán en el map. Consulte la propiedad severity del trigger para obtener una lista de las severidades de trigger admitidas. |
| show_unack | integer | Cómo se deben mostrar los problemas. Valores posibles: 0 - (predeterminado) mostrar el recuento de todos los problemas; 1 - mostrar solo el recuento de problemas no reconocidos; 2 - mostrar por separado el recuento de problemas reconocidos y no reconocidos. |
| userid | ID | ID del usuario que es el propietario del map. |
| private | integer | Tipo de compartición del map. Valores posibles: 0 - map público; 1 - (predeterminado) map privado. |
| show_suppressed | integer | Indica si se muestran los problemas suprimidos. Valores posibles: 0 - (predeterminado) ocultar los problemas suprimidos; 1 - mostrar los problemas suprimidos. |
Elemento de mapa
El objeto elemento de mapa define un objeto mostrado en un mapa. Tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| selementid | ID | ID del elemento de mapa. Property behavior: - solo lectura |
| elements | array | Objeto de datos Element. Property behavior: - obligatorio 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. Property behavior: - obligatorio |
| iconid_off | ID | ID de la imagen usada para mostrar el elemento en estado predeterminado. Property behavior: - obligatorio |
| areatype | integer | Cómo deben mostrarse los hosts de un host group separado. Valores posibles: 0 - (predeterminado) el elemento de host group ocupará todo el mapa; 1 - el elemento de host group tendrá un tamaño fijo. |
| elementsubtype | integer | Cómo debe mostrarse un elemento de host group en un mapa. Valores posibles: 0 - (predeterminado) mostrar el host group como un único elemento; 1 - mostrar cada host del grupo por separado. |
| evaltype | integer | Método de evaluación de la condición de filtrado de etiquetas del elemento de mapa método de evaluación. Valores posibles: 0 - (predeterminado) And/Or; 2 - Or. |
| height | integer | Altura del elemento de host group de tamaño fijo en píxeles. Predeterminado: 200. |
| iconid_disabled | ID | ID de la imagen usada para mostrar elementos de mapa deshabilitados. Property behavior: - compatible si elementtype está establecido en "host", "map", "trigger" o "host group" |
| iconid_maintenance | ID | ID de la imagen usada para mostrar elementos de mapa en mantenimiento. Property behavior: - compatible si elementtype está establecido en "host", "map", "trigger" o "host group" |
| iconid_on | ID | ID de la imagen usada para mostrar elementos de mapa con problemas. Property behavior: - compatible 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 - (predeterminado) ubicación predeterminada; 0 - abajo; 1 - izquierda; 2 - derecha; 3 - arriba. |
| permission | integer | Tipo de nivel de permiso. Valores posibles: -1 - ninguno; 2 - solo lectura; 3 - lectura y escritura. |
| sysmapid | ID | ID del mapa al que pertenece el elemento. Property behavior: - solo lectura |
| urls | array | URLs del elemento de mapa. El objeto URL del elemento de mapa se describe en detalle a continuación. |
| use_iconmap | integer | Si debe usarse el mapeo de iconos para elementos de host. Valores posibles: 0 - no usar mapeo de iconos; 1 - (predeterminado) usar mapeo de iconos. |
| viewtype | integer | Algoritmo de colocación del elemento de host group. Valores posibles: 0 - (predeterminado) cuadrícula. |
| width | integer | Ancho del elemento de host group de tamaño fijo en píxeles. Predeterminado: 200. |
| x | integer | Coordenada X del elemento en píxeles. Predeterminado: 0. |
| y | integer | Coordenada Y del elemento en píxeles. Predeterminado: 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. |
Mapa de elementos Mapa
El objeto de mapa de elementos 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 de 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: - requerido |
| 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 de 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 de enlace de mapa define un enlace entre dos elementos del mapa. Tiene las siguientes propiedades.
| Property | Type | Description |
|---|---|---|
| linkid | ID | ID del enlace de mapa. Property behavior: - read-only |
| selementid1 | ID | ID del primer elemento del mapa vinculado en un extremo. Property behavior: - required |
| selementid2 | ID | ID del primer elemento del mapa vinculado en el otro extremo. Property behavior: - required |
| color | string | Color de la línea como código de color hexadecimal. Default: 000000. |
| drawtype | integer | Estilo de dibujo de la línea del enlace. Possible values: 0 - (default) line; 2 - bold line; 3 - dotted line; 4 - dashed line. |
| label | string | Etiqueta del enlace. |
| linktriggers | array | Triggers del enlace de mapa que se usan como indicadores de estado del enlace. El objeto trigger del enlace de mapa se describe en detalle a continuación. |
| permission | integer | Tipo de nivel de permiso. Possible values: -1 - none; 2 - read only; 3 - read-write. |
| 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:
| Property | Type | Description |
|---|---|---|
| linktriggerid | ID | ID del trigger de enlace de mapa. Property behavior: - read-only |
| triggerid | ID | ID del trigger usado como indicador de enlace. Property behavior: - required |
| color | string | Color del indicador como código de color hexadecimal. Default: DD0000. |
| drawtype | integer | Estilo de dibujo del indicador. Possible values: 0 - (default) line; 2 - bold line; 3 - dotted line; 4 - dashed line. |
| 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 obtener una lista de los tipos soportados.Por defecto: 0. |
| sysmapid | ID | ID del mapa al que pertenece la URL. |
Usuario del mapa
Lista de permisos de mapa basados en usuarios. Tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| sysmapuserid | ID | ID del usuario del 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 del mapa
El objeto de forma del mapa define una forma geométrica (con o sin texto) 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 |
| type | integer | Tipo de elemento de forma del 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 de mapa
El objeto línea de mapa define una línea mostrada 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íneas. Valores posibles: 0 - ninguna; 1 - —————;2 - ·····;3 - - - -.Por defecto: 0. |
| line_width | integer | Ancho de las líneas 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. |