MQTT-Plugin

Übersicht

Konfigurationsparameter ermöglichen die Anpassung des Verhaltens des MQTT-Plugins.

Es wird empfohlen, sie in einer eigenen Konfigurationsdatei (z. B. mqtt.conf) anzugeben, statt in der Konfigurationsdatei von Agent 2. Verwenden Sie dann die Direktive Include, um diese Datei in die Konfiguration von Zabbix Agent 2 einzubinden.

Alle Parameter sind optional, sofern nicht ausdrücklich angegeben ist, dass der Parameter obligatorisch ist.

Beachten Sie:

  • Die Standardwerte spiegeln die Standardwerte des Prozesses wider, nicht die Werte in den mitgelieferten Konfigurationsdateien;
  • Werte unterstützen Umgebungsvariablen;
  • Zabbix unterstützt Konfigurationsdateien nur in UTF-8-Kodierung ohne BOM;
  • Kommentare, die mit "#" beginnen, werden nur am Anfang der Zeile unterstützt.

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

Parameter Mandatory Range Default Beschreibung
Plugins.MQTT.Default.Password no Standardpasswort für die Verbindung zu MQTT; wird verwendet, wenn kein Wert in einem item key oder einer benannten Sitzung angegeben ist.
Plugins.MQTT.Default.TLSCAFile no Vollständiger Pfadname einer Datei mit den Zertifikaten der obersten CA(s) zur Überprüfung des Peer-Zertifikats für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und dem MQTT-Broker; wird verwendet, wenn kein Wert in einer benannten Sitzung angegeben ist.
Plugins.MQTT.Default.TLSCertFile no Vollständiger Pfadname einer Datei mit dem Agent-Zertifikat oder der Zertifikatskette für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und dem MQTT-Broker; wird verwendet, wenn kein Wert in einer benannten Sitzung angegeben ist.
Plugins.MQTT.Default.TLSKeyFile no Vollständiger Pfadname einer Datei mit dem privaten MQTT-Schlüssel für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und dem MQTT-Broker; wird verwendet, wenn kein Wert in einer benannten Sitzung angegeben ist.
Plugins.MQTT.Default.Topic no Standard-Topic für das MQTT-Subscription; wird verwendet, wenn kein Wert in einem item key oder einer benannten Sitzung angegeben ist.

Das Topic kann Platzhalter ("+","#") enthalten.
Beispiele: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url no tcp://localhost:1883 Standard-Verbindungszeichenfolge für den MQTT-Broker; wird verwendet, wenn kein Wert in einem item key oder einer benannten Sitzung angegeben ist.

Sollte keine Query-Parameter enthalten.
Muss dem URL-Format entsprechen.
Unterstützte Schemas: tcp (Standard), ws, tls; ein Schema kann weggelassen werden.
Ein Port kann weggelassen werden (Standard=1883).
Beispiele: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User no Standardbenutzername für die Verbindung zu MQTT; wird verwendet, wenn kein Wert in einem item key oder einer benannten Sitzung angegeben ist.
Plugins.MQTT.Sessions.<SessionName>.Password no Passwort der benannten Sitzung.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile no Vollständiger Pfadname einer Datei mit den Zertifikaten der obersten CA(s) zur Überprüfung des Peer-Zertifikats, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und dem MQTT-Broker.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile no Vollständiger Pfadname einer Datei mit dem Agent-Zertifikat oder der Zertifikatskette, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und dem MQTT-Broker.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile no Vollständiger Pfadname einer Datei mit dem privaten MQTT-Schlüssel, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und dem MQTT-Broker.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.
Plugins.MQTT.Sessions.<SessionName>.Topic no Topic der benannten Sitzung für das MQTT-Subscription.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.

Das Topic kann Platzhalter ("+","#") enthalten.
Beispiele: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url no Verbindungszeichenfolge einer benannten Sitzung.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.

Sollte keine Query-Parameter enthalten.
Muss dem URL-Format entsprechen.
Unterstützte Schemas: tcp (Standard), ws, tls; ein Schema kann weggelassen werden.
Ein Port kann weggelassen werden (Standard=1883).
Beispiele: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User no Benutzername der benannten Sitzung.
<SessionName> - Name einer Sitzung, die in item keys verwendet wird.

Wenn Sie das Timeout für die Ausführung einer Anfrage festlegen müssen (wie lange gewartet werden soll, bis eine Anfrage abgeschlossen ist, bevor sie beendet wird), verwenden Sie das Formular item configuration.

Siehe auch: