Recopilación de ISE Support Bundle mediante la API ERS

Introducción

Este documento describe el proceso para activar y descargar un paquete de soporte de ISE a través de la API ERS usando PostMan como cliente REST. 

Prerequisites

Requirements

Cisco recomienda que tenga conocimiento sobre estos temas:

• ISE
• Servicios RESTful externos
• Clientes de REST como Postman, RESTED, Insomnio, etc.

Componentes Utilizados

La información que contiene este documento se basa en estas versiones de software:

• Parche 6 de Cisco ISE 3.1
• Postman REST client v10.17.4

La información que contiene este documento se creó a partir de los dispositivos en un ambiente de laboratorio específico. Todos los dispositivos que se utilizan en este documento se pusieron en funcionamiento con una configuración verificada (predeterminada). Si tiene una red en vivo, asegúrese de entender el posible impacto de cualquier comando.

Configurar

Activar ERS (puerto 9060)

Las API ERS son API REST solo HTTPS que funcionan a través de los puertos 443 y 9060. El puerto 9060 está cerrado de forma predeterminada, por lo que debe abrirse primero. Se presenta un tiempo de espera del servidor si los clientes que intentan acceder a este puerto no habilitan ERS primero. Por lo tanto, el primer requisito es habilitar ERS desde la interfaz de usuario de administración de Cisco ISE.

Vaya a Administration > Settings > API Settings y habilite el botón de alternancia ERS (lectura/escritura).

Crear administrador ERS

Cree un administrador de Cisco ISE, asigne una contraseña y agregue el usuario al grupo de administradores como administrador de ERS. Puede dejar el resto de la configuración vacía.

Configuración de Postman

Descargue o utilice la versión en línea de Postman.

1. Cree un usuario y un espacio de trabajo haciendo clic en Create Workspace en la pestaña Workspaces.

2. Seleccione Espacio de Trabajo en Blanco y asígnele un nombre. Puede agregar una descripción y hacerla pública. Para este ejemplo, Personalis está seleccionado.

Una vez creado el espacio de trabajo, ya puede configurar las llamadas de API.

Paquete Trigger Support 

Para configurar cualquier llamada, primero debe acceder al SDK de ISE ERS (kit de desarrolladores de software). Esta herramienta recopila la lista completa de llamadas API que ISE puede realizar:

1. Vaya a https://{ise-ip}/ers/sdk
2. Inicie sesión con sus credenciales de administrador de ISE.
3. Ampliar la documentación de API
4. Desplácese hacia abajo hasta que encuentre Support Bundle Trigger Configuration y haga clic en él.
5. En esta opción ahora puede encontrar todas las operaciones disponibles que puede realizar para esta opción en ISE. Seleccione Crear.

6. Ahora puede ver la configuración necesaria para realizar la llamada API mediante XML o JSON en cualquier cliente Rest, así como un ejemplo de respuesta esperada. 

7.Volver a Postman permite configurar la autenticación básica para ISE. En la pestaña Authorization, seleccione Basic Auth como tipo de autenticación y agregue las credenciales de usuario ERS de ISE creadas anteriormente en ISE.

8. En Postman, vaya a la pestaña Headers y configure los encabezados necesarios para la llamada API usando XML o JSON como se ve en el SDK. En este ejemplo se utiliza JSON. La configuración del encabezado debe ser similar a la siguiente:

9. Desplácese hasta la cabecera Body y seleccione raw. Esto nos permite pegar la plantilla XML o JSON necesaria para activar el paquete de soporte. 

10. Pegue la plantilla XML o JSON en la sección Cuerpo cambiando los valores según sea necesario:

XML:

<?xml version="1.0" encoding="UTF-8"?> <ns0:supportbundle xmlns:ns0="supportbundle.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Support Bundle Generation" name="supportBundle"> <hostName>Node hostname the SB is being collected from </hostName> <supportBundleIncludeOptions> <fromDate>mm/dd/yyyy</fromDate> <includeConfigDB>true|false</includeConfigDB> <includeCoreFiles>true|false</includeCoreFiles> <includeDebugLogs>true|false</includeDebugLogs> <includeLocalLogs>true|false</includeLocalLogs> <includeSystemLogs>true|false</includeSystemLogs> <mntLogs>true|false</mntLogs> <policyXml>true|false</policyXml> <toDate>mm/dd/yyyy</toDate> </supportBundleIncludeOptions> </ns0:supportbundle>

JSON:

{ "SupportBundle": { "name": "supportBundle", "description": "Support Bundle Generation", "hostName": "node hostname the SB is being collected from", "supportBundleIncludeOptions": { "includeConfigDB": true|false, "includeDebugLogs": true|false, "includeLocalLogs": true|false, "includeCoreFiles": true|false, "mntLogs": true|false, "includeSystemLogs": true|false, "policyXml": true|false, "fromDate": "mm/dd/yyyy", "toDate": "mm/dd/yyyy" } } }

11. Seleccione POST como método, pegue https://{ISE-ip}/ers/config/supportbundle y haga clic en Send. Si todo se ha configurado correctamente, debe ver un mensaje "201 Created" y el resultado estará vacío. 

Comprobar el estado del paquete de soporte

Puede confirmar si el paquete de soporte se ha activado o completado mediante la ejecución de una serie de llamadas GET. 

1. En el SDK, en la ficha Estado del paquete de soporte, seleccione Obtener todo. Desea obtener el ID para poder ejecutar la siguiente llamada GET.  Como se ha visto anteriormente, estos son los encabezados necesarios para realizar la llamada, así como la respuesta esperada.

2. Vaya a la pestaña Headers y configure los encabezados necesarios para la llamada API tal como se ve en el SDK. En este ejemplo se utiliza JSON. La configuración del encabezado debe ser similar a la siguiente:

3. Seleccione GET como método, pegue https://{ISE-ip}/ers/config/supportbundlestatus y haga clic en Enviar. Si todo se ha configurado correctamente, debe ver un mensaje "200 OK" y el resultado con información relacionada con el último paquete de soporte activado. Esta llamada no nos permite saber si el paquete de asistencia se ha completado correctamente o no. A partir de esta llamada, recopile la ID para poder utilizarla en la siguiente llamada GET. 

4. Una vez que se recopile el ID, vaya al SDK, bajo la pestaña Estado del paquete de soporte y seleccione Get-By-Id. Como se ha visto antes, aquí están los encabezados requeridos para realizar la llamada así como la respuesta esperada.

5. Vaya a la pestaña Headers y configure los encabezados necesarios para la llamada API como se ve en el SDK. En este ejemplo se utiliza JSON. La configuración del encabezado debe ser similar a la siguiente:

6. Seleccione GET como método, pegue https://{ISE-ip}/ers/config/supportbundlestatus/{id} y el ID recopilado en el paso 3 y, por último, haga clic en Enviar. Si todo estaba correctamente configurado, debe ver un mensaje "200 OK" y el resultado con información relacionada con la finalización o no del último paquete de soporte activado. Anote el fileName de esta llamada, ya que necesita la llamada PUT.

Descargar paquete de asistencia

Cuando confirme que el paquete de asistencia se encuentra en el estado finalizado. Puede proceder a descargarlo. 

1. En el SDK, en la ficha Descarga del paquete de soporte, seleccione Descargar paquete de soporte. Como se ha visto anteriormente, a continuación se muestran los encabezados necesarios para realizar la llamada, las plantillas XML y JSON, así como la respuesta esperada.

2. Vaya a la pestaña Headers y configure los encabezados necesarios para la llamada API tal como se ve en el SDK. En este ejemplo se utiliza JSON. La configuración del encabezado debe ser similar a la siguiente:

3. Desplácese hasta la cabecera Body y seleccione raw. Esto nos permite pegar la plantilla XML o JSON necesaria para descargar el paquete de soporte. 

4. Pegue la plantilla XML o JSON en la sección Body, cambiando los valores según sea necesario. El nombre de archivo sería el nombre del archivo recopilado en el paso 6 (ise-support-bundle-pk-ise3-1test-external-09-26-2023-01-26.tar.gpg):

XML

<?xml version="1.0" encoding="UTF-8"?> <ns0:supportbundle xmlns:ns0="supportbundle.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com"> <fileName>Support bundle file name to be picked for download</fileName> </ns0:supportbundle>

JSON:

{ "ErsSupportBundleDownload" : { "fileName" : "Support bundle file name to be picked for download" } }

5. Seleccione PUT como método, pegue https://{ISE-ip}/ers/config/supportbundledownload y haga clic en Enviar. Si todo estaba correctamente configurado, debe ver un mensaje "200 OK" y el archivo descargado. 

Verificación

 Si puede acceder a la página GUI del servicio API, por ejemplo, https://{iseip}:{port}/api/swagger-ui/index.html o https://{iseip}:9060/ers/sdk, significa que el servicio API está funcionando como se esperaba.

Troubleshoot

• Todas las operaciones REST se auditan y los registros se registran en los registros del sistema.
• Para resolver problemas relacionados con las API abiertas, establezca el Nivel de registro para el componente apiservice en DEBUG en la ventana Debug Log Configuration.
• Para resolver problemas relacionados con las API ERS, establezca el Nivel de registro para el componente ers en DEBUG en la ventana Debug Log Configuration. Para ver esta ventana, navegue hasta la GUI de Cisco ISE, haga clic en el icono Menú y elija Operaciones > Solución de problemas > Asistente de depuración > Configuración del registro de depuración.
• Puede descargar los registros desde la ventana Download Logs (Descargar registros). Para ver esta ventana, navegue hasta la GUI de Cisco ISE, haga clic en el icono Menú y elija Operaciones > Solucionar problemas > Descargar registros.
• Puede descargar un paquete de soporte de la pestaña Paquete de soporte haciendo clic en el botón Descargar debajo de la pestaña, o descargar los registros de depuración api-service de la pestaña Registros de depuración haciendo clic en el valor de Archivo de registro para el registro de depuración api-service.