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 pour 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 standard de maintenance, la méthode accepte les paramètres suivants.

Paramètre Type Description
groups object/array Groupes d'hôtes qui seront mis en maintenance.

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

Comportement du paramètre :
- obligatoire si hosts n'est pas défini
hosts object/array Hôtes qui seront mis en maintenance.

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

Comportement du paramètre :
- obligatoire si groups n'est pas défini
timeperiods object/array Périodes de temps de maintenance.

Comportement du paramètre :
- obligatoire
tags object/array Tags de problème.

Définissez quels problèmes doivent être supprimés.
Si aucun tag n'est fourni, tous les problèmes des hôtes en maintenance active seront supprimés.

Comportement du paramètre :
- pris en charge si maintenance_type de l'objet Maintenance est défini sur "with data collection"

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 période de maintenance

Créez une période de maintenance avec collecte de données pour le groupe d’hôtes ayant l’ID « 2 » et avec les tags de problème service:mysqld et error. Elle doit être active du 22.01.2013 au 22.01.2014, entrer en vigueur chaque dimanche à 18:00 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": ""
            }
        ]
    },
    "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.