Secure Firewall REST API Inleiding

Inleiding

In dit document wordt de introductie van de REST API-configuratie beschreven 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 biedt veel mogelijkheden om de manier waarop u Secure Firewall-apparaten configureert te automatiseren en te stroomlijnen.

De belangrijkste voordelen van REST API zijn:

• Schaalbaarheid - Omdat Operations kan worden uitgebreid naar verschillende bronnen.
• Flexibiliteit - Gemakkelijk te implementeren in verschillende softwareontwikkelingsomgevingen; zoals de meeste API's maakt het gebruik van 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 is gebaseerd op dezelfde authenticatie als de FMC/FDM en maakt gebruik van OAUTH2.0. Elke functie in de REST API wijst dezelfde rechten toe in FMC en FDM.

Configuratie

API Explorer Walk-Through

REST API is standaard ingeschakeld binnen FMC. U kunt bevestigen dat deze optie is ingeschakeld door naar teSystem > Configuration > REST API Preferencesnavigeren.

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 via deze URL;https:///api/api-explorer.

Aanmelden met FMC GUI-referenties:

Log in met uw FMC GUI-referenties

Zodra u de API-verkenner hebt geopend, wordt de startpagina weergegeven. Hier vindt u het bovenste lint, de domeinen en de configuratiesecties. In de rechterbovenhoek vindt u de versie-informatie en nuttige bronnen:

bovenlint

Zoek vervolgens alle configuratiesecties op, te beginnen met de domeinen. Als u deze keuzelijst 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, onderaan de pagina, kunt u 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-bewerking uitvoert:

• GET – Lezen

• POST – Aanmaken

• PUT – Bijwerken/vervangen

• VERWIJDEREN – VERWIJDEREN

De Unified Resource Identifier (URI) vergezelt 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-verzoek uitbreiden en bekijken:

• filter
• offset
• limiet
• geëxpandeerd
• Universally Domain Unique Identifier (UUID)

Apparaten/apparaatrecords OPHALEN

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

UUID domein apparaatrecords

Kopieer de domein-UUID:

e276abec-e0f2-11e3-8169-6d9ed49b625f

Vervolgens ziet u de sectie Antwoorden, waar u de URL Curl en Verzoek kunt vinden, samen met de standaard Serverrespons 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 te klikken opTry it out:

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 kiezen voor Uitvoeren:

Selecteer Uitvoering

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

200 GET-responsuitvoer.

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

UUID ID 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 met behulp van de UUID van een apparaat (verkregen uit de eerdere reactie) in deze methode:

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

Navigeer naarGET-Devices > Device records > physicalinterfaces.

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

FMC antwoordt (met de server response output) en u kunt zien dat dit apparaat (FTD) twee data-interfaces en een diagnostische interface heeft geconfigureerd met de bijbehorende UUID en configuraties.

De reactie van de fysieke interfaces van het apparaat ophalen.

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. Van algemene naar specifieke UUID, u kunt lezen, wijzigen of toevoegen van configuratiewijzigingen aan de FMC en specifieke beheerde apparaten.

URI-structuur.

De FMC API explorer kan van groot nut zijn als gids 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.