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

Sidebar

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 Beschrijving
templateids string/array Retourneer alleen sjablonen met de opgegeven sjabloon-ID's.
groupids string/array Retourneer alleen sjablonen die bij de opgegeven hostgroepen horen.
parentTemplateids string/array Retourneer alleen sjablonen die onderliggend zijn aan de gegeven sjablonen.
hostids string/array Retourneer alleen sjablonen die zijn gekoppeld aan de opgegeven hosts/sjablonen.
graphids string/array Retourneer alleen sjablonen die de gegeven 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 webscenario's.
evaltype integer Regels voor het zoeken naar tags.

Mogelijke waarden:
0 - (standaard) And/Or;
2 - Or.
tags array/object Retourneer alleen sjablonen met opgegeven tags. Exacte overeenkomst op tag en hoofdlettergevoelig of hoofdletterongevoelig zoeken op tagwaarde, afhankelijk van de operatorwaarde.
Formaat: [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].
Een lege array retourneert alle sjablonen.

Mogelijke operatorwaarden:
0 - (standaard) Bevat;
1 - Is gelijk aan;
2 - Niet zoals;
3 - Niet gelijk
4 - Bestaat;
5 - Bestaat niet.
selectGroups query Retourneer de hostgroepen waartoe de sjabloon behoort in de eigenschap groups.
selectTags query Retourneer sjabloontags in de eigenschap tags.
selectHosts query Retourneer de hosts die zijn gekoppeld aan de sjabloon in de eigenschap hosts.

Ondersteunt count.
selectTemplates query Retourneer de onderliggende sjablonen in de eigenschap templates.

Ondersteunt count.
selectParentTemplates query Retourneer de bovenliggende sjablonen in de eigenschap parentTemplates.

Ondersteunt count.
selectHttpTests query Retourneer de webscenario's van de sjabloon in de eigenschap httpTests.

Ondersteunt count.
selectItems query Retourneert items uit de sjabloon in de eigenschap items .

Ondersteunt count.
selectDiscoveries query Retourneer ontdekkingen op laag niveau van de sjabloon in de eigenschap discoveries.

Ondersteunt count.
selectTriggers query Retourneert triggers van de sjabloon in de eigenschap triggers.

Ondersteunt count.
selectGraphs query Retourneer grafieken uit de sjabloon in de eigenschap graphs .

Ondersteunt count.
selectMacros query Retourneer de macro's van de sjabloon in de eigenschap macro's'..| |selectDashboards|query|Dashboards retourneren van de sjabloon in de eigenschap [dashboards](/manual/api/reference/templateashboard/object).

Ondersteunt
count.| |selectValueMaps|query|Retourneer een eigenschap [valuemaps](/manual/api/reference/valuemap/object) met sjabloonwaardekaarten.| |limitSelects|integer|Beperkt het aantal records dat wordt geretourneerd door subselecties.

Van toepassing op de volgende subselecties:
selectTemplates- resultaten worden gesorteerd opname;
selectHosts- gesorteerd ophost;
selectParentTemplates- gesorteerd ophost;
selectItems- gesorteerd opnaam;
selectDiscoveries- gesorteerd opnaam;
selectTriggers- gesorteerd opbeschrijving;
selectGraphs- gesorteerd opnaam;
selectDashboards- gesorteerd opnaam.| |sortfield|string/array|Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn:
hostid,host,name,status.| |countOutput|boolean|Deze parameters gelden voor alleget`-methoden en worden in detail beschreven in de referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
preservekeys boolean
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter 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
       }

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.