Objet de carte
Les objets suivants sont directement liés à l’API map.
Carte
L'objet carte possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| sysmapid | ID | ID de la carte. Comportement de la propriété : - lecture seule - obligatoire pour les opérations de mise à jour |
| height | integer | Hauteur de la carte en pixels. Comportement de la propriété : - obligatoire pour les opérations de création |
| name | string | Nom de la carte. Comportement de la propriété : - obligatoire pour les opérations de création |
| width | integer | Largeur de la carte en pixels. Comportement de la propriété : - obligatoire pour les opérations de création |
| backgroundid | ID | ID de l'image utilisée comme arrière-plan de la carte. |
| background_scale | integer | Indique s'il faut activer la mise à l'échelle proportionnelle de l'image d'arrière-plan. Valeurs possibles : 0 - désactiver la mise à l'échelle ; 1 - (par défaut) activer la mise à l'échelle de l'image. |
| expand_macros | integer | Indique s'il faut développer les macros dans les libellés lors de la configuration de la carte. Valeurs possibles : 0 - (par défaut) ne pas développer les macros ; 1 - développer les macros. |
| expandproblem | integer | Indique si le déclencheur de problème sera affiché pour les éléments ayant un seul problème. Valeurs possibles : 0 - toujours afficher le nombre de problèmes ; 1 - (par défaut) afficher le déclencheur de problème s'il n'y a qu'un seul problème. |
| grid_align | integer | Indique s'il faut activer l'alignement sur la grille. Valeurs possibles : 0 - désactiver l'alignement sur la grille ; 1 - (par défaut) activer l'alignement sur la grille. |
| grid_show | integer | Indique s'il faut afficher la grille sur la carte. Valeurs possibles : 0 - ne pas afficher la grille ; 1 - (par défaut) afficher la grille. |
| grid_size | integer | Taille de la grille de la carte en pixels. Valeurs prises en charge : 20, 40, 50, 75 et 100. Par défaut : 50. |
| highlight | integer | Indique si la mise en évidence des icônes est activée. Valeurs possibles : 0 - mise en évidence désactivée ; 1 - (par défaut) mise en évidence activée. |
| iconmapid | ID | ID de la correspondance d'icônes utilisée sur la carte. |
| label_format | integer | Indique s'il faut activer les libellés avancés. Valeurs possibles : 0 - (par défaut) désactiver les libellés avancés ; 1 - activer les libellés avancés. |
| label_location | integer | Emplacement du libellé de l'élément de la carte. Valeurs possibles : 0 - (par défaut) bas ; 1 - gauche ; 2 - droite ; 3 - haut. |
| label_string_host | string | Libellé personnalisé pour les éléments hôte. Comportement de la propriété : - obligatoire si label_type_host est défini sur "custom" |
| label_string_hostgroup | string | Libellé personnalisé pour les éléments de groupe d'hôtes. Comportement de la propriété : - obligatoire si label_type_hostgroup est défini sur "custom" |
| label_string_image | string | Libellé personnalisé pour les éléments image. Comportement de la propriété : - obligatoire si label_type_image est défini sur "custom" |
| label_string_map | string | Libellé personnalisé pour les éléments carte. Comportement de la propriété : - obligatoire si label_type_map est défini sur "custom" |
| label_string_trigger | string | Libellé personnalisé pour les éléments déclencheur. Comportement de la propriété : - obligatoire si label_type_trigger est défini sur "custom" |
| label_type | integer | Type de libellé de l'élément de la carte. Valeurs possibles : 0 - libellé ; 1 - adresse IP ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien. |
| label_type_host | integer | Type de libellé pour les éléments hôte. Valeurs possibles : 0 - libellé ; 1 - adresse IP ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé. |
| label_type_hostgroup | integer | Type de libellé pour les éléments de groupe d'hôtes. Valeurs possibles : 0 - libellé ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé. |
| label_type_image | integer | Type de libellé pour les éléments de groupe d'hôtes. Valeurs possibles : 0 - libellé ; 2 - (par défaut) nom de l'élément ; 4 - rien ; 5 - personnalisé. |
| label_type_map | integer | Type de libellé pour les éléments carte. Valeurs possibles : 0 - libellé ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé. |
| label_type_trigger | integer | Type de libellé pour les éléments déclencheur. Valeurs possibles : 0 - libellé ; 2 - (par défaut) nom de l'élément ; 3 - statut uniquement ; 4 - rien ; 5 - personnalisé. |
| markelements | integer | Indique s'il faut mettre en évidence les éléments de la carte dont le statut a récemment changé. Valeurs possibles : 0 - (par défaut) ne pas mettre en évidence les éléments ; 1 - mettre en évidence les éléments. |
| severity_min | integer | Sévérité minimale des déclencheurs qui seront affichés sur la carte. Reportez-vous à la propriété severity du déclencheur pour obtenir la liste des sévérités de déclencheur prises en charge. |
| show_element_label | integer | Comment afficher les libellés des éléments par défaut. Valeurs possibles : 0 - toujours afficher ; 1 - (par défaut) masquer automatiquement. |
| show_link_label | integer | Comment afficher les libellés des liens par défaut. Valeurs possibles : 0 - toujours afficher ; 1 - (par défaut) masquer automatiquement. |
| show_unack | integer | Comment les problèmes doivent être affichés. Valeurs possibles : 0 - (par défaut) afficher le nombre de tous les problèmes ; 1 - afficher uniquement le nombre de problèmes non acquittés ; 2 - afficher séparément le nombre de problèmes acquittés et non acquittés. |
| userid | ID | ID de l'utilisateur propriétaire de la carte. |
| private | integer | Type de partage de la carte. Valeurs possibles : 0 - carte publique ; 1 - (par défaut) carte privée. |
| show_suppressed | integer | Indique si les problèmes supprimés sont affichés. Valeurs possibles : 0 - (par défaut) masquer les problèmes supprimés ; 1 - afficher les problèmes supprimés. |
Élément de carte
L'objet d'élément de carte définit un objet affiché sur une carte. Il possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| selementid | ID | ID de l'élément de carte. Comportement de la propriété : - lecture seule |
| elements | array | Objet de données Element. Comportement de la propriété : - obligatoire si elementtype est défini sur "host", "map", "trigger" ou "host group" |
| elementtype | integer | Type de l'élément de carte. Valeurs possibles : 0 - hôte ; 1 - carte ; 2 - déclencheur ; 3 - groupe d'hôtes ; 4 - image. Comportement de la propriété : - obligatoire |
| iconid_off | ID | ID de l'image utilisée pour afficher l'élément dans son état par défaut. Comportement de la propriété : - obligatoire |
| areatype | integer | Comment les hôtes d'un groupe d'hôtes séparé doivent être affichés. Valeurs possibles : 0 - (par défaut) l'élément du groupe d'hôtes occupera toute la carte ; 1 - l'élément du groupe d'hôtes aura une taille fixe. |
| elementsubtype | integer | Comment un élément de groupe d'hôtes doit être affiché sur une carte. Valeurs possibles : 0 - (par défaut) afficher le groupe d'hôtes comme un élément unique ; 1 - afficher séparément chaque hôte du groupe. |
| evaltype | integer | Méthode d'évaluation de la condition de filtrage par balises de l'élément de carte evaluation method. Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
| height | integer | Hauteur en pixels de l'élément de groupe d'hôtes à taille fixe. Par défaut : 200. |
| iconid_disabled | ID | ID de l'image utilisée pour afficher les éléments de carte désactivés. Comportement de la propriété : - pris en charge si elementtype est défini sur "host", "map", "trigger" ou "host group" |
| iconid_maintenance | ID | ID de l'image utilisée pour afficher les éléments de carte en maintenance. Comportement de la propriété : - pris en charge si elementtype est défini sur "host", "map", "trigger" ou "host group" |
| iconid_on | ID | ID de l'image utilisée pour afficher les éléments de carte présentant des problèmes. Comportement de la propriété : - pris en charge si elementtype est défini sur "host", "map", "trigger" ou "host group" |
| label | string | Libellé de l'élément. |
| label_location | integer | Emplacement du libellé de l'élément de carte. Valeurs possibles : -1 - (par défaut) emplacement par défaut ; 0 - bas ; 1 - gauche ; 2 - droite ; 3 - haut. |
| permission | integer | Type de niveau d'autorisation. Valeurs possibles : -1 - aucun ; 2 - lecture seule ; 3 - lecture-écriture. |
| show_label | integer | Comment afficher le libellé de l'élément. Valeurs possibles : -1 - (par défaut) valeur par défaut de la carte ; 0 - toujours afficher ; 1 - masquage automatique. |
| sysmapid | ID | ID de la carte à laquelle appartient l'élément. Comportement de la propriété : - lecture seule |
| urls | array | URL de l'élément de carte. L'objet URL d'élément de carte est décrit en détail ci-dessous. |
| use_iconmap | integer | Indique si le mappage d'icônes doit être utilisé pour les éléments d'hôte. Valeurs possibles : 0 - ne pas utiliser le mappage d'icônes ; 1 - (par défaut) utiliser le mappage d'icônes. |
| viewtype | integer | Algorithme de placement de l'élément de groupe d'hôtes. Valeurs possibles : 0 - (par défaut) grille. |
| width | integer | Largeur en pixels de l'élément de groupe d'hôtes à taille fixe. Par défaut : 200. |
| x | integer | Coordonnées X de l'élément en pixels. Par défaut : 0. |
| y | integer | Coordonnées Y de l'élément en pixels. Par défaut : 0. |
| zindex | integer | Valeur utilisée pour ordonner les éléments de carte (z-index). Par défaut : 0. |
Élément de carte Hôte
L’objet d’élément de carte Hôte définit un élément d’hôte.
| Propriété | Type | Description |
|---|---|---|
| hostid | ID | ID de l’hôte. |
Élément de carte Groupe d’hôtes
L’objet d’élément de carte Groupe d’hôtes définit un élément de groupe d’hôtes.
| Propriété | Type | Description |
|---|---|---|
| groupid | ID | ID du groupe d’hôtes. |
Élément de carte Map
L'objet d'élément de carte Map définit un élément de carte.
| Propriété | Type | Description |
|---|---|---|
| sysmapid | ID | ID de la carte. |
Élément de carte Trigger
L'objet d'élément de carte Trigger définit un ou plusieurs éléments de trigger.
| Propriété | Type | Description |
|---|---|---|
| triggerid | ID | ID du trigger. |
Balise d'élément de carte
L'objet Balise d'élément de carte possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag | string | Nom de la balise de l'élément de carte. Comportement de la propriété : - obligatoire |
| operator | integer | Opérateur de condition de la balise de l'élément de carte. Valeurs possibles : 0 - (par défaut) Contient ; 1 - Égal à ; 2 - Ne contient pas ; 3 - Différent de ; 4 - Existe ; 5 - N'existe pas. |
| value | string | Valeur de la balise de l'élément de carte. |
URL de l’élément de carte
L’objet URL de l’élément de carte définit un lien cliquable qui sera disponible pour un élément de carte spécifique. Il possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| sysmapelementurlid | ID | ID de l’URL de l’élément de carte. Comportement de la propriété : - lecture seule |
| name | string | Légende du lien. Comportement de la propriété : - obligatoire |
| url | string | URL du lien. Comportement de la propriété : - obligatoire |
| selementid | ID | ID de l’élément de carte auquel l’URL appartient. |
Lien de carte
L'objet de lien de carte définit un lien entre deux éléments de carte. Il possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| linkid | ID | ID du lien de carte. Comportement de la propriété : - lecture seule |
| sysmapid | ID | ID de la carte à laquelle le lien appartient. |
| selementid1 | ID | ID du premier élément de carte lié à une extrémité. Comportement de la propriété : - obligatoire |
| selementid2 | ID | ID du premier élément de carte lié à l'autre extrémité. Comportement de la propriété : - obligatoire |
| drawtype | integer | Style de tracé de la ligne du lien. Valeurs possibles : 0 - (par défaut) ligne ; 2 - ligne en gras ; 3 - ligne pointillée ; 4 - ligne en tirets. |
| color | string | Couleur de la ligne sous forme de code couleur hexadécimal. Par défaut : 000000. |
| label | string | Libellé du lien. |
| show_label | integer | Comment afficher le libellé du lien. Valeurs possibles : -1 - (par défaut) valeur par défaut de la carte ; 0 - toujours afficher ; 1 - masquer automatiquement. |
| indicator_type | integer | Sélectionnez le type d'indicateur du lien. Valeurs possibles : 0 - (par défaut) lien statique ; 1 - déclencheur ; 2 - valeur d'élément. |
| linktriggers | array | Déclencheurs de lien de carte à utiliser comme indicateurs d'état du lien. L'objet de déclencheur de lien de carte est décrit en détail ci-dessous. Comportement de la propriété : - obligatoire si indicator_type est défini sur "trigger" (1). |
| itemid | ID | ID de l'élément. Comportement de la propriété : - obligatoire si indicator_type est défini sur "item value" (2). |
| highlights | array | Mises en évidence de lien de carte à utiliser comme indicateurs d'état du lien. L'objet des indicateurs de lien de carte est décrit en détail ci-dessous. Comportement de la propriété : - obligatoire si indicator_type est défini sur "item value" (2). |
| thresholds | array | Seuils de lien de carte à utiliser comme indicateurs d'état du lien. L'objet des indicateurs de lien de carte est décrit en détail ci-dessous. Comportement de la propriété : - obligatoire si indicator_type est défini sur "item value" (2). |
| permission | integer | Type de niveau d'autorisation. Valeurs possibles : -1 - aucun ; 2 - lecture seule ; 3 - lecture-écriture. |
Déclencheur de lien de carte
L’objet de déclencheur de lien de carte définit un indicateur d’état de lien de carte en fonction de l’état d’un déclencheur. Il possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| triggerid | ID | ID du déclencheur utilisé comme indicateur de lien. Comportement de la propriété : - obligatoire |
| color | string | Couleur de l’indicateur sous forme de code couleur hexadécimal. Par défaut : DD0000. |
| drawtype | integer | Style de dessin de l’indicateur. Valeurs possibles : 0 - (par défaut) ligne ; 2 - ligne en gras ; 3 - ligne en pointillés ; 4 - ligne en tirets. |
Indicateurs de lien de carte
L’objet des indicateurs de lien de carte définit un indicateur d’état de lien de carte en fonction de la valeur de l’élément. Il possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| pattern | string | Expression régulière à comparer. Disponible uniquement pour les surlignages. |
| sortorder | integer | Utilisé pour définir l’ordre de tri des surlignages. Disponible uniquement pour les surlignages. |
| threshold | string | Valeur numérique à comparer. Disponible uniquement pour les seuils. |
| drawtype | integer | Style de dessin de l’indicateur. Valeurs possibles : 0 - (par défaut) ligne ; 2 - ligne en gras ; 3 - ligne pointillée ; 4 - ligne en tirets. |
| color | string | Couleur de l’indicateur sous forme de code couleur hexadécimal. Par défaut : DD0000.Comportement de la propriété : - obligatoire |
URL de carte
L'objet URL de carte définit un lien cliquable qui sera disponible pour tous les éléments d'un type spécifique sur la carte. Il possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| sysmapurlid | ID | ID de l'URL de carte. Comportement de la propriété : - lecture seule |
| name | string | Légende du lien. Comportement de la propriété : - obligatoire |
| url | string | URL du lien. Comportement de la propriété : - obligatoire |
| elementtype | integer | Type d'élément de carte pour lequel l'URL sera disponible. Consultez la propriété type de l'élément de carte pour obtenir la liste des types pris en charge.Par défaut : 0. |
| sysmapid | ID | ID de la carte à laquelle l'URL appartient. |
Utilisateur de carte
Liste des autorisations de carte basées sur les utilisateurs. Elle possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| sysmapuserid | ID | ID de l'utilisateur de la carte. Comportement de la propriété : - lecture seule |
| userid | ID | ID de l'utilisateur. Comportement de la propriété : - obligatoire |
| permission | integer | Type de niveau d'autorisation. Valeurs possibles : 2 - lecture seule ; 3 - lecture-écriture. Comportement de la propriété : - obligatoire |
Groupe d’utilisateurs de carte
Liste des autorisations de carte basées sur les groupes d’utilisateurs. Elle possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| sysmapusrgrpid | ID | ID du groupe d’utilisateurs de la carte. Comportement de la propriété : - lecture seule |
| usrgrpid | ID | ID du groupe d’utilisateurs. Comportement de la propriété : - obligatoire |
| permission | integer | Type de niveau d’autorisation. Valeurs possibles : 2 - lecture seule ; 3 - lecture-écriture. Comportement de la propriété : - obligatoire |
Formes de carte
L'objet de forme de carte définit une forme géométrique (avec ou sans texte) affichée sur une carte. Il possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| sysmap_shapeid | ID | ID de l'élément de forme de carte. Comportement de la propriété : - lecture seule |
| type | integer | Type de l'élément de forme de carte. Valeurs possibles : 0 - rectangle ; 1 - ellipse. Cette propriété est requise lors de la création de nouvelles formes. Comportement de la propriété : - obligatoire |
| x | integer | Coordonnées X de la forme en pixels. Par défaut : 0. |
| y | integer | Coordonnées Y de la forme en pixels. Par défaut : 0. |
| width | integer | Largeur de la forme en pixels. Par défaut : 200. |
| height | integer | Hauteur de la forme en pixels. Par défaut : 200. |
| text | string | Texte de la forme. |
| font | integer | Police du texte dans la forme. Valeurs possibles : 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 Par défaut : 9. |
| font_size | integer | Taille de la police en pixels. Par défaut : 11. |
| font_color | string | Couleur de la police. Par défaut : 000000. |
| text_halign | integer | Alignement horizontal du texte. Valeurs possibles : 0 - centré ; 1 - gauche ; 2 - droite. Par défaut : 0. |
| text_valign | integer | Alignement vertical du texte. Valeurs possibles : 0 - milieu ; 1 - haut ; 2 - bas. Par défaut : 0. |
| border_type | integer | Type de bordure. Valeurs possibles : 0 - aucune ; 1 - ————— ;2 - ····· ;3 - - - -.Par défaut : 0. |
| border_width | integer | Largeur de la bordure en pixels. Par défaut : 0. |
| border_color | string | Couleur de la bordure. Par défaut : 000000. |
| background_color | string | Couleur d'arrière-plan (couleur de remplissage). Par défaut : (vide). |
| zindex | integer | Valeur utilisée pour ordonner toutes les formes et lignes (z-index). Par défaut : 0. |
Lignes de carte
L'objet de ligne de carte définit une ligne affichée sur une carte. Il possède les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| sysmap_shapeid | ID | ID de l'élément de forme de la carte. Comportement de la propriété : - lecture seule |
| x1 | integer | Coordonnées X du point 1 de la ligne, en pixels. Par défaut : 0. |
| y1 | integer | Coordonnées Y du point 1 de la ligne, en pixels. Par défaut : 0. |
| x2 | integer | Coordonnées X du point 2 de la ligne, en pixels. Par défaut : 200. |
| y2 | integer | Coordonnées Y du point 2 de la ligne, en pixels. Par défaut : 200. |
| line_type | integer | Type des lignes. Valeurs possibles : 0 - aucune ; 1 - ————— ;2 - ····· ;3 - - - -.Par défaut : 0. |
| line_width | integer | Largeur des lignes en pixels. Par défaut : 0. |
| line_color | string | Couleur de la ligne. Par défaut : 000000. |
| zindex | integer | Valeur utilisée pour ordonner toutes les formes et lignes (z-index). Par défaut : 0. |