3 Modèles

Aperçu

Les modèles sont exportés avec de nombreux objets associés et relations entre objets.

L'exportation d'un modèle contient :

  • Groupes de modèles liés
  • Groupes d'hôtes liés (s'ils sont utilisés dans la configuration des prototypes d'hôte)
  • Données du modèle
  • Liaison avec d'autres modèles
  • Liaison avec des groupes de modèles
  • Éléments directement liés
  • Déclencheurs directement liés
  • Graphiques directement liés
  • Tableaux de bord directement liés
  • Règles de découverte directement liées avec tous les prototypes
  • Scénarios web directement liés
  • Mappages de valeurs

Exportation

Pour exporter des modèles, procédez comme suit :

  1. Accédez à Collecte de donnéesModèles.
  2. Cochez les cases des modèles à exporter.
  3. Cliquez sur Exporter sous la liste.

Selon le format sélectionné, les modèles sont exportés vers un fichier local avec un nom par défaut :

  • zabbix_export_templates.yaml - en export YAML (option par défaut pour l’exportation) ;
  • zabbix_export_templates.xml - en export XML ;
  • zabbix_export_templates.json - en export JSON.

Importation

Pour importer des modèles, procédez comme suit :

  1. Allez dans Collecte de donnéesModèles.
  2. Cliquez sur Importer dans le coin supérieur droit.
  3. Sélectionnez le fichier d'importation.
  4. Cliquez sur Importer dans le coin inférieur droit du formulaire de configuration.

Si vous cochez la case Options avancées, une liste détaillée de tous les éléments importables s'affichera ; cochez ou décochez chaque règle d'importation selon vos besoins.

Si vous cliquez sur la case à cocher de la ligne Tous, tous les éléments en dessous seront cochés/décochés.

Règles d'importation :

