Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

triggerprototype.get

Descripción

integer/array triggerprototype.get(object parameters)

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

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

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
active flag Devolver solo prototipos de disparadores habilitados que pertenezcan a hosts monitorizados.
discoveryids ID/array Devolver solo prototipos de disparadores que pertenezcan a las reglas LLD indicadas.
functions string/array Devolver solo disparadores que utilicen las funciones indicadas.

Consulte la página de Funciones soportadas para ver una lista de funciones soportadas.
group string Devolver solo prototipos de disparadores que pertenezcan a hosts o plantillas de los grupos de hosts o grupos de plantillas con el nombre indicado.
groupids ID/array Devolver solo prototipos de disparadores que pertenezcan a hosts o plantillas de los grupos de hosts o grupos de plantillas indicados.
host string Devolver solo prototipos de disparadores que pertenezcan a hosts con el nombre indicado.
hostids ID/array Devolver solo prototipos de disparadores que pertenezcan a los hosts indicados.
inherited boolean Si se establece en true, devolver solo prototipos de disparadores heredados de una plantilla.
maintenance boolean Si se establece en true, devolver solo prototipos de disparadores habilitados que pertenezcan a hosts en mantenimiento.
min_severity integer Devolver solo prototipos de disparadores con una gravedad mayor o igual a la gravedad indicada.
monitored flag Devolver solo prototipos de disparadores habilitados que pertenezcan a hosts monitorizados y contengan solo elementos habilitados.
templated boolean Si se establece en true, devolver solo prototipos de disparadores que pertenezcan a plantillas.
templateids ID/array Devolver solo prototipos de disparadores que pertenezcan a las plantillas indicadas.
triggerids ID/array Devolver solo prototipos de disparadores con los IDs indicados.
expandExpression flag Expandir funciones y macros en la expresión del disparador.
selectDependencies query Devolver prototipos de disparadores y disparadores de los que depende el prototipo de disparador en la propiedad dependencies.
selectDiscoveryRule query Devolver la regla LLD a la que pertenece el prototipo de disparador en la propiedad discoveryRule.
selectFunctions query Devolver funciones utilizadas en el prototipo de disparador en la propiedad functions.

Los objetos de función representan las funciones utilizadas en la expresión del disparador y tienen las siguientes propiedades:
functionid - (ID) ID de la función;
itemid - (ID) ID del elemento 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 Devolver los grupos de hosts a los que pertenece el prototipo de disparador en la propiedad hostgroups.
selectHosts query Devolver los hosts a los que pertenece el prototipo de disparador en la propiedad hosts.
selectItems query Devolver elementos y prototipos de elementos utilizados por el prototipo de disparador en la propiedad items.
selectTags query Devolver las etiquetas del prototipo de disparador en la propiedad tags.
selectTemplateGroups query Devolver los grupos de plantillas a los que pertenece el prototipo de disparador en la propiedad templategroups.
filter object Devolver solo aquellos resultados que coincidan exactamente con el filtro indicado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar.

No admite propiedades del tipo de dato text data type.

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

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

Valores posibles: triggerid, description, status, priority, discovered.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(obsoleto)
query Este parámetro está obsoleto, utilice selectHostGroups o selectTemplateGroups en su lugar.
Devuelve los grupos de hosts y grupos de plantillas a los que pertenece el prototipo de disparador en la propiedad groups.

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar prototipos de disparadores de una regla LLD

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

Solicitud:

{
           "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": "Los inodos libres son menos del 20% en el volumen {#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": "El espacio libre en disco es menos del 20% en el volumen {#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
       }

Recuperar un prototipo de iniciador específico 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": "Free disk space is less than 20% on volume {#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.