Modbus plugin

Overview

Configuration parameters allow customizing the Modbus plugin behavior.

It is recommended to specify them in their own configuration file (e.g. modbus.conf), rather than in the agent 2 configuration file. Then use the Include directive to include this file in the Zabbix agent 2 configuration.

All parameters are optional, unless explicitly stated that the parameter is mandatory.

This page is structured as:

• Parameter overview (to see full details of a parameter, click its name)
• Parameter details

Note that:

• The default values reflect process defaults, not the values in the shipped configuration files;
• Values support environment variables;
• Zabbix supports configuration files only in UTF-8 encoding without BOM;
• Comments starting with "#" are only supported at the beginning of the line.

Parameter details

Plugins.Modbus.Sessions.<SessionName>.Endpoint

Specify the named session endpoint for connecting to Modbus.
The connection string consists of a protocol scheme, a host address and a port or serial port name and attributes.
<SessionName> - define name of a session for using in item keys.

Plugins.Modbus.Sessions.<SessionName>.SlaveID

Specify the named session slave ID for connecting to Modbus.
<SessionName> - define name of a session for using in item keys.

Example: Plugins.Modbus.Sessions.MB1.SlaveID=20

Note that this named session parameter is checked only if the value provided in the item key slave ID parameter is empty.

Plugins.Modbus.Sessions.<SessionName>.Timeout

Set the named session timeout in seconds.
<SessionName> - define name of a session for using in item keys.

Example: Plugins.Modbus.Sessions.MB1.Timeout=2

If you need to set the request execution timeout (how long to wait for a request to complete before shutting it down), use the item configuration form.

See also

• Description of general Zabbix agent 2 configuration parameters: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
• Instructions for configuring plugins