Règle Description
Mettre à jour l'existant Les éléments existants seront mis à jour à l'aide des données du fichier d'importation. Sinon, ils ne seront pas mis à jour.
Créer De nouveaux éléments seront créés à l'aide des données du fichier d'importation. Sinon, ils ne seront pas créés.
Supprimer les éléments manquants Les éléments existants qui ne sont pas présents dans le fichier d'importation seront supprimés. Sinon, ils ne seront pas supprimés.
Si Supprimer les éléments manquants est coché pour Liaison de modèles, la liaison actuelle des modèles qui n'est pas présente dans le fichier d'importation sera supprimée. Les entités (éléments, déclencheurs, graphiques, etc.) héritées des modèles dissociés ne seront pas supprimées (sauf si l'option Supprimer les éléments manquants est également sélectionnée pour chaque entité).

Sur l'écran suivant, vous pourrez afficher le contenu d'un modèle en cours d'importation. S'il s'agit d'un nouveau modèle, tous les éléments seront affichés en vert. Lors de la mise à jour d'un modèle existant, les nouveaux éléments du modèle seront mis en évidence en vert ; les éléments supprimés du modèle seront mis en évidence en rouge ; les éléments qui n'ont pas changé seront affichés sur un fond gris.

Le menu de gauche peut être utilisé pour parcourir la liste des modifications. La section Mis à jour met en évidence toutes les modifications apportées aux éléments existants du modèle. La section Ajouté répertorie les nouveaux éléments du modèle. Les éléments de chaque section sont regroupés par type d'élément ; cliquez sur la flèche grise pour développer ou réduire le groupe d'éléments.

Passez en revue les modifications du modèle, puis cliquez sur Importer pour lancer l'importation du modèle. Un message indiquant le succès ou l'échec de l'importation s'affichera dans l'interface web.

Format d'export

Lorsqu'un modèle est exporté, Zabbix génère un format structuré YAML, JSON ou XML. L'export inclut des éléments du modèle, tels que les métadonnées du modèle, les éléments de données, les macros, les déclencheurs, les tableaux de bord, et plus encore.

Chaque élément remplit un objectif spécifique et peut contenir des éléments imbriqués.

Les sections suivantes décrivent chaque élément du format d'export. Les exemples utilisent le modèle Linux by Zabbix agent.

Une ellipse (...) indique des éléments omis par souci de concision. La note (see table below) est utilisée lorsque l'élément est expliqué plus en détail dans les sections suivantes.

Métadonnées du modèle

zabbix_export:
  version: '8.0'
  template_groups:
    - uuid: 846977d1dfed4968bc5f8bdb363285bc
      name: 'Templates/Operating systems'
  templates: (voir le tableau ci-dessous)
  triggers: (voir le tableau ci-dessous)
  graphs: (voir le tableau ci-dessous)
Élément Type Description
version string (obligatoire) Version de l’export.
template_groups (obligatoire) Élément racine pour les groupes de modèles.
uuid string (obligatoire) Identifiant unique de ce groupe de modèles.
name string (obligatoire) Nom du groupe de modèles.
host_groups Élément racine pour les groupes d’hôtes utilisés par les prototypes d’hôte.
uuid string (obligatoire) Identifiant unique de ce groupe d’hôtes.
name string (obligatoire) Nom du groupe d’hôtes.
templates Élément racine pour les modèles.
triggers Élément racine pour les éléments de déclencheur de modèle, identiques à ceux des déclencheurs d’élément de modèle.
graphs Élément racine pour les éléments de graphique de modèle, identiques à ceux des graphiques d’hôte.

Modèles

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      template: 'Linux by Zabbix agent'
      name: 'Linux by Zabbix agent'
      description: |
        Il s'agit d'un modèle Linux officiel. Il nécessite Zabbix agent 8.0 ou une version plus récente. (...)
      wizard_ready: 'YES'
      readme: |
        ## Aperçu

        Il s'agit d'un modèle Linux officiel. Il nécessite Zabbix agent 8.0 ou une version plus récente. (...)
      vendor:
        name: Zabbix
        version: 8.0-2
      groups:
        - name: 'Templates/Operating systems'
      items: (voir le tableau ci-dessous)
      discovery_rules: (voir le tableau ci-dessous)
      tags:
        - tag: class
          value: os
        - tag: target
          value: linux
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          value: 3m
          description: 'Délai après lequel l''agent est considéré comme indisponible. Fonctionne uniquement pour les agents joignables depuis le serveur/proxy Zabbix (mode passif).'
          config: (voir le tableau ci-dessous)
        - macro: '{$CPU.UTIL.CRIT}'
          value: '90'
          description: 'Seuil critique d''utilisation du processeur exprimé en %.'
          config: (voir le tableau ci-dessous)
        (...)
      dashboards: (voir le tableau ci-dessous)
      valuemaps: (voir le tableau ci-dessous)
    (...)
Element Type Description
uuid string (obligatoire) Identifiant unique de ce modèle.
template string (obligatoire) Nom unique du modèle.
name string Nom visible du modèle.
description text Description du modèle.
wizard_ready text Indique si le modèle est disponible pour la sélection dans l'assistant d'hôte.
Valeurs possibles :1 NO (0, par défaut), YES (1).
Voir aussi : Template object (wizard_ready).
readme text Instructions de configuration spécifiques au modèle à afficher dans l'assistant d'hôte. Prend en charge le formatage Markdown.
vendor Élément racine pour le fournisseur du modèle (présent si le modèle exporté contient des données de fournisseur).
name string (obligatoire) Nom du fournisseur du modèle.
version string (obligatoire) Version du modèle.
Pour les modèles prêts à l'emploi, la version est affichée comme suit : version majeure de Zabbix, délimiteur ("-"), numéro de révision (incrémenté à chaque nouvelle version du modèle et réinitialisé à chaque version majeure de Zabbix). Par exemple, 7.0-0, 7.0-3, 8.0-0, 8.0-3.
templates Élément racine pour les modèles liés.
name string (obligatoire) Nom du modèle.
groups Élément racine pour les groupes de modèles.
name string (obligatoire) Nom du groupe de modèles.
items Élément racine pour les éléments de modèle.
discovery_rules Élément racine pour les règles de découverte de bas niveau du modèle.
httptests Élément racine pour les scénarios web du modèle.
tags Élément racine pour les balises du modèle.
tag string (obligatoire) Nom de la balise.
value string Valeur de la balise.
macros Élément racine pour les macros utilisateur du modèle.
macro string (obligatoire) Nom de la macro utilisateur.
type string Type de macro utilisateur.
Valeurs possibles :1 TEXT (0, par défaut), SECRET_TEXT (1), VAULT (2).
Voir aussi : User macro object (type).
value string Valeur de la macro utilisateur.
description string Description de la macro utilisateur.
config Élément racine pour la configuration des macros du modèle, responsable de la manière dont la macro est affichée dans l'assistant d'hôte.
dashboards Élément racine pour les tableaux de bord du modèle.
valuemaps Élément racine pour les correspondances de valeurs du modèle.

Éléments de modèle

zabbix_export:
  (...)
  templates:
    (...)
      items:
        - uuid: f94f9f4699e94c369e6c98b2a2f485ce
          name: 'Zabbix agent ping'
          key: agent.ping
          description: 'L''agent renvoie toujours "1" pour cet élément. Peut être utilisé en combinaison avec `nodata()` pour la vérification de disponibilité.'
          valuemap:
            name: 'Zabbix agent ping status'
          tags:
            - tag: component
              value: system
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          name: 'Number of installed packages'
          key: system.sw.packages.get
          delay: 1h
          preprocessing: (voir le tableau ci-dessous)
          tags:
            - tag: component
              value: os
          triggers: (voir le tableau ci-dessous)
        - uuid: 403cebed115441369e94d35d070ca7b8
          name: 'Memory utilization'
          type: DEPENDENT
          key: vm.memory.utilization
          value_type: FLOAT
          units: '%'
          description: 'Le pourcentage de mémoire utilisée est calculé comme `100-pavailable`.'
          preprocessing: (voir le tableau ci-dessous)
          master_item:
            key: 'vm.memory.size[pavailable]'
          tags:
            - tag: component
              value: memory
          triggers: (voir le tableau ci-dessous)
        (...)
Élément Type Description
uuid string (obligatoire) Identifiant unique de cet élément.
name string (obligatoire) Nom de l'élément.
type string Type d'élément.
Valeurs possibles :1 ZABBIX_PASSIVE (0, par défaut), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), CALCULATED (15), JMX (16), SNMP_TRAP (17), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22).
snmp_oid string (obligatoire pour les éléments SNMP_AGENT) ID d'objet SNMP.
key string (obligatoire) Clé de l'élément.
delay string Intervalle de mise à jour de l'élément.
Par défaut : 1m. La valeur sera toujours 0 pour les éléments TRAP.
history string Période (à l'aide d'un suffixe temporel, d'une macro utilisateur ou d'une macro LLD) pendant laquelle les données d'historique doivent être conservées.
Par défaut : 31d.
trends string Période (à l'aide d'un suffixe temporel, d'une macro utilisateur ou d'une macro LLD) pendant laquelle les données de tendances doivent être conservées.
Par défaut : 365d.
status string Statut de l'élément.
Valeurs possibles :1 ENABLED (0, par défaut), DISABLED (1).
value_type string Type de valeur reçue.
Valeurs possibles :1 FLOAT (0), CHAR (1), LOG (2), UNSIGNED (3, par défaut), TEXT (4), BINARY (5), JSON (6).
allowed_hosts string Liste d'adresses IP d'hôtes, séparées par des virgules, autorisées à envoyer des données pour l'élément.
Pris en charge pour les éléments TRAP et HTTP_AGENT.
units string Unités de la valeur reçue (bps, B, etc.).
params text Paramètres supplémentaires selon le type d'élément (script exécuté pour les éléments SSH et TELNET ; requête SQL pour les éléments ODBC ; formule pour les éléments CALCULATED ; script pour les éléments ITEM_TYPE_SCRIPT et ITEM_TYPE_BROWSER).
ipmi_sensor string Capteur IPMI.
Pris en charge pour les éléments IPMI.
authtype string Type d'authentification.
Pris en charge pour les éléments SSH et HTTP_AGENT.
Valeurs possibles pour les éléments SSH :1 PASSWORD (0, par défaut), PUBLIC_KEY (1).
Valeurs possibles pour les éléments HTTP_AGENT :1 NONE (0, par défaut), BASIC (1), NTLM (2), Kerberos (3) ou Digest (4).
username string (obligatoire pour les éléments SSH et TELNET) Nom d'utilisateur pour l'authentification.
Pris en charge pour les éléments SIMPLE, ODBC, JMX et HTTP_AGENT.
Lorsqu'il est utilisé pour des éléments JMX, password (voir ci-dessous) doit également être spécifié, ou les deux éléments doivent être laissés vides.
password string (obligatoire pour les éléments SSH et TELNET) Mot de passe pour l'authentification.
Pris en charge pour les éléments SIMPLE, ODBC, JMX et HTTP_AGENT.
Lorsqu'il est utilisé pour des éléments JMX, username (voir ci-dessus) doit également être spécifié, ou les deux éléments doivent être laissés vides.
publickey string (obligatoire pour les éléments SSH) Nom du fichier de clé publique.
privatekey string (obligatoire pour les éléments SSH) Nom du fichier de clé privée.
description text Description de l'élément.
inventory_link string Champ d'inventaire de l'hôte renseigné par l'élément.
Valeurs possibles :1 NONE (0), ALIAS (4), etc. (voir Host inventory pour les champs pris en charge).
valuemap Élément racine pour les correspondances de valeurs de l'élément.
name string (obligatoire) Nom de la correspondance de valeurs à utiliser pour l'élément.
logtimefmt string Format de l'heure dans les entrées de journal.
Pris en charge pour les éléments de type de valeur LOG.
preprocessing Élément racine pour le prétraitement des valeurs de l'élément.
step Élément racine pour les étapes de prétraitement des valeurs d'élément de modèle.
jmx_endpoint string Point de terminaison JMX.
Pris en charge pour les éléments JMX.
master_item (obligatoire pour les éléments DEPENDENT) Élément racine pour l'élément maître d'un élément dépendant.
key string (obligatoire) Clé de l'élément maître de l'élément dépendant.
timeout string Délai d'expiration de la requête d'interrogation des données de l'élément.
Pris en charge pour la liste des types d'éléments Timeouts.
url string (obligatoire pour les éléments HTTP_AGENT) Chaîne URL.
query_fields Élément racine pour les paramètres de requête.
Pris en charge pour les éléments HTTP_AGENT.
name string (obligatoire pour les éléments HTTP_AGENT) Nom du paramètre de requête.
value string Valeur du paramètre de requête.
Pris en charge pour les éléments HTTP_AGENT.
parameters Élément racine pour les paramètres définis par l'utilisateur.
Pris en charge pour les éléments ITEM_TYPE_SCRIPT et ITEM_TYPE_BROWSER.
name string (obligatoire pour les éléments ITEM_TYPE_SCRIPT et ITEM_TYPE_BROWSER) Nom du paramètre défini par l'utilisateur.
value string Valeur du paramètre défini par l'utilisateur.
Pris en charge pour les éléments ITEM_TYPE_SCRIPT et ITEM_TYPE_BROWSER.
posts string Données du corps de la requête HTTP(S).
Pris en charge pour les éléments HTTP_AGENT.
status_codes string Plages des codes d'état HTTP requis, séparées par des virgules.
Pris en charge pour les éléments HTTP_AGENT.
follow_redirects string Suivre les redirections de réponse lors de l'interrogation des données.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 NO (0), YES (1, par défaut).
post_type string Type du corps des données POST.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 RAW (0, par défaut), JSON (2), XML (3).
http_proxy string Chaîne de connexion du proxy HTTP(S).
Pris en charge pour les éléments HTTP_AGENT.
headers Élément racine pour les en-têtes de requête HTTP(S).
Pris en charge pour les éléments HTTP_AGENT.
name string (obligatoire pour les éléments HTTP_AGENT) Nom de l'en-tête.
value string (obligatoire pour les éléments HTTP_AGENT) Valeur de l'en-tête.
retrieve_mode string Partie de la réponse à stocker.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 BODY (0, par défaut), HEADERS (1), BOTH (2).
request_method string Type de méthode de requête.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 GET (0, par défaut), POST (1), PUT (2), HEAD (3).
output_format string Méthode de traitement de la réponse.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 RAW (0, par défaut), JSON (1).
allow_traps string Autoriser le renseignement de la valeur de manière similaire à un élément trapper.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 NO (0, par défaut), YES (1).
ssl_cert_file string Chemin du fichier de clé SSL publique.
Pris en charge pour les éléments HTTP_AGENT.
ssl_key_file string Chemin du fichier de clé SSL privée.
Pris en charge pour les éléments HTTP_AGENT.
ssl_key_password string Mot de passe du fichier de clé SSL.
Pris en charge pour les éléments HTTP_AGENT.
verify_peer string Indique s'il faut valider l'authenticité du certificat de l'hôte.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 NO (0, par défaut), YES (1).
verify_host string Indique s'il faut valider que le nom d'hôte de la connexion correspond à celui figurant dans le certificat de l'hôte.
Pris en charge pour les éléments HTTP_AGENT.
Valeurs possibles :1 NO (0, par défaut), YES (1).
tags Élément racine pour les tags de l'élément.
tag string (obligatoire) Nom du tag.
value string Valeur du tag.
triggers Élément racine pour les déclencheurs d'élément de modèle.

