Documentation
Table of Contents
triggerprototype.get
Descri??o
integer/array triggerprototype.get(object parameters)
O m¨¦todo permite recuperar prot¨®tipos de trigger de acordo com os par?metros fornecidos.
Este m¨¦todo est¨¢ dispon¨ªvel para usu¨¢rios de qualquer tipo. As permiss?es para chamar o m¨¦todo podem ser revogadas nas configura??es de fun??o do usu¨¢rio. Consulte User roles para obter mais informa??es.
Par?metros
(object) Par?metros que definem a sa¨ªda desejada.
O m¨¦todo oferece suporte aos par?metros a seguir.
| Par?metro | Type | Descri??o |
|---|---|---|
| active | flag | Retorna apenas prot¨®tipos de trigger habilitados que pertencem a hosts monitorados. |
| discoveryids | string/array | Retorna apenas prot¨®tipos de trigger que pertencem ¨¤s regras LLD fornecidas. |
| functions | string/array | Retorne apenas triggers que usam as fun??es fornecidas. Consulte a p¨¢gina supported trigger functions para obter uma lista de fun??es compat¨ªveis. |
| group | string | Retorna apenas prot¨®tipos de trigger que pertencem a hosts dos grupos de hosts com o nome fornecido. |
| groupids | string/array | Retorna apenas prot¨®tipos de trigger que pertencem a hosts dos grupos de hosts fornecidos. |
| host | string | Retorna apenas prot¨®tipos de trigger que pertencem a hosts com o nome fornecido. |
| inherited | boolean | Se definido como true, retorna apenas prot¨®tipos de trigger herdados de um modelo. |
| manuten??o | boolean | Se definido como true retorna apenas prot¨®tipos de trigger habilitados que pertencem a hosts em manuten??o. |
| min_severity | integer | Retorna apenas prot¨®tipos de trigger com gravidade maior ou igual ¨¤ gravidade especificada. |
| monitored | flag | Retorna apenas prot¨®tipos de trigger ativados que pertencem a hosts monitorados e cont¨ºm apenas itens ativados. |
| templated | boolean | Se definido como true, retornar¨¢ apenas prot¨®tipos de trigger que pertencem a templates. |
| templateids | string/array | Retorna apenas prot¨®tipos de trigger que pertencem aos modelos fornecidos. |
| triggerids | string/array | Retorna apenas prot¨®tipos de trigger com os IDs fornecidos. |
| expandExpression | flag | Expandir fun??es e macros na express?o da trigger. |
| selectDependencies | query | Retorne prot¨®tipos de trigger e triggers dos quais o prot¨®tipo de trigger depende na propriedade dependencies. |
| selectDiscoveryRule | query | Retorne a LLD rule ¨¤ qual o prot¨®tipo da trigger pertence. |
| selectFunctions | query | Retorna as fun??es usadas no prot¨®tipo do trigger na propriedade functions.Os objetos de fun??o representam as fun??es usadas na express?o do trigger e possuem as seguintes propriedades: functionid - * (string)* ID da fun??o;itemid - (string) ID do item usado na fun??o;function - (string) nome da fun??o;parameter - (string) par?metro passado para a fun??o. O par?metro de consulta ¨¦ substitu¨ªdo pelo s¨ªmbolo $ na string retornada. |
| selectGroups | query | Retorne os grupos de hosts aos quais o prot¨®tipo do trigger pertence na propriedade groups. |
| selectHosts | query | Retorne os hosts aos quais o prot¨®tipo do trigger pertence na propriedade hosts. |
| selectItems | query | Itens de retorno e prot¨®tipos de itens usaram o prot¨®tipo de trigger na propriedade items. |
| selectTags | query | Retorne as etiquetas de prot¨®tipo de trigger na propriedade etiquetas. |
| filter | object | Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita uma array, em que as chaves s?o nomes de propriedades e os valores s?o um ¨²nico valor ou uma array de valores para correspond¨ºncia. Suporta filtros adicionais: host - nome t¨¦cnico do host ao qual o prot¨®tipo da trigger pertence;hostid - ID do host ao qual o prot¨®tipo da trigger pertence. |
| limitSelects | integer | Limite o n¨²mero de registros retornados por subsele??es. Aplica-se ¨¤s seguintes subsele??es: selectHosts - os resultados ser?o classificados por host. |
| sortfield | string/array | Ordenar o resultado pelas propriedades fornecidas. Os valores poss¨ªveis s?o: triggerid, description, status e priority. |
| countOutput | boolean | Esses par?metros sendo comuns para todos os m¨¦todos get s?o descritos em detalhes no coment¨¢rio de refer¨ºncia. |
| 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) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o par?metro
countOutputfoi usado.
Exemplos
Recuperar prot¨®tipos de trigger de uma regra LLD
Recupere todos os prot¨®tipos de trigger e suas fun??es de uma regra LLD.
Request:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": "extend",
"selectFunctions": "extend",
"discoveryids": "22450"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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
}Recuperando um prot¨®tipo de trigger espec¨ªfica com etiquetas
Request:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": [
"triggerid",
"description"
]
"selectTags": "extend",
"triggerids": [
"17373"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"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
}Veja tamb¨¦m
Fonte
CTriggerPrototype::get() in ui/include/classes/api/services/CTriggerPrototype.php.