Zabbix Documentation 2.0

3.04.04.45.0 (current)| In development:5.2 (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 [2013/10/17 06:16]
Pavels described interfaceid requirement conditions
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. \\ \\ Not required for template items add Zabbix agent (active), Zabbix internal, Zabbix trapper, Zabbix aggregate, database monitor and calculated items. |+| **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. |
Line 20: Line 20:
 | 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 27: 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 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. |