1 Macros supported by location

Overview

The table contains a complete list of macros supported by Zabbix.

• X means "supported" in that location
• The numbered macro syntax of {MACRO<1-9>} is used to reference hosts in the order in which they appear in a trigger expression. Thus, macros like {HOST.IP1}, {HOST.IP2}, {HOST.IP3} will expand to the IP of the first, second and third host in the trigger expression, providing the expression contains those hosts. Additionally {HOST.HOST<1-9>} is supported within {host:key.func(param)} macro in graph names. For example, {{HOST.HOST2}:key.func()} in the graph name will refer to the host of the second item in the graph.

Footnotes

¹ Macros for map labels are supported since 1.8.

² The {HOST.*} macros supported in item key parameters will resolve to the interface that is selected for the item. When used in items without interfaces they will resolve to either the Zabbix agent, SNMP, JMX or IPMI interface of the host in this order of priority, since Zabbix 2.2.16. In Zabbix 2.0.3-2.2.15 they will not resolve when used in items without interfaces e.g. "Zabbix agent (active)", "Calculated" etc.

³ In remote commands, global scripts, interface IP/DNS fields and web scenarios the macro will resolve to the main agent interface, however, if it is not present, the main SNMP interface will be used. If SNMP is also not present, the main JMX interface will be used. If JMX is not present either, the main IPMI interface will be used.

⁴ This macro is supported in icon labels and link labels in maps. Only the avg, last, max and min functions, with seconds as parameter are supported in this macro.

⁵ Supported since 2.0.3.

⁶ Supported since Zabbix 2.2.0. {HOST.*} macros and user-defined macros {$MACRO} are supported in web scenario Name and Variables fields and in scenario step Name, URL, Post and Required string fields. {$MACRO} is also supported in web scenario Authentication (user and password), Agent and HTTP proxy fields and in the scenario step Required status codes field.

⁷ Supported since Zabbix 2.2.0. Only the avg, last, max and min functions, with seconds as parameter are supported within this macro in graph names. The {HOST.HOST<1-9>} macro can be used as host within the macro. For example:

 * {Cisco switch:ifAlias[{#SNMPINDEX}].last()}
        * %%{{HOST.HOST}:ifAlias[{#SNMPINDEX}].last()}%%

⁸ Only in trigger expression constants and function parameters.

⁹ While supported to build trigger expressions, simple macros may not be used inside each other.

Additional support for user macros

In addition to the locations listed, user-definable macros since Zabbix 2.0 are supported in numerous other locations:

• Hosts
  • Interface IP/DNS
  • Interface port

• Passive proxy
  • Interface port

• Items and item prototypes
  • 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
  • Telnet username
  • Telnet password
  • Calculated item formula
  • Trapper item "Allowed hosts" field (since Zabbix 2.2)

• Discovery

    * SNMPv3 context name
           * SNMPv3 security name
           * SNMPv3 auth pass
           * SNMPv3 priv pass
           * SNMPv1/v2 community
           * SNMP OID

Macros used in low-level discovery

There is a type of macro used within the low-level discovery function - {#MACRO}. It is a macro that is used in an LLD rule and returns real values of file system names, network interfaces and SNMP OIDs.

These macros can be used for creating item, trigger and graph prototypes. Then, when discovering real file systems, network interfaces etc., these macros are substituted with real values and are the basis for creating real items, triggers and graphs.

These macros are also used in creating host and host group prototypes in virtual machine discovery.

LLD macros can be used:

• for item prototypes in
  • names
  • key parameters
  • SNMP OIDs
  • calculated item formulas
  • SSH and Telnet scripts
  • database monitoring SQL queries
  • descriptions (supported since 2.2.0)
• for trigger prototypes in
  • names
  • expressions (insofar as when referencing an item key prototype and as standalone constants)
  • descriptions (supported since 2.2.0)
• for graph prototypes in
  • names
• for host prototypes (supported since 2.2.0) in
  • names
  • visible names
  • host group prototype names
  • (see the full list)

Some low-level discovery macros come "pre-packaged" with the LLD function in Zabbix - {#FSNAME}, {#FSTYPE}, {#IFNAME}, {#SNMPINDEX}, {#SNMPVALUE}. However, adhering to these names is not compulsory when creating a custom low-level discovery rule. Then you may use any other LLD macro name and refer to that name.