使用ERS API收集ISE支持套件

简介

本文档介绍使用PostMan作为REST客户端通过ERS API触发和下载ISE支持捆绑包的流程。 

先决条件

要求

Cisco 建议您了解以下主题：

• ISE
• 外部REST风格服务
• REST的客户喜欢邮递员、REST、失眠等。

使用的组件

本文档中的信息基于以下软件版本：

• 思科ISE 3.1补丁6
• Postman REST客户端v10.17.4

本文档中的信息都是基于特定实验室环境中的设备编写的。本文档中使用的所有设备最初均采用原始（默认）配置。如果您的网络处于活动状态，请确保您了解所有命令的潜在影响。

配置

启用ERS（端口9060）

ERS API是在端口443和端口9060上运行的仅HTTPS的REST API。端口9060默认关闭，因此需要先将其打开。 如果尝试访问此端口的客户端不首先启用ERS，则会出现服务器超时。因此，第一个要求是从思科ISE管理员UI启用ERS。

导航到Administration > Settings > API Settings并启用ERS（读/写）切换按钮。

创建ERS管理员

创建思科ISE管理员，分配密码，并将用户作为ERS管理员添加到管理员组。您可以将配置的其余部分留空。

设置Postman

下载或使用在线版Postman。

1. 通过点击“工作区”(Workspaces)选项卡下的“创建工作区”(Create Workspace)创建用户和工作空间。

2.选择空白工作区，并为工作区指定名称。您可以添加描述并将其公开。 在本示例中选择了Personalis。

创建工作空间后，即可配置我们的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选项卡，并使用XML或JSON为API调用配置所需的信头，如SDK中所示。在本例中使用JSON。 报头配置必须如下所示：

9.转到 正文 标题和选择 原始.这允许我们粘贴触发支持捆绑包所需的XML或JSON模板。 

10.将XML或JSON模板粘贴到Body部分中，根据需要更改值：

XML:

http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Support Bundle Generation" name=" supportBundle"> Node hostname the SB is being collected from mm/dd/yyyy true|false true|false true|false true|false t rue|false true|false true|false mm/dd/yyyy

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”消息，结果为空。 

检查支持捆绑包状态

您可以确认通过运行一系列GET呼叫来触发或完成支持捆绑包。 

1. 在SDK上的Support Bundle Statustab下选择Get-All。您想要获取ID，以便可以运行下一个GET呼叫。  如前所述，以下是执行呼叫所需的报头以及预期的响应。

2. M转到 信头 选项卡并配置API调用所需的报头，如SDK中所示。在本例中使用JSON。报头配置必须如下所示：

3.选择GET作为方法，粘贴https://{ISE-ip}/ers/config/supportbundlestatus，然后单击Send。 如果所有内容都配置正确，您必须看到“200 OK”消息以及触发与上一个支持捆绑包相关的信息。此呼叫不会让我们知道支持捆绑包是否成功完成。从此呼叫收集ID，以便您可以在下一个GET呼叫中使用它。 

4.收集ID后，请转到SDK，在Support Bundle Status选项卡下并选择Get-By-Id。如前所述，下面列出了执行呼叫所需的标头以及预期响应。

5. M转到 信头 选项卡并配置API调用所需的报头，如SDK中所示。在本例中使用JSON。报头配置必须如下所示：

6.选择GET作为方法，粘贴https://{ISE-ip}/ers/config/supportbundlestatus/{id} 和从步骤3收集的ID，最后单击Send。 如果所有内容都配置正确，您必须看到“200 OK”消息和结果，其中显示与上次触发支持捆绑包完成与否相关的信息。请记下此调用的fileName，因为您需要PUT调用。

下载支持捆绑包

确认支持捆绑包处于完成状态后。您可以继续下载它。 

1. 在SDK上的Support Bundle Downloadtab下，选择Download SupportBundle。如前所述，以下是执行呼叫所需的报头、XML和JSON模板以及预期响应。

2. M转到 信头 选项卡并配置API调用所需的报头，如SDK中所示。在本例中使用JSON。报头配置必须如下所示：

3.转到 正文 标题和选择 原始.这允许我们粘贴下载支持捆绑包所需的XML或JSON模板。 

4. 将XML或JSON模板粘贴到Body部分中，根据需要更改值。文件名将是从第6步收集的文件名(ise-support-bundle-pk-ise3-1test-external-09-26-2023-01-26.tar.gpg):

XML

http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com"> Support bundle file name to be picked for download

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操作都经过审核，并且日志记录在系统日志中。
• 要排除与开放式API相关的问题，请在调试日志配置窗口中将apiservice组件的日志级别设置为DEBUG。
• 要排除与ERS API相关的问题，请在Debug Log Configuration窗口中将ers组件的Log Level设置为DEBUG。要查看此窗口，导航到Cisco ISE GUI，点击菜单图标并选择操作>故障排除>调试向导>调试日志配置。
• 您可以从Download Logs（下载日志）窗口下载日志。要查看此窗口，导航到Cisco ISE GUI，点击菜单图标并选择操作>故障排除>下载日志。
• 您可以选择从Support Bundle选项卡下载支持捆绑包，方法是单击该选项卡下的Download按钮，或通过单击api-service debug log日志的Log File值，从Debug Logs选项卡下载api-service debug logs。