Documentation
Table of Contents
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 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;parámetro - parámetro (cadena) 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 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 parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| límite | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | cadena/matriz | |
| iniciarBuscar | booleano | |
| selectGroups (deprecated) |
query | Este parámetro 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 parámetro
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.