host.massadd

説明

object host.massadd(object parameters)

このメソッドは、指定されたすべてのホストに複数の関連オブジェクトを同時に追加することができます。

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

パラメータ

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

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

パラメータ 型 説明
hosts object/array 更新するホスト。

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

パラメータの動作:
- 必須
groups object/array 指定したホストに追加するホストグループ。

ホストグループにはgroupidプロパティのみを定義する必要があります。
interfaces object/array 指定したホストに作成するホストインターフェース。
macros object/array 指定したホストに作成するユーザーマクロ。
templates object/array 指定したホストにリンクするテンプレート。

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

戻り値

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

例

マクロの追加

2つのホストに2つの新しいマクロを追加します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "host.massadd",
    "params": {
        "hosts": [
            {
                "hostid": "10160"
            },
            {
                "hostid": "10167"
            }
        ],
        "macros": [
            {
                "macro": "{$TEST1}",
                "value": "MACROTEST1"
            },
            {
                "macro": "{$TEST2}",
                "value": "MACROTEST2",
                "description": "Test description"
            }
        ]
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "10160",
            "10167"
        ]
    },
    "id": 1
}

参照

ソース

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