Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

drule.get

Descripción

integer/array drule.get(object parameters)

El método permite recuperar reglas de descubrimiento de acuerdo con los parámetros suministrados.

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

Parámetros

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

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
dhostids ID/array Devolver solo las reglas de descubrimiento que crearon los equipos descubiertos indicados.
druleids ID/array Devolver solo las reglas de descubrimiento con los IDs indicados.
dserviceids ID/array Devolver solo las reglas de descubrimiento que crearon los servicios descubiertos indicados.
selectDChecks consulta Devolver una propiedad dchecks con las comprobaciones de descubrimiento utilizadas por la regla de descubrimiento.

Admite count.
selectDHosts consulta Devolver una propiedad dhosts con los equipos descubiertos creados por la regla de descubrimiento.

Admite count.
limitSelects entero Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
selectDChecks - los resultados se ordenarán por dcheckid;
selectDHosts - los resultados se ordenarán por dhostsid.
sortfield cadena/array Ordenar el resultado por las propiedades indicadas.

Valores posibles: druleid, name.
countOutput booleano Estos parámetros se describen en el comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/array
startSearch booleano

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar todas las reglas de descubrimiento

Recupere todas las reglas de descubrimiento configuradas y las comprobaciones de descubrimiento que usar.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "drule.get",
           "params": {
               "output": "extend",
               "selectDChecks": "extend"
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "druleid": "2",
                   "proxyid": "0",
                   "name": "Local network",
                   "iprange": "192.168.3.1-255",
                   "delay": "5s",
                   "status": "0",
                   "concurrency_max": "0",
                   "error": "",
                   "dchecks": [
                       {
                           "dcheckid": "7",
                           "druleid": "2",
                           "type": "3",
                           "key_": "",
                           "snmp_community": "",
                           "ports": "21",
                           "snmpv3_securityname": "",
                           "snmpv3_securitylevel": "0",
                           "snmpv3_authpassphrase": "",
                           "snmpv3_privpassphrase": "",
                           "uniq": "0",
                           "snmpv3_authprotocol": "0",
                           "snmpv3_privprotocol": "0",
                           "snmpv3_contextname": "",
                           "host_source": "1",
                           "name_source": "0",
                           "allow_redirect": "0"
                       },
                       {
                           "dcheckid": "8",
                           "druleid": "2",
                           "type": "4",
                           "key_": "",
                           "snmp_community": "",
                           "ports": "80",
                           "snmpv3_securityname": "",
                           "snmpv3_securitylevel": "0",
                           "snmpv3_authpassphrase": "",
                           "snmpv3_privpassphrase": "",
                           "uniq": "0",
                           "snmpv3_authprotocol": "0",
                           "snmpv3_privprotocol": "0",
                           "snmpv3_contextname": "",
                           "host_source": "1",
                           "name_source": "0",
                           "allow_redirect": "0"
                       }
                   ]
               },
               {
                   "druleid": "6",
                   "proxyid": "0",
                   "name": "Zabbix agent discovery",
                   "iprange": "192.168.1.1-255",
                   "delay": "1h",
                   "status": "0",
                   "concurrency_max": "10",
                   "error": "",
                   "dchecks": [
                       {
                           "dcheckid": "10",
                           "druleid": "6",
                           "type": "9",
                           "key_": "system.uname",
                           "snmp_community": "",
                           "ports": "10050",
                           "snmpv3_securityname": "",
                           "snmpv3_securitylevel": "0",
                           "snmpv3_authpassphrase": "",
                           "snmpv3_privpassphrase": "",
                           "uniq": "0",
                           "snmpv3_authprotocol": "0",
                           "snmpv3_privprotocol": "0",
                           "snmpv3_contextname": "",
                           "host_source": "2",
                           "name_source": "3",
                           "allow_redirect": "0"
                       }
                   ]
               }
           ],
           "id": 1
       }

Ver también

Fuente

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