maintenance.create

Description

object maintenance.create(object/array maintenances)

Cette méthode permet de créer de nouvelles maintenances.

Cette méthode est disponible uniquement pour les types d'utilisateurs Admin et Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôles utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(object/array) Maintenances à créer.

En plus des propriétés de l'objet maintenance standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
groups object/array Groupes d'hôtes qui vont subir une maintenance.

Les groupes d'hôtes doivent avoir la propriété groupid définie.

Au moins un objet groups ou hosts doit être spécifié.
hosts object/array Hôtes qui vont subir une maintenance.

Les hôtes doivent avoir la propriété hostid définie.

Au moins un objet groups ou hosts doit être spécifié.
timeperiods
(obligatoire)
object/array Périodes de maintenance.
tags object/array Tags de problème.

Défini quels problèmes doivent être supprimés.
Si aucun tag n’est spécifié, tous les problèmes d’hôte en maintenance actives seront supprimés.
groupids
(obsolète)
array Ce paramètre est obsolète, veuillez utiliser des groups à la place.
ID des groupes d'hôte qui subiront la maintenance.
hostids
(obsolète)
array Ce paramètre est obsolète, veuillez utiliser des hosts à la place.
IDs des hôtes qui subiront la maintenance.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des maintenance créées sous la propriété maintenanceids. L'ordre des ID retournés correspond à l'ordre des maintenances transmises.

Exemples

Création d'une maintenance

Créez une maintenance avec collecte de données pour le groupe d'hôtes avec l'ID "2" et avec les tags de problème service:mysqld et error. Il doit être actif du 22.01.2013 au 22.01.2014, entrer en vigueur chaque dimanche à 18h00 et durer une heure.

Requête :

{
           "jsonrpc": "2.0",
           "method": "maintenance.create",
           "params": {
               "name": "Sunday maintenance",
               "active_since": 1358844540,
               "active_till": 1390466940,
               "tags_evaltype": 0,
               "groups": [
                   {"groupid": "2"}
               ],
               "timeperiods": [
                   {
                       "period": 3600,
                       "timeperiod_type": 3,
                       "start_time": 64800,
                       "every": 1,
                       "dayofweek": 64
                   }
               ],
               "tags": [
                   {
                       "tag": "service",
                       "operator": "0",
                       "value": "mysqld"
                   },
                   {
                       "tag": "error",
                       "operator": "2",
                       "value": ""
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": {
               "maintenanceids": [
                   "3"
               ]
           },
           "id": 1
       }

Voir également

Source

CMaintenance::create() dans ui/include/classes/api/services/CMaintenance.php.