Objet prototype d’élément

Les objets suivants sont directement liés à l’API itemprototype.

Prototype d'élément

L'objet prototype d'élément possède les propriétés suivantes.

Property Type Description
itemid ID ID du prototype d'élément.

Comportement de la propriété :
- en lecture seule
- obligatoire pour les opérations de mise à jour
delay string Intervalle de mise à jour du prototype d'élément.

Accepte un nombre de secondes (par ex. 1, 60, 300), une valeur avec un suffixe temporel (par ex. 30s, 1m, 2h, 1d) ou, éventuellement, un ou plusieurs intervalles personnalisés, tous séparés par des points-virgules. Les intervalles personnalisés peuvent combiner des intervalles flexibles et des intervalles de planification.

Accepte les macros utilisateur et les macros LLD. Si elle est utilisée, la valeur doit être une macro unique. Plusieurs macros ou des macros combinées à du texte ne sont pas pris en charge. Les intervalles flexibles peuvent être écrits sous la forme de deux macros séparées par une barre oblique (par ex. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).

Exemple :
1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}

Comportement de la propriété :
- obligatoire si type est défini sur « Zabbix agent » (0), « Simple check » (3), « Zabbix internal » (5), « External check » (10), « Database monitor » (11), « IPMI agent » (12), « SSH agent » (13), « TELNET agent » (14), « Calculated » (15), « JMX agent » (16), « HTTP agent » (19), « SNMP agent » (20), « Script » (21), « Browser » (22), ou si type est défini sur « Zabbix agent (active) » (7) et que key_ ne contient pas « mqtt.get »
hostid ID ID du hôte auquel appartient le prototype d'élément.

Comportement de la propriété :
- constant
- obligatoire pour les opérations de création
interfaceid ID ID de l'interface du hôte du prototype d'élément.

Comportement de la propriété :
- obligatoire si le prototype d'élément appartient à un hôte et que type est défini sur « Zabbix agent », « IPMI agent », « JMX agent », « SNMP trap » ou « SNMP agent »
- pris en charge si le prototype d'élément appartient à un hôte et que type est défini sur « Simple check », « External check », « SSH agent », « TELNET agent » ou « HTTP agent »
key_ string Clé du prototype d'élément.

Comportement de la propriété :
- obligatoire pour les opérations de création
- en lecture seule pour les objets hérités
name string Nom du prototype d'élément.
Prend en charge les macros utilisateur.

Comportement de la propriété :
- obligatoire pour les opérations de création
- en lecture seule pour les objets hérités
type integer Type du prototype d'élément.

Valeurs possibles :
0 - Zabbix agent ;
2 - Zabbix trapper ;
3 - Simple check ;
5 - Zabbix internal ;
7 - Zabbix agent (active) ;
10 - External check ;
11 - Database monitor ;
12 - IPMI agent ;
13 - SSH agent ;
14 - TELNET agent ;
15 - Calculated ;
16 - JMX agent ;
17 - SNMP trap ;
18 - Dependent item ;
19 - HTTP agent ;
20 - SNMP agent ;
21 - Script ;
22 - Browser.

Comportement de la propriété :
- obligatoire pour les opérations de création
- en lecture seule pour les objets hérités
url string Chaîne URL.
Prend en charge les macros LLD, les macros utilisateur, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

Comportement de la propriété :
- obligatoire si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
value_type integer Type d'information du prototype d'élément.

Valeurs possibles :
0 - nombre décimal ;
1 - caractère ;
2 - journal ;
3 - nombre entier non signé ;
4 - texte ;
5 - binaire ;
6 - JSON.

Comportement de la propriété :
- obligatoire pour les opérations de création
- en lecture seule pour les objets hérités
allow_traps integer Autoriser le remplissage de la valeur comme pour l'élément trapper.

0 - (par défaut) Ne pas autoriser l'acceptation des données entrantes ;
1 - Autoriser l'acceptation des données entrantes.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
authtype integer Méthode d'authentification.

