Table of Contents
> LLD rule object
The following objects are directly related to the discoveryrule API.
LLD rule
The low-level discovery rule object has the following properties.
| Property | Type | Description |
|---|---|---|
| itemid | string | (readonly) ID of the LLD rule. |
| delay (required) |
string | Update interval of the LLD rule. 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. Flexible intervals could be written as two macros separated by a forward slash. Intervals are separated by a semicolon. |
| hostid (required) |
string | ID of the host that the LLD rule belongs to. |
| interfaceid (required) |
string | ID of the LLD rule's host interface. Used only for host LLD rules. Optional for Zabbix agent (active), Zabbix internal, Zabbix trapper and database monitor LLD rules. |
| key_ (required) |
string | LLD rule key. |
| name (required) |
string | Name of the LLD rule. |
| type (required) |
integer | Type of the LLD rule. 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); 10 - external check; 11 - database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 16 - JMX agent. |
| authtype | integer | SSH authentication method. Used only by SSH agent LLD rules. Possible values: 0 - (default) password; 1 - public key. |
| description | string | Description of the LLD rule. |
| error | string | (readonly) Error text if there are problems updating the LLD rule. |
| ipmi_sensor | string | IPMI sensor. Used only by IPMI LLD rules. |
| lifetime | string | Time period after which items that are no longer discovered will be deleted. Accepts seconds, time unit with suffix and user macro. Default: 30d. |
| params | string | Additional parameters depending on the type of the LLD rule: - executed script for SSH and Telnet LLD rules; - SQL query for database monitor LLD rules; - formula for calculated LLD rules. |
| password | string | Password for authentication. Used by simple check, SSH, Telnet, database monitor and JMX LLD rules. |
| port | string | Port used by the LLD rule. Used only by SNMP LLD rules. |
| privatekey | string | Name of the private key file. |
| publickey | string | Name of the public key file. |
| snmp_community | string | SNMP community. Required for SNMPv1 and SNMPv2 LLD rules. |
| snmp_oid | string | SNMP OID. |
| snmpv3_authpassphrase | string | SNMPv3 auth passphrase. Used only by SNMPv3 LLD rules. |
| snmpv3_authprotocol | integer | SNMPv3 authentication protocol. Used only by SNMPv3 LLD rules. Possible values: 0 - (default) MD5; 1 - SHA. |
| snmpv3_contextname | string | SNMPv3 context name. Used only by SNMPv3 checks. |
| snmpv3_privpassphrase | string | SNMPv3 priv passphrase. Used only by SNMPv3 LLD rules. |
| snmpv3_privprotocol | integer | SNMPv3 privacy protocol. Used only by SNMPv3 LLD rules. Possible values: 0 - (default) DES; 1 - AES. |
| snmpv3_securitylevel | integer | SNMPv3 security level. Used only by SNMPv3 LLD rules. Possible values: 0 - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| snmpv3_securityname | string | SNMPv3 security name. Used only by SNMPv3 LLD rules. |
| state | integer | (readonly) State of the LLD rule. Possible values: 0 - (default) normal; 1 - not supported. |
| status | integer | Status of the LLD rule. Possible values: 0 - (default) enabled LLD rule; 1 - disabled LLD rule. |
| templateid | string | (readonly) ID of the parent template LLD rule. |
| trapper_hosts | string | Allowed hosts. Used only by trapper LLD rules. |
| username | string | Username for authentication. Used by simple check, SSH, Telnet, database monitor and JMX LLD rules. Required by SSH and Telnet LLD rules. |
| jmx_endpoint | string | JMX agent custom connection string. Default value: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
LLD rule filter
The LLD rule filter object defines a set of conditions that can be used to filter discovered objects. It has the following properties:
| Property | Type | Description |
|---|---|---|
| conditions (required) |
array | Set of filter conditions to use for filtering results. |
| evaltype (required) |
integer | Filter condition evaluation method. Possible values: 0 - and/or; 1 - and; 2 - or; 3 - custom expression. |
| eval_formula | string | (readonly) Generated expression that will be used for evaluating filter conditions. The expression contains IDs that reference specific filter conditions by its formulaid. The value of eval_formula is equal to the value of formula for filters with a custom expression. |
| formula | string | User-defined expression to be used for evaluating conditions of filters with a custom expression. The expression must contain IDs that reference specific filter conditions by its formulaid. The IDs used in the expression must exactly match the ones defined in the filter conditions: no condition can remain unused or omitted.Required for custom expression filters. |
LLD rule filter condition
The LLD rule filter condition object defines a separate check to perform on the value of an LLD macro. It has the following properties:
| Property | Type | Description |
|---|---|---|
| macro (required) |
string | LLD macro to perform the check on. |
| value (required) |
string | Value to compare with. |
| formulaid | string | Arbitrary unique ID that is used to reference the condition from a custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward. |
| operator | integer | Condition operator. Possible values: 8 - (default) matches regular expression. |
To better understand how to use filters with various types of expressions, see examples on the discoveryrule.get and discoveryrule.create method pages.