Objet dashboard

Les objets suivants sont directement liés à l'API dashboard.

Tableau de bord

L'objet tableau de bord possède les propriétés suivantes.

Propriété Type Description
dashboardid ID ID du tableau de bord.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
name string Nom du tableau de bord.

Comportement de la propriété :
- obligatoire pour les opérations de création
userid ID ID de l'utilisateur 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 pas démarrer automatiquement le diaporama ;
1 - (par défaut) démarrer automatiquement le diaporama.

Page de tableau de bord

L'objet de page de tableau de bord possède les propriétés suivantes.

Propriété Type Description
dashboard_pageid ID ID de la page de tableau de bord.

Comportement de la propriété :
- lecture seule
name string Nom de la page de tableau de bord.

Par défaut : chaîne vide.
display_period integer Période d'affichage de la page de 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 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 possède les propriétés suivantes.

Propriété Type Description
widgetid ID ID du widget de tableau de bord.

Comportement de la propriété:
- lecture seule
type string Type du widget de tableau de bord.

Valeurs possibles :
actionlog - Journal des actions ;
clock - Horloge ;
discovery - Statut de découverte ;
favgraphs - Graphiques favoris ;
favmaps - Cartes favorites ;
gauge - Jauge ;
geomap - Géocarte ;
graph - Graphique (classique) ;
graphprototype - Prototype de graphique ;
honeycomb - Nid d'abeilles ;
hostavail - Disponibilité de l'hôte ;
hostcard - Carte de l'hôte ;
hostnavigator - Navigateur d'hôtes ;
itemcard - Carte d'élément ;
itemhistory - Historique d'élément ;
itemnavigator - Navigateur d'éléments ;
item - Valeur d'élément ;
map - Carte ;
navtree - Arborescence de navigation des cartes ;
piechart - Diagramme circulaire ;
problemhosts - Hôtes avec problèmes ;
problems - Problèmes ;
problemsbysv - Problèmes par sévérité ;
scatterplot - Nuage de points ;
slareport - Rapport SLA ;
svggraph - Graphique ;
systeminfo - Informations système ;
tophosts - Principaux hôtes ;
topitems - Principaux éléments ;
toptriggers - Principaux déclencheurs ;
trigover - Vue d'ensemble des déclencheurs ;
url - URL ;
web - Supervision web.

Comportement de la propriété:
- requis
name string Nom personnalisé du widget.
x integer Position horizontale à partir du côté gauche du tableau de bord.

Les valeurs possibles vont de 0 à 71.
y integer Position verticale à partir du haut du tableau de bord.

Les valeurs possibles vont de 0 à 63.
width integer Largeur du widget.

Les valeurs possibles vont de 1 à 72.
height integer Hauteur du widget.

Les valeurs possibles vont de 1 à 64.
view_mode integer Mode d'affichage du widget.

Valeurs possibles :
0 - (par défaut) affichage par défaut du widget ;
1 - avec en-tête masqué ;
fields array Tableau d'objets champ de widget de tableau de bord.

Comportement de la propriété:
- voir les widgets individuels dans Champs de widget de tableau de bord
Champ de widget de tableau de bord

L'objet champ de widget de tableau de bord possède les propriétés suivantes.

Propriété Type Description
type integer Type du champ de widget.

Valeurs possibles :
0 - Entier ;
1 - Chaîne ;
2 - Groupe d'hôtes ;
3 - Hôte ;
4 - Élément ;
5 - Prototype d'élément ;
6 - Graphique ;
7 - Prototype de graphique ;
8 - Carte ;
9 - Service ;
10 - SLA ;
11 - Utilisateur ;
12 - Action ;
13 - Type de média.

Comportement de la propriété :
- obligatoire
name string Nom du champ de widget.

Valeurs possibles : voir Champs de widget de tableau de bord.

Comportement de la propriété :
- obligatoire
value mixed Valeur du champ de widget selon le type.

Valeurs possibles : voir Champs de widget de tableau de bord.

Comportement de la propriété :
- obligatoire

Groupe d’utilisateurs du tableau de bord

Liste des autorisations du tableau de bord basées sur les groupes d’utilisateurs. Elle possède les propriétés suivantes.

Propriété Type Description
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

Utilisateur du tableau de bord

Liste des autorisations du tableau de bord basées sur les utilisateurs. Elle possède les propriétés suivantes.

Propriété Type Description
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