host.massupdate

説明

object host.massupdate(object parameters)

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

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

パラメータ

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

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

パラメータ 型 説明
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.