triggerprototype.get

Description

integer/array triggerprototype.get(object parameters)

La méthode permet de récupérer les prototypes de déclencheur 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 des rôles utilisateur. Consultez Rôles utilisateur 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
active flag Ne retourner que les prototypes de déclencheur activés qui appartiennent à des hôtes surveillés.
discoveryids ID/array Ne retourner que les prototypes de déclencheur qui appartiennent aux règles de découverte LLD données.
functions string/array Ne retourner que les déclencheurs qui utilisent les fonctions données.

Consultez la page Fonctions prises en charge pour obtenir la liste des fonctions prises en charge.
group string Ne retourner que les prototypes de déclencheur qui appartiennent à des hôtes ou des modèles issus des groupes d'hôtes ou groupes de modèles portant le nom donné.
groupids ID/array Ne retourner que les prototypes de déclencheur qui appartiennent à des hôtes ou des modèles issus des groupes d'hôtes ou groupes de modèles donnés.
host string Ne retourner que les prototypes de déclencheur qui appartiennent à des hôtes portant le nom donné.
hostids ID/array Ne retourner que les prototypes de déclencheur qui appartiennent aux hôtes donnés.
inherited boolean Si défini sur true, ne retourner que les prototypes de déclencheur hérités d'un modèle.
maintenance boolean Si défini sur true, ne retourner que les prototypes de déclencheur activés qui appartiennent à des hôtes en maintenance.
min_severity integer Ne retourner que les prototypes de déclencheur dont la gravité est supérieure ou égale à la gravité donnée.
monitored flag Ne retourner que les prototypes de déclencheur activés qui appartiennent à des hôtes surveillés et ne contiennent que des éléments activés.
templated boolean Si défini sur true, ne retourner que les prototypes de déclencheur qui appartiennent à des modèles.
templateids ID/array Ne retourner que les prototypes de déclencheur qui appartiennent aux modèles donnés.
triggerids ID/array Ne retourner que les prototypes de déclencheur avec les ID donnés.
expandExpression flag Développer les fonctions et les macros dans l'expression du déclencheur.
selectDependencies query Retourner les prototypes de déclencheur et les déclencheurs dont dépend le prototype de déclencheur dans la propriété dependencies.
selectDiscoveryRule query Retourner la règle LLD à laquelle appartient le prototype de déclencheur dans la propriété discoveryRule.
selectFunctions query Retourner les fonctions utilisées dans le prototype de 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 - (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 renvoyée.
selectHostGroups query Retourner les groupes d'hôtes auxquels appartient le prototype de déclencheur dans la propriété hostgroups.
selectHosts query Retourner les hôtes auxquels appartient le prototype de déclencheur dans la propriété hosts.
selectItems query Retourner les éléments et les prototypes d'élément utilisés par le prototype de déclencheur dans la propriété items.
selectTags query Retourner les balises du prototype de déclencheur dans la propriété tags.
selectTemplateGroups query Retourner les groupes de modèles auxquels appartient le prototype de déclencheur dans la propriété templategroups.
filter object Ne retourner que 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 text data type.

Prend en charge des propriétés supplémentaires :
host - nom technique de l'hôte auquel appartient le prototype de déclencheur;
hostid - ID de l'hôte auquel appartient le prototype de déclencheur.
limitSelects integer Limite le nombre d'enregistrements renvoyé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 Trier le résultat selon les propriétés données.

Valeurs possibles : triggerid, description, status, priority, discovered.
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
selectGroups
(deprecated)		 query Ce paramètre est obsolète, veuillez utiliser selectHostGroups ou selectTemplateGroups à la place.
Retourner les groupes d'hôtes et les groupes de modèles auxquels appartient le prototype de déclencheur dans la propriété groups.

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érer les prototypes de déclencheur d'une règle LLD

Récupérez tous les prototypes de déclencheur et leurs fonctions à partir d'une règle LLD.

Requête :

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": "extend",
        "selectFunctions": "extend",
        "discoveryids": "22450"
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13272",
            "expression": "{12598}<20",
            "description": "Free inodes is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "6ce467d05e8745409a177799bed34bb3",
            "url_name": "",
            "functions": [
                {
                    "functionid": "12598",
                    "itemid": "22454",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        },
        {
            "triggerid": "13266",
            "expression": "{13500}<20",
            "description": "Free disk space is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "74a1fc62bfe24b7eabe4e244c70dc384",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13500",
                    "itemid": "22686",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

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

Requête:

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

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17373",
            "description": "L’espace disque libre est inférieur à 20 % sur le volume {#FSNAME}",
            "tags": [
                {
                    "tag": "volume",
                    "value": "{#FSNAME}"
                },
                {
                    "tag": "type",
                    "value": "{#FSTYPE}"
                }
            ]
        }
    ],
    "id": 1
}

Voir aussi

Source

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