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 hostprototypen terug met de opgegeven IDs.
discoveryids	string/array	Geef alleen hostprototypen terug die behoren tot de opgegeven LLD-regels.
inherited	boolean	Indien ingesteld op `true`, geef alleen items terug die zijn geërfd van een sjabloon.
selectDiscoveryRule	query	Geef een discoveryRule eigenschap terug met de LLD-regel waartoe het hostprototype behoort.
selectInterfaces	query	Geef een interfaces eigenschap terug met aangepaste interfaces van het hostprototype.
selectGroupLinks	query	Geef een groupLinks eigenschap terug met de groepskoppelingen van het hostprototype.
selectGroupPrototypes	query	Geef een groupPrototypes eigenschap terug met de groepsprototypen van het hostprototype.
selectMacros	query	Geef een macros eigenschap terug met hostprototype-macro's.
selectParentHost	query	Geef een parentHost eigenschap terug met het host waartoe het hostprototype behoort.
selectTags	query	Geef een tags eigenschap terug met hostprototype-tags.
selectTemplates	query	Geef een templates eigenschap terug met de sjablonen die zijn gekoppeld aan het hostprototype. Ondersteunt `count`.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden zijn: `hostid`, `host`, `name` en `status`.
countOutput	boolean	Deze parameters die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven in de referentie-toelichting.
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 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.

Documentation