3 Templates

Overview

Templates are exported with many related objects and object relations.

Template export contains:

  • Linked template groups
  • Linked host groups (if used in host prototype configuration)
  • Template data
  • Linkage to other templates
  • Linkage to template groups
  • Directly linked items
  • Directly linked triggers
  • Directly linked graphs
  • Directly linked dashboards
  • Directly linked discovery rules with all prototypes
  • Directly linked web scenarios
  • Value maps

Exporting

To export templates, do the following:

  1. Go to Data collectionTemplates.
  2. Mark the checkboxes of the templates to export.
  3. Click on Export below the list.

3 Templates - 图1

Depending on the selected format, templates are exported to a local file with a default name:

  • zabbix_export_templates.yaml - in YAML export (default option for export);
  • zabbix_export_templates.xml - in XML export;
  • zabbix_export_templates.json - in JSON export.

Importing

To import templates, do the following:

  1. Go to: Data collectionTemplates.
  2. Click on Import to the right.
  3. Select the import file.
  4. Click on Import.

3 Templates - 图2

If you mark the Advanced options checkbox, a detailed list of all importable elements will be displayed - mark or unmark each import rule as required.

If you click the checkbox in the All row, all elements below it become marked/unmarked.

Import rules:

RuleDescription
Update existingExisting elements will be updated with data taken from the import file. Otherwise, they will not be updated.
Create newThe import will add new elements using data from the import file. Otherwise, it will not add them.
Delete missingThe import will remove existing elements not present in the import file. Otherwise, it will not remove them.
If Delete missing is marked for Template linkage, current template linkage not present in the import file will be unlinked. Entities (items, triggers, graphs, etc.) inherited from the unlinked templates will not be removed (unless the Delete missing option is selected for each entity as well).

On the next screen, you will be able to view the content of a template being imported. If this is a new template all elements will be listed in green. If updating an existing template, new template elements are highlighted in green; removed template elements are highlighted in red; elements that have not changed are listed on a gray background.

3 Templates - 图3

The menu on the left can be used to navigate through the list of changes. Section Updated highlights all changes made to existing template elements. Section Added lists new template elements. The elements in each section are grouped by element type; press on the gray arrow down to expand or collapse the group of elements.

3 Templates - 图4

Review template changes, then press Import to perform template import. A success or failure message of the import will be displayed in the frontend.

Export format

Export format in YAML:

  1. zabbix_export:
  2. version: '6.4'
  3. template_groups:
  4. -
  5. uuid: a571c0d144b14fd4a87a9d9b2aa9fcd6
  6. name: Templates/Applications
  7. templates:
  8. -
  9. uuid: 56079badd056419383cc26e6a4fcc7e0
  10. template: VMware
  11. name: VMware
  12. description: |
  13. You can discuss this template or leave feedback on our forum https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/
  14. Template tooling version used: 0.38
  15. vendor:
  16. name: Zabbix
  17. version: 6.4-0
  18. templates:
  19. -
  20. name: 'VMware macros'
  21. groups:
  22. -
  23. name: Templates/Applications
  24. items:
  25. -
  26. uuid: 5ce209f4d94f460488a74a92a52d92b1
  27. name: 'VMware: Event log'
  28. type: SIMPLE
  29. key: 'vmware.eventlog[{$VMWARE.URL},skip]'
  30. history: 7d
  31. trends: '0'
  32. value_type: LOG
  33. username: '{$VMWARE.USERNAME}'
  34. password: '{$VMWARE.PASSWORD}'
  35. description: 'Collect VMware event log. See also: https://www.zabbix.com/documentation/6.2/manual/config/items/preprocessing/examples#filtering_vmware_event_log_records'
  36. tags:
  37. -
  38. tag: Application
  39. value: VMware
  40. -
  41. uuid: ee2edadb8ce943ef81d25dbbba8667a4
  42. name: 'VMware: Full name'
  43. type: SIMPLE
  44. key: 'vmware.fullname[{$VMWARE.URL}]'
  45. delay: 1h
  46. history: 7d
  47. trends: '0'
  48. value_type: CHAR
  49. username: '{$VMWARE.USERNAME}'
  50. password: '{$VMWARE.PASSWORD}'
  51. description: 'VMware service full name.'
  52. preprocessing:
  53. -
  54. type: DISCARD_UNCHANGED_HEARTBEAT
  55. parameters:
  56. - 1d
  57. tags:
  58. -
  59. tag: Application
  60. value: VMware
  61. -
  62. uuid: a0ec9145f2234fbea79a28c57ebdb44d
  63. name: 'VMware: Version'
  64. type: SIMPLE
  65. key: 'vmware.version[{$VMWARE.URL}]'
  66. delay: 1h
  67. history: 7d
  68. trends: '0'
  69. value_type: CHAR
  70. username: '{$VMWARE.USERNAME}'
  71. password: '{$VMWARE.PASSWORD}'
  72. description: 'VMware service version.'
  73. preprocessing:
  74. -
  75. type: DISCARD_UNCHANGED_HEARTBEAT
  76. parameters:
  77. - 1d
  78. tags:
  79. -
  80. tag: Application
  81. value: VMware
  82. discovery_rules:
  83. -
  84. uuid: 16ffc933cce74cf28a6edf306aa99782
  85. name: 'Discover VMware clusters'
  86. type: SIMPLE
  87. key: 'vmware.cluster.discovery[{$VMWARE.URL}]'
  88. delay: 1h
  89. username: '{$VMWARE.USERNAME}'
  90. password: '{$VMWARE.PASSWORD}'
  91. description: 'Discovery of clusters'
  92. item_prototypes:
  93. -
  94. uuid: 46111f91dd564a459dbc1d396e2e6c76
  95. name: 'VMware: Status of "{#CLUSTER.NAME}" cluster'
  96. type: SIMPLE
  97. key: 'vmware.cluster.status[{$VMWARE.URL},{#CLUSTER.NAME}]'
  98. history: 7d
  99. username: '{$VMWARE.USERNAME}'
  100. password: '{$VMWARE.PASSWORD}'
  101. description: 'VMware cluster status.'
  102. valuemap:
  103. name: 'VMware status'
  104. tags:
  105. -
  106. tag: Application
  107. value: VMware
  108. -
  109. uuid: 8fb6a45cbe074b0cb6df53758e2c6623
  110. name: 'Discover VMware datastores'
  111. type: SIMPLE
  112. key: 'vmware.datastore.discovery[{$VMWARE.URL}]'
  113. delay: 1h
  114. username: '{$VMWARE.USERNAME}'
  115. password: '{$VMWARE.PASSWORD}'
  116. item_prototypes:
  117. -
  118. uuid: 4b61838ba4c34e709b25081ae5b059b5
  119. name: 'VMware: Average read latency of the datastore {#DATASTORE}'
  120. type: SIMPLE
  121. key: 'vmware.datastore.read[{$VMWARE.URL},{#DATASTORE},latency]'
  122. history: 7d
  123. username: '{$VMWARE.USERNAME}'
  124. password: '{$VMWARE.PASSWORD}'
  125. description: 'Amount of time for a read operation from the datastore (milliseconds).'
  126. tags:
  127. -
  128. tag: Application
  129. value: VMware
  130. -
  131. uuid: 5355c401dc244bc588ccd18767577c93
  132. name: 'VMware: Free space on datastore {#DATASTORE} (percentage)'
  133. type: SIMPLE
  134. key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE},pfree]'
  135. delay: 5m
  136. history: 7d
  137. value_type: FLOAT
  138. units: '%'
  139. username: '{$VMWARE.USERNAME}'
  140. password: '{$VMWARE.PASSWORD}'
  141. description: 'VMware datastore space in percentage from total.'
  142. tags:
  143. -
  144. tag: Application
  145. value: VMware
  146. -
  147. uuid: 84f13c4fde2d4a17baaf0c8c1eb4f2c0
  148. name: 'VMware: Total size of datastore {#DATASTORE}'
  149. type: SIMPLE
  150. key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE}]'
  151. delay: 5m
  152. history: 7d
  153. units: B
  154. username: '{$VMWARE.USERNAME}'
  155. password: '{$VMWARE.PASSWORD}'
  156. description: 'VMware datastore space in bytes.'
  157. tags:
  158. -
  159. tag: Application
  160. value: VMware
  161. -
  162. uuid: 540cd0fbc56c4b8ea19f2ff5839ce00d
  163. name: 'VMware: Average write latency of the datastore {#DATASTORE}'
  164. type: SIMPLE
  165. key: 'vmware.datastore.write[{$VMWARE.URL},{#DATASTORE},latency]'
  166. history: 7d
  167. username: '{$VMWARE.USERNAME}'
  168. password: '{$VMWARE.PASSWORD}'
  169. description: 'Amount of time for a write operation to the datastore (milliseconds).'
  170. tags:
  171. -
  172. tag: Application
  173. value: VMware
  174. -
  175. uuid: a5bc075e89f248e7b411d8f960897a08
  176. name: 'Discover VMware hypervisors'
  177. type: SIMPLE
  178. key: 'vmware.hv.discovery[{$VMWARE.URL}]'
  179. delay: 1h
  180. username: '{$VMWARE.USERNAME}'
  181. password: '{$VMWARE.PASSWORD}'
  182. description: 'Discovery of hypervisors.'
  183. host_prototypes:
  184. -
  185. uuid: 051a1469d4d045cbbf818fcc843a352e
  186. host: '{#HV.UUID}'
  187. name: '{#HV.NAME}'
  188. group_links:
  189. -
  190. group:
  191. name: Templates/Applications
  192. group_prototypes:
  193. -
  194. name: '{#CLUSTER.NAME}'
  195. -
  196. name: '{#DATACENTER.NAME}'
  197. templates:
  198. -
  199. name: 'VMware Hypervisor'
  200. macros:
  201. -
  202. macro: '{$VMWARE.HV.UUID}'
  203. value: '{#HV.UUID}'
  204. description: 'UUID of hypervisor.'
  205. custom_interfaces: 'YES'
  206. interfaces:
  207. -
  208. ip: '{#HV.IP}'
  209. -
  210. uuid: 9fd559f4e88c4677a1b874634dd686f5
  211. name: 'Discover VMware VMs'
  212. type: SIMPLE
  213. key: 'vmware.vm.discovery[{$VMWARE.URL}]'
  214. delay: 1h
  215. username: '{$VMWARE.USERNAME}'
  216. password: '{$VMWARE.PASSWORD}'
  217. description: 'Discovery of guest virtual machines.'
  218. host_prototypes:
  219. -
  220. uuid: 23b9ae9d6f33414880db1cb107115810
  221. host: '{#VM.UUID}'
  222. name: '{#VM.NAME}'
  223. group_links:
  224. -
  225. group:
  226. name: Templates/Applications
  227. group_prototypes:
  228. -
  229. name: '{#CLUSTER.NAME} (vm)'
  230. -
  231. name: '{#DATACENTER.NAME}/{#VM.FOLDER} (vm)'
  232. -
  233. name: '{#HV.NAME}'
  234. templates:
  235. -
  236. name: 'VMware Guest'
  237. macros:
  238. -
  239. macro: '{$VMWARE.VM.UUID}'
  240. value: '{#VM.UUID}'
  241. description: 'UUID of guest virtual machine.'
  242. custom_interfaces: 'YES'
  243. interfaces:
  244. -
  245. ip: '{#VM.IP}'
  246. valuemaps:
  247. -
  248. uuid: 3c59c22905054d42ac4ee8b72fe5f270
  249. name: 'VMware status'
  250. mappings:
  251. -
  252. value: '0'
  253. newvalue: gray
  254. -
  255. value: '1'
  256. newvalue: green
  257. -
  258. value: '2'
  259. newvalue: yellow
  260. -
  261. value: '3'
  262. newvalue: red

Element tags

Element tag values are explained in the table below.

Template tags
ElementElement propertyRequiredTypeRangeDescription
template_groupsxRoot element for template groups.
uuidxstringUnique identifier for this template group.
namexstringTemplate group name.
host_groupsxRoot element for host groups that are used by host prototypes.
uuidxstringUnique identifier for this host group.
namexstringHost group name.
templates-Root element for templates.
uuidxstringUnique identifier for this template.
templatexstringUnique template name.
name-stringVisible template name.
description-textTemplate description.
vendor-Root element for template vendor.

Element added only if the exported template contains vendor data.
name-stringTemplate vendor name.
version-stringTemplate version.

For out-of-the-box templates, version is displayed as follows: major version of Zabbix, delimiter (“-“), revision number (increased with each new version of the template, and reset with each major version of Zabbix). For example, 6.4-0, 6.4-3, 7.0-0, 7.0-3.
templates-Root element for linked templates.
namexstringTemplate name.
groups-Root element for template groups.
namexstringTemplate group name.
tags-Root element for template tags.
tagxstringTag name.
value-stringTag value.
macros-Root element for template user macros.
macroxstringUser macro name.
type-string0 - TEXT (default)
1 - SECRET_TEXT
2 - VAULT
Type of the macro.
value-stringUser macro value.
description-stringUser macro description.
valuemaps-Root element for template value maps.
uuidxstringUnique identifier for this value map.
namexstringValue map name.
mapping-Root element for mappings.
valuexstringValue of a mapping.
newvaluexstringNew value of a mapping.
Template item tags
ElementElement propertyRequiredTypeRange1Description
items-Root element for items.
uuidxstringUnique identifier for the item.
namexstringItem name.
type-string0 - ZABBIX_PASSIVE (default)
2 - TRAP
3 - SIMPLE
5 - INTERNAL
7 - ZABBIX_ACTIVE
10 - EXTERNAL
11 - ODBC
12 - IPMI
13 - SSH
14 - TELNET
15 - CALCULATED
16 - JMX
17 - SNMP_TRAP
18 - DEPENDENT
19 - HTTP_AGENT
20 - SNMP_AGENT
21 - ITEM_TYPE_SCRIPT
Item type.
snmp_oid-stringSNMP object ID.

Required by SNMP items.
keyxstringItem key.
delay-stringDefault: 1mUpdate interval of the item.

Accepts seconds or a time unit with suffix (30s, 1m, 2h, 1d).
Optionally one or more custom intervals can be specified either as flexible intervals or scheduling.
Multiple intervals are separated by a semicolon.
User macros may be used. A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.
Flexible intervals may be written as two macros separated by a forward slash (e.g. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).
history-stringDefault: 90dA time unit of how long the history data should be stored. Time unit with suffix, user macro or LLD macro.
trends-stringDefault: 365dA time unit of how long the trends data should be stored. Time unit with suffix, user macro or LLD macro.
status-string0 - ENABLED (default)
1 - DISABLED
Item status.
value_type-string0 - FLOAT
1 - CHAR
2 - LOG
3 - UNSIGNED (default)
4 - TEXT
Received value type.
allowed_hosts-stringList of IP addresses (comma delimited) of hosts allowed sending data for the item.

Used by trapper and HTTP agent items.
units-stringUnits of returned values (bps, B, etc).
params-textAdditional parameters depending on the type of the item:
- executed script for Script, SSH and Telnet items;
- SQL query for database monitor items;
- formula for calculated items.
ipmi_sensor-stringIPMI sensor.

Used only by IPMI items.
authtype-stringAuthentication type for SSH agent items:
0 - PASSWORD (default)
1 - PUBLIC_KEY

Authentication type for HTTP agent items:
0 - NONE (default)
1 - BASIC
2 - NTLM
Authentication type.

Used only by SSH and HTTP agent items.
username-stringUsername for authentication.
Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items.

Required by SSH and Telnet items.
When used by JMX agent, password should also be specified together with the username or both properties should be left blank.
password-stringPassword for authentication.
Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent items.

When used by JMX agent, username should also be specified together with the password or both properties should be left blank.
publickey-stringName of the public key file.

Required for SSH agent items.
privatekey-stringName of the private key file.

Required for SSH agent items.
port-stringCustom port monitored by the item.
Can contain user macros.

