Introduction

Ce document décrit comment EPNM (Evolved Programmable Network Manager) peut gérer les fichiers de configuration de sauvegarde des périphériques depuis son emplacement central.

Informations générales

• Ce document a été écrit à partir de la version 6.1.1 d'EPNM
• Pour les systèmes exécutant la version 5.1.x, l'ID de bogue Cisco CSCvz12497 s'applique et empêche la modification du travail Device Configuration Backup-External à partir du tableau de bord du travail

Obtenir les fichiers de sauvegarde de la configuration

Le processus de stockage des sauvegardes à partir des périphériques dans la base de données EPNM est appelé « Archive de configuration » et peut être ajusté pour s'exécuter périodiquement.

Le schéma synoptique présente les étapes de configuration de l'EPNM pour obtenir les fichiers de sauvegarde des périphériques réseau et les 3 options de récupération de ces fichiers à partir de l'EPNM.

À l'étape 1, il est défini les préférences globales sur la façon de gérer la collecte des fichiers de configuration par EPNM. Vous pouvez choisir, par exemple, le nombre de fichiers de configuration conservés par périphérique et le déclenchement ou non d'une sauvegarde en cas de modification de la configuration.

Après cela, à l'étape 2, il est configuré la fréquence à laquelle l'EPNM interroge les périphériques réseau pour obtenir leurs fichiers de configuration.

Une fois que les fichiers sont dans la base de données EPNM, il y a 3 options pour les récupérer :

1. Téléchargez directement le fichier de configuration depuis EPNM (étape 3 du schéma de principe)
2. Exportez les fichiers de configuration vers un serveur externe, auquel cas il est nécessaire de configurer le serveur externe et de le configurer en tant que référentiel dans EPNM (étapes 4, 5, 6 et 7)
3. Récupérez les fichiers de configuration en utilisant l'API REST (étape 8). Cette méthode ne fonctionne pas pour les périphériques NCS2000, qui utilisent des fichiers de configuration au format base de données

1. Configurez les préférences de sauvegarde des périphériques

Définit les comportements par défaut de la collecte d'archives, tels que le déclenchement de l'archivage, le nombre de fichiers conservés par périphérique et la création ou non automatique d'un fichier de configuration de sauvegarde dès qu'un périphérique est ajouté au réseau.

Procédure

2. Configurez la fréquence de récupération des fichiers de configuration des périphériques

Au cours de cette étape, il est défini la fréquence à laquelle le module EPNM récupère les fichiers de configuration sur les périphériques du réseau. Le nombre de fichiers conservés dans la base de données dépend de ce qui a été défini à l'élément 1 - Configurer les préférences de sauvegarde des unités.

Procédure

3. Téléchargez les fichiers de configuration depuis EPNM

Procédure

4. Configurez le serveur externe

Les référentiels pris en charge sont FTP, SSH FTP (SFTP) et NFS (Network File System). Dans l'exemple, on suppose qu'un serveur SFTP est construit avec un serveur CentOS Linux version 8. La procédure de création du serveur n'est pas traitée dans cet article.

5. Configurer le référentiel de destination dans EPNM (Cisco IOS)

Dans cette étape, les paramètres du serveur externe sont définis dans l'interpréteur de commandes cars EPNM.

Procédure

epnm/admin# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
epnm/admin(config)#

epnm6/admin# conf t
Enter configuration commands, one per line.  End with CNTL/Z.
epnm6/admin(config)# repository external_config_backup
epnm6/admin(config-Repository-external_config_backup)# url sftp:// 
         
           //home/sftpuser 
         
epnm6/admin(config-Repository-external_config_backup)# user sftpuser password plain xxxx
epnm6/admin(config-Repository-external_config_backup)# end
epnm6/admin# write memory 
Generating configuration...
epnm6/admin#

epnm/admin# show repository external_config_backup
% Repository is empty

6. Configurer le référentiel de destination dans EPNM (GUI)

Au cours de cette étape, les paramètres du serveur externe sont définis dans l'interface utilisateur graphique EPNM.

Procédure

7. Programmez le travail d'exportation dans l'interface utilisateur graphique EPNM

Au cours de cette étape, le travail d'exportation des fichiers de configuration vers le serveur externe est défini dans l'interface utilisateur graphique d'EPNM.

Procédure

8. Utilisez l'API REST pour obtenir les fichiers de configuration

Plusieurs options de services pour les fichiers de configuration sont disponibles (par exemple, les opérations diff, bulk export et version). Dans cette section, il est montré un exemple de base de la façon de récupérer les fichiers de sauvegarde basés sur le périphérique avec l'adresse ip x.x.x.x

Tout d'abord, vous devez interroger le périphérique pour obtenir le champ correspondant au fichier de configuration souhaité. Pour ce faire, utilisez le point de terminaison GET Configuration Versions [2] :

GET https://
    
    
      /webacs/api/v4/data/ConfigVersions?.full=true&deviceIpAddress=x.x.x.x 
    

Notez que la réponse JSON indique que la configuration de démarrage et la configuration en cours sont disponibles pour ce périphérique. Dans ce cas, le type de différence est OUT_OF_SYNC, ce qui signifie que cette version est différente par rapport à la version précédente du fichier de configuration :

