Documentation
Table of Contents
> Objet Service
Les objets suivants sont directement liés à l'API service.
Service
L'objet de service a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| serviceid | string | (lecture seule) ID du service. |
| algorithm (required) |
integer | Règle de calcul du statut. Applicable uniquement si des services enfants existent. Valeurs possibles : 0 - définir l'état sur OK ; 1 - le plus critique si tous les enfants ont des problèmes ; 2 - le plus critique des services enfants. |
| name (required) |
string | Nom du service. |
| sortorder (required) |
integer | Position du service utilisé pour le tri. Valeurs possibles : 0-999. |
| weight | integer | Poids du service. Valeurs possibles : 0-1000000. Par défaut : 0. |
| propagation_rule | integer | Règle de propagation d'état. Doit être défini avec propagation_value.Valeurs possibles : 0 - (par défaut) propage l'état du service tel quel - sans aucune modification ; 1 - augmente l'état propagé d'une valeur donnée propagation_value (de 1 à 5 sévérités) ;2 - diminue le statut propagé d'une propagation_value donnée (de 1 à 5 sévérités) ;3 - ignore ce service - le statut n'est pas propagé au service parent du tout ; 4 - définir le statut du service fixe en utilisant une propagation_value donnée. |
| propagation_value | integer | Valeur de propagation de l'état. Doit être défini avec propagation_rule.Valeurs possibles pour propagation_rule avec les valeurs 0 et 3 : 0.Valeurs possibles pour propagation_rule avec les valeurs 1 et 2 : 1-5.Valeurs possibles pour propagation_rule avec la valeur 4 :-1 - OK ; 0 - Non classifié ; 1 - Information ; 2 - Avertissement ; 3 - Moyen ; 4 - Élevé ; 5 - Désastre. |
| status | integer | (lecture seule) Indique si le service est en état OK ou problème. Si le service est en état problème, status est égal à :- la sévérité du problème le plus critique ; - le niveau le plus élevé d'un service enfant en état de problème. Si le service est en état OK, status est égal à -1. |
| description | string | Description du service. |
| uuid | string | Identifiant unique universel. Pour les opérations de mise à jour, ce champ est en lecture seule. |
| created_at | integer | Horodatage Unix de quand le service a été créé. |
| readonly | boolean | (lecture seule) Accès au service. Valeurs possibles : 0 - Lecture-écriture ; 1 - Lecture seule. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Règle de statut
L'objet de règle de statut a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| type (obligatoire) |
integer | Condition pour définir le statut (Nouveau statut). Valeurs possibles : 0 - si au moins (N) services enfants ont le statut (Statut) ou supérieur ; 1 - si au moins (N%) des services enfants ont le statut (Statut) ou supérieur ; 2 - si moins de (N) services enfants ont le statut (Statut) ou inférieur ; 3 - si moins de (N%) des services enfants ont ( Statut) statut ou inférieur ; 4 - si le poids des services enfants avec le statut (Statut) ou supérieur est au moins (W) ; 5 - si le poids des services enfants avec le statut (Statut) ou supérieur est au moins (N%) ; 6 - si le poids des services enfants avec le statut (Statut) ou inférieur est inférieur à (W) ; 7 - si le poids des services enfants avec le statut (Statut) ou inférieur est inférieur à (N%). Où : - N (W) est limit_value ;- (Statut) est limit_status ;- (Nouveau statut) est new_status. |
| limit_value (obligatoire) |
integer | Valeur limite. Valeurs possibles : - pour N et W : 1-100000 ; - pour N % : 1-100. |
| limit_status (obligatoire) |
integer | État limite. Valeurs possibles : -1 - OK ; 0 - Non classifié ; 1 - Information ; 2 - Avertissement ; 3 - Moyenne ; 4 - Élevé ; 5 - Désastre. |
| new_status (obligatoire) |
integer | Nouvelle valeur d'état. Valeurs possibles : 0 - Non classifié ; 1 - Information ; 2 - Avertissement ; 3 - Moyenne ; 4 - Élevé ; 5 - Désastre. |
Tag de service
L'objet de tag de service a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (obligatoire) |
string | Nom du tag de service. |
| value | string | Valeur du tag de service. |
Alarme de service
Les alarmes de service ne peuvent pas être directement créées, mises à jour ou supprimées via l'API Zabbix.
Les objets d'alarme de service représentent le changement d'état d'un service. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| clock | timestamp | Heure à laquelle le changement d'état du service s'est produit. |
| value | integer | État du service. Reportez-vous à la propriété d'état du service pour obtenir une liste des valeurs possibles. |
Tag de problème
Les tags de problème permettent de lier des services à des événements de problème. L'objet de balise de problème a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (obligatoire) |
string | Nom du tag de problème. |
| operator | integer | Opérateur de condition de mappage. Valeurs possibles : 0 - (par défaut) equals; 2 - like. |
| value | string | Valeur du tag de problème. |