Table of Contents

3 Templates

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:

Go to: Configuration → Templates
Mark the checkboxes of the templates to export
Click on Export below the list

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:

Go to: Configuration → Templates
Click on Import to the right
Select the import file
Mark the required options in import rules
Click on Import

All mandatory input fields are marked with a red asterisk.

Import rules:

Rule	Description
Update existing	Existing elements will be updated with data taken from the import file. Otherwise, they will not be updated.
Create new	The import will add new elements using data from the import file. Otherwise, it will not add them.
Delete missing	The 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, existing template linkage not present in the import file will be unlinked. Since Zabbix 6.2.7, 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.

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.

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:

zabbix_export:
         version: '6.2'
         date: '2021-08-31T12:40:55Z'
         template_groups:
           -
             uuid: a571c0d144b14fd4a87a9d9b2aa9fcd6
             name: Templates/Applications
         templates:
           -
             uuid: 56079badd056419383cc26e6a4fcc7e0
             template: VMware
             name: VMware
             description: |
               You can discuss this template or leave feedback on our forum https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/
               
               Template tooling version used: 0.38
             templates:
               -
                 name: 'VMware macros'
             groups:
               -
                 name: Templates/Applications
             items:
               -
                 uuid: 5ce209f4d94f460488a74a92a52d92b1
                 name: 'VMware: Event log'
                 type: SIMPLE
                 key: 'vmware.eventlog[{$VMWARE.URL},skip]'
                 history: 7d
                 trends: '0'
                 value_type: LOG
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 description: 'Collect VMware event log. See also: https://www.zabbix.com/documentation/6.2/manual/config/items/preprocessing/examples#filtering_vmware_event_log_records'
                 tags:
                   -
                     tag: Application
                     value: VMware
               -
                 uuid: ee2edadb8ce943ef81d25dbbba8667a4
                 name: 'VMware: Full name'
                 type: SIMPLE
                 key: 'vmware.fullname[{$VMWARE.URL}]'
                 delay: 1h
                 history: 7d
                 trends: '0'
                 value_type: CHAR
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 description: 'VMware service full name.'
                 preprocessing:
                   -
                     type: DISCARD_UNCHANGED_HEARTBEAT
                     parameters:
                       - 1d
                 tags:
                   -
                     tag: Application
                     value: VMware
               -
                 uuid: a0ec9145f2234fbea79a28c57ebdb44d
                 name: 'VMware: Version'
                 type: SIMPLE
                 key: 'vmware.version[{$VMWARE.URL}]'
                 delay: 1h
                 history: 7d
                 trends: '0'
                 value_type: CHAR
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 description: 'VMware service version.'
                 preprocessing:
                   -
                     type: DISCARD_UNCHANGED_HEARTBEAT
                     parameters:
                       - 1d
                 tags:
                   -
                     tag: Application
                     value: VMware
             discovery_rules:
               -
                 uuid: 16ffc933cce74cf28a6edf306aa99782
                 name: 'Discover VMware clusters'
                 type: SIMPLE
                 key: 'vmware.cluster.discovery[{$VMWARE.URL}]'
                 delay: 1h
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 description: 'Discovery of clusters'
                 item_prototypes:
                   -
                     uuid: 46111f91dd564a459dbc1d396e2e6c76
                     name: 'VMware: Status of "{#CLUSTER.NAME}" cluster'
                     type: SIMPLE
                     key: 'vmware.cluster.status[{$VMWARE.URL},{#CLUSTER.NAME}]'
                     history: 7d
                     username: '{$VMWARE.USERNAME}'
                     password: '{$VMWARE.PASSWORD}'
                     description: 'VMware cluster status.'
                     valuemap:
                       name: 'VMware status'
                     tags:
                       -
                         tag: Application
                         value: VMware
               -
                 uuid: 8fb6a45cbe074b0cb6df53758e2c6623
                 name: 'Discover VMware datastores'
                 type: SIMPLE
                 key: 'vmware.datastore.discovery[{$VMWARE.URL}]'
                 delay: 1h
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 item_prototypes:
                   -
                     uuid: 4b61838ba4c34e709b25081ae5b059b5
                     name: 'VMware: Average read latency of the datastore {#DATASTORE}'
                     type: SIMPLE
                     key: 'vmware.datastore.read[{$VMWARE.URL},{#DATASTORE},latency]'
                     history: 7d
                     username: '{$VMWARE.USERNAME}'
                     password: '{$VMWARE.PASSWORD}'
                     description: 'Amount of time for a read operation from the datastore (milliseconds).'
                     tags:
                       -
                         tag: Application
                         value: VMware
                   -
                     uuid: 5355c401dc244bc588ccd18767577c93
                     name: 'VMware: Free space on datastore {#DATASTORE} (percentage)'
                     type: SIMPLE
                     key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE},pfree]'
                     delay: 5m
                     history: 7d
                     value_type: FLOAT
                     units: '%'
                     username: '{$VMWARE.USERNAME}'
                     password: '{$VMWARE.PASSWORD}'
                     description: 'VMware datastore space in percentage from total.'
                     tags:
                       -
                         tag: Application
                         value: VMware
                   -
                     uuid: 84f13c4fde2d4a17baaf0c8c1eb4f2c0
                     name: 'VMware: Total size of datastore {#DATASTORE}'
                     type: SIMPLE
                     key: 'vmware.datastore.size[{$VMWARE.URL},{#DATASTORE}]'
                     delay: 5m
                     history: 7d
                     units: B
                     username: '{$VMWARE.USERNAME}'
                     password: '{$VMWARE.PASSWORD}'
                     description: 'VMware datastore space in bytes.'
                     tags:
                       -
                         tag: Application
                         value: VMware
                   -
                     uuid: 540cd0fbc56c4b8ea19f2ff5839ce00d
                     name: 'VMware: Average write latency of the datastore {#DATASTORE}'
                     type: SIMPLE
                     key: 'vmware.datastore.write[{$VMWARE.URL},{#DATASTORE},latency]'
                     history: 7d
                     username: '{$VMWARE.USERNAME}'
                     password: '{$VMWARE.PASSWORD}'
                     description: 'Amount of time for a write operation to the datastore (milliseconds).'
                     tags:
                       -
                         tag: Application
                         value: VMware
               -
                 uuid: a5bc075e89f248e7b411d8f960897a08
                 name: 'Discover VMware hypervisors'
                 type: SIMPLE
                 key: 'vmware.hv.discovery[{$VMWARE.URL}]'
                 delay: 1h
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 description: 'Discovery of hypervisors.'
                 host_prototypes:
                   -
                     uuid: 051a1469d4d045cbbf818fcc843a352e
                     host: '{#HV.UUID}'
                     name: '{#HV.NAME}'
                     group_links:
                       -
                         group:
                           name: Templates/Applications
                     group_prototypes:
                       -
                         name: '{#CLUSTER.NAME}'
                       -
                         name: '{#DATACENTER.NAME}'
                     templates:
                       -
                         name: 'VMware Hypervisor'
                     macros:
                       -
                         macro: '{$VMWARE.HV.UUID}'
                         value: '{#HV.UUID}'
                         description: 'UUID of hypervisor.'
                     custom_interfaces: 'YES'
                     interfaces:
                       -
                         ip: '{#HV.IP}'
               -
                 uuid: 9fd559f4e88c4677a1b874634dd686f5
                 name: 'Discover VMware VMs'
                 type: SIMPLE
                 key: 'vmware.vm.discovery[{$VMWARE.URL}]'
                 delay: 1h
                 username: '{$VMWARE.USERNAME}'
                 password: '{$VMWARE.PASSWORD}'
                 description: 'Discovery of guest virtual machines.'
                 host_prototypes:
                   -
                     uuid: 23b9ae9d6f33414880db1cb107115810
                     host: '{#VM.UUID}'
                     name: '{#VM.NAME}'
                     group_links:
                       -
                         group:
                           name: Templates/Applications
                     group_prototypes:
                       -
                         name: '{#CLUSTER.NAME} (vm)'
                       -
                         name: '{#DATACENTER.NAME}/{#VM.FOLDER} (vm)'
                       -
                         name: '{#HV.NAME}'
                     templates:
                       -
                         name: 'VMware Guest'
                     macros:
                       -
                         macro: '{$VMWARE.VM.UUID}'
                         value: '{#VM.UUID}'
                         description: 'UUID of guest virtual machine.'
                     custom_interfaces: 'YES'
                     interfaces:
                       -
                         ip: '{#VM.IP}'
             valuemaps:
               -
                 uuid: 3c59c22905054d42ac4ee8b72fe5f270
                 name: 'VMware status'
                 mappings:
                   -
                     value: '0'
                     newvalue: gray
                   -
                     value: '1'
                     newvalue: green
                   -
                     value: '2'
                     newvalue: yellow
                   -
                     value: '3'
                     newvalue: red

