Plugin MQTT

Vue d'ensemble

Les paramètres de configuration permettent de personnaliser le comportement du plugin MQTT.

Il est recommandé de les spécifier dans leur propre fichier de configuration (par exemple mqtt.conf), plutôt que dans le fichier de configuration de l'agent 2. Utilisez ensuite la directive Include pour inclure ce fichier dans la configuration de Zabbix agent 2.

Tous les paramètres sont facultatifs, sauf indication explicite précisant que le paramètre est obligatoire.

Notez que :

  • Les valeurs par défaut reflètent les valeurs par défaut du processus, et non celles des fichiers de configuration fournis ;
  • Les valeurs prennent en charge les variables d'environnement ;
  • Zabbix prend en charge les fichiers de configuration uniquement en encodage UTF-8, sans BOM ;
  • Les commentaires commençant par "#" ne sont pris en charge qu'au début de la ligne.

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.

Paramètres

Parameter Mandatory Range Default Description
Plugins.MQTT.Default.Password no Mot de passe par défaut pour la connexion à MQTT ; utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.
Plugins.MQTT.Default.TLSCAFile no Chemin complet d'un fichier contenant les certificats des AC de niveau supérieur pour la vérification du certificat du pair, utilisé pour les communications chiffrées entre Zabbix agent 2 et le broker MQTT ; utilisé si aucune valeur n'est spécifiée dans une session nommée.
Plugins.MQTT.Default.TLSCertFile no Chemin complet d'un fichier contenant le certificat de l'agent ou la chaîne de certificats pour les communications chiffrées entre Zabbix agent 2 et le broker MQTT ; utilisé si aucune valeur n'est spécifiée dans une session nommée.
Plugins.MQTT.Default.TLSKeyFile no Chemin complet d'un fichier contenant la clé privée MQTT pour les communications chiffrées entre Zabbix agent 2 et le broker MQTT ; utilisé si aucune valeur n'est spécifiée dans une session nommée.
Plugins.MQTT.Default.Topic no Sujet MQTT par défaut pour l'abonnement ; utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.

Le sujet peut contenir des caractères génériques ("+","#")
Exemples : path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url no tcp://localhost:1883 Chaîne de connexion par défaut au broker MQTT ; utilisée si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.

Ne doit pas inclure de paramètres de requête.
Doit correspondre au format d'URL.
Schémas pris en charge : tcp (par défaut), ws, tls ; un schéma peut être omis.
Un port peut être omis (par défaut=1883).
Exemples : tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User no Nom d'utilisateur par défaut pour la connexion à MQTT ; utilisé si aucune valeur n'est spécifiée dans une clé d'élément ou une session nommée.
Plugins.MQTT.Sessions.<SessionName>.Password no Mot de passe de la session nommée.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile no Chemin complet d'un fichier contenant les certificats des AC de niveau supérieur pour la vérification du certificat du pair, utilisé pour les communications chiffrées entre Zabbix agent 2 et le broker MQTT.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile no Chemin complet d'un fichier contenant le certificat de l'agent ou la chaîne de certificats, utilisé pour les communications chiffrées entre Zabbix agent 2 et le broker MQTT.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile no Chemin complet d'un fichier contenant la clé privée MQTT utilisée pour les communications chiffrées entre Zabbix agent 2 et le broker MQTT.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.
Plugins.MQTT.Sessions.<SessionName>.Topic no Sujet de la session nommée pour l'abonnement MQTT.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Le sujet peut contenir des caractères génériques ("+","#")
Exemples : path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url no Chaîne de connexion d'une session nommée.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Ne doit pas inclure de paramètres de requête.
Doit correspondre au format d'URL.
Schémas pris en charge : tcp (par défaut), ws, tls ; un schéma peut être omis.
Un port peut être omis (par défaut=1883).
Exemples : tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User no Nom d'utilisateur de la session nommée.
<SessionName> - définit le nom d'une session à utiliser dans les clés d'élément.

Si vous devez définir le délai d'attente d'exécution de la requête (durée d'attente avant l'arrêt d'une requête), utilisez le formulaire de configuration de l'élément.

Voir aussi :