Documentation
Table of Contents
Objecte mapa
Els següents objectes són relacionats amb l'API map.
Mapa
L'objecte mapa té les següents propietats.
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmapid | ID | ID del mapa. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| height | integer | Alçada del mapa en píxels. Comportament de la propietat: - obligatori per operacions de creació |
| name | string | Nom de la tarja. Comportament de la propietat: - obligatori per operacions de creació |
| width | integer | Amplada del mapa en píxels. Comportament de la propietat: - obligatori per operacions de creació |
| backgroundid | ID | ID de la imatge emprada com a fons del mapa. |
| expand_macros | integer | Indica si s'han d'ampliar les macros a les etiquetes quan es configura el mapa. Valors possibles: 0 - (per defecte) no s'amplien; 1 - ampliar macros. |
| expandproblem | integer | Indica si el trigger del problema es mostrarà per als elements amb un sol problema. Valors possibles: 0 - sempre mostra el nombre de problemes; 1 - (per defecte) mostra el trigger del problema si només hi ha un problema. |
| grid_align | integer | Indica si s'ha d'activar l'alineació de la quadrícula. Valors possibles: 0 - desactiva l'alineació de la quadrícula; 1 - (per defecte) activa l'encaix a la quadrícula. |
| grid_show | integer | Indica si s'ha de veure la graella al mapa. Valors possibles: 0 - no mostra la graella; 1 - (per defecte) mostra la graella . |
| grid_size | integer | Mida de la quadrícula del mapa en píxels. Valors admesos: 20, 40, 50, 75 i 100. Per defecte: 50. |
| highlight | integer | Indica si el ressaltat de les icones és habilitat. Valors possibles: 0 - ressaltat desactivat; 1 - (per defecte) ressaltat activat. |
| iconmapid | ID | ID del mapa d'icones emprat al mapa. |
| label_format | integer | Indica si s'han d'activar les etiquetes avançades. Valors possibles: 0 - (per defecte) desactiva les etiquetes avançades; 1 - activa-les. |
| label_location | integer | Ubicació de l'etiqueta de l'element del mapa. Valors possibles: 0 - (per defecte) inferior; 1 - esquerra;<br >2 - dreta;< br>3 - a dalt. |
| label_string_host | string | Etiqueta personalitzada per als elements d'equip. Comportament de la propietat: - obligatori si label_type_host és "custom" |
| label_string_hostgroup | string | Etiqueta personalitzada per als elements del grup d'equips. Comportament de la propietat: - obligatori si label_type_hostgroup és "custom" |
| label_string_image | string | Etiqueta personalitzada per als elements d'imatge. Comportament de la propietat: - obligatori si label_type_image és "custom" |
| label_string_map | string | Etiqueta personalitzada per als elements del mapa. Comportament de la propietat: - obligatori si label_type_map és "custom" |
| label_string_trigger | string | Etiqueta personalitzada per als elements trigger. Comportament de la propietat: - obligatori si label_type_string és "custom" |
| label_type | integer | Tipus d'etiqueta d'element del mapa. Valors possibles: 0 - etiqueta; 1 - adreça IP; 2 - (per defecte) nom de l'element;< br>3 - només estat; 4 - res. |
| label_type_host | integer | Tipus d'etiqueta per als elements de l'equip. Valors possibles: 0 - etiqueta; 1 - adreça IP; 2 - (per defecte) nom de l'element; 3 - només estat; 4 - res; 5 - personalitzat. |
| label_type_hostgroup | integer | Tipus d'etiqueta per als elements del grup d'equips. Valors possibles: 0 - etiqueta; 2 - (per defecte) nom de l'element; 3 - només estat; 4 - res; 5 - personalitzat. |
| label_type_image | integer | Tipus d'etiqueta per als elements de la imatge. Valors possibles: 0 - etiqueta; 2 - (per defecte) nom de l'element; 4 - res; 5 - personalitzat. |
| label_type_map | integer | Tipus d'etiqueta per als elements del mapa. Valors possibles: 0 - etiqueta; 2 - (per defecte) nom de l'element; 3 - només estat; 4 - res; 5 - personalitzat. |
| label_type_trigger | integer | Tipus d'etiqueta per als triggers. Valors possibles: 0 - etiqueta; 2 - (per defecte) nom de l'element; 3 - només estat; 4 - res; 5 - personalitzat. |
| markelements | integer | Indica si cal ressaltar els elements del mapa que han canviat d'estat recentment. Valors possibles: 0 - (per defecte) no ressalten els elements; 1 - ressalten els elements. |
| severity_min | integer | Gravetat mínima dels triggers que es mostraran al mapa. Consulteu la propietat "gravetat" d'un trigger per obtindre un llistat de les gravetats admeses. |
| show_unack | integer | Com s'han de veure els problemes. Valors possibles: 0 - (per defecte) ensenya el recompte de tots els problemes; 1 - ensenya només el nombre de problemes no reconeguts; 2 - ensenya el nombre de problemes reconeguts i no reconeguts per separat. |
| userid | ID | identificador de l'usuari propietari del mapa. |
| private | integer | Tipus de compartició del mapa. Valors possibles: 0 - mapa públic; 1 - (per defecte) mapa privat. |
| show_suppressed | integer | Indica si es mostren els problemes suprimits. Valors possibles: 0 - (per defecte) amaga els problemes suprimits; 1 - ensenya els problemes suprimits. |
Element de mapa
L'objecte d'element del mapa defineix un objecte que es mostra en un mapa. Té les següents propietats.
| Propietat | Tipus | Descripció |
|---|---|---|
| selementid | ID | ID de l'element del mapa. Comportament de la propietat: - només lectura |
| elements | array | Objecte de dades de l'element. Comportament de la propietat: - obligatori si elementtype és "equip", "mapa", "trigger" o "grup d'equips" |
| elementtype | integer | Tipus d'element del mapa. Valors possibles: 0 - equip; 1 - mapa; 2 - trigger;< br>3 - grup d'equips; 4 - imatge. Comportament de la propietat: - obligatori |
| iconid_off | ID | ID de la imatge emprada per ensenyar l'element en estat predeterminat. Comportament de la propietat: - obligatori |
| areatype | integer | Com s'han d'ensenyar diferents equips del grup d'equips. Valors possibles: 0 - (per defecte) l'element del grup d'equips ocuparà tot el mapa; 1 - l'element del grup d'equips tindrà una mida fixa. |
| elementsubtype | integer | Com s'ha d'ensenyar un element del grup d'equips al mapa. Valors possibles: 0 - (per defecte) mostra el grup d'equips com a element únic; 1 - mostra cada equip al grup per separat. |
| evaltype | integer | Mètode per avaluar les condicions del filtre d'etiquetes d'elements del mapa. Valors possibles: 0 - (per defecte) I/O; 2 - O. |
| height | integer | Alçada de l'element del grup d'equips de mida fixa en píxels. Per defecte: 200. |
| iconid_disabled | ID | ID de la icona emprada per ensenyar els elements del mapa desactivats. Comportament de la propietat: - admès si elementtype és "equip", "mapa", "trigger" o "grup d'equips" |
| iconid_maintenance | ID | Identificador de la icona que s'empra per ensenyar els elements del mapa en manteniment. Comportament de la propietat: - admès si elementtype és "equip", "mapa", "trigger" o "grup d'equips" |
| iconid_on | ID | Identificador de la icona que s'empra per ensenyar els elements del mapa amb problemes. Comportament de la propietat: - admès si elementtype és "equip", "mapa", "trigger" o "grup d'equips" |
| label | string | Etiqueta de l'element. |
| label_location | integer | Posició de l'etiqueta de l'element del mapa. Valors possibles: -1 - (per defecte) posició per defecte; 0 - sota; 1 - esquerra; 2 - dreta; 3 - dalt. |
| permission | integer | Tipus de nivell de permís. Valors possibles: -1 - cap; 2 - només lectura; 3 - lectura-escriptura. |
| sysmapid | ID | ID del mapa al qual pertany l'element. Comportament de la propietat: - només lectura |
| urls | array | elements del mapa d'URL. L'objecte de l'element del mapa d'URL és descrit en detall a continuació. |
| use_iconmap | integer | Indica si s'ha d'emprar l'assignació d'icones per als elements de l'equip. Valors possibles: 0 - no empreu pas l'assignació d'icones; 1 - (per defecte) empreu la icona cartografia. |
| viewtype | integer | Algorisme d'ubicació d'elements del grup d'equips. Valors possibles: 0 - (per defecte) quadrícula. |
| width | integer | Amplada de l'element del grup d'equips de mida fixa en píxels. Per defecte: 200. |
| x | integer | Coordenada X de l'element en píxels. Per defecte: 0. |
| y | integer | Coordenada Y de l'element en píxels. Per defecte: 0. |
Element de mapa d'quip
L'objecte element de mapa d'equips defineix un o més elements d'equips.
| Propietat | Tipus | Descripció |
|---|---|---|
| hostid | ID | ID de l'equip. |
Element de mapa grup d'equips
L'objecte element de mapa de grups d'equips defineix un o més elements de grups d'equips.
| Propietat | Tipus | Descripció |
|---|---|---|
| groupid | ID | ID del grup d'equips. |
Element de mapa Mapa
L'objecte element de mapa Mapa defineix un o més elements de Mapes.
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmapid | ID | ID del mapa. |
Element de mapa Trigger
L'objecte element de mapa Trigger defineix un o més triggers d'elements.
| Propietat | Tipus | Descripció |
|---|---|---|
| triggerid | ID | ID del trigger. |
Element del mapa Etiqueta
L'objecte d'element de mapa Etiqueta té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| tag | cadena | Nom d'etiqueta de l'element del mapa. Comportament de la propietat: - obligatori |
| operator | string | Operador de condició d'etiqueta d'element de mapa. Valors possibles : 0 - (per defecte) Conté; 1 - Iguals; 2 - No en conté; 3 - No és igual; 4 - Existeix; 5 - No existeix. |
| value | string | Valor d'etiqueta d'element de carta. |
Element de mapa URL
L'objecte element de mapa URL defineix un enllaç clicable que serà disponible per a un element de mapa concret. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmapelementurlid | ID | ID de l'element de mapa URL. Comportament de la propietat: - només lectura |
| name | string | Llegenda d'enllaç. Comportament de la propietat: - obligatori |
| url | string | URL de l'enllaç. Comportament de la propietat: - obligatori |
| selementid | ID | ID de l'element de mapa on pertany l'URL. |
Enllaç de mapa
L'objecte d'enllaç al mapa defineix un enllaç entre dos elements del mapa. Té les següents propietats.
| Propietat | Tipus | Descripció |
|---|---|---|
| linkid | ID | ID de l'enllaç del mapa. Comportament de la propietat: - només lectura |
| selementid1 | ID | ID del primer element del mapa enllaçat al final. Comportament de la propietat: - obligatori |
| selementid2 | ID | ID del primer element del mapa enllaçat a l'altre extrem. Comportament de la propietat: - obligatori |
| color | string | Color de línia com a codi de color hexadecimal. Per defecte: 000000. |
| drawtype | integer | Estil de línia d'enllaç. Valors possibles: 0 - (per defecte) línia; 2 - línia en negreta; 3 - línia de punts; 4 - línia amb guions. |
| label | string | Etiqueta d'enllaç. |
| linktriggers | array | L'enllaç del mapa s'activa per emprar-lo com a indicadors d'estat de l'enllaç. L'objecte trigger de l'enllaç del mapa és descrit en detall a continuació. |
| permission | integer | Tipus de nivell de permís. Valors possibles: -1 - cap; 2 - només lectura; 3 - lectura-escriptura. |
| sysmapid | ID | ID del mapa al qual pertany l'enllaç. |
Trigger d'enllaç de mapa
L'objecte estableix un indicador d'estat d'enllaç de mapa en funció de l'estat d'un trigger. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| linktriggerid | ID | ID del trigger de l'enllaç del mapa. Comportament de la propietat: - només lectura |
| triggerid | string | ID del trigger emprat com a indicador d'enllaç. Comportament de la propietat: - obligatori |
| color | string | Color de l'indicador com a codi de color hexadecimal. Per defecte: DD0000. |
| drawtype | integer | Estil de dibuix de l'indicador. Valors possibles: 0 - (per defecte) línia; 2 - línia en negreta; 3 - línia puntejada; 4 - línia amb guions. |
| linkid | ID | ID de l'enllaç del mapa al qual pertany el trigger de l'enllaç. |
Element de mapa URL
L'objecte element de mapa URL defineix un enllaç clicable que serà disponible per a un element de mapa concret. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmapurlid | ID | ID del mapa URL. Comportament de la propietat: - només lectura |
| name | string | Llegenda d'enllaç. Comportament de la propietat: - obligatori |
| url | string | URL de l'enllaç. Comportament de la propietat: - obligatori |
| elementtype | integer | Tipus d'element de mapa per al que l'URL serà disponible. Veieu el llistat de tipus admesos a la propietat type de mapa d'element.Per defecte: 0. |
| sysmapid | ID | ID del mapa on pertany l'URL. |
Usuaris del tauler
Llistat dels permisos del tauler en funció dels usuaris. L'objecte té les següents propietats:
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmapuserid | ID | ID del mapa d'usuari. Comportament de la propietat: - només lectura |
| userid | ID | ID de l'usuari. Comportament de la propietat: - obligatori |
| permission | integer | Tipus del nivell de permisos. Valors possibles: 2 - només lectura; 3 - lectura i escriptura. Comportament de la propietat: - obligatori |
Grup d'usuaris del mapa
Llistat dels permisos del mapa en funció dels grups d'usuaris. L'objecte té les següents propietats:
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmapusrgrpid | ID | ID del mapa del grup d'usuaris. Comportament de la propietat: - només lectura |
| usrgrpid | ID | ID del grup d'usuaris. Comportament de la propietat: - obligatori |
| permission | integer | Tipus del nivell de permisos. Valors possibles: 2 - només lectura; 3 - lectura i escriptura. Comportament de la propietat: - obligatori |
Formes del mapa
L'objecte defineix una forma geomètrica (amb text o sense) que s'ensenya a un mapa. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmap_shapeid | ID | ID de la forma del mapa. Comportament de la propietat: - només lectura |
| tipus | integer | Tipus de la forma del mapa. Valors possibles: 0 - rectangle; 1 - el·lipse. Aquesta propietat és necessària quan es creen noves formes. Comportament de la propietat: - obligatori |
| x | integer | Coordenada X de la forma en píxels. Per defecte: 0. |
| y | integer | Coordenada Y de la forma en píxels. Per defecte: 0. |
| width | integer | Amplada de la forma en píxels. Per defecte: 200. |
| height | integer | Alçada de la forma en píxels. Per defecte: 200. |
| text | string | Formulari de text. |
| font | integer | Tipus de lletra del text en forma. Valors possibles: 0 - Geòrgia, 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, Ginebra, sans-serif 9 - “Trebuchet MS”, Helvetica, sans-serif 10 - Verdana, Ginebra, sans-serif 11 - “Courier New”, Courier, monospace 12 - “Lucida Console”, Mònaco, monospace Per defecte: 9. |
| font_size | integer | Mida del tipus de lletra en píxels. Per defecte: 11. |
| font_color | string | color de la font. Per defecte: '000000'. |
| text_halign | integer | Alineació de text horitzontal. Valors possibles: 0 - centre; 1 - esquerra; 2 - dreta. Per defecte: 0 . |
| text_valign | integer | Alineació vertical del text Valors possibles: 0 - mig; 1 - superior; 2 - inferior. Per defecte: 0. |
| border_type | integer | Tipus de vora. Valors possibles: 0 - cap; 1 - —————;2 - ···· · ;3 - - - -.Per defecte: 0. |
| border_width | integer | Amplada de la vora en píxels. Per defecte: 0. |
| border_color | string | Color de la vora. Per defecte: '000000'. |
| background_color | cadena | Color de fons (color de farcit). Per defecte: (buida). |
| zindex | integer | Valor emprat per ordenar totes les formes i línies (índex z). Per defecte: 0. |
Línies de mapes
L'objecte defineix una línia que es mostra en un mapa. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| sysmap_shapeid | ID | ID de la forma del mapa. Comportament de la propietat: - només lectura |
| x1 | integer | Coordenada X del punt 1 de la línia en píxels. Per defecte: 0. |
| y1 | integer | Coordenada Y del punt 1 de la línia en píxels. Per defecte: 0. |
| x2 | integer | Coordenada X del punt 2 de la línia en píxels. Per defecte: 200. |
| y2 | integer | Coordenada Y del punt 2 de la línia en píxels. Per defecte: 200. |
| line_type | integer | Tipus de línia. Valors possibles: 0 - cap; 1 - —————;2 - ···· ·;3 - - - -.Per defecte: 0. |
| line_width | integer | Amplada de línia en píxels. Per defecte: 0. |
| line_color | string | Color de línia. Per defecte: 000000. |
| zindex | integer | Valor emprat per ordenar totes les formes i línies (índex z). Per defecte: 0. |