Element tags

Element tag values are explained in the table below.

Template tags

Element	Element property	Required	Type	Range	Description
template_groups		x			Root element for template groups.
	uuid	x	`string`		Unique identifier for this template group.
	name	x	`string`		Template group name.
host_groups		x			Root element for host groups that are used by host prototypes.
	uuid	x	`string`		Unique identifier for this host group.
	name	x	`string`		Host group name.
templates		-			Root element for templates.
	uuid	x	`string`		Unique identifier for this template.
	template	x	`string`		Unique template name.
	name	-	`string`		Visible template name.
	description	-	`text`		Template description.
groups		-			Root element for template groups.
	name	x	`string`		Template group name.
templates		-			Root element for linked templates.
	name	x	`string`		Template name.
tags		-			Root element for template tags.
	tag	x	`string`		Tag name.
	value	-	`string`		Tag value.
macros		-			Root element for template user macros.
	macro	x	`string`		User macro name.
	type	-	`string`	0 - TEXT (default) 1 - SECRET_TEXT 2 - VAULT	Type of the macro.
	value	-	`string`		User macro value.
	description	-	`string`		User macro description.
valuemaps		-			Root element for template value maps.
	uuid	x	`string`		Unique identifier for this value map.
	name	x	`string`		Value map name.
	mapping	-			Root element for mappings.
	value	x	`string`		Value of a mapping.
	newvalue	x	`string`		New value of a mapping.

