This is a translation of the original English documentation page. Help us make it better.

Sidebar

Zabbix Summit 2022
View presentations

> 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 a 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 les unités de temps avec suffixe (30s, 1m, 2h, 1d).
En option, un ou plusieurs intervalles personnalisés peuvent être spécifiés sous forme d'intervalles flexibles ou de planification.
Les intervalles sont séparés par un point-virgule.
Les macros utilisateur et les macros de règle de découverte bas niveau peuvent être utilisées. Une seule macro doit remplir tout le champ. Plusieurs macros dans un champ 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}).

Facultatif pour le trapper Zabbix ou l'élément dépendant.
hostid
(obligatoire)
string ID de l'hôte auquel appartient le prototype d'élément.

Pour les opérations de mise à jour, ce champ est en lecture seule.
ruleid
(obligatoire)
string ID de la règle de découverte bas niveau à laquelle l'élément appartient.

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éments hôtes.

Facultatif pour l'agent Zabbix (actif), Zabbix interne, le trapper Zabbix, l'élément dépendant, l'agrégat Zabbix, la surveillance de base de données et les prototypes d'élément calculés.
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 ;
1 - agent SNMPv1 ;
2 - trapper Zabbix ;
3 - vérification simple ;
4 - agent SNMPv2 ;
5 - Zabbix interne ;
6 - agent SNMPv3 ;
7 - agent Zabbix (actif) ;
8 - agrégat Zabbix ;
10 - vérification externe ;
11 - surveillance de base de données ;
12 - agent IPMI ;
13 - ahent SSH ;
14 - agent TELNET ;
15 - calculé ;
16 - agent JMX ;
17 - trap SNMP ;
18 - élément dépendant ;
19 - agent HTTP.
url
(obligatoire)
string Chaîne d'URL requise uniquement pour les prototypes d'élément d'agent HTTP. Prend en charge les macros de règle de découverte bas niveau, 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 - numérique flottant ;
1 - caractère ;
2 - log ;
3 - numérique non signé ;
4 - texte.
allow_traps integer Champ prototype d'élément d'agent HTTP. Permet de renseigner la valeur comme dans le type d'élément trapper également.

0 - (par défaut) Ne pas permettre d'accepter les données entrantes ;
1 - Permettre d'accepter les données entrantes.
authtype integer Utilisé uniquement par les prototypes d'élément d'agent SSH ou les prototypes d'élément d'agent HTTP.

Valeurs possibles de la méthode d'authentification de l'agent SSH :
0 - (par défaut) mot de passe ;
1 - clé publique.

Valeurs possibles de la méthode d'authentification de l'agent HTTP :
0 - (par défaut) aucune ;
1 - basique
2 - NTLM.
description string Description du prototype d'élément.
follow_redirects integer Champ prototype d'élément d'agent HTTP. Suivre les redirections lors de la mise en pool des données.

0 - Ne pas suivre les redirections ;
1 - (par défaut) Suivre les redirections.
headers object Champ prototype d'élément d'agent HTTP. Objet avec en-tête de requête HTTP(S), où le nom d'en-tête est utilisé en tant que clé et la valeur d'en-tête en tant que valeur.

Exemple:
{ "User-Agent": "Zabbix" }
history string Unité de temps de la durée pendant laquelle les données d’historique doivent être stockées. Accepte également les macros utilisateur et les règles de découverte bas niveau.

Par défaut : 90d.
http_proxy string Champ de prototype d'élément d'agent HTTP. Chaîne de connexion proxy HTTP(S).
ipmi_sensor string Capteur IPMI. Utilisé uniquement par les prototypes d'éléments IPMI.
jmx_endpoint string Chaîne de connexion personnalisée de l'agent JMX.

Valeurs par défaut :
service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi
logtimefmt string Format de l'heure dans les entrées du journal. Utilisé uniquement par les prototypes d'éléments de journal.
master_itemid integer ID de l'élément maître.
La récursivité d'un maximum de 3 éléments dépendants et prototypes d'éléments, et le nombre maximal d'éléments dépendants et de prototypes d'éléments égal à 999 sont autorisés.

Requis par les éléments dépendants.
output_format integer Champ prototype d'élément d'agent HTTP. La réponse doit-elle être convertie en JSON.