Used only by SNMP items.
description-textItem description.
inventory_link-string0 - NONE

Capitalized host inventory field name. For example:
4 - ALIAS
6 - OS_FULL
14 - HARDWARE
etc.
Host inventory field that is populated by the item.

Refer to the host inventory page for a list of supported host inventory fields and their IDs.
logtimefmt-stringFormat of the time in log entries.
Used only by log items.
jmx_endpoint-stringJMX endpoint.

Used only by JMX agent items.
url-stringURL string.

Required only for HTTP agent items.
allow_traps-string0 - NO (default)
1 - YES
Allow to populate value as in a trapper item.

Used only by HTTP agent items.
follow_redirects-string0 - NO
1 - YES (default)
Follow HTTP response redirects while pooling data.

Used only by HTTP agent items.
headers-Root element for HTTP(S) request headers, where header name is used as key and header value as value.
Used only by HTTP agent items.
namexstringHeader name.
valuexstringHeader value.
http_proxy-stringHTTP(S) proxy connection string.

Used only by HTTP agent items.
output_format-string0 - RAW (default)
1 - JSON
How to process response.

Used only by HTTP agent items.
post_type-string0 - RAW (default)
2 - JSON
3 - XML
Type of post data body.

Used only by HTTP agent items.
posts-stringHTTP(S) request body data.

Used only by HTTP agent items.
query_fields-Root element for query parameters.

Used only by HTTP agent items.
namexstringParameter name.
value-stringParameter value.
request_method-string0 - GET (default)
1 - POST
2 - PUT
3 - HEAD
Request method.

Used only by HTTP agent items.
retrieve_mode-string0 - BODY (default)
1 - HEADERS
2 - BOTH
What part of response should be stored.

Used only by HTTP agent items.
ssl_cert_file-stringPublic SSL Key file path.

Used only by HTTP agent items.
ssl_key_file-stringPrivate SSL Key file path.

Used only by HTTP agent items.
ssl_key_password-stringPassword for SSL Key file.

Used only by HTTP agent items.
status_codes-stringRanges of required HTTP status codes separated by commas. Supports user macros.
Example: 200,200-{$M},{$M},200-400

Used only by HTTP agent items.
timeout-stringItem data polling request timeout. Supports user macros.

Used by HTTP agent and Script items.
verify_host-string0 - NO (default)
1 - YES
Validate if host name in URL is in Common Name field or a Subject Alternate Name field of host certificate.

Used only by HTTP agent items.
verify_peer-string0 - NO (default)
1 - YES
Validate if host certificate is authentic.

Used only by HTTP agent items.
parameters-Root element for user-defined parameters.

Used only by Script items.
namexstringParameter name.

Used only by Script items.
value-stringParameter value.

Used only by Script items.
value map-Value map.
namexstringName of the value map to use for the item.
preprocessing-Root element for item value preprocessing.
step-Individual item value preprocessing step.
typexstring1 - MULTIPLIER
2 - RTRIM
3 - LTRIM
4 - TRIM
5 - REGEX
6 - BOOL_TO_DECIMAL
7 - OCTAL_TO_DECIMAL
8 - HEX_TO_DECIMAL
9 - SIMPLE_CHANGE (calculated as (received value-previous value))
10 - CHANGE_PER_SECOND (calculated as (received value-previous value)/(time now-time of last check))
11 - XMLPATH
12 - JSONPATH
13 - IN_RANGE
14 - MATCHES_REGEX
15 - NOT_MATCHES_REGEX
16 - CHECK_JSON_ERROR
17 - CHECK_XML_ERROR
18 - CHECK_REGEX_ERROR
19 - DISCARD_UNCHANGED
20 - DISCARD_UNCHANGED_HEARTBEAT
21 - JAVASCRIPT
22 - PROMETHEUS_PATTERN
23 - PROMETHEUS_TO_JSON
24 - CSV_TO_JSON
25 - STR_REPLACE
26 - CHECK_NOT_SUPPORTED
Type of the item value preprocessing step.
parameters-Root element for parameters of the item value preprocessing step.
parameterxstringIndividual parameter of the item value preprocessing step.
error_handler-string0 - ORIGINAL_ERROR (default)
1 - DISCARD_VALUE
2 - CUSTOM_VALUE
3 - CUSTOM_ERROR
Action type used in case of preprocessing step failure.
error_handler_params-stringError handler parameters used with ‘error_handler’.
master_item-Individual item master item.

Required by dependent items.
keyxstringDependent item master item key value.

Recursion up to 3 dependent items and maximum count of dependent items equal to 29999 are allowed.
triggers-Root element for simple triggers.
For trigger element tag values, see template trigger tags.
tags-Root element for item tags.
tagxstringTag name.
value-stringTag value.
Template low-level discovery rule tags
ElementElement propertyRequiredTypeRangeDescription
discovery_rules-Root element for low-level discovery rules.
For most of the element tag values, see element tag values for a regular item. Only the tags that are specific to low-level discovery rules, are described below.
type-string0 - ZABBIX_PASSIVE (default)
2 - TRAP
3 - SIMPLE
5 - INTERNAL
7 - ZABBIX_ACTIVE
10 - EXTERNAL
11 - ODBC
12 - IPMI
13 - SSH
14 - TELNET
16 - JMX
18 - DEPENDENT
19 - HTTP_AGENT
20 - SNMP_AGENT
Item type.
lifetime-stringDefault: 30dTime period after which items that are no longer discovered will be deleted. Seconds, time unit with suffix or user macro.
filterIndividual filter.
evaltype-string0 - AND_OR (default)
1 - AND
2 - OR
3 - FORMULA
Logic to use for checking low-level discovery rule filter conditions.
formula-stringCustom calculation formula for filter conditions.
conditions-Root element for filter conditions.
macroxstringLow-level discovery macro name.
value-stringFilter value: regular expression or global regular expression.
operator-string8 - MATCHES_REGEX (default)
9 - NOT_MATCHES_REGEX
Condition operator.
formulaidxcharacterArbitrary unique ID that is used to reference a condition from the custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward.
lld_macro_paths-Root element for LLD macro paths.
lld_macroxstringLow-level discovery macro name.
pathxstringSelector for value which will be assigned to the corresponding macro.
preprocessing-LLD rule value preprocessing.
step-Individual LLD rule value preprocessing step.
For most of the element tag values, see element tag values for a template item value preprocessing. Only the tags that are specific to template low-level discovery value preprocessing, are described below.
typexstring5 - REGEX
11 - XMLPATH
12 - JSONPATH
15 - NOT_MATCHES_REGEX
16 - CHECK_JSON_ERROR
17 - CHECK_XML_ERROR
20 - DISCARD_UNCHANGED_HEARTBEAT
21 - JAVASCRIPT
23 - PROMETHEUS_TO_JSON
24 - CSV_TO_JSON
25 - STR_REPLACE
Type of the item value preprocessing step.
trigger_prototypes-Root element for trigger prototypes.
For trigger prototype element tag values, see regular template trigger tags.
graph_prototypes-Root element for graph prototypes.
For graph prototype element tag values, see regular template graph tags.
host_prototypes-Root element for host prototypes.
For host prototype element tag values, see regular host tags.
item_prototypes-Root element for item prototypes.
For item prototype element tag values, see regular template item tags.
master_item-Individual item prototype master item/item prototype data.
keyxstringDependent item prototype master item/item prototype key value.

