Documentation
Table of Contents
dhost.get
Description
integer/array dhost.get(object parameters)
The method allows to retrieve discovered hosts according to the given parameters.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| dhostids | string/array | Return only discovered hosts with the given IDs. |
| druleids | string/array | Return only discovered hosts that have been created by the given discovery rules. |
| dserviceids | string/array | Return only discovered hosts that are running the given services. |
| selectDRules | query | Return the discovery rule that detected the host as an array in the drules property. |
| selectDServices | query | Return the discovered services running on the host in the dservices property.Supports count. |
| limitSelects | integer | Limits the number of records returned by subselects. Applies to the following subselects: selectDServices - results will be sorted by dserviceid. |
| sortfield | string/array | Sort the result by the given properties. Possible values are: dhostid and druleid. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter has been used.
Examples
Retrieve discovered hosts by discovery rule
Retrieve all hosts and the discovered services they are running that have been detected by discovery rule "4".
Request:
{ "jsonrpc": "2.0", "method": "dhost.get", "params": { "output": "extend", "selectDServices": "extend", "druleids": "4" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "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 }See also
Source
CDHost::get() in frontends/php/include/classes/api/services/CDHost.php.