Sommaire
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.
| Propriété | Type | Description |
|---|---|---|
| itemid | ID | ID du prototype d'élément. Comportement de la propriété : - lecture seule - obligatoire pour les opérations de mise à jour |
| delay | string | Intervalle de mise à jour du prototype d'é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, tous séparés par des points-virgules. Les intervalles personnalisés peuvent être un mélange d'intervalles flexibles et d'intervalles de planification. Accepte les macros utilisateur et les macros LLD. Si elles sont utilisées, la valeur doit être une macro unique. Plusieurs macros ou des 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}).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 de l'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 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 - 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 - 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 - 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"- lecture seule pour les objets hérités |
| value_type | integer | Type d'information du prototype d'élément. Valeurs possibles : 0 - numérique flottant ; 1 - caractère ; 2 - journal ; 3 - numérique non signé ; 4 - texte ; 5 - binaire ; 6 - JSON. Comportement de la propriété : - obligatoire pour les opérations de création - lecture seule pour les objets hérités |
| allow_traps | integer | Autoriser le remplissage de la valeur de manière similaire à l'élément trapper. 0 - (par défaut) Ne pas autoriser l'acceptation de données entrantes ; 1 - Autoriser l'acceptation de 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 - basique ; 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"- 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é : - lecture seule |
| follow_redirects | integer | Suivre les redirections de 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"- lecture seule pour les objets hérités |
| headers | array | Tableau des 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"- lecture seule pour les objets hérités |
| history | string | Unité de temps indiquant combien de temps les données d'historique doivent être conservées. Accepte également une macro utilisateur et une macro 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"- 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"- lecture seule pour les objets hérités |
| jmx_endpoint | string | Chaîne de connexion personnalisée de l'agent JMX. 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"- 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"- 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 brut ; 1 - Convertir en JSON. Comportement de la propriété : - pris en charge si type est défini sur "HTTP agent"- 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ément SSH agent et TELNET agent ; - requête SQL pour les prototypes d'élément Database monitor ; - formule pour les prototypes d'élément Calculated ; - le script pour les prototypes d'élément 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"- 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 avec 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"- lecture seule pour les objets hérités |
| password | string | Mot de passe pour l'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"- 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"- 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 "JSON data" ou "XML data"- pris en charge si type est défini sur "HTTP agent" et que post_type est défini sur "Raw data"- 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 "public key" |
| 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 "public key" |
| query_fields | array | Tableau des 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"- 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"- lecture seule pour les objets hérités |
| 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 - (par défaut) 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. Comportement de la propriété : - pris en charge si type est défini sur "HTTP agent"- 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"- lecture seule pour les objets hérités |
| ssl_cert_file | string | Chemin du fichier de clé SSL publique. Comportement de la propriété : - pris en charge si type est défini sur "HTTP agent"- lecture seule pour les objets hérités |
| ssl_key_file | string | Chemin du fichier de clé SSL privée. Comportement de la propriété : - pris en charge si type est défini sur "HTTP agent"- 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"- lecture seule pour les objets hérités |
| status | integer | Statut du prototype d'élément. Valeurs possibles : 0 - (par défaut) prototype d'élément activé ; 1 - prototype d'élément désactivé ; 3 - prototype d'élément non pris en charge. |
| status_codes | string | Plages des codes d'état HTTP requis, séparées par des virgules. Prend également en charge les macros utilisateur ou les macros LLD comme partie d'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"- 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é : - lecture seule |
| timeout | string | Délai d'expiration de la requête d'interrogation 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 et les macros LLD. Plage de valeurs possible : 1-600s. Par défaut : "" - utiliser les paramètres du proxy/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)- 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 "Allow to accept incoming data" |
| trends | string | Unité de temps indiquant combien de temps les données de tendances doivent être conservées. Accepte également une macro utilisateur et une macro 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"- 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"- lecture seule pour les objets hérités (si type est défini sur "HTTP agent") |
| uuid | string | Identifiant universel unique, utilisé pour lier les prototypes d'élément 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 du mappage de valeurs associé. Comportement de la propriété : - pris en charge si value_type est défini sur "numeric float", "character" ou "numeric unsigned"- 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 de l'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"- lecture seule pour les objets hérités |
| verify_peer | integer | Indique s'il faut vérifier que le certificat de l'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"- lecture seule pour les objets hérités |
| discover | integer | Statut 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 de prototype d’élément
L’objet tag de prototype d’élément possède les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag | string | Nom du tag de prototype d’élément. Comportement de la propriété : - obligatoire |
| value | string | Valeur du tag de 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.
| Property | Type | Description |
|---|---|---|
| type | integer | Le type d’option de prétraitement. Valeurs possibles : 1 - Multiplicateur personnalisé ; 2 - Supprimer à droite ; 3 - Supprimer à gauche ; 4 - Supprimer ; 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 - Changement 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 une erreur dans JSON ; 17 - Vérifier une erreur dans XML ; 18 - Vérifier une erreur à l’aide d’une expression régulière ; 19 - Ignorer si inchangé ; 20 - Ignorer si inchangé avec heartbeat ; 21 - JavaScript ; 22 - Motif Prometheus ; 23 - Prometheus vers JSON ; 24 - CSV vers JSON ; 25 - Remplacer ; 26 - Vérifier non pris en charge ; 27 - XML vers JSON ; 28 - Valeur SNMP walk ; 29 - SNMP walk vers JSON ; 30 - Valeur SNMP get. Comportement de la propriété : - obligatoire |
| 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’un des suivants :-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é : - obligatoire 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) ou "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é : - obligatoire 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) ou "SNMP get value" (30) |
| error_handler_params | string | Paramètres du gestionnaire d’erreurs. Comportement de la propriété : - obligatoire si error_handler est défini sur "Set custom value" ou "Set custom error message" |
Les paramètres suivants et les 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é | nombre1,\ 6 | 0, 1, 2, 3 | ||
| 2 | Supprimer à droite | liste de caractères2 | |||
| 3 | Supprimer à gauche | liste de caractères2 | |||
| 4 | Supprimer | liste de caractères2 | |||
| 5 | Expression régulière | motif3 | sortie2 | 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 | Changement par seconde | 0, 1, 2, 3 | |||
| 11 | XML XPath | 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 | motif3 | 0, 1, 2, 3 | ||
| 15 | Ne correspond pas à l’expression régulière | motif3 | 0, 1, 2, 3 | ||
| 16 | Vérifier une erreur dans JSON | chemin4 | 0, 1, 2, 3 | ||
| 17 | Vérifier une erreur dans XML | chemin4 | 0, 1, 2, 3 | ||
| 18 | Vérifier une erreur à l’aide d’une expression régulière | motif3 | sortie2 | 0, 1, 2, 3 | |
| 19 | Ignorer si inchangé | ||||
| 20 | Ignorer si inchangé avec heartbeat | secondes5,\ 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Motif Prometheus | motif6,\ 7 | value, label, function |
sortie8,\ 9 | 0, 1, 2, 3 |
| 23 | Prometheus 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 recherchée2 | remplacement2 | ||
| 26 | Vérifier non pris en charge | scope1 | motif3,\ 6 | 1, 2, 3 | |
| 27 | XML vers JSON | 0, 1, 2, 3 | |||
| 28 | Valeur SNMP walk | OID2 | Format : 0 - Inchangé 1 - UTF-8 depuis Hex-STRING 2 - MAC depuis Hex-STRING 3 - Entier depuis BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk vers 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 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 ex. 30s, 1m, 2h, 1d)
6 macro utilisateur, macro LLD
7 Motif Prometheus suivant la syntaxe : <metric name>{<label name>="<label value>", ...} == <value>.
Chaque composant du motif Prometheus (métrique, nom d’étiquette, valeur d’étiquette et valeur de 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 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 "Nom du champ,Préfixe OID,Format" délimités par un caractère de nouvelle ligne.