Complemento MQTT

Resumen

Los parámetros de configuración permiten personalizar el comportamiento del plugin MQTT.

Se recomienda especificarlos en su propio archivo de configuración (por ejemplo, mqtt.conf), en lugar de en el archivo de configuración de agent 2. Luego, use la directiva Include para incluir este archivo en la configuración de Zabbix agent 2.

Todos los parámetros son opcionales, salvo que se indique explícitamente que el parámetro es obligatorio.

Tenga en cuenta que:

  • Los valores predeterminados reflejan los valores predeterminados del proceso, no los valores de los archivos de configuración suministrados;
  • Los valores admiten variables de entorno;
  • Zabbix solo admite archivos de configuración en codificación UTF-8 sin BOM;
  • Los comentarios que comienzan con "#" solo se admiten al principio de la línea.

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.

Parámetros

Parameter Mandatory Range Default Description
Plugins.MQTT.Default.Password no Contraseña predeterminada para conectarse a MQTT; se usa si no se especifica ningún valor en una clave de item o en una sesión con nombre.
Plugins.MQTT.Default.TLSCAFile no Ruta completa de un archivo que contiene los certificados de la CA de nivel superior para la verificación del certificado del par en comunicaciones cifradas entre Zabbix agent 2 y el broker MQTT; se usa si no se especifica ningún valor en una sesión con nombre.
Plugins.MQTT.Default.TLSCertFile no Ruta completa de un archivo que contiene el certificado del agent o la cadena de certificados para comunicaciones cifradas entre Zabbix agent 2 y el broker MQTT; se usa si no se especifica ningún valor en una sesión con nombre.
Plugins.MQTT.Default.TLSKeyFile no Ruta completa de un archivo que contiene la clave privada de MQTT para comunicaciones cifradas entre Zabbix agent 2 y el broker MQTT; se usa si no se especifica ningún valor en una sesión con nombre.
Plugins.MQTT.Default.Topic no Tema predeterminado para la suscripción MQTT; se usa si no se especifica ningún valor en una clave de item o en una sesión con nombre.

El tema puede contener comodines ("+","#")
Ejemplos: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url no tcp://localhost:1883 Cadena de conexión predeterminada del broker MQTT; se usa si no se especifica ningún valor en una clave de item o en una sesión con nombre.

No debe incluir parámetros de consulta.
Debe coincidir con el formato de URL.
Esquemas admitidos: tcp (predeterminado), ws, tls; se puede omitir un esquema.
Se puede omitir un puerto (predeterminado=1883).
Ejemplos: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User no Nombre de usuario predeterminado para conectarse a MQTT; se usa si no se especifica ningún valor en una clave de item o en una sesión con nombre.
Plugins.MQTT.Sessions.<SessionName>.Password no Contraseña de la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile no Ruta completa de un archivo que contiene los certificados de la CA de nivel superior para la verificación del certificado del par, usado para comunicaciones cifradas entre Zabbix agent 2 y el broker MQTT.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile no Ruta completa de un archivo que contiene el certificado del agent o la cadena de certificados, usado para comunicaciones cifradas entre Zabbix agent 2 y el broker MQTT.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile no Ruta completa de un archivo que contiene la clave privada de MQTT, usada para comunicaciones cifradas entre Zabbix agent 2 y el broker MQTT.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.
Plugins.MQTT.Sessions.<SessionName>.Topic no Tema de la sesión con nombre para la suscripción MQTT.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

El tema puede contener comodines ("+","#")
Ejemplos: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url no Cadena de conexión de una sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

No debe incluir parámetros de consulta.
Debe coincidir con el formato de URL.
Esquemas admitidos: tcp (predeterminado), ws, tls; se puede omitir un esquema.
Se puede omitir un puerto (predeterminado=1883).
Ejemplos: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User no Nombre de usuario de la sesión con nombre.
<SessionName> - define el nombre de una sesión para usarlo en las claves de item.

Si necesita establecer el tiempo de espera de ejecución de la solicitud (cuánto tiempo esperar a que una solicitud se complete antes de detenerla), use el formulario de configuración de item.

Véase también: