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
| Parâmetro | Descrição |
|---|---|
| AllowedAPIMethods | Especifique quais métodos da API do Zabbix podem ser chamados por meio do adaptador de bridge. |
| DataDir | Especifique o diretório onde o arquivo de estado do adaptador de bridge e as chaves de criptografia são criados e armazenados. |
| DebugLevel | Defina o nível de depuração. |
| Include | Especifique um diretório ou arquivos individuais a serem incluídos no arquivo de configuração. |
| ListenHealthPort | Especifique a porta na qual serão aguardadas conexões HTTP de verificação de integridade recebidas. |
| ListenIP | Especifique o endereço IP ou o nome do host no qual serão aguardadas conexões HTTP(S) recebidas do server do Zabbix. |
| ListenPort | Especifique a porta na qual serão aguardadas conexões HTTP(S) recebidas do server do Zabbix. |
| LogFile | Especifique o arquivo de log do adaptador de bridge. |
| LogFileSize | Defina o tamanho máximo do arquivo de log (em MB). |
| LogType | Especifique o tipo de saída do log. |
| PidFile | Especifique o arquivo PID. |
| ServerId | Especifique o identificador exclusivo do server do Zabbix. Obrigatório. |
| TLSConfig.AllowedCN | Especifique uma lista separada por vírgulas dos Common Names permitidos do cliente (somente mTLS). |
| TLSConfig.CAFile | Especifique o caminho completo para um arquivo que contenha o(s) certificado(s) da CA de nível superior usado(s) para verificar os certificados do 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 recebidas em ListenPort. |
| ZabbixAPITLSCAFile | Especifique o nome de caminho completo de um arquivo que contenha o(s) certificado(s) da CA de nível superior usado(s) pelo adaptador de bridge para verificar o certificado da API do Zabbix. |
| ZabbixAPITLSConnect | Defina o modo TLS para conexões de saída com a API do Zabbix. |
| ZabbixAPIURL | Especifique a URL do endpoint da API do Zabbix. Obrigatório. |
| ZabbixBridgeURL | Especifique a URL do Zabbix Bridge para a recuperação da configuração do Zabbix Bridge (recuperada quando o adaptador de bridge é iniciado). |
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 bridge adapter.
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 bridge adapter.
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 de bridge e as chaves de criptografia são criados e armazenados.
O diretório deve existir e 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 Zabbix1- informações críticas2- informações de erro3- avisos4- 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 /etc/zabbix, a menos que você altere essa configuraçã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
Includeem um único arquivo de configuração. - O Zabbix processa o parâmetro
Includeassim 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.confpode criarinclude/my_specific.conf.BAK), pois ambos os arquivos serão incluídos.
Para incluir apenas 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
ListenHealthPort
Especifique a porta na qual escutar 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
ListenIP
Especifique o endereço IP ou o nome do host no qual escutar conexões HTTP(S) recebidas do Zabbix server.
Se não for especificado, o adaptador de bridge escutará em todos os endereços IP disponíveis do sistema local.
ListenPort
Especifique a porta na qual o proxy deve escutar conexões HTTP(S) de entrada do Zabbix server.
Padrão: 10054
Intervalo: 1024-32767
LogFile
Especifique o arquivo de log do adaptador de bridge.
Obrigatório: Sim se LogType estiver definido como file; caso contrário, não
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âmetroLogFile.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 no web frontend 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 for especificado, o adaptador bridge não verificará 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
Veja também: TLS do Zabbix server para o adaptador de ponte do Zabbix
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- usa HTTP simples;ZabbixAPIURLdeve usarhttp://.required- usa HTTPS sem verificação do certificado (somente para testes).verify_ca- usa HTTPS e verifica o certificado da API do Zabbix.verify_full- usa HTTPS e verifica o certificado e o nome do host da API do Zabbix.
Um valor vazio ou não definido é tratado como required.
Padrão: required
Veja também: TLS do adaptador de ponte do Zabbix para a 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 recuperar a configuração do Zabbix Bridge (recuperada quando o adaptador do bridge é iniciado).
Padrão: ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration