Documentation
Table of Contents
> 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 | string | (lecture seule) ID du prototype d'élément. |
| delay (obligatoire) |
string | Intervalle de mise à jour du prototype d'é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 le prorotype d'élément. Pour les opérations de mise à jour, ce champ est en lecture seule. |
| ruleid (obligatoire) |
string | ID de la règle LLD à laquelle 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 du prototype d'élément. Utilisé uniquement pour les prototypes d' élément hôtes. Non requis pour les prototypes d'éléments d'agent Zabbix (actif), Zabbix interne, trapper Zabbix, calculé, dépendant, moniteur de base de données et script. Facultatif pour les prototypes d'éléments d'agent HTTP. |
| key_ (obligatoire) |
string | Clé du prototype d'élément. |
| name (obligatoire) |
string | Nom du prototype d'élément. |
| type (obligatoire) |
integer | Type du prototype d'é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 de prototype 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 du prototype d'élément. Valeurs possibles : 0 - nombre flottant ; 1 - caractère ; 2 - journal ; 3 - numérique non signé ; 4 - texte. |
| allow_traps | integer | Champ de prototype 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 prototypes d'élément 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 du prototype d'élément. |
| follow_redirects | integer | Champ du prototype 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 du prototype 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 du prototype d'élément d'agent HTTP. Chaîne de connexion proxy HTTP(S). |
| ipmi_sensor | string | Capteur IPMI. Utilisé uniquement par les prototype d'élément 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 |
| logtimefmt | string | Format de l'heure dans les entrées de journal. Utilisé uniquement par les prototypes d'élément 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 et de prototypes d'éléments dépendants égal à 29 999 sont autorisés. Requis par les éléments dépendants. |
| output_format | integer | Champ du prototype 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 de prototype d'élément : - script exécuté pour les prototypes d'élément SSH et Telnet ; - requête SQL pour les prototypes d'élément de surveillance de base de données ; - formule pour les prototypes d'élément calculés. |
| parameters | array | Paramètres supplémentaires pour les prototypes d'élément 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, prototypes d'élément d'agent JMX et HTTP. |
| post_type | integer | Champ de prototype 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 de prototype d'élément d'agent HTTP. Données du corps de la requête HTTP(S). Utilisé avec post_type. |
| privatekey | string | Nom du fichier de clé privée. |
| publickey | string | Nom du fichier de clé publique. |
| query_fields | array | Champ de prototype 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 de prototype 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 de prototype 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 de prototype d'élément d'agent HTTP. Chemin d'accès au fichier de clé SSL publique. |
| ssl_key_file | string | Champ de prototype d'élément d'agent HTTP. Chemin d'accès au fichier de clé SSL privée. |
| ssl_key_password | string | Champ de prototype d'élément d'agent HTTP. Mot de passe pour le fichier de clé SSL. |
| status | integer | Statut du prototype d'élément. Valeurs possibles : 0 - prototype d'élément activé (par défaut) ; 1 - prototype d'élément désactivé ; 2 - prototype d'élément non supporté. |
| status_codes | string | Champ de prototype 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 du prototype d'élément du modèle parent. |
| timeout | string | Délai d'expiration de la demande d'interrogation des données d'élément. Utilisé pour l'agent HTTP et les prototypes d'élément 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 prototypes d'élément de trappeur ou les prototypes d'élément 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, prototypes d'élément d'agent JMX et HTTP. Requis par les prototypes d'élément SSH et Telnet. |
| uuid | string | Identifiant unique universel, utilisé pour lier un prototype d'élément importé à des prototypes d'élément déjà existants. Utilisé uniquement pour les prototypes d'élément 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 de prototype 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 de prototype 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. |
| 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. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Tag de prototype d'élément
L'objet de tag de prototype d'élément a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (obligatoire) |
string | Nom du tag du prototype d'élément. |
| value | string | Valeur du tag du prototype d'élément. |
Prétraitement du prototype d'élément
The item prototype preprocessing object has the following properties.
| Propriété | Type | Description |
|---|---|---|
| type (obligatoire) |
integer | Le type d'option de prétraitement. Valeurs possibles : 1 - Multiplicateur personnalisé ; 2 - Suppression des espaces à droite ; 3 - Suppression des espaces à gauche ; 4 - Suppression des espaces à droite et à gauche ; 5 - Correspondance d'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'interval ; 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 - Supprimer sans modification ; 20 - Supprimer sans modification avec heartbeat ; 21 - JavaScript ; 22 - Motif Prometheus ; 23 - Prometheus vers JSON ; 24 - CSV vers JSON ; 25 - Remplacer ; 26 - Vérifier les valeurs non prises en charge ; 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 : 0 - Le message d'erreur est défini par le serveur Zabbix ; 1 - Supprimer la valeur ; 2 - Définir la valeur personnalisée ; 3 - Définir le 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 | Suppression des espaces à droite | liste de caractères2 | |||
| 3 | Suppression des espaces à gauche | liste de caractères2 | |||
| 4 | Suppression des espaces à droite et à gauche | liste de caractères2 | |||
| 5 | Correspondance d’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’interval | 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ère3 | 0, 1, 2, 3 | |||
| 16 | Rechercher une erreur dans JSON | chemin4 | 0, 1, 2, 3 | ||
| 17 | Rechercher une erreur dans XML | chemin4 | 0, 1, 2, 3 | ||
| 18 | Rechercher une erreur à l’aide d’une expression régulière | motif3 | sortie2 | 0, 1, 2, 3 | |
| 19 | Supprimer sans modification | ||||
| 20 | Supprimer sans modification 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 de recherche2 | remplacement2 | ||
| 26 | Vérifier les valeurs non prises en charge | 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, macro LLD
7 motif Prometheus suivant la syntaxe : <metric name>{<label name>="<label value>", ...} == <value>. Chaque composant deu 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 One of the aggregation functions: sum, min, max, avg, count if function is selected as the second parameter.