hostgroup.update

説明

object hostgroup.update(object/array hostGroups)

このメソッドでは、既存の hosts group を更新することができます。

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

パラメータ

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

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

戻り値

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

例

host group の名前の変更

host group の名前を "Linux hosts" に変更します。

Request:

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

Response:

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

ソース

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