Documentation
Table of Contents
> Objet Maintenance
Les objets suivants sont directement liés à l'API maintenance.
Maintenance
L'objet maintenance a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| maintenanceid | string | (lecture seule) ID de la maintenance. |
| name (obligatoire) |
string | Nom de la maintenance. |
| active_since (obligatoire) |
timestamp | Heure à laquelle la maintenance devient active. La valeur donnée sera arrondie aux minutes inférieures. |
| active_till (obligatoire) |
timestamp | Heure à laquelle la maintenance arrête d'être active. La valeur donnée sera arrondie aux minutes inférieures. |
| description | string | Description de la maintenance. |
| maintenance_type | integer | Type de la maintenance. Valeurs possibles : 0 - (par défaut) avec collecte de données ; 1 - sans collecte de données. |
| tags_evaltype | integer | Méthode d'évaluation du tag de problème. Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Période de temps
L'objet période de temps permet de définir des périodes où la maintenance doit entrer en vigueur. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| period | integer | Durée de la période de maintenance en secondes. La valeur donnée sera arrondie en minutes. Par défaut : 3600. |
| timeperiod_type | integer | Type de période. Valeurs possibles : 0 - (par défaut) une seule fois ; 2 - quotidien ; 3 - hebdomadaire ;< br>4 - mensuel. |
| start_date | timestamp | Date à laquelle la période de maintenance doit entrer en vigueur. Utilisé uniquement pour une seule période. La valeur donnée sera arrondie aux minutes. < br>Par défaut : date actuelle. |
| start_time | integer | Heure du jour à laquelle la maintenance démarre en secondes. Utilisé pour les périodes quotidiennes, hebdomadaires et mensuelles. La valeur donnée sera arrondie aux minutes.<br Par défaut : 0. |
| every | integer | Utilisé pour les périodes quotidiennes, hebdomadaires et mensuelles. Pour les périodes quotidiennes et hebdomadaires, every définit les intervalles de jour ou de semaine durant lesquels la maintenance doit entrer en vigueur.Par défaut : 1. Pour les périodes mensuelles, si la propriété dayofweek contient au moins un jour de la semaine sélectionné, la propriété every définit la semaine du mois où la maintenance doit entrer en vigueur.<br >Valeurs possibles : 1 - (par défaut) première semaine ; 2 - deuxième semaine ; 3 - troisième semaine ; 4 - quatrième semaine ; 5 - dernière semaine. |
| dayofweek | integer | Jours de la semaine où la maintenance doit entrer en vigueur. Les jours sont stockés sous forme binaire, chaque bit représentant le jour correspondant. Par exemple, 4 est égal à 100 en binaire et signifie que la maintenance sera activée le mercredi. Utilisé pour les périodes hebdomadaires et mensuelles. Requis uniquement pour les périodes hebdomadaires. Au moins un dayofweek ou day doit être spécifié pour les périodes mensuelles. |
| day | integer | Jour du mois où la maintenance doit entrer en vigueur. Utilisé uniquement pour les périodes mensuelles. Au moins un dayofweek ou day doit être spécifié pour périodes mensuelles. |
| month | integer | Mois où la maintenance doit entrer en vigueur. Les mois sont stockés sous forme binaire, chaque bit représentant le mois correspondant. Par exemple, 5 est égal à 101 en binaire et signifie que la maintenance sera activée en janvier et mars. Requis uniquement pour les périodes mensuelles. |
Tag de problème
L'objet de tag de problème est utilisé pour définir quels problèmes doivent être supprimés lorsque la maintenance entre en vigueur. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (obligatoire) |
string | Nom du tag de problème. |
| operator | integer | Opérateur de conditions. Valeurs possibles : 0 - Egal; 2 - (par défaut) Contient. |
| value | string | Valeur du tag de problème. |
Les tags ne peuvent être spécifiées que pour les périodes de maintenance avec collecte de données ("maintenance_type":0).