manual:appendix:macros:supported_by_location

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:appendix:macros:supported_by_location [2021/01/21 13:53]
marinagen some reordering; more precise wording
manual:appendix:macros:supported_by_location [2021/01/27 20:27] (current)
Line 24: Line 24:
 |{DISCOVERY.SERVICE.UPTIME} ​            ​|->​ Discovery notifications and commands ​ |//Time since the last change of discovery status for a particular service//, with precision down to a second.\\ For example: 1h 29m 01s.\\ For services with status DOWN, this is the period of their downtime. ​ | |{DISCOVERY.SERVICE.UPTIME} ​            ​|->​ Discovery notifications and commands ​ |//Time since the last change of discovery status for a particular service//, with precision down to a second.\\ For example: 1h 29m 01s.\\ For services with status DOWN, this is the period of their downtime. ​ |
 |{ESC.HISTORY} ​                         |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications ​ |//​Escalation history. Log of previously sent messages.//​\\ Shows previously sent notifications,​ on which escalation step they were sent and their status (//sent//, //in progress// or //​failed//​). ​ | |{ESC.HISTORY} ​                         |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications ​ |//​Escalation history. Log of previously sent messages.//​\\ Shows previously sent notifications,​ on which escalation step they were sent and their status (//sent//, //in progress// or //​failed//​). ​ |
-|{EVENT.ACK.STATUS} ​                    ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands ​ |//Acknowledgement ​status of the event (Yes/​No)//​. ​ |+|{EVENT.ACK.STATUS} ​                    ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands ​ |//Acknowledgment ​status of the event (Yes/​No)//​. ​ |
 |{EVENT.AGE} ​                           |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Age of the event that triggered an action//, with precision down to a second.\\ Useful in escalated messages. ​ | |{EVENT.AGE} ​                           |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Age of the event that triggered an action//, with precision down to a second.\\ Useful in escalated messages. ​ |
 |{EVENT.DATE} ​                          ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Date of the event that triggered an action.// ​ | |{EVENT.DATE} ​                          ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Date of the event that triggered an action.// ​ |
Line 49: Line 49:
 |{EVENT.TIME} ​                          ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Time of the event that triggered an action.// ​ | |{EVENT.TIME} ​                          ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Time of the event that triggered an action.// ​ |
 |{EVENT.UPDATE.ACTION} ​                 |-> Problem update notifications and commands ​ |//​Human-readable name of the action(s)// performed during [[:​manual/​acknowledges#​updating_problems|problem update]].\\ Resolves to the following values: //​acknowledged//,​ //​commented//,​ //changed severity from (original severity) to (updated severity)// and //closed// (depending on how many actions are performed in one update).\\ Supported since 4.0.0. ​ | |{EVENT.UPDATE.ACTION} ​                 |-> Problem update notifications and commands ​ |//​Human-readable name of the action(s)// performed during [[:​manual/​acknowledges#​updating_problems|problem update]].\\ Resolves to the following values: //​acknowledged//,​ //​commented//,​ //changed severity from (original severity) to (updated severity)// and //closed// (depending on how many actions are performed in one update).\\ Supported since 4.0.0. ​ |
-|{EVENT.UPDATE.DATE} ​                   |-> Problem update notifications and commands ​ |//Date of problem update (acknowledgement, etc).//\\ Deprecated name: {ACK.DATE} ​ | +|{EVENT.UPDATE.DATE} ​                   |-> Problem update notifications and commands ​ |//Date of problem update (acknowledgment, etc).//\\ Deprecated name: {ACK.DATE} ​ | 
-|{EVENT.UPDATE.HISTORY} ​                ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands ​ |//Log of problem updates (acknowledgements, etc).//\\ Deprecated name: {EVENT.ACK.HISTORY} ​ |+|{EVENT.UPDATE.HISTORY} ​                ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands ​ |//Log of problem updates (acknowledgments, etc).//\\ Deprecated name: {EVENT.ACK.HISTORY} ​ |
 |{EVENT.UPDATE.MESSAGE} ​                ​|->​ Problem update notifications and commands ​ |//Problem update message.//​\\ Deprecated name: {ACK.MESSAGE} ​ | |{EVENT.UPDATE.MESSAGE} ​                ​|->​ Problem update notifications and commands ​ |//Problem update message.//​\\ Deprecated name: {ACK.MESSAGE} ​ |
 |{EVENT.UPDATE.STATUS} ​   ​              ​|->​​ Trigger-based notifications and commands\\ -> Problem update notifications and commands ​ |//Numeric value of of the problem update status.// Possible values: 0 - Webhook was called because of problem/​recovery event, 1 - Update operation.\\ Supported since 4.4.0. ​ | |{EVENT.UPDATE.STATUS} ​   ​              ​|->​​ Trigger-based notifications and commands\\ -> Problem update notifications and commands ​ |//Numeric value of of the problem update status.// Possible values: 0 - Webhook was called because of problem/​recovery event, 1 - Update operation.\\ Supported since 4.4.0. ​ |
