hostprototype.update

Beschrijving

object hostprototype.update(object/array hostPrototypes)

Deze methode maakt het mogelijk om bestaande host sjablonen bij te werken.

Deze methode is alleen beschikbaar voor gebruikerstypen Admin en Superadmin. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Host sjablooneigenschappen die moeten worden bijgewerkt.

De eigenschap hostid moet gedefinieerd zijn voor elk host sjabloon, alle andere eigenschappen zijn optioneel. Alleen de doorgegeven eigenschappen zullen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard host sjablooneigenschappen, accepteert de methode de volgende parameters.

Parameter Type Beschrijving
groupLinks array Groep links om de huidige groep links op het host sjabloon te vervangen.

Gedrag van de parameter:
- alleen-lezen voor geërfde objecten
groupPrototypes array Groep prototypes om de bestaande groep prototypes op het host sjabloon te vervangen.

Gedrag van de parameter:
- alleen-lezen voor geërfde objecten
macros object/array Gebruiker macros om de huidige gebruiker macros te vervangen.

Alle macros die niet in het verzoek worden vermeld, worden verwijderd.
tags object/array Host sjabloon tags om de huidige tags te vervangen.

Alle tags die niet in het verzoek worden vermeld, worden verwijderd.

Gedrag van de parameter:
- alleen-lezen voor geërfde objecten
interfaces object/array Host sjabloon aangepaste interfaces om de huidige interfaces te vervangen.

Het aangepaste interface-object moet al zijn parameters bevatten.
Alle interfaces die niet in het verzoek worden vermeld, worden verwijderd.

Gedrag van de parameter:
- ondersteund als custom_interfaces van Host sjabloon object is ingesteld op "gebruik host sjabloon aangepaste interfaces"
- alleen-lezen voor geërfde objecten
templates object/array Sjablonen om de momenteel gekoppelde sjablonen te vervangen.

De sjablonen moeten de eigenschap templateid gedefinieerd hebben.

Retourwaarden

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

Voorbeelden

Uitschakelen van een host sjabloon

Schakel een host sjabloon uit, dat wil zeggen, stel de status in op "1".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.update",
           "params": {
               "hostid": "10092",
               "status": 1
           },
           "id": 1
       }

Reactie:

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

Bijwerken van host sjabloon tags

Vervang host sjabloon tags door nieuwe.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.update",
           "params": {
               "hostid": "10092",
               "tags": [
                   {
                       "tag": "Datacenter",
                       "value": "{#DATACENTER.NAME}"
                   },
                   {
                       "tag": "Instance type",
                       "value": "{#INSTANCE_TYPE}"
                   }
               ]
           },
           "id": 1
       }

Reactie:

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

Bijwerken van aangepaste interfaces voor host sjabloon

Vervang geërfde interfaces door aangepaste interfaces voor host sjabloon.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.update",
           "params": {
               "hostid": "10092",
               "custom_interfaces": "1",
               "interfaces": [
                   {
                       "main": "1",
                       "type": "2",
                       "useip": "1",
                       "ip": "127.0.0.1",
                       "dns": "",
                       "port": "161",
                       "details": {
                           "version": "2",
                           "bulk": "1",
                           "community": "{$SNMP_COMMUNITY}"
                       }
                   }
               ]
           },
           "id": 1
       }

Reactie:

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

Zie ook

Bron

CHostPrototype::update() in ui/include/classes/api/services/CHostPrototype.php.