Documentation
Table of Contents
> Objet Tableau de bord
Les objets suivants sont directement liés à l'API dashboard.
Tableau de bord
L'objet dashboard a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| dashboardid | string | (lecture seule) ID du tableau de bord. |
| name (obligatoire) |
string | Nom du tableau de bord. |
| userid | string | ID utilisateur du propriétaire du tableau de bord. |
| private | integer | Type de partage du tableau de bord. Valeurs possibles : 0 - tableau de bord public ; 1 - (par défaut) tableau de bord privé. |
| display_period | integer | Période d'affichage par défaut de la page (en secondes). Valeurs possibles : 10, 30, 60, 120, 600, 1800, 3600. Par défaut : 30. |
| auto_start | integer | Démarrage automatique du diaporama. Valeurs possibles : 0 - |
| ne démarre pas automatiquement le diaporama ; 1 - (par défaut) démarrage automatique du diaporama. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Page de tableau de bord
L'objet page de tableau de bord a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| dashboard_pageid | string | (lecture seule) ID de la page du tableau de bord. |
| name | string | Nom de la page du tableau de bord. Par défaut : chaîne vide. |
| display_period | integer | Période d'affichage de la page du tableau de bord (en secondes). Valeurs possibles : 0, 10, 30, 60, 120, 600, 1800, 3600. Par défaut : 0 (utilisera la période d'affichage de la page par défaut). |
| widgets | array | Tableau des objets widget de tableau de bord. |
Widget de tableau de bord
L'objet widget de tableau de bord a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| widgetid | string | (lecture seule) ID du widget de tableau de bord. |
| type (obligatoire) |
string | Type de widget de tableau de bord. Valeurs possibles : actionlog - Journal des actions ; clock - Horloge ; dataover - Aperçu des données ; discovery - Statut de découverte ; favgraphs - Graphiques favoris ; favmaps - Cartes favorites ; graph - Graphique (classique) ; graphprototype - Prototype de graphique ; hostavail - Disponibilité de l'hôte ; item - Valeur d'élément ; map - Carte ; navtree - Arborescence de carte ; plaintext - Texte brut ; problemhosts - Hôtes problématiques ; problems - Problèmes ; problemsbysv - Problèmes par sévérité ; slareport - Rapport de SLA; svggraph - Graphique ; systeminfo - Information système ; tophosts - Top des hôtes ; trigover - Aperçu de déclencheur ; url - URL ; web - Supervision Web. |
| name | string | Nom du widget personnalisé. |
| x | integer | Position horizontale depuis le côté gauche du tableau de bord. Les valeurs valides vont de 0 à 23. |
| y | integer | Position vertical depuis le haut du tableau de bord. Les valeurs valides vont de 0 à 62. |
| width | integer | Largeur du widget. Les valeurs valides vont de 1 à 24. |
| height | integer | Hauteur du widget. Les valeurs valides vont de 2 à 32. |
| view_mode | integer | Mode d'affichage du widget. Valeurs possibles : 0 - (par défaut) mode d'affichage par défaut du widget ; 1 - avec en-tête masqué ; |
| fields | array | Tableau d'objets champ de widget de tableau de bord.. |
Champ de widget de tableau de bord
L'objet champ de widget de tableau de bord a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| type (obligatoire) |
integer | Type de champ de widget. Valeurs possibles : 0 - Entier ; 1 - Chaîne ; 2 - Groupe d'hôtes ; 3 - Hôte ; 4 - Élément ; 6 - Graphique ; 8 - Carte. |
| name | string | Nom du champ du widget. Valeurs possibles : voir Champs des widget de tableau de bord. |
| value (obligatoire) |
mixed | Valeur du champ du widget en fonction du type. Valeurs possibles : voir Champs des widget de tableau de bord. |
Groupe d'utilisateurs du tableau de bord
Liste des autorisations du tableau de bord en fonction des groupes d'utilisateurs. L'objet a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| usrgrpid (obligatoire) |
string | ID du groupe d'utilisateurs. |
| permission (obligatoire) |
integer | Type de niveau d'autorisation. Valeurs possibles : 2 - lecture seule ; 3 - lecture-écriture. |
Utilisateur du tableau de bord
Liste des autorisations du tableau de bord en fonction des utilisateurs. L'objet a les propriétés suivantes :
| Propriété | Type | Description |
|---|---|---|
| userid (obligatoire) |
string | ID de l'utilisateur. |
| permission (obligatoire) |
integer | Type de niveau d'autorisation. Valeurs possibles : 2 - lecture seule ; 3 - lecture-écriture. |