Parametri di configurazione: adattatore bridge di Zabbix

Panoramica

I parametri di configurazione consentono di personalizzare il comportamento dell'adattatore bridge di Zabbix.

Specificare i valori dei parametri nel file di configurazione (zabbix_bridge_adapter.conf). Tutti i parametri sono facoltativi, salvo quando viene esplicitamente indicato che il parametro è obbligatorio.

Questa pagina è strutturata come segue:

  • Panoramica dei parametri (per visualizzare tutti i dettagli di un parametro, fare clic sul suo nome)
  • Dettagli dei parametri
Parametro Descrizione
AllowedAPIMethods Specificare quali metodi API di Zabbix possono essere chiamati tramite l'adattatore bridge.
DataDir Specificare la directory in cui vengono creati e archiviati il file di stato dell'adattatore bridge e le chiavi di crittografia.
DebugLevel Impostare il livello di debug.
Include Specificare una directory o singoli file da includere nel file di configurazione.
ListenHealthPort Specificare la porta sulla quale restare in ascolto delle connessioni HTTP in ingresso per i controlli dello stato.
ListenIP Specificare l'indirizzo IP o il nome host sul quale restare in ascolto delle connessioni HTTP(S) in ingresso dal server Zabbix.
ListenPort Specificare la porta sulla quale restare in ascolto delle connessioni HTTP(S) in ingresso dal server Zabbix.
LogFile Specificare il file di log dell'adattatore bridge.
LogFileSize Impostare la dimensione massima del file di log (in MB).
LogType Specificare il tipo di output del log.
PidFile Specificare il file PID.
ServerId Specificare l'identificatore univoco del server Zabbix. Obbligatorio.
TLSConfig.AllowedCN Specificare un elenco separato da virgole dei Common Name client consentiti (solo mTLS).
TLSConfig.CAFile Specificare il percorso completo di un file contenente il certificato o i certificati CA di livello superiore utilizzati per verificare i certificati client in modalità mTLS.
TLSConfig.CertFile Specificare il percorso completo di un file contenente il certificato o la catena di certificati.
TLSConfig.KeyFile Specificare il percorso completo di un file contenente la chiave privata.
TLSConfig.Mode Impostare la modalità TLS per le connessioni in ingresso su ListenPort.
ZabbixAPITLSCAFile Specificare il percorso completo di un file contenente il certificato o i certificati CA di livello superiore utilizzati dall'adattatore bridge per verificare il certificato dell'API di Zabbix.
ZabbixAPITLSConnect Impostare la modalità TLS per le connessioni in uscita all'API di Zabbix.
ZabbixAPIURL Specificare l'URL dell'endpoint dell'API di Zabbix. Obbligatorio.
ZabbixBridgeURL Specificare l'URL di Zabbix Bridge per il recupero della configurazione di Zabbix Bridge (recuperata all'avvio dell'adattatore bridge).

Tenere presente quanto segue:

  • I valori predefiniti riflettono i valori predefiniti del processo, non i valori presenti nei file di configurazione forniti.
  • I valori supportano le variabili d'ambiente.
  • Zabbix supporta solo file di configurazione con codifica UTF-8 senza BOM.
  • I commenti che iniziano con # sono supportati solo all'inizio della riga.

Dettagli dei parametri

AllowedAPIMethods

Specifica quali metodi API di Zabbix possono essere chiamati tramite il bridge adapter.
Per più metodi, ripeti il parametro, specificando un metodo per riga.

Ogni valore del parametro deve essere un nome di metodo esatto (ad esempio, problem.get) oppure un modello con caratteri jolly che sostituisce solo l'intero nome dell'API (ad esempio, *.get) o l'intero nome del metodo (ad esempio, problem.*).

Qualsiasi altro valore non è valido e impedisce l'avvio del bridge adapter. Sono inclusi un carattere jolly isolato (*), un modello con carattere jolly parziale (host* o host*.*) oppure un valore vuoto (AllowedAPIMethods=).

Esempio:

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

L'insieme minimo di metodi richiesto dall'app mobile di 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

Predefinito: non impostato (tutti i metodi API di Zabbix sono negati)

DataDir

Specificare la directory in cui vengono creati e archiviati il file di stato dell'adattatore bridge e le chiavi di crittografia.
La directory deve esistere e avere permessi 0700; tutti i file archiviati al suo interno devono avere permessi 0600.

Predefinito: /var/lib/zabbix-bridge-adapter

DebugLevel

Imposta il livello di debug:

  • 0 - informazioni di base sull'avvio e l'arresto dei processi Zabbix
  • 1 - informazioni critiche
  • 2 - informazioni sugli errori
  • 3 - avvisi
  • 4 - per il debug (genera molte informazioni)
  • 5 - debug esteso (genera ancora più informazioni)

Predefinito: 3
Intervallo: 0-5

Include

Specificare una directory o singoli file da includere nel file di configurazione.
Durante l'installazione di Zabbix, questo parametro viene impostato su /etc/zabbix, a meno che non si modifichi tale impostazione durante la compilazione.

