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.
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID du prototype d'élément. Property behavior: - 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, 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 et les macros LLD. Si elles sont utilisées, 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: - 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. Property behavior: - constant - obligatoire pour les opérations de création |
| interfaceid | ID | ID de l'interface d'hôte du prototype d'élément. Property behavior: - 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. Property behavior: - 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. Property behavior: - 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. Property behavior: - 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}, {ITEM.ID}, {ITEM.KEY}. Property behavior: - 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 - nombre flottant; 1 - caractère; 2 - journal; 3 - entier non signé; 4 - texte; 5 - binaire. Property behavior: - 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 la même manière que pour 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. Property behavior: - 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. Property behavior: - 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. |
| 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 - (par défaut) Suivre les redirections. Property behavior: - pris en charge si type est défini sur "HTTP agent"- 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. Property behavior: - 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 la durée de conservation des données d'historique. Accepte également les macros utilisateur et les macros LLD. Par défaut: 31d. |
| http_proxy | string | Chaîne de connexion du proxy HTTP(S). Property behavior: - pris en charge si type est défini sur "HTTP agent"- lecture seule pour les objets hérités |
| ipmi_sensor | string | Capteur IPMI. Property behavior: - 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 Property behavior: - pris en charge si type est défini sur "JMX agent" |
| logtimefmt | string | Format de l'heure dans les entrées de journal. Property behavior: - 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. La récursion jusqu'à 3 éléments dépendants et prototypes d'élément, ainsi qu'un nombre maximal d'éléments dépendants et de prototypes d'élément égal à 29999, sont autorisés. Property behavior: - obligatoire si type est défini sur "Dependent item"- lecture seule pour les objets hérités |
| output_format | integer | La réponse doit-elle être convertie en JSON. Valeurs possibles: 0 - (par défaut) Stocker les données brutes; 1 - Convertir en JSON. Property behavior: - 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; - script pour les prototypes d'élément Script et Browser. Property behavior: - 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.Property behavior: - 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. Property behavior: - 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. Property behavior: - 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). Property behavior: - 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. Property behavior: - 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. Property behavior: - obligatoire si type est défini sur "SSH agent" et que authtype est défini sur "public key" |
| 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: - 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. Property behavior: - 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. Property behavior: - pris en charge si type est défini sur "HTTP agent"- lecture seule pour les objets hérités |
| snmp_oid | string | OID SNMP. Property behavior: - 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. Property behavior: - 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. Property behavior: - 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. Property behavior: - 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 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 Property behavior: - 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. Property behavior: - lecture seule |
| 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 et les macros LLD. Plage de valeurs possibles: 1-600s. Par défaut: "" - utiliser les paramètres du proxy/global. Property behavior: - 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. Property behavior: - 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 la durée de conservation des données de tendances. Accepte également les macros utilisateur et les macros LLD. Par défaut: 365d. Property behavior: - pris en charge si value_type est défini sur "numeric float" ou "numeric unsigned" |
| units | string | Unités de la valeur. Property behavior: - 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. Property behavior: - 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 unique universel, utilisé pour lier les prototypes d'élément importés à ceux déjà existants. Généré automatiquement s'il n'est pas fourni. Property behavior: - pris en charge si le prototype d'élément appartient à un modèle |
| valuemapid | ID | ID de la correspondance de valeurs associée. Property behavior: - 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 valider 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 valider; 1 - Valider. Property behavior: - 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 valider que le certificat de l'hôte est authentique. Valeurs possibles: 0 - (par défaut) Ne pas valider; 1 - Valider. Property behavior: - 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) de nouveaux éléments seront découverts; 1 - de 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 |
Balise de prototype d'élément
L'objet de balise de prototype d'élément possède les propriétés suivantes.
| Property | Type | Description |
|---|---|---|
| tag | string | Nom de la balise du prototype d'élément. Comportement de la propriété: - required |
| value | string | Valeur de la balise du prototype d'élément. |
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 - Suppression des caractères à droite; 3 - Suppression des caractères à gauche; 4 - Suppression des caractères; 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 si inchangé; 20 - Ignorer si inchangé 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. Plusieurs paramètres 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 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 "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 | Custom multiplier | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Right trim | list of characters2 | |||
| 3 | Left trim | list of characters2 | |||
| 4 | Trim | list of characters2 | |||
| 5 | Regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Boolean to decimal | 0, 1, 2, 3 | |||
| 7 | Octal to decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal to decimal | 0, 1, 2, 3 | |||
| 9 | Simple change | 0, 1, 2, 3 | |||
| 10 | Change per second | 0, 1, 2, 3 | |||
| 11 | XML XPath | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | In range | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Matches regular expression | pattern3 | 0, 1, 2, 3 | ||
| 15 | Does not match regular expression | pattern3 | 0, 1, 2, 3 | ||
| 16 | Check for error in JSON | path4 | 0, 1, 2, 3 | ||
| 17 | Check for error in XML | path4 | 0, 1, 2, 3 | ||
| 18 | Check for error using regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Discard unchanged | ||||
| 20 | Discard unchanged with heartbeat | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Prometheus pattern | pattern6, 7 | value, label, function |
output8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus to JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV to JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Replace | search string2 | replacement2 | ||
| 26 | Check unsupported | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML to JSON | 0, 1, 2, 3 | |||
| 28 | SNMP walk value | OID2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk to JSON10 | Field name2 | OID prefix2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 |
| 30 | SNMP get value | Format: 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | ||
1 nombre entier ou à 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, 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 de libellé, valeur de libellé 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 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.