Required for a dependent item.
Template trigger tags
ElementElement propertyRequiredTypeRange1Description
triggers-Root element for triggers.
uuidxstringUnique identifier for this trigger.
expressionxstringTrigger expression.
recovery_mode-string0 - EXPRESSION (default)
1 - RECOVERY_EXPRESSION
2 - NONE
Basis for generating OK events.
recovery_expression-stringTrigger recovery expression.
namexstringTrigger name.
correlation_mode-string0 - DISABLED (default)
1 - TAG_VALUE
Correlation mode (no event correlation or event correlation by tag).
correlation_tag-stringThe tag name to be used for event correlation.
url-stringURL associated with the trigger.
status-string0 - ENABLED (default)
1 - DISABLED
Trigger status.
priority-string0 - NOT_CLASSIFIED (default)
1 - INFO
2 - WARNING
3 - AVERAGE
4 - HIGH
5 - DISASTER
Trigger severity.
description-textTrigger description.
type-string0 - SINGLE (default)
1 - MULTIPLE
Event generation type (single problem event or multiple problem events).
manual_close-string0 - NO (default)
1 - YES
Manual closing of problem events.
dependencies-Root element for dependencies.
namexstringDependency trigger name.
expressionxstringDependency trigger expression.
recovery_expression-stringDependency trigger recovery expression.
tags-Root element for trigger tags.
tagxstringTag name.
value-stringTag value.
Template graph tags
ElementElement propertyRequiredTypeRange1Description
graphs-Root element for graphs.
uuidxstringUnique identifier for this graph.
namexstringGraph name.
width-integer20-65535 (default: 900)Graph width, in pixels. Used for preview and for pie/exploded graphs.
height-integer20-65535 (default: 200)Graph height, in pixels. Used for preview and for pie/exploded graphs.
yaxismin-doubleDefault: 0Value of Y axis minimum.

Used if ‘ymin_type_1’ is FIXED.
yaxismax-doubleDefault: 0Value of Y axis maximum.

Used if ‘ymax_type_1’ is FIXED.
show_work_period-string0 - NO
1 - YES (default)
Highlight non-working hours.

Used by normal and stacked graphs.
show_triggers-string0 - NO
1 - YES (default)
Display simple trigger values as a line.

Used by normal and stacked graphs.
type-string0 - NORMAL (default)
1 - STACKED
2 - PIE
3 - EXPLODED
Graph type.
show_legend-string0 - NO
1 - YES (default)
Display graph legend.
show_3d-string0 - NO (default)
1 - YES
Enable 3D style.

Used by pie and exploded pie graphs.
percent_left-doubleDefault:0Show the percentile line for left axis.

Used only for normal graphs.
percent_right-doubleDefault:0Show the percentile line for right axis.

Used only for normal graphs.
ymin_type_1-string0 - CALCULATED (default)
1 - FIXED
2 - ITEM
Minimum value of Y axis.

Used by normal and stacked graphs.
ymax_type_1-string0 - CALCULATED (default)
1 - FIXED
2 - ITEM
Maximum value of Y axis.

Used by normal and stacked graphs.
ymin_item_1-Individual item details.

Required if ‘ymin_type_1’ is ITEM.
hostxstringItem host.
keyxstringItem key.
ymax_item_1-Individual item details.

Required if ‘ymax_type_1’ is ITEM.
hostxstringItem host.
keyxstringItem key.
graph_itemsxRoot element for graph items.
sortorder-integerDraw order. The smaller value is drawn first. Can be used to draw lines or regions behind (or in front of) another.
drawtype-string0 - SINGLE_LINE (default)
1 - FILLED_REGION
2 - BOLD_LINE
3 - DOTTED_LINE
4 - DASHED_LINE
5 - GRADIENT_LINE
Draw style of the graph item.

Used only by normal graphs.
color-stringElement color (6 symbols, hex).
yaxisside-string0 - LEFT (default)
1 - RIGHT
Side of the graph where the graph item’s Y scale will be drawn.

