This is a translation of the original English documentation page. Help us make it better.

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 Geef alleen host-prototypes terug met de opgegeven ID's.
discoveryids string/array Geef alleen host-prototypes terug die behoren tot de opgegeven LLD-regels (Low-Level Discovery).
inherited boolean Indien ingesteld op true, geef alleen items terug die geërfd zijn van een sjabloon.
selectDiscoveryRule query Geef een eigenschap discoveryRule terug met de LLD-regel waartoe de host-prototype behoort.
selectInterfaces query Geef een eigenschap interfaces terug met aangepaste host-prototype interfaces.
selectGroupLinks query Geef een eigenschap groupLinks terug met de groepskoppelingen van de host-prototype.
selectGroupPrototypes query Geef een eigenschap groupPrototypes terug met de groepsprototypes van de host-prototype.
selectMacros query Geef een eigenschap macros terug met host-prototype macro's.
selectParentHost query Geef een eigenschap parentHost terug met de host waartoe de host-prototype behoort.
selectTags query Geef een eigenschap tags terug met host-prototype tags.
selectTemplates query Geef een eigenschap templates terug met de sjablonen die gekoppeld zijn aan de host-prototype.

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

Mogelijke waarden: hostid, host, name, status.
countOutput boolean Deze parameters, die algemeen zijn voor alle get-methoden, worden in detail beschreven in het referentiecommentaar.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Host-prototypes ophalen vanuit een LLD-regel

Haal alle host-prototypes, hun groepskoppelingen, groepsprototypes en tags op vanuit een LLD-regel.

Aanvraag:

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

Reactie:

{
           "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.