Valeurs possibles si type est défini sur « SSH agent » :
0 - (par défaut) mot de passe ;
1 - clé publique.

Valeurs possibles si type est défini sur « HTTP agent » :
0 - (par défaut) aucune ;
1 - basic ;
2 - NTLM ;
3 - Kerberos ;
4 - Digest.

Comportement de la propriété :
- pris en charge si type est défini sur « SSH agent » ou « HTTP agent »
- en lecture seule pour les objets hérités (si type est défini sur « HTTP agent »)
description string Description du prototype d'élément.
flags integer Origine du prototype d'élément.

Valeurs possibles :
2 - un prototype d'élément ;
6 - un prototype d'élément découvert

Comportement de la propriété :
- en lecture seule
follow_redirects integer Suivre les redirections de la réponse lors de l'interrogation des données.

Valeurs possibles :
0 - Ne pas suivre les redirections ;
1 - (par défaut) Suivre les redirections.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
headers array Tableau d'en-têtes qui seront envoyés lors de l'exécution d'une requête HTTP.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
history string Unité de temps pendant laquelle les données d'historique doivent être conservées.
Accepte également les macros utilisateur et les macros LLD.

Par défaut : 31d.
http_proxy string Chaîne de connexion du proxy HTTP(S).

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
ipmi_sensor string Capteur IPMI.

Comportement de la propriété :
- obligatoire si type est défini sur « IPMI agent » et que key_ n'est pas défini sur « ipmi.get »
- pris en charge si type est défini sur « IPMI agent »
- en lecture seule pour les objets hérités
jmx_endpoint string Chaîne de connexion personnalisée de Java gateway.

Par défaut : service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Comportement de la propriété :
- pris en charge si type est défini sur « JMX agent »
logtimefmt string Format de l'heure dans les entrées de journal.

Comportement de la propriété :
- pris en charge si value_type est défini sur « log »
- en lecture seule pour les objets hérités
master_itemid ID ID de l'élément maître.

Comportement de la propriété :
- obligatoire si type est défini sur « Dependent item »
- en lecture seule pour les objets hérités
output_format integer Indique si la réponse doit être convertie en JSON.

Valeurs possibles :
0 - (par défaut) Stocker les données brutes ;
1 - Convertir en JSON.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
params string Paramètres supplémentaires selon le type du prototype d'élément :
- script exécuté pour les prototypes d'éléments SSH agent et TELNET agent ;
- requête SQL pour les prototypes d'éléments Database monitor ;
- formule pour les prototypes d'éléments Calculated ;
- script pour les prototypes d'éléments Script et Browser.

Comportement de la propriété :
- obligatoire si type est défini sur « Database monitor », « SSH agent », « TELNET agent », « Calculated », « Script » ou « Browser »
- en lecture seule pour les objets hérités (si type est défini sur « Script » ou « Browser »)
parameters object/array Paramètres supplémentaires si type est défini sur « Script » ou « Browser ». Tableau d'objets possédant les propriétés name et value, où name doit être unique.

Comportement de la propriété :
- pris en charge si type est défini sur « Script » ou « Browser »
- en lecture seule pour les objets hérités
password string Mot de passe d'authentification.

Comportement de la propriété :
- obligatoire si type est défini sur « JMX agent » et que username est défini
- pris en charge si type est défini sur « Simple check », « SSH agent », « TELNET agent », « Database monitor » ou « HTTP agent »
- en lecture seule pour les objets hérités (si type est défini sur « HTTP agent »)
post_type integer Type du corps des données POST stocké dans la propriété posts.

Valeurs possibles :
0 - (par défaut) Données brutes.
2 - Données JSON.
3 - Données XML.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
posts string Données du corps de la requête HTTP(S).

