Documentation
dhost.get
説明
integer/array dhost.get(object parameters)
このメソッドは、指定したパラメーターに応じた検出されたホストを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) 希望する出力を定義するパラメータ
このメソッドは、以下のパラメータをサポートしています。
| パラメータ | Type | 説明 |
|---|---|---|
| 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 a drules property with an array of the discovery rules that detected the host. |
| selectDServices | query | Return a dservices property with the discovered services running on the host. 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 |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
ディスカバリルールによって検出されたホストの取得
ディスカバリルール"4"によって検出されたすべてのホストと実行中の発見されたサービスを取得します。
{ "jsonrpc": "2.0", "method": "dhost.get", "params": { "output": "extend", "selectDServices": "extend", "druleids": "4" }, "id": 1 }レスポンス:
{ "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 }参照
ソース
CDHost::get() in ui/include/classes/api/services/CDHost.php.