Documentation
Table of Contents
> Objet service
Les objets suivants sont directement liés à l'API service.
Service
L'objet service a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| serviceid | string | (lecture seule) ID du service. |
| algorithm (obligatoire) |
integer | Algorithme utilisé pour calculé l'état du service. Valeurs possibles: 0 - ne calcule pas; 1 - problème, si au moins un enfant a un problème; 2 - problème, si tous les enfants ont un problème;. |
| name (obligatoire) |
string | Nom du service. |
| showsla (obligatoire) |
integer | Indique si le SLA doit être calculé. Valeurs possibles: 0 - ne calcule pas; 1 - calcule. |
| sortorder (obligatoire) |
integer | Position du service utilisé pour le tri. |
| goodsla | float | Valeur minimale du SLA acceptable. Si le SLA est inférieur, le service est considéré en état problématique. Défaut: 99.9. |
| status | integer | (lecture seule) Indique si le service est en état OK ou problématique. Si le service est en état problématique, state est égal à:- la priorité du déclencheur lié s'il est défini sur 2, "Avertissement" ou supérieur (les priorités 0, "Non classé" et 1, "Information" sont ignorées); - le statut le plus élevé d'un service enfant en état problématique. Si le service est dans l'état OK, status est égal à 0. |
| triggerid | string | Déclencheur associé au service. Ne peut être configuré que pour les services sans enfants. Défaut: 0 |
Période de maintenance
L'objet période de maintenance du service définit les périodes au cours desquelles un service est programmé pour être en fonctionnement ou à l'arrêt. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| timeid | string | (lecture seule) ID de la période de maintenance. |
| serviceid (obligatoire) |
string | ID du service. Ne peut pas être mis à jour. |
| ts_from (obligatoire) |
integer | Heure à laquelle le période de maintenance entre en vigueur. Pour les temps d'arrêt uniques, ts_from doit être défini comme horodatage Unix, pour les autres types, comme une heure spécifique dans une semaine, en secondes, par exemple, 90000 pour mardi à 02h00. |
| ts_to (obligatoire) |
integer | Heure de fin de service. Pour les périodes de disponibilité ponctuelles, ts_to doit être défini comme horodatage Unix, pour les autres types - comme une heure spécifique dans une semaine, en secondes, par exemple, 90000 pour mardi à 02h00. |
| type (obligatoire) |
integer | Type de période de maintenance. Valeurs possibles: 0 - temps de fonctionnement, répété chaque semaine; 1 - temps d'arrêt planifié, répété chaque semaine; 2 - temps d'arrêt unique. |
| note | string | Informations supplémentaires sur la période de maintenance. |
Dépendance du service
L'objet de dépendance de service représente une dépendance entre des services. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| linkid | string | (lecture seule) ID de la dépendance de service. |
| servicedownid (obligatoire) |
string | ID du service dont dépend un service, c'est-à-dire le service enfant. Un service peut avoir plusieurs enfants. |
| serviceupid (obligatoire) |
string | ID du service dépendant d'un service, c'est-à-dire du service parent. Un service peut avoir plusieurs parents formant un graphe dirigé. |
| soft (obligatoire) |
integer | Type de dépendance entre services. Valeurs possibles: 0 - dépendance dure; 1 - dépendance douce. Un service ne peut avoir qu'un seul parent avec dépendance dure. Cet attribut n'a aucun effet sur le statut ni sur le calcul du SLA et sert uniquement à créer une arborescence de services principale. Des parents supplémentaires peuvent être ajoutés en tant que dépendances douces formant ainsi un graphique. Un service ne peut pas être supprimé s'il a des enfants avec dépendances dures. |
Alarme du service
Les alarmes de service ne peuvent pas être directement créées, mises à jour ou supprimées via l'API Zabbix.
L'objet d'alarme de service représente le changement d'état d'un service. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| servicealarmid | string | ID de l'alarme de service. |
| serviceid | string | ID du service. |
| clock | timestamp | Heure à laquelle le changement d'état du service s'est produit. |
| value | integer | Statut du service. Se référer à la propriété de statut du service pour une liste des valeurs possibles. |