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 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 Funções de usuário 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
active flag Retorna somente protótipos de trigger habilitados que pertencem a hosts monitorados.
discoveryids ID/array Retorna somente protótipos de trigger que pertencem às regras de LLD fornecidas.
functions string/array Retorna somente triggers que usam as funções fornecidas.

Consulte a página Funções compatíveis para obter a lista de funções compatíveis.
group string Retorna somente protótipos de trigger que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates com o nome fornecido.
groupids ID/array Retorna somente protótipos de trigger que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates fornecidos.
host string Retorna somente protótipos de trigger que pertencem a hosts com o nome fornecido.
hostids ID/array Retorna somente protótipos de trigger que pertencem aos hosts fornecidos.
inherited boolean Se definido como true, retorna somente protótipos de trigger herdados de um template.
maintenance boolean Se definido como true, retorna somente protótipos de trigger habilitados que pertencem a hosts em manutenção.
min_severity integer Retorna somente protótipos de trigger com severidade maior ou igual à severidade fornecida.
monitored flag Retorna somente protótipos de trigger habilitados que pertencem a hosts monitorados e contêm apenas itens habilitados.
templated boolean Se definido como true, retorna somente protótipos de trigger que pertencem a templates.
templateids ID/array Retorna somente protótipos de trigger que pertencem aos templates fornecidos.
triggerids ID/array Retorna somente protótipos de trigger com os IDs fornecidos.
expandExpression flag Expande funções e macros na expressão do trigger.
selectDependencies query Retorna os protótipos de trigger e os triggers dos quais o protótipo de trigger depende na propriedade dependencies.
selectDiscoveryData query Retorna uma propriedade discoveryData com os dados do objeto de descoberta do protótipo de trigger. O objeto de descoberta do protótipo de trigger vincula um protótipo de trigger descoberto ao 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 protótipo de trigger foi criado;
status - (int) status de descoberta do protótipo de trigger:
0 - (padrão) o protótipo de trigger foi descoberto,
1 - o protótipo de trigger não é mais descoberto;
ts_delete - (timestamp) momento em que um protótipo de trigger que não é mais descoberto será excluído;
ts_disable - (timestamp) momento em que um protótipo de trigger que não é mais descoberto será desabilitado;
disable_source - (int) indicador de se o protótipo de 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 LLD à qual o protótipo de trigger pertence na propriedade discoveryRule.
selectDiscoveryRulePrototype query Retorna uma propriedade discoveryRulePrototype com o protótipo da regra de LLD pai à qual o protótipo de trigger pertence.
selectFunctions query Retorna as funções usadas no protótipo de 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 da consulta é substituído pelo símbolo $ na string retornada.
selectHostGroups query Retorna os grupos de hosts aos quais o protótipo de trigger pertence na propriedade hostgroups.
selectHosts query Retorna os hosts aos quais o protótipo de trigger pertence na propriedade hosts.
selectInheritedTags query Retorna uma propriedade inheritedTags com tags herdadas de templates, templates vinculados e hosts, além de itens e protótipos de item referenciados nas expressões de trigger ou de recuperação.
selectItems query Retorna os itens e protótipos de item usados pelo protótipo de trigger na propriedade items.
selectTags query Retorna as tags do protótipo de trigger na propriedade tags.
selectTemplateGroups query Retorna os grupos de templates aos quais o protótipo de 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 é compatível com propriedades do tipo de dados text.

É compatível com as seguintes propriedades adicionais:
host - nome técnico do host ao qual o protótipo de trigger pertence;
hostid - ID do host ao qual o protótipo de 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, discovered.
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

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido 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.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": "extend",
        "selectFunctions": "extend",
        "discoveryids": "22450"
    },
    "id": 1
}

Resposta:

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

Recuperando um protótipo de trigger específico com tags

Requisição:

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": [
            "triggerid",
            "description"
        ],
        "selectTags": "extend",
        "triggerids": [
            "17373"
        ]
    },
    "id": 1
}

Resposta:

{
    "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() em ui/include/classes/api/services/CTriggerPrototype.php.