Inleiding voor Secure Firewall REST API

Inleiding

Dit document beschrijft de introductie van de REST API-configuratie voor Cisco Secure Firewall met behulp van Firewall Management Center API-verkenner.

Aanvullende informatie

REST API is een Application Programming Interface die kan communiceren op basis van RESTful principes. REST API's communiceren via HTTP-aanvragen en voeren Creëer, Lezen, Update en Verwijderen (CRUD) bewerkingen uit binnen een resource. Configuratie via REST API maakt veel mogelijkheden om de manier waarop u Secure Firewall-apparaten configureren te automatiseren en te stroomlijnen.

De belangrijkste voordelen van het gebruik van REST API zijn:

• Schaalbaarheid - Aangezien Operations kan worden uitgebreid naar meerdere bronnen.
• Flexibiliteit - Eenvoudig te implementeren in verschillende softwareontwikkelingsomgevingen; zoals de meeste API's, gebruikt het XML, JSON en HTTP.
• Automatisering - U kunt de configuratieprocessen voor meerdere apparaten tegelijkertijd stroomlijnen door configuratiewijzigingen in bulk uit te voeren, waardoor tijdrovende, herhalende configuratietaken worden geminimaliseerd.

REST API is gebaseerd op dezelfde authenticatie als FMC/FDM en gebruikt OAUTH2.0. Elke functie in de REST API brengt dezelfde rechten in kaart in FMC en FDM.

Configuratie

API Explorer doorlopen

REST API is standaard ingeschakeld binnen FMC. U kunt bevestigen dat deze optie is ingeschakeld door te navigeren naar System > Configuration > REST API Preferences.

API voor rustperioden inschakelen

FMC en FDM hebben een ingebouwde interface genaamd API Explorer, wat een handig hulpmiddel is om de mogelijkheden en functies van REST API te bekijken. Voor FMC, API Explorer kan worden benaderd met deze URL; https:// /api/api-explorer .

Aanmelden met FMC GUI-referenties:

Meld u aan met uw FMC GUI-referenties

Na toegang tot de API verkenner, wordt de startpagina weergegeven. Hier vindt u de bovenste linten, domeinen en configuratiesecties. In de rechterbovenhoek vindt u de versiegegevens en nuttige bronnen:

Bovenste lint

Zoek vervolgens alle configuratiesecties, te beginnen met de domeinen. Als u deze vervolgkeuzelijst kiest, worden alle bestaande FMC-domeinen weergegeven.

Domeinen

De volgende configuratiesecties en -functies worden weergegeven, inclusief functies die door FMC worden ondersteund:

Configuratiesecties

Tot slot, onderaan de pagina, kunt u de sectie Schemas vinden. Hier kunt u enkele configuraties in JSON bekijken voor extra ondersteunde functies die u kunt gebruiken als referentie om uw HTTP-aanvragen voor deze functies op te bouwen:

Schemas

API Explorer gebruiken

Ga nu terug naar de configuratie secties en navigeer naar Apparaten:

Configuratie van apparaten

REST API voor FMC ondersteunt de volgende HTTP-methoden. Merk op dat elk van hen een RUWE handeling uitvoert:

• GET - Lees

• POST - Aanmaken

• PUT - Bijwerken/vervangen

• VERWIJDEREN - Verwijderen

Het Unified Resource Identifier (URI) begeleidt deze methoden met het corresponderende pad naar elk object:

/api/fmc_config/v1/domain/{domainUUID}/apparaten/apparaatrecords

Door één van deze methodes te kiezen, kunt u uitbreiden en de parameters zien inbegrepen in uw GET HTTP- verzoek:

• filteren
• Offset
• Limiet
• Uitgebreid
• Domain Universally Unique Identifier (UUID)

GET apparaten/apparaatrecords

UID voor domein apparaatrecords

Kopieer de Domain UUID:

e276abec-e0f2-11e3-8169-6d9ed49b625f

Vervolgens kunt u de sectie Antwoorden zien, waar u de Curl en Aanvraag URL samen met de standaard Server Response op deze methode en enkele server response voorbeelden kan vinden.

Sectie Antwoorden.

Test FMC API Explorer GET methode

Nu bent u bereid om de functionaliteit van de API-verkenner te testen door op te klikken Try it out:

Selecteer Uitproberen

Voor deze specifieke HTTP GET aanvraag (van apparaten, apparaatrecords) hoeft u geen andere UUID of extra parameters op te nemen en kunt u Execute kiezen:

Selecteer Uitvoeren

FMC retourneert een Server Response 200 als de HTTP GET-aanvraag succesvol was en de Response-instantie apparaatinformatie bevat voor alle geregistreerde apparaten in uw FMC.

200 GET Response Output.

Uit deze output, merk op dat er één FTD beheerd door dit FMC, genaamd FTDv-703.

UID-domein apparaatrecords VERKRIJGEN

U kunt de ID-waarde noteren zoals deze wordt gebruikt om toegang te krijgen tot de API-verzoeken die specifiek gericht zijn op dit FTD. Kopieer de ID:

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

Als laatste voorbeeld kunt u alle interfaceconfiguraties van een bepaald beheerde apparaat (FTDv-703) ophalen met behulp van de UUID van een apparaat (verkregen uit de eerdere respons) in deze methode:

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

Naar navigeren GET - Devices > Device records > physicalinterfaces.

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

FMC reageert (met de Server Response-uitvoer) en u kunt zien dat dit apparaat (FTD) twee data-interfaces en een diagnostische interface heeft geconfigureerd met de bijbehorende UUID en configuraties.

GET Device Records Physical Interfaces respons.

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"

De vorige boomachtige structuur en de logica van de toegang tot de HTTP-methoden zijn van toepassing op alle objecten. Als u van algemene naar specifieke UUID gaat, kunt u wijzigingen in de configuratie van het VCC en specifieke beheerde apparaten lezen, wijzigen of toevoegen.

URI structuur.

De FMC API verkenner kan van groot nut zijn als gids of referentie om de ondersteunde functies en configuratiemethoden te bekijken, zodat u uw code voor configuratie implementaties kunt ontwerpen en aanpassen.

U kunt ook met FMC API communiceren via meerdere API-platforms zoals Postman of vanuit een lokale host via Python of Perl script.