hostgroup.update

説明

object hostgroup.update(object/array hostGroups)

このメソッドは、既存のホストグループを更新することができます。

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

パラメータ

(object/array) Host group properties が更新されます。

groupid` プロパティは各ホストグループに対して定義する必要があり、他のプロパティはすべてオプションです。
与えられたプロパティのみが更新され、その他のプロパティは変更されません。

戻り値

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

例

ホストグループの名前の変更

ホストグループの名前を"Linux hosts"に変更します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.update",
    "params": {
        "groupid": "7",
        "name": "Linux hosts"
    },
    "id": 1
}

レスポンス:

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

複数のホストグループの名前変更

2つのホストグループの名前にリージョン情報を含めるように名前を変更します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.update",
    "params": [
        {
            "groupid": "8",
            "name": "Europe/Linux hosts"
        },
        {
            "groupid": "9",
            "name": "Europe/Windows hosts"
        }
    ],
    "id": 1
}

レスポンス:

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

ソース

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