dhost.get

Descripció

integer/array dhost.get(object parameters)

El mètode permet recuperar equips descoberts segons els paràmetres proveïts.

Paràmetres

(objecte) Paràmetres que defineixen la sortida desitjada.

El mètode admet els paràmetres següents.

|Paràmetre|Tipus|Descripció| |---------|---------------------------------------- ------------|-----------| |dhostids|string/array|Retorna només els equips descoberts amb els ID donats.| |druleids|string/array|Retorna només els equips descoberts creats per les regles de descobriment donades.| |dserviceids|string/array|Retorna només els equips descoberts que executen els serveis donats.| |selectDRules|query|Retorna una propietat drules que conté una matriu de regles de descobriment que van detectar l'equip.| |selectDServices|query|Retorna una propietat dservices que conté els serveis descoberts que s'executen a l'equip.

Admet count.| |limitSelects|enteger|Limita el nombre de registres retornats per les subconsultes.

S'aplica a les subseleccions següents:
selectDServices: els resultats s'ordenaran per dserviceid.| |sortfield|string/array|Ordena el resultat per les propietats donades.

Els valors possibles són: dhostid i druleid.| |countOutput|boolean|Aquests paràmetres són descrits als comentaris de referència.| |editable|boolean|^| |excludeSearch|boolean|^| |filter|object|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^|

Valors de retorn

(integer/array) Retorna un d'entre:

• una taula d'objectes;
• el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar equips descoberts per la regla de descoberta

Recuperar tots els equips i els serveis actius descoberts que s'han detectat amb la regla de descobriment nombre "4".

Petició:

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

Resposta:

{  "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 }

Veieu també

• Servei descobert
• Regla de descoberta

Font

CDHost::get() in ui/include/classes/api/services/CDHost.php.