Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> Objet Règle LLD

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

Règle LLD

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

Propriété Type Description
itemid string (lecture seule) ID de la règle LLD.
delay
(obligatoire)
string Intervalle de mise à jour de la règle LLD. Accepte les secondes ou l'unité de temps avec suffixe et avec ou sans un ou plusieurs intervalles personnalisés qui se composent d'intervalles flexibles et d'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.

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 auquel appartient la règle LLD.
interfaceid
(obligatoire)
string ID de l'interface hôte de la règle LLD. Utilisé uniquement pour les règles LLD d'hôte.

Non requis pour l'agent Zabbix (actif), Zabbix interne, le trappeur Zabbix, dépendant, le moniteur de base de données et les règles LLD script. Facultatif pour les règles LLD de l'agent HTTP.
key_
(obligatoire)
string Clé de la règle LLD.
name
(obligatoire)
string Nom de la règle LLD.
type
(obligatoire)
integer Type de la règle LLD..

Valeurs possibles :
0 - agent Zabbix ;
2 - trappeur Zabbix ;
3 - vérification simple ;
5 - Zabbix interne ;
7 - agent Zabbix (actif) ;
10 - vérification externe ;
11 - moniteur de base de données ;
12 - agent IPMI ;
13 - agent SSH ;
14 - agent TELNET ;
16 - agent JMX ;
18 - élément dépendant ;< br>19 - Agent HTTP ;
20 - Agent SNMP ;
21 - Script.
url
(obligatoire)
string Chaîne URL, requise pour la règle LLD de l'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 LLD de l'agent HTTP. Autoriser également le remplissage de la valeur comme dans le type d'élément 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 règles LLD de l'agent SSH ou de l'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
description string Description de la règle LLD.
error string (lecture seule) Texte d'erreur en cas de problèmes de mise à jour de la règle LLD.
follow_redirects integer Champ de règle LLD de l'agent HTTP. Suivre les redirections de réponse lors du regroupement des données.

0 : Ne pas suivre les redirections.
1 : (par défaut) Suivez les redirections.
headers object Champ de règle LLD de l'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" }
http_proxy string Champ de règle LLD de l'agent HTTP. Chaîne de connexion proxy HTTP(S).
ipmi_sensor string Capteur IPMI. Utilisé uniquement par les règles IPMI LLD.
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, l'unité de temps avec suffixe et la macro utilisateur.

Par défaut : 30d.
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 dépendants égal à 999 sont autorisés.
La règle de découverte ne peut pas être l'élément principal pour une autre règle de découverte.

Obligatoire pour l'élément dépendant.
output_format integer Champ de règle LLD de l'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 règle LLD :
- script exécuté pour les règles LLD SSH et Telnet ;
- requête SQL pour les règles LLD moniteur de base de données ;
- formule pour les règles LLD calculées.
parameters array Paramètres supplémentaires pour la règle LLD de type 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é pour vérification simple, SSH, Telnet, moniteur de base de données, règles LLD JMX et agent HTTP.
post_type integer Champ de règle LLD de l'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 règle LLD de l'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 règle LLD de l'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 règle LLD de l'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 règle LLD de l'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 règle LLD de l'agent HTTP. Chemin d'accès au fichier de clé SSL publique.
ssl_key_file string Champ de règle LLD de l'agent HTTP. Chemin d'accès au fichier de clé SSL privée.
ssl_key_password string Champ de règle LLD de l'agent HTTP. Mot de passe pour le fichier de clé SSL.
state integer (lecture seule) État de la règle LLD.

Valeurs possibles :
0 - (par défaut) normal ;
1 - non pris en charge.
status integer Statut de la règle LLD.

Valeurs possibles :
0 - (par défaut) règle LLD activée ;
1 - règle LLD désactivée.
status_codes string Champ de règle LLD de l'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 de la règle LLD 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 règles LLD script. Prend en charge les macros utilisateur.

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

Requis par les règles LLD SSH et Telnet.
uuid string Identifiant unique universel, utilisé pour lier les règles LLD importées à celles déjà existantes. Utilisé uniquement pour les règles LLD sur les 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.
verify_host integer Champ de règle LLD agent HTTP. Valide 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 règle LLD agent HTTP. Valide si le certificat de l'hôte est authentique.

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

Filtre de règle LLD

L'objet de filtre de règle LLD définit un ensemble de conditions qui peuvent ê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 filtre à utiliser pour filtrer les résultats.
evaltype
(obligatoire)
integer Méthode d'évaluation de la condition de filtre.

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 identifiants qui font référence à des conditions de filtre spécifiques par son formulaid. La valeur de eval_formula est égale à la valeur de formula pour les filtres avec une expression personnalisée.
formula string Expression définie par l'utilisateur à utiliser pour évaluer les conditions des filtres avec une expression personnalisée. L'expression doit contenir des ID faisant référence à des conditions de filtre spécifiques par son formulaid. Les ID utilisés dans l'expression doivent correspondre exactement à ceux définis dans les conditions de filtre : aucune condition ne peut rester inutilisée ou omise.

Requis pour les filtres d'expression personnalisés.

Condition de filtre de règle LLD

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

