Objet item

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

Élément

Les éléments web ne peuvent pas être créés, mis à jour ou supprimés directement via l'API Zabbix.

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

Property Type Description
itemid ID ID de l'élément.

Property behavior:
- read-only
- required for update operations
delay string Intervalle de mise à jour de l'élément.

Accepte des secondes ou une unité de temps avec suffixe (par exemple, 30s, 1m, 2h, 1d) et, éventuellement, un ou plusieurs intervalles personnalisés, le tout séparé par des points-virgules. Les intervalles personnalisés peuvent combiner des intervalles flexibles et des intervalles de planification.

Accepte les macros utilisateur. Si elle est utilisée, la valeur doit être une seule macro. Les macros multiples ou les macros mélangées à du texte ne sont pas prises en charge. Les intervalles flexibles peuvent être écrits sous forme de deux macros séparées par une barre oblique (par exemple, {$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}

Property behavior:
- required if type is set to "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), or if type is set to "Zabbix agent (active)" (7) and key_ does not contain "mqtt.get"
hostid ID ID de l'hôte ou du modèle auquel appartient l'élément.

Property behavior:
- constant
- required for create operations
interfaceid ID ID de l'interface de l'hôte de l'élément.

Property behavior:
- required if item belongs to host and type is set to "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap", or "SNMP agent"
- supported if item belongs to host and type is set to "Simple check", "External check", "SSH agent", "TELNET agent", or "HTTP agent"
- read-only for discovered objects
key_ string Clé de l'élément.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
name string Nom de l'élément.
Prend en charge les macros utilisateur.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
name_resolved string Nom de l'élément avec les macros utilisateur résolues.

Property behavior:
- read-only
type integer Type de l'élément.

Valeurs possibles:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
9 - Web item;
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.

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
url string Chaîne d'URL.
Prend en charge les macros utilisateur, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

Property behavior:
- required if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
value_type integer Type d'information de l'élément.

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

Property behavior:
- required for create operations
- read-only for inherited objects or discovered objects
allow_traps integer Autoriser le remplissage de la valeur de la même manière que pour l'élément trapper.

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for discovered objects
authtype integer Méthode d'authentification.

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

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

Property behavior:
- supported if type is set to "SSH agent" or "HTTP agent"
- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects
description string Description de l'élément.

Property behavior:
- read-only for discovered objects
error string Texte d'erreur s'il y a des problèmes lors de la mise à jour de la valeur de l'élément.

Property behavior:
- read-only
flags integer Origine de l'élément.

Valeurs possibles:
0 - un élément simple;
4 - un élément converti depuis un prototype.

Property behavior:
- read-only
follow_redirects integer Suivre les redirections de réponse lors de la collecte des données.

Valeurs possibles:
0 - Ne pas suivre les redirections;
1 - (default) Suivre les redirections.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
headers array Tableau de en-têtes qui seront envoyés lors de l'exécution d'une requête HTTP.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
history string Une unité de temps indiquant pendant combien de temps les données d'historique doivent être conservées.
Accepte également une macro utilisateur.

Par défaut: 31d.

Property behavior:
- read-only for discovered objects
http_proxy string Chaîne de connexion du proxy HTTP(S).

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
inventory_link integer ID du champ d'inventaire de l'hôte renseigné par l'élément.

Consultez la page d'inventaire de l'hôte pour obtenir la liste des champs d'inventaire pris en charge et leurs ID.

Par défaut: 0.

Property behavior:
- supported if value_type is set to "numeric float", "character", "numeric unsigned", or "text"
- read-only for discovered objects
ipmi_sensor string Capteur IPMI.

Property behavior:
- required if type is set to "IPMI agent" and key_ is not set to "ipmi.get"
- supported if type is set to "IPMI agent"
- read-only for inherited objects or discovered objects
jmx_endpoint string Chaîne de connexion personnalisée de l'agent JMX.

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

Property behavior:
- supported if type is set to "JMX agent"
- read-only for discovered objects
lastclock timestamp Heure à laquelle la valeur de l'élément a été mise à jour pour la dernière fois.

Par défaut, seules les valeurs comprises dans les dernières 24 heures sont affichées. Vous pouvez étendre cette période en modifiant la valeur du paramètre Max history display period dans la section de menu Administration → General.

Property behavior:
- read-only
lastns integer Nanosecondes à laquelle la valeur de l'élément a été mise à jour pour la dernière fois.

Par défaut, seules les valeurs comprises dans les dernières 24 heures sont affichées. Vous pouvez étendre cette période en modifiant la valeur du paramètre Max history display period dans la section de menu Administration → General.

Property behavior:
- read-only
lastvalue string Dernière valeur de l'élément.

Par défaut, seules les valeurs comprises dans les dernières 24 heures sont affichées. Vous pouvez étendre cette période en modifiant la valeur du paramètre Max history display period dans la section de menu Administration → General.

Property behavior:
- read-only
logtimefmt string Format de l'heure dans les entrées de journal.

Property behavior:
- supported if value_type is set to "log"
- read-only for inherited objects or discovered objects
master_itemid ID ID de l'élément maître.

Property behavior:
- required if type is set to "Dependent item"
- read-only for inherited objects or discovered objects
output_format integer La réponse doit-elle être convertie en JSON.

0 - (default) Stocker les données brutes;
1 - Convertir en JSON.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
params string Paramètres supplémentaires selon le type de l'élément:
- script exécuté pour les éléments SSH agent et TELNET agent;
- requête SQL pour les éléments database monitor;
- formule pour les éléments calculated;
- script pour les éléments script et browser.

Property behavior:
- required if type is set to "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script", or "Browser"
- read-only for inherited objects (if type is set to "Script" or "Browser") or discovered objects
parameters object/array Paramètres supplémentaires si type est défini sur "Script" ou "Browser". Tableau d'objets avec les propriétés name et value, où name doit être unique.

Property behavior:
- supported if type is set to "Script" or "Browser"
- read-only for inherited objects or discovered objects
password string Mot de passe pour l'authentification.

Property behavior:
- required if type is set to "JMX agent" and username is set
- supported if type is set to "Simple check", "SSH agent", "TELNET agent", "Database monitor", or "HTTP agent"
- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects
post_type integer Type du corps des données POST stocké dans la propriété posts.

Valeurs possibles:
0 - (default) Données brutes;
2 - Données JSON;
3 - Données XML.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
posts string Données du corps de la requête HTTP(S).

Property behavior:
- required if type is set to "HTTP agent" and post_type is set to "JSON data" or "XML data"
- supported if type is set to "HTTP agent" and post_type is set to "Raw data"
- read-only for inherited objects or discovered objects
prevvalue string Valeur précédente de l'élément.

Par défaut, seules les valeurs comprises dans les dernières 24 heures sont affichées. Vous pouvez étendre cette période en modifiant la valeur du paramètre Max history display period dans la section de menu Administration → General.

Property behavior:
- read-only
privatekey string Nom du fichier de clé privée.

Property behavior:
- required if type is set to "SSH agent" and authtype is set to "public key"
- read-only for discovered objects
publickey string Nom du fichier de clé publique.

Property behavior:
- required if type is set to "SSH agent" and authtype is set to "public key"
- read-only for discovered objects
query_fields array Tableau de champs de requête qui seront envoyés lors de l'exécution d'une requête HTTP.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
request_method integer Type de méthode de requête.

Valeurs possibles:
0 - (default) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
retrieve_mode integer Quelle partie de la réponse doit être stockée.

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

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
snmp_oid string OID SNMP.

Property behavior:
- required if type is set to "SNMP agent"
- read-only for inherited objects or discovered objects
ssl_cert_file string Chemin du fichier de clé SSL publique.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
ssl_key_file string Chemin du fichier de clé SSL privée.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
ssl_key_password string Mot de passe du fichier de clé SSL.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
state integer État de l'élément.

Valeurs possibles:
0 - (default) normal;
1 - non pris en charge.

Property behavior:
- read-only
status integer Statut de l'élément.

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

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

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
templateid ID ID de l'élément de modèle parent.

Conseil: utilisez la propriété hostid pour spécifier le modèle auquel l'élément appartient.

Property behavior:
- read-only
timeout string Délai d'attente de la requête de collecte des données de l'élément.
Accepte des secondes ou une unité de temps avec suffixe (par exemple, 30s, 1m). Accepte également les macros utilisateur.

Plage de valeurs possible: 1-600s.

Par défaut: "" - utiliser les paramètres du proxy/global.

Property behavior:
- supported if type is set to "Zabbix agent" (0), "Simple check" (3) and key_ does not start with "vmware." and "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) and snmp_oid starts with "walk[" or "get[", "Script" (21), "Browser" (22)
- read-only for inherited and discovered objects
trapper_hosts string Hôtes autorisés.

Property behavior:
- readonly for discovered objects
- supported if type is set to "Zabbix trapper", or if type is set to "HTTP agent" and allow_traps is set to "Allow to accept incoming data"
trends string Une unité de temps indiquant pendant combien de temps les données de tendances doivent être conservées.
Accepte également une macro utilisateur.

Par défaut: 365d.

Property behavior:
- supported if value_type is set to "numeric float" or "numeric unsigned"
- read-only for discovered objects
units string Unités de la valeur.

Property behavior:
- supported if value_type is set to "numeric float" or "numeric unsigned"
- read-only for inherited objects or discovered objects
username string Nom d'utilisateur pour l'authentification.

Property behavior:
- required if type is set to "SSH agent", "TELNET agent", or if type is set to "JMX agent" and password is set
- supported if type is set to "Simple check", "Database monitor", or "HTTP agent"
- read-only for inherited objects (if type is set to "HTTP agent") or discovered objects
uuid string Identifiant unique universel, utilisé pour lier l'élément importé à des éléments déjà existants. Généré automatiquement s'il n'est pas fourni.

Property behavior:
- supported if the item belongs to a template
valuemapid ID ID de la carte de valeurs associée.

Property behavior:
- supported if value_type is set to "numeric float", "character", or "numeric unsigned"
- read-only for inherited objects or discovered objects
verify_host integer Indique s'il faut valider que le nom d'hôte de la connexion correspond à celui du certificat de l'hôte.

Valeurs possibles:
0 - (default) Ne pas valider;
1 - Valider.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects
verify_peer integer Indique s'il faut valider que le certificat de l'hôte est authentique.

Valeurs possibles:
0 - (default) Ne pas valider;
1 - Valider.

Property behavior:
- supported if type is set to "HTTP agent"
- read-only for inherited objects or discovered objects

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

Balise d'élément

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

Property Type Description
tag string Nom de la balise d'élément.

Property behavior:
- required
value string Valeur de la balise d'élément.

Prétraitement de l'élément

L'objet de prétraitement de l'élément possède les propriétés suivantes.

Property Type Description
type integer Le type d'option de prétraitement.

Valeurs possibles :
1 - Multiplicateur personnalisé;
2 - Suppression à droite;
3 - Suppression à gauche;
4 - Suppression;
5 - Expression régulière;
6 - Booléen vers décimal;
7 - Octal vers décimal;
8 - Hexadécimal vers décimal;
9 - Changement simple;
10 - Variation par seconde;
11 - XML XPath;
12 - JSONPath;
13 - Dans l'intervalle;
14 - Correspond à l'expression régulière;
15 - Ne correspond pas à l'expression régulière;
16 - Vérifier l'erreur dans JSON;
17 - Vérifier l'erreur dans XML;
18 - Vérifier l'erreur à l'aide d'une expression régulière;
19 - Ignorer les valeurs inchangées;
20 - Ignorer les valeurs inchangées avec heartbeat;
21 - JavaScript;
22 - Modèle Prometheus;
23 - Prometheus vers JSON;
24 - CSV vers JSON;
25 - Remplacer;
26 - Vérifier non pris en charge;
27 - XML vers JSON;
28 - Valeur de parcours SNMP;
29 - Parcours SNMP vers 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.
Les paramètres multiples sont séparés par le caractère de nouvelle ligne (\n).

Si type est défini sur "Check unsupported", 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érifier si le message d'erreur correspond à pattern;
\ 1 - vérifier si le message d'erreur ne correspond pas à pattern.

Comportement de la propriété:
- required si type est défini sur "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), Check unsupported (26), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30)
error_handler integer Type d'action utilisé en cas d'échec de l'é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 "Check unsupported" :
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 "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30)
error_handler_params string Paramètres du gestionnaire d'erreurs.

Comportement de la propriété:
- required si error_handler est défini sur "Set custom value" ou "Set custom error message"

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

Preprocessing type Name Parameter 1 Parameter 2 Parameter 3 Supported error handlers
1 Multiplicateur personnalisé number1, 6 0, 1, 2, 3
2 Suppression à droite list of characters2
3 Suppression à gauche list of characters2
4 Suppression list of characters2
5 Expression régulière pattern3 output2 0, 1, 2, 3
6 Booléen vers décimal 0, 1, 2, 3
7 Octal vers décimal 0, 1, 2, 3
8 Hexadécimal vers décimal 0, 1, 2, 3
9 Changement simple 0, 1, 2, 3
10 Variation par seconde 0, 1, 2, 3
11 XML XPath path4 0, 1, 2, 3
12 JSONPath path4 0, 1, 2, 3
13 Dans l'intervalle min1, 6 max1, 6 0, 1, 2, 3
14 Correspond à l'expression régulière pattern3 0, 1, 2, 3
15 Ne correspond pas à l'expression régulière pattern3 0, 1, 2, 3
16 Vérifier l'erreur dans JSON path4 0, 1, 2, 3
17 Vérifier l'erreur dans XML path4 0, 1, 2, 3
18 Vérifier l'erreur à l'aide d'une expression régulière pattern3 output2 0, 1, 2, 3
19 Ignorer les valeurs inchangées
20 Ignorer les valeurs inchangées avec heartbeat seconds5, 6
21 JavaScript script2
22 Modèle Prometheus pattern6, 7 value, label, function output8, 9 0, 1, 2, 3
23 Prometheus vers JSON pattern6, 7 0, 1, 2, 3
24 CSV vers JSON character2 character2 0,1 0, 1, 2, 3
25 Remplacer search string2 replacement2
26 Vérifier non pris en charge scope1 pattern3, 6 1, 2, 3
27 XML vers JSON 0, 1, 2, 3
28 Valeur de parcours SNMP OID2 Format:
0 - Inchangé
1 - UTF-8 à partir de Hex-STRING
2 - MAC à partir de Hex-STRING
3 - Entier à partir de BITS		 0, 1, 2, 3
29 Parcours SNMP vers JSON10 Field name2 OID prefix2 Format:
0 - Inchangé
1 - UTF-8 à partir de Hex-STRING
2 - MAC à partir de Hex-STRING
3 - Entier à partir de BITS		 0, 1, 2, 3
30 Valeur SNMP get Format:
1 - UTF-8 à partir de Hex-STRING
2 - MAC à partir de Hex-STRING
3 - Entier à partir de BITS		 0, 1, 2, 3

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