Table of Contents
template.get
Beschrijving
integer/array template.get(object parameters)
De methode maakt het mogelijk om sjablonen 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 | Omschrijving |
|---|---|---|
| templateids | string/array | Geef alleen sjablonen terug met de opgegeven sjabloond IDs. |
| groupids | string/array | Geef alleen sjablonen terug die behoren tot de opgegeven hostgroepen. |
| parentTemplateids | string/array | Geef alleen sjablonen terug die ouder zijn van de opgegeven sjablonen. |
| hostids | string/array | Geef alleen sjablonen terug die zijn gekoppeld aan de opgegeven hosts/sjablonen. |
| graphids | string/array | Geef alleen sjablonen terug die de opgegeven grafieken bevatten. |
| itemids | string/array | Geef alleen sjablonen terug die de opgegeven items bevatten. |
| triggerids | string/array | Geef alleen sjablonen terug die de opgegeven triggers bevatten. |
| with_items | flag | Geef alleen sjablonen terug die items hebben. |
| with_triggers | flag | Geef alleen sjablonen terug die triggers hebben. |
| with_graphs | flag | Geef alleen sjablonen terug die grafieken hebben. |
| with_httptests | flag | Geef alleen sjablonen terug die webscenario's hebben. |
| evaltype | integer | Regels voor tag-zoeken. Mogelijke waarden: 0 - (standaard) En/Of; 2 - Of. |
| tags | object/array | Geef alleen sjablonen terug met de opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletterongevoelige zoekopdracht op tagwaarde, afhankelijk van de waarde van operator. Formaat: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Een lege array geeft alle sjablonen terug. Mogelijke operatorwaarden: 0 - (standaard) Bevat; 1 - Is gelijk aan; 2 - Niet zoals; 3 - Niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet. |
| selectGroups | query | Geef de hostgroepen terug waarbij het sjabloon hoort in de groups eigenschap. |
| selectTags | query | Geef sjabloontags terug in de tags eigenschap. |
| selectHosts | query | Geef de hosts terug die zijn gekoppeld aan het sjabloon in de hosts eigenschap. Ondersteunt count. |
| selectTemplates | query | Geef sjablonen terug waaraan het sjabloon is gekoppeld als kind, in de templates eigenschap.Ondersteunt count. |
| selectParentTemplates | query | Geef sjablonen terug waaraan het sjabloon is gekoppeld als ouder, in de parentTemplates eigenschap.Ondersteunt count. |
| selectHttpTests | query | Geef de webscenario's terug vanuit het sjabloon in de httpTests eigenschap. Ondersteunt count. |
| selectItems | query | Geef items terug vanuit het sjabloon in de items eigenschap. Ondersteunt count. |
| selectDiscoveries | query | Geef low-level ontdekkingen terug vanuit het sjabloon in de discoveries eigenschap.Ondersteunt count. |
| selectTriggers | query | Geef triggers terug vanuit het sjabloon in de triggers eigenschap. Ondersteunt count. |
| selectGraphs | query | Geef grafieken terug vanuit het sjabloon in de graphs eigenschap. Ondersteunt count. |
| selectMacros | query | Geef de macros terug vanuit het sjabloon in de macros eigenschap.. |
| selectDashboards | query | Geef dashboards terug vanuit het sjabloon in de dashboards eigenschap. Ondersteunt count. |
| selectValueMaps | query | Geef een valuemaps eigenschap terug met sjabloonwaardekaarten. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselecties. Van toepassing op de volgende subselecties: selectTemplates - resultaten worden gesorteerd op name;selectHosts - gesorteerd op host;selectParentTemplates - gesorteerd op host;selectItems - gesorteerd op name;selectDiscoveries - gesorteerd op name;selectTriggers - gesorteerd op description;selectGraphs - gesorteerd op name;selectDashboards - gesorteerd op name. |
| sortfield | string/array | Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden zijn: hostid, host, name, status. |
| countOutput | boolean | Deze parameters die gemeenschappelijk 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
countOutputparameter heeft gebruikt.
Voorbeelden
Sjablonen op naam ophalen
Haal alle gegevens op over twee sjablonen genaamd "Linux" en "Windows".
Verzoek:
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux",
"Windows"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"proxy_hostid": "0",
"host": "Linux",
"status": "3",
"disable_until": "0",
"error": "",
"available": "0",
"errors_from": "0",
"lastaccess": "0",
"ipmi_authtype": "0",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"ipmi_disable_until": "0",
"ipmi_available": "0",
"snmp_disable_until": "0",
"snmp_available": "0",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"ipmi_errors_from": "0",
"snmp_errors_from": "0",
"ipmi_error": "",
"snmp_error": "",
"jmx_disable_until": "0",
"jmx_available": "0",
"jmx_errors_from": "0",
"jmx_error": "",
"name": "Linux",
"flags": "0",
"templateid": "10001",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"tls_psk_identity": "",
"tls_psk": "",
"uuid": "282ffe33afc74cccaf1524d9aa9dc502"
},
{
"proxy_hostid": "0",
"host": "Windows",
"status": "3",
"disable_until": "0",
"error": "",
"available": "0",
"errors_from": "0",
"lastaccess": "0",
"ipmi_authtype": "0",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"ipmi_disable_until": "0",
"ipmi_available": "0",
"snmp_disable_until": "0",
"snmp_available": "0",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"ipmi_errors_from": "0",
"snmp_errors_from": "0",
"ipmi_error": "",
"snmp_error": "",
"jmx_disable_until": "0",
"jmx_available": "0",
"jmx_errors_from": "0",
"jmx_error": "",
"name": "Windows",
"flags": "0",
"templateid": "10081",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"tls_psk_identity": "",
"tls_psk": "",
"uuid": "522d17e1834049be879287b7c0518e5d"
}
],
"id": 1
}Retrieving hosts by template
Retrieve hosts that have the "10001" (Linux by Zabbix agent) template linked to them.
Request:
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "templateid",
"templateids": "10001",
"selectHosts": ["hostid", "name"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Zoeken op sjabloontags
Haal sjablonen op met de tag "Hostnaam" gelijk aan "{HOST.NAME}".
Verzoek:
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}",
"operator": 1
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10402",
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}Zie ook
Bron
CTemplate::get() in ui/include/classes/api/services/CTemplate.php.