Voir aussi : Item object (reportez-vous à la propriété pertinente portant le même nom).

Étapes de prétraitement des valeurs d’élément de modèle
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          preprocessing:
            - type: JSONPATH
              parameters:
                - $.length()
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 12h
          (...)
Élément Type Description
type string (obligatoire) Type de l’étape de prétraitement de la valeur de l’élément.
Valeurs possibles :1 MULTIPLIER (1), RTRIM (2), LTRIM (3), TRIM (4), REGEX (5), BOOL_TO_DECIMAL (6), OCTAL_TO_DECIMAL (7), HEX_TO_DECIMAL (8), SIMPLE_CHANGE (9, calculé : valeur reçue - valeur précédente), CHANGE_PER_SECOND (10, calculé : (valeur reçue - valeur précédente)/(heure actuelle - heure de la dernière vérification)), XMLPATH (11), JSONPATH (12), IN_RANGE (13), MATCHES_REGEX (14), NOT_MATCHES_REGEX (15), CHECK_JSON_ERROR (16), CHECK_XML_ERROR (17), CHECK_REGEX_ERROR (18), DISCARD_UNCHANGED (19), DISCARD_UNCHANGED_HEARTBEAT (20), JAVASCRIPT (21), PROMETHEUS_PATTERN (22), PROMETHEUS_TO_JSON (23), CSV_TO_JSON (24), STR_REPLACE (25), CHECK_NOT_SUPPORTED (26), XML_TO_JSON (27), SNMP_WALK_VALUE (28), SNMP_WALK_TO_JSON (29), SNMP_GET_VALUE (30).
parameters (obligatoire) Élément racine des paramètres de l’étape de prétraitement de la valeur de l’élément.
parameter string Paramètre individuel de l’étape de prétraitement de la valeur de l’élément.
error_handler string Type d’action utilisé en cas d’échec de l’étape de prétraitement.
Valeurs possibles :1 ORIGINAL_ERROR (0, par défaut), DISCARD_VALUE (1), CUSTOM_VALUE (2), CUSTOM_ERROR (3).
error_handler_params string Paramètres du gestionnaire d’erreurs.

