discoveryruleprototype.get

Descrição

integer/array discoveryruleprototype.get(object parameters)

O método permite recuperar protótipos de regras LLD 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
discoveryids	ID/array	Retorna apenas protótipos de regras LLD que pertencem às regras LLD ou protótipos de regras LLD fornecidos.
itemids	ID/array	Retorna apenas protótipos de regras LLD com os IDs fornecidos.
groupids	ID/array	Retorna apenas protótipos de regras LLD que pertencem aos hosts dos grupos fornecidos.
hostids	ID/array	Retorna apenas protótipos de regras LLD que pertencem aos hosts fornecidos.
inherited	boolean	Se definido como `true`, retorna apenas protótipos de regras LLD herdados de um template.
interfaceids	ID/array	Retorna apenas protótipos de regras LLD que usam as interfaces de host fornecidas.
monitored	boolean	Se definido como `true`, retorna apenas protótipos de regras LLD habilitados que pertencem a hosts monitorados.
templated	boolean	Se definido como `true`, retorna apenas protótipos de regras LLD que pertencem a templates.
templateids	ID/array	Retorna apenas protótipos de regras LLD que pertencem aos templates fornecidos.
selectDiscoveryRule	query	Retorna uma propriedade `discoveryRule` com a regra LLD pai do protótipo de regra LLD. Retornará uma resposta vazia se o pai for um protótipo de regra de descoberta.
selectDiscoveryRulePrototype	query	Retorna uma propriedade `discoveryRulePrototype` com o protótipo de regra LLD pai do protótipo de regra LLD. Retornará uma resposta vazia se o pai for uma regra de descoberta (não protótipo).
selectDiscoveryRulePrototypes	query	Retorna uma propriedade `discoveryRulePrototypes` com protótipos de regras LLD filhas que pertencem ao protótipo de regra LLD. Suporta `count`.
selectFilter	query	Retorna uma propriedade `filter` com dados do filtro usado pelo protótipo de regra LLD.
selectGraphs	query	Retorna uma propriedade `graphs` com protótipos de gráficos que pertencem ao protótipo de regra LLD. Suporta `count`.
selectHostPrototypes	query	Retorna uma propriedade `hostPrototypes` com protótipos de host que pertencem ao protótipo de regra LLD. Suporta `count`.
selectHosts	query	Retorna uma propriedade `hosts` com um array de hosts ao qual o protótipo de regra LLD pertence.
selectItems	query	Retorna uma propriedade `items` com protótipos de item que pertencem ao protótipo de regra LLD. Suporta `count`.
selectTriggers	query	Retorna uma propriedade `triggers` com protótipos de trigger que pertencem ao protótipo de regra LLD. Suporta `count`.
selectLLDMacroPaths	query	Retorna uma propriedade `lld_macro_paths` com uma lista de macros LLD e caminhos para valores atribuídos a cada macro correspondente.
selectPreprocessing	query	Retorna uma propriedade `preprocessing` com opções de pré-processamento do protótipo de regra LLD.
selectOverrides	query	Retorna uma propriedade `lld_rule_overrides` com uma lista de filtros de sobrescrita, condições e operações que são realizadas em objetos protótipos.
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 protótipo de regra LLD pertence.
limitSelects	integer	Limita o número de registros retornados por subconsultas. Aplica-se às seguintes subconsultas: `selectItems`, `selectGraphs`, `selectTriggers`.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `itemid`, `name`, `key_`, `delay`, `type`, `status`.
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

Recuperando protótipos de regras de descoberta de um host

Recupere todos os protótipos de regras de descoberta para um ID de host específico.

Requisição:

{
           "jsonrpc": "2.0",
           "method": "discoveryruleprototype.get",
           "params": {
               "hostids": "10084"
           },
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "itemid": "47253",
                   "type": "23",
                   "snmp_oid": "",
                   "hostid": "10084",
                   "name": "Discover tablespaces for {#DB}",
                   "key_": "db.tablespace.discovery[{#DB}]",
                   "delay": "0",
                   "history": "31d",
                   "trends": "365d",
                   "status": "0",
                   "value_type": "4",
                   "trapper_hosts": "",
                   "units": "",
                   "logtimefmt": "",
                   "templateid": "0",
                   "valuemapid": "0",
                   "params": "",
                   "ipmi_sensor": "",
                   "authtype": "0",
                   "username": "",
                   "password": "",
                   "publickey": "",
                   "privatekey": "",
                   "flags": "3",
                   "interfaceid": "0",
                   "description": "",
                   "inventory_link": "0",
                   "lifetime": "7d",
                   "jmx_endpoint": "",
                   "master_itemid": "0",
                   "timeout": "",
                   "url": "",
                   "query_fields": [],
                   "posts": "",
                   "status_codes": "200",
                   "follow_redirects": "1",
                   "post_type": "0",
                   "http_proxy": "",
                   "headers": [],
                   "retrieve_mode": "0",
                   "request_method": "0",
                   "output_format": "0",
                   "ssl_cert_file": "",
                   "ssl_key_file": "",
                   "ssl_key_password": "",
                   "verify_peer": "0",
                   "verify_host": "0",
                   "allow_traps": "0",
                   "discover": "0",
                   "uuid": "",
                   "lifetime_type": "0",
                   "enabled_lifetime_type": "2",
                   "enabled_lifetime": "0",
                   "parameters": []
               }
           ],
           "id": 1
       }

Veja também

Fonte

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

Documentation