Parâmetros de configuração: adaptador de bridge do Zabbix

Visão geral

Os parâmetros de configuração permitem personalizar o comportamento do adaptador de bridge do Zabbix.

Especifique os valores dos parâmetros no arquivo de configuração (zabbix_bridge_adapter.conf). Todos os parâmetros são opcionais, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Esta página está estruturada da seguinte forma:

• Visão geral dos parâmetros (para ver os detalhes completos de um parâmetro, clique no nome dele)
• Detalhes dos parâmetros

Observe que:

• Os valores padrão refletem os padrões do processo, não os valores dos arquivos de configuração fornecidos.
• Os valores são compatíveis com variáveis de ambiente.
• O Zabbix oferece suporte apenas a arquivos de configuração codificados em UTF-8 sem BOM;
• Comentários iniciados com # são compatíveis somente no início da linha.

Detalhes dos parâmetros

AllowedAPIMethods

Especifique quais métodos da API do Zabbix podem ser chamados por meio do adaptador Zabbix bridge.
Para vários métodos, repita o parâmetro, um método por linha.

Cada valor do parâmetro deve ser um nome de método exato (por exemplo, problem.get) ou um padrão curinga que substitua apenas o nome completo da API (por exemplo, *.get) ou o nome completo do método (por exemplo, problem.*).

Qualquer outro valor é inválido e impede a inicialização do adaptador Zabbix bridge. Isso inclui um curinga isolado (*), um padrão curinga parcial (host* ou host*.*) ou um valor vazio (AllowedAPIMethods=).

Exemplo:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=problem.*
AllowedAPIMethods=*.get

O conjunto mínimo de métodos exigido pelo aplicativo móvel do Zabbix:

AllowedAPIMethods=apiinfo.version
AllowedAPIMethods=device.onboard
AllowedAPIMethods=device.offboard
AllowedAPIMethods=user.get
AllowedAPIMethods=role.get
AllowedAPIMethods=problem.get
AllowedAPIMethods=event.get
AllowedAPIMethods=event.acknowledge
AllowedAPIMethods=trigger.get
AllowedAPIMethods=alert.get
AllowedAPIMethods=host.get
AllowedAPIMethods=hostgroup.get

Padrão: não definido (todos os métodos da API do Zabbix são negados)

DataDir

Especifique o diretório onde o arquivo de estado do adaptador bridge e as chaves de criptografia são criados e armazenados.
O diretório deve ter permissões 0700, e todos os arquivos armazenados nele devem ter permissões 0600.

Padrão: /var/lib/zabbix-bridge-adapter

DebugLevel

Defina o nível de depuração:

• 0 - informações básicas sobre a inicialização e a interrupção dos processos do Zabbix
• 1 - informações críticas
• 2 - informações de erro
• 3 - avisos
• 4 - para depuração (gera muitas informações)
• 5 - depuração estendida (gera ainda mais informações)

Padrão: 3
Intervalo: 0-5

Incluir

Especifique um diretório ou arquivos individuais a serem incluídos no arquivo de configuração.
Durante a instalação do Zabbix, esse parâmetro é definido como /usr/local/etc, a menos que você altere essa definição durante a compilação.

Regras gerais para o parâmetro Include:

• O caminho pode ser relativo ao local do arquivo zabbix_bridge_adapter.conf.
• Você pode especificar vários parâmetros Include em um único arquivo de configuração.
• O Zabbix processa o parâmetro Include assim que o lê. Portanto, considere colocá-lo no final do arquivo de configuração.

Regras para arquivos incluídos:

• Cada arquivo deve ser legível.
• Cada arquivo deve ter a sintaxe correta. Caso contrário, o componente não será iniciado.

Regras para incluir diretórios ou padrões de arquivos:

• Não presuma nenhuma ordem de inclusão (por exemplo, os arquivos não são incluídos em ordem alfabética).
• Não defina o mesmo parâmetro em mais de um arquivo incluído (por exemplo, para substituir uma configuração geral por uma específica), pois não é possível prever qual valor será usado.
• Fique atento às cópias de backup que alguns editores de texto criam automaticamente (por exemplo, editar include/my_specific.conf pode criar include/my_specific.conf.BAK), pois ambos os arquivos serão incluídos.

Para incluir somente os arquivos relevantes de um diretório, use o caractere curinga (*) para correspondência de padrões.

Exemplo:

Include=/absolute/path/to/config/files/*.conf

ListenIP

Especifique o endereço IP de escuta do adaptador de bridge para conexões HTTP[S] recebidas do Zabbix server.
Se não for especificado, o adaptador de bridge escutará em todos os endereços IP.

ListenHealthPort

Especifique a porta de escuta do adaptador de bridge para conexões HTTP de verificação de integridade recebidas.
Disponibiliza os endpoints /health e /ready.
Se não for especificada, o serviço de integridade não será iniciado.

Padrão: 8081
Intervalo: 1024-32767

ListenPort

Especifique a porta de escuta do adaptador bridge para conexões HTTP[S] de entrada do Zabbix server.

Padrão: 10005
Intervalo: 1024-32767

LogFile

Especifique o caminho completo para o arquivo de log do adaptador de bridge.

Obrigatório: Sim se LogType estiver definido como file

Padrão: /tmp/zabbix_bridge_adapter.log

LogFileSize

Defina o tamanho máximo do arquivo de log (em MB).
0 - desabilita a rotação automática de logs.

Padrão: 1
Intervalo: 0-1024

LogType

Especifique o tipo de saída do log:

• file - grava o log no arquivo especificado pelo parâmetro LogFile.
• system - grava o log no syslog.
• console - grava o log na saída padrão.

Padrão: file

PidFile

Especifique o arquivo PID.

Padrão: /tmp/zabbix_bridge_adapter.pid

ServerId

Especifique o identificador exclusivo do Zabbix server.
Disponível em Relatórios > Informações do sistema na interface de usuário do Zabbix.

Obrigatório: Sim

TLSConfig.AllowedCN

Especifique uma lista separada por vírgulas de Common Names de clientes permitidos (somente mTLS).
Se não especificado, o adaptador de bridge não verifica o Common Name do cliente.

TLSConfig.CAFile

Especifique o caminho completo para um arquivo que contenha o(s) certificado(s) de CA de nível superior usado(s) para verificar certificados de cliente no modo mTLS.

TLSConfig.CertFile

Especifique o caminho completo para um arquivo que contenha o certificado ou a cadeia de certificados.

TLSConfig.KeyFile

Especifique o caminho completo para um arquivo que contenha a chave privada.

TLSConfig.Mode

Defina o modo TLS para conexões de entrada em ListenPort:

• none - aceita conexões sem criptografia.
• tls - TLS padrão com v1.2 como versão mínima.
• mtls - estende o TLS com autenticação mútua.

Padrão: none

ZabbixAPITLSCAFile

Especifique o caminho completo de um arquivo que contenha o(s) certificado(s) de CA de nível superior usado(s) pelo adaptador de bridge para verificar o certificado da API do Zabbix.

Obrigatório: Sim se ZabbixAPITLSConnect estiver definido como verify_ca ou verify_full.

ZabbixAPITLSConnect

Defina o modo TLS para conexões de saída com a API do Zabbix:

• disabled (ou vazio) - use HTTP simples; ZabbixAPIURL deve usar http://.
• required - use HTTPS sem verificação do certificado (somente para testes).
• verify_ca - use HTTPS e verifique o certificado da API do Zabbix.
• verify_full - use HTTPS e verifique o certificado e o nome do host da API do Zabbix.

ZabbixAPIURL

Especifique a URL do endpoint da API do Zabbix.

Obrigatório: Sim

Exemplo:

ZabbixAPIURL=https://example.com/zabbix/api_jsonrpc.php

ZabbixBridgeURL

Especifique a URL do Zabbix Bridge para a recuperação da configuração do Zabbix Bridge (recuperada quando o adaptador do bridge é iniciado).

Padrão: ZabbixBridgeURL=https://test.aws.zabbix-lab.win/.well-known/bridge-configuration