Documentation
Table of Contents
template.get
Beschrijving
integer/array template.get(object parameters)
Deze methode maakt het mogelijk om sjablonen op te halen aan de hand van de opgegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode op te roepen kan worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Omschrijving |
|---|---|---|
| templateids | string/array | Retourneer alleen sjablonen met de opgegeven sjabloon-ID's. |
| groupids | string/array | Retourneer alleen sjablonen die tot de opgegeven sjabloongroepen behoren. |
| parentTemplateids | string/array | Retourneer alleen sjablonen waaraan het opgegeven sjabloon is gekoppeld. |
| hostids | string/array | Retourneer alleen sjablonen die gekoppeld zijn aan de opgegeven hosts/sjablonen. |
| graphids | string/array | Retourneer alleen sjablonen die de opgegeven grafieken bevatten. |
| itemids | string/array | Retourneer alleen sjablonen die de opgegeven items bevatten. |
| triggerids | string/array | Retourneer alleen sjablonen die de opgegeven triggers bevatten. |
| with_items | flag | Retourneer alleen sjablonen met items. |
| with_triggers | flag | Retourneer alleen sjablonen met triggers. |
| with_graphs | flag | Retourneer alleen sjablonen met grafieken. |
| with_httptests | flag | Retourneer alleen sjablonen met web scenario's. |
| evaltype | integer | Regels voor het zoeken op tags. Mogelijke waarden: 0 - (standaard) En/Of; 2 - Of. |
| tags | object/array | Retourneer alleen sjablonen met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelige of hoofdletteron-gevoelige zoekopdracht op tagwaarde, afhankelijk van de operatorwaarde. Indeling: [{"tag": "<tag>", "value": "<waarde>", "operator": "<operator>"}, ...].Een lege array retourneert alle sjablonen. Mogelijke operatorwaarden: 0 - (standaard) Bevat; 1 - Gelijk aan; 2 - Niet zoals; 3 - Niet gelijk aan; 4 - Bestaat; 5 - Bestaat niet. |
| selectTags | query | Retourneer sjabloon-tags in de tags eigenschap. |
| selectHosts | query | Retourneer de hosts die gekoppeld zijn aan het sjabloon in de hosts eigenschap.Ondersteunt count. |
| selectTemplateGroups | query | Retourneer de sjabloongroepen waartoe het sjabloon behoort in de templategroups eigenschap. |
| selectTemplates | query | Retourneer sjablonen waaraan het opgegeven sjabloon is gekoppeld in de templates eigenschap.Ondersteunt count. |
| selectParentTemplates | query | Retourneer sjablonen die gekoppeld zijn aan het opgegeven sjabloon in de parentTemplates eigenschap.Ondersteunt count. |
| selectHttpTests | query | Retourneer de web scenario's van het sjabloon in de httpTests eigenschap.Ondersteunt count. |
| selectItems | query | Retourneer items van het sjabloon in de items eigenschap.Ondersteunt count. |
| selectDiscoveries | query | Retourneer ontdekkingen van laag niveau van het sjabloon in de discoveries eigenschap.Ondersteunt count. |
| selectTriggers | query | Retourneer triggers van het sjabloon in de triggers eigenschap.Ondersteunt count. |
| selectGraphs | query | Retourneer grafieken van het sjabloon in de graphs eigenschap.Ondersteunt count. |
| selectMacros | query | Retourneer de macro's van het sjabloon in de macros eigenschap. |
| selectDashboards | query | Retourneer dashboards van het sjabloon in de dashboards eigenschap.Ondersteunt count. |
| selectValueMaps | query | Retourneer een valuemaps eigenschap met sjabloonwaardekaarten. |
| limitSelects | integer | Beperkt het aantal records dat wordt geretourneerd door subselects. Van toepassing op de volgende subselects: 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: 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 | |
| selectGroups (verouderd) |
query | Deze parameter is verouderd, gebruik alstublieft selectTemplateGroups in plaats daarvan.Retourneer de sjabloongroepen waartoe het sjabloon behoort in de groups eigenschap. |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de
countOutputparameter heeft gebruikt.
Voorbeelden
Sjablonen ophalen op naam
Haal alle gegevens op over twee sjablonen met de naam "Linux" en "Windows".
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux",
"Windows"
]
}
},
"id": 1
}Reactie:
{
"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
}Sjabloongroepen ophalen
Haal sjabloongroepen op waar het sjabloon "Linux via Zabbix-agent" lid van is.
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTemplateGroups": "extend",
"filter": {
"host": [
"Linux via Zabbix-agent"
]
}
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"templategroups": [
{
"groupid": "10",
"name": "Sjablonen/Besturingssystemen",
"uuid": "846977d1dfed4968bc5f8bdb363285bc"
}
]
}
],
"id": 1
}Retrieving hosts by template
Retrieve hosts that have the "10001" (Linux by Zabbix agent) template linked to them.
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "templateid",
"templateids": "10001",
"selectHosts": ["hostid", "name"]
},
"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 die de tag "Hostnaam" hebben gelijk aan "{HOST.NAME}".
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Hostnaam",
"value": "{HOST.NAME}",
"operator": 1
}
]
},
"id": 1
}Reactie:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10402",
"tags": [
{
"tag": "Hostnaam",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}Zie ook
Bron
CTemplate::get() in ui/include/classes/api/services/CTemplate.php.