hostgroup.massupdate

説明

object hostgroup.massupdate(object parameters)

このメソッドでは、複数のホストグループ内のホストおよびテンプレートを、指定したものに置き換えることができます。

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

パラメータ

(object) 更新するホストグループのIDと、 更新対象のオブジェクトを含むパラメータ。

パラメータ Type 説明
groups object/array 更新するホストグループ。

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

パラメータの動作:
- 必須
hosts object/array 指定したホストグループ上の現在のホストを置き換えるホスト。
記載されたものを除く他のすべてのホストは、ホストグループから除外されます。
ディスカバリされたホストは影響を受けません。

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

パラメータの動作:
- 必須

戻り値

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

例

ホストグループ内のホストの置き換え

ホストグループ内のすべてのホストを、指定したホストに置き換えます。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.massupdate",
    "params": {
        "groups": [
            {
                "groupid": "6"
            }
        ],
        "hosts": [
            {
                "hostid": "30050"
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "groupids": [
            "6",
        ]
    },
    "id": 1
}

関連項目

ソース

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