host.massremove

説明

object host.massremove(object parameters)

このメソッドは、複数のホストから関連するオブジェクトを削除することができます。

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

パラメータ

(object) 更新するホストのIDと削除するオブジェクトを含むパラメータ。

パラメータ 型 説明
hostids ID/array 更新するホストのID。

パラメータの動作:
- 必須
groupids ID/array 指定したホストを削除するホストグループのID。
interfaces object/array 指定したホストから削除するホストインターフェース。

ホストインターフェースオブジェクトには、ip、dns、portプロパティのみを定義する必要があります。
macros string/array 指定したホストから削除するユーザーマクロ。
templateids ID/array 指定したホストからリンクを解除するテンプレートのID。
templateids_clear ID/array 指定したホストからリンクを解除し、クリアするテンプレートのID。

戻り値

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

例

テンプレートのリンク解除

2つのホストからテンプレートのリンクを解除し、テンプレート化されたすべてのエンティティを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "host.massremove",
    "params": {
        "hostids": ["69665", "69666"],
        "templateids_clear": "325"
    },
    "id": 1
}

レスポンス:

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

参照

ソース

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