trigger.get

Description

integer/array trigger.get(object parameters)

La méthode permet de récupérer les déclencheurs 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 Rôles utilisateur 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
triggerids ID/array Retourne uniquement les déclencheurs correspondant aux ID indiqués.
groupids ID/array Retourne uniquement les déclencheurs appartenant aux hôtes ou aux modèles des groupes d’hôtes ou de modèles indiqués.
templateids ID/array Retourne uniquement les déclencheurs appartenant aux modèles indiqués.
hostids ID/array Retourne uniquement les déclencheurs appartenant aux hôtes indiqués.
itemids ID/array Retourne uniquement les déclencheurs contenant les éléments indiqués.
maintenanceids ID/array Retourne uniquement les déclencheurs affectés par les maintenances indiquées.
functions string/array Retourne uniquement les déclencheurs utilisant les fonctions indiquées.

Consultez la page des fonctions prises en charge pour obtenir la liste des fonctions prises en charge.
group string Retourne uniquement les déclencheurs appartenant aux hôtes ou aux modèles du groupe d’hôtes ou de modèles portant le nom indiqué.
host string Retourne uniquement les déclencheurs appartenant à l’hôte portant le nom technique indiqué.
inherited boolean Si défini sur true, retourne uniquement les déclencheurs hérités d’un modèle.
templated boolean Si défini sur true, retourne uniquement les déclencheurs appartenant à des modèles.
dependent boolean Si défini sur true, retourne uniquement les déclencheurs ayant des dépendances. Si défini sur false, retourne uniquement les déclencheurs n’ayant pas de dépendances.
monitored flag Retourne uniquement les déclencheurs activés appartenant à des hôtes surveillés et contenant uniquement des éléments activés.
active flag Retourne uniquement les déclencheurs activés appartenant à des hôtes surveillés.
maintenance boolean Si défini sur true, retourne uniquement les déclencheurs activés appartenant à des hôtes en maintenance.
withUnacknowledgedEvents flag Retourne uniquement les déclencheurs ayant des événements non acquittés.
withAcknowledgedEvents flag Retourne uniquement les déclencheurs dont tous les événements sont acquittés.
withLastEventUnacknowledged flag Retourne uniquement les déclencheurs dont le dernier événement n’est pas acquitté.
skipDependent flag Ignore les déclencheurs en état de problème qui dépendent d’autres déclencheurs. Notez que les autres déclencheurs sont ignorés s’ils sont désactivés, s’ils possèdent des éléments désactivés ou si leurs hôtes d’éléments sont désactivés.
lastChangeSince timestamp Retourne uniquement les déclencheurs dont l’état a changé après l’heure indiquée.
lastChangeTill timestamp Retourne uniquement les déclencheurs dont l’état a changé avant l’heure indiquée.
only_true flag Retourne uniquement les déclencheurs ayant été récemment en état de problème (au cours de la période ok_period).
min_severity integer Retourne uniquement les déclencheurs dont la sévérité est supérieure ou égale à la sévérité indiquée.
evaltype integer Méthode d’évaluation des tags.

Valeurs possibles :
0 - (par défaut) And/Or ;
2 - Or.
tags array Retourne uniquement les déclencheurs possédant les tags indiqués.
Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne tous les déclencheurs.

Valeurs d’opérateur possibles :
0 - (par défaut) Contient ;
1 - Est égal à ;
2 - Ne contient pas ;
3 - N’est 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 fonctions et les macros dans l’expression du déclencheur.
selectHostGroups query Retourne les groupes d’hôtes auxquels appartient le déclencheur dans la propriété hostgroups.
selectHosts query Retourne les hôtes auxquels appartient le déclencheur dans la propriété hosts.
selectItems query Retourne les éléments contenus dans le déclencheur dans la propriété items.
selectFunctions query Retourne les fonctions utilisées dans le déclencheur dans la propriété functions.

Les objets de fonction représentent les fonctions utilisées dans l’expression du déclencheur et possèdent les propriétés suivantes :
functionid - (ID) ID de la fonction ;
itemid - (ID) ID de l’élément utilisé dans la fonction ;
function - (string) nom de la fonction ;
parameter - (string) paramètre transmis à la fonction. Le paramètre de requête est remplacé par le symbole $ dans la chaîne retournée.
selectDependencies query Retourne les déclencheurs dont dépend le déclencheur dans la propriété dependencies.
selectDiscoveryData query Retourne une propriété discoveryData contenant les données de l’objet de découverte du déclencheur. L’objet de découverte du déclencheur relie un déclencheur découvert au prototype de déclencheur à partir duquel il a été découvert.

Il possède les propriétés suivantes :
parent_triggerid - (ID) ID du prototype de déclencheur à partir duquel le déclencheur a été créé ;
status - (int) état de découverte du déclencheur :
0 - (par défaut) le déclencheur est découvert,
1 - le déclencheur n’est plus découvert ;
ts_delete - (timestamp) heure à laquelle un déclencheur qui n’est plus découvert sera supprimé ;
ts_disable - (timestamp) heure à laquelle un déclencheur qui n’est plus découvert sera désactivé ;
disable_source - (int) indicateur indiquant si le déclencheur a été désactivé par une règle LLD ou manuellement :
0 - (par défaut) désactivé automatiquement,
1 - désactivé par une règle LLD.
selectDiscoveryRule query Retourne la règle de découverte de bas niveau ayant créé le déclencheur dans la propriété discoveryRule.
selectLastEvent query Retourne le dernier événement significatif du déclencheur dans la propriété lastEvent.
selectTags query Retourne les tags du déclencheur dans la propriété tags.
inheritedTags boolean Retourne les déclencheurs possédant les tags indiqués également dans le modèle, l’hôte ou les modèles liés.

Valeurs possibles :
true - le modèle, l’hôte ou les modèles liés doivent également posséder les tags indiqués ;
false - (par défaut) les tags du modèle, de l’hôte ou des modèles liés sont ignorés.
selectInheritedTags query Retourne une propriété inheritedTags contenant les tags hérités des modèles, des modèles liés et des hôtes, ainsi que des éléments référencés dans les expressions du déclencheur ou de récupération.
selectTemplateGroups query Retourne les groupes de modèles auxquels appartient le déclencheur dans la propriété templategroups.
filter object Retourne uniquement les résultats correspondant exactement au filtre indiqué.

Accepte un objet dont les clés sont des noms de propriétés et dont les valeurs sont soit une valeur unique, soit un tableau de valeurs à comparer.

Ne prend pas en charge les propriétés du type de données text.

Prend en charge les propriétés supplémentaires suivantes :
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 retournés par les sous-sélections.

S’applique aux sous-sélections suivantes :
selectHosts - les résultats seront triés par host.
sortfield string/array Trie le résultat selon les propriétés indiquées.

Valeurs possibles : triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Retourne l’objet de découverte du déclencheur dans la propriété triggerDiscovery. Les objets de découverte du déclencheur relient le déclencheur au prototype de déclencheur à partir duquel il a été créé.

Cette requête est obsolète ; veuillez utiliser selectDiscoveryData à la place.

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 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"
    },
    "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": "",
            "event_name": "",
            "uuid": "",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13513",
                    "itemid": "24350",
                    "triggerid": "14062",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Récupération des déclencheurs à l’état de problème

Récupérez l’ID, le nom et la sévérité de tous les déclencheurs à l’état de problème, puis triez-les par sévérité dans l’ordre décroissant.

Requête:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description",
            "priority"
        ],
        "filter": {
            "value": 1
        },
        "sortfield": "priority",
        "sortorder": "DESC"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13907",
            "description": "Zabbix self-monitoring processes < 100% busy",
            "priority": "4"
        },
        {
            "triggerid": "13824",
            "description": "Zabbix discoverer processes more than 75% busy",
            "priority": "3"
        }
    ],
    "id": 1
}

Récupération d’un déclencheur spécifique avec des tags

Récupérez un déclencheur spécifique avec des tags.

Requête:

{
    "jsonrpc": "2.0",
    "method": "trigger.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17578"
        ]
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17370",
            "description": "Service status",
            "tags": [
                {
                    "tag": "service",
                    "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}",
                    "automatic": "1"
                },
                {
                    "tag": "error",
                    "value": "",
                    "automatic": "1"
                }
            ]
        }
    ],
    "id": 1
}

Voir aussi

Source

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