Voir aussi : Item preprocessing object (reportez-vous à la propriété correspondante portant le même nom).

Déclencheurs d’élément de modèle
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          triggers:
            - uuid: b950c306394f4b3c902060a8273cbcde
              expression: 'change(/Linux by Zabbix agent/system.sw.packages.get)<>0'
              name: 'Linux : le nombre de paquets installés a changé'
              priority: WARNING
              manual_close: 'YES'
              tags:
                - tag: scope
                  value: notice
        (...)
        - uuid: 403cebed115441369e94d35d070ca7b8
          (...)
          triggers:
            - uuid: cfd395b1cde74ef18a5e5f840bd5142a
              expression: 'min(/Linux by Zabbix agent/vm.memory.utilization,5m)>{$MEMORY.UTIL.MAX}'
              name: 'Linux : utilisation élevée de la mémoire'
              event_name: 'Linux : utilisation élevée de la mémoire (>{$MEMORY.UTIL.MAX}% pendant 5m)'
              priority: AVERAGE
              description: 'Le système manque de mémoire libre.'
              dependencies:
                - name: 'Linux : manque de mémoire disponible'
                  expression: 'max(/Linux by Zabbix agent/vm.memory.size[available],5m)<{$MEMORY.AVAILABLE.MIN} and last(/Linux by Zabbix agent/vm.memory.size[total])>0'
              tags:
                - tag: scope
                  value: capacity
                - tag: scope
                  value: performance
        (...)
