maintenance.get

Description

integer/array maintenance.get(object parameters)

La méthode permet de récupérer les maintenances selon les paramètres fournis.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez User roles pour plus d'informations.

Paramètres

(object) Paramètres définissant le résultat souhaité.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
groupids ID/array Retourne uniquement les maintenances affectées aux groupes d’hôtes indiqués.
hostids ID/array Retourne uniquement les maintenances affectées aux hôtes indiqués.
triggerids ID/array Retourne uniquement les maintenances affectées aux déclencheurs indiqués.
maintenanceids ID/array Retourne uniquement les maintenances possédant les ID indiqués.
selectHostGroups query Retourne une propriété hostgroups contenant les groupes d’hôtes affectés à la maintenance.
selectHosts query Retourne une propriété hosts contenant les hôtes affectés à la maintenance.
selectTriggers query Retourne une propriété triggers contenant les déclencheurs affectés à la maintenance.
selectEventNames query Retourne une propriété event_names contenant les noms d’événements affectés à la maintenance.
selectTags query Retourne une propriété tags contenant les balises de problème de la maintenance.
selectTimeperiods query Retourne une propriété timeperiods contenant les périodes de la maintenance.
sortfield string/array Trie le résultat selon les propriétés indiquées.

Valeurs possibles : maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs de retour

(integer/array) Renvoie soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des maintenances

Récupérez toutes les maintenances configurées, les données relatives à la portée de maintenance attribuée (groupe d’hôtes, hôte, déclencheur, nom de l’événement, balises), ainsi que les périodes définies.

Requête :

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectHosts": "extend",
        "selectTriggers": "extend",
        "selectEventNames": "extend",
        "selectTags": "extend",
        "selectTimeperiods": "extend"
    },
    "id": 1
}

Réponse :

{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Maintenance régulière de la base de données",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Bases de données",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "Ad hoc : Imprimante : encre ÉPUISÉE",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Serveurs Zabbix",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Imprimante : encre ÉPUISÉE"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}

Voir aussi

Source

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