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) |
integer | Update interval of the item prototype in seconds. |
| hostid (required) |
string | ID of the host that the item prototype belongs to. |
| 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, 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. |
| 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. |
| data_type | integer | Data type of the item prototype. 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 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. |
| description | string | Description of the item prototype. |
| formula | integer/float | Custom multiplier. Default: 1. |
| history | integer | Number of days to keep item prototype's history data. Default: 90. |
| 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. |
| multiplier | integer | Whether to use a custom multiplier. |
| params | string | Additional parameters depending on the type of the item prototype: - executed script for SSH and telnet item prototypes; - additional parameters for database monitor item prototypes; - formula for calculated item prototypes. |
| password | string | Password for authentication. Used only by SSH, telnet 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. |
| snmp_oid | string | SNMP OID. |
| snmpv3_authpassphrase | string | SNMPv3 auth passphrase. Used only by SNMPv3 item prototypes. |
| snmpv3_privpassphrase | string | SNMPv3 priv passphrase. Used only by SNMPv3 item prototypes. |
| 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 | integer | Number of days to keep item prototype's trends data. Default: 365. |
| 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. |