Propriété Type Description
macro
(obligatoire)
string Macro LLD sur laquelle effectuer la vérification.
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 lettres majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtrage, mais sera généré à nouveau lors de sa demande ultérieure.
operator integer Opérateur de condition.

Valeurs possibles :
8 - (par défaut) correspond à l'expression régulière ;
9 - ne correspond pas à l'expression régulière ;
12 - existe ;
13 -n'existe pas.

Pour mieux comprendre comment utiliser les filtres avec différents types d'expressions, consultez les exemples sur les pages de méthode discoveryrule.get et discoveryrule.create.

Chemin de macro LLD

Le chemin de la macro LLD a les propriétés suivantes :

Propriété Type Description
lld_macro
(obligatoire)
string Macro LLD.
path
(obligatoire)
string Sélecteur de valeur qui sera affectée à la macro correspondante.

Prétraitement de règle LLD

L'objet de prétraitement de règle LLD a les propriétés suivantes.

Propriété Type Description
type
(obligatoire)
integer Le type d'option de prétraitement.

Valeurs possibles :
5 - Correspondance d'expression régulière ;
11 - XML ​​XPath ;
12 - JSONPath ;
15 - Ne correspond pas à l'expression régulière ;< br>16 - Rechercher une erreur dans JSON ;
17 - Rechercher une erreur dans XML ;
20 - Ecarter inchangé avec heartbeat ;
23 - Prometheus vers JSON ;
24 - CSV vers JSON ;< br>25 - Remplacer ;
27 - XML ​​vers JSON.
params
(obligatoire)
string Paramètres supplémentaires utilisés par l'option de prétraitement. Paramètres multiples 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.

Valeurs possibles :
0 - Le message d'erreur est défini par le serveur Zabbix ;
1 - Supprimer la valeur ;
2 - Définir la valeur personnalisée ;< br>3 - Définir un 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
5 Expression régulière motif1 sortie2 0, 1, 2, 3
11 XML XPath chemin3 0, 1, 2, 3
12 JSONPath chemin3 0, 1, 2, 3
15 Ne correspond pas à l'expression régulière motif1 0, 1, 2, 3
16 Rechercher une erreur dans JSON chemin3 0, 1, 2, 3
17 Rechercher une erreur dans XML chemin3 0, 1, 2, 3
20 Ecarter inchangé avec heartbeat secondes4, 5, 6
23 Prometheus vers JSON motif5, 7 0, 1, 2, 3
24 CSV vers JSON character2 caractère2 0,1 0, 1, 2, 3
25 Remplacer search string2 remplacement2
27 XML vers JSON 0, 1, 2, 3

1 expression régulière
2 chaîne de caractères
3 JSONPath ou XML XPath
4 entier positif (avec prise en charge des suffixes temporels, par ex. 30s, 1m, 2h, 1d)
5 macro utilisateur
6 macro LLD
7 motif Prometheus suivant la syntaxe : <nom de la métrique>{<nom de l'étiquette>="<valeur de l'étiquette>", ...} == <valeur>. Chaque composant de motif Prometheus (métrique, nom d'étiquette, valeur d'étiquette et valeur de métrique) peut être une macro utilisateur.
8 Sortie Prometheus suivant la syntaxe : <nom de l'étiquette>.

Surcharge de règle LLD

L'objet de surcharge de règle LLD définit un ensemble de règles (filtres, conditions et opérations) qui sont utilisées pour remplacer les propriétés de différents objets prototypes. Il a les propriétés suivantes :

Propriété Type Description
name
(obligatoire)
string Nom unique de surcharge.
step
(obligatoire)
integer Numéro d'ordre unique de la surcharge.
stop integer Arrêt de traitement des prochaines surcharges si correspondances.

Valeurs possibles :
0 - (par défaut) n'arrête pas de traiter les surcharges ;
1 - arrête de traiter les surcharges si le filtre correspond.
filter object Filtre de surcharge.
operations array Opérations de surcharge.

Filtre de surcharge de règle LLD

L'objet de filtre de surcharge de règle LLD définit un ensemble de conditions qui, si elles correspondent à l'objet découvert, la surcharge est appliquée. Il a les propriétés suivantes :

Propriété Type Description
evaltype
(obligatoire)
integer Remplacer la méthode d'évaluation de la condition de filtre.

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

Requis pour les filtres de surcharge expression personnalisée.

Condition de filtre de surcharge de règle LLD

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

Propriété Type Description
macro
(obligatoire)
string Macro LLD pour effectuer la vérification.
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 lettres majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtrage, mais sera généré à nouveau lors de sa demande ultérieure.
operator integer Opérateur de condition.

Valeurs possibles :
8 - (par défaut) correspond à l'expression régulière ;
9 - ne correspond pas à l'expression régulière ;
12 - existe ;
13 - n'existe pas.

Opération de surcharge de règle LLD

L'opération de surcharge de règle LLD est une combinaison de conditions et d'actions à effectuer sur l'objet prototype. Il a les propriétés suivantes :

Propriété Type Description
operationobject
(obligatoire)
integer Type d'objet découvert pour effectuer l'action.

Valeurs possibles :
0 - Prototype d'élément ;
1 - Prototype de déclencheur ;
2 - Prototype de graphique ;
3 - Prototype d'hôte.
operator integer Opérateur de condition de surcharge.

Valeurs possibles :
0 - (par défaut) est égal ;
1 - n'est pas égal ;
2 - contient ;
3 - ne contient pas ;
8 - correspond ;
9 - ne correspond pas.
value string Motif pour faire correspondre l'élément, le déclencheur, le graphique ou le nom du prototype d'hôte en fonction de l'objet sélectionné.
opstatus object Objet statut d'opération de surcharge pour les objets de prototype d'élément, de déclencheur et d'hôte.
opdiscover object Objet statut d'opération de surcharge de découverte (tout type d'objet).
opperiod object Objet période d'opération de surcharge (intervalle de mise à jour) pour l'objet prototype d'élément.
ophistory object Objet historique d'opération de surcharge pour l'objet prototype d'élément.
optrends object Objet tendances d'opération de surcharge pour l'objet prototype d'élément.
opseverity object Objet sévérité d'opération de surcharge pour l'objet prototype de déclencheur.
optag array Objet tag d'opération de surcharge pour l'objet prototype d'hôte.
optemplate array Objet modèle d'opération de surcharge pour l'objet prototype d'hôte.
opinventory object Objet inventaire d'opération de surcharge pour l'objet prototype d'hôte.
Statut de l'opération de surcharge de la règle LLD

