triggerprototype.get

Description

integer/array triggerprototype.get(object parameters)

Cette 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 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
active flag Retourne uniquement les prototypes de déclencheur activés qui appartiennent à des hôtes surveillés.
discoveryids ID/array Retourne uniquement les prototypes de déclencheur qui appartiennent aux règles LLD indiquées.
functions string/array Retourne uniquement les déclencheurs qui utilisent les fonctions indiquées.

Consultez la page Fonctions prises en charge pour obtenir la liste des fonctions prises en charge.
group string Retourne uniquement les prototypes de déclencheur qui appartiennent à des hôtes ou à des modèles des groupes d’hôtes ou de modèles portant le nom indiqué.
groupids ID/array Retourne uniquement les prototypes de déclencheur qui appartiennent à des hôtes ou à des modèles des groupes d’hôtes ou de modèles indiqués.
host string Retourne uniquement les prototypes de déclencheur qui appartiennent aux hôtes portant le nom indiqué.
hostids ID/array Retourne uniquement les prototypes de déclencheur qui appartiennent aux hôtes indiqués.
inherited boolean Si défini sur true, retourne uniquement les prototypes de déclencheur hérités d’un modèle.
maintenance boolean Si défini sur true, retourne uniquement les prototypes de déclencheur activés qui appartiennent à des hôtes en maintenance.
min_severity integer Retourne uniquement les prototypes de déclencheur dont la sévérité est supérieure ou égale à la sévérité indiquée.
monitored flag Retourne uniquement les prototypes de déclencheur activés qui appartiennent à des hôtes surveillés et contiennent uniquement des éléments activés.
templated boolean Si défini sur true, retourne uniquement les prototypes de déclencheur qui appartiennent à des modèles.
templateids ID/array Retourne uniquement les prototypes de déclencheur qui appartiennent aux modèles indiqués.
triggerids ID/array Retourne uniquement les prototypes de déclencheur possédant les ID indiqués.
expandExpression flag Développe les fonctions et les macros dans l’expression du déclencheur.
selectDependencies query Retourne les prototypes de déclencheur et les déclencheurs dont dépend le prototype de 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 prototype de déclencheur. L’objet de découverte du prototype de déclencheur associe un prototype de 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 prototype de déclencheur a été créé ;
status - (int) état de découverte du prototype de déclencheur :
0 - (par défaut) le prototype de déclencheur est découvert,
1 - le prototype de déclencheur n’est plus découvert ;
ts_delete - (timestamp) moment auquel un prototype de déclencheur qui n’est plus découvert sera supprimé ;
ts_disable - (timestamp) moment auquel un prototype de déclencheur qui n’est plus découvert sera désactivé ;
disable_source - (int) indique si le prototype de 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 LLD à laquelle appartient le prototype de déclencheur dans la propriété discoveryRule.
selectDiscoveryRulePrototype query Retourne une propriété discoveryRulePrototype contenant le prototype de règle LLD parent auquel appartient le prototype de déclencheur.
selectFunctions query Retourne les fonctions utilisées dans le prototype de 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.
selectHostGroups query Retourne les groupes d’hôtes auxquels appartient le prototype de déclencheur dans la propriété hostgroups.
selectHosts query Retourne les hôtes auxquels appartient le prototype de déclencheur dans la propriété hosts.
selectInheritedTags query Retourne une propriété inheritedTags contenant les étiquettes héritées des modèles, des modèles liés et des hôtes, ainsi que des éléments et prototypes d’élément référencés dans les expressions de déclenchement ou de récupération.
selectItems query Retourne les éléments et les prototypes d’élément utilisés par le prototype de déclencheur dans la propriété items.
selectTags query Retourne les étiquettes du prototype de déclencheur dans la propriété tags.
selectTemplateGroups query Retourne les groupes de modèles auxquels appartient le prototype de 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 de 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 prototype de déclencheur ;
hostid - ID de l’hôte auquel appartient le prototype de 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, 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

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éclencheurs à partir d’une règle LLD

Récupérez tous les prototypes de déclencheurs 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": "Le nombre d’inodes libres est inférieur à 20 % sur le 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",
                    "triggerid": "13272",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        },
        {
            "triggerid": "13266",
            "expression": "{13500}<20",
            "description": "L’espace disque libre est inférieur à 20 % sur le 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",
                    "triggerid": "13266",
                    "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.