Secure Firewall REST API Inleiding

Inleiding

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

Aanvullende informatie

REST API is een Application Programming Interface die kan communiceren op basis van RESTful principes. REST API's communiceren via HTTP-verzoeken en voeren Create, Read, Update, and Delete (CRUD)-bewerkingen uit binnen een resource. Configuratie via REST API maakt veel mogelijkheden mogelijk om de manier waarop u Secure Firewall-apparaten configureert te automatiseren en te stroomlijnen.

De belangrijkste voordelen van het gebruik van REST API zijn:

• Schaalbaarheid - Aangezien bewerkingen kunnen worden uitgebreid tot meerdere bronnen.
• Flexibiliteit - Eenvoudig te implementeren in verschillende softwareontwikkelingsomgevingen; zoals de meeste API's gebruikt het XML, JSON en HTTP.
• Automatisering - U kunt configuratieprocessen voor meerdere apparaten tegelijk stroomlijnen door configuratiewijzigingen in bulk uit te voeren, waardoor tijdrovende repetitieve configuratietaken worden verminderd.

REST API vertrouwt op dezelfde authenticatie als de FMC/FDM en gebruikt OAUTH2.0. Elke functie in de REST API wordt toegewezen aan dezelfde rechten in FMC en FDM.

Configuratie

API Explorer Walk-Through

REST API is standaard ingeschakeld binnen FMC. U kunt bevestigen dat het is ingeschakeld door naar System > Configuration > REST API Preferenceste navigeren.

REST API inschakelen

FMC en FDM hebben een ingebouwde interface genaamd API Explorer, wat een handig hulpmiddel is voor het beoordelen van de mogelijkheden en functies van REST API. Voor FMC is API Explorer toegankelijk met deze URL; https:///api/api-explorer.

Inloggen met FMC GUI-referenties:

Log in met uw FMC GUI-referenties

Zodra u de API explorer opent, wordt de startpagina weergegeven. Hier vindt u de bovenste lint, domeinen en configuratie secties. In de rechterbovenhoek vindt u de versie-informatie en nuttige bronnen:

bovenlint

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

domeinen

Hierna worden de configuratiesecties en -mogelijkheden weergegeven, inclusief functies die door FMC worden ondersteund:

Configuratiesecties

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

schema's

API Explorer gebruiken

Ga nu terug naar de configuratiesecties en navigeer naar Apparaten:

Configuratie van apparaten

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

• GET – Lezen

• POST – Aanmaken

• PUT – Bijwerken/vervangen

• VERWIJDEREN – Verwijderen

De Unified Resource Identifier (URI) begeleidt elk van deze methoden met het bijbehorende pad naar elk object:

/api/fmc_config/v1/domain/{domainUUID}/devices/device records

Door een van deze methoden te kiezen, kunt u de parameters die zijn opgenomen in uw GET HTTP-aanvraag, uitbreiden en bekijken:

• filteren
• offset
• begrenzen
• uitgebreid
• Universally Unique Identifier (UUID)

APPARATEN/apparaatrecords OPHALEN

Opmerking: domein-UUID is van cruciaal belang bij het genereren van de HTTP-verzoeken, omdat elk object een unieke identificator heeft toegewezen en dergelijke is vereist om bewerkingen uit te voeren.

UUID voor apparaatrecorddomein

Kopieer de domein-UUID:

e276abec-e0f2-11e3-8169-6d9ed49b625f

Vervolgens kunt u de sectie Antwoorden zien, waar u de URL Curl and Request kunt vinden, samen met de standaard Serverreactie op deze methode en enkele voorbeelden van serverrespons.

Sectie Antwoorden.

FMC API Explorer GET-methode testen

Nu bent u klaar om de API Explorer-functionaliteit te testen door op Try it outte klikken:

Selecteer Probeer het uit

Voor dit specifieke HTTP GET-verzoek (van apparaten, apparaatrecords) hoeft u geen andere UUID of aanvullende parameters op te nemen en kunt u Uitvoeren kiezen:

Selecteer Uitvoeren

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

200 GET-responsoutput.

Merk op dat er één FTD wordt beheerd door deze FMC, genaamd FTDv-703.

UUID voor domein voor apparaatrecords OPHALEN

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

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

Als laatste voorbeeld kunt u alle interfaceconfiguraties van een bepaald beheerd apparaat (FTDv-703) ophalen door de UUID van een apparaat (verkregen uit de eerdere reactie) in deze methode te gebruiken:

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

Navigeer naar GET - Devices > Device records > physicalinterfaces.

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

FMC antwoordt (met de uitvoer Serverrespons) en u kunt zien dat dit apparaat (FTD) twee gegevensinterfaces en een diagnostische interface heeft die zijn geconfigureerd met de bijbehorende UUID en configuraties.

GET Device Records Fysieke interfaces Reactie.

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 toegang tot de HTTP-methoden zijn van toepassing op alle objecten. Als u van algemene naar specifieke UUID gaat, kunt u configuratiewijzigingen lezen, wijzigen of toevoegen aan de FMC en specifieke beheerde apparaten.

URI-structuur.

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

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

Opmerking: U kunt de Secure-Firewall Repository in Github bezoeken om veel sjablonen en automatiseringsbronnen te bekijken.