Zabbix Documentation 4.0

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools

This translation is older than the original page and might be outdated. See what has changed.

Sidebar

fr:manual:api:reference:item:object

> 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 a 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 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 un élément dépendant.
hostid
(obligatoire)
string ID de l'hôte 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.

Facultatif pour l'agent Zabbix (actif), Zabbix interne, le trapper Zabbix, un élément dépendant, un agrégat Zabbix, la surveillance de base de données et les éléments calculés.
key_
(obligatoire)
string Clé de l'élément.
name
(obligatoire)
string Nom de l'élément.
type
(obligatoire)
integer Type 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 - agent 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 éléments 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 de l'élément.

Valeurs possibles :
0 - numérique flottant ;
1 - caractère ;
2 - log ;
3 - numérique non signé ;
4 - texte.
allow_traps integer Champ 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 é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 - (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 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'élément.

Valeurs possibles :
0 - un élément brut ;
4 - un élément découvert.
follow_redirects integer Champ 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 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 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 règle de découverte bas niveau.

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 de l'hôte rempli par l'élément.

Se référer à la page inventaire d'hôte pour une liste des champs d'inventaire supportés et leurs ID.

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.

Cette propriété ne renverra qu'une valeur pour la période configurée dans ZBX_HISTORY_PERIOD.
lastns integer (lecture seule) Nanosecondes lors de la dernière mise à jour de l'élément.

Cette propriété ne renverra qu'une valeur pour la période configurée dans ZBX_HISTORY_PERIOD.
lastvalue string (lecture seule) Dernière valeur de l'élément.

Cette propriété ne renverra qu'une valeur pour la période configurée dans ZBX_HISTORY_PERIOD.
logtimefmt string Format de l'heure dans les entrées du journal. Utilisé uniquement par les é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 d'éléments égal à 999 sont autorisés.

Requis par les éléments dépendants.
mtime timestamp Heure à laquelle le fichier journal surveillé a été mis à jour pour la dernière fois. Utilisé uniquement par les éléments de journal.
output_format integer Champ 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 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.
password string Mot de passe pour l'authentification. Utilisé pour les vérifications simples, SSH, Telnet, surveillance de base de données, les éléments d'agent JMX et HTTP.
port string Port surveillé par l'élément. Utilisé uniquement par l'élément SNMP.
post_type integer Champ d'élément d'agent HTTP. Type de corps de données de publication 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 d'élément d'agent HTTP. Données du corps de la demande HTTP(S). Utilisé avec post_type.
prevvalue string (lecture seule) Valeur précédente de l'élément.

Cette propriété ne renverra qu'une valeur pour la période configurée dans ZBX_HISTORY_PERIOD.
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 'key':'value', 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. 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 éléments SNMPv1 et SNMPv2.
snmp_oid string OID SNMP.
snmpv3_authpassphrase string Phrase secrète d'authentification SNMPv3. Utilisé uniquement par les éléments SNMPv3.
snmpv3_authprotocol integer Protocole d'authentification SNMPv3. Utilisé uniquement par les éléments SNMPv3.

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

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

Valeurs possibles :
0 - noAuthNoPriv ;
1 - authNoPriv ;
2 - authPriv.
snmpv3_securityname string Nom de sécurité SNMPv3. Utilisé uniquement par les éléments SNMPv3.
ssl_cert_file string Champ d'élément d'agent HTTP. Chemin du fichier de la clé SSL publique.
ssl_key_file string Champ d'élément d'agent HTTP. Chemin du fichier de la 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 supporté.
status integer Statut de l'élément.

Valeurs possibles :
0 - (par défaut) élément activé ;
1 - élément désactivé ;
3 - élément non supporté.
status_codes string Champ 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 de l'élément.
timeout string Champ 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 éléments trapper ou les éléments 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, éléments d'agent JMX et HTTP.

Requis par les éléments SSH et Telnet.
valuemapid string ID de la table de correspondance associée.
verify_host integer Champ 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 d'hôte.

0 - (par défaut) Ne pas valider ;
1 - Valider.
verify_peer integer Champ 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.

Pré-traitement d'élément

L'objet 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 - Supprimer les espaces à droite ;
3 - Supprimer les espaces à gauche ;
4 - Supprimer les 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.
params
(obligatoire)
string Paramètres supplémentaires utilisés par l'option de pré-traitement. Plusieurs paramètres sont séparés par un caractère LF (\n).