Template item tags

Element	Element property	Required	Type	Range¹	Description
items		-			Root element for items.
	uuid	x	`string`		Unique identifier for the item.
	name	x	`string`		Item name.
	type	-	`string`	0 - 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	-	`string`		SNMP object ID. Required by SNMP items.
	key	x	`string`		Item key.
	delay	-	`string`	Default: 1m	Update 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	-	`string`	Default: 90d	A time unit of how long the history data should be stored. Time unit with suffix, user macro or LLD macro.
	trends	-	`string`	Default: 365d	A time unit of how long the trends data should be stored. Time unit with suffix, user macro or LLD macro.
	status	-	`string`	0 - ENABLED (default) 1 - DISABLED	Item status.
	value_type	-	`string`	0 - FLOAT 1 - CHAR 2 - LOG 3 - UNSIGNED (default) 4 - TEXT	Received value type.
	allowed_hosts	-	`string`		List of IP addresses (comma delimited) of hosts allowed sending data for the item. Used by trapper and HTTP agent items.
	units	-	`string`		Units of returned values (bps, B, etc).
	params	-	`text`		Additional 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	-	`string`		IPMI sensor. Used only by IPMI items.
	authtype	-	`string`	Authentication 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	-	`string`		Username 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	-	`string`		Password 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	-	`string`		Name of the public key file. Required for SSH agent items.
	privatekey	-	`string`		Name of the private key file. Required for SSH agent items.
	port	-	`string`		Custom port monitored by the item. Can contain user macros. Used only by SNMP items.
	description	-	`text`		Item description.
	inventory_link	-	`string`	0 - 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	-	`string`		Format of the time in log entries. Used only by log items.
	jmx_endpoint	-	`string`		JMX endpoint. Used only by JMX agent items.
	url	-	`string`		URL string. Required only for HTTP agent items.
	allow_traps	-	`string`	0 - NO (default) 1 - YES	Allow to populate value as in a trapper item. Used only by HTTP agent items.
	follow_redirects	-	`string`	0 - 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.
	name	x	`string`		Header name.
	value	x	`string`		Header value.
	http_proxy	-	`string`		HTTP(S) proxy connection string. Used only by HTTP agent items.
	output_format	-	`string`	0 - RAW (default) 1 - JSON	How to process response. Used only by HTTP agent items.
	post_type	-	`string`	0 - RAW (default) 2 - JSON 3 - XML	Type of post data body. Used only by HTTP agent items.
	posts	-	`string`		HTTP(S) request body data. Used only by HTTP agent items.
