hostgroup.massadd

説明

object hostgroup.massadd(object parameters)

このメソッドは、複数の関連オブジェクトをすべての指定されたホストグループに同時に追加することを可能にします。

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

パラメータ

更新するホストグループのIDと、 すべてのホストグループに追加するオブジェクトを含む(object)パラメータです。

このメソッドは以下のパラメータを受け付けます。

Parameter Type Description
groups object/array 更新対象のホストグループ。

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

パラメータの動作:
- 必須
hosts object/array すべてのホストグループに追加するホスト。

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

戻り値

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

例

ホストをホストグループに追加する

2つのホストをIDが5と6のホストグループに追加します。

リクエスト:

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

レスポンス:

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

関連項目

ソース

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