Plugin MQTT

Visão geral

Os parâmetros de configuração permitem personalizar o comportamento do plugin MQTT.

Recomenda-se especificá-los em seu próprio arquivo de configuração (por exemplo, mqtt.conf), em vez de no arquivo de configuração do agent 2. Em seguida, use a diretiva Include para incluir esse arquivo na configuração do Zabbix agent 2.

Todos os parâmetros são opcionais, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Observe que:

  • Os valores padrão refletem os padrões do processo, não os valores nos arquivos de configuração fornecidos;
  • Os valores suportam variáveis de ambiente;
  • O Zabbix suporta arquivos de configuração somente em codificação UTF-8, sem BOM;
  • Comentários que começam com "#" são suportados apenas no início da linha.

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 Senha padrão para conexão com MQTT; usada se nenhum valor for especificado em uma chave de item ou sessão nomeada.
Plugins.MQTT.Default.TLSCAFile no Caminho completo de um arquivo contendo os certificados da(s) CA(s) de nível superior para verificação do certificado do par em comunicações criptografadas entre o Zabbix agent 2 e o broker MQTT; usado se nenhum valor for especificado em uma sessão nomeada.
Plugins.MQTT.Default.TLSCertFile no Caminho completo de um arquivo contendo o certificado do agent ou a cadeia de certificados para comunicações criptografadas entre o Zabbix agent 2 e o broker MQTT; usado se nenhum valor for especificado em uma sessão nomeada.
Plugins.MQTT.Default.TLSKeyFile no Caminho completo de um arquivo contendo a chave privada do MQTT para comunicações criptografadas entre o Zabbix agent 2 e o broker MQTT; usado se nenhum valor for especificado em uma sessão nomeada.
Plugins.MQTT.Default.Topic no Tópico padrão para assinatura MQTT; usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.

O tópico pode conter curingas ("+","#")
Exemplos: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url no tcp://localhost:1883 String de conexão padrão do broker MQTT; usada se nenhum valor for especificado em uma chave de item ou sessão nomeada.

Não deve incluir parâmetros de consulta.
Deve corresponder ao formato de URL.
Esquemas suportados: tcp (padrão), ws, tls; um esquema pode ser omitido.
Uma porta pode ser omitida (padrão=1883).
Exemplos: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User no Nome de usuário padrão para conexão com MQTT; usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.
Plugins.MQTT.Sessions.<SessionName>.Password no Senha da sessão nomeada.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile no Caminho completo de um arquivo contendo os certificados da(s) CA(s) de nível superior para verificação do certificado do par, usado para comunicações criptografadas entre o Zabbix agent 2 e o broker MQTT.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile no Caminho completo de um arquivo contendo o certificado do agent ou a cadeia de certificados, usado para comunicações criptografadas entre o Zabbix agent 2 e o broker MQTT.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile no Caminho completo de um arquivo contendo a chave privada do MQTT usada para comunicações criptografadas entre o Zabbix agent 2 e o broker MQTT.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Plugins.MQTT.Sessions.<SessionName>.Topic no Tópico da sessão nomeada para assinatura MQTT.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

O tópico pode conter curingas ("+","#")
Exemplos: path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url no String de conexão de uma sessão nomeada.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

Não deve incluir parâmetros de consulta.
Deve corresponder ao formato de URL.
Esquemas suportados: tcp (padrão), ws, tls; um esquema pode ser omitido.
Uma porta pode ser omitida (padrão=1883).
Exemplos: tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User no Nome de usuário da sessão nomeada.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

Se você precisar definir o tempo limite de execução da solicitação (quanto tempo aguardar a conclusão de uma solicitação antes de encerrá-la), use o formulário de configuração do item.

Veja também: