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. Voir User roles pour plus d'informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

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

Parameter Type Description
triggerids ID/array Retourne uniquement les déclencheurs avec les IDs donnés.
groupids ID/array Retourne uniquement les déclencheurs qui appartiennent à des hôtes ou des modèles des groupes d'hôtes ou groupes de modèles donnés.
templateids ID/array Retourne uniquement les déclencheurs qui appartiennent aux modèles donnés.
hostids ID/array Retourne uniquement les déclencheurs qui appartiennent aux hôtes donnés.
itemids ID/array Retourne uniquement les déclencheurs qui contiennent les éléments donnés.
functions string/array Retourne uniquement les déclencheurs qui utilisent les fonctions donné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 qui appartiennent à des hôtes ou des modèles du groupe d'hôtes ou du groupe de modèles portant le nom donné.
host string Retourne uniquement les déclencheurs qui appartiennent à l'hôte portant le nom technique donné.
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 qui appartiennent à des modèles.
dependent boolean Si défini sur true, retourne uniquement les déclencheurs qui ont des dépendances. Si défini sur false, retourne uniquement les déclencheurs qui n'ont pas de dépendances.
monitored flag Retourne uniquement les déclencheurs activés qui appartiennent à des hôtes surveillés et ne contiennent que des éléments activés.
active flag Retourne uniquement les déclencheurs activés qui appartiennent à des hôtes surveillés.
maintenance boolean Si défini sur true, retourne uniquement les déclencheurs activés qui appartiennent à des hôtes en maintenance.
withUnacknowledgedEvents flag Retourne uniquement les déclencheurs qui ont 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 dans un é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, ont des éléments désactivés ou des hôtes d'éléments désactivés.
lastChangeSince timestamp Retourne uniquement les déclencheurs dont l'état a changé après l'heure donnée.
lastChangeTill timestamp Retourne uniquement les déclencheurs dont l'état a changé avant l'heure donnée.
only_true flag Retourne uniquement les déclencheurs qui ont récemment été dans un état de problème.
min_severity integer Retourne uniquement les déclencheurs dont la gravité est supérieure ou égale à la gravité donnée.
evaltype integer Méthode d'évaluation des balises.

Valeurs possibles :
0 - (par défaut) Et/Ou;
2 - Ou.
tags array Retourne uniquement les déclencheurs avec les balises données.
Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne tous les déclencheurs.

Valeurs possibles de operator :
0 - (par défaut) Contient;
1 - É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 le déclencheur appartient dans la propriété hostgroups.
selectHosts query Retourne les hôtes auxquels le déclencheur appartient dans la propriété hosts.
selectItems query Retourne les éléments contenus par 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 avec les données de l'objet de découverte du déclencheur. L'objet de découverte du déclencheur lie un déclencheur découvert à un 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) moment où un déclencheur qui n'est plus découvert sera supprimé;
ts_disable - (timestamp) moment où un déclencheur qui n'est plus découvert sera désactivé;
disable_source - (int) indicateur précisant 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 qui a 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 balises du déclencheur dans la propriété tags.
selectTemplateGroups query Retourne les groupes de modèles auxquels le déclencheur appartient dans la propriété templategroups.
filter object Retourne uniquement les résultats qui correspondent exactement au filtre donné.

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

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

Prend en charge des propriétés supplémentaires :
host - nom technique de l'hôte auquel le déclencheur appartient;
hostid - ID de l'hôte auquel le déclencheur appartient.
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 donné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 lient le déclencheur à un 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",
                    "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\")}"
                },
                {
                    "tag": "error",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}

Voir aussi

Source

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