{
    "queryResponse": {
        "@last": 0,
        "@first": 0,
        "@count": 1,
        "@type": "ConfigVersions",
        "@domain": "ROOT-DOMAIN",
        "@requestUrl": "https://
    
    
      /webacs/api/v4/data/ConfigVersions?.full=true&deviceIpAddress=x.x.x.x", "@responseType": "listEntityInstances", "@rootUrl": "https:// 
     
       /webacs/api/v4/data", "entity": [ { "@dtoType": "configVersionsDTO", "@type": "ConfigVersions", "@url": "https:// 
      
        /webacs/api/v4/data/ConfigVersions/5029722742", "configVersionsDTO": { "@displayName": "5029722742", "@id": 5029722742, "comments": "Archived By Job Name: Job_Configuration_Archive_Collection_10_10_00_021_AM_8_28_2024, Run Id: 6333919609", "createdAt": "2024-08-28T13:10:07.112Z", "createdBy": "root", "deviceIpAddress": "x.x.x.x", "deviceName": "CBR8", "diffType": "OUT_OF_SYNC", "fileInfos": { "fileInfo": [ { "fileId": 5029723744, "fileState": "STARTUPCONFIG", "fileType": "TEXT" }, { "fileId": 5029723743, "fileState": "RUNNINGCONFIG", "fileType": "TEXT" } ] }, "isFirst": true, "isLast": true, "outOfBand": true } } ] } } 
       
      
    

Vous pouvez ensuite télécharger le fichier de configuration à l'aide de l'ID de fichier de l'étape précédente. Si vous souhaitez télécharger la configuration en cours, vous pouvez utiliser le point d'extrémité :

GET https://
    
    
      /webacs/api/v4/op/configArchiveService/extractUnsanitizedFile?fileId=5029723743 
    

La réponse contient la configuration en cours au format texte.

{
    "mgmtResponse": {
        "@domain": "ROOT-DOMAIN",
        "@requestUrl": "https://
    
    
      /webacs/api/v4/op/configArchiveService/extractUnsanitizedFile?fileId=5029723743", "@responseType": "operation", "@rootUrl": "https:// 
     
       /webacs/api/v4/op", "extractFileResult": [ { "fileData":"!\n! Last configuration change at 18:12:00 EDT Sun Aug 25 2024 by rtp1\n!\nno issu config-sync policy bulk prc\nversion 16.12\nservice timestamps debug datetime msec\nservice timestamps log datetime localtime show-timezone\nservice password-encryption\nservice internal\nservice udp-small-servers\nservice sequence- 
      
        tcp\nnetconf-yang\nnetconf-yang cisco-ia snmp-community-string testing-mib-yang\nnetconf-yang ssh port 57000\nrestconf\nend" } ] } } 
       
      
    

N'oubliez pas que les fichiers de configuration NCS2000 ne peuvent pas être récupérés par cette méthode en raison de leur format différent (DATABASE).

Dépannage de la collection Configuration Archive

Timeout (Délai d’expiration)

Message d'erreur associé : Backup Database from device using https failed. Délai d'attente du socket pendant l'exécution de la requête HTTP : délai de lecture dépassé

Cause première : le délai d'attente s'écoule avant qu'EPNM puisse obtenir la base de données du périphérique.

La tâche d'archivage de la configuration utilise la valeur Délai d'attente ILC du périphérique pour chaque activité d'extraction. Une seule tâche d'archivage de la configuration nécessite de 1 à 5 fichiers. Par conséquent, la valeur de délai d'attente de tâche globale est déterminée à l'aide de la logique : Total job timeout = Number of files*Device CLI Timeout. Pour configurer une valeur de délai d'attente CLI, choisissez Inventory > Device Management > Network Devices, cliquez sur l'icône edit device, sélectionnez l'option Telnet/SSH, puis entrez une valeur dans le champ Timeout.

EMS non activé comme « sécurisé » dans NCS2000

Message d'erreur associé :"Échec de la sauvegarde de la base de données à partir du périphérique utilisant https. Échec de l'établissement de la connexion Telnet au périphérique - Cause : Connexion refusée ou dépassement du délai imparti."

Cause première : le paramètre Accès EMS dans NCS2000 (l'accès s'effectue via l'outil CTC) est défini sur Non sécurisé. Il est nécessaire de le configurer en tant que Secure. 

Pour résoudre ce problème, accédez au NCS2000 à l'aide de l'outil CTC, accédez à la vue Node, à l'onglet Provisioning, à l'onglet Security, puis à l'onglet Access et modifiez l'état d'accès sous EMS Access en Secure.

ID de périphérique introuvable

Message d'erreur associé : «Device archive(s) cannot be found. Le ou les périphériques peuvent avoir un ID non valide ou avoir été supprimés du système. »

Cause première : si le périphérique NCS2000 a été supprimé dans EPNM, son ID de périphérique dans la base de données EPNM est modifié. Cependant, la tâche Configuration Archive Collection fait toujours référence à l'ancien ID, et par conséquent elle échoue. La solution de contournement consiste à supprimer et recréer la tâche Configuration Archive Collection pour le périphérique associé.

Conclusion

Ce document décrit en détail comment accéder aux fichiers de configuration à partir des périphériques réseau stockés dans la base de données EPNM.

Trois options ont été données pour accéder aux fichiers : via EPNM directement, export vers un serveur externe et via REST API. Ces méthodes peuvent être utilisées pour automatiser des tâches qui peuvent être exécutées par des systèmes connectés à l'interface nord d'EPNM. Des conseils de dépannage ont également été donnés pour la récupération des fichiers de configuration à partir des périphériques.

Références

[1] Guide de configuration EPNM

https://www.cisco.com/c/en/us/td/docs/net_mgmt/epn_manager/5_1_3/user/guide/bk-cisco-evolved-programmable-network-manager-5-1-3-user-and-administrator-guide1/bk_CiscoEPNManager_4_0_UserAndAdministratorGuide_chapter_011.html#task_1237296

[2] API REST EPNM - référence en ligne
https://<Adresse IP EPNM>/webacs/api/v1/index?_docs