hostinterface.get

説明

integer/array hostinterface.get(object parameters)

このメソッドは、指定されたパラメータに従ってホストインターフェースを取得することができます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメーター

(object) 望ましい出力を定義するパラメーター。

このメソッドは以下のパラメーターをサポートします。

パラメーター 型 説明
hostids ID/array 指定したホストで使用されているホストインターフェースのみを返します。
interfaceids ID/array 指定したIDのホストインターフェースのみを返します。
itemids ID/array 指定したアイテムで使用されているホストインターフェースのみを返します。
triggerids ID/array 指定したトリガーのアイテムで使用されているホストインターフェースのみを返します。
selectItems query インターフェースを使用するアイテムを含むitemsプロパティを返します。

countをサポートします。
selectHosts query インターフェースを使用するホストの配列を含むhostsプロパティを返します。
limitSelects integer サブセレクトで返されるレコード数を制限します。

以下のサブセレクトに適用されます:
selectItems。
sortfield string/array 指定したプロパティで結果をソートします。

可能な値: interfaceid, dns, ip。
countOutput boolean これらのパラメーターはリファレンス解説で説明されています。
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パラメーターが使用されている場合、取得したオブジェクトの数

例

ホストインターフェースの取得

ホスト "30057" で使用されているインターフェースに関するすべてのデータを取得します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostinterface.get",
    "params": {
        "output": "extend",
        "hostids": "30057"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "interfaceid": "50039",
            "hostid": "30057",
            "main": "1",
            "type": "1",
            "useip": "0",
            "ip": "",
            "dns": "localhost",
            "port": "10050",
            "available": "0",
            "error": "",
            "errors_from": "0",
            "disable_until": "0",
            "details": []
        },
        {
            "interfaceid": "55082",
            "hostid": "30057",
            "main": "1",
            "type": "2",
            "useip": "1",
            "ip": "127.0.0.1",
            "dns": "",
            "port": "161",
            "available": "0",
            "error": "",
            "errors_from": "0",
            "disable_until": "0",
            "details": {
                "version": "2",
                "bulk": "0",
                "community": "{$SNMP_COMMUNITY}",
                "max_repetitions": "10"
            }
        }
    ],
    "id": 1
}

参照

ソース

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