hostgroup.update

説明

object hostgroup.update(object/array hostGroups)

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

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

パラメータ

(object/array) 更新するホストグループのプロパティ。

各ホストグループでは 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
}

ソース

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