Element Type Description
uuid string (obligatoire) Identifiant unique de ce déclencheur.
expression string (obligatoire) Expression du déclencheur.
recovery_mode string Base pour la génération des événements OK.
Valeurs possibles :1 EXPRESSION (0, par défaut), RECOVERY_EXPRESSION (1), NONE (2).
recovery_expression string Expression de récupération du déclencheur.
correlation_mode string Mode de corrélation (pas de corrélation d’événements ou corrélation d’événements par tag).
Valeurs possibles :1 DISABLED (0, par défaut), TAG_VALUE (1).
correlation_tag string Nom du tag à utiliser pour la corrélation des événements.
name string (obligatoire) Nom du déclencheur.
event_name string Nom de l’événement.
opdata string Données opérationnelles.
url_name string Libellé de l’URL associée au déclencheur.
url string URL associée au déclencheur.
status string Statut du déclencheur.
Valeurs possibles :1 ENABLED (0, par défaut), DISABLED (1).
priority string Sévérité du déclencheur.
Valeurs possibles :1 NOT_CLASSIFIED (0, par défaut), INFO (1), WARNING (2), AVERAGE (3), HIGH (4), DISASTER (5).
description text Description du déclencheur.
type string Type de génération d’événements (événement de problème unique ou événements de problèmes multiples).
Valeurs possibles :1 SINGLE (0, par défaut), MULTIPLE (1).
manual_close string Fermeture manuelle des événements de problème.
Valeurs possibles :1 NO (0, par défaut), YES (1).
dependencies Élément racine pour les dépendances.
name string (obligatoire) Nom du déclencheur de dépendance.
expression string (obligatoire) Expression du déclencheur de dépendance.
recovery_expression string Expression de récupération du déclencheur de dépendance.
tags Élément racine pour les tags du déclencheur.
tag string (obligatoire) Nom du tag.
value string Valeur du tag.

Voir aussi : Trigger object (reportez-vous à la propriété correspondante portant le même nom).

Règles de découverte de bas niveau de template

zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          name: 'Découverte des interfaces réseau'
          key: net.if.discovery
          delay: 1h
          filter: (voir le tableau ci-dessous)
          description: 'La découverte des interfaces réseau.'
          item_prototypes: (voir le tableau ci-dessous)
          trigger_prototypes: (voir le tableau ci-dessous)
          graph_prototypes: (voir le tableau ci-dessous)
        (...)

La plupart des éléments des règles de découverte de bas niveau de template sont identiques à ceux des éléments de template. Le tableau ci-dessous décrit les éléments qui diffèrent des éléments de template.

Element Type Description
type string Type d'élément.
Valeurs possibles :1 ZABBIX_PASSIVE (0, par défaut), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), JMX (16), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22).
key string (obligatoire) La clé de la règle de découverte de bas niveau.
filter Élément racine pour les filtres de règle de découverte de bas niveau de template.
lifetime string Période (en utilisant des secondes, un suffixe temporel ou une macro utilisateur), après laquelle les ressources qui ne sont plus découvertes seront supprimées.
Par défaut : 7d.
lifetime_type string Scénario de suppression des ressources LLD perdues.
Valeurs possibles : DELETE_NEVER, DELETE_IMMEDIATELY, DELETE_AFTER.
enabled_lifetime string Période (en utilisant des secondes, un suffixe temporel ou une macro utilisateur), après laquelle les ressources qui ne sont plus découvertes seront désactivées.
enabled_lifetime_type string Scénario de désactivation des ressources LLD perdues.
Valeurs possibles : DISABLE_NEVER, DISABLE_IMMEDIATELY, DISABLE_AFTER.
item_prototypes Élément racine pour les éléments de prototype d'élément de template, qui sont identiques à ceux des éléments de template.
trigger_prototypes Élément racine pour les éléments de prototype de déclencheur de template, qui sont identiques à ceux des déclencheurs d'élément de template.
graph_prototypes Élément racine pour les éléments de prototype de graphique de template, qui sont identiques à ceux des graphiques d'hôte.
host_prototypes Élément racine pour les éléments de prototype d'hôte de template, qui sont identiques à ceux des hôtes.
parent_discovery_rule Élément racine pour la règle de découverte de bas niveau parente (ou le prototype de règle) du prototype de règle de découverte de bas niveau. Cette propriété indique qu'il s'agit d'un prototype de règle LLD, enfant direct de la règle/du prototype de règle référencé.
key string (obligatoire) La clé de la règle de découverte de bas niveau parente (ou du prototype de règle).
master_item string (obligatoire pour les règles DEPENDENT) Élément racine pour l'élément maître de la règle dépendante.
lld_macro_paths Élément racine pour les chemins de macro de règle de découverte de bas niveau.
lld_macro string (obligatoire) Nom de la macro de règle de découverte de bas niveau.
path string (obligatoire) Sélecteur de valeur, qui sera attribuée à la macro correspondante.
preprocessing Élément racine pour le prétraitement des valeurs de la règle de découverte de bas niveau.
step Élément racine pour les éléments d'étape de prétraitement des valeurs de la règle de découverte de bas niveau, qui sont identiques à ceux des étapes de prétraitement des valeurs d'élément de template, sauf avec moins de valeurs possibles. Voir aussi : objet de prétraitement de règle LLD.
overrides Élément racine pour les règles de substitution de la règle de découverte de bas niveau.
name string (obligatoire) Nom unique de la substitution.
step string (obligatoire) Numéro d'ordre unique de la substitution.
stop string Arrêter le traitement des substitutions suivantes en cas de correspondance.
filter Élément racine pour les éléments de filtre de règle de substitution de découverte de bas niveau de template, qui sont identiques à ceux des filtres de règle de découverte de bas niveau de template.
operations Élément racine pour les opérations de substitution de règle de découverte de bas niveau de template.

