host.massremove

Beschrijving

object host.massremove(objectparameters)

Met deze methode kunnen gerelateerde objecten van meerdere hosts worden verwijderd.

Deze methode is alleen beschikbaar voor Admin en Super admin gebruikers typen. Machtigingen om de methode aan te roepen kunnen worden ingetrokken in de gebruikersrol instellingen. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de ID's van de te bijwerken hosts en de objecten die moeten worden verwijderd bevatten.

Parameter Type Beschrijving
hostids string/array ID's van de hosts die bijgewerkt moeten worden.

Gedrag van parameter:
- verplicht
groupids string/array Hostgroepen om de opgegeven hosts uit te verwijderen.
interfaces object/array Host-interfaces om te verwijderen van de opgegeven hosts.

Het host-interface object moet de eigenschappen ip, dns en port gedefinieerd hebben.
macros string/array Gebruikersmacro's om te verwijderen van de opgegeven hosts.
templateids string/array Sjablonen om te ontkoppelen van de opgegeven hosts.
templateids_clear string/array Sjablonen om te ontkoppelen en te verwijderen van de opgegeven hosts.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte hosts bevat onder de eigenschap 'hostids'.

Voorbeelden

Ontkoppelen van sjablonen

Ontkoppel een sjabloon van twee hosts en verwijder alle gesjabloneerde entiteiten.

Aanvraag:

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

Reactie:

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

Zie ook

Bron

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