Used by normal and stacked graphs.
calc_fnc-string1 - MIN
2 - AVG (default)
4 - MAX
7 - ALL (minimum, average and maximum; used only by simple graphs)
9 - LAST (used only by pie and exploded pie graphs)
Data to draw if more than one value exists for an item.
type-string0 - SIMPLE (default)
2 - GRAPH_SUM (value of the item represents the whole pie; used only by pie and exploded pie graphs)
Graph item type.
itemxIndividual item.
hostxstringItem host.
keyxstringItem key.
Template web scenario tags
ElementElement propertyRequiredTypeRange1Description
httptests-Root element for web scenarios.
uuidxstringUnique identifier for this web scenario.
namexstringWeb scenario name.
delay-stringDefault: 1mFrequency of executing the web scenario. Seconds, time unit with suffix or user macro.
attempts-integer1-10 (default: 1)The number of attempts for executing web scenario steps.
agent-stringDefault: ZabbixClient agent. Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.
http_proxy-stringSpecify an HTTP proxy to use, using the format: http://[username[:password]@]proxy.example.com[:port]
variables-Root element for scenario-level variables (macros) that may be used in scenario steps.
namextextVariable name.
valuextextVariable value.
headers-Root element for HTTP headers that will be sent when performing a request. Headers should be listed using the same syntax as they would appear in the HTTP protocol.
namextextHeader name.
valuextextHeader value.
status-string0 - ENABLED (default)
1 - DISABLED
Web scenario status.
authentication-string0 - NONE (default)
1 - BASIC
2 - NTLM
Authentication method.
http_user-stringUser name used for basic, HTTP or NTLM authentication.
http_password-stringPassword used for basic, HTTP or NTLM authentication.
verify_peer-string0 - NO (default)
1 - YES
Verify the SSL certificate of the web server.
verify_host-string0 - NO (default)
1 - YES
Verify that the Common Name field or the Subject Alternate Name field of the web server certificate matches.
ssl_cert_file-stringName of the SSL certificate file used for client authentication (must be in PEM format).
ssl_key_file-stringName of the SSL private key file used for client authentication (must be in PEM format).
ssl_key_password-stringSSL private key file password.
stepsxRoot element for web scenario steps.
namexstringWeb scenario step name.
urlxstringURL for monitoring.
query_fields-Root element for query fields - an array of HTTP fields that will be added to the URL when performing a request.
namexstringQuery field name.
value-stringQuery field value.
posts-HTTP POST variables as a string (raw post data) or as an array of HTTP fields (form field data).
namexstringPost field name.
valuexstringPost field value.
variables-Root element of step-level variables (macros) that should be applied after this step.

If the variable value has a ‘regex:’ prefix, then its value is extracted from the data returned by this step according to the regular expression pattern following the ‘regex:’ prefix
namexstringVariable name.
valuexstringVariable value.
headers-Root element for HTTP headers that will be sent when performing a request. Headers should be listed using the same syntax as they would appear in the HTTP protocol.
namexstringHeader name.
valuexstringHeader value.
follow_redirects-string0 - NO
1 - YES (default)
Follow HTTP redirects.
retrieve_mode-string0 - BODY (default)
1 - HEADERS
2 - BOTH
HTTP response retrieve mode.
timeout-stringDefault: 15sTimeout of step execution. Seconds, time unit with suffix or user macro.
required-stringText that must be present in the response. Ignored if empty.
status_codes-stringA comma delimited list of accepted HTTP status codes. Ignored if empty. For example: 200-201,210-299
tags-Root element for web scenario tags.
tagxstringTag name.
value-stringTag value.
Template dashboard tags
ElementElement propertyRequiredTypeRange1Description
dashboards-Root element for template dashboards.
uuidxstringUnique identifier for this dashboard.
namexstringTemplate dashboard name.
display period-integerDisplay period of dashboard pages.
auto_start-string0 - no
1 - yes
Slideshow auto start.
pages-Root element for template dashboard pages.
name-stringPage name.
display period-integerPage display period.
sortorder-integerPage sorting order.
widgets-Root element for template dashboard widgets.
typexstringWidget type.
name-stringWidget name.
x-integer0-23Horizontal position from the left side of the template dashboard.
y-integer0-62Vertical position from the top of the template dashboard.
width-integer1-24Widget width.
height-integer2-32Widget height.
hide_header-string0 - no
1 - yes
Hide widget header.
fields-Root element for the template dashboard widget fields.
typexstring0 - INTEGER
1 - STRING
3 - HOST
4 - ITEM
5 - ITEM_PROTOTYPE
6 - GRAPH
7 - GRAPH_PROTOTYPE
Widget field type.
namexstringWidget field name.
valuexmixedWidget field value, depending on the field type.
Footnotes

1 For string values, only the string will be exported (e.g. “ZABBIX_ACTIVE”) without the numbering used in this table. The numbers for range values (corresponding to the API values) in this table is used for ordering only.