ERS API를 사용하여 ISE 지원 번들 수집

소개

이 문서에서는 PostMan을 REST 클라이언트로 사용하여 ERS API를 통해 ISE 지원 번들을 트리거하고 다운로드하는 프로세스에 대해 설명합니다. 

사전 요구 사항

요구 사항

다음 주제에 대한 지식을 보유하고 있으면 유용합니다.

• ISE
• 외부 RESTful 서비스
• REST 클라이언트 Postman, REST, Insomnia 등

사용되는 구성 요소

이 문서의 정보는 다음 소프트웨어 버전을 기반으로 합니다.

• Cisco ISE 3.1 패치 6
• Postman REST 클라이언트 v10.17.4

이 문서의 정보는 특정 랩 환경의 디바이스를 토대로 작성되었습니다. 이 문서에 사용된 모든 디바이스는 초기화된(기본) 컨피그레이션으로 시작되었습니다. 현재 네트워크가 작동 중인 경우 모든 명령의 잠재적인 영향을 미리 숙지하시기 바랍니다.

구성

ERS 활성화(포트 9060)

ERS API는 포트 443 및 포트 9060을 통해 작동하는 HTTPS 전용 REST API입니다. 포트 9060은 기본적으로 닫혀 있으므로 먼저 열어야 합니다. 이 포트에 액세스하려는 클라이언트가 ERS를 먼저 활성화하지 않을 경우 서버의 시간 초과가 표시됩니다. 따라서 첫 번째 요구 사항은 Cisco ISE 관리 UI에서 ERS를 활성화 하는 것 입니다.

Administration(관리) > Settings(설정) > API Settings(API 설정)로 이동하고 ERS(Read/Write) 토글 버튼을 활성화합니다.

ERS 관리자 생성

Cisco ISE 관리자를 만들고 암호를 할당한 다음 사용자를 관리자 그룹에 ERS 관리자로 추가합니다. 나머지 컨피그레이션은 비워둘 수 있습니다.

Postman 설정

Postman의 온라인 버전을 다운로드하거나 사용합니다.

1. 작업공간(Workspaces) 탭에서 작업공간 생성(Create Workspace)을 클릭하여 사용자를 생성하고 작업공간을 생성합니다.

2. 빈 Workspace를 선택하고 Workspace에 이름을 지정합니다. 설명을 추가하고 공개할 수 있습니다. 이 예에서는 Personalis를 선택합니다.

Workspace를 생성했으면 이제 API 호출을 구성할 수 있습니다.

트리거 지원 번들 

통화를 구성하려면 먼저 ISE ERS SDK(소프트웨어 개발자 키트)에 액세스하도록 합니다. 이 도구는 ISE에서 수행할 수 있는 API 호출의 전체 목록을 컴파일합니다.

1. https://{ise-ip}/ers/sdk로 이동
2. ISE 관리자 자격 증명을 사용하여 로그인합니다.
3. API 문서를 확장합니다.
4. Support Bundle Trigger Configuration(지원 번들 트리거 컨피그레이션)이 나타날 때까지 아래로 스크롤하여 클릭합니다.
5. 이제 이 옵션에서 ISE에서 이 옵션에 대해 수행할 수 있는 모든 작업을 찾을 수 있습니다. 생성을 선택합니다.

6. 이제 모든 Rest 클라이언트에서 XML 또는 JSON을 사용하여 API 호출을 수행하는 데 필요한 컨피그레이션과 예상 응답 예를 볼 수 있습니다. 

7. Postman으로 돌아오면 ISE에 대한 기본 인증을 구성할 수 있습니다. Authorization(권한 부여) 탭에서 Basic Auth(기본 인증)를 인증 유형으로 선택하고 ISE에서 이전에 생성한 ISE ERS 사용자 자격 증명을 추가합니다.

8. Postman에서 Headers(헤더) 탭으로 이동하고 SDK에 표시된 대로 XML 또는 JSON을 사용하여 API 호출에 필요한 헤더를 구성합니다. 이 예에서는 JSON이 사용됩니다. 헤더 구성은 다음과 같아야 합니다.

9. 본문 헤더로 이동하고 raw를 선택합니다. 이를 통해 지원 번들을 트리거하는 데 필요한 XML 또는 JSON 템플릿을 붙여넣을 수 있습니다. 

10. 필요에 따라 값을 변경하여 본문 섹션에 XML 또는 JSON 템플릿을 붙여넣습니다.

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>

JSON:

