Documentation
Table of Contents
template.get
Descrição
integer/array template.get(object parameters)
O método permite recuperar modelos de acordo com os parâmetros fornecidos.
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte funções do usuário para obter mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| templateids | string/array | Retorna apenas modelos com os IDs de modelo fornecidos. |
| groupids | string/array | Retorna apenas modelos que pertencem aos grupos de hosts fornecidos. |
| parentTemplateids | string/array | Retorne apenas modelos que são pais dos modelos fornecidos. |
| hostids | string/array | Retorne apenas modelos vinculados aos hosts/modelos fornecidos. |
| graphids | string/array | Retorne apenas modelos que contenham os gráficos fornecidos. |
| itemids | string/array | Retorne apenas modelos que contenham os itens fornecidos. |
| triggerids | string/array | Retorne apenas modelos que contenham os triggers fornecidas. |
| with_items | flag | Retorne apenas templates que tenham itens. |
| with_triggers | flag | Retorne apenas templates que tenham triggers. |
| with_graphs | flag | Retorne apenas templates que tenham gráficos. |
| with_httptests | flag | Retorne apenas templates que tenham cenários da web. |
| evaltype | integer | Regras para pesquisa de tags. Valores possíveis: 0 - (padrão) e/ou; 2 - ou. |
| tags | array/object | Retorna apenas modelos com tags fornecidas. Correspondência exata por tag e pesquisa com ou sem distinção entre maiúsculas e minúsculas por valor de tag, dependendo do valor do operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Uma matriz vazia retorna todos os templates. Possíveis valores do operador: 0 - (padrão) Contém; 1 - Igual; 2 - Não contém; 3 - Diferente; 4 - Existe; 5 - Não existe. |
| selectGroups | query | Retorne os grupos de hosts aos quais o modelo pertence na propriedade grupos property. |
| selectTags | query | Retorne tags de modelo na propriedade tags property. |
| selectHosts | query | Retorne os hosts que estão vinculados ao modelo na propriedade hosts property. Suporta count. |
| selectTemplates | query | Retorne templates para os quais o modelo é filho, na propriedade templates.Suporta count. |
| selectParentTemplates | query | Retorne templates para os quais o modelo é pai, na propriedade parentTemplates.Suporta count. |
| selectHttpTests | query | Retorne os cenários da web do modelo na propriedade httpTests . Suporta count. |
| selectItems | query | Retorne itens do modelo na propriedade items. Suporta count. |
| selectDiscoveries | query | Retorne descobertas de baixo nível do modelo na propriedade discoveries.Suporta count. |
| selectTriggers | query | Retorne os triggers de templates na propriedade de triggers. Suporta count. |
| selectGraphs | query | Retorne as triggers de templates na propriedade graphs. Suporta count. |
| selectMacros | query | Retorne as macros do modelo na propriedade macros. |
| selectDashboards | query | Retorne os painéis do modelo na propriedade de dashboards. Suporta count. |
| selectValueMaps | query | Retorne uma propriedade valuemaps com mapas de valores de modelo. |
| limitSelects | integer | Limita o número de registros retornados por subseleções. Aplica-se às seguintes subseleções: selectTemplates - os resultados serão classificados por name;selectHosts - classificado por host;selectParentTemplates - classificado porhost;selectItems - classificado por name;selectDiscoveries - classificado por name;selectTriggers - classificado por description;selectGraphs - classificado por name;selectDashboards - classificado por name. |
| sortfield | string/array | Classifique o resultado pelas propriedades fornecidas. Os valores possíveis são: hostid, host, name, status. |
| countOutput | boolean | Esses parâmetros sendo comuns para todos os métodos get que são descritos em detalhes no comentário de referência. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna ou:
- uma matriz de objetos;
- contagem de objetos recuperados, se o
countOutputparâmetro tiver sido usado.
Exemplos
Recuperando templates por nome
Recupere todos os dados sobre dois templates chamados "Linux" e "Windows".
Requisição:
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux",
"Windows"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"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 template groups
Retrieve template groups that the template "Linux by Zabbix agent" is a member of.
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTemplateGroups": "extend",
"filter": {
"host": [
"Linux by Zabbix agent"
]
}
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"templategroups": [
{
"groupid": "10",
"name": "Templates/Operating systems",
"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
}Pesquisando por tags de templates
Recupere modelos que tenham a tag "Host name" igual a "{HOST.NAME}".
Requisição:
{
"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
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10402",
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}Veja também
Fonte
CTemplate::get() in ui/include/classes/api/services/CTemplate.php.