query_fields		-			Root element for query parameters. Used only by HTTP agent items.
	name	x	`string`		Parameter name.
	value	-	`string`		Parameter value.
	request_method	-	`string`	0 - GET (default) 1 - POST 2 - PUT 3 - HEAD	Request method. Used only by HTTP agent items.
	retrieve_mode	-	`string`	0 - BODY (default) 1 - HEADERS 2 - BOTH	What part of response should be stored. Used only by HTTP agent items.
	ssl_cert_file	-	`string`		Public SSL Key file path. Used only by HTTP agent items.
	ssl_key_file	-	`string`		Private SSL Key file path. Used only by HTTP agent items.
	ssl_key_password	-	`string`		Password for SSL Key file. Used only by HTTP agent items.
	status_codes	-	`string`		Ranges 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	-	`string`		Item data polling request timeout. Supports user macros. Used by HTTP agent and Script items.
	verify_host	-	`string`	0 - 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	-	`string`	0 - 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.
	name	x	`string`		Parameter name. Used only by Script items.
	value	-	`string`		Parameter value. Used only by Script items.
value map		-			Value map.
	name	x	`string`		Name of the value map to use for the item.
preprocessing		-			Root element for item value preprocessing.
step		-			Individual item value preprocessing step.
	type	x	`string`	1 - 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.
	parameter	x	`string`		Individual parameter of the item value preprocessing step.
	error_handler	-	`string`	0 - ORIGINAL_ERROR (default) 1 - DISCARD_VALUE 2 - CUSTOM_VALUE 3 - CUSTOM_ERROR	Action type used in case of preprocessing step failure.
	error_handler_params	-	`string`		Error handler parameters used with 'error_handler'.
master_item		-			Individual item master item. Required by dependent items.
	key	x	`string`		Dependent 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.
	tag	x	`string`		Tag name.
	value	-	`string`		Tag value.

Template low-level discovery rule tags

Element	Element property	Required	Type	Range	Description
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	-	`string`	0 - 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	-	`string`	Default: 30d	Time period after which items that are no longer discovered will be deleted. Seconds, time unit with suffix or user macro.
filter					Individual filter.
	evaltype	-	`string`	0 - AND_OR (default) 1 - AND 2 - OR 3 - FORMULA	Logic to use for checking low-level discovery rule filter conditions.
	formula	-	`string`		Custom calculation formula for filter conditions.
conditions		-			Root element for filter conditions.
	macro	x	`string`		Low-level discovery macro name.
	value	-	`string`		Filter value: regular expression or global regular expression.
	operator	-	`string`	8 - MATCHES_REGEX (default) 9 - NOT_MATCHES_REGEX	Condition operator.
	formulaid	x	`character`		Arbitrary 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_macro	x	`string`		Low-level discovery macro name.
	path	x	`string`		Selector 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.
	type	x	`string`	5 - 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.
	key	x	`string`		Dependent item prototype master item/item prototype key value. Required for a dependent item.

Template trigger tags