Comportement de la propriété :
- obligatoire si type est défini sur « HTTP agent » et que post_type est défini sur « Données JSON » ou « Données XML »
- pris en charge si type est défini sur « HTTP agent » et que post_type est défini sur « Données brutes »
- en lecture seule pour les objets hérités
privatekey string Nom du fichier de clé privée.

Comportement de la propriété :
- obligatoire si type est défini sur « SSH agent » et que authtype est défini sur « clé publique »
publickey string Nom du fichier de clé publique.

Comportement de la propriété :
- obligatoire si type est défini sur « SSH agent » et que authtype est défini sur « clé publique »
query_fields array Tableau de champs de requête qui seront envoyés lors de l'exécution d'une requête HTTP.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
request_method integer Type de méthode de requête.

Valeurs possibles :
0 - (par défaut) GET ;
1 - POST ;
2 - PUT ;
3 - HEAD.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
retrieve_mode integer Partie de la réponse à stocker.

Valeurs possibles si request_method est défini sur « GET », « POST » ou « PUT » :
0 - (par défaut) Corps ;
1 - En-têtes ;
2 - Le corps et les en-têtes seront stockés.

Valeurs possibles si request_method est défini sur « HEAD » :
1 - En-têtes.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
snmp_oid string OID SNMP.

Comportement de la propriété :
- obligatoire si type est défini sur « SNMP agent »
- en lecture seule pour les objets hérités
ssl_cert_file string Chemin du fichier de clé publique SSL.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
ssl_key_file string Chemin du fichier de clé privée SSL.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
ssl_key_password string Mot de passe du fichier de clé SSL.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
status integer État du prototype d'élément.

Valeurs possibles :
0 - prototype d'élément activé (par défaut) ;
1 - prototype d'élément désactivé ;
3 - prototype d'élément non pris en charge.
status_codes string Plages de codes d'état HTTP requis, séparées par des virgules.
Prend également en charge les macros utilisateur ou les macros LLD dans une liste séparée par des virgules.

Exemple : 200,200-{$M},{$M},200-400

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
templateid ID ID du prototype d'élément du modèle parent.

Comportement de la propriété :
- en lecture seule
timeout string Délai d'expiration de la requête d'interrogation des données de l'élément.
Accepte un nombre de secondes (par ex. 1, 60, 300) ou une valeur avec un suffixe temporel (par ex. 30s, 1m). Accepte également les macros utilisateur et les macros LLD.

Plage de valeurs possibles : 1-600s.

Par défaut : "" - utiliser les paramètres du proxy ou globaux.

