Zabbix Documentation 2.0

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:appendix:api:item:definitions

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:api:item:definitions [2012/11/02 09:24]
Pavels [Item] corrected item flag
manual:appendix:api:item:definitions [2018/12/17 10:02] (current)
martins-v 'hostid' clarified to include both hosts and templates
Line 12: Line 12:
 | itemid ​ | string ​ | //​(readonly)//​ ID of the item.  | | itemid ​ | string ​ | //​(readonly)//​ ID of the item.  |
 | **delay** \\ (required) | integer | Update interval of the item in seconds. | | **delay** \\ (required) | integer | Update interval of the item in seconds. |
-| **hostid** \\ (required) | string | ID of the host that the item belongs to. | +| **hostid** \\ (required) | string | ID of the host or template ​that the item belongs to. | 
-| **interfaceid** \\ (required) | string ​ | ID of the item's host interface. |+| **interfaceid** \\ (required) | string ​ | ID of the item's host interface.\\ \\ Not required for template items. Optional for Zabbix agent (active), Zabbix internal, Zabbix trapper, Zabbix aggregate, database monitor and calculated items. |
 | **key_** \\ (required) | string | Item key. | | **key_** \\ (required) | string | Item key. |
 | **name** \\ (required) | string | Name of the item. | | **name** \\ (required) | string | Name of the item. |
 | **type** \\ (required) | integer | Type of the item. \\ \\ Possible values: \\ 0 - Zabbix agent; \\ 1 - SNMPv1 agent; \\ 2 - Zabbix trapper; \\ 3 - simple check; \\ 4 - SNMPv2 agent; \\ 5 - Zabbix internal; \\ 6 - SNMPv3 agent; \\ 7 - Zabbix agent (active); \\ 8 - Zabbix aggregate; \\ 9 - web item; \\ 10 - external check; \\ 11 - database monitor; \\ 12 - IPMI agent; \\ 13 - SSH agent; \\ 14 - TELNET agent; \\ 15 - calculated; \\ 16 - JMX agent. | | **type** \\ (required) | integer | Type of the item. \\ \\ Possible values: \\ 0 - Zabbix agent; \\ 1 - SNMPv1 agent; \\ 2 - Zabbix trapper; \\ 3 - simple check; \\ 4 - SNMPv2 agent; \\ 5 - Zabbix internal; \\ 6 - SNMPv3 agent; \\ 7 - Zabbix agent (active); \\ 8 - Zabbix aggregate; \\ 9 - web item; \\ 10 - external check; \\ 11 - database monitor; \\ 12 - IPMI agent; \\ 13 - SSH agent; \\ 14 - TELNET agent; \\ 15 - calculated; \\ 16 - JMX agent. |
-| **username** \\ (required) | string | Username for authentication. Used only by SSH, telnet and JMX items. \\ \\ Required by SSH and telnet items. | 
 | **value_type** \\ (required) | integer | Type of information of the item. \\ \\ Possible values: \\ 0 - numeric float; \\ 1 - character; \\ 2 - log; \\ 3 - numeric unsigned; \\ 4 - text. | | **value_type** \\ (required) | integer | Type of information of the item. \\ \\ Possible values: \\ 0 - numeric float; \\ 1 - character; \\ 2 - log; \\ 3 - numeric unsigned; \\ 4 - text. |
 | authtype | integer | SSH authentication method. Used only by SSH agent items. \\ \\ Possible values: \\ 0 - //​(default)//​ password; \\ 1 - public key. | | authtype | integer | SSH authentication method. Used only by SSH agent items. \\ \\ Possible values: \\ 0 - //​(default)//​ password; \\ 1 - public key. |
 | data_type | integer | Data type of the item. \\ \\ Possible values: \\ 0 - //​(default)//​ decimal; \\ 1 - octal; \\ 2 - hexadecimal;​ \\ 3 - boolean. | | data_type | integer | Data type of the item. \\ \\ Possible values: \\ 0 - //​(default)//​ decimal; \\ 1 - octal; \\ 2 - hexadecimal;​ \\ 3 - boolean. |
