Introducción

Este documento describe cómo Evolved Programmable Network Manager (EPNM) puede administrar archivos de configuración de copia de seguridad para dispositivos desde su ubicación central.

Antecedentes

• Este documento se ha escrito basándose en la versión 6.1.1 de EPNM
• Para los sistemas que ejecutan la versión 5.1.x, el ID de bug de Cisco CSCvz12497 se aplica e impide la edición del trabajo Device Configuration Backup-External desde el panel de trabajo

Obtener los archivos de copia de seguridad de configuración

El proceso para almacenar copias de seguridad de los dispositivos en la base de datos EPNM se denomina "Archivo de configuración" y se puede ajustar para que se ejecute periódicamente.

El diagrama de bloques muestra los pasos para configurar el EPNM para obtener los archivos de copia de seguridad de los dispositivos de red y las 3 opciones para recuperar estos archivos del EPNM.

En el Paso 1, se definen las preferencias generales sobre cómo manejar la recolección de los archivos de configuración por EPNM. Puede elegir, por ejemplo, cuántos archivos de configuración se guardan por dispositivo y si se activa o no una copia de seguridad cuando se produce un cambio de configuración.

Después de eso, en el Paso 2 se configura la frecuencia con que el EPNM sondea los dispositivos de red para obtener sus archivos de configuración.

Una vez que los archivos están en la base de datos EPNM, hay 3 opciones para recuperarlos:

1. Descargue el archivo de configuración de EPNM directamente (Paso 3 en el diagrama de bloques)
2. Exporte los archivos de configuración a un servidor externo, en cuyo caso es necesario configurar el servidor externo y configurarlo como repositorio en EPNM (Pasos 4, 5, 6, y 7)
3. Recupere los archivos de configuración mediante la API REST (Paso 8). Este método no funciona para los dispositivos NCS2000, que utilizan archivos de configuración en formato de base de datos

1. Configurar preferencias de copia de seguridad del dispositivo

Define los comportamientos predeterminados para la recopilación de archivos, como cuándo se activa el archivado, el número de archivos que se conservan por dispositivo y si se debe crear o no automáticamente un archivo de configuración de copia de seguridad tan pronto como se agrega un dispositivo a la red.

Procedimiento

2. Configure la frecuencia de recuperación de archivos de configuración de dispositivos

En este paso, se define la frecuencia con que el EPNM obtiene los archivos de configuración de los dispositivos de la red. El número de archivos que se mantienen en la base de datos depende de lo que se haya definido en el elemento 1 -Configurar preferencias de copia de seguridad de dispositivos.

Procedimiento

3. Descargue los archivos de configuración de EPNM

Procedimiento

4. Configuración del servidor externo

Los repositorios compatibles son FTP, SSH FTP (SFTP) y Network File System (NFS). En el ejemplo, se supone que un servidor SFTP se construye con un servidor CentOS Linux versión 8. El procedimiento para crear el servidor está fuera del alcance de este artículo.

5. Configure el repositorio de destino en EPNM (Cisco IOS)

En este paso, los parámetros del servidor externo se definen en el shell EPNM cars.

Procedimiento

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. Configure el repositorio de destino en EPNM (GUI)

En este paso, los parámetros del servidor externo se definen en la GUI de EPNM.

Procedimiento

7. Programe el trabajo de exportación en la GUI de EPNM

En este paso, el trabajo para exportar los archivos de configuración al servidor externo se define en la GUI de EPNM.

Procedimiento

8. Utilice la API REST para obtener los archivos de configuración

Hay disponibles varias opciones de servicios para los archivos de configuración (por ejemplo, operaciones diff, exportación masiva y versión). En esta sección se muestra un ejemplo básico de cómo recuperar los archivos de copia de seguridad basados en el dispositivo con la dirección ip x.x.x.x

En primer lugar, debe consultar el dispositivo para obtener el campo del archivo de configuración deseado. Esto se puede hacer usando el punto final de GET Configuration Versions [2]:

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

Observe en la respuesta JSON que tanto la configuración de inicio como la configuración de ejecución están disponibles para este dispositivo. También diff Type en este caso es OUT_OF_SYNC, lo que significa que esta versión es diferente si se compara con la versión anterior del archivo de configuración:

{
    "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 } } ] } } 
       
      
    

A continuación, puede descargar el archivo de configuración mediante el ID de archivo del paso anterior. Si desea descargar la configuración en ejecución, puede utilizar el punto final:

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

La respuesta contiene la configuración de ejecución en formato de texto.

{
    "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" } ] } } 
       
      
    

Recuerde que este método no puede recuperar los archivos de configuración de NCS2000 debido a su diferente formato (DATABASE).

Solucionar problemas de recopilación de archivo de configuración

Tiempo de espera

Mensaje de error relacionado:Error en la copia de seguridad de la base de datos del dispositivo que usa https. Tiempo de espera del socket durante la ejecución de la solicitud HTTP: tiempo de espera de lectura agotado

Causa raíz: se ha terminado el tiempo de espera antes de que EPNM pueda obtener la base de datos del dispositivo.

La tarea Archivo de configuración utiliza el valor de Tiempo de espera de la CLI del dispositivo para cada actividad de obtención. Una sola tarea de archivo de configuración implica de 1 a 5 archivos. Por consiguiente, el valor del tiempo de espera del trabajo total se determina usando la lógica: Tiempo de espera del trabajo total = Número de archivos*Tiempo de espera de la CLI del dispositivo. Para configurar un valor de tiempo de espera CLI, elija Inventory > Device Management > Network Devices, haga clic en el icono edit device, seleccione la opción Telnet/SSH y, a continuación, ingrese un valor en el campo Timeout.

EMS no habilitado como "seguro" en NCS2000

Mensaje de error relacionado:"Error en la copia de seguridad de la base de datos del dispositivo que usa https. No se pudo establecer la conexión telnet con el dispositivo. Causa: Conexión rechazada o agotada el tiempo de espera."

Causa raíz: el parámetro EMS Access de NCS2000 (el acceso a este se realiza mediante la herramienta CTC) está establecido en Non Secure. Es necesario configurarlo como Secure (Seguro). 

Para solucionarlo, acceda a NCS2000 con la herramienta CTC, vaya a la vista de nodo, la ficha Aprovisionamiento, Seguridad y, a continuación, la ficha Acceso y cambie el estado de acceso en Acceso EMS a Seguro.

ID de dispositivo no encontrada

Mensaje de error relacionado: "No se han encontrado los archivos del dispositivo. Los dispositivos pueden tener una ID no válida o se pueden haber eliminado del sistema."

Causa raíz: si el dispositivo NCS2000 se ha eliminado en EPNM, su ID de dispositivo en la base de datos EPNM cambia. Sin embargo, el trabajo Configuration Archive Collection todavía hace referencia al ID antiguo y, por lo tanto, falla. La solución alternativa es eliminar y volver a crear el trabajo Configuration Archive Collection para el dispositivo relacionado.

Conclusión

Este documento describe con cierto detalle cómo acceder a los archivos de configuración desde los dispositivos de red que se almacenan en la base de datos EPNM.

Se ofrecieron tres opciones para acceder a los archivos: a través de EPNM directamente, exportar a un servidor externo y a través de la API REST. Estos métodos se pueden utilizar para automatizar tareas que pueden ejecutar los sistemas conectados a la interfaz ascendente de EPNM. También se proporcionaron algunas sugerencias de solución de problemas para la recuperación de los archivos de configuración de los dispositivos.

Referencias

[1] Guía de configuración de 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] Referencia en línea de la API EPNM REST
https://<Dirección IP de EPNM>/webacs/api/v1/index?_docs