Plugin MQTT

Panoramica

I parametri di configurazione consentono di personalizzare il comportamento del plugin MQTT.

Si consiglia di specificarli in un file di configurazione separato (ad esempio mqtt.conf), anziché nel file di configurazione di agent 2. Quindi usare la direttiva Include per includere questo file nella configurazione di Zabbix agent 2.

Tutti i parametri sono opzionali, a meno che non sia esplicitamente indicato che il parametro è obbligatorio.

Nota che:

  • I valori predefiniti riflettono i valori predefiniti del processo, non i valori presenti nei file di configurazione distribuiti;
  • I valori supportano variabili di ambiente;
  • Zabbix supporta i file di configurazione solo in codifica UTF-8 senza BOM;
  • I commenti che iniziano con "#" sono supportati solo all'inizio della riga.

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.

Parametri

Parameter Mandatory Range Default Description
Plugins.MQTT.Default.Password no Password predefinita per la connessione a MQTT; usata se non è specificato alcun valore in una chiave item o in una sessione denominata.
Plugins.MQTT.Default.TLSCAFile no Percorso completo di un file contenente i certificati della CA di livello superiore per la verifica del certificato del peer nelle comunicazioni crittografate tra Zabbix agent 2 e il broker MQTT; usato se non è specificato alcun valore in una sessione denominata.
Plugins.MQTT.Default.TLSCertFile no Percorso completo di un file contenente il certificato dell'agent o la catena di certificati per le comunicazioni crittografate tra Zabbix agent 2 e il broker MQTT; usato se non è specificato alcun valore in una sessione denominata.
Plugins.MQTT.Default.TLSKeyFile no Percorso completo di un file contenente la chiave privata MQTT per le comunicazioni crittografate tra Zabbix agent 2 e il broker MQTT; usato se non è specificato alcun valore in una sessione denominata.
Plugins.MQTT.Default.Topic no Topic predefinito per la sottoscrizione MQTT; usato se non è specificato alcun valore in una chiave item o in una sessione denominata.

Il topic può contenere caratteri jolly ("+","#")
Esempi: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url no tcp://localhost:1883 Stringa di connessione predefinita al broker MQTT; usata se non è specificato alcun valore in una chiave item o in una sessione denominata.

Non deve includere parametri di query.
Deve corrispondere al formato URL.
Schemi supportati: tcp (predefinito), ws, tls; lo schema può essere omesso.
La porta può essere omessa (predefinita=1883).
Esempi: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User no Nome utente predefinito per la connessione a MQTT; usato se non è specificato alcun valore in una chiave item o in una sessione denominata.
Plugins.MQTT.Sessions.<SessionName>.Password no Password della sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile no Percorso completo di un file contenente i certificati della CA di livello superiore per la verifica del certificato del peer, usato per le comunicazioni crittografate tra Zabbix agent 2 e il broker MQTT.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile no Percorso completo di un file contenente il certificato dell'agent o la catena di certificati, usato per le comunicazioni crittografate tra Zabbix agent 2 e il broker MQTT.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile no Percorso completo di un file contenente la chiave privata MQTT usata per le comunicazioni crittografate tra Zabbix agent 2 e il broker MQTT.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.
Plugins.MQTT.Sessions.<SessionName>.Topic no Topic della sessione denominata per la sottoscrizione MQTT.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.

Il topic può contenere caratteri jolly ("+","#")
Esempi: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url no Stringa di connessione di una sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.

Non deve includere parametri di query.
Deve corrispondere al formato URL.
Schemi supportati: tcp (predefinito), ws, tls; lo schema può essere omesso.
La porta può essere omessa (predefinita=1883).
Esempi: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User no Nome utente della sessione denominata.
<SessionName> - definisce il nome di una sessione da usare nelle chiavi item.

Se è necessario impostare il timeout di esecuzione della richiesta (quanto tempo attendere il completamento di una richiesta prima di interromperla), usare il modulo configurazione item.

Vedi anche: