discoveryruleprototype.get

Descripción

integer/array discoveryruleprototype.get(object parameters)

El método permite recuperar prototipos de reglas LLD según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
itemids ID/array Devolver solo prototipos de reglas LLD con los IDs dados.
groupids ID/array Devolver solo prototipos de reglas LLD que pertenezcan a los hosts de los grupos dados.
hostids ID/array Devolver solo prototipos de reglas LLD que pertenezcan a los hosts dados.
inherited boolean Si se establece en true, devolver solo prototipos de reglas LLD heredados de un template.
interfaceids ID/array Devolver solo prototipos de reglas LLD que utilicen las interfaces de host dadas.
monitored boolean Si se establece en true, devolver solo prototipos de reglas LLD habilitados que pertenezcan a hosts monitorizados.
templated boolean Si se establece en true, devolver solo prototipos de reglas LLD que pertenezcan a templates.
templateids ID/array Devolver solo prototipos de reglas LLD que pertenezcan a los templates dados.
selectDiscoveryRule query Devolver una propiedad discoveryRule con la regla LLD principal del prototipo de regla LLD.
selectDiscoveryRulePrototype query Devolver una propiedad discoveryRulePrototype con el prototipo de regla LLD principal del prototipo de regla LLD.
selectDiscoveryRulePrototypes query Devolver una propiedad discoveryRulePrototypes con los prototipos de reglas LLD secundarias que pertenecen al prototipo de regla LLD.

Admite count.
selectFilter query Devolver una propiedad filter con los datos del filtro utilizado por el prototipo de regla LLD.
selectGraphs query Devolver una propiedad graphs con los prototipos de gráficos que pertenecen al prototipo de regla LLD.

Admite count.
selectHostPrototypes query Devolver una propiedad hostPrototypes con los prototipos de host que pertenecen al prototipo de regla LLD.

Admite count.
selectHosts query Devolver una propiedad hosts con un array de hosts a los que pertenece el prototipo de regla LLD.
selectItems query Devolver una propiedad items con los prototipos de item que pertenecen al prototipo de regla LLD.

Admite count.
selectTriggers query Devolver una propiedad triggers con los prototipos de trigger que pertenecen al prototipo de regla LLD.

Admite count.
selectLLDMacroPaths query Devolver una propiedad lld_macro_paths con una lista de macros LLD y rutas a los valores asignados a cada macro correspondiente.
selectPreprocessing query Devolver una propiedad preprocessing con las opciones de preprocesamiento del prototipo de regla LLD.
selectOverrides query Devolver una propiedad lld_rule_overrides con una lista de filtros de override, condiciones y operaciones que se realizan sobre los objetos prototipo.
filter object Devolver solo aquellos resultados que coincidan exactamente con el filtro dado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar.

No admite propiedades del tipo de datos text data type.

Admite propiedades adicionales:
host - nombre técnico del host al que pertenece el prototipo de regla LLD.
limitSelects integer Limita el número de registros devueltos por subconsultas.

Se aplica a las siguientes subconsultas: selectItems, selectGraphs, selectTriggers.
sortfield string/array Ordenar el resultado por las propiedades dadas.

Valores posibles: itemid, name, key_, delay, type, status.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(entero/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar prototipos de reglas de descubrimiento de un host

Recupera todos los prototipos de reglas de descubrimiento para un ID de host específico.

Solicitud:

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

Respuesta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "47253",
            "type": "23",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Descubrir 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
}

Ver también

Fuente

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