On this page
hostgroup.massupdate
Description
object hostgroup.massupdate(object parameters)
This method allows to replace hosts and templates with the specified ones in multiple host groups.
This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.
Parameters
(object) Parameters containing the IDs of the host groups to update
and the objects that should be updated.
| Parameter | Type | Description |
|---|---|---|
| groups | object/array | Host groups to be updated. The host groups must have only the groupid property defined.Parameter behavior: - required |
| hosts | object/array | Hosts to replace the current hosts on the given host groups. All other hosts, except the ones mentioned, will be excluded from host groups. Discovered hosts will not be affected. The hosts must have only the hostid property defined.Parameter behavior: - required |
Return values
(object) Returns an object containing the IDs of the updated host
groups under the groupids property.
Examples
Replacing hosts in a host group
Replace all hosts in a host group to ones mentioned host.
{
"jsonrpc": "2.0",
"method": "hostgroup.massupdate",
"params": {
"groups": [
{
"groupid": "6"
}
],
"hosts": [
{
"hostid": "30050"
}
]
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"6",
]
},
"id": 1
}See also
Source
CHostGroup::massUpdate() in ui/include/classes/api/services/CHostGroup.php.