object host.massupdate(object parameters)
This method allows to simultaneously replace or remove related objects and update properties on multiple hosts.
(object)
Parameters containing the IDs of the hosts to update and the properties that should be updated.
Additionally to the standard host properties, the method accepts the following parameters.
Parameter | Type | Description |
---|---|---|
hosts (required) |
object/array | Hosts to be updated. The hosts must have the hostid property defined. |
groups | object/array | Host groups to replace the current host groups the hosts belong to. The host groups must have the groupid property defined. |
interfaces | object/array | Host interfaces to replace the current host interfaces on the given hosts. |
inventory | object | Host inventory properties. Host inventory mode cannot be updated using the inventory parameter, use inventory_mode instead. |
inventory_mode | integer | Host inventory population mode. Refer to the host inventory object page for a list of supported inventory modes. |
macros | object/array | User macros to replace the current user macros on the given hosts. |
templates | object/array | Templates to replace the currently linked templates on the given hosts. The templates must have the templateid property defined. |
templates_clear | object/array | Templates to unlink and clear from the given hosts. The templates must have the templateid property defined. |
(object)
Returns an object containing the IDs of the updated hosts under the hostids
property.
Enable monitoring of two hosts, i.e., set their status to 0.
Request:
{
"jsonrpc": "2.0",
"method": "host.massupdate",
"params": {
"hosts": [
{
"hostid": "69665"
},
{
"hostid": "69666"
}
],
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
CHost::massUpdate() in frontends/php/include/classes/api/services/CHost.php.