Element	Element property	Required	Type	Range¹	Description
triggers		-			Root element for triggers.
	uuid	x	`string`		Unique identifier for this trigger.
	expression	x	`string`		Trigger expression.
	recovery_mode	-	`string`	0 - EXPRESSION (default) 1 - RECOVERY_EXPRESSION 2 - NONE	Basis for generating OK events.
	recovery_expression	-	`string`		Trigger recovery expression.
	name	x	`string`		Trigger name.
	correlation_mode	-	`string`	0 - DISABLED (default) 1 - TAG_VALUE	Correlation mode (no event correlation or event correlation by tag).
	correlation_tag	-	`string`		The tag name to be used for event correlation.
	url	-	`string`		URL associated with the trigger.
	status	-	`string`	0 - ENABLED (default) 1 - DISABLED	Trigger status.
	priority	-	`string`	0 - NOT_CLASSIFIED (default) 1 - INFO 2 - WARNING 3 - AVERAGE 4 - HIGH 5 - DISASTER	Trigger severity.
	description	-	`text`		Trigger description.
	type	-	`string`	0 - SINGLE (default) 1 - MULTIPLE	Event generation type (single problem event or multiple problem events).
	manual_close	-	`string`	0 - NO (default) 1 - YES	Manual closing of problem events.
dependencies		-			Root element for dependencies.
	name	x	`string`		Dependency trigger name.
	expression	x	`string`		Dependency trigger expression.
	recovery_expression	-	`string`		Dependency trigger recovery expression.
tags		-			Root element for trigger tags.
	tag	x	`string`		Tag name.
	value	-	`string`		Tag value.

Template graph tags

Element	Element property	Required	Type	Range¹	Description
graphs		-			Root element for graphs.
	uuid	x	`string`		Unique identifier for this graph.
	name	x	`string`		Graph name.
	width	-	`integer`	20-65535 (default: 900)	Graph width, in pixels. Used for preview and for pie/exploded graphs.
	height	-	`integer`	20-65535 (default: 200)	Graph height, in pixels. Used for preview and for pie/exploded graphs.
	yaxismin	-	`double`	Default: 0	Value of Y axis minimum. Used if 'ymin_type_1' is FIXED.
	yaxismax	-	`double`	Default: 0	Value of Y axis maximum. Used if 'ymax_type_1' is FIXED.
	show_work_period	-	`string`	0 - NO 1 - YES (default)	Highlight non-working hours. Used by normal and stacked graphs.
	show_triggers	-	`string`	0 - NO 1 - YES (default)	Display simple trigger values as a line. Used by normal and stacked graphs.
	type	-	`string`	0 - NORMAL (default) 1 - STACKED 2 - PIE 3 - EXPLODED	Graph type.
	show_legend	-	`string`	0 - NO 1 - YES (default)	Display graph legend.
	show_3d	-	`string`	0 - NO (default) 1 - YES	Enable 3D style. Used by pie and exploded pie graphs.
	percent_left	-	`double`	Default:0	Show the percentile line for left axis. Used only for normal graphs.
	percent_right	-	`double`	Default:0	Show the percentile line for right axis. Used only for normal graphs.
	ymin_type_1	-	`string`	0 - CALCULATED (default) 1 - FIXED 2 - ITEM	Minimum value of Y axis. Used by normal and stacked graphs.
	ymax_type_1	-	`string`	0 - 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.
	host	x	`string`		Item host.
	key	x	`string`		Item key.
ymax_item_1		-			Individual item details. Required if 'ymax_type_1' is ITEM.
	host	x	`string`		Item host.
	key	x	`string`		Item key.
graph_items		x			Root element for graph items.
	sortorder	-	`integer`		Draw order. The smaller value is drawn first. Can be used to draw lines or regions behind (or in front of) another.
	drawtype	-	`string`	0 - 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	-	`string`		Element color (6 symbols, hex).
	yaxisside	-	`string`	0 - 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	-	`string`	1 - 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	-	`string`	0 - SIMPLE (default) 2 - GRAPH_SUM (value of the item represents the whole pie; used only by pie and exploded pie graphs)	Graph item type.
item		x			Individual item.
	host	x	`string`		Item host.
	key	x	`string`		Item key.

Template web scenario tags

