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


Sidebar

fr:manual:api:reference:discoveryrule:object

> Objet règle de découverte bas niveau

Les objets suivants sont directement liés à l'API discoveryrule.

Règle de découverte bas niveau

L'objet règle de découverte bas niveau a les propriétés suivantes.

Propriété Type Description
itemid string (lecture seule) ID de règle de découverte bas niveau.
delay
(obligatoire)
string Intervalle de mise à jour de la règle. Accepte des secondes ou une unité de temps avec suffixe avec ou sans un ou plusieurs intervalles personnalisés comprenant des intervalles flexibles et des intervalles de planification sous forme de chaînes sérialisées. Accepte également les macros utilisateur. Les intervalles flexibles peuvent être écrits sous la forme de deux macros séparées par une barre oblique. Les intervalles sont séparés par un point-virgule.
hostid
(obligatoire)
string ID de l'hôte auquel la règle LLD appartient.
interfaceid
(obligatoire)
string ID de l'interface hôte de la règle. Utilisé uniquement pour les règles d'hôte.

Facultatif pour les règles agent Zabbix (actif), Zabbix interne, Zabbix trapper et surveillance base de données.
key_
(obligatoire)
string Clé de la règle de découverte bas niveau.
name
(obligatoire)
string Nom de la règle de découverte bas niveau.
type
(obligatoire)
integer
url
(obligatoire)
string Chaîne de l'URL, obligatoire pour la règle de découverte bas niveau agent HTTP. Prend en charge les macros utilisateur, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.
allow_traps integer Champ de la règle de découverte bas niveau agent HTTP. Permet de renseigner la valeur comme avec le type d'élément trapper.

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 pour les règles de découverte bas niveau agent SSH et 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 la règle de découverte bas niveau.
error string (lecture seule) Texte d'erreur en cas de problèmes de mise à jour de la règle de découverte bas niveau.
follow_redirects integer Champ de la règle de découverte bas niveau 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 de la règle de découverte bas niveau agent HTTP. Objet avec en-tête de requête HTTP(S), où 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” }
http_proxy string Champ de la règle de découverte bas niveau agent HTTP. Chaîne de connexion du proxy HTTP(S).
ipmi_sensor string Champ de la règle de découverte bas niveau agent IPMI. Capteur 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
lifetime string Période après laquelle les éléments qui ne sont plus découverts seront supprimés. Accepte les secondes, les unités de temps avec suffixe et les macros utilisateur.

Par défaut : 30d.
output_format integer Champ de la règle de découverte bas niveau agent HTTP. La réponse doit-elle être convertie en JSON ?

0 - (par défaut) Stocker à l'état brut.
1 - Convertir en JSON.
params string Paramètres supplémentaires en fonction du type de règle LLD :
- script exécuté pour les règles de découverte bas niveau SSH et Telnet;
- Requête SQL pour les règles de découverte bas niveau de surveillance de base de données ;
- formule pour les règles de découverte bas niveau calculées.
password string Mot de passe pour l'authentification. Utilisé par les règles de découverte bas niveau Vérification simple, SSH, Telnet, surveillance de base de données, JMX et HTTP.
port string Port utilisé par la règle de découverte bas niveau. Utilisé uniquement par les règles SNMP.
post_type integer Champ pour les règles de découverte bas niveau 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 pour les règles de découverte bas niveau 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 pour les règles de découverte bas niveau HTTP. Paramètres de requête. Tableau d'objets avec des paires 'key': 'value', où 'value' peut être une chaîne vide.
request_method integer Champ pour les règles de découverte bas niveau HTTP. Type de méthode de requête.

0 - (par défaut) GET
1 - POST
2 - PUT
3 - HEAD
retrieve_mode integer Champ pour les règles de découverte bas niveau 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, la seule valeur autorisée est 1.
snmp_community string Communauté SNMP.

Obligatoire pour les règles de découverte bas niveau SNMPv1 et SNMPv2.
snmp_oid string OID SNMP.
snmpv3_authpassphrase string Phrase secrète d'authentification SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.
snmpv3_authprotocol integer Protocole d'authentification SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.

lecture seule
0 - (par défaut) MD5 ;
1 - SHA.
snmpv3_contextname string Nom du contexte SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.
snmpv3_privpassphrase string Phrase secrète privée SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.
snmpv3_privprotocol integer Protocole de confidentialité SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.

Valeurs possibles :
0 - (par défaut) DES ;
1 - AES.
snmpv3_securitylevel integer Niveau de sécurité SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.

Valeurs possibles :
0 - noAuthNoPriv ;
1 - authNoPriv ;
2 - authPriv.
snmpv3_securityname string Nom de sécurité SNMPv3. Utilisé uniquement pour les règles de découverte bas niveau SNMPv3.
ssl_cert_file string Champ pour les règles de découverte bas niveau HTTP. Chemin du fichier de la clé SSL publique.
ssl_key_file string Champ pour les règles de découverte bas niveau HTTP. Chemin du fichier de la clé SSL privée.
ssl_key_password string Champ pour les règles de découverte bas niveau HTTP. Mot de passe pour le fichier de clé SSL.
state integer (lecture seule) État de la règle de découverte bas niveau.

Valeurs possibles :
0 - (par défaut) normale ;
1 - non supportée.
status integer Statut de la règle de découverte bas niveau.

Valeurs possibles :
0 - (par défaut) activée ;
1 - désactivée.
status_codes string Champ pour les règles de découverte bas niveau HTTP. Plages de codes d’état HTTP obligatoires séparées 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 modèle parent de la règle de découverte bas niveau.
timeout string Champ pour les règles de découverte bas niveau HTTP. Délai d'expiration de la demande d'interrogation de données d'élément. Supporte les macros utilisateur.

par défaut : 3s
valeur maximale : 60s
trapper_hosts string Hôtes autorisés. Utilisé par les règles de découverte bas niveau trapper ou HTTP.
username string Nom d'utilisateur pour l'authentification. Utilisé pour les règles de découverte bas niveau vérification simple, SSH, Telnet, surveillance de bases de données, JMX et HTTP.

Obligatoire les règles de découverte bas niveau SSH et Telnet.
verify_host integer Champ pour les règles de découverte bas niveau HTTP. Valider le nom d'hôte de l'URL se trouvant 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 pour les règles de découverte bas niveau HTTP. Valider que le certificat d'hôte est authentique.

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

Filtre de règle de découverte bas niveau

L'objet Filtre de règle de découverte bas niveau définit un ensemble de conditions pouvant être utilisées pour filtrer les objets découverts. Il a les propriétés suivantes :

Propriété Type Description
conditions
(obligatoire)
array Ensemble de conditions de filtrage à utiliser pour filtrer les résultats.
evaltype
(obligatoire)
integer Méthode d'évaluation des conditions de filtrage.

Valeurs possibles :
0 - et/ou ;
1 - et ;
2 - ou ;
3 - expression personnalisée.
eval_formula string (lecture seule) Expression générée qui sera utilisée pour évaluer les conditions de filtre. L'expression contient des ID qui se réfèrent à des conditions de filtre spécifiques par leur formulaid. La valeur de eval_formula est égale à celle de formula pour les filtres avec une expression personnalisée.
formula string Expression définie par l'utilisateur à utiliser pour évaluer les conditions de filtres avec une expression personnalisée. L'expression doit contenir des identifiants faisant référence à des conditions de filtre spécifiques par leur formulaid. Les identifiants utilisés dans l'expression doivent correspondre exactement à ceux définis dans les conditions de filtre : aucune condition ne peut rester non utilisée ou omise.

Obligatoire pour les filtres d'expression personnalisés.

Condition de filtre de règle de découverte bas niveau

L'objet Condition de filtre de règle de découverte bas niveau définit une vérification distincte à effectuer sur la valeur d'une macro de découverte bas niveau. Il a les propriétés suivantes :

Propriété Type Description
macro
(obligatoire)
string Macro de découverte bas niveau pour effectuer le contrôle.
value
(obligatoire)
string Valeur à comparer.
formulaid string ID unique arbitraire utilisé pour référencer la condition à partir d'une expression personnalisée. Ne peut contenir que des majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtre, mais sera généré à nouveau lors de la demande ultérieure.
operator integer Opérateur de la condition.

Valeurs possibles :
8 - (par défaut) correspond à l'expression régulière ;
9 - ne correspond pas à l'expression régulière ;.
Pour mieux comprendre comment utiliser les filtres avec différents types d'expressions, voir des exemples dans les pages des méthodes discoveryrule.get et discoveryrule.create