Voir aussi : objet de règle LLD (reportez-vous à la propriété pertinente portant le même nom).

Filtres des règles de découverte de bas niveau de template
zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.MATCHES}'
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
          (...)
        - uuid: 2bbdc79f082d4c618e01bec625e9c90a
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.MATCHES}'
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
              - macro: '{#DEVTYPE}'
                value: disk
          (...)
Élément Type Description
evaltype string Remplacer la méthode d'évaluation des conditions du filtre.
Valeurs possibles :1 AND_OR (0, par défaut), AND (1), OR (2), FORMULA (3).
formula string Formule de calcul personnalisée pour les conditions du filtre.
conditions Élément racine des conditions du filtre.
macro string (obligatoire) Nom de la macro de découverte de bas niveau sur laquelle effectuer la vérification.
value string Valeur à comparer.
operator string Opérateur de condition.
Valeurs possibles :1 MATCHES_REGEX (8, par défaut), NOT_MATCHES_REGEX (9).
formulaid string (obligatoire) ID unique arbitraire utilisé pour référencer une condition depuis l'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 du filtre, mais sera généré à nouveau lors de leur demande ultérieure.

Voir aussi : objet de filtre de règle LLD (reportez-vous à la propriété correspondante portant le même nom).

Opérations de substitution de règle de découverte de bas niveau de modèle
Élément Type Description
operationobject string Objet auquel l’opération est appliquée.
Valeurs possibles :1 ITEM_PROTOTYPE (0), TRIGGER_PROTOTYPE (1), GRAPH_PROTOTYPE (2), HOST_PROTOTYPE (3).
operator string Opérateur de condition de substitution.
Valeurs possibles :1 EQUAL (1), NOT_EQUAL (2), LIKE (3), NOT_LIKE (4), REGEXP (5), NOT_REGEXP (6).
value string Une expression régulière ou une chaîne pour l’opérateur de condition de substitution.
status string Statut de l’objet lors de l’opération de substitution.
discover string Indique si l’objet est ajouté à la suite de la découverte.
delay string Intervalle de mise à jour défini pour le prototype d’élément lors de l’opération de substitution.
history string Période de stockage de l’historique définie pour le prototype d’élément lors de l’opération de substitution.
trends string Période de stockage des tendances définie pour le prototype d’élément lors de l’opération de substitution.
severity string Sévérité du prototype de déclencheur définie lors de l’opération de substitution.
tags Élément racine pour les tags définis pour l’objet lors de l’opération de substitution.
tag string (obligatoire) Nom du tag.
value string Valeur du tag.
templates Élément racine pour les modèles liés au prototype d’hôte lors de l’opération de substitution.
name string (obligatoire) Nom du modèle.
inventory_mode string Mode d’inventaire du prototype d’hôte défini lors de l’opération de substitution.

Voir aussi : LLD rule override operation object (reportez-vous à la propriété correspondante portant le même nom).

Scénarios web de modèle

