- Плагин MQTT
- Parameter details
- Plugins.MQTT.Default.Password
- Plugins.MQTT.Default.TLSCAFile
- Plugins.MQTT.Default.TLSCertFile
- Plugins.MQTT.Default.TLSKeyFile
- Plugins.MQTT.Default.Topic
- Plugins.MQTT.Default.Url
- Plugins.MQTT.Default.User
- Plugins.MQTT.Sessions.<SessionName>.Password
- Plugins.MQTT.Sessions.<SessionName>.TLSCAFile
- Plugins.MQTT.Sessions.<SessionName>.TLSCertFile
- Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile
- Plugins.MQTT.Sessions.<SessionName>.Topic
- Plugins.MQTT.Sessions.<SessionName>.Url
- Plugins.MQTT.Sessions.<SessionName>.User
- Параметры
Плагин MQTT
Обзор
Параметры конфигурации позволяют настраивать поведение плагина MQTT.
Рекомендуется указывать их в отдельном файле конфигурации (например, mqtt.conf), а не в файле конфигурации агента 2. Затем используйте директиву Include, чтобы включить этот файл в конфигурацию Zabbix agent 2.
Все параметры являются необязательными, если явно не указано, что параметр обязателен.
Обратите внимание:
- Значения по умолчанию отражают значения по умолчанию процесса, а не значения в поставляемых файлах конфигурации;
- Значения поддерживают переменные окружения;
- Zabbix поддерживает файлы конфигурации только в кодировке UTF-8 без BOM;
- Комментарии, начинающиеся с "#", поддерживаются только в начале строки.
Parameter details
Plugins.MQTT.Default.Password
Specify the default password for connecting to MQTT.
Used if no value is specified in an item key or named session.
Plugins.MQTT.Default.TLSCAFile
Specify full pathname of the file containing top-level CA(s) certificates for peer certificate verification for encrypted communications between Zabbix agent 2 and MQTT broker.
Used if no value is specified in a named session.
Plugins.MQTT.Default.TLSCertFile
Specify full pathname of the file containing the agent certificate or certificate chain for encrypted communications between Zabbix agent 2 and MQTT broker.
Used if no value is specified in a named session.
Plugins.MQTT.Default.TLSKeyFile
Specify full pathname of the file containing the MQTT private key for encrypted communications between Zabbix agent 2 and MQTT broker.
Used if no value is specified in a named session.
Plugins.MQTT.Default.Topic
Specify the default topic for MQTT subscription.
Used if no value is specified in an item key or named session.
The topic may contain wildcards ("+","#").
Examples:
path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url
Specify the default MQTT broker connection string.
Used if no value is specified in an item key or named session.
Should not include query parameters.
Must match the URL format.
Supported schemes: tcp (default), ws, tls
A scheme can be omitted.
A port can be omitted (default=1883)
Default: tcp://localhost:1883
Examples:
tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User
Specify the default username for connecting to MQTT.
Used if no value is specified in an item key or named session.
Plugins.MQTT.Sessions.<SessionName>.Password
Specify the named session password for connecting to MQTT.
<SessionName> - define name of a session for using in item keys.
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile
Specify full pathname of the file containing top-level CA(s) certificates for peer certificate verification for named session, used for encrypted communications between Zabbix agent 2 and MQTT broker.
<SessionName> - define name of a session for using in item keys.
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile
Specify full pathname of the file containing the agent certificate or certificate chain for named session, used for encrypted communications between Zabbix agent 2 and MQTT broker.
<SessionName> - define name of a session for using in item keys.
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile
Specify full pathname of the file containing the MQTT private key for named session, used for encrypted communications between Zabbix agent 2 and MQTT broker.
<SessionName> - define name of a session for using in item keys.
Plugins.MQTT.Sessions.<SessionName>.Topic
Specify the named session topic for MQTT subscription.
<SessionName> - define name of a session for using in item keys.
The topic may contain wildcards ("+","#").
Examples:
path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url
Specify the named session MQTT broker connection string.
<SessionName> - define name of a session for using in item keys.
Should not include query parameters.
Must match the URL format.
Supported schemes: tcp (default), ws, tls
A scheme can be omitted.
A port can be omitted (default=1883)
Default: tcp://localhost:1883
Examples:
tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User
Specify the named session username for connecting to MQTT.
<SessionName> - define name of a session for using in item keys.
Параметры
| Parameter | Mandatory | Range | Default | Description |
|---|---|---|---|---|
| Plugins.MQTT.Default.Password | no | Пароль по умолчанию для подключения к MQTT; используется, если значение не указано в ключе элемента данных или именованной сессии. | ||
| Plugins.MQTT.Default.TLSCAFile | no | Полный путь к файлу, содержащему сертификаты корневого CA(ов) для проверки сертификата узла при зашифрованной связи между агентом Zabbix 2 и MQTT broker; используется, если значение не указано в именованной сессии. | ||
| Plugins.MQTT.Default.TLSCertFile | no | Полный путь к файлу, содержащему сертификат агента или цепочку сертификатов для зашифрованной связи между агентом Zabbix 2 и MQTT broker; используется, если значение не указано в именованной сессии. | ||
| Plugins.MQTT.Default.TLSKeyFile | no | Полный путь к файлу, содержащему закрытый ключ MQTT для зашифрованной связи между агентом Zabbix 2 и MQTT broker; используется, если значение не указано в именованной сессии. | ||
| Plugins.MQTT.Default.Topic | no | Тема по умолчанию для подписки MQTT; используется, если значение не указано в ключе элемента данных или именованной сессии. Тема может содержать подстановочные знаки ("+","#") Примеры: path/to/filepath/to/#path/+/topic |
||
| Plugins.MQTT.Default.Url | no | tcp://localhost:1883 | Строка подключения к MQTT broker по умолчанию; используется, если значение не указано в ключе элемента данных или именованной сессии. Не должна содержать параметры запроса. Должна соответствовать формату URL. Поддерживаемые схемы: tcp (по умолчанию), ws, tls; схему можно опустить.Порт можно опустить (по умолчанию=1883). Примеры: tcp://host:1883localhostws://host:8080 |
|
| Plugins.MQTT.Default.User | no | Имя пользователя по умолчанию для подключения к MQTT; используется, если значение не указано в ключе элемента данных или именованной сессии. | ||
| Plugins.MQTT.Sessions.<SessionName>.Password | no | Пароль именованной сессии. <SessionName> - задает имя сессии для использования в ключах элементов данных. |
||
| Plugins.MQTT.Sessions.<SessionName>.TLSCAFile | no | Полный путь к файлу, содержащему сертификаты корневого CA(ов) для проверки сертификата узла, используется для зашифрованной связи между агентом Zabbix 2 и MQTT broker. <SessionName> - задает имя сессии для использования в ключах элементов данных. |
||
| Plugins.MQTT.Sessions.<SessionName>.TLSCertFile | no | Полный путь к файлу, содержащему сертификат агента или цепочку сертификатов, используется для зашифрованной связи между агентом Zabbix 2 и MQTT broker. <SessionName> - задает имя сессии для использования в ключах элементов данных. |
||
| Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile | no | Полный путь к файлу, содержащему закрытый ключ MQTT, используемый для зашифрованной связи между агентом Zabbix 2 и MQTT broker. <SessionName> - задает имя сессии для использования в ключах элементов данных. |
||
| Plugins.MQTT.Sessions.<SessionName>.Topic | no | Тема именованной сессии для подписки MQTT. <SessionName> - задает имя сессии для использования в ключах элементов данных. Тема может содержать подстановочные знаки ("+","#") Примеры: path/to/filepath/to/#path/+/topic |
||
| Plugins.MQTT.Sessions.<SessionName>.Url | no | Строка подключения именованной сессии. <SessionName> - задает имя сессии для использования в ключах элементов данных. Не должна содержать параметры запроса. Должна соответствовать формату URL. Поддерживаемые схемы: tcp (по умолчанию), ws, tls; схему можно опустить.Порт можно опустить (по умолчанию=1883). Примеры: tcp://host:1883localhostws://host:8080 |
||
| Plugins.MQTT.Sessions.<SessionName>.User | no | Имя пользователя именованной сессии. <SessionName> - задает имя сессии для использования в ключах элементов данных. |
Если нужно задать тайм-аут выполнения запроса (сколько ждать завершения запроса перед его остановкой), используйте форму настройки элемента данных.
См. также:
- Описание общих параметров конфигурации агента Zabbix 2: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- Инструкции по настройке плагинов