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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmapid | string | (nom¨¦s lectura) ID del mapa. |
| height (obligatori) |
integer | Al?ada del mapa en p¨ªxels. |
| name (obligatori) |
string | Nom de la tarja. |
| width (obligatori) |
integer | Amplada del mapa en p¨ªxels. |
| backgroundid | string | 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 ±ç³Ü²¹»å°ù¨ª³¦³Ü±ô²¹. Valors possibles: 0 - desactiva l'alineaci¨® de la quadr¨ªcula; 1 - (per defecte) activa l'encaix a la ±ç³Ü²¹»å°ù¨ª³¦³Ü±ô²¹. |
| 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 | string | 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. Requerit per als mapes amb tipus d'etiqueta d'equip personalitzat. |
| label_string_hostgroup | string | Etiqueta personalitzada per als elements del grup d'equips. Requerit per als mapes amb tipus d'etiqueta de grup d'equips personalitzat. |
| label_string_image | string | Etiqueta personalitzada per als elements d'imatge. Requerit per als mapes amb tipus d'etiqueta d'imatge personalitzada. |
| label_string_map | string | Etiqueta personalitzada per als elements del mapa. Requerit per als mapes amb tipus d'etiqueta de mapa personalitzat. |
| label_string_trigger | string | Etiqueta personalitzada per als elements trigger. Obligatori per a targetes amb tipus d'etiqueta trigger personalitzat. |
| 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 | string | 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. |
Tingueu en compte que per a alguns m¨¨todes (actualitzar, esborrar) la combinaci¨® de par¨¤metres obligatoris/opcionals ¨¦s diferent.
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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| selementid | string | (nom¨¦s lectura) ID de l'element del mapa. |
| elements (obligatori) |
array | Objecte de dades de l'element. Necessari per a elements d'equip, grup d'equips, trigger i tipus de mapa. |
| elementtype (obligatori) |
integer | Tipus d'element del mapa. Valors possibles: 0 - equip; 1 - mapa; 2 - trigger;< br>3 - grup d'equips; 4 - imatge. |
| iconid_off (obligatori) |
string | ID de la imatge emprada per ensenyar l'element en estat predeterminat. |
| 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 | string | ID de la icona emprada per ensenyar els elements del mapa desactivats. No s'empra per a elements de tipus d'imatge. |
| iconid_maintenance | string | Identificador de la icona que s'empra per ensenyar els elements del mapa en manteniment. No s'empra per a elements de tipus d'imatge. |
| iconid_on | string | Identificador de la icona que s'empra per ensenyar els elements del mapa amb problemes. No s'empra per a elements de tipus d'imatge. |
| 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 | string | (nom¨¦s lectura) ID del mapa al qual pertany l'element. |
| 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) ±ç³Ü²¹»å°ù¨ª³¦³Ü±ô²¹. |
| 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 Equip
L'objecte element de mapa d'equips defineix un o m¨¦s elements d'equips.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| hostid | string | ID del grup d'equips. |
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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| groupid | string | 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmapid | string | ID del mapa. |
Element de mapa Trigger
L'objecte element de mapa Trigger defineix un o m¨¦s triggers d'elements.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| triggerid | string | ID del trigger. |
Element del mapa Etiqueta
L'objecte d'element de mapa Etiqueta t¨¦ les propietats seg¨¹ents.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| tag (obligatori) |
cadena | Nom d'etiqueta de l'element del mapa. |
| operator | enter | Operador de condici¨® d'etiqueta d'element de mapa. Valors possibles : 0 - (per defecte) °ä´Ç²Ô³Ù¨¦; 1 - Iguals; 2 - No en cont¨¦; 3 - No ¨¦s igual; 4 - Existeix; 5 - No existeix. |
| value | cadena | Valor d'etiqueta d'element de mapa. |
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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmapelementurlid | string | (nom¨¦s lectura) ID de l'element de mapa URL. |
| name (obligatori) |
string | Llegenda d'enlla?. |
| url (obligatori) |
string | URL de l'enlla?. |
| selementid | string | 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| linkid | string | (nom¨¦s ectura) ID de l'enlla? del mapa. |
| selementid1 (obligatori) |
string | ID del primer element del mapa enlla?at al final. |
| selementid2 (obligatori) |
string | ID del primer element del mapa enlla?at a l'altre extrem. |
| 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) ±ô¨ª²Ô¾±²¹; 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 | string | 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| linktriggerid | string | (nom¨¦s lectura) ID del trigger de l'enlla? del mapa. |
| triggerid (obligatori) |
string | ID del trigger emprat com a indicador d'enlla?. |
| color | string | Color de l'indicador com a codi de color hexadecimal. Per defecte: DD0000. |
| tipus de dibuix | integer | Estil de dibuix de l'indicador. Valors possibles: 0 - (per defecte) ±ô¨ª²Ô¾±²¹; 2 - l¨ªnia en negreta; 3 - l¨ªnia puntejada; 4 - l¨ªnia amb guions. |
| linkid | string | ID de l'enlla? del mapa al qual pertany el trigger de l'enlla?. |
URL de mapa
L'objecte defineix un enlla? on es pot fer clic que ser¨¤ disponible per a tots els elements d'un tipus espec¨ªfic del mapa. T¨¦ les propietats seg¨¹ents:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmapurlid | string | (nom¨¦s lectura) ID de l'URL del mapa. |
| name (obligatori) |
string | T¨ªtol de l'enlla?. |
| url (obligatori) |
string | URL de l'enlla?. |
| elementtype | integer | Tipus d'element de mapa per al qual l'URL ser¨¤ disponible. Consulteu la propietat "elementtype" de l'element de mapa per obtindre un llistat dels tipus admesos. Per defecte: 0. |
| sysmapid | string | ID del mapa al qual pertany l'URL. |
Usuari de mapa
Llista dels permisos del mapa en funci¨® dels usuaris. L'objecte t¨¦ les propietats seg¨¹ents:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmapuserid | string | (nom¨¦s lectura) ID del mapa d'usuari. |
| userid (obligatori) |
string | ID d'usuari. |
| permission (obligatori) |
integer | Nivell de permisos. Valors possibles: 2 - nom¨¦s lectura; 3 - lectura i escriptura; |
Grup d'usuaris del mapa
Llista dels permisos del mapa en funci¨® del grup d'usuaris. L'objecte t¨¦ les propietats seg¨¹ents:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmapusergrpid | string | (nom¨¦s lectura) ID del grup d'usuaris del mapa. |
| usergrpid (obligatori) |
string | ID del grup d'usuaris. |
| permission (obligatori) |
integer | Nivell de permisos. Valors possibles: 2 - nom¨¦s lectura; 3 - lectura i escriptura; |
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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmap_shapeid | string | (nom¨¦s lectura) ID de la forma del mapa. |
| tipus (obligatori) | integer | Tipus de la forma del mapa. Valors possibles: 0 - rectangle; 1 - el¡¤lipse. Aquesta propietat ¨¦s necess¨¤ria quan es creen noves formes. |
| 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| sysmap_shapeid | string | (nom¨¦s lectura) ID de la forma del mapa. |
| 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. |