Élément Type Description
uuid string (obligatoire) Identifiant unique de ce scénario web.
name string (obligatoire) Nom du scénario web.
delay string Fréquence d’exécution du scénario web (en utilisant des secondes, un suffixe temporel ou une macro utilisateur).
Par défaut : 1m.
attempts integer Nombre de tentatives d’exécution des étapes du scénario web.
Valeurs possibles :1 1-10 (par défaut : 1).
agent string Agent client. Zabbix se fera passer pour le navigateur sélectionné.
Cela est utile lorsqu’un site web renvoie un contenu différent selon le navigateur.
Par défaut : Zabbix.
http_proxy string Proxy qui sera utilisé par le scénario web, indiqué sous la forme : http://[username[:password]@]proxy.example.com[:port]
variables Élément racine des variables du scénario web pouvant être utilisées dans les étapes du scénario.
name string (obligatoire) Nom de la variable.
value text (obligatoire) Valeur de la variable.
headers Élément racine des en-têtes HTTP à envoyer lors de l’exécution d’une requête.
Les en-têtes doivent être listés en utilisant la même syntaxe que dans le protocole HTTP.
name string (obligatoire) Nom de l’en-tête.
value text (obligatoire) Valeur de l’en-tête.
status string Statut du scénario web.
Valeurs possibles :1 ENABLED (0, par défaut), DISABLED (1).
authentication string Méthode d’authentification.
Valeurs possibles :1 NONE (0, par défaut), BASIC (1), NTLM (2), Kerberos (3) ou Digest (4).
http_user string Nom d’utilisateur utilisé pour l’authentification BASIC (HTTP), NTLM, Kerberos ou Digest.
http_password string Mot de passe utilisé pour l’authentification BASIC (HTTP), NTLM, Kerberos ou Digest.
verify_peer string Vérifier le certificat SSL du serveur web.
Valeurs possibles :1 NO (0, par défaut), YES (1).
verify_host string Vérifier que le champ Common Name ou le champ Subject Alternate Name du certificat du serveur web correspond.
Valeurs possibles :1 NO (0, par défaut), YES (1).
ssl_cert_file string Nom du fichier de certificat SSL utilisé pour l’authentification du client (doit être au format PEM).
ssl_key_file string Nom du fichier de clé privée SSL utilisé pour l’authentification du client (doit être au format PEM).
ssl_key_password string Mot de passe du fichier de clé privée SSL.
steps (obligatoire) Élément racine des étapes de scénario web de modèle.
tags Élément racine des tags du scénario web.
tag string (obligatoire) Nom du tag.
value string Valeur du tag.

Voir aussi : Web scenario object (reportez-vous à la propriété correspondante portant le même nom).

Étapes du scénario web
Élément Type Description
name string (requis) Nom de l’étape du scénario web.
url string (requis) URL à surveiller.
query_fields Élément racine pour les paramètres de requête (un tableau de champs HTTP à ajouter à l’URL lors de l’exécution d’une requête).
name string (requis) Nom du paramètre de requête.
value string Valeur du paramètre de requête.
posts Élément racine pour les variables HTTP POST (une chaîne de caractères (données POST brutes) ou un tableau de champs HTTP (données de champ de formulaire)).
name string (requis) Nom du champ POST.
value string (requis) Valeur du champ POST.
variables Élément racine des variables au niveau de l’étape (macros) qui doivent être appliquées après cette étape.
Si la valeur de la variable a le préfixe 'regex:', sa valeur est alors extraite des données renvoyées par cette étape selon le motif d’expression régulière suivant le préfixe 'regex:'
name string (requis) Nom de la variable.
value text (requis) Valeur de la variable.
headers Élément racine pour les en-têtes HTTP à envoyer lors de l’exécution d’une requête.
name string (requis) Nom de l’en-tête.
value text (requis) Valeur de l’en-tête.
follow_redirects string Suivre les redirections HTTP.
Valeurs possibles :1 NO (0), YES (1, par défaut).
retrieve_mode string Mode de récupération de la réponse HTTP.
Valeurs possibles :1 BODY (0, par défaut), HEADERS (1), BOTH (2).
timeout string Délai d’expiration (en secondes, suffixe temporel ou macro utilisateur) de l’exécution de l’étape.
Par défaut : 15s.
required string Texte qui doit être présent dans la réponse (ignoré si vide).
status_codes string Liste des codes d’état HTTP acceptés, séparés par des virgules (par exemple, 200-201,210-299 ; ignoré si vide).

Voir aussi : Web scenario step object (reportez-vous à la propriété correspondante portant le même nom).

Configuration des macros de modèle

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      (...)
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          (...)
          config:
            type: TEXT
            priority: '1'
            label: 'Secondes depuis la dernière détection de l’agent Zabbix'
            description: 'Délai après lequel l’agent est considéré comme indisponible.'
        - macro: '{$CPU.UTIL.CRIT}'
          (...)
          config:
            type: TEXT
            priority: '2'
            section_name: Seuils
            label: 'Seuil d’utilisation du processeur exprimé'
            description: 'Seuil critique d’utilisation du processeur exprimé en %. Dans la plage de 0 à 100 inclus.'
            regex: '^-?([0-9]+|(([0-9]+)\.([0-9]+)))$'
        (...)
        - macro: '{$IFCONTROL}'
          (...)
          config:
            type: CHECKBOX
            priority: '19'
            label: 'Contrôle des interfaces'
            description: 'Déclencher un trigger lorsque l’état opérationnel de l’interface passe à "Link down".'
            options:
              - checked: '1'
                unchecked: '0'
        (...)
