Table of Contents
> Item prototype object
The following objects are directly related to the itemprototype API.
Item prototype
The item prototype object has the following properties.
| Property | Type | Description |
|---|---|---|
| itemid | string | (readonly) ID of the item prototype. |
| delay (required) |
string | Update interval of the item prototype. Accepts seconds or time unit with suffix and with or without one or more custom intervals that consist of either flexible intervals and scheduling intervals as serialized strings. Also accepts user macros and LLD macros. Flexible intervals could be written as two macros separated by a forward slash. Intervals are separated by a semicolon. Optional for Zabbix trapper or Dependent item. |
| hostid (required) |
string | ID of the host that the item prototype belongs to. For update operations this field is readonly. |
| ruleid (required) |
string | ID of the LLD rule that the item belongs to. For update operations this field is readonly. |
| interfaceid (required) |
string | ID of the item prototype's host interface. Used only for host item prototypes. Optional for Zabbix agent (active), Zabbix internal, Zabbix trapper, Dependent item, Zabbix aggregate, database monitor and calculated item prototypes. |
| key_ (required) |
string | Item prototype key. |
| name (required) |
string | Name of the item prototype. |
| type (required) |
integer | Type of the item prototype. 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; 10 - external check; 11 - database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item |
| value_type (required) |
integer | Type of information of the item prototype. Possible values: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text. |
| authtype | integer | SSH authentication method. Used only by SSH agent item prototypes. Possible values: 0 - (default) password; 1 - public key. |
| description | string | Description of the item prototype. |
| history | string | A time unit of how long the history data should be stored. Also accepts user macro and LLD macro. Default: 90d. |
| ipmi_sensor | string | IPMI sensor. Used only by IPMI item prototypes. |
| logtimefmt | string | Format of the time in log entries. Used only by log item prototypes. |
| params | string | Additional parameters depending on the type of the item prototype: - executed script for SSH and Telnet item prototypes; - SQL query for database monitor item prototypes; - formula for calculated item prototypes. |
| password | string | Password for authentication. Used by simple check, SSH, Telnet, database monitor and JMX item prototypes. |
| port | string | Port monitored by the item prototype. Used only by SNMP items prototype. |
| privatekey | string | Name of the private key file. |
| publickey | string | Name of the public key file. |
| snmp_community | string | SNMP community. Used only by SNMPv1 and SNMPv2 item prototypes. |
| snmp_oid | string | SNMP OID. |
| snmpv3_authpassphrase | string | SNMPv3 auth passphrase. Used only by SNMPv3 item prototypes. |
| snmpv3_authprotocol | integer | SNMPv3 authentication protocol. Used only by SNMPv3 items. Possible values: 0 - (default) MD5; 1 - SHA. |
| snmpv3_contextname | string | SNMPv3 context name. Used only by SNMPv3 item prototypes. |
| snmpv3_privpassphrase | string | SNMPv3 priv passphrase. Used only by SNMPv3 item prototypes. |
| snmpv3_privprotocol | integer | SNMPv3 privacy protocol. Used only by SNMPv3 items. Possible values: 0 - (default) DES; 1 - AES. |
| snmpv3_securitylevel | integer | SNMPv3 security level. Used only by SNMPv3 item prototypes. Possible values: 0 - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| snmpv3_securityname | string | SNMPv3 security name. Used only by SNMPv3 item prototypes. |
| status | integer | Status of the item prototype. Possible values: 0 - (default) enabled item prototype; 1 - disabled item prototype; 3 - unsupported item prototype. |
| templateid | string | (readonly) ID of the parent template item prototype. |
| trapper_hosts | string | Allowed hosts. Used only by trapper item prototypes. |
| trends | string | A time unit of how long the trends data should be stored. Also accepts user macro and LLD macro. Default: 365d. |
| units | string | Value units. |
| username | string | Username for authentication. Used by simple check, SSH, Telnet, database monitor and JMX item prototypes. Required by SSH and Telnet item prototypes. |
| valuemapid | string | ID of the associated value map. |
| jmx_endpoint | string | JMX agent custom connection string. Default value: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| master_itemid | integer | Master item ID. Recursion up to 3 dependent item prototypes and maximum count of dependent item prototypes equal to 999 are allowed. Required by Dependent items. |