-|{EVENT.UPDATE.TIME} ​                   |-> Problem update notifications and commands ​ |//Time of problem update (acknowledgement, etc).//\\ Deprecated name: {ACK.TIME} ​ |+|{EVENT.UPDATE.TIME} ​                   |-> Problem update notifications and commands ​ |//Time of problem update (acknowledgment, etc).//\\ Deprecated name: {ACK.TIME} ​ |
 |{EVENT.VALUE} ​                         |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Numeric value of the event that triggered an action (1 for problem, 0 for recovering).//​\\ Supported since 2.2.0. ​ | |{EVENT.VALUE} ​                         |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Discovery notifications and commands\\ ​ -> Autoregistration notifications and commands\\ ​ -> Internal notifications ​ |//Numeric value of the event that triggered an action (1 for problem, 0 for recovering).//​\\ Supported since 2.2.0. ​ |
 |{HOST.CONN} ​                      ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Global scripts (including confirmation text)\\ -> Map element labels, map URL names and values\\ -> Item key parameters<​sup>​[[supported_by_location#​footnotes|1]]</​sup>​\\ -> Host interface IP/DNS\\ -> Trapper item %%"​%%Allowed hosts%%"​%% field\\ -> Database monitoring additional parameters\\ -> SSH and Telnet scripts\\ -> JMX item endpoint field\\ -> Web monitoring<​sup>​[[supported_by_location#​footnotes|4]]</​sup>​\\ -> Low-level discovery rule filter regular expressions\\ -> URL field of dynamic URL dashboard widget/​screen element\\ -> Trigger names, event names, operational data and descriptions\\ -> Trigger URLs\\ -> Tag names and values\\ -> Script type item, item prototype and discovery rule parameter names and values\\ -> HTTP agent type item, item prototype and discovery rule fields:\\ URL, Query fields, Request body, Headers, Proxy, SSL certificate file, SSL key file, Allowed hosts. ​ |//Host IP address or DNS name, depending on host settings//<​sup>​[[supported_by_location#​footnotes|2]]</​sup>​.\\ \\ May be used with a numeric index as {HOST.CONN[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ |  |{HOST.CONN} ​                      ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Global scripts (including confirmation text)\\ -> Map element labels, map URL names and values\\ -> Item key parameters<​sup>​[[supported_by_location#​footnotes|1]]</​sup>​\\ -> Host interface IP/DNS\\ -> Trapper item %%"​%%Allowed hosts%%"​%% field\\ -> Database monitoring additional parameters\\ -> SSH and Telnet scripts\\ -> JMX item endpoint field\\ -> Web monitoring<​sup>​[[supported_by_location#​footnotes|4]]</​sup>​\\ -> Low-level discovery rule filter regular expressions\\ -> URL field of dynamic URL dashboard widget/​screen element\\ -> Trigger names, event names, operational data and descriptions\\ -> Trigger URLs\\ -> Tag names and values\\ -> Script type item, item prototype and discovery rule parameter names and values\\ -> HTTP agent type item, item prototype and discovery rule fields:\\ URL, Query fields, Request body, Headers, Proxy, SSL certificate file, SSL key file, Allowed hosts. ​ |//Host IP address or DNS name, depending on host settings//<​sup>​[[supported_by_location#​footnotes|2]]</​sup>​.\\ \\ May be used with a numeric index as {HOST.CONN[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ | 
Line 137: Line 137:
 |{ITEM.DESCRIPTION} ​               |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications ​ |//​Description of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.DESCRIPTION[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ | |{ITEM.DESCRIPTION} ​               |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications ​ |//​Description of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.DESCRIPTION[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ |
 |{ITEM.DESCRIPTION.ORIG} ​               |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications ​ |//​Description (with macros unresolved) of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.DESCRIPTION.ORIG[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]].\\ \\ Supported since 5.2.0.| |{ITEM.DESCRIPTION.ORIG} ​               |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications ​ |//​Description (with macros unresolved) of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.DESCRIPTION.ORIG[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]].\\ \\ Supported since 5.2.0.|
-|{ITEM.ID} ​                        ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Script type item, item prototype and discovery rule parameter names and values\\ ​ -> HTTP agent type item, item prototype and discovery rule fields: \\ URL, query fields, request body, headers, proxy, SSL certificate file, SSL key file.  |//Numeric ID of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.ID[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ | +|{ITEM.ID} ​                        ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Script type item, item prototype and discovery rule parameter names and values ​<​sup>​[[supported_by_location#​footnotes|8]]</​sup> ​\\  -> HTTP agent type item, item prototype and discovery rule fields: \\ URL, query fields, request body, headers, proxy, SSL certificate file, SSL key file.  |//Numeric ID of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.ID[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ | 
-|{ITEM.KEY} ​                       |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Script type item, item prototype and discovery rule parameter names and values\\ -> HTTP agent type item, item prototype and discovery rule fields: \\ URL, query fields, request body, headers, proxy, SSL certificate file, SSL key file.  |//Key of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.KEY[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]].\\ \\ ''​{TRIGGER.KEY}''​ is deprecated.| +|{ITEM.KEY} ​                       |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Script type item, item prototype and discovery rule parameter names and values ​<​sup>​[[supported_by_location#​footnotes|8]]</​sup>​\\ -> HTTP agent type item, item prototype and discovery rule fields: \\ URL, query fields, request body, headers, proxy, SSL certificate file, SSL key file.  |//Key of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.KEY[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]].\\ \\ ''​{TRIGGER.KEY}''​ is deprecated.| 
-|{ITEM.KEY.ORIG} ​                  ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Script type item, item prototype and discovery rule parameter names and values\\ ​ -> HTTP agent type item, item prototype and discovery rule fields: \\ URL, query fields, request body, headers, proxy, SSL certificate file, SSL key file. |//Original key (with macros not expanded) of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.KEY.ORIG[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ |+|{ITEM.KEY.ORIG} ​                  ​|->​ Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Internal notifications\\ -> Script type item, item prototype and discovery rule parameter names and values ​<​sup>​[[supported_by_location#​footnotes|8]]</​sup>​\\  -> HTTP agent type item, item prototype and discovery rule fields: \\ URL, query fields, request body, headers, proxy, SSL certificate file, SSL key file <​sup>​[[supported_by_location#​footnotes|8]]</​sup>​. |//Original key (with macros not expanded) of the Nth item in the trigger expression that caused a notification.//​\\ \\ This macro may be used with a numeric index e.g. {ITEM.KEY.ORIG[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ |
 |{ITEM.LASTVALUE} ​                 |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Trigger names, event names, operational data and descriptions\\ -> Tag names and values\\ -> Trigger URLs<​sup>​[[supported_by_location#​footnotes|7]]</​sup> ​ |//The latest value of the Nth item in the trigger expression that caused a notification.//​\\ It will resolve to *UNKNOWN* in the frontend if the latest history value has been collected more than the //Max history display period// time ago (set in the [[:​manual/​web_interface/​frontend_sections/​administration/​general#​gui|Administration->​General]] menu section).\\ Note that since 4.0, when used in the problem name, it will not resolve to the latest item value when viewing problem events, instead it will keep the item value from the time of problem happening.\\ Supported since 1.4.3. It is alias to ''​%%{{HOST.HOST}:​{ITEM.KEY}.last()}%%''​.\\ [[:​manual/​config/​macros/​macro_functions|Customizing]] the macro value is supported for this macro; starting with Zabbix 3.2.0.\\ \\ This macro may be used with a numeric index e.g. {ITEM.LASTVALUE[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ | |{ITEM.LASTVALUE} ​                 |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Trigger names, event names, operational data and descriptions\\ -> Tag names and values\\ -> Trigger URLs<​sup>​[[supported_by_location#​footnotes|7]]</​sup> ​ |//The latest value of the Nth item in the trigger expression that caused a notification.//​\\ It will resolve to *UNKNOWN* in the frontend if the latest history value has been collected more than the //Max history display period// time ago (set in the [[:​manual/​web_interface/​frontend_sections/​administration/​general#​gui|Administration->​General]] menu section).\\ Note that since 4.0, when used in the problem name, it will not resolve to the latest item value when viewing problem events, instead it will keep the item value from the time of problem happening.\\ Supported since 1.4.3. It is alias to ''​%%{{HOST.HOST}:​{ITEM.KEY}.last()}%%''​.\\ [[:​manual/​config/​macros/​macro_functions|Customizing]] the macro value is supported for this macro; starting with Zabbix 3.2.0.\\ \\ This macro may be used with a numeric index e.g. {ITEM.LASTVALUE[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ |
 |{ITEM.LOG.AGE} ​                   |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Trigger names, operational data and descriptions\\ -> Trigger URLs\\ -> Event tags and values ​ |//Age of the log item event//, with precision down to a second.\\ \\ This macro may be used with a numeric index e.g. {ITEM.LOG.AGE[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ | |{ITEM.LOG.AGE} ​                   |-> Trigger-based notifications and commands\\ -> Problem update notifications and commands\\ -> Trigger names, operational data and descriptions\\ -> Trigger URLs\\ -> Event tags and values ​ |//Age of the log item event//, with precision down to a second.\\ \\ This macro may be used with a numeric index e.g. {ITEM.LOG.AGE[[supported_by_location#​indexed_macros|<​1-9>​]]} to point to the first, second, third, etc. host in a trigger expression. See [[supported_by_location#​indexed_macros|indexed macros]]. ​ |
Line 190: Line 190:
 |{TRIGGERS.PROBLEM.ACK} ​                ​|->​ Map element labels ​ |//Number of acknowledged PROBLEM triggers for a map element.//​\\ A trigger is considered to be acknowledged if all of it's PROBLEM events are acknowledged.\\ Supported since 1.8.3.| |{TRIGGERS.PROBLEM.ACK} ​                ​|->​ Map element labels ​ |//Number of acknowledged PROBLEM triggers for a map element.//​\\ A trigger is considered to be acknowledged if all of it's PROBLEM events are acknowledged.\\ Supported since 1.8.3.|
 |{USER.ALIAS} ​                          ​|->​ Global scripts (including confirmation text)  |//Alias (username) of the user// who started the script.\\ Supported since 5.0.2. ​ | |{USER.ALIAS} ​                          ​|->​ Global scripts (including confirmation text)  |//Alias (username) of the user// who started the script.\\ Supported since 5.0.2. ​ |
-|{USER.FULLNAME} ​                       |-> Problem update notifications and commands\\ -> Global scripts (including confirmation text)  |//Name, surname and alias of the user// who added event acknowledgement ​or started the script. \\ Supported for problem updates since 3.4.0, for global scripts since 5.0.2  |+|{USER.FULLNAME} ​                       |-> Problem update notifications and commands\\ -> Global scripts (including confirmation text)  |//Name, surname and alias of the user// who added event acknowledgment ​or started the script. \\ Supported for problem updates since 3.4.0, for global scripts since 5.0.2  |
 |{USER.NAME} ​                           |-> Global scripts (including confirmation text)  | //Name of the user// who started the script. \\ Supported since 5.0.2. ​ | |{USER.NAME} ​                           |-> Global scripts (including confirmation text)  | //Name of the user// who started the script. \\ Supported since 5.0.2. ​ |
 |{USER.SURNAME} ​                        ​|->​ Global scripts (including confirmation text)  | //Surname name of the user// who started the script. \\ Supported since 5.0.2. ​ | |{USER.SURNAME} ​                        ​|->​ Global scripts (including confirmation text)  | //Surname name of the user// who started the script. \\ Supported since 5.0.2. ​ |
Line 215: Line 215:
  
 <​sup>​**7**</​sup>​ Supported since 4.0.0. <​sup>​**7**</​sup>​ Supported since 4.0.0.
 +
 +<​sup>​**8**</​sup>​ Supported since 5.2.5.
 +
  
 === Indexed macros === === Indexed macros ===