Documentation
Table of Contents
trigger.get
Description
integer/array trigger.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des d¨¦clencheurs en fonction des param¨¨tres donn¨¦s.
Cette m¨¦thode est disponible ¨¤ tous les types d'utilisateurs. Les autorisations d'appeler la m¨¦thode peuvent ¨ºtre r¨¦voqu¨¦es dans les param¨¨tres du le r?le d'utilisateur. Voir R?les Utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| triggerids | string/array | Renvoie uniquement les d¨¦clencheurs avec les identifiants donn¨¦s. |
| groupids | string/array | Renvoie uniquement les d¨¦clencheurs appartenant aux h?tes des groupes d'h?tes donn¨¦s. |
| templateids | string/array | Renvoie uniquement les d¨¦clencheurs appartenant aux mod¨¨les donn¨¦s. |
| hostids | string/array | Renvoie uniquement les d¨¦clencheurs appartenant aux h?tes donn¨¦s. |
| itemids | string/array | Renvoie uniquement les d¨¦clencheurs contenant les ¨¦l¨¦ments donn¨¦s. |
| functions | string/array | Renvoie uniquement les d¨¦clencheurs qui utilisent les fonctions donn¨¦es. Reportez-vous ¨¤ la page Fonctions de d¨¦clencheur support¨¦es pour une liste des fonctions prises en charge. |
| group | string | Renvoie uniquement les d¨¦clencheurs appartenant aux h?tes du groupe d'h?tes portant le nom indiqu¨¦. |
| host | string | Renvoie uniquement les d¨¦clencheurs appartenant ¨¤ l'h?te avec le nom donn¨¦. |
| inherited | boolean | Si d¨¦fini ¨¤ true, ne renvoie que les d¨¦clencheurs h¨¦rit¨¦s d'un mod¨¨le. |
| templated | boolean | Si d¨¦fini ¨¤ true, ne renvoie que les d¨¦clencheurs appartenant aux mod¨¨les. |
| dependent | boolean | S'il est d¨¦fini sur true, ne renvoie que les d¨¦clencheurs qui ont des d¨¦pendances. S'il est d¨¦fini sur false, ne renvoie que les d¨¦clencheurs qui n'ont pas de d¨¦pendances. |
| monitored | flag | Renvoie uniquement les d¨¦clencheurs activ¨¦s appartenant aux h?tes surveill¨¦s et contenant uniquement des ¨¦l¨¦ments activ¨¦s. |
| active | flag | Renvoie uniquement les d¨¦clencheurs activ¨¦s appartenant aux h?tes surveill¨¦s. |
| maintenance | boolean | Si d¨¦fini ¨¤ true, ne renvoie que les d¨¦clencheurs activ¨¦s appartenant aux h?tes en maintenance. |
| withUnacknowledgedEvents | flag | Renvoie uniquement les d¨¦clencheurs qui ont des ¨¦v¨¦nements non acquitt¨¦s. |
| withAcknowledgedEvents | flag | Renvoie uniquement les d¨¦clencheurs avec tous les ¨¦v¨¦nements acquitt¨¦s. |
| withLastEventUnacknowledged | flag | Renvoie uniquement les d¨¦clencheurs avec le dernier ¨¦v¨¦nement non acquitt¨¦. |
| skipDependent | flag | Ignore les d¨¦clencheurs dans un ¨¦tat probl¨¦matique qui d¨¦pendent d'autres d¨¦clencheurs. Notez que les autres d¨¦clencheurs sont ignor¨¦s s'ils sont d¨¦sactiv¨¦s, s'ils ont des ¨¦l¨¦ments d¨¦sactiv¨¦s ou des h?tes d'¨¦l¨¦ments d¨¦sactiv¨¦s. |
| lastChangeSince | timestamp | Renvoie uniquement les d¨¦clencheurs qui ont chang¨¦ d'¨¦tat apr¨¨s le temps imparti. |
| lastChangeTill | timestamp | Renvoie uniquement les d¨¦clencheurs qui ont chang¨¦ d'¨¦tat avant l'heure indiqu¨¦e. |
| only_true | flag | Renvoie uniquement les d¨¦clencheurs ayant r¨¦cemment rencontr¨¦ un probl¨¨me. |
| min_severity | integer | Renvoie uniquement les d¨¦clencheurs avec une s¨¦v¨¦rit¨¦ sup¨¦rieure ou ¨¦gale ¨¤ la s¨¦v¨¦rit¨¦ donn¨¦e. |
| evaltype | integer | R¨¨gles pour la recherche de tag. Valeurs possibles : 0 - (Par d¨¦faut) Et/Ou ; 2 - Ou. |
| tags | array of objects | Retourne seulement les d¨¦clencheurs avec les tags donn¨¦s. Correspondance exacte par tag et recherche par tag sensible ¨¤ la casse ou non sensible ¨¤ la casse selon la valeur de l'op¨¦rateur. Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide retourne tous les d¨¦clencheurs. Types d'op¨¦rateurs possibles : 0 - (par d¨¦faut) Comme ; 1 - Egal; 2 - Pas comme ; 3 - Pas ¨¦gal ; 4 - Existe ; 5 - N'existe pas. |
| expandComment | flag | D¨¦veloppe les macros dans la description du d¨¦clencheur. |
| expandDescription | flag | D¨¦veloppe les macros dans le nom du d¨¦clencheur. |
| expandExpression | flag | D¨¦veloppe les macros et les fonctions dans l'expression du d¨¦clencheur. |
| selectGroups | query | Renvoie les groupes h?tes auxquels le d¨¦clencheur appartient dans la propri¨¦t¨¦ groups. |
| selectHosts | query | Renvoie les h?tes auxquels le d¨¦clencheur appartient dans la propri¨¦t¨¦ hosts. |
| selectItems | query | Renvoie les ¨¦l¨¦ments contenus dans le d¨¦clencheur dans la propri¨¦t¨¦ items. |
| selectFunctions | query | Renvoie les fonctions utilis¨¦es dans le d¨¦clencheur dans la propri¨¦t¨¦ functions.Les objets fonction repr¨¦sentent les fonctions utilis¨¦es dans l'expression du d¨¦clencheur et poss¨¨dent les propri¨¦t¨¦s suivantes : functionid - (string) ID de la fonction ;itemid - (string) ID de l'¨¦l¨¦ment utilis¨¦ dans la fonction ;function - (string) nom de la fonction ;parameter - (string) param¨¨tre pass¨¦ ¨¤ la fonction. Le param¨¨tre de requ¨ºte est remplac¨¦ par le symbole $ dans la cha?ne renvoy¨¦e. |
| selectDependencies | query | Renvoie les d¨¦clencheurs dont d¨¦pend le d¨¦clencheur dans la propri¨¦t¨¦ dependencies. |
| selectDiscoveryRule | query | Renvoie la r¨¨gle de d¨¦couverte de bas niveau qui a cr¨¦¨¦ le d¨¦clencheur. |
| selectLastEvent | query | Retourne le dernier ¨¦v¨¦nement d¨¦clencheur significatif dans la propri¨¦t¨¦ lastEvent. |
| selectTags | query | Renvoie les tags de d¨¦clenchement dans la propri¨¦t¨¦ tags. |
| selectTriggerDiscovery | query | Renvoie l'objet de d¨¦couverte du d¨¦clencheur dans la propri¨¦t¨¦ triggerDiscovery. Les objets de d¨¦couverte de d¨¦clencheur lient le d¨¦clencheur ¨¤ un prototype de d¨¦clencheur ¨¤ partir duquel il a ¨¦t¨¦ cr¨¦¨¦.Il a les propri¨¦t¨¦s suivantes : parent_triggerid - (string) ID du prototype de d¨¦clencheur ¨¤ partir duquel le d¨¦clencheur a ¨¦t¨¦ cr¨¦¨¦. |
| filter | object | Renvoie uniquement les r¨¦sultats qui correspondent exactement au filtre donn¨¦. Accepte un tableau dans lequel les cl¨¦s sont des noms de propri¨¦t¨¦s et les valeurs sont une valeur unique ou un tableau de valeurs ¨¤ comparer. \\Prend en charge des filtres suppl¨¦mentaires : host - nom technique de l'h?te auquel appartient le d¨¦clencheur ;hostid - ID de l'h?te auquel appartient le d¨¦clencheur. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoy¨¦s par les sous-requ¨ºtes. S'applique aux sous-s¨¦lections suivantes : selectHosts - les r¨¦sultats seront tri¨¦s par host. |
| sortfield | string/array | Trie le r¨¦sultat par les propri¨¦t¨¦s donn¨¦es. Valeurs possibles : triggerid, description, status, priority, lastchange et hostname. |
| countOutput | boolean | Ces param¨¨tres, communs ¨¤ toutes les m¨¦thodes get, sont d¨¦crits dans les commentaires 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 retourn¨¦es
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets r¨¦cup¨¦r¨¦s, si le param¨¨tre
countOutputa ¨¦t¨¦ utilis¨¦.
Exemples
R¨¦cup¨¦ration des donn¨¦es par ID de d¨¦clencheur
R¨¦cup¨¦rez toutes les donn¨¦es et les fonctions utilis¨¦es dans le d¨¦clencheur "14062".
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"triggerids": "14062",
"output": "extend",
"selectFunctions": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "14062",
"expression": "{13513}<10m",
"description": "{HOST.NAME} has been restarted (uptime < 10m)",
"url": "",
"status": "0",
"value": "0",
"priority": "2",
"lastchange": "0",
"comments": "The host uptime is less than 10 minutes",
"error": "",
"templateid": "10016",
"type": "0",
"state": "0",
"flags": "0",
"recovery_mode": "0",
"recovery_expression": "",
"correlation_mode": "0",
"correlation_tag": "",
"manual_close": "0",
"opdata": "",
"functions": [
{
"functionid": "13513",
"itemid": "24350",
"triggerid": "14062",
"parameter": "$",
"function": "last"
}
]
}
],
"id": 1
}R¨¦cup¨¦ration des d¨¦clencheurs en ¨¦tat probl¨¦matique
R¨¦cup¨¦rer l'ID, le nom et la s¨¦v¨¦rit¨¦ de tous les d¨¦clencheurs en ¨¦tat probl¨¦matique et les trier par s¨¦v¨¦rit¨¦ en ordre d¨¦croissant.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description",
"priority"
],
"filter": {
"value": 1
},
"sortfield": "priority",
"sortorder": "DESC"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "13907",
"description": "Áú»¢¶Ä²© self-monitoring processes < 100% busy",
"priority": "4"
},
{
"triggerid": "13824",
"description": "Áú»¢¶Ä²© discoverer processes more than 75% busy",
"priority": "3"
}
],
"id": 1
}R¨¦cup¨¦ration d'un d¨¦clencheur sp¨¦cifique avec des tags
R¨¦cup¨¦ration d'un d¨¦clencheur sp¨¦cifique avec des tags.
Requ¨ºte :
{
"jsonrpc": "2.0",
"method": "trigger.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17578"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}R¨¦ponse :
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "17370",
"description": "Service status",
"tags": [
{
"tag": "service",
"value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
},
{
"tag": "error",
"value": ""
}
]
}
],
"id": 1
}Voir ¨¦galement
Source
CTrigger::get() dans ui/include/classes/api/services/CTrigger.php.