trigger.get

Descrição

integer/array trigger.get(object parameters)

O método permite recuperar triggers de acordo com os parâmetros informados.

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 de usuário. Consulte User roles para obter mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
triggerids ID/array Retorna somente os triggers com os IDs fornecidos.
groupids ID/array Retorna somente os triggers pertencentes a hosts ou templates dos grupos de hosts ou grupos de templates fornecidos.
templateids ID/array Retorna somente os triggers pertencentes aos templates fornecidos.
hostids ID/array Retorna somente os triggers pertencentes aos hosts fornecidos.
itemids ID/array Retorna somente os triggers que contêm os items fornecidos.
maintenanceids ID/array Retorna somente os triggers afetados pelas manutenções fornecidas.
functions string/array Retorna somente os triggers que usam as funções fornecidas.

Consulte a página de funções compatíveis para obter uma lista das funções compatíveis.
group string Retorna somente os triggers pertencentes a hosts ou templates do grupo de hosts ou grupo de templates com o nome fornecido.
host string Retorna somente os triggers pertencentes ao host com o nome técnico fornecido.
inherited boolean Se definido como true, retorna somente os triggers herdados de um template.
templated boolean Se definido como true, retorna somente os triggers pertencentes a templates.
dependent boolean Se definido como true, retorna somente os triggers que têm dependências. Se definido como false, retorna somente os triggers que não têm dependências.
monitored flag Retorna somente os triggers habilitados que pertencem a hosts monitorados e contêm apenas items habilitados.
active flag Retorna somente os triggers habilitados que pertencem a hosts monitorados.
maintenance boolean Se definido como true, retorna somente os triggers habilitados que pertencem a hosts em manutenção.
withUnacknowledgedEvents flag Retorna somente os triggers que têm eventos não reconhecidos.
withAcknowledgedEvents flag Retorna somente os triggers com todos os eventos reconhecidos.
withLastEventUnacknowledged flag Retorna somente os triggers cujo último evento não foi reconhecido.
skipDependent flag Ignora triggers em estado de problema que dependem de outros triggers. Observe que os outros triggers são ignorados se estiverem desabilitados, tiverem items desabilitados ou pertencerem a hosts com items desabilitados.
lastChangeSince timestamp Retorna somente os triggers que alteraram seu estado após o horário fornecido.
lastChangeTill timestamp Retorna somente os triggers que alteraram seu estado antes do horário fornecido.
only_true flag Retorna somente os triggers que estiveram recentemente em estado de problema (dentro de ok_period).
min_severity integer Retorna somente os triggers com severidade maior ou igual à severidade fornecida.
evaltype integer Método de avaliação das tags.

Valores possíveis:
0 - (padrão) E/OU;
2 - OU.
tags array Retorna somente os triggers com as tags fornecidas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Uma matriz vazia retorna todos os triggers.

Valores possíveis de operador:
0 - (padrão) Contém;
1 - É igual a;
2 - Não contém;
3 - Não é igual a;
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 items 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 têm 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 os triggers dos quais o trigger depende na propriedade dependencies.
selectDiscoveryData query Retorna uma propriedade discoveryData com os dados do objeto de descoberta do trigger. O objeto de descoberta do trigger vincula um trigger descoberto a um protótipo de trigger a partir do qual ele foi descoberto.

Ele tem as seguintes propriedades:
parent_triggerid - (ID) ID do protótipo de trigger a partir do qual o trigger foi criado;
status - (int) status de descoberta do trigger:
0 - (padrão) o trigger foi descoberto,
1 - o trigger não é mais descoberto;
ts_delete - (timestamp) horário em que um trigger que não é mais descoberto será excluído;
ts_disable - (timestamp) horário em que um trigger que não é mais descoberto será desabilitado;
disable_source - (int) indicador de que o trigger foi desabilitado por uma regra de LLD ou manualmente:
0 - (padrão) desabilitado automaticamente,
1 - desabilitado por uma regra de LLD.
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.
inheritedTags boolean Retorna triggers que também têm as tags fornecidas no template/host/templates vinculados.

Valores possíveis:
true - o template/host/templates vinculados também devem ter as tags fornecidas;
false - (padrão) as tags do template/host/templates vinculados são ignoradas.
selectInheritedTags query Retorna uma propriedade inheritedTags com tags herdadas de templates, templates vinculados e hosts, e de items referenciados nas expressões do trigger ou de recuperação.
selectTemplateGroups query Retorna os grupos de templates aos quais o trigger pertence na propriedade templategroups.
filter object Retorna somente os resultados que correspondem exatamente ao filtro fornecido.

Aceita um objeto cujas chaves são nomes de propriedades e cujos valores são um único valor ou uma matriz de valores a serem comparados.

Não oferece suporte a propriedades do tipo de dados text.

Oferece suporte às seguintes 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 subseleções.

Aplica-se às seguintes subseleções:
selectHosts - os resultados serão ordenados por host.
sortfield string/array Ordena o resultado pelas propriedades fornecidas.

Valores possíveis: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Esses parâmetros estã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
selectTriggerDiscovery query Retorna o objeto de descoberta do trigger na propriedade triggerDiscovery. Os objetos de descoberta do trigger vinculam o trigger a um protótipo de trigger a partir do qual ele foi criado.

Esta consulta está obsoleta; use selectDiscoveryData em seu lugar.

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando dados pelo ID do trigger

Recupere todos os dados e as funções usadas no trigger "14062".

Requisição:

{
    "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",
                    "triggerid": "14062",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Recuperando triggers em estado de problema

Recupere o ID, nome e severidade de todos os triggers em estado de problema e classifique-os por severidade em ordem decrescente.

Requisição:

{
    "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.

Requisição:

{
    "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\")}",
                    "automatic": "1"
                },
                {
                    "tag": "error",
                    "value": "",
                    "automatic": "1"
                }
            ]
        }
    ],
    "id": 1
}

Veja também

Fonte

CTrigger::get() em ui/include/classes/api/services/CTrigger.php.