host.massremove

Description

object host.massremove(object parameters)

This method allows to remove related objects from multiple hosts.

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 hosts to update and the objects that should be removed.

Parameter	Type	Description
hostids	ID/array	IDs of the hosts to be updated. Parameter behavior: - required
groupids	ID/array	IDs of the host groups to remove the given hosts from.
interfaces	object/array	Host interfaces to remove from the given hosts. The host interface object must have only the `ip`, `dns` and `port` properties defined.
macros	string/array	User macros to delete from the given hosts.
templateids	ID/array	IDs of the templates to unlink from the given hosts.
templateids_clear	ID/array	IDs of the templates to unlink and clear from the given hosts.

Return values

(object) Returns an object containing the IDs of the updated hosts under the hostids property.

Examples

Unlinking templates

Unlink a template from two hosts and delete all of the templated entities.

Request:

{
           "jsonrpc": "2.0",
           "method": "host.massremove",
           "params": {
               "hostids": ["69665", "69666"],
               "templateids_clear": "325"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "hostids": [
                   "69665",
                   "69666"
               ]
           },
           "id": 1
       }

Source

CHost::massRemove() in ui/include/classes/api/services/CHost.php.

Documentation