Documentation
Table of Contents
triggerprototype.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array triggerprototype.get(object parameters)
El m¨¦todo permite recuperar prototipos de iniciadores seg¨²n los ±è²¹°ù¨¢³¾±ð³Ù°ù´Çs 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.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes ±è²¹°ù¨¢³¾±ð³Ù°ù´Çs.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| active | flag | Devolver solo los prototipos de disparadores habilitados que pertenecen a hosts monitoreados. |
| discoveryids | ID/matriz | Devuelve solo los prototipos de activaci¨®n que pertenecen a las reglas LLD dadas. |
| funciones | cadena/matriz | Devuelve solo activadores que usan las funciones dadas. Consulte la p¨¢gina Funciones admitidas para obtener una lista de funciones admitidas. |
| grupo | cadena | Devuelve solo los prototipos de activaci¨®n que pertenecen a hosts o plantillas de los grupos de hosts o grupos de plantillas con el nombre indicado. |
| groupids | ID/matriz | Devuelve solo prototipos de activaci¨®n que pertenecen a hosts o plantillas de los grupos de hosts o grupos de plantillas dados. |
| host | cadena | Devuelve solo los prototipos de activaci¨®n que pertenecen a hosts con el nombre dado. |
| hostids | ID/matriz | Devuelve solo los prototipos de activaci¨®n que pertenecen a los hosts dados. |
| heredado | booleano | Si se establece en "verdadero", solo se devuelven prototipos de activaci¨®n heredados de una plantilla. |
| mantenimiento | booleano | Si se establece en "verdadero", devolver¨¢ solo los prototipos de activaci¨®n habilitados que pertenecen a los hosts 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 disparadores habilitados que pertenecen a hosts monitoreados y que contienen solo elementos habilitados. |
| template | boolean | Si se establece en true, solo se devuelven prototipos que pertenecen a plantillas. |
| templateids | ID/matriz | Devuelve solo los prototipos de activaci¨®n que pertenecen a las plantillas dadas. |
| triggerids | ID/matriz | Devuelve solo los prototipos de activaci¨®n con los ID proporcionados. |
| expandExpression | flag | Ampliar funciones y macros en la expresi¨®n desencadenante. |
| selectDependencies | query | Devuelve prototipos de disparador y disparadores de los que depende el prototipo de disparador en la propiedad dependencias. |
| selectDiscoveryRule | consulta | Devuelve la regla LLD a la que pertenece el prototipo del activador en la propiedad discoveryRule. |
| selectFunctions | query | Devuelve funciones utilizadas en el prototipo del activador en la propiedad functions.Los objetos de funci¨®n representan las funciones utilizadas en la expresi¨®n del activador 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;±è²¹°ù¨¢³¾±ð³Ù°ù´Ç - ±è²¹°ù¨¢³¾±ð³Ù°ù´Ç (cadena) pasado a la funci¨®n. El ±è²¹°ù¨¢³¾±ð³Ù°ù´Ç 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 del activador en la propiedad hostgroups. |
| selectHosts | query | Devuelve los hosts a los que pertenece el prototipo del activador en la propiedad hosts. |
| selectItems | query | Los elementos devueltos y los prototipos de elementos utilizaron el prototipo de activaci¨®n en la propiedad items. |
| selectTags | query | Devuelve las etiquetas del prototipo de activaci¨®n en la propiedad tags. |
| selectTemplateGroups | query | Devuelve los grupos de plantillas a los que pertenece el prototipo del activador en la propiedad templategroups. |
| filtro | objeto | Devuelve s¨®lo aquellos resultados que coinciden exactamente con el filtro dado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor ¨²nico o una matriz de valores con los que comparar. No admite propiedades de text tipo de datos.Admite propiedades adicionales: host - nombre t¨¦cnico del host al que pertenece el prototipo del disparador;hostid - ID del host al que pertenece el prototipo del disparador. |
| 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. Valores posibles: triggerid, description, status, priority. |
| countOutput | boolean | Estos ±è²¹°ù¨¢³¾±ð³Ù°ù´Çs, que son comunes para todos los m¨¦todos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| ±ô¨ª³¾¾±³Ù±ð | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| ³¦±ô²¹²õ¾±´Ú¾±³¦²¹³¦¾±¨®²Ô | cadena/matriz | |
| iniciarBuscar | booleano | |
| selectGroups (deprecated) |
query | Este ±è²¹°ù¨¢³¾±ð³Ù°ù´Ç est¨¢ en desuso; utilice selectHostGroups o selectTemplateGroups en su lugar.Devuelve los grupos de hosts y los grupos de plantillas a los que pertenece el prototipo del activador en la propiedad groups. |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el ±è²¹°ù¨¢³¾±ð³Ù°ù´Ç
countOutputha sido usado.
Ejemplos
Recuperar prototipos de iniciador de una regla LLD
Recupere todos los prototipos de iniciador y sus funciones de una regla LLD.
{
"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 un prototipo de iniciador espec¨ªfico con etiquetas
{
"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.