triggerprototype.get

Descripción

entero/matriz triggerprototype.get(parámetros de objeto)

El método permite recuperar prototipos de iniciador de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para 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 los prototipos de iniciadores habilitados que pertenecen a equipos monitoreados.
discoveryids string/array Devuelve solo los prototipos de iniciadores que pertenecen a las reglas LLD dadas.
functions cadena/matriz Devuelve solo iniciadores que usan las funciones dadas.

Consulte la página Funciones admitidas para obtener una lista de funciones admitidas.
group cadena Devuelve solo los prototipos de iniciadores que pertenecen a equipos de los grupos de equipos con el nombre dado.
groupids cadena/matriz Devuelve solo prototipos de iniciadores que pertenecen a equipos de los grupos de equipos dados.
host cadena Devuelve solo los prototipos de iniciadores que pertenecen a equipos con el nombre dado.
hostids cadena/matriz Devuelve solo los prototipos de iniciadores que pertenecen a los equipos dados.
inherited booleano Si se establece en "verdadero", solo se devuelven prototipos de iniciadores heredados de una plantilla.
maintenance booleano Si se establece en "verdadero", devolverá solo los prototipos de iniciadores habilitados que pertenecen a equipos en mantenimiento.
min_severity integer Devolver solo activa prototipos con una gravedad mayor o igual que la gravedad dada.
monitored flag Devuelve solo prototipos de iniciadores habilitados que pertenecen a equipos monitoreados y que contienen solo métricas habilitadas.
template boolean Si se establece en true, solo se devuelven prototipos de iniciadores que pertenecen a plantillas.
templateids cadena/matriz Devuelve solo los prototipos de iniciadores que pertenecen a las plantillas dadas.
triggerids string/array Devuelve solo los prototipos de iniciadores con los ID proporcionados.
expandExpression flag Ampliar funciones y macros en la expresión de iniciador.
selectDependencies query Devuelve prototipos de iniciadores e iniciadores de los que depende el prototipo de iniciador en la propiedad dependencias.
selectDiscoveryRule consulta Devuelve la regla LLD a la que pertenece el prototipo del iniciador.
selectFunctions query Devuelve funciones utilizadas en el prototipo del iniciador en la propiedad functions.

Los objetos de función representan las funciones utilizadas en la expresión del iniciador y tienen las siguientes propiedades:
functionid - * (cadena)* ID de la función;
itemid - (cadena) ID de la métrica utilizada en la función;
función - (cadena) nombre de la función;
parámetro - (cadena) parámetro pasado a la función. El parámetro de consulta se reemplaza por el símbolo $ en la cadena devuelta.
selectGroups query Devuelve los grupos de equipos a los que pertenece el prototipo del iniciador en la propiedad groups.
selectHosts query Devuelve los hosts a los que pertenece el prototipo del iniciador en la propiedad hosts.
selectItems query Los elementos devueltos y los prototipos de métricas utilizaron el prototipo de iniciador en la propiedad items.
selectTags query Devuelve las etiquetas del prototipo de iniciador en la propiedad tags.
filter objeto Devuelve sólo aquellos resultados que coinciden exactamente con el filtro dado.

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

Admite filtros adicionales:
host: nombre técnico del equipo al que pertenece el prototipo del iniciador;
hostid: ID del equipo al que pertenece el prototipo del iniciador.
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 según las propiedades dadas.

Los valores posibles son: triggerid, description, status y priority.
countOutput boolean Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia.
editable booleano
excludeSearch booleano
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano

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 iniciador de una regla LLD

Recupere todos los prototipos de iniciador y sus funciones de una regla LLD.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.get",
           "params": {
               "output": "extend",
               "selectFunctions": "extend",
               "discoveryids": "22450"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "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",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "triggerid": "13266",
                           "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.