Statut d'opération de surcharge de règle LLD qui est défini sur objet découvert. Il a les propriétés suivantes :

Propriété Type Description
status
(obligatoire)
integer Remplace le statut de l'objet sélectionné.

Valeurs possibles :
0 - Création activée ;
1 - Création désactivée.
Opération de surcharge de découverte de la règle LLD

Statut l'opération de surcharge de découverte de la règle LLD qui est défini sur l'objet découvert. Il a les propriétés suivantes :

Propriété Type Description
discover
(obligatoire)
integer Surcharge l'état de découverte de l'objet sélectionné.

Valeurs possibles :
0 - Oui, continuer à découvrir les objets ;
1 - Non, les nouveaux objets ne seront pas découverts et les objets existants seront marqués comme perdus .
Période d'opération de surcharge de la règle LLD

La période d'opération de surcharge de règle LLD est une valeur d'intervalle de mise à jour (prend en charge les intervalles personnalisés) qui est définie sur l'élément découvert. Il a les propriétés suivantes :

Propriété Type Description
delay
(obligatoire)
string Surcharge l'intervalle de mise à jour du prototype d'élément. Accepte les secondes ou une unité de temps avec suffixe (30s,1m,2h,1d) ainsi que des intervalles flexibles et de planification et des macros utilisateur ou LLD. Les intervalles multiples sont séparés par un point-virgule.
Opération de surcharge de l'historique de la règle LLD

L'opération de surcharge de l'historique de la règle LLD définie sur l'élément découvert. Il a les propriétés suivantes :

Propriété Type Description
history
(obligatoire)
string Surcharge l'historique du prototype d'élément qui est une unité de temps de la durée pendant laquelle les données d'historique doivent être stockées. Accepte également la macro utilisateur et la macro LLD.
Opération de surcharge des tendances de la règle LLD

L'opération de surcharge des tendances de la règle LLD définie sur l'élément découvert. Il a les propriétés suivantes :

Propriété Type Description
trends
(obligatoire)
string Surcharge les tendances du prototype d'élément qui est une unité de temps de la durée pendant laquelle les données de tendances doivent être stockées. Accepte également la macro utilisateur et la macro LLD.
Opération de surcharge de la sévérité de la règle LLD

L'opération de surcharge de la sévérité de la règle LLD définie sur le déclencheur découvert. Il a les propriétés suivantes :

Propriété Type Description
severity
(obligatoire)
integer Surcharge la sévérité du prototype de déclencheur.

Les valeurs possibles sont : 0 - (par défaut) non classifié ;
1 - information ;
2 - avertissement ;
3 - moyenne ;<br >4 - élevé ;
5 - désastre.
Opération de surcharge de tag de la règle LLD

L'opération de surcharge de tag de la règle LLD contient le nom et la valeur du tag définis sur l'objet découvert. Il a les propriétés suivantes :

Propriété Type Description
tag
(obligatoire)
string Nouveau nom de tag.
value string Nouvelle valeur de tag.
Opération de surcharge de modèle de la règle LLD

Objet d'opération de surcharge de modèle lié à l'hôte découvert. Il a les propriétés suivantes :

Propriété Type Description
templateid
(obligatoire)
string Surcharge le modèle des modèles liés au prototype d'hôte.
Opération de surcharge d'inventaire de la règle LLD

Opération de surcharge de la valeur de mode d'inventaire de la règle LLD qui est définie sur l'hôte découvert. Il a les propriétés suivantes :

Propriété Type Description
inventory_mode
(obligatoire)
integer Ignorer le mode d'inventaire du prototype de l'hôte.

Les valeurs possibles sont :
-1 - désactivé ;
0 - (par défaut) manuel ;
1 - automatique.