triggerprototype.get

Descripción

integer/array triggerprototype.get(object parameters)

El método permite recuperar prototipos de trigger según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(object) Parámetros que definen el resultado deseado.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
active flag Devuelve únicamente los prototipos de trigger habilitados que pertenecen a hosts monitorizados.
discoveryids ID/array Devuelve únicamente los prototipos de trigger que pertenecen a las reglas LLD indicadas.
functions string/array Devuelve únicamente los triggers que utilizan las funciones indicadas.

Consulte la página Funciones compatibles para ver la lista de funciones compatibles.
group string Devuelve únicamente los prototipos de trigger que pertenecen a hosts o templates de los grupos de hosts o grupos de templates con el nombre indicado.
groupids ID/array Devuelve únicamente los prototipos de trigger que pertenecen a hosts o templates de los grupos de hosts o grupos de templates indicados.
host string Devuelve únicamente los prototipos de trigger que pertenecen a hosts con el nombre indicado.
hostids ID/array Devuelve únicamente los prototipos de trigger que pertenecen a los hosts indicados.
inherited boolean Si se establece en true, devuelve únicamente los prototipos de trigger heredados de un template.
maintenance boolean Si se establece en true, devuelve únicamente los prototipos de trigger habilitados que pertenecen a hosts en mantenimiento.
min_severity integer Devuelve únicamente los prototipos de trigger con una gravedad mayor o igual que la gravedad indicada.
monitored flag Devuelve únicamente los prototipos de trigger habilitados que pertenecen a hosts monitorizados y contienen solo items habilitados.
templated boolean Si se establece en true, devuelve únicamente los prototipos de trigger que pertenecen a templates.
templateids ID/array Devuelve únicamente los prototipos de trigger que pertenecen a los templates indicados.
triggerids ID/array Devuelve únicamente los prototipos de trigger con los ID indicados.
expandExpression flag Expande las funciones y macros de la expresión del trigger.
selectDependencies query Devuelve los prototipos de trigger y los triggers de los que depende el prototipo de trigger en la propiedad dependencies.
selectDiscoveryData query Devuelve una propiedad discoveryData con los datos del objeto de descubrimiento del prototipo de trigger. El objeto de descubrimiento del prototipo de trigger vincula un prototipo de trigger descubierto con el prototipo de trigger a partir del cual se descubrió.

Tiene las siguientes propiedades:
parent_triggerid - (ID) ID del prototipo de trigger a partir del cual se creó el prototipo de trigger;
status - (int) estado de descubrimiento del prototipo de trigger:
0 - (predeterminado) el prototipo de trigger se ha descubierto,
1 - el prototipo de trigger ya no se ha descubierto;
ts_delete - (timestamp) momento en que se eliminará un prototipo de trigger que ya no se descubra;
ts_disable - (timestamp) momento en que se deshabilitará un prototipo de trigger que ya no se descubra;
disable_source - (int) indicador de si el prototipo de trigger fue deshabilitado por una regla LLD o manualmente:
0 - (predeterminado) deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.
selectDiscoveryRule query Devuelve la regla LLD a la que pertenece el prototipo de trigger en la propiedad discoveryRule.
selectDiscoveryRulePrototype query Devuelve una propiedad discoveryRulePrototype con el prototipo de regla LLD principal al que pertenece el prototipo de trigger.
selectFunctions query Devuelve las funciones utilizadas en el prototipo de trigger en la propiedad functions.

Los objetos de función representan las funciones utilizadas en la expresión del trigger y tienen las siguientes propiedades:
functionid - (ID) ID de la función;
itemid - (ID) ID del item utilizado en la función;
function - (string) nombre de la función;
parameter - (string) parámetro pasado a la función. El parámetro de consulta se reemplaza por el símbolo $ en la cadena devuelta.
selectHostGroups query Devuelve los grupos de hosts a los que pertenece el prototipo de trigger en la propiedad hostgroups.
selectHosts query Devuelve los hosts a los que pertenece el prototipo de trigger en la propiedad hosts.
selectInheritedTags query Devuelve una propiedad inheritedTags con las etiquetas heredadas de templates, templates vinculados y hosts, así como de items y prototipos de item referenciados en las expresiones del trigger o de recuperación.
selectItems query Devuelve los items y prototipos de item utilizados por el prototipo de trigger en la propiedad items.
selectTags query Devuelve las etiquetas del prototipo de trigger en la propiedad tags.
selectTemplateGroups query Devuelve los grupos de templates a los que pertenece el prototipo de trigger en la propiedad templategroups.
filter object Devuelve únicamente los resultados que coinciden exactamente con el filtro indicado.

Acepta un objeto cuyas claves son nombres de propiedades y cuyos valores son un único valor o una matriz de valores con los que se debe comparar.

No admite propiedades del tipo de datos text.

Admite propiedades adicionales:
host - nombre técnico del host al que pertenece el prototipo de trigger;
hostid - ID del host al que pertenece el prototipo de trigger.
limitSelects integer Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
selectHosts - los resultados se ordenarán por host.
sortfield string/array Ordena el resultado por las propiedades indicadas.

Valores posibles: triggerid, description, status, priority, discovered.
countOutput boolean Estos parámetros se describen en los comentarios de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar prototipos de trigger de una regla LLD

Recuperar todos los prototipos de trigger y sus funciones de una regla LLD.

Request:

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

Respuesta:

{
    "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",
                    "triggerid": "13272",
                    "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",
                    "triggerid": "13266",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Recuperar una prototipo de disparador específica con etiquetas

Solicitud:

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

Respuesta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17373",
            "description": "El espacio libre en disco es menor al 20% en el volumen {#FSNAME}",
            "tags": [
                {
                    "tag": "volume",
                    "value": "{#FSNAME}"
                },
                {
                    "tag": "type",
                    "value": "{#FSTYPE}"
                }
            ]
        }
    ],
    "id": 1
}

Ver también

Fuente

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