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

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

2 User macros supported by location

Overview

User-definable macros are supported in the following locations:

  • Hosts
    • Interface IP/DNS
    • Interface port
  • Passive proxy
    • Interface port
  • Items and item prototypes
    • Name
    • Key parameters
    • Update interval
    • Custom intervals
    • History storage period
    • Trend storage period
    • SNMPv3 context name
    • SNMPv3 security name
    • SNMPv3 auth pass
    • SNMPv3 priv pass
    • SNMPv1/v2 community
    • SNMP OID
    • SNMP port
    • SSH username
    • SSH public key
    • SSH private key
    • SSH password
    • SSH script
    • Telnet username
    • Telnet password
    • Telnet script
    • Calculated item formula
    • Trapper item "Allowed hosts" field
    • Database monitoring additional parameters
    • JMX item endpoint field
    • since Zabbix 4.0 also in:
      • item value preprocessing steps
      • HTTP agent URL field
      • HTTP agent HTTP query fields field
      • HTTP agent request body field
      • HTTP agent required status codes field
      • HTTP agent headers field key and value
      • HTTP agent HTTP authentication username field
      • HTTP agent HTTP authentication password field
      • HTTP agent HTTP proxy field
      • HTTP agent SSL certificate file field
      • HTTP agent SSL key file field
      • HTTP agent SSL key password field
      • HTTP agent HTTP timeout field
      • HTTP agent HTTP allowed hosts field
  • Discovery
    * Update interval
           * SNMPv3 context name
           * SNMPv3 security name
           * SNMPv3 auth pass
           * SNMPv3 priv pass
           * SNMPv1/v2 community
           * SNMP OID
  • Low-level discovery rule
    • Name
    • Key parameters
    • Update interval
    • Custom intervals
    • SNMPv3 context name
    • SNMPv3 security name
    • SNMPv3 auth pass
    • SNMPv3 priv pass
    • SNMPv1/v2 community
    • SNMP OID
    • SNMP port
    • SSH username
    • SSH public key
    • SSH private key
    • SSH password
    • SSH script
    • Telnet username
    • Telnet password
    • Telnet script
    • Trapper item "Allowed hosts" field
    • Database monitoring additional parameters
    • JMX item endpoint field
    • Keep lost resources period
    • Filter regular expressions
    • since Zabbix 4.0 also in:
      • HTTP agent URL field
      • HTTP agent HTTP query fields field
      • HTTP agent request body field
      • HTTP agent required status codes field
      • HTTP agent headers field key and value
      • HTTP agent HTTP authentication username field
      • HTTP agent HTTP authentication password field
      • HTTP agent HTTP timeout field
  • Web scenario
    * Name
           * Update interval
           * Agent
           * HTTP proxy
           * Variables
           * Headers
           * Step name
           * Step URL
           * Step post variables
           * Step headers
           * Step timeout
           * Required string
           * Required status codes
           * Authentication (user and password)
           * SSL certificate file
           * SSL key file
           * SSL key password
  • Triggers
    * Name
           * Expression (only in constants and function parameters)
           * Description
           * URLs
  • Trigger-based notifications
  • Trigger-based internal notifications
  • Event tags
    * Tag name 
           * Tag value 
           * Tag for matching 
  • Action operations
    * Default operation step duration
           * Step duration
  • Action conditions
    * Time period condition
  • Global scripts (including confirmation text)
  • URL field of dynamic URL screen element
  • Administration → Users → Media: 'When active' field
  • Administration → General → Working time: 'Working time' field

For a complete list of all macros supported Zabbix, see macros supported by location.

Actions

In actions, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Trigger-based notifications and commands yes
Trigger-based internal notifications yes
Problem update notifications yes
Time period condition no
Operations
Default operation step duration no
Step duration no

Hosts

In a host configuration, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Interface IP/DNS DNS only
Interface port no
SNMP v1, v2
SNMP community yes
SNMP v3
Context name yes
Security name yes
Authentication passphrase yes
Privacy passphrase yes
IPMI
Username yes
Password yes
Tags
Tag names yes
Tag values yes

Items / item prototypes

In an item or an item prototype configuration, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Name (deprecated) yes
Item key parameters yes
Update interval no
Custom intervals no
History storage period no
Trend storage period no
Calculated item
Formula yes
Database monitor
Username yes
Password yes
SQL query yes
//HTTP agent //
URL2 yes
Query fields yes
Timeout no
Request body yes
Headers (names and values) yes
Required status codes yes
HTTP proxy yes
HTTP authentication username yes
HTTP authentication password yes
SSl certificate file yes
SSl key file yes
SSl key password yes
Allowed hosts yes
JMX agent
JMX endpoint yes
SNMP agent
SNMP OID yes
SSH agent
Username yes
Public key file yes
Private key file yes
Password yes
Script yes
TELNET agent
Username yes
Password yes
Script yes
Zabbix trapper
Allowed hosts yes
Preprocessing
Step parameters (including custom scripts) yes

Low-level discovery

In a low-level discovery rule, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Name yes
Key parameters yes
Update interval no
Custom interval no
Keep lost resources period no
SNMP agent
SNMP OID yes
SSH agent
Username yes
Public key file yes
Private key file yes
Password yes
Script yes
TELNET agent
Username yes
Password yes
Script yes
Zabbix trapper
Allowed hosts yes
Database monitor
Additional parameters yes
JMX agent
JMX endpoint yes
HTTP agent
URL2 yes
Query fields yes
Timeout no
Request body yes
Headers (names and values) yes
Required status codes yes
HTTP authentication username yes
HTTP authentication password yes
Filters
Regular expression yes
Overrides
Filters: regular expression yes
Operations: update interval (for item prototypes) no
Operations: history storage period (for item prototypes) no
Operations: trend storage period (for item prototypes) no

Network discovery

In a network discovery rule, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Update interval no
SNMP v1, v2
SNMP community yes
SNMP OID yes
SNMP v3
Context name yes
Security name yes
Authentication passphrase yes
Privacy passphrase yes
SNMP OID yes

Proxies

In a proxy configuration, user macros can be used in the following field:

Location Multiple macros/mix with text1
Interface port (for passive proxy) no

Templates

In a template configuration, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Tags
Tag names yes
Tag values yes

Triggers

In a trigger configuration, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Name yes
Operational data yes
Expression (only in constants and function parameters; secret macros are not supported). yes
Description yes
URL2 yes
Tag for matching yes
Tags
Tag names yes
Tag values yes

Web scenario

In a web scenario configuration, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Name yes
Update interval no
Agent yes
HTTP proxy yes
Variables (values only) yes
Headers (names and values) yes
Steps
Name yes
URL2 yes
Variables (values only) yes
Headers (names and values) yes
Timeout no
Required string yes
Required status codes no
Authentication
User yes
Password yes
SSL certificate yes
SSL key file yes
SSL key password yes

Other locations

In addition to the locations listed here, user macros can be used in the following fields:

Location Multiple macros/mix with text1
Global scripts (including confirmation text) yes
Monitoring → Screens
URL2 field of dynamic URL screen element yes
Administration → Users → Media
When active no
Administration → General → Working time
Working time no
Administration → Media types → Message templates
Subject yes
Message yes

For a complete list of all macros supported in Zabbix, see supported macros.

Footnotes

1 If multiple macros in a field or macros mixed with text are not supported for the location, a single macro has to fill the whole field.

2 URLs that contain a secret macro will not work, as the macro in them will be resolved as "******".