{ "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. 방법으로 POST를 선택하고 https://{ISE-ip}/ers/config/supportbundle을 붙여넣은 후 Send(보내기)를 클릭합니다. 모든 것이 올바르게 구성된 경우 "201 Created(201 생성)" 메시지가 표시되고 결과가 비어 있어야 합니다. 

지원 번들 상태 확인

지원 번들이 일련의 GET 호출을 실행하여 트리거되거나 완료되었는지 확인할 수 있습니다. 

1. SDK의 Support Bundle Statustab SelectGet-All을 선택합니다. 다음 GET 통화를 실행할 수 있도록 ID를 가져오려고 합니다.  앞에서 살펴본 것처럼, 통화를 수행하는 데 필요한 헤더와 예상 응답입니다.

2. Headers(헤더) 탭으로 이동하고 SDK에 표시된 대로 API 호출에 필요한 헤더를 구성합니다. 이 예에서는 JSON이 사용됩니다. 헤더 구성은 다음과 같아야 합니다.

3. 방법으로 GET을 선택하고 https://{ISE-ip}/ers/config/supportbundlestatus를 붙여넣은 후 Send를 클릭합니다. 모든 것이 올바르게 구성된 경우, 마지막으로 트리거된 지원 번들과 관련된 정보가 포함된 "200 OK" 메시지와 결과가 표시되어야 합니다. 이 통화는 지원 번들이 성공적으로 완료되었는지 여부를 알려주지 않습니다. 이 통화에서 다음 GET 통화에서 사용할 수 있도록 ID를 수집합니다. 

4. ID가 수집되면 Support Bundle Statustab 아래의 SDK로 이동하여 Get-By-Id를 선택합니다. 앞에서 살펴본 것처럼, 통화를 수행하는 데 필요한 헤더와 예상 응답입니다.

5. Headers(헤더) 탭으로 이동하여 SDK에 표시된 대로 API 호출에 필요한 헤더를 구성합니다. 이 예에서는 JSON이 사용됩니다. 헤더 구성은 다음과 같아야 합니다.

6. 방법으로 GET을 선택하고 https://{ISE-ip}/ers/config/supportbundlestatus/{id} 및 3단계에서 수집한 ID를 붙여넣은 후 Send를 클릭합니다. 모든 것이 올바르게 구성된 경우, 마지막으로 트리거된 지원 번들의 완료 여부와 관련된 정보와 함께 "200 OK" 메시지와 결과가 표시되어야 합니다. PUT 통화에 필요하므로 이 통화의 fileName을 기록해 둡니다.

지원 번들 다운로드

지원 번들이 완료됨 상태인지 확인한 후 다운로드하실 수 있습니다. 

1. SDK의 Support Bundle Downloadtab(지원 번들 다운로드)에서 Download SupportBundle(지원 번들 다운로드)을 선택합니다. 앞에서 살펴본 것처럼, 통화를 수행하는 데 필요한 헤더, XML 및 JSON 템플릿, 예상 응답입니다.

2. Headers(헤더) 탭으로 이동하고 SDK에 표시된 대로 API 호출에 필요한 헤더를 구성합니다. 이 예에서는 JSON이 사용됩니다. 헤더 구성은 다음과 같아야 합니다.

3. 본문 헤더로 이동하고 raw를 선택합니다. 이렇게 하면 지원 번들을 다운로드하는 데 필요한 XML 또는 JSON 템플릿을 붙여넣을 수 있습니다. 

4. 필요에 따라 값을 변경하여 본문 섹션에 XML 또는 JSON 템플릿을 붙여넣습니다. 파일 이름은 6단계에서 수집된 파일의 이름입니다(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>

JSON:

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

5. 방법으로 PUT를 선택하고 https://{ISE-ip}/ers/config/supportbundledownload를 붙여넣은 후 Send를 클릭합니다. 모든 것이 올바르게 구성된 경우 "200 OK" 메시지와 다운로드된 파일이 표시되어야 합니다. 

다음을 확인합니다.

 API 서비스 GUI 페이지에 액세스할 수 있는 경우(예: https://{iseip}:{port}/api/swagger-ui/index.html 또는 https://{iseip}:9060/ers/sdk)는 API 서비스가 예상대로 작동함을 의미합니다.

문제 해결

• 모든 REST 작업은 감사되며 로그는 시스템 로그에 기록됩니다.
• Open API와 관련된 문제를 해결하려면 Debug Log Configuration(로그 컨피그레이션 디버그) 창에서 apiservice 구성 요소의 Log Level(로그 레벨)을 DEBUG(디버그)로 설정합니다.
• ERS API와 관련된 문제를 해결하려면 Debug Log Configuration(로그 컨피그레이션 디버그) 창에서 ers 구성 요소의 Log Level(로그 레벨)을 DEBUG(디버그)로 설정합니다. 이 창을 보려면 Cisco ISE GUI로 이동하여 메뉴 아이콘을 클릭하고 Operations(운영) > Troubleshoot(문제 해결) > Debug Wizard(디버그 마법사) > Debug Log Configuration(디버그 로그 컨피그레이션)을 선택합니다.
• Download Logs(로그 다운로드) 창에서 로그를 다운로드할 수 있습니다. 이 창을 보려면 Cisco ISE GUI로 이동하여 메뉴 아이콘을 클릭하고 Operations(운영) > Troubleshoot(문제 해결) > Download Logs(로그 다운로드)를 선택합니다.
• Support Bundle(지원 번들) 탭의 Download(다운로드) 버튼을 클릭하여 지원 번들을 다운로드하거나, Debug Logs(디버그 로그) 탭에서 api-service 디버그 로그에 대한 Log File(로그 파일)을 클릭하여 api-service 디버그 로그를 다운로드하도록 선택할 수 있습니다.