integer/array hostprototype.get(object parameters)
The method allows to retrieve host prototypes according to the given parameters.
(object)
Parameters defining the desired output.
The method supports the following parameters.
Parameter | Type | Description |
---|---|---|
hostids | string/array | Return only host prototypes with the given IDs. |
discoveryids | string/array | Return only host prototype that belong to the given LLD rules. |
inherited | boolean | If set to true return only items inherited from a template. |
selectDiscoveryRule | query | Return a discoveryRule property with the LLD rule that the host prototype belongs to. |
selectGroupLinks | query | Return a groupLinks property with the group links of the host prototype. |
selectGroupPrototypes | query | Return a groupPrototypes property with the group prototypes of the host prototype. |
selectMacros | query | Return a macros property with host prototype macros. |
selectParentHost | query | Return a parentHost property with the host that the host prototype belongs to. |
selectTemplates | query | Return a templates property with the templates linked to the host prototype.Supports count . |
sortfield | string/array | Sort the result by the given properties. Possible values are: hostid , host , name and status . |
countOutput | boolean | These parameters being common for all get methods are described in detail on the Generic Zabbix API information page. |
editable | boolean | |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(integer/array)
Returns either:
countOutput
parameter has been used.Retrieve all host prototypes and their group links and group prototypes from an LLD rule.
Request:
{ "jsonrpc": "2.0", "method": "hostprototype.get", "params": { "output": "extend", "selectGroupLinks": "extend", "selectGroupPrototypes": "extend", "discoveryids": "23554" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": [ { "hostid": "10092", "host": "{#HV.UUID}", "status": "0", "name": "{#HV.NAME}", "templateid": "0", "discover": "0", "groupLinks": [ { "group_prototypeid": "4", "hostid": "10092", "groupid": "7", "templateid": "0" } ], "groupPrototypes": [ { "group_prototypeid": "7", "hostid": "10092", "name": "{#CLUSTER.NAME}", "templateid": "0" } ] } ], "id": 1 }
CHostPrototype::get() in ui/include/classes/api/services/CHostPrototype.php.