Aller au contenu

Export

L’export des fixtures permet de sauvegarder, l’intégralité ou seulement certaines parties de la configuration de Canopsis, afin de pouvoir la réutiliser ultérieurement, par exemple lors d’un déploiement sur une nouvelle instance.

Pour réaliser un export, il suffit d’appeler le endpoint d’API suivant :

POST /api/v4/export-configuration

Le corps de la requête doit contenir un objet JSON avec la clé export listant les collections à extraire.

Exemple minimal de payload :

{
  "export": [
    "metaalarm",
    "pbehavior"
  ]
}

Exemple de résultat au format YAML :

meta_alarm_rules:
  "0":
    _id: Ping_1
    alarm_pattern:
    - - cond:
          type: eq
          value: Ping_1
        field: v.resource
    author: root
    auto_resolve: false
    config:
      threshold_count: 2
      time_interval:
        unit: m
        value: 15
    corporate_alarm_pattern: ""
    corporate_alarm_pattern_title: ""
    corporate_entity_pattern: ""
    corporate_entity_pattern_title: ""
    corporate_total_entity_pattern: ""
    corporate_total_entity_pattern_title: ""
    created: 1684142212
    entity_pattern: []
    name: Ping_1
    output_template: "{{ .Children.Alarm.Value.State.Message }}"
    total_entity_pattern: []
    type: complex
    updated: 1684142212
pbehavior:
  "0":
    _id: df28d4a0-7e79-4a89-b957-0385d673f087
    alarm_count: 863
    author: root
    color: ""
    corporate_entity_pattern: ""
    corporate_entity_pattern_title: ""
    created: 1683795610
    enabled: true
    entity_pattern:
    - - cond:
          type: begin_with
          value: Joignabilité
        field: name
    exceptions: []
    exdates: []
    last_alarm_date: 1754982491
    name: Joignabilité
    reason: 5fee78e8-2519-4cc5-a9d5-19cbde6519e6
    rrule: FREQ=DAILY
    rrule_cstart: 1753394400
    tstart: 1683756000
    tstop: 1683842399
    type_: 5ea9d2d8-0f16-4e19-bcca-64b1e96e00fa
    updated: 1683795610

Liste complète des paramètres disponibles

Chaque valeur du tableau export correspond à une collection MongoDB. Dans le fichier YAML obtenu, les documents sont regroupés sous le nom de la collection (par exemple meta_alarm_rules pour la valeur metaalarm).

Une valeur inconnue est refusée : la requête renvoie une erreur de validation et aucun export n'est produit. Une collection vide n'apparaît pas dans le fichier.

Valeur de export Collection MongoDB Contenu
configuration configuration Paramètres généraux
user user Utilisateurs
role role Rôles
permission permission Droits
pbehavior pbehavior Comportements périodiques
pbehavior_type pbehavior_type Types de comportements périodiques
pbehavior_reason pbehavior_reason Raisons de comportements périodiques
pbehavior_exception pbehavior_exception Exceptions de comportements périodiques
scenario action_scenario Scénarios
metaalarm meta_alarm_rules Règles de méta-alarmes
idle_rule idle_rule Règles d'inactivité
eventfilter eventfilter Filtres d'événements
dynamic_infos dynamic_infos Informations dynamiques
playlist view_playlist Listes de lecture
state_settings state_settings Paramètres de calcul d'état
broadcast broadcast_message Messages diffusés
associative_table default_associativetable Tables associatives
user_notification_settings user_notification_settings Paramètres de notification des utilisateurs
view views Vues
view_tab viewtabs Onglets de vues
widget widgets Widgets
widget_filter widget_filters Filtres de widgets
widget_template widget_templates Modèles de widgets
view_group viewgroups Groupes de vues
instruction instruction Consignes de remédiation
job_config job_config Configurations de jobs de remédiation
job job Jobs de remédiation
resolve_rule resolve_rule Règles de résolution
flapping_rule flapping_rule Règles de bagot
user_preferences userpreferences Préférences des utilisateurs
kpi_filter kpi_filter Filtres KPI
pattern pattern Filtres (patterns) enregistrés
snmp_rule default_snmprules Règles SNMP
snmp_mib default_mibs MIB SNMP
declare_ticket_rule declare_ticket_rule Règles de déclaration de ticket
link_rule link_rule Générateurs de liens
map map Cartographies
entity_infos_property entity_infos_property Propriétés des informations d'entités
template_data template_data Données de test des modèles
template_test template_test Tests de modèles
webhook_token_rule webhook_token_history Historique des jetons de webhook
icon icon Icônes personnalisées

Il est possible de sélectionner uniquement les collections nécessaires ou bien de toutes les exporter en les listant dans le tableau export.

Icônes personnalisées

La valeur icon exporte les icônes ajoutées dans l'interface. Ajoutez-la à l'export pour que les vues, widgets, modèles et règles qui utilisent ces icônes s'affichent correctement sur l'instance cible.

Attention

L'export ne contient que la description des icônes (identifiant, titre, type MIME, emplacement de stockage). Les fichiers SVG ne sont pas dans MongoDB : ils se trouvent dans le répertoire /opt/canopsis/var/lib/icons du service canopsis-internal-api (internalapi en Docker Compose).

Copiez ce répertoire vers l'instance cible en plus d'importer le fichier d'export, sinon les icônes importées ne peuvent pas s'afficher.

Exemple d'export de vues avec leurs icônes :

{
  "export": [
    "view_group",
    "view",
    "view_tab",
    "widget",
    "icon"
  ]
}