Element Type Description
type string (obligatoire) Type du champ de saisie de la macro.
Valeurs possibles :1 NOCONF (0), TEXT (1), LIST (2), CHECKBOX (3).
priority string Position de la macro dans la liste des macros.
section_name string Libellé de la section repliable dans laquelle la macro est regroupée.
label string (obligatoire pour les macros TEXT, LIST, CHECKBOX) Libellé de la macro.
description text Texte d’aide de la macro. Prend en charge le formatage Markdown.
required string Marque la macro comme obligatoire.
Valeurs possibles :1 NO (0), YES (1).
Pris en charge pour les macros TEXT et LIST.
regex string Expression régulière permettant de valider la saisie utilisateur dans un champ de zone de texte.
Pris en charge pour les macros TEXT.
options Élément racine pour les éléments LIST ou les valeurs CHECKBOX.
value string (obligatoire pour les macros LIST) Valeur de l’élément LIST.
text string (obligatoire pour les macros LIST) Texte de l’élément LIST.
checked string (obligatoire pour les macros CHECKBOX) Valeur représentant un état coché.
Valeurs possibles :1 0 (false), 1 (true).
Pris en charge pour les macros CHECKBOX.
unchecked string (obligatoire pour les macros CHECKBOX) Valeur représentant un état décoché.
Valeurs possibles :1 0 (false), 1 (true).
Pris en charge pour les macros CHECKBOX.

Voir aussi : Macro configuration object (reportez-vous à la propriété correspondante portant le même nom).

Tableaux de bord de modèle

zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets: (voir le tableau ci-dessous)
        (...)
Élément Type Description
uuid string (obligatoire) Identifiant unique de ce tableau de bord.
name string (obligatoire) Nom du tableau de bord du modèle.
display period integer Période d’affichage des pages du tableau de bord.
auto_start string Démarrage automatique du diaporama.
Valeurs possibles :1 NO (0), YES (1, par défaut).
pages Élément racine pour les pages du tableau de bord du modèle.
name string Nom de la page.
display period integer Période d’affichage de la page.
sortorder integer Ordre de tri de la page.
widgets Élément racine pour les widgets de tableau de bord de modèle.

Voir aussi : Template dashboard object (reportez-vous à la propriété correspondante portant le même nom).

Widgets de tableau de bord de modèle
zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Systèmes de fichiers
          pages:
            - name: Vue d'ensemble
              widgets:
                - type: graphprototype
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '3'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})] : graphique d''utilisation de l''espace (par rapport au total)'
                    - type: STRING
                      name: reference
                      value: AAAEB
                - type: graphprototype
                  'y': '5'
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '1'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})] : graphique d''utilisation de l''espace, en % (par rapport au maximum disponible)'
                    - type: STRING
                      name: reference
                      value: AAAEC
        (...)
Element Type Description
type string (obligatoire) Type de widget.
name string Nom du widget.
x integer Position horizontale à partir du côté gauche du tableau de bord du modèle.
Valeurs possibles :1 0-71.
y integer Position verticale à partir du haut du tableau de bord du modèle.
Valeurs possibles :1 0-63.
width integer Largeur du widget.
Valeurs possibles :1 1-72.
height integer Hauteur du widget.
Valeurs possibles :1 1-64.
hide_header string Masquer l'en-tête du widget.
Valeurs possibles :1 NO (0, par défaut), YES (1).
fields Élément racine pour les champs du widget du tableau de bord du modèle.
type string (obligatoire) Type de champ du widget.
Valeurs possibles :1 INTEGER (0), STRING (1), ITEM (4), ITEM_PROTOTYPE (5), GRAPH (6), GRAPH_PROTOTYPE (7), MAP (8), SERVICE (9), SLA (10), USER (11), ACTION (12), MEDIA_TYPE (13).
name string (obligatoire) Nom du champ du widget.
value mixed (obligatoire) Valeur du champ du widget, selon le type de champ.

Voir aussi : Template dashboard widget object (reportez-vous à la propriété correspondante portant le même nom).

Mappages de valeurs de modèle

zabbix_export:
  (...)
  templates:
    (...)
      valuemaps:
        - uuid: 8c048c6cca8248f2860c208e8db0f59e
          name: ifOperStatus
          mappings:
            - value: '0'
              newvalue: unknown
            - value: '1'
              newvalue: notpresent
            - value: '2'
              newvalue: down
            - value: '3'
              newvalue: lowerlayerdown
            - value: '4'
              newvalue: testing
            - value: '5'
              newvalue: dormant
            - value: '6'
              newvalue: up
        (...)
Élément Type Description
uuid string (obligatoire) Identifiant unique pour ce mappage de valeurs.
name string (obligatoire) Nom du mappage de valeurs.
mapping Élément racine pour les correspondances.
type string Type de correspondance du mappage.
Valeurs possibles :1 EQUAL (0, par défaut), GREATER_OR_EQUAL (2), LESS_OR_EQUAL (3), IN_RANGE (4), REGEXP (5), DEFAULT (6).
value string Valeur d’origine.
newvalue string (obligatoire) Valeur à laquelle la valeur d’origine est mappée.

Voir aussi : Value map object (reportez-vous à la propriété correspondante portant le même nom).

Notes de bas de page

1 Les valeurs entières de l’API entre parenthèses, par exemple ENABLED (0), sont mentionnées uniquement à titre de référence. Pour plus d’informations, consultez la page de l’objet API liée dans l’entrée du tableau ou à la fin de chaque section.