0 - (par défaut) Stocker des données brutes ;
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éments de surveillance de base de données ;
- formule pour les prototypes d'éléments calculés.
password string Mot de passe pour l'authentification. Utilisé pour les vérifications simples, SSH, Telnet, surveillance de base de données, prototypes d'élément d'agent JMX et HTTP.
port string Port surveillé par le prototype d'élément. Utilisé uniquement par le prototype d'élément SNMP.
post_type integer Champ prototype d'élément d'agent HTTP. Type de corps de données POST stocké dans la propriété de publication.

0 - (par défaut) Données brutes ;
2 - données JSON ;
3 - données XML.
posts string Champ prototype d'élément d'agent HTTP. Données du corps de la demande 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 prototype d'élément d'agent HTTP. Paramètres de requête. Tableau d'objets avec des paires 'key':'value', où la valeur peut être une chaîne vide.
request_method integer Champ 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 prototype d'élément d'agent HTTP. Partie de la réponse devant être stockée.

0 - (par défaut) Corps ;
1 - Entêtes ;
2 - Corps et entêtes.

Pour request_method défini à HEAD, seule la valeur 1 est autorisée.
snmp_community string Communauté SNMP.

Utilisé uniquement par les prototypes d'élément SNMPv1 et SNMPv2.
snmp_oid string OID SNMP.
snmpv3_authpassphrase string Phrase secrète d'authentification SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.
snmpv3_authprotocol integer Protocole d'authentification SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.

Valeurs possibles :
0 - (par défaut) MD5 ;
1 - SHA.
snmpv3_contextname string Nom du contexte SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.
snmpv3_privpassphrase string Phrase secrète privée SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.
snmpv3_privprotocol integer Protocole de confidentialité SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.

Valeurs possibles :
0 - (par défaut) DES ;
1 - AES.
snmpv3_securitylevel integer Niveau de sécurité SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.

Valeurs possibles :
0 - noAuthNoPriv ;
1 - authNoPriv ;
2 - authPriv.
snmpv3_securityname string Nom de sécurité SNMPv3. Utilisé uniquement par les prototypes d'élément SNMPv3.
ssl_cert_file string Champ prototype d'élément d'agent HTTP. Chemin du fichier de la clé SSL publique.
ssl_key_file string Champ prototype d'élément d'agent HTTP. Chemin du fichier de la clé SSL privée.
ssl_key_password string Champ 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 - (par défaut) prototype d'élément activé ;
1 - prototype d'élément désactivé ;
3 - prototype d'élément non supporté.
status_codes string Champ prototype d'élément d'agent HTTP. Plage de codes de statut HTTP requis séparés par des virgules. Prend également en charge les macros utilisateur ou les macros de règle de découverte bas niveau 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 modèle parent du prototype d'élément.
timeout string Champ prototype d'élément d'agent HTTP. Délai d'expiration de la demande d'interrogation de données d'élément. Prend en charge les macros utilisateur et les macros de règle de découverte bas niveau.

Par défaut : 3s.
Valeur maximale : 60s.
trapper_hosts string Hôtes autorisés. Utilisé par les prototypes d'élément trapper ou les prototypes d'élément HTTP.
trends string Unité de temps de la durée pendant laquelle les données de tendance doivent être stockées. Accepte également les macros utilisateur et de règle de découverte bas niveau.

Par défaut : 365d.
units string Unités de valeur.
username string Nom d'utilisateur pour l'authentification. Utilisé pour les vérifications simples, SSH, Telnet, surveillance de base de données, prototypes d'élément d'agent JMX et HTTP.

Requis par les prototypes d'éléments SSH et Telnet.
valuemapid string ID de la table de correspondance associée.
verify_host integer Champ prototype d'élément d'agent HTTP. Valide que le nom de l'hôte dans l'URL se trouve dans le champ Nom commun ou dans le champ Autre nom du sujet du certificat de l'hôte.

0 - (par défaut) Ne pas valider ;
1 - Valider.
verify_peer integer Champ prototype d'élément d'agent HTTP. Valide qu'il s'agit d'un certificat d'hôte authentique.

0 - (par défaut) Ne pas valider ;
1 - Valider.