Introdução à API REST de firewall seguro

Introdução

Este documento descreve a introdução da configuração da API REST para o Cisco Secure Firewall usando o Firewall Management Center API explorer.

Informações adicionais

A API REST é uma interface de programação de aplicativos que pode se comunicar com base nos princípios RESTful. As APIs REST se comunicam por meio de solicitações HTTP e executam operações CRUD (Create, Read, Update, and Delete, criar, ler, atualizar e excluir) em um recurso. A configuração por meio da API REST permite várias possibilidades de automatizar e simplificar a forma como você configura os dispositivos de firewall seguro.

As principais vantagens do uso da API REST são:

• Escalabilidade - Como as operações podem ser estendidas para vários recursos.
• Flexibilidade - Fácil de implementar em diferentes ambientes de desenvolvimento de software; como a maioria das APIs, ele usa XML, JSON e HTTP.
• Automação - Você pode simplificar os processos de configuração para vários dispositivos de uma só vez, executando alterações de configuração em massa, reduzindo as demoradas tarefas repetitivas de configuração.

A API REST depende da mesma autenticação que o FMC/FDM e usa OAUTH2.0. Cada função na API REST é mapeada para as mesmas permissões no FMC e no FDM.

Configuração

Passeio pelo Explorador de API

A API REST é habilitada por padrão no FMC. Você pode confirmar se ela está ativada navegando para System > Configuration > REST API Preferences.

Habilitar API Rest

O FMC e o FDM têm uma interface interna chamada API Explorer, que é uma ferramenta útil para analisar os recursos e as funções da API REST. Para o FMC, o API Explorer pode ser acessado com este URL; https:// /api/api-explorer .

Fazer login usando as credenciais GUI do FMC:

Entrar usando suas credenciais da GUI do FMC

Depois de acessar o explorador de API, a página inicial é exibida. Aqui você pode encontrar a faixa superior, os domínios e as seções de configuração. No canto superior direito, você encontrará informações sobre a versão, bem como recursos úteis:

Faixa Superior

Em seguida, localize todas as seções de configuração, começando pelos Domínios. A escolha desse menu suspenso exibe todos os domínios FMC existentes.

Domínios

As seções e os recursos de configuração são mostrados a seguir, incluindo os recursos compatíveis com o FMC:

Seções de configuração

Finalmente, na parte inferior da página, você pode encontrar a seção Esquemas. Aqui você pode ver algumas das configurações no JSON para recursos adicionais suportados que você pode usar como referência para construir suas solicitações HTTP para esses recursos:

Esquemas

Usando o Explorador de API

Agora, voltando às seções de configuração, navegue até Devices:

Configuração de dispositivos

A API REST para FMC oferece suporte aos próximos métodos HTTP. Observe que cada um deles executa uma operação CRUD:

• GET - Ler

• POST - Criar

• PUT - Atualizar/Substituir

• EXCLUIR - Excluir

O Unified Resource Identifier (URI) acompanha cada um destes métodos com o caminho correspondente para cada objeto:

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

Escolhendo um destes métodos, você pode expandir e ver os parâmetros incluídos em sua solicitação HTTP GET:

• Filtrar
• Deslocamento
• Limite
• Expandido
• Identificador Universalmente Exclusivo de Domínio (UUID)

OBTER registros de dispositivos/dispositivos

UUID do Domínio de Registros do Dispositivo

Copie o UUID do domínio:

e276abec-e0f2-11e3-8169-6d9ed49b625f

Em seguida, você pode ver a seção Respostas, onde você pode encontrar o URL de Curl e Solicitação junto com a Resposta do servidor padrão para este método e alguns exemplos de resposta do servidor.

Seção Respostas.

Testar método GET do API Explorer do FMC

Agora você está pronto para testar a funcionalidade do explorador de API clicando em Try it out:

Selecione Experimentar

Para esta solicitação HTTP GET específica (de dispositivos, registros de dispositivos), você não precisa incluir nenhum outro UUID ou parâmetros adicionais e pode escolher Executar:

Selecione Executar

O FMC retornará uma Resposta do servidor 200 se a solicitação HTTP GET tiver sido bem-sucedida e o corpo da Resposta contiver informações de Dispositivo para todos os dispositivos registrados em seu FMC.

200 Saída de Resposta GET.

Nesta saída, observe que há um FTD gerenciado por este FMC, chamado FTDv-703.

OBTER UUID do Domínio de Registros do Dispositivo

Você pode anotar o valor de ID conforme ele é usado para acessar as solicitações de API direcionadas a este FTD em particular. Copie a ID:

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

Como exemplo final, você pode recuperar todas as configurações de interface de um dispositivo gerenciado específico (FTDv-703) usando o UUID de um dispositivo (obtido da resposta anterior) neste método:

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

Navegue até GET - Devices > Device records > physicalinterfaces.

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

O FMC responde (com a saída de Server Response) e você pode ver que esse dispositivo (FTD) tem duas interfaces de dados e uma interface de diagnóstico configurada com suas configurações e UUID correspondentes.

GET Device registra resposta de interfaces físicas.

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"

A estrutura em árvore anterior e a lógica de acesso aos métodos HTTP são aplicáveis a todos os objetos. Prosseguindo do UUID geral para o específico, você pode ler, modificar ou adicionar alterações de configuração no FMC e em dispositivos gerenciados específicos.

Estrutura de URI.

O explorador de API do FMC pode ser de grande utilidade como guia ou referência para visualizar os recursos e métodos de configuração suportados, para que você possa projetar e personalizar seu código para implantações de configuração.

Você também pode interagir com a API do FMC usando várias plataformas de API, como Postman, ou a partir de um host local por meio de um script Python ou Perl.