On this page
hostinterface.massremove
Description
object hostinterface.massremove(object parameters)
This method allows to remove host interfaces from the given 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 be updated and
the interfaces to be removed.
| Parameter | Type | Description |
|---|---|---|
| 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.Parameter behavior: - required |
| hostids | ID/array | IDs of the hosts to be updated. Parameter behavior: - required |
Return values
(object) Returns an object containing the IDs of the deleted host
interfaces under the interfaceids property.
Examples
Removing interfaces
Remove the "127.0.0.1" SNMP interface from two hosts.
{
"jsonrpc": "2.0",
"method": "hostinterface.massremove",
"params": {
"hostids": [
"30050",
"30052"
],
"interfaces": {
"dns": "",
"ip": "127.0.0.1",
"port": "161"
}
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": {
"interfaceids": [
"30069",
"30070"
]
},
"id": 1
}See also
Source
CHostInterface::massRemove() in ui/include/classes/api/services/CHostInterface.php.