dhost.get

Descripción

integer/array dhost.get(object parameters)

El método permite recuperar equipos descubiertos 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/matriz Devuelve solo los equipos descubiertos con los ID proporcionados.
druleids ID/matriz Devuelve sólo los equipos descubiertos que han sido creados según las reglas de descubrimiento dadas.
dserviceids ID/matriz Devuelve solo los equipos descubiertos que ejecutan los servicios dados.
selectDRules query Devuelve una propiedad drules con una matriz de reglas de descubrimiento que detectaron el equipo.
selectDServices query Devuelve una propiedad dservices con los servicios descubiertos ejecutándose en el equipo.

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

Se aplica a las siguientes subselecciones:
selectDServices: los resultados se ordenarán por dserviceid.
sortfield cadena/matriz Ordena el resultado según las propiedades dadas.

Valores posibles: dhostid, druleid.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorderstartSearch cadena/matriz
startSearch booleano

Valores de devueltos

(integer/array) Returns either:

  • una matriz de objetos;
  • la suma de los objetos devueltos, si el parámetros countOutput está siendo usado.

Ejemplos

Recuperar equipos descubiertos mediante regla de descubrimiento

Recuperar todos los equipos y los servicios descubiertos que han sido detectados por la regla de descubrimiento "4".

Solicitud:

{
       "jsonrpc": "2.0",
       "method": "dhost.get",
       "params": {
       "output": "extend",
       "selectDServices": "extend",
       "druleids": "4"
       },
       "id": 1
       }

Respuesta:

{
       "jsonrpc": "2.0",
       "result": [
       {
       "dservices": [
       {
       "dserviceid": "1",
       "dhostid": "1",
       "type": "4",
       "key_": "",
       "value": "",
       "port": "80",
       "status": "0",
       "lastup": "1337697227",
       "lastdown": "0",
       "dcheckid": "5",
       "ip": "192.168.1.1",
       "dns": "station.company.lan"
       }
       ],
       "dhostid": "1",
       "druleid": "4",
       "status": "0",
       "lastup": "1337697227",
       "lastdown": "0"
       },
       {
       "dservices": [
       {
       "dserviceid": "2",
       "dhostid": "2",
       "type": "4",
       "key_": "",
       "value": "",
       "port": "80",
       "status": "0",
       "lastup": "1337697234",
       "lastdown": "0",
       "dcheckid": "5",
       "ip": "192.168.1.4",
       "dns": "john.company.lan"
       }
       ],
       "dhostid": "2",
       "druleid": "4",
       "status": "0",
       "lastup": "1337697234",
       "lastdown": "0"
       },
       {
       "dservices": [
       {
       "dserviceid": "3",
       "dhostid": "3",
       "type": "4",
       "key_": "",
       "value": "",
       "port": "80",
       "status": "0",
       "lastup": "1337697234",
       "lastdown": "0",
       "dcheckid": "5",
       "ip": "192.168.1.26",
       "dns": "printer.company.lan"
       }
       ],
       "dhostid": "3",
       "druleid": "4",
       "status": "0",
       "lastup": "1337697234",
       "lastdown": "0"
       },
       {
       "dservices": [
       {
       "dserviceid": "4",
       "dhostid": "4",
       "type": "4",
       "key_": "",
       "value": "",
       "port": "80",
       "status": "0",
       "lastup": "1337697234",
       "lastdown": "0",
       "dcheckid": "5",
       "ip": "192.168.1.7",
       "dns": "mail.company.lan"
       }
       ],
       "dhostid": "4",
       "druleid": "4",
       "status": "0",
       "lastup": "1337697234",
       "lastdown": "0"
       }
       ],
       "id": 1
       }

Ver también

Fuente

CHost::delete() en ui/include/classes/api/services/CHost.php.