Objet proxy

Les objets suivants sont directement liés à l'API proxy.

Proxy

L’objet proxy possède les propriétés suivantes.

Property Type Description
proxyid ID ID du proxy.

Comportement de la propriété :
- en lecture seule
- obligatoire pour les opérations de mise à jour
name string Nom du proxy.

Comportement de la propriété :
- obligatoire pour les opérations de création
proxy_groupid ID ID du groupe de proxys.

0 - le proxy n’est affecté à aucun groupe de proxys.
local_address string Adresse pour les agents actifs. Adresse IP ou nom DNS auquel se connecter.

Comportement de la propriété :
- obligatoire si proxy_groupid n’est pas égal à 0
local_port string Numéro de port local du proxy auquel se connecter.

Les macros utilisateur sont prises en charge.

Valeur par défaut : 10051.

Comportement de la propriété :
- pris en charge si proxy_groupid n’est pas égal à 0
operating_mode integer Type de proxy.

Valeurs possibles :
0 - proxy actif ;
1 - proxy passif.

Comportement de la propriété :
- obligatoire pour les opérations de création
description text Description du proxy.
lastaccess timestamp Heure à laquelle le proxy s’est connecté pour la dernière fois au serveur.

Comportement de la propriété :
- en lecture seule
address string Adresse IP ou nom DNS auquel se connecter.

Les macros utilisateur sont prises en charge.

Comportement de la propriété :
- obligatoire si le mode de fonctionnement du proxy Zabbix est passif
port string Numéro de port auquel se connecter.

Les macros utilisateur sont prises en charge.

Valeur par défaut : 10051.

Comportement de la propriété :
- pris en charge si le mode de fonctionnement du proxy Zabbix est passif
allowed_addresses string Adresses IP ou noms DNS, séparés par des virgules, du proxy Zabbix actif.
tls_connect integer Connexions au proxy.

Valeurs possibles :
1 - (par défaut) aucune chiffrement ;
2 - PSK ;
4 - certificat.
tls_accept integer Connexions depuis le proxy.

Valeurs bitmap possibles :
1 - (par défaut) aucune chiffrement ;
2 - PSK ;
4 - certificat.

Il s’agit d’un champ de masque de bits ; toute somme de valeurs bitmap possibles est acceptée (par exemple, 6 pour PSK et certificat).
tls_issuer string Émetteur du certificat.
tls_subject string Sujet du certificat.
tls_psk_identity string Identité PSK ; doit être associée à une seule PSK (parmi l’enregistrement automatique, les hôtes et les proxys).

N’incluez pas d’informations sensibles dans l’identité PSK, car celle-ci est envoyée sans chiffrement sur le réseau afin d’indiquer au destinataire quelle PSK utiliser.

Comportement de la propriété :
- en écriture seule
- obligatoire si tls_connect est défini sur « PSK » ou si tls_accept contient le bit « PSK »
tls_psk string Clé prépartagée (PSK) ; doit comporter au moins 32 chiffres hexadécimaux.

Comportement de la propriété :
- en écriture seule
- obligatoire si tls_connect est défini sur « PSK » ou si tls_accept contient le bit « PSK »
custom_timeouts integer Indique s’il faut remplacer les délais d’expiration globaux des éléments au niveau du proxy.

Valeurs possibles :
0 - (par défaut) utiliser les paramètres globaux ;
1 - remplacer les délais d’expiration.
timeout_zabbix_agent string Ne pas consacrer plus de timeout_* secondes au traitement.
Accepte un nombre de secondes (par exemple, 1, 60, 300) ou une valeur avec un suffixe de temps (par exemple, 30s, 1m). Les macros utilisateur sont également acceptées.
Utilisé uniquement si custom_timeouts est défini sur « remplacer les délais d’expiration » ; sinon, la valeur est ignorée.

Plage de valeurs possibles : 1-600 s.

Comportement de la propriété :
- obligatoire si custom_timeouts est défini sur « remplacer les délais d’expiration »
timeout_simple_check
timeout_snmp_agent
timeout_external_check
timeout_db_monitor
timeout_http_agent
timeout_ssh_agent
timeout_telnet_agent
timeout_script
timeout_browser
timeout_telemetry_query
version integer Version du proxy.

Numéro de version Zabbix en trois parties, où deux chiffres décimaux sont utilisés pour chaque partie, par exemple 60401 pour la version 6.4.1, 70002 pour la version 7.0.2, etc.
0 - Version du proxy inconnue.

Comportement de la propriété :
- en lecture seule
compatibility integer Version du proxy comparée à celle du serveur Zabbix.

Valeurs possibles :
0 - Non définie ;
1 - Version actuelle (le proxy et le serveur ont la même version majeure) ;
2 - Version obsolète (la version du proxy est antérieure à celle du serveur, mais elle est partiellement prise en charge) ;
3 - Version non prise en charge (la version du proxy est antérieure à la version de la précédente version LTS du serveur ou la version majeure du serveur est antérieure à celle du proxy).

Comportement de la propriété :
- en lecture seule
state integer État du proxy.

Valeurs possibles :
0 - Inconnu ;
1 - Hors ligne ;
2 - En ligne.

Comportement de la propriété :
- en lecture seule

Supervision des performances des applications (APM)

L’objet APM possède les propriétés suivantes.

Property Type Description
data_collection_status integer Indique si la collecte des données de télémétrie est activée sur le proxy.

Valeurs possibles :
0 - (par défaut) Désactivée ;
1 - Activée.
max_messages_per_second integer Nombre maximal de messages par seconde que le proxy accepte.

Plage de valeurs possibles : 0 (illimité) – 2147483647.

Valeur par défaut : 0.

Comportement de la propriété :
- prise en charge si data_collection_status est défini sur « Enabled »
additional_resource_attributes array Tableau d’attributs de ressource à ajouter aux données de télémétrie entrantes.

Comportement de la propriété :
- prise en charge si data_collection_status est défini sur « Enabled »

Attributs de ressource

L'objet des attributs de ressource possède les propriétés suivantes.

Property Type Description
key string Nom de l'attribut de ressource.
Doit être unique pour le signal_type spécifié.

Comportement de la propriété :
- requis
value string Valeur de l'attribut de ressource.
Peut être vide.
signal_type integer Type de données de télémétrie auquel l'attribut s'applique.

Valeurs possibles :
0 - Traces ;
1 - Métriques ;
2 - Journaux.

Comportement de la propriété :
- requis