Introducción a la API REST de firewall seguro

Introducción

Este documento describe la introducción a la configuración de la API REST para Cisco Secure Firewall mediante el explorador de API de Firewall Management Center.

Additional Information

La API REST es una interfaz de programación de aplicaciones que puede comunicarse según los principios de RESTful. Las API REST se comunican a través de solicitudes HTTP y realizan operaciones de creación, lectura, actualización y eliminación (CRUD) en un recurso. La configuración a través de la API REST ofrece numerosas posibilidades para automatizar y agilizar la configuración de los dispositivos de firewall seguro.

Las principales ventajas de utilizar la API REST son:

• Escalabilidad: las operaciones se pueden ampliar a varios recursos.
• Flexibilidad - Fácil de implementar en diferentes entornos de desarrollo de software; como la mayoría de las API, utiliza XML, JSON y HTTP.
• Automatización: puede simplificar los procesos de configuración de varios dispositivos a la vez realizando cambios de configuración de forma masiva, lo que reduce las tareas de configuración repetitivas que consumen mucho tiempo.

La API REST se basa en la misma autenticación que la FMC/FDM y utiliza OAUTH 2.0. Cada función de la API REST se asigna a los mismos permisos en FMC y FDM.

Configuración

Tutorial del Explorador de API

La API REST está activada de forma predeterminada en FMC. Para confirmar que está activado, acceda a System > Configuration > REST API Preferences.

Activar API Rest

FMC y FDM tienen una interfaz incorporada llamada API Explorer, que es una herramienta útil para revisar las capacidades y funciones de la API REST. Para FMC, se puede acceder al Explorador de API con esta URL; https:// /api/api-explorer .

Inicio de sesión con credenciales de GUI de FMC:

Inicie sesión con las credenciales de la GUI de FMC

Una vez que acceda al explorador de la API, se mostrará la página de inicio. Aquí puede encontrar las secciones de configuración, dominios y la banda superior. En la esquina superior derecha, puede encontrar información sobre la versión, así como recursos útiles:

Cinta superior

A continuación, busque todas las secciones de configuración, empezando por los dominios. Al elegir este menú desplegable, se muestran todos los dominios FMC existentes.

Dominos

A continuación se muestran las secciones y funciones de configuración, incluidas las funciones compatibles con FMC:

Secciones de configuración

Por último, en la parte inferior de la página, puede encontrar la sección Esquemas. Aquí puede echar un vistazo a algunas de las configuraciones en JSON para ver las funciones admitidas adicionales que puede utilizar como referencia para generar sus solicitudes HTTP para estas funciones:

Esquemas

Utilizar el Explorador de API

Ahora, volviendo a las secciones de configuración, navegue hasta Dispositivos:

Configuración de dispositivos

La API REST para FMC admite los siguientes métodos HTTP. Tenga en cuenta que cada uno de ellos realiza una operación CRUD:

• GET - Lectura

• POST - Crear

• PUT - Actualizar/Reemplazar

• ELIMINAR - Eliminar

El identificador de recursos unificado (URI) acompaña a cada uno de estos métodos con la ruta correspondiente a cada objeto:

/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords

Al elegir uno de estos métodos, puede expandir y ver los parámetros incluidos en su solicitud GET HTTP:

• Filtro
• Offset (desplazamiento)
• Límite
• Ampliado
• Identificador único universal (UUID) de dominio

OBTENER dispositivos/registros dedispositivos

UUID de dominio de registros de dispositivos

Copie el UUID de dominio:

e276abec-e0f2-11e3-8169-6d9ed49b625f

A continuación, puede ver la sección Respuestas, donde puede encontrar la URL de Curl y Request junto con la Respuesta del servidor predeterminada a este método y algunos ejemplos de respuesta del servidor.

Sección Respuestas.

Test FMC API Explorer GET Method

Ahora está listo para probar la funcionalidad del explorador de API haciendo clic en Try it out:

Seleccione Try it out.

Para esta solicitud GET HTTP específica (de dispositivos, registros de dispositivos), no es necesario incluir ningún otro UUID o parámetros adicionales y puede elegir Ejecutar:

Seleccione Ejecutar

FMC devuelve una respuesta de servidor 200 si la solicitud GET de HTTP se realizó correctamente y el cuerpo de la respuesta contiene información de dispositivo para todos los dispositivos registrados en su FMC.

Salida de respuesta GET 200.

A partir de este resultado, observe que hay un FTD gestionado por este FMC, denominado FTDv-703.

UUID de dominio de registros de dispositivos GET

Puede anotar el valor de ID tal como se utiliza para acceder a las solicitudes de API dirigidas a este FTD en particular. Copie la ID:

"name": "FTDv-703"
"id": "6bad6bbc-0b05-11ee-9a47-84ecf73b3ccf"

Como ejemplo final, puede recuperar todas las configuraciones de interfaz de un dispositivo administrado concreto (FTDv-703) mediante el UUID de un dispositivo (obtenido de la respuesta anterior) en este método:

"id": "6bad6bbc-0b05-11ee-9a47-84ecf73b3ccf"

Desplácese hasta GET - Devices > Device records > physicalinterfaces.

/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/physicalinterfaces

FMC responde (con la salida Server Response) y puede ver que este dispositivo (FTD) tiene dos interfaces de datos y una interfaz de diagnóstico configuradas con sus correspondientes UUID y configuraciones.

Respuesta de interfaces físicas de registros de dispositivos GET.

From Response body:

"type": "PhysicalInterface",
"id": "005056B3-9582-0ed3-0000-004294967553",
"name": "GigabitEthernet0/0"

"type": "PhysicalInterface",
"id": "005056B3-9582-0ed3-0000-004294967554",
"name": "GigabitEthernet0/1"

"type": "PhysicalInterface",
"id": "005056B3-9582-0ed3-0000-004294967555",
"name": "Diagnostic0/0"

La estructura en forma de árbol anterior y la lógica de acceso a los métodos HTTP son aplicables a todos los objetos. A partir de un UUID general a uno específico, puede leer, modificar o agregar cambios de configuración al FMC y a dispositivos administrados específicos.

Estructura URI.

El explorador API FMC puede ser de gran utilidad como guía o referencia para ver las características y métodos de configuración compatibles, de modo que pueda diseñar y personalizar su código para implementaciones de configuración.

También puede interactuar con FMC API utilizando varias plataformas de API como Postman o desde un host local a través de Python o Perl script.