Documentation
Table of Contents
> Objet Élément
Les objets suivants sont directement liés à l'API item.
Élément
Les éléments Web ne peuvent pas être directement créés, mis à jour ou supprimés via l'API Zabbix.
L'objet élément possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| itemid | string | (lecture seule) ID de l'élément. |
| delay (obligatoire) |
string | Intervalle de mise à jour de l'élément. Accepte les secondes ou une unité de temps avec suffixe (30s, 1m, 2h, 1j). En option, un ou plusieurs intervalles personnalisés peuvent être spécifiés soit comme intervalles flexibles, soit comme planification . Plusieurs intervalles sont séparés par un point-virgule. Des macros utilisateur peuvent être utilisées. Une seule macro doit remplir tout le champ. Les macros multiples dans un champ ou les macros mélangées avec du texte ne sont pas prises en charge. Les intervalles flexibles peuvent être écrits sous la forme de deux macros séparées par une barre oblique (par exemple, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).<br >Facultatif pour le trappeur Zabbix, les éléments dépendants et pour l'agent Zabbix (actif) avec la clé mqtt.get. |
| hostid (obligatoire) |
string | ID de l'hôte ou du modèle auquel appartient l'élément. Pour les opérations de mise à jour, ce champ est en lecture seule. |
| interfaceid (obligatoire) |
string | ID de l'interface hôte de l'élément. Utilisé uniquement pour les éléments hôtes. Non requis pour les éléments d'agent Zabbix (actif), Zabbix interne, trapper Zabbix, calculé, dépendant, moniteur de base de données et script. Facultatif pour les éléments d'agent HTTP. |
| key_ (obligatoire) |
string | Clé de l'élément. |
| name (obligatoire) |
string | Nom de l'élément. |
| type (obligatoire) |
integer | Type de l'élément Valeurs possibles : 0 - Agent Zabbix ; 2 - Trapper Zabbix ; 3 - Vérification simple ; 5 - Zabbix interne ; 7 - Agent Zabbix (actif) ; 9 - Élément Web ; 10 - Vérification externe ; 11 - Moniteur de base de données ; 12 - Agent IPMI ; 13 - Agent SSH ; 14 - Agent Telnet ; 15 - Calculé ; 16 - Agent JMX ; 17 - Interruption SNMP ; 18 - Élément dépendant ; 19 - Agent HTTP ; 20 - Agent SNMP ; 21 - Script |
| url (obligatoire) |
string | Chaîne d'URL, requise uniquement pour le type d'élément d'agent HTTP. Prend en charge les macros utilisateur, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| value_type (obligatoire) |
integer | Type d'information de l'élément. Valeurs possibles : 0 - nombre flottant ; 1 - caractère ; 2 - journal ; 3 - numérique non signé ; 4 - texte. |
| allow_traps | integer | Champ d'élément d'agent HTTP. Autoriser également le remplissage de la valeur comme dans le type d'élément du trappeur. 0 - (par défaut) Ne pas autoriser l'acceptation des données entrantes. 1 - Autoriser l'acceptation des données entrantes. |
| authtype | integer | Utilisé uniquement par les éléments d'agent SSH ou les éléments d'agent HTTP. Valeurs possibles de la méthode d'authentification de l'agent SSH : 0 - mot de passe (par défaut) ; 1 - clé publique. Valeurs possibles de la méthode d'authentification de l'agent HTTP : 0 - (par défaut) aucune 1 - de base 2 - NTLM 3 - Kerberos |
| description | string | Description de l'élément. |
| error | string | (lecture seule) Texte d'erreur en cas de problèmes de mise à jour de l'élément. |
| flags | integer | (lecture seule) Origine de l'objet. Valeurs possibles : 0 - un objet ordinaire ; 4 - un objet découvert. |
| follow_redirects | integer | Champ d'élément d'agent HTTP. Suivre les redirections de réponse tout en regroupant les données. 0 - Ne pas suivre les redirections. 1 - (par défaut) Suivre les redirections. |
| headers | object | Champ d'élément d'agent HTTP. Objet avec en-têtes de requête HTTP(S), où le nom de l'en-tête est utilisé comme clé et la valeur de l'en-tête comme valeur. Exemple : { "User-Agent": "Zabbix" } |
| history | string | Une unité de temps indiquant combien de temps les données d'historique doivent être stockées. Accepte également les macros utilisateur. Par défaut : 90d. |
| http_proxy | string | Champ d'élément d'agent HTTP. Chaîne de connexion proxy HTTP(S). |
| inventory_link | integer | ID du champ d'inventaire d'hôte rempli par l'élément. Reportez-vous à la page d'inventaire d'hôte pour obtenir la liste des champs d'inventaire d'hôte pris en charge et leurs identifiants. Par défaut : 0. |
| ipmi_sensor | string | Capteur IPMI. Utilisé uniquement par les éléments IPMI. |
| 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 |
| lastclock | timestamp | (lecture seule) Heure à laquelle l'élément a été mis à jour pour la dernière fois. Par défaut, seules les valeurs des dernières 24 heures sont affichées. Vous pouvez prolonger cette période en modifiant la valeur du paramètre Période d'affichage maximale de l'historique dans la section de menu Administration → Général. |
| lastns | integer | (lecture seule) Nanosecondes de la dernière mise à jour de l'élément. Par défaut, seules les valeurs des dernières 24 heures sont affichées. Vous pouvez prolonger cette période en modifiant la valeur du paramètre Période d'affichage maximale de l'historique dans la section de menu Administration → Général. |
| lastvalue | string | (lecture seule) Dernière valeur de l'élément. Par défaut, seules les valeurs des dernières 24 heures sont affichées. Vous pouvez prolonger cette période en modifiant la valeur du paramètre Période d'affichage maximale de l'historique dans la section de menu Administration → Général. |
| logtimefmt | string | Format de l'heure dans les entrées de journal. Utilisé uniquement par les éléments de journal. |
| master_itemid | integer | ID de l'élément principal. La récursivité jusqu'à 3 éléments dépendants et le nombre maximal d'éléments dépendants égal à 29 999 sont autorisés. Requis par les éléments dépendants. |
| output_format | integer | Champ d'élément d'agent HTTP. La réponse doit-elle être convertie en JSON. 0 - (par défaut) Stocker brut. 1 - Convertir en JSON. |
| params | string | Paramètres supplémentaires en fonction du type d'élément : - script exécuté pour les éléments SSH et Telnet ; - requête SQL pour les éléments de surveillance de base de données ; - formule pour les éléments calculés ; - le script pour un élément script. |
| parameters | array | Paramètres supplémentaires pour les éléments de script. Tableau d'objets avec les propriétés 'name' et 'value', où name doit être unique. |
| password | string | Mot de passe pour l'authentification. Utilisé par vérification simple, SSH, Telnet, moniteur de base de données, éléments d'agent JMX et HTTP. Lorsqu'il est utilisé par JMX, le nom d'utilisateur doit également être spécifié avec le mot de passe ou les deux propriétés doivent être laissées vides. |
| post_type | integer | Champ d'élément d'agent HTTP. Type de corps de données post stocké dans la propriété posts. 0 - (par défaut) Données brutes. 2 - Données JSON. 3 - Données XML. |
| posts | string | Champ d'élément d'agent HTTP. Données du corps de la requête HTTP(S). Utilisé avec post_type. |
| prevvalue | string | (lecture seule) Valeur précédente de l'élément. Par défaut, seules les valeurs des dernières 24 heures sont affichées. Vous pouvez prolonger cette période en modifiant la valeur du paramètre Période d'affichage maximale de l'historique dans la section de menu Administration → Général. |
| privatekey | string | Nom du fichier de clé privée. |
| publickey | string | Nom du fichier de clé publique. |
| query_fields | array | Champ d'élément d'agent HTTP. Paramètres de requête. Tableau d'objets avec des paires 'clé':'valeur', où la valeur peut être une chaîne vide. |
| request_method | integer | Champ d'élément d'agent HTTP. Type de méthode de requête. 0 - (par défaut) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | Champ d'élément d'agent HTTP. Quelle partie de la réponse doit être stockée. 0 - (par défaut) Corps. 1 - En-têtes. 2 - Le corps et les en-têtes seront stockés. Pour request_method HEAD seul 1 est la valeur autorisée. |
| snmp_oid | string | OID SNMP. |
| ssl_cert_file | string | Champ d'élément d'agent HTTP. Chemin d'accès au fichier de clé SSL publique. |
| ssl_key_file | string | Champ d'élément d'agent HTTP. Chemin d'accès au fichier de clé SSL privée. |
| ssl_key_password | string | Champ d'élément d'agent HTTP. Mot de passe pour le fichier de clé SSL. |
| state | integer | (lecture seule) État de l'élément. Valeurs possibles : 0 - (par défaut) normal ; 1 - non pris en charge. |
| status | integer | Statut de l'élément. Valeurs possibles : 0 - élément activé (par défaut) ; 1 - élément désactivé. |
| status_codes | string | Champ d'élément d'agent HTTP. Plages de codes d'état HTTP requis séparés par des virgules. Prend également en charge les macros utilisateur dans le cadre d'une liste séparée par des virgules. Exemple : 200,200-{$M},{$M},200-400 |
| templateid | string | (lecture seule) ID de l'élément du modèle parent. Conseil : utilisez la propriété hostid pour spécifier le modèle auquel appartient l'élément. |
| timeout | string | Délai d'expiration de la demande d'interrogation des données d'élément. Utilisé pour l'agent HTTP et les éléments de script. Prend en charge les macros utilisateur. par défaut : 3s valeur maximale : 60s |
| trapper_hosts | string | Hôtes autorisés. Utilisé par les éléments de trappeur ou les éléments d'agent HTTP. |
| trends | string | Une unité de temps de combien de temps les données de tendances doivent être stockées. Accepte également les macros utilisateur. Par défaut : 365d. |
| units | string | Unités de valeur. |
| username | string | Nom d'utilisateur pour l'authentification. Utilisé par simple vérification, SSH, Telnet, moniteur de base de données, éléments d'agent JMX et HTTP. Requis par les éléments SSH et Telnet. Lorsqu'il est utilisé par JMX, le mot de passe doit également être spécifié avec le nom d'utilisateur ou les deux propriétés doit rester vide. |
| uuid | string | Identifiant unique universel, utilisé pour lier un élément importé à des éléments déjà existants. Utilisé uniquement pour les éléments de modèles. Généré automatiquement, s'il n'est pas fourni. Pour les opérations de mise à jour, ce champ est en lecture seule. |
| valuemapid | string | ID de la table. de correspondance de valeurs associée. |
| verify_host | integer | Champ d'élément d'agent HTTP. Valider que le nom d'hôte dans l'URL se trouve dans le champ Nom commun ou dans un champ Autre nom du sujet du certificat d'hôte. 0 - (par défaut) Ne pas valider. 1 - Valider. |
| verify_peer | integer | Champ d'élément d'agent HTTP. Valider si le certificat de l'hôte est authentique. 0 - (par défaut) Ne pas valider. 1 - Valider. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Tag d'élément
L'objet tag d'élément a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (obligatoire) |
string | Nom du tag de l'élément. |
| value | string | Valeur du tag de l'élément. |
### Prétraitement de l'élément
L'objet de prétraitement d'élément a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| type (obligatoire) |
integer | Le type d'option de prétraitement. Valeurs possibles : 1 - Multiplicateur personnalisé ; 2 - Rogner à droite ; 3 - Rogner à gauche ; 4 - Rogner ; 5 - Correspondance d'expression régulière ; 6 - Booléen à décimal ; 7 - Octal à décimal ; 8 - Hexadécimal à décimal ; 9 - Modification simple ; 10 - Modification par seconde ; 11 - XPath XML ; 12 - JSONPath ; 13 - Dans la plage ; 14 - Correspond à l'expression régulière ; 15 - Ne correspond pas à l'expression régulière ; 16 - Rechercher une erreur dans JSON ; 17 - Rechercher une erreur dans XML ; 18 - Rechercher une erreur à l'aide d'une expression régulière ; 19 - Ecarter les inchangés ;<br >20 - Ecarté les inchangés avec un heartbeat ; 21 - JavaScript ; 22 - Motif Prometheus ; 23 - Prometheus vers JSON ; 24 - CSV vers JSON ; 25 - Remplacer ; >26 - Vérification non supportée ; 27 - XML vers JSON. |
| params (obligatoire) |
string | Paramètres supplémentaires utilisés par l'option de prétraitement. Plusieurs paramètres sont séparés par le caractère LF (\n). |
| error_handler (obligatoire) |
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 ;< br>1 - Supprimer la valeur ; 2 - Définir une valeur personnalisée ; 3 - Définir un message d'erreur personnalisé. |
| error_handler_params (obligatoire) |
string | Paramètres du gestionnaire d'erreurs. Utilisé avec error_handler.Doit être vide, si error_handler est 0 ou 1.Peut être vide si error_handler est 2.Ne peut pas être vide, si error_handler est 3. |
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|Rogner à droite|liste des caractères2|<|<|<| |3|Rogner à gauche|liste des caractères2|<|<|<| |4|Rogner|liste de caractères2|<|<|<| |5|Expression régulière|motif3|sortie2|<|0, 1, 2, 3| |6|Booléen à décimal|<|<|<|0, 1, 2, 3| |7|Octal à décimal|<|<|<|0, 1, 2, 3| |8|Hexadécimal à décimal|<|<|<|0, 1, 2, 3| |9|Changement simple|<|<|<|0, 1, 2, 3| |10|Changement par seconde|<|<|<|0, 1, 2, 3| |11|XML XPath|chemin4|<|<|0, 1, 2, 3| |12|JSONPath|chemin4|<|<|0, 1, 2, 3| |13|Dans la plage|min1, 6|max1, 6|<|0, 1, 2, 3| |14|Correspond à l'expression régulière|motif3|<|<|0, 1, 2, 3| |15|Ne correspond pas à l'expression régulière|motif3|<|<|0, 1, 2, 3| |16|Vérifier l'erreur dans JSON|chemin4|<|<|0, 1, 2, 3| |17|Vérifier l'erreur dans XML|chemin4|<|<|0, 1, 2, 3| |18|Vérifiez les erreurs à l'aide de l'expression régulière|motif3|sortie2|<|0, 1, 2, 3| |19|Ecarter les inchangés|<|<|<|<| |20|Ecarter les inchangés avec un heartbeat|secondes5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Motif Prometheus|motif6, 7|value, label, function|sortie8, 9|0, 1, 2, 3| |23|Prométhée vers JSON|motif6, 7|<|<|0, 1, 2, 3| |24|CSV vers JSON|caractère2|caractère2|0,1|0, 1, 2, 3| |25|Remplacer|chaîne de recherche2|remplacement2|<|<| |26|Vérification non supportée|<|<|<|1, 2, 3| |27|XML vers JSON|<|<|<|0, 1, 2, 3|
1 entier ou nombre à virgule flottante
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 : <nom de la mesure>{<nom de l'étiquette>="<valeur de l'étiquette>", ...} == <valeur>. Chaque composant de motif Prometheus (métrique, nom de l'étiquette, valeur de l'étiquette et métrique valeur) 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 Une des fonctions d'agrégation : sum, min, max, avg, count si function est sélectionné comme deuxième paramètre.