Element	Element property	Required	Type	Range¹	Description
httptests		-			Root element for web scenarios.
	uuid	x	`string`		Unique identifier for this web scenario.
	name	x	`string`		Web scenario name.
	delay	-	`string`	Default: 1m	Frequency of executing the web scenario. Seconds, time unit with suffix or user macro.
	attempts	-	`integer`	1-10 (default: 1)	The number of attempts for executing web scenario steps.
	agent	-	`string`	Default: Zabbix	Client agent. Zabbix will pretend to be the selected browser. This is useful when a website returns different content for different browsers.
	http_proxy	-	`string`		Specify 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.
	name	x	`text`		Variable name.
	value	x	`text`		Variable 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.
	name	x	`text`		Header name.
	value	x	`text`		Header value.
	status	-	`string`	0 - ENABLED (default) 1 - DISABLED	Web scenario status.
	authentication	-	`string`	0 - NONE (default) 1 - BASIC 2 - NTLM	Authentication method.
	http_user	-	`string`		User name used for basic, HTTP or NTLM authentication.
	http_password	-	`string`		Password used for basic, HTTP or NTLM authentication.
	verify_peer	-	`string`	0 - NO (default) 1 - YES	Verify the SSL certificate of the web server.
	verify_host	-	`string`	0 - 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	-	`string`		Name of the SSL certificate file used for client authentication (must be in PEM format).
	ssl_key_file	-	`string`		Name of the SSL private key file used for client authentication (must be in PEM format).
	ssl_key_password	-	`string`		SSL private key file password.
steps		x			Root element for web scenario steps.
	name	x	`string`		Web scenario step name.
	url	x	`string`		URL 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.
	name	x	`string`		Query field name.
	value	-	`string`		Query field value.
posts		-			HTTP POST variables as a string (raw post data) or as an array of HTTP fields (form field data).
	name	x	`string`		Post field name.
	value	x	`string`		Post 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
	name	x	`string`		Variable name.
	value	x	`string`		Variable 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.
	name	x	`string`		Header name.
	value	x	`string`		Header value.
	follow_redirects	-	`string`	0 - NO 1 - YES (default)	Follow HTTP redirects.
	retrieve_mode	-	`string`	0 - BODY (default) 1 - HEADERS 2 - BOTH	HTTP response retrieve mode.
	timeout	-	`string`	Default: 15s	Timeout of step execution. Seconds, time unit with suffix or user macro.
	required	-	`string`		Text that must be present in the response. Ignored if empty.
	status_codes	-	`string`		A comma delimited list of accepted HTTP status codes. Ignored if empty. For example: 200-201,210-299
tags		-			Root element for web scenario tags.
	tag	x	`string`		Tag name.
	value	-	`string`		Tag value.

Template dashboard tags

Element	Element property	Required	Type	Range¹	Description
dashboards		-			Root element for template dashboards.
	uuid	x	`string`		Unique identifier for this dashboard.
	name	x	`string`		Template dashboard name.
	display period	-	`integer`		Display period of dashboard pages.
	auto_start	-	`string`	0 - no 1 - yes	Slideshow auto start.
pages		-			Root element for template dashboard pages.
	name	-	`string`		Page name.
	display period	-	`integer`		Page display period.
	sortorder	-	`integer`		Page sorting order.
widgets		-			Root element for template dashboard widgets.
	type	x	`string`		Widget type.
	name	-	`string`		Widget name.
	x	-	`integer`	0-23	Horizontal position from the left side of the template dashboard.
	y	-	`integer`	0-62	Vertical position from the top of the template dashboard.
	width	-	`integer`	1-24	Widget width.
	height	-	`integer`	2-32	Widget height.
	hide_header	-	`string`	0 - no 1 - yes	Hide widget header.
fields		-			Root element for the template dashboard widget fields.
	type	x	`string`	0 - INTEGER 1 - STRING 3 - HOST 4 - ITEM 5 - ITEM_PROTOTYPE 6 - GRAPH 7 - GRAPH_PROTOTYPE	Widget field type.
	name	x	`string`		Widget field name.
	value	x	mixed		Widget field value, depending on the field type.

Footnotes

¹ 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.

Documentation