Comportement de la propriété :
- pris en charge si type est défini sur « Zabbix agent » (0), « Simple check » (3) et que key_ ne commence pas par « vmware. » ni « icmpping », « Zabbix agent (active) » (7), « External check » (10), « Database monitor » (11), « SSH agent » (13), « TELNET agent » (14), « HTTP agent » (19), « SNMP agent » (20) et que snmp_oid commence par « walk[ » ou « get[ », « Script » (21), « Browser » (22)
- en lecture seule pour les objets hérités
trapper_hosts string Hôtes autorisés.

Comportement de la propriété :
- pris en charge si type est défini sur « Zabbix trapper », ou si type est défini sur « HTTP agent » et que allow_traps est défini sur « Autoriser l'acceptation des données entrantes ».
Si la propriété est omise, elle est automatiquement définie sur la macro utilisateur {$TRAPPER.ALLOWED_HOSTS} (valeur par défaut). Par défaut, {$TRAPPER.ALLOWED_HOSTS} est 127.0.0.1,::1.
Si la propriété est définie sur une chaîne vide, les connexions entrantes seront refusées pour tous les hôtes.
trends string Unité de temps pendant laquelle les données de tendances doivent être conservées.
Accepte également les macros utilisateur et les macros LLD.

Par défaut : 365d.

Comportement de la propriété :
- pris en charge si value_type est défini sur « numeric float » ou « numeric unsigned »
units string Unités de valeur.

Comportement de la propriété :
- pris en charge si value_type est défini sur « numeric float » ou « numeric unsigned »
- en lecture seule pour les objets hérités
username string Nom d'utilisateur pour l'authentification.

Comportement de la propriété :
- obligatoire si type est défini sur « SSH agent » ou « TELNET agent », ou si type est défini sur « JMX agent » et que password est défini
- pris en charge si type est défini sur « Simple check », « Database monitor » ou « HTTP agent »
- en lecture seule pour les objets hérités (si type est défini sur « HTTP agent »)
uuid string Identifiant unique universel, utilisé pour lier les prototypes d'éléments importés à ceux qui existent déjà. Généré automatiquement s'il n'est pas fourni.

Comportement de la propriété :
- pris en charge si le prototype d'élément appartient à un modèle
valuemapid ID ID de la table de correspondance des valeurs associée.

Comportement de la propriété :
- pris en charge si value_type est défini sur « numeric float », « character » ou « numeric unsigned »
- en lecture seule pour les objets hérités
verify_host integer Indique s'il faut vérifier que le nom d'hôte de la connexion correspond à celui du certificat du hôte.

Valeurs possibles :
0 - (par défaut) Ne pas vérifier ;
1 - Vérifier.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
verify_peer integer Indique s'il faut vérifier que le certificat du hôte est authentique.

Valeurs possibles :
0 - (par défaut) Ne pas vérifier ;
1 - Vérifier.

Comportement de la propriété :
- pris en charge si type est défini sur « HTTP agent »
- en lecture seule pour les objets hérités
discover integer État de découverte du prototype d'élément.

Valeurs possibles :
0 - (par défaut) les nouveaux éléments seront découverts ;
1 - les nouveaux éléments ne seront pas découverts et les éléments existants seront marqués comme perdus.

En-tête HTTP

L'objet d'en-tête possède les propriétés suivantes :

Propriété Type Description
name string Nom de l'en-tête HTTP.

Comportement de la propriété :
- obligatoire
value string Valeur de l'en-tête.

Comportement de la propriété :
- obligatoire

Champ de requête HTTP

L'objet de champ de requête définit un nom et une valeur utilisés pour spécifier un paramètre d'URL. Il possède les propriétés suivantes :

Propriété Type Description
name string Nom du paramètre.

Comportement de la propriété :
- obligatoire
value string Valeur du paramètre.

Comportement de la propriété :
- obligatoire

Tag d'un prototype d'élément

L'objet de tag d'un prototype d'élément possède les propriétés suivantes.

Propriété Type Description
tag string Nom du tag du prototype d'élément.

Comportement de la propriété:
- obligatoire
value string Valeur du tag du prototype d'élément.

Comportement de la propriété:
- lecture seule.
object integer Type d'objet dont le tag a été hérité.

Valeurs possibles :
0 - modèle;
1 - hôte.

Comportement de la propriété:
- lecture seule.
objectid ID ID de l'objet dont le tag a été hérité.

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

Prétraitement du prototype d’élément

L’objet de prétraitement du prototype d’élément possède les propriétés suivantes.

Propriété Type Description
type integer Type de l’option de prétraitement.

Valeurs possibles :
1 - Multiplicateur personnalisé ;
2 - Suppression des espaces à droite ;
3 - Suppression des espaces à gauche ;
4 - Suppression des espaces ;
5 - Expression régulière ;
6 - Conversion de booléen en décimal ;
7 - Conversion d’octal en décimal ;
8 - Conversion d’hexadécimal en décimal ;
9 - Modification simple ;
10 - Modification par seconde ;
11 - XPath XML ;
12 - JSONPath ;
13 - Dans l’intervalle ;
14 - Correspond à l’expression régulière ;
15 - Ne correspond pas à l’expression régulière ;
16 - Vérification des erreurs dans JSON ;
17 - Vérification des erreurs dans XML ;
18 - Vérification des erreurs à l’aide d’une expression régulière ;
19 - Ignorer les valeurs inchangées ;
20 - Ignorer les valeurs inchangées avec battement de cœur ;
21 - JavaScript ;
22 - Modèle Prometheus ;
23 - Conversion de Prometheus en JSON ;
24 - Conversion de CSV en JSON ;
25 - Remplacement ;
26 - Vérification des éléments non pris en charge ;
27 - Conversion de XML en JSON ;
28 - Valeur de parcours SNMP ;
29 - Conversion du parcours SNMP en JSON ;
30 - Valeur SNMP get.

Comportement de la propriété :
- required
params string Paramètres supplémentaires utilisés par l’option de prétraitement.
Plusieurs paramètres sont séparés par le caractère de nouvelle ligne (\n).

Si type est défini sur « Vérification des éléments non pris en charge », les paramètres suivent la syntaxe <scope>[\n<pattern>], où pattern est une expression régulière et scope est l’une des valeurs suivantes :
-1 - correspond à toute erreur ;
\ 0 - vérifie si le message d’erreur correspond à pattern ;
\ 1 - vérifie si le message d’erreur ne correspond pas à pattern.

Comportement de la propriété :
- required si type est défini sur « Multiplicateur personnalisé » (1), « Suppression des espaces à droite » (2), « Suppression des espaces à gauche » (3), « Suppression des espaces » (4), « Expression régulière » (5), « XPath XML » (11), « JSONPath » (12), « Dans l’intervalle » (13), « Correspond à l’expression régulière » (14), « Ne correspond pas à l’expression régulière » (15), « Vérification des erreurs dans JSON » (16), « Vérification des erreurs dans XML » (17), « Vérification des erreurs à l’aide d’une expression régulière » (18), « Ignorer les valeurs inchangées avec battement de cœur » (20), « JavaScript » (21), « Modèle Prometheus » (22), « Conversion de Prometheus en JSON » (23), « Conversion de CSV en JSON » (24), « Remplacement » (25), « Vérification des éléments non pris en charge » (26), « Valeur de parcours SNMP » (28), « Conversion du parcours SNMP en JSON » (29) ou « Valeur SNMP get » (30)
error_handler integer Type d’action utilisé en cas d’échec d’une étape de prétraitement.

Valeurs possibles :
0 - Le message d’erreur est défini par le serveur Zabbix ;
1 - Ignorer la valeur ;
2 - Définir une valeur personnalisée ;
3 - Définir un message d’erreur personnalisé.

Valeurs possibles si type est défini sur « Vérification des éléments non pris en charge » :
1 - Ignorer la valeur ;
2 - Définir une valeur personnalisée ;
3 - Définir un message d’erreur personnalisé.

Comportement de la propriété :
- required si type est défini sur « Multiplicateur personnalisé » (1), « Expression régulière » (5), « Conversion de booléen en décimal » (6), « Conversion d’octal en décimal » (7), « Conversion d’hexadécimal en décimal » (8), « Modification simple » (9), « Modification par seconde » (10), « XPath XML » (11), « JSONPath » (12), « Dans l’intervalle » (13), « Correspond à l’expression régulière » (14), « Ne correspond pas à l’expression régulière » (15), « Vérification des erreurs dans JSON » (16), « Vérification des erreurs dans XML » (17), « Vérification des erreurs à l’aide d’une expression régulière » (18), « Modèle Prometheus » (22), « Conversion de Prometheus en JSON » (23), « Conversion de CSV en JSON » (24), « Vérification des éléments non pris en charge » (26), « Conversion de XML en JSON » (27), « Valeur de parcours SNMP » (28), « Conversion du parcours SNMP en JSON » (29) ou « Valeur SNMP get » (30)
error_handler_params string Paramètres du gestionnaire d’erreurs.

Comportement de la propriété :
- required si error_handler est défini sur « Définir une valeur personnalisée » ou « Définir un message d’erreur personnalisé »

Les paramètres et gestionnaires d’erreurs suivants sont pris en charge pour chaque type de prétraitement.

Type de prétraitement Nom Paramètre 1 Paramètre 2 Paramètre 3 Gestionnaires d’erreurs pris en charge
1 Multiplicateur personnalisé nombre1, 6 0, 1, 2, 3
2 Suppression des espaces à droite liste de caractères2
3 Suppression des espaces à gauche liste de caractères2
4 Suppression des espaces liste de caractères2
5 Expression régulière modèle3 sortie2 0, 1, 2, 3
6 Conversion de booléen en décimal 0, 1, 2, 3
7 Conversion d’octal en décimal 0, 1, 2, 3
8 Conversion d’hexadécimal en décimal 0, 1, 2, 3
9 Modification simple 0, 1, 2, 3
10 Modification par seconde 0, 1, 2, 3
11 XPath XML chemin4 0, 1, 2, 3
12 JSONPath chemin4 0, 1, 2, 3
13 Dans l’intervalle min1, 6 max1, 6 0, 1, 2, 3
14 Correspond à l’expression régulière modèle3 0, 1, 2, 3
15 Ne correspond pas à l’expression régulière modèle3 0, 1, 2, 3
16 Vérification des erreurs dans JSON chemin4 0, 1, 2, 3
17 Vérification des erreurs dans XML chemin4 0, 1, 2, 3
18 Vérification des erreurs à l’aide d’une expression régulière modèle3 sortie2 0, 1, 2, 3
19 Ignorer les valeurs inchangées
20 Ignorer les valeurs inchangées avec battement de cœur secondes5, 6
21 JavaScript script2
22 Modèle Prometheus modèle6, 7 value, label, function sortie8, 9 0, 1, 2, 3
23 Conversion de Prometheus en JSON modèle6, 7 0, 1, 2, 3
24 Conversion de CSV en JSON caractère2 caractère2 0,1 0, 1, 2, 3
25 Remplacement chaîne recherchée2 remplacement2
26 Vérification des éléments non pris en charge scope1 modèle3, 6 1, 2, 3
27 Conversion de XML en JSON 0, 1, 2, 3
28 Valeur de parcours SNMP OID2 Format :
0 - Inchangé
1 - UTF-8 depuis Hex-STRING
2 - MAC depuis Hex-STRING
3 - Entier depuis BITS		 0, 1, 2, 3
29 Conversion du parcours SNMP en JSON10 Nom du champ2 Préfixe OID2 Format :
0 - Inchangé
1 - UTF-8 depuis Hex-STRING
2 - MAC depuis Hex-STRING
3 - Entier depuis BITS		 0, 1, 2, 3
30 Valeur SNMP get Format :
1 - UTF-8 depuis Hex-STRING
2 - MAC depuis Hex-STRING
3 - Entier depuis BITS		 0, 1, 2, 3

1 nombre entier ou à virgule flottante
2 chaîne
3 expression régulière
4 JSONPath ou XPath XML
5 entier positif (avec prise en charge des suffixes temporels, par exemple 30s, 1m, 2h, 1d)
6 macro utilisateur, macro LLD
7 modèle Prometheus suivant la syntaxe : <metric name>{<label name>="<label value>", ...} == <value>. Chaque composant du modèle Prometheus (métrique, nom du libellé, valeur du libellé et valeur de la métrique) peut être une macro utilisateur ou une macro LLD.
8 sortie Prometheus suivant la syntaxe : <label name> (peut être une macro utilisateur ou une macro LLD) si label est sélectionné comme deuxième paramètre.
9 L’une des fonctions d’agrégation suivantes : sum, min, max, avg, count si function est sélectionné comme deuxième paramètre.
10 Prend en charge plusieurs enregistrements « Nom du champ,Préfixe OID,Format » délimités par un caractère de nouvelle ligne.