-| delay_flex | string | Flexible intervals as a serialized string. \\ \\ Each serialized flexible interval consists of an update interval and a [[2.0:manual:​appendix:​time_period|time period]] separated by a forward slash. Multiple intervals are separated by a colon. |+| delay_flex | string | Flexible intervals as a serialized string. \\ \\ Each serialized flexible interval consists of an update interval and a [[manual:​appendix:​time_period|time period]] separated by a forward slash. Multiple intervals are separated by a colon. |
 | delta | integer | Value that will be stored. \\ \\ Possible values: \\ 0 - //​(default)//​ as is; \\ 1 - Delta, speed per second; \\ 2 - Delta, simple change. | | delta | integer | Value that will be stored. \\ \\ Possible values: \\ 0 - //​(default)//​ as is; \\ 1 - Delta, speed per second; \\ 2 - Delta, simple change. |
 | description | string | Description of the item. | | description | string | Description of the item. |
Line 28: Line 27:
 | formula | integer/​float | Custom multiplier. \\ \\ Default: 1. | | formula | integer/​float | Custom multiplier. \\ \\ Default: 1. |
 | history | integer | Number of days to keep item's history data. \\ \\ Default: 90. | | history | integer | Number of days to keep item's history data. \\ \\ Default: 90. |
-| inventory_link | integer | ID of the host inventory field that is populated by the item. \\ \\ Refer to the [[2.0:manual:​appendix:​api:​host:​definitions#​host_inventory|host inventory page]] for a list of supported host inventory fields and their IDs. \\ \\ Default: 0. |+| inventory_link | integer | ID of the host inventory field that is populated by the item. \\ \\ Refer to the [[manual:​appendix:​api:​host:​definitions#​host_inventory|host inventory page]] for a list of supported host inventory fields and their IDs. \\ \\ Default: 0. |
 | ipmi_sensor | string | IPMI sensor. Used only by IPMI items. | | ipmi_sensor | string | IPMI sensor. Used only by IPMI items. |
 | lastclock | timestamp | //​(readonly)//​ Time when the item was last updated. | | lastclock | timestamp | //​(readonly)//​ Time when the item was last updated. |
Line 34: Line 33:
 | lastvalue | string | //​(readonly)//​ Last value of the item. | | lastvalue | string | //​(readonly)//​ Last value of the item. |
 | logtimefmt | string | Format of the time in log entries. Used only by log items. | | logtimefmt | string | Format of the time in log entries. Used only by log items. |
 +| mtime | timestamp | Time when the monitored log file was last updated. Used only by log items. |
 | multiplier | integer | Whether to use a custom multiplier. | | multiplier | integer | Whether to use a custom multiplier. |
 | params | string | Additional parameters depending on the type of the item: \\ - executed script for SSH and telnet items; \\ - additional parameters for database monitor items; \\ - formula for calculated items. | | params | string | Additional parameters depending on the type of the item: \\ - executed script for SSH and telnet items; \\ - additional parameters for database monitor items; \\ - formula for calculated items. |
Line 49: Line 49:
 | snmpv3_securityname | string | SNMPv3 security name. Used only by SNMPv3 items. | | snmpv3_securityname | string | SNMPv3 security name. Used only by SNMPv3 items. |
 | status | integer | Status of the item. \\ \\ Possible values: \\ 0 - //​(default)//​ enabled item; \\ 1 - disabled item; \\ 3 - unsupported item. | | status | integer | Status of the item. \\ \\ Possible values: \\ 0 - //​(default)//​ enabled item; \\ 1 - disabled item; \\ 3 - unsupported item. |
-| templateid | string | (readonly) ID of the parent template item. |+| templateid | string | (readonly) ID of the parent template item.\\ \\ //Hint//: Use the ''​hostid''​ property to specify the template that the item belongs to. |
 | trapper_hosts | string | Allowed hosts. Used only by trapper items. | | trapper_hosts | string | Allowed hosts. Used only by trapper items. |
 | trends | integer | Number of days to keep item's trends data. \\ \\ Default: 365. | | trends | integer | Number of days to keep item's trends data. \\ \\ Default: 365. |
 | units | string | Value units. | | units | string | Value units. |
 +| username | string | Username for authentication. Used only by SSH, telnet and JMX items. \\ \\ Required by SSH and telnet items. |
 | valuemapid | string | ID of the associated value map. | | valuemapid | string | ID of the associated value map. |