Sidebar

hostprototype.get

Beschrijving

integer/array hostprototype.get(objectparameters)

De methode maakt het mogelijk om host-prototypes op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
hostids string/array Retourneer alleen host-prototypes met de opgegeven ID's.
discoveryids string/array Retourneer alleen het host-prototype dat bij de gegeven LLD-regels hoort.
inherited boolean Indien ingesteld op true worden alleen items geretourneerd die zijn overgenomen van een sjabloon.
selectDiscoveryRule query Retourneer een eigenschap discoveryRule met de LLD-regel waartoe het hostprototype behoort.
selectInterfaces query Retourneer een eigenschap interfaces met aangepaste host-prototype-interfaces.
selectGroupLinks query Retourneer een eigenschap groupLinks met de groepskoppelingen van het host-prototype.
selectGroupPrototypes query Retourneer een eigenschap groupPrototypes met de groepsprototypes van het hostprototype.
selectMacros query Retourneer een eigenschap macro's met host-prototypemacro's.
selectParentHost query Retourneer een eigenschap parentHost met de host waartoe het host-prototype behoort.
selectTags query Retourneer een eigenschap tags met host-prototype-tags.
selectTemplates query Retourneer een eigenschap templates met de sjablonen die aan het hostprototype zijn gekoppeld.

Ondersteunt count.
sortfield string/array Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn: hostid, host, name en status.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven op de pagina Generic Zabbix API information pagina.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Host-prototypes ophalen uit een LLD-regel

Haal alle host-prototypes, hun groepslinks, groepsprototypes en tags van een LLD-regel.

Verzoek:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.get",
           "params": {
               "output": "extend",
               "selectInterfaces": "extend",
               "selectGroupLinks": "extend",
               "selectGroupPrototypes": "extend",
               "selectTags": "extend",
               "discoveryids": "23554"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Antwoord:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "hostid": "10092",
                   "host": "{#HV.UUID}",
                   "name": "{#HV.UUID}",
                   "status": "0",
                   "templateid": "0",
                   "discover": "0",
                   "custom_interfaces": "1",
                   "inventory_mode": "-1",
                   "groupLinks": [
                       {
                           "group_prototypeid": "4",
                           "hostid": "10092",
                           "groupid": "7",
                           "templateid": "0"
                       }
                   ],
                   "groupPrototypes": [
                       {
                           "group_prototypeid": "7",
                           "hostid": "10092",
                           "name": "{#CLUSTER.NAME}",
                           "templateid": "0"
                       }
                   ],
                   "tags": [
                       {
                           "tag": "Datacenter",
                           "value": "{#DATACENTER.NAME}"
                       },
                       {
                           "tag": "Instance type",
                           "value": "{#INSTANCE_TYPE}"
                       }
                   ],
                   "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
       }

Zie ook

Bron

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