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 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
active	flag	Retorna apenas protótipos de trigger habilitados que pertencem a hosts monitorados.
discoveryids	ID/array	Retorna apenas protótipos de trigger que pertencem às regras LLD fornecidas.
functions	string/array	Retorna apenas triggers que usam as funções fornecidas. Consulte a página Funções suportadas para obter uma lista de funções suportadas.
group	string	Retorna apenas 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 apenas protótipos de trigger que pertencem a hosts ou templates dos grupos de hosts ou grupos de templates fornecidos.
host	string	Retorna apenas protótipos de trigger que pertencem a hosts com o nome fornecido.
hostids	ID/array	Retorna apenas protótipos de trigger que pertencem aos hosts fornecidos.
inherited	boolean	Se definido como `true`, retorna apenas protótipos de trigger herdados de um template.
maintenance	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 severidade maior ou igual à severidade fornecida.
monitored	flag	Retorna apenas protótipos de trigger habilitados que pertencem a hosts monitorados e contêm apenas itens habilitados.
templated	boolean	Se definido como `true`, retorna apenas protótipos de trigger que pertencem a templates.
templateids	ID/array	Retorna apenas protótipos de trigger que pertencem aos templates fornecidos.
triggerids	ID/array	Retorna apenas protótipos de trigger com os IDs fornecidos.
expandExpression	flag	Expande funções e macros na expressão do trigger.
selectDependencies	query	Retorna protótipos de trigger e 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 a um protótipo de trigger do qual foi descoberto. Possui as seguintes propriedades: `parent_triggerid` - `(ID)` ID do protótipo de trigger do qual o protótipo de trigger foi criado; `status` - `(int)` status de descoberta do protótipo de trigger: 0 - (padrão) protótipo de trigger foi descoberto, 1 - protótipo de trigger não é mais descoberto; `ts_delete` - `(timestamp)` hora em que um protótipo de trigger que não é mais descoberto será excluído; `ts_disable` - `(timestamp)` hora em que um protótipo de trigger que não é mais descoberto será desabilitado; `disable_source` - `(int)` indicador se o protótipo de trigger foi desabilitado por uma regra LLD ou manualmente: 0 - (padrão) desabilitado automaticamente, 1 - desabilitado por uma regra LLD.
selectDiscoveryRule	query	Retorna a regra LLD à qual o protótipo de trigger pertence na propriedade `discoveryRule`.
selectDiscoveryRulePrototype	query	Retorna uma propriedade `discoveryRulePrototype` com o protótipo da regra LLD pai ao qual o protótipo de trigger pertence.
selectFunctions	query	Retorna 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 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.
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`.
selectItems	query	Retorna itens e protótipos de item usados no 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 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 correspondência. Não suporta propriedades do tipo de dado `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 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`, `discovered`.
countOutput	boolean	Estes 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

Recupera 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",
                           "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