host.massupdate

説明

object host.massupdate(object parameters)

このメソッドでは、関連オブジェクトを一括で置換または削除し、複数のホストのプロパティを更新できます。

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

パラメータ

更新するホストのIDと、更新するプロパティを含む(object)パラメータです。

このメソッドは、標準のホストプロパティに加えて、 以下のパラメータを受け付けます。

パラメータ 型 説明
hosts object/array 更新対象のホスト。

ホストでは、hostidプロパティのみを定義する必要があります。

パラメータの動作:
- 必須
groups object/array ホストが現在所属しているホストグループを置き換えるためのホストグループ。

ホストグループでは、groupidプロパティのみを定義する必要があります。
interfaces object/array 指定したホスト上の現在のホストインターフェースを置き換えるためのホストインターフェース。
inventory object ホストインベントリのプロパティ。

ホストインベントリモードはinventoryパラメータでは更新できません。代わりにinventory_modeを使用してください。
macros object/array 指定したホスト上の現在のユーザーマクロを置き換えるためのユーザーマクロ。
templates object/array 指定したホストに現在リンクされているテンプレートを置き換えるためのテンプレート。

テンプレートでは、templateidプロパティのみを定義する必要があります。
templates_clear object/array 指定したホストからリンク解除してクリアするテンプレート。

テンプレートでは、templateidプロパティのみを定義する必要があります。

戻り値

(object) hostids プロパティの下で更新されたホストの ID を含むオブジェクトを返します。

例

複数のホストの有効化

2つのホストの監視を有効にします。つまり、それらのステータスを「0」に設定します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "host.massupdate",
    "params": {
        "hosts": [
            {
                "hostid": "69665"
            },
            {
                "hostid": "69666"
            }
        ],
        "status": 0
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "69665",
            "69666"
        ]
    },
    "id": 1
}

関連項目

ソース

CHost::massUpdate() in ui/include/classes/api/services/CHost.php.