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 suporta os seguintes parâmetros.

Parameter Type Description
active flag Retornar apenas protótipos de trigger habilitados que pertencem a hosts monitorados.
discoveryids ID/array Retornar apenas protótipos de trigger que pertencem às regras de LLD informadas.
functions string/array Retornar apenas triggers que usam as funções informadas.

Consulte a página Supported functions para obter uma lista das funções suportadas.
group string Retornar apenas protótipos de trigger que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates com o nome informado.
groupids ID/array Retornar apenas protótipos de trigger que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates informados.
host string Retornar apenas protótipos de trigger que pertencem a hosts com o nome informado.
hostids ID/array Retornar apenas protótipos de trigger que pertencem aos hosts informados.
inherited boolean Se definido como true, retornar apenas protótipos de trigger herdados de um template.
maintenance boolean Se definido como true, retornar apenas protótipos de trigger habilitados que pertencem a hosts em manutenção.
min_severity integer Retornar apenas protótipos de trigger com severidade maior ou igual à severidade informada.
monitored flag Retornar apenas protótipos de trigger habilitados que pertencem a hosts monitorados e contêm apenas items habilitados.
templated boolean Se definido como true, retornar apenas protótipos de trigger que pertencem a templates.
templateids ID/array Retornar apenas protótipos de trigger que pertencem aos templates informados.
triggerids ID/array Retornar apenas protótipos de trigger com os IDs informados.
expandExpression flag Expandir funções e macros na expressão do trigger.
selectDependencies query Retornar protótipos de trigger e triggers dos quais o protótipo de trigger depende na propriedade dependencies.
selectDiscoveryData query Retornar 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 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 protótipo de trigger foi criado;
status - (int) status da descoberta do protótipo de trigger:
0 - (padrão) o protótipo de trigger foi descoberto,
1 - o protótipo de trigger não está mais descoberto;
ts_delete - (timestamp) momento em que um protótipo de trigger que não está mais descoberto será excluído;
ts_disable - (timestamp) momento em que um protótipo de trigger que não está 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 Retornar a regra de LLD à qual o protótipo de trigger pertence na propriedade discoveryRule.
selectDiscoveryRulePrototype query Retornar uma propriedade discoveryRulePrototype com o protótipo da regra de LLD pai ao qual o protótipo de trigger pertence.
selectFunctions query Retornar 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 de consulta é substituído pelo símbolo $ na string retornada.
selectHostGroups query Retornar os grupos de hosts aos quais o protótipo de trigger pertence na propriedade hostgroups.
selectHosts query Retornar os hosts aos quais o protótipo de trigger pertence na propriedade hosts.
selectItems query Retornar items e protótipos de item usados pelo protótipo de trigger na propriedade items.
selectTags query Retornar as tags do protótipo de trigger na propriedade tags.
selectTemplateGroups query Retornar os grupos de templates aos quais o protótipo de trigger pertence na propriedade templategroups.
filter object Retornar apenas os resultados que correspondem exatamente ao filtro informado.

Aceita um objeto, em que as chaves são nomes de propriedades e os valores são um único valor ou uma matriz de valores com os quais comparar.

Não suporta propriedades do tipo de dados text data type.

Suporta 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 pelos subselects.

Aplica-se aos seguintes subselects:
selectHosts - os resultados serão ordenados por host.
sortfield string/array Ordenar o resultado pelas propriedades informadas.

Valores possíveis: triggerid, description, status, priority, discovered.
countOutput boolean Esses parâmetros são descritos no reference commentary.
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.

Request:

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