Documentation
Table of Contents
trigger.get
Descrição
integer/array trigger.get(object parameters)
O método permite recuperar triggers 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 Funções de usuário para mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| triggerids | ID/array | Retorna apenas triggers com os IDs fornecidos. |
| groupids | ID/array | Retorna apenas triggers que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates fornecidos. |
| templateids | ID/array | Retorna apenas triggers que pertencem aos templates fornecidos. |
| hostids | ID/array | Retorna apenas triggers que pertencem aos hosts fornecidos. |
| itemids | ID/array | Retorna apenas triggers que contenham os itens fornecidos. |
| functions | string/array | Retorna apenas triggers que usam as funções fornecidas. Consulte a página de funções suportadas para obter uma lista de funções suportadas. |
| group | string | Retorna apenas triggers que pertencem a hosts ou templates do grupo de hosts ou grupo de templates com o nome fornecido. |
| host | string | Retorna apenas triggers que pertencem ao host com o nome técnico fornecido. |
| inherited | boolean | Se definido como true, retorna apenas triggers herdados de um template. |
| templated | boolean | Se definido como true, retorna apenas triggers que pertencem a templates. |
| dependent | boolean | Se definido como true, retorna apenas triggers que possuem dependências. Se definido como false, retorna apenas triggers que não possuem dependências. |
| monitored | flag | Retorna apenas triggers habilitados que pertencem a hosts monitorados e contêm apenas itens habilitados. |
| active | flag | Retorna apenas triggers habilitados que pertencem a hosts monitorados. |
| maintenance | boolean | Se definido como true, retorna apenas triggers habilitados que pertencem a hosts em manutenção. |
| withUnacknowledgedEvents | flag | Retorna apenas triggers que possuem eventos não reconhecidos. |
| withAcknowledgedEvents | flag | Retorna apenas triggers com todos os eventos reconhecidos. |
| withLastEventUnacknowledged | flag | Retorna apenas triggers com o último evento não reconhecido. |
| skipDependent | flag | Ignora triggers em estado de problema que são dependentes de outros triggers. Observe que os outros triggers são ignorados se estiverem desabilitados, tiverem itens desabilitados ou hosts de itens desabilitados. |
| lastChangeSince | timestamp | Retorna apenas triggers que mudaram de estado após o tempo fornecido. |
| lastChangeTill | timestamp | Retorna apenas triggers que mudaram de estado antes do tempo fornecido. |
| only_true | flag | Retorna apenas triggers que recentemente estiveram em estado de problema. |
| min_severity | integer | Retorna apenas triggers com severidade maior ou igual à severidade fornecida. |
| evaltype | integer | Método de avaliação da tag. Valores possíveis: 0 - (padrão) E/Ou; 2 - Ou. |
| tags | array | Retorna apenas triggers com as tags fornecidas. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Um array vazio retorna todos os triggers. Valores possíveis para operator: 0 - (padrão) Contém; 1 - Igual; 2 - Não contém; 3 - Não é igual; 4 - Existe; 5 - Não existe. |
| expandComment | flag | Expande macros na descrição do trigger. |
| expandDescription | flag | Expande macros no nome do trigger. |
| expandExpression | flag | Expande funções e macros na expressão do trigger. |
| selectHostGroups | query | Retorna os grupos de hosts aos quais o trigger pertence na propriedade hostgroups. |
| selectHosts | query | Retorna os hosts aos quais o trigger pertence na propriedade hosts. |
| selectItems | query | Retorna os itens contidos pelo trigger na propriedade items. |
| selectFunctions | query | Retorna as funções usadas no 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 - (ID) ID da função;itemid - (ID) 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. |
| selectDependencies | query | Retorna triggers dos quais o trigger depende na propriedade dependencies. |
| selectDiscoveryRule | query | Retorna a regra de descoberta de baixo nível que criou o trigger na propriedade discoveryRule. |
| selectLastEvent | query | Retorna o último evento significativo do trigger na propriedade lastEvent. |
| selectTags | query | Retorna as tags do trigger na propriedade tags. |
| selectTemplateGroups | query | Retorna os grupos de templates aos quais o trigger pertence na propriedade templategroups. |
| selectTriggerDiscovery | query | Retorna o objeto de descoberta do trigger na propriedade triggerDiscovery. Os objetos de descoberta de trigger vinculam o trigger a um protótipo de trigger a partir do qual ele foi criado.Possui as seguintes propriedades: parent_triggerid - (ID) ID do protótipo de trigger a partir do qual o trigger foi criado;status - (int) status da descoberta do trigger:0 - (padrão) trigger foi descoberto, 1 - trigger não é mais descoberto; ts_delete - (timestamp) hora em que um trigger que não é mais descoberto será excluído;ts_disable - (timestamp) hora em que um trigger que não é mais descoberto será desabilitado;disable_source - (int) indicador de se o trigger foi desabilitado por uma regra LLD ou manualmente:0 - (padrão) desabilitado automaticamente, 1 - desabilitado por uma regra LLD. |
| filter | object | Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita um objeto, onde as chaves são nomes de propriedades e os valores são um único valor ou um array de valores para comparar. Não suporta propriedades do tipo de dado text data type.Suporta propriedades adicionais: host - nome técnico do host ao qual o trigger pertence;hostid - ID do host ao qual o trigger pertence. |
| limitSelects | integer | Limita o número de registros retornados por subconsultas. Aplica-se às seguintes subconsultas: selectHosts - os resultados serão classificados por host. |
| sortfield | string/array | Classifica o resultado pelas propriedades fornecidas. Valores possíveis: triggerid, description, status, priority, lastchange, hostname. |
| countOutput | boolean | Esses parâmetros são descritos 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 | |
| selectGroups (obsoleto) | query | Este parâmetro está obsoleto, use selectHostGroups ou selectTemplateGroups em seu lugar.Retorna os grupos de hosts e grupos de templates aos quais o trigger pertence na propriedade groups. |
Valores de retorno
(integer/array) Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperando dados pelo ID do trigger
Recupere todos os dados e as funções usadas no trigger "14062".
{ "jsonrpc": "2.0", "method": "trigger.get", "params": { "triggerids": "14062", "output": "extend", "selectFunctions": "extend" }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "triggerid": "14062", "expression": "{13513}<10m", "description": "{HOST.NAME} has been restarted (uptime < 10m)", "url": "", "status": "0", "value": "0", "priority": "2", "lastchange": "0", "comments": "The host uptime is less than 10 minutes", "error": "", "templateid": "10016", "type": "0", "state": "0", "flags": "0", "recovery_mode": "0", "recovery_expression": "", "correlation_mode": "0", "correlation_tag": "", "manual_close": "0", "opdata": "", "event_name": "", "uuid": "", "url_name": "", "functions": [ { "functionid": "13513", "itemid": "24350", "parameter": "$", "function": "last" } ] } ], "id": 1 }Recuperando triggers em estado de problema
Recupere o ID, nome e gravidade de todos os triggers em estado de problema e classifique-os por gravidade em ordem decrescente.
{ "jsonrpc": "2.0", "method": "trigger.get", "params": { "output": [ "triggerid", "description", "priority" ], "filter": { "value": 1 }, "sortfield": "priority", "sortorder": "DESC" }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "triggerid": "13907", "description": "Zabbix self-monitoring processes < 100% busy", "priority": "4" }, { "triggerid": "13824", "description": "Zabbix discoverer processes more than 75% busy", "priority": "3" } ], "id": 1 }Recuperando um trigger específico com tags
Recupere um trigger específico com tags.
{ "jsonrpc": "2.0", "method": "trigger.get", "params": { "output": [ "triggerid", "description" ], "selectTags": "extend", "triggerids": [ "17578" ] }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "triggerid": "17370", "description": "Service status", "tags": [ { "tag": "service", "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}" }, { "tag": "error", "value": "" } ] } ], "id": 1 }Veja também
Fonte
CTrigger::get() in ui/include/classes/api/services/CTrigger.php.