Verzamel ISE-ondersteuningsbundel met ERS API

Inleiding

Dit document beschrijft het proces voor het activeren en downloaden van een ISE-ondersteuningsbundel via ERS API met PostMan als de REST-client. 

Voorwaarden

Vereisten

Cisco raadt kennis van de volgende onderwerpen aan:

• ISE
• Externe RUSTful-services
• REST klanten zoals Postman, RESTED, Insomnia, enzovoort.

Gebruikte componenten

De informatie in dit document is gebaseerd op de volgende softwareversies:

• Cisco ISE 3.1-patch 6
• Postman REST client v10.17.4

De informatie in dit document is gebaseerd op de apparaten in een specifieke laboratoriumomgeving. Alle apparaten die in dit document worden beschreven, hadden een opgeschoonde (standaard)configuratie. Als uw netwerk live is, moet u zorgen dat u de potentiële impact van elke opdracht begrijpt.

Configureren

ERS inschakelen (poort 9060)

ERS API's zijn HTTPS-only REST API's die werken via poort 443 en poort 9060. Port 9060 is standaard gesloten, dus het moet eerst geopend worden. Er wordt een time-out van de server weergegeven als clients die proberen toegang te krijgen tot deze poort niet eerst ERS inschakelen. Daarom is de eerste vereiste dat ERS vanuit de Cisco ISE-beheerder UI mogelijk wordt gemaakt.

Navigeer naar Beheer > Instellingen > API-instellingen en schakel de knop ERS (Lezen/schrijven) in.

ERS-beheerder maken

Maak een Cisco ISE-beheerder, wijs een wachtwoord toe en voeg de gebruiker aan de beheergroep toe als ERS-beheerder. U kunt de rest van de configuratie leeg laten.

Postman instellen

Download of gebruik de online versie van Postman.

1. Maak een gebruiker en maak een werkruimte door te klikken op Create Workspace onder het tabblad Workspace.

2. Selecteer Lege werkruimte en wijs een naam toe aan de werkruimte. U kunt een beschrijving toevoegen en deze openbaar maken. In dit voorbeeld is Personalis geselecteerd.

Zodra u de werkruimte hebt gemaakt, kunt u nu onze API-oproepen configureren.

Ondersteuningsbundel voor triggers 

Om een gesprek te configureren hebt u eerst toegang tot de ISE ERS SDK (Software Developer Kit). Dit hulpmiddel compileert de gehele lijst van API vraag ISE kan uitvoeren:

1. Ga naar https://{ise-ip}/ers/sdk
2. Login met behulp van uw ISE-beheerreferenties.
3. De API-documentatie uitbreiden
4. Scroll naar beneden tot u Support Bundle Trigger Configuration vindt en klik erop.
5. Onder deze optie kunt u nu alle beschikbare bewerkingen vinden die u voor deze optie op ISE kunt uitvoeren. Selecteer Aanmaken.

6. U kunt nu de configuratie zien die nodig is om de API-oproep uit te voeren met behulp van XML of JSON op een Rest-client, evenals een verwacht responsvoorbeeld. 

7.Back to Postman laat basisverificatie configureren naar ISE. Selecteer in het tabblad Autorisatie Basis autorisatie als het verificatietype en voeg de eerder op ISE gemaakte ISE ERS-gebruikersreferenties toe.

8. In Postman ga je naar het tabblad Koppen en configureer je de benodigde kopregels voor de API-aanroep met XML of JSON zoals in de SDK. In dit voorbeeld wordt JSON gebruikt. De headerconfiguratie moet er als volgt uitzien:

9. Verplaats naar de kop Tekst en selecteer rauw. Hiermee kunnen we de XML- of JSON-sjabloon plakken die nodig is voor het activeren van de Support Bundle. 

10. Plakt de XML- of JSON-sjabloon in het gedeelte Body om de waarden naar wens te wijzigen:

XML:

<?xml version="1.0" encoding="UTF-8"?> <ns0:supportbundle xmlns:ns0="supportbundle.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Support Bundle Generation" name="supportBundle"> <hostName>Node hostname the SB is being collected from </hostName> <supportBundleIncludeOptions> <fromDate>mm/dd/yyyy</fromDate> <includeConfigDB>true|false</includeConfigDB> <includeCoreFiles>true|false</includeCoreFiles> <includeDebugLogs>true|false</includeDebugLogs> <includeLocalLogs>true|false</includeLocalLogs> <includeSystemLogs>true|false</includeSystemLogs> <mntLogs>true|false</mntLogs> <policyXml>true|false</policyXml> <toDate>mm/dd/yyyy</toDate> </supportBundleIncludeOptions> </ns0:supportbundle>

ZOON:

{ "SupportBundle": { "name": "supportBundle", "description": "Support Bundle Generation", "hostName": "node hostname the SB is being collected from", "supportBundleIncludeOptions": { "includeConfigDB": true|false, "includeDebugLogs": true|false, "includeLocalLogs": true|false, "includeCoreFiles": true|false, "mntLogs": true|false, "includeSystemLogs": true|false, "policyXml": true|false, "fromDate": "mm/dd/yyyy", "toDate": "mm/dd/yyyy" } } }

11. Selecteer POST als de methode, plak https://{ISE-ip}/ers/config/support bundel en klik op Verzenden. Als alles correct was geconfigureerd, moet u een "201 Created" bericht zien en het resultaat leeg. 

Status ondersteuningsbundel controleren

U kunt bevestigen of de Ondersteuningsbundel geactiveerd of voltooid is door een serie GET gesprekken uit te voeren. 

1. Op de SDK onder de Support Bundle Status selecteerGet-All. Je wilt het ID hebben zodat je de volgende GET call kunt uitvoeren.  Zoals eerder gezien, hier zijn de kopregels die nodig zijn om de oproep uit te voeren en de verwachte reactie.

2. Ga naar het tabblad Koppen en configureer de gewenste kopregels voor de API-aanroep zoals weergegeven in de SDK. In dit voorbeeld wordt JSON gebruikt. De headerconfiguratie moet er als volgt uitzien:

3. Selecteer GET als de methode, plak https://{ISE-ip}/ers/config/support bundlestatus en klik op Verzenden. Als alles correct was geconfigureerd, moet u een "200 OK"-bericht zien en het resultaat met informatie over de laatste ondersteuningsbundel geactiveerd. Deze oproep laat ons niet weten of het ondersteuningsbundel al dan niet met succes is voltooid. Verzamel vanaf deze oproep de ID, zodat u deze bij de volgende GET-oproep kunt gebruiken. 

4. Zodra de ID is verzameld, gaat u naar de SDK, onder de statuten van de ondersteuningsbundel en selecteert u Get-By-Id. Zoals eerder te zien, zijn hier de kopregels die vereist zijn om de oproep uit te voeren en de verwachte reactie.

5. Ga naar het tabblad Koppen en configureer de gewenste kopregels voor de API-aanroep zoals weergegeven in de SDK. In dit voorbeeld wordt JSON gebruikt. De headerconfiguratie moet er als volgt uitzien:

6. Selecteer GET als de methode, plak https://{ISE-ip}/ers/config/support bundbundlestatus/{id} en de ID die uit stap 3 is verzameld, klik tot slot op Send. Als alles correct was geconfigureerd, moet u een "200 OK" bericht zien en het resultaat met informatie over het al dan niet voltooien van de laatste Support Bundle geactiveerd. Noteer de bestandsnaam van deze oproep omdat u deze nodig hebt voor de PUT aanroep.

Ondersteuningsbundel downloaden

Nadat u hebt bevestigd dat het ondersteuningsbundel zich in de voltooide staat bevindt. U kunt doorgaan met het downloaden. 

1. Selecteer in de SDK onder het tabblad Ondersteuningsbundel downloaden de optie Ondersteuningsbundel downloaden. Zoals eerder te zien, hier zijn de kopregels die nodig zijn om de oproep uit te voeren, de XML en JSON sjablonen, evenals de verwachte reactie.

2. Ga naar het tabblad Koppen en configureer de gewenste kopregels voor de API-aanroep zoals weergegeven in de SDK. In dit voorbeeld wordt JSON gebruikt. De headerconfiguratie moet er als volgt uitzien:

3. Verplaats naar de kop Tekst en selecteer rauw. Hiermee kunnen we de XML- of JSON-sjabloon plakken die nodig is voor het downloaden van de Support Bundle. 

4. Plakt de XML- of JSON-sjabloon in het gedeelte Body om de waarden naar behoefte te wijzigen. De bestandsnaam zou de naam zijn van het bestand dat uit stap 6 is verzameld (ise-support-bundle-pk-ise3-1test-external-09-26-2023-01-26.tar.gpg):

XML

<?xml version="1.0" encoding="UTF-8"?> <ns0:supportbundle xmlns:ns0="supportbundle.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com"> <fileName>Support bundle file name to be picked for download</fileName> </ns0:supportbundle>

ZOON:

{ "ErsSupportBundleDownload" : { "fileName" : "Support bundle file name to be picked for download" } }

5. Selecteer PUT als de methode, plak https://{ISE-ip}/ers/config/support bundbundledownload en klik op Verzenden. Als alles goed is geconfigureerd, moet u een "200 OK"-bericht zien en het bestand downloaden. 

Verifiëren

 Als u tot de API dienst GUI pagina kunt toegang hebben, bijvoorbeeld, https://{iseip}:{port}/api/swagger-ui/index.html of https://{iseip}:9060/ers/sdk, betekent het dat de API-service werkt zoals verwacht.

Problemen oplossen

• Alle REST-bewerkingen worden gecontroleerd en de logbestanden worden ingelogd in de systeemlogbestanden.
• Om problemen op te lossen die betrekking hebben op de Open API's, stelt u het niveau van het logboek voor de apisservice-component in om te DEBUGGEN in het venster van de Debug Log Configuration.
• Om problemen met betrekking tot de ERS API's op te lossen, stelt u het Logniveau voor de ers-component in om DEBUG te maken in het venster Debug Log Configuration. Als u dit venster wilt weergeven, navigeert u naar de Cisco ISE GUI, klikt u op het pictogram Menu en kiest u Operations > Probleemoplossing > Wizard Debug > Log Configuration.
• U kunt de logbestanden downloaden vanuit het venster Download Logs. Als u dit venster wilt weergeven, navigeert u naar de Cisco ISE GUI, klikt u op het pictogram Menu en kiest u Operations > Probleemoplossing > Logbestanden downloaden.
• U kunt ervoor kiezen om een ondersteuningsbundel van het tabblad Support te downloaden door op de knop Downloaden onder het tabblad te klikken, of om de api-service debug logs te downloaden van het tabblad Debug Logs door op de waarde Log File voor het debug-log te klikken.