Regole generali per il parametro Include:

  • Il percorso può essere relativo alla posizione del file zabbix_bridge_adapter.conf.
  • È possibile specificare più parametri Include in un unico file di configurazione.
  • Zabbix elabora il parametro Include non appena lo legge; pertanto, è consigliabile inserirlo alla fine del file di configurazione.

Regole per i file inclusi:

  • Ogni file deve essere leggibile.
  • Ogni file deve avere una sintassi corretta. In caso contrario, il componente non verrà avviato.

Regole per l'inclusione di directory o pattern di file:

  • Non presumere alcun ordine di inclusione (ad esempio, i file non vengono inclusi in ordine alfabetico).
  • Non definire lo stesso parametro in più di un file incluso (ad esempio, per sovrascrivere un'impostazione generale con una specifica), poiché non è possibile prevedere quale valore verrà utilizzato.
  • Prestare attenzione alle copie di backup che alcuni editor di testo creano automaticamente (ad esempio, modificando include/my_specific.conf potrebbe essere creato include/my_specific.conf.BAK), poiché entrambi i file verranno inclusi.

Per includere solo i file rilevanti da una directory, utilizzare il carattere jolly (*) per la corrispondenza dei pattern.

Esempio:

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

Specificare la porta su cui ascoltare le connessioni HTTP in ingresso per i controlli dello stato.
Fornisce gli endpoint /health e /ready.
Se non specificata, il servizio di controllo dello stato non viene avviato.

Predefinito: 8081
Intervallo: 1024-32767

ListenIP

Specificare l'indirizzo IP o il nome host su cui ascoltare le connessioni HTTP(S) in entrata dal server Zabbix.
Se non specificato, l'adattatore bridge ascolta su tutti gli indirizzi IP disponibili del sistema locale.

ListenPort

Specificare la porta su cui restare in ascolto per le connessioni HTTP(S) in entrata dal server Zabbix.

Predefinito: 10054
Intervallo: 1024-32767

LogFile

Specificare il file di log dell'adattatore bridge.

Obbligatorio: Sì se LogType è impostato su file; altrimenti, no

Predefinito: /tmp/zabbix_bridge_adapter.log

LogFileSize

Imposta la dimensione massima del file di log (in MB).
0 - disabilita la rotazione automatica dei log.

Predefinito: 1
Intervallo: 0-1024

LogType

Specificare il tipo di output del log:

  • file - scrive il log nel file specificato dal parametro LogFile.
  • system - scrive il log nel syslog.
  • console - scrive il log sull'output standard.

Predefinito: file

PidFile

Specificare il file PID.

Predefinito: /tmp/zabbix_bridge_adapter.pid

ServerId

Specificare l'identificatore univoco del server Zabbix.
Disponibile in Report > Informazioni di sistema nell'interfaccia web di Zabbix.

Obbligatorio: Sì

TLSConfig.AllowedCN

Specificare un elenco separato da virgole dei Common Name dei client consentiti (solo mTLS).
Se non specificato, l'adattatore bridge non verifica il Common Name del client.

TLSConfig.CAFile

Specificare il percorso completo del file contenente i certificati CA principali utilizzati per verificare i certificati client in modalità mTLS.

TLSConfig.CertFile

Specificare il percorso completo del file contenente il certificato o la catena di certificati.

TLSConfig.KeyFile

Specificare il percorso completo del file contenente la chiave privata.

TLSConfig.Mode

Imposta la modalità TLS per le connessioni in ingresso su ListenPort:

  • none - accetta connessioni senza crittografia.
  • tls - TLS standard con v1.2 come versione minima.
  • mtls - estende TLS con autenticazione reciproca.

Predefinito: none

Vedi anche: TLS dal server Zabbix all'adattatore bridge Zabbix

ZabbixAPITLSCAFile

Specificare il percorso completo di un file contenente i certificati CA di livello superiore utilizzati dall'adattatore bridge per verificare il certificato dell'API Zabbix.

Obbligatorio: Sì se ZabbixAPITLSConnect è impostato su verify_ca o verify_full.

ZabbixAPITLSConnect

Imposta la modalità TLS per le connessioni in uscita all'API di Zabbix:

  • disabled - usa HTTP semplice; ZabbixAPIURL deve usare http://.
  • required - usa HTTPS senza verifica del certificato (solo per i test).
  • verify_ca - usa HTTPS e verifica il certificato dell'API di Zabbix.
  • verify_full - usa HTTPS e verifica il certificato e il nome host dell'API di Zabbix.

Un valore vuoto o non impostato viene trattato come required.

Predefinito: required

Vedere anche: TLS dall'adattatore bridge di Zabbix all'API di Zabbix

ZabbixAPIURL

Specificare l'URL dell'endpoint dell'API Zabbix.

Obbligatorio: Sì

Esempio:

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

Specificare l'URL di Zabbix Bridge per il recupero della configurazione di Zabbix Bridge (recuperata all'avvio dell'adattatore bridge).

Predefinito: ZabbixBridgeURL=https://config.mobilebridge.zabbix.com/.well-known/bridge-configuration