discoveryruleprototype.get

Descrição

integer/array discoveryruleprototype.get(object parameters)

O método permite recuperar protótipos de regra de LLD 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
itemids ID/array Retorna apenas protótipos de regra LLD com os IDs informados.
groupids ID/array Retorna apenas protótipos de regra LLD que pertencem aos hosts dos grupos informados.
hostids ID/array Retorna apenas protótipos de regra LLD que pertencem aos hosts informados.
inherited boolean Se definido como true, retorna apenas protótipos de regra LLD herdados de um template.
interfaceids ID/array Retorna apenas protótipos de regra LLD que usam as interfaces de host informadas.
monitored boolean Se definido como true, retorna apenas protótipos de regra LLD habilitados que pertencem a hosts monitorados.
templated boolean Se definido como true, retorna apenas protótipos de regra LLD que pertencem a templates.
templateids ID/array Retorna apenas protótipos de regra LLD que pertencem aos templates informados.
selectDiscoveryRule query Retorna uma propriedade discoveryRule com a regra LLD pai do protótipo de regra LLD.
selectDiscoveryRulePrototype query Retorna uma propriedade discoveryRulePrototype com o protótipo de regra LLD pai do protótipo de regra LLD.
selectDiscoveryRulePrototypes query Retorna uma propriedade discoveryRulePrototypes com protótipos de regra LLD filhos que pertencem ao protótipo de regra LLD.

Suporta count.
selectFilter query Retorna uma propriedade filter com os dados do filtro usado pelo protótipo de regra LLD.
selectGraphs query Retorna uma propriedade graphs com protótipos de gráfico 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 uma matriz de hosts aos quais 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 os valores atribuídos a cada macro correspondente.
selectPreprocessing query Retorna uma propriedade preprocessing com as opções de pré-processamento do protótipo de regra LLD.
selectOverrides query Retorna uma propriedade lld_rule_overrides com uma lista de filtros, condições e operações de substituição executadas em objetos de protótipo.
filter object Retorna 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 para correspondência.

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 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 Classifica o resultado pelas propriedades informadas.

Valores possíveis: itemid, name, key_, delay, type, status.
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 dos seguintes:

  • um array de objetos;
  • a contagem dos 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": "Descobrir tablespaces para {#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",
            "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

Source

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