Áú»¢¶Ä²©

This is the documentation page for an unsupported version of Áú»¢¶Ä²©.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.

> Objet ?±ô¨¦³¾±ð²Ô³Ù

Les objets suivants sont directement li¨¦s ¨¤ l'API item.

?±ô¨¦³¾±ð²Ô³Ù

Les ¨¦l¨¦ments Web ne peuvent pas ¨ºtre directement cr¨¦¨¦s, mis ¨¤ jour ou supprim¨¦s via l'API Áú»¢¶Ä²©.

L'objet ¨¦l¨¦ment a les propri¨¦t¨¦s suivantes.

±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ 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 Áú»¢¶Ä²© 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 Áú»¢¶Ä²© (actif), Áú»¢¶Ä²© interne, le trapper Áú»¢¶Ä²©, un ¨¦l¨¦ment d¨¦pendant, un agr¨¦gat Áú»¢¶Ä²©, 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 Áú»¢¶Ä²© ;
1 - agent SNMPv1 ;
2 - trapper Áú»¢¶Ä²© ;
3 - v¨¦rification simple ;
4 - agent SNMPv2 ;
5 - Áú»¢¶Ä²© interne ;
6 - agent SNMPv3 ;
7 - agent Áú»¢¶Ä²© (actif) ;
8 - agr¨¦gat Áú»¢¶Ä²© ;
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": "Áú»¢¶Ä²©" }
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.

±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ 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).