Documentation
Table of Contents
hostinterface.get
説明
integer/array hostinterface.get(object parameters)
このメソッドを使用では、指定されたパラメーターに従ってホストインターフェイスを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で 取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 希望する出力を定義するパラメータ
このメソッドは、次のパラメータをサポートしています。
| パラメータ | タイプ | 説明 |
|---|---|---|
| hostids | string/array | 指定されたホストによって使用されるホストインターフェースのみを返します。 |
| interfaceids | string/array | 指定されたIDを持つホストインターフェースのみを返します。 |
| itemids | string/array | 指定されたアイテムで使用されるホストインターフェースのみを返します。 |
| triggerids | string/array | 指定されたトリガーのアイテムによって使用されるホストインターフェイスのみを返します。 |
| selectItems | query | インターフェイスを使用するアイテムを含むitemsプロパティを返します。countをサポートします。 |
| selectHosts | query | インターフェイスを使用するホストの配列を含むhostsプロパティを返します。 |
| limitSelects | integer | 副選択によって返されるレコードの数を制限します。 次の副選択に適用されます： selectItems |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます。 指定可能な値は interfaceid、dns、ipです。 |
| countOutput | boolean | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| nodeids | string/array | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
ホストインターフェースの取得
ホスト"30057"が使用するインターフェースに関するすべてのデータを取得します。
Request:
{ "jsonrpc": "2.0", "method": "hostinterface.get", "params": { "output": "extend", "hostids": "30057" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "jsonrpc": "2.0", "result": [ { "interfaceid": "50039", "hostid": "30057", "main": "1", "type": "1", "useip": "1", "ip": "::1", "dns": "", "port": "10050", "available": "0", "error": "", "errors_from": "0", "disable_until": "0", "details": [] }, { "interfaceid": "55082", "hostid": "30057", "main": "0", "type": "1", "useip": "1", "ip": "127.0.0.1", "dns": "", "port": "10051", "available": "0", "error": "", "errors_from": "0", "disable_until": "0", "details": { "version": "2", "bulk": "0", "community": "{$SNMP_COMMUNITY}" } } ], "id": 1 }参照
ソース
CHostInterface::get() in ui/include/classes/api/services/CHostInterface.php.