BPA用户指南v5.1
- 简介
- 入门指南
- 传统和门户UI权限
- 资产组
- 资产经理
- 管理员配置
- BPA应用
- BPA传统用户界面门户
- 系统配置
- 使用业务应用程序
- 故障排除
- BPA使用案例
简介
关于业务流程自动化
业务流程自动化 (BPA) 是由客户体验 (CX) 团队打造的多域网络自动化和协调解决方案，可与思科和第三方的各种域控制器配合使用。BPA包括：
- 用于端到端服务集成的跨域协调
- 结合了网络和防火墙自动化和流程自动化，例如IT服务管理(ITSM)变更管理、外部集成(例如库存、IP地址管理(IPAM)等)以及人工干预
- 与控制器进行南向集成，例如思科网络服务协调器(NSO)、思科全数字化网络架构控制器和vManage
- Cisco Data Center Network Manager(DCNM)和Ansible
- 用于BPA使用案例（例如，操作系统升级、服务调配、迁移等）的容器化应用层
- 流程自动化方法的可定制流程模板
- 东 — 西集成（例如IPAM、ITSM、资产）的适配器
- 通用集成API，用于使用通过平台开发的服务和工作流程
范围
《用户指南》提供了以下信息：
本文档不包括NSO和其他下一代(YANG)模型的说明和操作详细信息，也不包括创建业务流程模型和表示法(BPMN)工作流程。
有关特定使用案例的详细信息，请参阅BPA用户指南”使用案例。
先决条件
用户应具备以下条件：
- 对计算机网络基本概念的了解
- 有关NSO、Cisco Catalyst Center、vManage等域控制器的公平知识
支持的浏览器
Cisco BPA可通过以下浏览器版本完全发挥作用：
- Chrome:135 版
- Firefox:135 版
- Safari:18.3.1 版
用户界面免责声明
本指南仅包含用于说明目的的图像。在某些情况下，本文档的图像可能无法准确反映实际的用户界面(UI)。
BPA UI已在v4.0中进行了修订。虽然一些应用程序已随v4.0框架引入，但其他v4.0之前版本的应用程序仍使用经典的v4.0之前版本的UI。
入门指南
本节提供有关应用程序访问的信息，并提供应用程序及其组件的概述。
BPA访问
访问BPA门户的步骤：
- 在浏览器中输入主机名或网络IP地址。
- 输入系统管理员分配给用户的BPA 用户名和密码。
- 单击Login。此时将显示BPA主页。
Assets应用程序启动，使用户能够查看所有域控制器管理的资产的统一列表。
左侧导航菜单
以下应用和工具可从左侧的导航菜单访问：
- 设置：包含用于管理用户、资源组、资产组和管理员的应用程序
- 应用：包含用于管理网络资产的应用程序，如操作系统(OS)升级、设备激活和服务目录
- 设计工具：包含有助于定义使用配置和工作流程的设计工具
菜单中的某些应用程序仅在传统门户中可用，并在新选项卡中打开以启动该应用程序。所有交叉启动应用程序都显示在菜单中，带有一个矩形图标和一个箭头。
切换到经典视图
用户可以通过选择BPA应用右上角的Switch-to-Classic图标直接启动传统门户。
要切换回新的登录页面，请从传统门户中选择相同的图标。
配置域控制器
BPA必须配置一个或多个域控制器来管理网络资产。BPA支持许多思科域控制器(例如，Cisco Catalyst Center、vManage、Cisco Crosswork、NSO、Cisco Nexus控制面板交换矩阵控制器(NDFC)等)，并可与第三方设备配合使用并使用控制器（例如NSO或Ansible）。
有关配置控制器的详细信息，请参阅控制器设置部分。
BPA支持基于v4.0的角色访问控制(RBAC)。在RBAC模型中，角色封装用户可以执行的一组权限（即操作）。对于访问控制，管理员可以分配预定义的角色或创建对用户组具有权限的新角色。
用户可属于一个或多个用户组，每个用户组可分配一个或多个角色。角色为该组中的用户分配特定访问权限。
用户管理
本节介绍使用本地身份验证方法管理用户。其他方法需要外部身份验证提供程序(例如Active Directory(AD)、开放轻量级目录访问协议(LDAP)、终端访问控制器访问控制系统(TACACS)等)，并且不在本文档的讨论范围内。本地身份验证使用BPA的内部身份验证服务，默认情况下可用。用户访问通过用户管理应用程序将用户添加到BPA来管理。
用户登录前，必须使用以下身份验证提供程序之一配置BPA。
- 本地身份验证（默认）
- LDAP/AD
- TACACS
添加用户
在BPA门户中添加用户的步骤：
- 选择Settings > User Management > Users。系统随即会显示“用户”页面，其中包含当前用户的列表。
- 单击Add User。New User窗口打开。
- 填写必填字段。
- 或者，为该用户选择一个或多个用户组的复选框。用户组选择定义用户可执行的操作集（基于分配给组的角色）。
- 单击Submit以创建用户。用户将添加到BPA门户。
编辑用户
- 从用户页面，选择所需用户的操作列中的更多选项图标> 编辑。Edit User窗口打开。
- 进行所需的更改，然后单击Submit。
删除用户
要删除用户，请执行以下操作：
- 在用户页面中，从所需用户的操作列中选择更多选项图标> 删除。确认窗口即会打开。
- 单击删除。
用户角色和角色管理
BPA v4.0平台现在支持具有用户角色的RBAC。角色定义允许用户执行的权限集（即，操作）。
可用角色
| 角色 | 描述 |
|---|---|
| 超级管理员 | 具有访问整个系统的管理员角色 |
| 用例管理员 | 管理应用程序和关联权限的角色 |
| 网络操作员 | 使用BPA应用管理其网络的角色 |
| 只读 | 对BPA具有只读访问权限的角色 |
虽然BPA提供一些开箱即用的角色，但管理员可以创建其他角色。要管理角色，请从左侧导航菜单中选择设置 > 用户管理 > 角色。系统随即会显示Roles页面，其中包含角色列表。
添加新角色
在BPA门户中添加新角色的步骤：
- 在Roles页面中，单击Add Role。Create Role窗口打开。
- 输入角色名称和说明。
- 选中适用于角色的用户组的复选框。
- 选中此角色可以执行的一个或多个权限的复选框。
- 单击 submit。
编辑角色
在BPA门户中编辑角色的步骤：
- 从角色页面，从所需角色的操作列中选择更多选项图标> 编辑。Edit Role窗口打开。
- 修订所需数据。
- 单击 submit。
删除角色
要删除角色，请执行以下操作：
- 从角色页面，从所需角色的操作列中选择更多选项图标> 删除。系统将显示确认窗口。
- 单击删除。
导出角色
在BPA门户中导出一个或多个角色：
- 在角色页面中，选择要导出的角色。
- 选择更多选项图标> 导出角色。将打开导出角色窗口，并显示选择用于导出的角色。
- 单击Export。下载一个JSON文件。
导入角色
要在BPA门户中导入角色，请执行以下操作：
- 选择更多选项图标> 导入角色。导入角色窗口打开。
- 单击导入文件，然后选择要导入的文件。文件中的所有角色都将被加载并显示。
- 单击 Import。系统将导入角色及其权限，并显示最终确认。
传统和门户UI权限
使用案例1
管理员可以授予传统和门户UI的权限。
提供权限后，非管理员用户登录时将启用Switch to Classic图标。
还启用切换到门户图标以从传统UI导航到门户UI。
使用案例2
管理员可以仅授予切换到门户UI的权限。
仅提供门户UI的权限后，对于非管理用户，登录时将禁用切换到经典图标。
使用案例3
管理员只能授予切换到传统UI的权限。
仅提供传统UI的权限后，登录页面重定向到传统UI，非管理员用户登录时不会看到切换到门户图标。
使用案例4
管理员可以拒绝传统和门户UI权限。
拒绝传统和门户UI权限后，非管理用户无法使用传统或门户UI登录。
用户组
BPA用户组能够根据用户提供的功能将用户分为不同的组。每个用户组都与定义组中用户可以或不可以执行的操作的角色相关联。
BPA提供多个开箱即用的用户组。BPA管理员还可以创建和管理其他用户组。
| 用户组 | 角色 |
|---|---|
| 管理员 | 超级管理员 |
| 操作员 | 网络操作员 |
以下示例显示与两个角色关联的用户组。防火墙用户角色为该用户组中的用户提供对防火墙访问控制列表(ACL)的只读访问权限。 负载均衡器管理器角色提供完全编辑访问权限。
要访问User Groups Management应用程序，请从左侧导航菜单中选择Settings > User Management > User Groups。系统随即会显示Groups页面，其中显示组列表。
创建用户组
- 在Groups页面中，单击Add Group。Add Group窗口打开。
- 输入Group Name和Description。
- 单击 submit。
编辑用户组
- 从组页面，从所需组的操作列中选择更多选项图标> 编辑。将打开Edit Group窗口。
- 进行所需的更改。
- 单击 submit。
删除用户组
- 从组页面，从所需组的操作列中选择更多选项图标> 删除。系统随即会显示确认。
- 单击Confirm。
访问策略
访问策略通过限制用户的可访问资源提供严格的访问控制。
当角色定义用户可执行的一组操作（即权限）时，访问策略会进一步限制可对其执行这些操作的资源。
访问策略定义为用户组，并且可将用户访问限制为资产组、资源组或两者的组合。
- 资产组:网络资产分组（静态或动态）
- 资源组:金牌配置模板(GCT)、流程模板等BPA对象分组。
例如，假设为Software Image Management(SWIM)Users用户组（允许用户更新设备上的软件）和US-West Assets组（属于US West地区的资产）定义的新访问策略将组内的用户限制为仅对US-West Assets中的设备进行升级。下图显示了用户组、访问策略、资产和资源组如何组合在一起。
要管理访问策略，请从左侧导航菜单中选择设置 > 用户管理 > 访问策略。系统随即会显示Policies页面，其中包含策略列表。
创建访问策略
- 在Policies页面中，单击Add Policy。将打开Add Policy窗口。
- 输入Policy名称和Description。
- 选择适用的Resource Groups、Asset Groups和User Groups复选框。
- 单击 submit。
编辑访问策略
- 在Policies页面中，从所需策略的Action列中选择More Options图标> Edit。
- 修订所需数据。
- 单击 submit。
删除策略
要删除策略，请执行以下操作：
- 从Policies页面，从所需策略的Action列中选择More Options图标> Delete。确认窗口即会打开。
- 单击删除。
资产组
BPA中的资产（即设备）可以通过“资产组”功能进行分组。如果适用，BPA应用程序会显示Asset Group字段，使用户能够快速选择所需的资产或执行组级别的操作。管理员还可以通过定义访问策略来限制对资产的访问。
要访问资产组，请执行以下操作：
选择设置 > 资产组。系统将显示Asset Groups页面。
BPA包括三种类型的资产组：静态、动态和已发现。
静态资产组
静态资产组由BPA用户创建和管理。BPA发现的任何设备（从域控制器）都可以添加到静态资产组。这些资产组仅在BPA中可用，不会传播到域控制器。
创建静态资产组
- 在“资产组”页面，单击添加资产组。将打开“创建资产组”窗口。
- 输入Group Name并选择Static选项。
- 从列表中选择设备。
- 如有必要，请使用资产选择标准部分中的字段搜索资产。
- 选中所需资源的复选框。
- Click Save.
编辑静态资产组
- 从资产组页面，从所需资产组的操作列中选择更多选项图标> 编辑。Edit Asset Group窗口打开。
- 选中或清除所需资源的复选框。
- Click Save.
删除静态资产组
- 从资产组页面，从所需资产组的操作列中选择更多选项图标> 删除。确认窗口即会打开。
- 单击Confirm。
动态资产组
动态资产组根据一个或多个资产选择标准进行定义。选择标准可以基于设备元数据，例如名称、型号、控制器等。BPA通过查询符合选择标准的资产来确定运行时哪些资产属于资产组。
创建动态资产组
- 在“资产组”页面，单击添加资产组。将打开“创建资产组”窗口。
- 输入Group Name并将Asset Group Type字段设置为“Dynamic”。默认情况下，用户授权的所有资产都会添加到组中。
- 使用资产选择标准部分中的选择标准来优化资产列表。输入数据后，资产列表将被修改，以包括和排除符合条件的资产。
- Click Save.
编辑动态静态资产组
- 从资产组页面，从所需资产组的操作列中选择更多选项图标> 编辑。Edit Asset Group窗口打开。
- 根据需要更改资产选择条件，以向资产组添加或删除资产。
- Click Save.
删除动态资产组
- 从资产组页面，从所需资产组的操作列中选择更多选项图标> 删除。
- 单击删除。
发现的资产组
发现的资产组是由域控制器管理并由BPA发现的资产组。这些资产组通常使用Web门户等域控制器工具创建。无法使用BPA门户修改这些资产组。当授权用户选择同步控制器状态时，BPA会发现这些资产组。
资产经理
Asset Manager应用程序显示BPA管理的所有资产的合并视图。BPA维护从系统中配置的各种域控制器收集的资产的缓存。Asset Manager还允许用户在设备上执行某些操作。
要访问Asset Manager，请执行以下操作：
- 登录BPA。
- 选择应用图标 > 资产。
Asset Manager页面分为资产过滤器和可以通过BPA管理的资产列表。要查看特定控制器资产，请选择所需的控制器类型过滤器。对于特定资产，请选择控制器ID过滤器
资产过滤器
Asset Manager的此部分显示显示的资产计数以及资产选择的过滤器列表。
资产计数显示向用户显示的资产总数，但不反映BPA管理的资产的实际数量。显示的资产总数取决于用户可见的资产数量（基于配置的访问策略）和所选过滤器。
BPA提供以下过滤器：
- 域名：按网络域过滤(例如，核心、数据中心、软件定义的广域网(SD-WAN)等)
- 控制器类型：按控制器类型过滤（例如，NSO、DCNM、vManage等）
- 控制器：按控制器实例筛选
- 资产组:按资产组筛选
BPA还提供使用Search字段中的搜索条件过滤资产列表的功能。
所选过滤器显示在资产列表上方。要删除单个过滤器，请选择所需过滤器上的Remove图标，或单击Clear All删除所有过滤器。如果过滤器的可用值超过10个，则每个类别下的过滤器面板中都会有一个搜索字段。
- 资产控制面板中提供了过滤器
- 控制器类型按特定控制器类型筛选数据
- 控制器ID按特定控制器类型过滤数据
- 资产组按特定资产组过滤数据按资产组过滤数据
资产列表
Asset Manager的底部显示用户的合并资产列表。
设备操作
在资产列表视图中，用户可以执行各种设备操作（例如，设备操作），例如Ping、查看配置、连接等。访问某些操作（尤其是更改设备状态的操作）受访问控制。无法执行特定操作的用户应联系BPA管理员。
在设备上运行操作有两种方法：
- 一次一个设备:选择所需设备旁边的More Options图标。系统将显示一个包含可用操作的下拉列表。
- 多台设备:此方法允许用户在多个设备上执行所需的操作。选中所需设备的复选框，然后点击更多选项图标> 设备操作。
ping
Ping用于故障排除、测试设备连通性和确定响应时间。
连接
Connect用于建立与所选设备的连接并返回连接状态。
获取主机密钥
获取主机密钥操作指示NSO控制器从所选设备检索主机密钥信息并将其存储在本地数据库中。
检查同步
Check Sync（检查同步）操作检查NSO配置数据库(CDB)中的设备配置是否与设备配置同步。
比较配置
比较配置操作将NSO CDB中的配置与所选设备上的运行配置进行比较。从列表中选择设备，然后选择Device Actions > Compare Config。
查看配置
View Config（查看配置）显示一个或多个所选设备的配置。要选择列表中的多个设备，请在View Config（查看配置）窗口中单击设备名称。
同步源
Sync From操作将NSO CDB中的配置状态与设备的运行配置同步。这也适用于Cisco Crosswork网络控制器(CNC)控制器。
同步到
Sync To操作将NSO CDB中存储的配置与运行该配置的设备同步。如果发现任何差异，则会更新设备配置以匹配CDB中的状态。
交互式CLI
交互式命令行界面(CLI)用于用户输入，尤其是用于命令（例如，device show）和配置由直接对设备管理的设备。用户可以轻松执行命令、访问设备信息和应用实时配置更改，从而获得无缝的交互式体验。
要访问直接到设备的交互式CLI功能：
- 在Assets页面上，在Managed By列中搜索具有Direct-to-Device的设备。
- 从可用选项中选择设备。
- 从所需设备的操作列中选择更多选项图标> Interactive CLI。系统将显示Interactive CLI面板。
- 输入用户名和密码。
- 输入show或config命令，然后单击execute。系统随即会显示进度通知。
- 选择Refresh图标以更新命令执行状态。执行完成后，按钮状态将更改为“已完成”。
- 单击命令旁边的箭头查看命令输出。
- 选择Download图标将输出响应保存为文本文件。响应中的任何敏感数据都将被屏蔽以保护隐私。如果命令执行时间过长，用户可以关闭交互式窗口。执行完成时收到用户通知。
- 选择View Output of Long-Running Tasks图标以查看特定设备执行命令输出。将会打开一个窗口，显示命令输出可用（但用户尚未查看）的设备列表。
- 选择Device图标可访问已执行的设备命令的详细信息。
- 或者，执行配置命令以更新设备配置，如下所示：
- 或者，根据使用案例需要修改环境变量“EXPIRES_INTERACTIVE_CLI”，以调整设备命令响应的保留期（默认情况下保留24小时，然后自动删除）。这样就可以创建用户友好且高效的界面来使用交互式CLI，从而无缝执行命令并轻松访问其输出。
同步资产
已将同步清单功能添加到所有控制器代理。这样可以灵活地从控制器和设备获取最新信息，如序列号、软件一致性型号和所选设备列表的软件版本。这允许使用案例使用此轻量级功能，而不是执行完整的控制器设备同步。
发现设备
Discover Device（发现设备）功能可识别相邻设备，该功能与使用思科发现协议(CDP)的Cisco Internetworking Operating System(IOS)环境等场景相关。只有可以从BPA服务器成功ping通并通过相同凭证访问的设备才会显示在已发现设备的结果中。用户可以通过查看弹出窗口中显示的详细信息以及载入这些发现的设备，来了解所发现的设备的详细信息。目前，只有思科系列设备支持此功能。
要执行Discover Device操作：
- 从Asset Manager的可用选项中选择设备。
- 在Assets页面中，从所需设备的Action列中选择More Options图标> Discover Device。
生成已发现设备的列表，显示可以从BPA服务器ping的设备。列出的每个设备都提供相关信息，如设备ID、IP地址、平台和版本。
- 选择一个或多个设备，然后单击ADD DEVICE TO INVENTORY。
备份配置
用户可以在备份配置设备操作中触发按需备份。通过完成以下步骤访问备份配置：
- 选择一个或多个设备，然后选择更多选项图标> 备份配置。将打开Backup Configuration窗口，其中列出了所有选定的设备。
- 选择策略，为备份进程分配自定义标签，并对所选设备进行备份。一次可以选择多个设备。
- 单击 submit。现在可以启动通过Asset Manager应用程序的备份过程。
查看备份
view backups device（查看备份设备）操作显示所执行备份的历史记录。选择More Options图标> View Backups以查看所选设备的备份历史记录。详细信息面板在备份选项卡下打开，其中显示可用的备份历史记录。
在备份选项卡中，可用的备份历史记录显示其各自的详细信息。用户可以在每个备份历史记录中执行以下操作：
| 备份历史记录操作 | 描述 |
|---|---|
| 查看备份配置 | 查看在所选备份日期可用的备份配置 |
| 与当前配置比较 | 将备份配置与运行配置或设备当前配置进行比较 |
查看备份配置
在此部分下，用户可以查看选定日期的备份配置。
要访问它，请选择More Options图标> View Backup Config。此时将打开一个窗口，用户可以在其中查看备份配置。
Backup Configuration窗口中提供以下选项：
| 备份配置操作 | 描述 |
|---|---|
| 复制 | 将备份配置复制到剪贴板。 |
| 下载 | 下载文本格式的备份配置 |
| 恢复 | 启动还原备份配置操作 |
与当前配置比较
在此部分下，将备份配置与设备的当前运行配置进行比较。
Compare with Current Config窗口具有以下选项：
| 与当前配置操作比较 | 描述 |
|---|---|
| 恢复 | 启动还原备份配置操作。 |
恢复备份设备配置
单击Restore启动还原备份配置过程。分配的还原工作流程（在备份还原策略中提及）将启动还原流程，用户将被重定向到配置还原页面。
其他操作
BPA通过更多选项图标提供额外的资产管理操作，包括导出资产列表、添加、更新或删除资产以及资产列表列自定义。
导出CSV
导出CSV选项以逗号分隔值(CSV)格式导出资产。默认情况下，操作导出当前页面中的资产。
要导出所有资产，请点击全选复选框，然后执行导出操作。
添加资产已完成
Add Assets操作可将资产添加到域控制器。
- 选择Asset Manager底部的More Options图标。
- 选择Add Assets以打开以下选项：
- 手动选项
- 上载选项
手动选项
Manual选项允许用户通过手动输入设备数据来添加设备。
- 从子菜单中，单击Manual。将打开Add Asset页面，用户在其中选择设备将添加到的控制器。
- 从下拉列表中选择控制器的类型（例如NSO）以及该控制器类型的实例。选择Controller Instance后，会打开另一个窗口，用户可以在其中输入设备详细信息。
- 输入所需数据，然后单击Save以添加设备。
上载选项
Upload选项允许用户通过上传文件添加一个或多个设备。目前，仅支持CSV文件格式。
- 选择更多选项图标> 添加资产 > 上传 > CSV。系统将显示新的Add Asset页面，用户可以在该页面选择设备添加到的控制器。
- 选择控制器的类型（例如NSO）和该控制器类型的实例。
- 拖放CSV文件。
- 单击Save将设备从CSV文件添加到控制器。
更新资产
此操作允许用户更新资产信息，例如IP地址、说明、端口号等。可从选择或CSV更新设备。
从选择
通过选择，用户可以编辑一个或多个所选设备。
- 从资源列表中选择一个或多个要编辑的设备，然后选择更多选项图标> 更新资源 > 从选择。系统随即会显示Update Asset Information页面，其中包含所选设备。
- 根据需要更改设备属性，然后单击Update以更新控制器中的设备信息。
从CSV
此选项允许用户通过上传文件来更新一个或多个设备。
- 选择More Options图标> Update Assets > From CSV。系统随即会显示更新资产信息页面。
- 使用拖放功能上传包含要更新的设备列表的CSV文件。
- 单击Save将设备从CSV文件添加到控制器。
删除资产
此操作允许用户从域控制器删除资产。可从“选择”或CSV中删除资产。
从选择
通过选择，用户可以从域控制器中删除一个或多个所选设备。
- 从资源列表中选择一个或多个要编辑的设备，然后选择更多选项图标> 删除资源 > 从选择。系统随即会显示Remove Assets页面，其中包含所选设备。
- 单击Remove以删除资产。
从CSV
通过CSV，用户可以通过上传文件来更新一个或多个设备。目前，仅支持CSV文件格式。
- 选择More Options图标> Remove Assets > From CSV。系统随即会显示删除资产页面。
- 使用拖放功能上传包含要删除的设备列表的CSV文件。
- 单击Save从控制器中删除设备。
显示/隐藏列
可以更改“资产列表”视图以显示其他字段。Edit Column窗口打开。
- 选择更多选项图标> 显示/隐藏列。
- 通过选中或清除复选框添加或删除所需列。
- 单击 Apply。
SCP到设备
安全复制协议(SCP)到设备帮助通过API调用将数据从本地用户的计算机传输到远程网络设备。目前，cisco-ios、cisco-iosxr、cisco-asa、NX-OS、arista-eos和juniper-junos设备操作系统类型支持此功能。
要执行SCP到设备，请执行以下操作：
- 在Postman应用程序中创建新请求，然后选择POST作为请求类型。或者，也可以从用例工作流程或自定义微服务创建相同的API调用。
- 输入如下所述的SCP到设备的URL，并根据设备类型更新BPA服务器IP地址和文件名。
基于设备类型的示例目录名称和文件名：
- Cisco-ios:flash:/sample_file.txt
- Cisco-iosxr:flash:/sample_file.txt
- Cisco-asa:bootflash:/sample_file.txt
- Arista-eos:/mnt/flash/sample_file.txt
- Juniper-junos:/var/tmp/sample_file.txt
- 选择raw > text，然后将所需文件的内容以文本格式输入到正文部分中。
- 单击Send，等待响应显示在Postman的响应区域中，状态代码为200。
| 请求类型 | POST |
|---|---|
| URL | https://d2d-agent-service:5010/api/v1.0/d2d-controller-agent/device-manager/scp?capabilityName=scp-to-device&controllerId=Direct-To-Device&deviceIdentifier=ios_device_d2d&fileName=<file_name> |
| 示例正文 | 要复制到设备的文件内容 |
| 响应示例 | { "消息":"文件已成功复制到flash:/scp_to_and_from_device_file.txt", "状态":“成功” } |
SCP源设备
SCP-from-device帮助通过API调用将数据从远程网络设备传输到用户的本地计算机。目前cisco-ios、cisco-iosxr、cisco-asa、arista-eos和juniper-junos设备os-type支持此功能。
要从设备执行SCP，请执行以下操作：
- 在Postman中创建新请求并选择GET作为请求类型。或者，也可从“使用案例”(Use Case)工作流程或自定义微服务创建相同的API调用。
- 输入如下所述的SCP-From-Device的URL，并根据设备类型更新BPA服务器IP地址和文件名。
基于设备类型的示例目录名称和文件名：
- Cisco-ios:flash:/sample_file.txt
- Cisco-iosxr:flash:/sample_file.txt
- Cisco-asa:flash:/sample_file.txt
- Arista-eos:/mnt/flash:/sample_file.txt
- Juniper-junos:/bin/flash:/sample_file.txt
- 单击Send，等待响应在Postman的响应区显示，状态代码为200。
| 请求类型 | GET |
|---|---|
| URL | https://d2d-agent-service:5010/api/v1.0/d2d-controller-agent/device-manager/scp?capabilityName=scp-from-device&controllerId=Direct-To-Device&deviceIdentifier=ios_device_d2d&fileName=flash:/ |
| 响应示例 | 要从设备复制的文件内容 |
管理NDFC设备
本节提供有关管理Cisco NDFC设备的信息。
添加资产
要添加资产，请执行以下操作：
- 从所需资产的操作列中单击更多选项图标> 添加资产 > 手动。
- 在“添加资产”窗口中输入详细信息，然后单击保存。
删除资产
- 在Assets页面上，选择要删除的资产，然后选择More Options图标> Remove Assets > From Selection。Remove Assets for NDFC窗口打开。
- 单击删除。
批量上传
- 在“资产”页面上，选择更多选项> 添加资产> 上传> CSV。Add Asset窗口打开。
- 选择控制器类型和控制器实例。
- 使用拖放功能从CSV文件添加资产。
- Click Save.
管理vManage设备
管理vManage设备涉及通过批量上传流程将设备组织为逻辑组。在此过程中，标签在vManage控制器上创建，从而有效地对设备进行分类。然后，标签会与BPA系统同步，并在系统中转换为资产组。该方法能够更有效地管理和操作特定设备组，提高自动化程度并提高操作效率。通过确保vManage和BPA之间的无缝同步，该系统可简化工作流程并改善设备管理实践。
要完成批量上传过程，请执行以下操作：
- 通过编译要上传的设备列表来准备设备数据，确保所有必要信息（例如，设备名称、IP地址和任何其他必需属性）都以结构化格式（例如.CSV文件）包含。
- 登录到vManage控制器接口以访问VManage控制器。
- 导航到Bulk Upload部分。
- 选择上传选项并选择准备的.CSV文件上传设备文件。
- 将标签分配给每台设备，以便在上传过程中进行分组。
- 确认详细信息并启动批量上传流程，为vManage控制器上的每台设备创建条目。
- 上传完成后，验证所有设备在vManage系统中正确组织和标记。
- 确保vManage控制器将新创建的标记与BPA系统同步，将其转换为资产组以进行进一步管理。
- 访问BPA系统查看资产组，确保所有设备正确分类以便管理。
- 持续监控设备组，根据需要调整标签或分组以保持运营效率。
vManage中的设备与标记相关联，并自动与BPA系统同步，在该系统中这些设备会被转换为资产组。这允许根据分配的标记，将每个设备逻辑分组到BPA中，从而实现高效管理和RBAC。
管理员配置
系统管理员可以使用Admin菜单配置和管理BPA应用。
Admin菜单包括：
- 用户:创建和管理用户，并将其分配到用户组
- 组:管理用户组和组权限
- 区域:管理BPA系统中的配置域
- 网络拓扑模板:管理用于创建网络拓扑的流程模板
- 设置：使用设置配置控制器（例如NSO）、简单邮件传输协议(SMTP)、密码设置、票证系统以及添加自定义设置
- 同步用户:从LDAP服务器同步用户（在配置LDAP集成时启用）
- 同步组:从LDAP服务器同步用户组（在配置LDAP集成时启用）
- 标记管理:管理用于标记BPA对象的标记
- 控制器数据同步:同步来自控制器的服务架构、配置模板和其他信息
- 服务目录:管理服务类别并注册新服务
- 适配器生成器：创建和管理适配器，以便与外部系统集成
- Ansible设置:将服务从NSO服务器同步到BPA系统
- 事件处理程序:配置用于处理发送到BPA的事件的规则
- 备份和恢复:配置备份和恢复策略以及集成插件和目标
- 计划程序：管理作业计划
有关详细信息，请参阅系统配置。
BPA应用
BPA提供下列应用：
- 服务中心
- 表单生成器
- 设备管理器
- 操作系统升级
- 流程模板
- GCT
- 配置验证程序
- 工作流程
- 服务拓扑
- 网络拓扑
- 市场差异
- 设备激活
- 服务目录
- 提交管理器
- 脚本运行者
- Ansible模板
- 操作系统升级
- 配置合规性和补救
- 计划程序服务
服务中心
Service Center应用程序允许用户创建和管理服务实例。添加服务实例时屏幕上显示的参数取决于与其关联的YANG模型。用户可以为服务创建多个实例。
有关详细信息，请参阅BPA用户指南服务中心应用。
表单生成器
Form Builder应用程序允许用户根据服务模板的YANG模型设计自定义输入表单。这些表单随后可在工作流程中使用，以呈现用于用户输入或审批的UI屏幕。
有关详细信息，请参阅使用Form Builder应用程序。
设备管理器
Device Manager应用程序允许用户管理设备。设备可以分组到设备组中，这样可以轻松管理分组设备的服务。它还允许用户创建和管理包含用于访问设备的身份验证信息的授权组。每个设备都与一个授权组关联。可以有多个用户与每个授权组关联，这样用户就可以访问与该授权组关联的设备。
有关详细信息，请参阅使用设备管理器应用。
操作系统升级传统
OS升级应用程序显示活动、已完成和挂起OS升级工作流程实例的状态。它显示升级结果，并提供成功升级的设备数量等统计信息。用户可以检查为工作流实例设置的升级设备的数量。如果升级未完成，则表示当前工作流程中的关联步骤以及该步骤的验证结果。用户可以查看针对升级执行的每次验证、预检查和后检查的命令输出。
有关详细信息，请参阅使用操作系统升级应用程序。
流程模板
Process Template应用程序允许用户管理模板，这些模板包括一组针对设备执行的命令和针对命令执行结果运行的关联验证规则。根据规则评估命令结果，以确定结果应被视为通过还是失败。例如，在操作系统升级期间，必须查看升级前后的配置状态。此外，还必须确定必备条件是否符合已定义的升级标准。可以使用基于脚本的方法执行自定义分析。
在调配服务时，用户可以使用工作流程中的模板执行以下任务：
- 配置验证
- 预检查（调配服务之前）
- 后期检查（调配服务后）
- 操作系统升级命令
模板还用于从设备检索网络和服务拓扑数据。
有关详细信息，请参阅BPA用户指南流程模板应用。
金牌配置模板
GCT是预定义的配置，用于在设备上保持一致的配置。优点是：
- 创建、编辑和管理可应用于一个或多个设备的通用配置模板
- 对模板进行参数化，以将其重新用于相同或不同市场中的设备
- 确保设备之间的配置一致性
- 管理GCT版本
- 根据GCT检查设备的合规性
在构建模板之前，请考虑规划网络设计并根据该设计创建模板。通过使用GCT，可以提高运营效率，减少配置错误，并改善合规性标准和最佳实践。
有关详细信息，请参阅BPA用户指南黄金配置模板应用。
配置验证程序
Config Validator应用程序用于根据网络元件驱动程序(NED)验证一组配置命令。 用户可以输入配置命令，config validator将指示配置命令集是否有效。这样可以确保用户始终在需要时使用有效的配置命令。在以下情况下，用户可以使用配置验证程序检查配置命令集的有效性：
- 有新的NED可用
- 现有NED的新版本可用
- 确保特定版本的NED支持您正在使用的配置命令
有关详细信息，请参阅使用配置验证程序应用。
工作流程
工作流程允许用户自动执行在对基础设施进行更改之前或之后实施的业务和技术流程。一些示例包括事前/事后检查、批准、与故障单系统或ITSM工具的集成。工作流程通常包括一系列任务（即，步骤），用于自动化流程，以及逻辑决策（例如，继续操作或中止）、调度计时器、需要最终用户响应的手动任务以及与其他OSS/BSS系统的集成。
BPA嵌入了一个基于标准的开源工作流引擎。工作流引擎完全集成到BPA中，使用户能够直接从BPA门户部署和管理工作流。用户可以启动工作流、停止或暂停工作流。工作流程执行的状态可以在BPA中看到，其中包含已执行任务的历史记录。对于故障排除，BPA还包括工作流调试视图，允许操作查看执行状态和检查工作流状态。
有关文件内容结构的详细信息，请参阅http://www.bpmn.org/。
用户可以使用BPA工作流编辑器或使用外部符合BPMN v2.0的建模工具（如Camunda modeler）定义工作流。工作流应用程序允许执行以下操作：
- 运行实例、未完成的用户任务和任何未解决问题（即事故）的概述
- 查看分配给用户/组的任务列表（即，用户任务）
- 编辑工作流程
- 查看工作流BPMN图
- 启动工作流（即工作流实例）
- 查看正在运行的工作流程
- 下载中的工作流实例。bpmn格式
- 上传决策模型和表示法(DMN)规则
- 查看DMN产品需求文档图表和表
- 在工作流编辑模式下拖放现有进程定义和DMN规则
- 创建DMN
- 编辑DMN
- 评估DMN
有关详细信息，请参阅使用工作流应用。
使用拓扑应用程序
Topology应用程序允许用户从两个不同的角度查看拓扑详细信息。
服务拓扑
服务拓扑应用允许用户查看服务实例和设备，服务在图表中部署在这些设备上。此图形有助于直观显示服务和关联设备的连接方式。选择服务及其实例，并查看网络中与这些服务实例关联的设备。用户可快速了解设备详细信息、设备在网络中的位置和配置。
网络拓扑
网络拓扑应用允许用户查看设备网络的图形表示。它允许用户根据名称、设备组或设备类型过滤设备。用户可以在拓扑图中查看每台设备的配置命令。用户还可以预览设备详细信息，例如协议、IP地址、端口、授权组、终端ID、管理状态和设备类型。这根据首选项提供网络中设备的概述，并有助于采取与放置新设备或修改现有设备配置相关的进一步措施。
有关详细信息，请参阅使用拓扑。
市场差异
市场差异是预定义的数据集，可针对一个地区或市场进行自定义，并可在BPA平台上使用（例如，NTP服务器设置、日志服务器设置等）。 可以存储特定于地区、市场和设备类型的值。参数化的值可在GCT、服务调配和工作流程中使用。
有关详细信息，请参阅使用市场差异。
设备激活
设备激活应用通过简单网络管理协议(SNMP)或DHCP通知为设备启用零接触调配(ZTP)。ZTP的设备详细信息（包括序列号）可以通过设备激活应用程序登录。在SNMP/DHCP事件上，设备激活工作流程会被触发以加入设备。该应用利用市场/全球差异、GCT模板以及设备激活工作流程中的前/后差异等功能。
有关详细信息，请参阅BPA用户指南设备激活。
服务目录
Service Catalog（服务目录）应用程序提供入职服务、订购服务和审核服务状态的统一视图。此应用程序允许用户对服务进行分类、标记、搜索和收藏夹。订单进度可视为里程碑。管理员用户可以管理服务项目、类别和标记。
有关详细信息，请参阅BPA用户指南服务目录。
提交管理器
Commit Manager应用程序支持：
- 使用NSO提交队列
- 禁用或启用全局提交队列
- 查看提交队列项目用于锁定、解锁、修剪、删除等提交队列项目的NSO功能
- 将服务回滚到上一个服务
有关详细信息，请参阅使用提交管理器。
脚本运行者
Script Runner应用程序用于运行Ansible或Python脚本。唯一键用于使每个脚本唯一。用户可以添加、执行、查看、编辑、删除和下载脚本，并可根据开始日期检查已执行脚本的状态（例如，正在运行、暂挂、已完成或全部）。
有关详细信息，请参阅使用脚本运行程序应用程序。
Ansible模板
Ansible Template应用程序使用现有的BPA Ansible控制器处理Ansible Tower。此应用与NSO控制器的现有应用类似（例如，服务目录）。 模板使用基础攻略在BPA中使用控制器和Ansible Agent在Ansible Tower基础设施上执行服务任务。
配置合规性和补救
配置合规性和补救(CnR)应用使网络运营商可以使用用户定义的策略运行设备配置合规性。策略包含配置块，这些配置块可以由系统手动创建，也可以由系统从选定的设备配置中自动生成。用户可以针对块创建规则。规则可以具有从引用数据管理(RefD)应用程序获取的值。可以计划或按需运行合规性作业。该应用程序提供控制面板以查看违规摘要以及设备和块级别的详细信息。
操作员可以使用修正框架修正合规性违规。此框架使用工作流程、配置模板（例如GCT）和流程模板。补救作业可以计划或按需运行。
有关详细信息，请参阅BPA用户指南配置合规性和补救。
调度程序
“日程安排程序”应用程序是一种常用服务，它允许其他使用案例和交付团队安排任意任务。计划可以是一次，也可以是定期的。该调度通过接收应用所使用的Kafka消息触发并通知最终用户。
有关详细信息，请参阅使用计划程序部分。
操作系统升级
OS升级框架是一个跨域、跨控制器且全面的解决方案，构建在BPA v4.0平台之上，用于软件升级。它支持多个控制器，从本版本中对Cisco Catalyst Center、vManage和NSO的支持开始，然后进行扩展，以在后续版本中包含其他控制器。
有关详细信息，请参阅BPA用户指南OS升级。
CI/CD-CT
持续集成、持续交付 — 持续测试(CI/CD-CT)是支持创建和执行功能有限的使用案例管道的最小可行产品解决方案。
说明和主要功能
BPA控制面板为以下CI/CD-CT管道服务提供统一的可视性：
| 服务 | 描述 |
|---|---|
| NFV | 通过相关的预检查和后检查支持端到端虚拟网络功能(VNF)协调。NFV管道集成包括： - GitHub，用于对象，如.sol文件和Day0配置 - CXTM执行预检查和后检查测试案例 — 用于运行漏洞检查的安全扫描工具 — 用于上传物品以供在不同环境中查看/使用的JFrog Artictory - NFV MANO堆栈执行此管道并协调VNF实例 |
| 金牌配置模板(GCT) | 通过使用BPA GCT应用支持将特定配置应用到设备。GCT管道集成包括： - GitHub，用于配置等工件 - CXTM执行预检查和后检查测试案例 — 用于运行漏洞检查的安全扫描工具 - JFrog Artifactory，上传成功执行的对象以供审阅或在不同环境中使用 |
| 外部Jenkins管道 | 外部Jenkins管道允许用户与外部运行的Jenkins管道集成，并通过统一的BPA控制面板监控和操作这些管道。 |
主要好处
- BPA提供包含所有管道创建和执行的统一控制面板。
- CI/CD-CT管线允许用户为开发阶段创建管线，并自动提升到预生产和生产环境。
- 管道与GitHub机器人集成。当GitHub中的对象更改时，会自动触发管道执行。
支持的控制器和平台
| 域 | BPA | 控制器 |
|---|---|---|
| 通用 | 版本 4.0.2 | NSO |
有关详细信息，请参阅BPA用户指南CI/CD-CT。
备份和恢复
备份和还原框架是一个跨域、跨控制器且全面的解决方案，构建在BPA v4.0平台之上，用于从设备或向设备备份和还原设备配置。该框架实施了一种基于代理能力的方法，用于从设备获取配置。恢复功能使用工作流程实施，可轻松定制。该框架支持使用插件方法在外部系统中存储设备配置。
有关详细信息，请参阅BPA用户指南备份和恢复。
参考数据管理
RefD是管理BPA中的本地和外部数据的应用程序，其他BPA用例应用程序利用它来动态获取变量数据。
说明和主要功能
RefD提供统一的控制面板来管理分层数据节点。主要功能包括：
- 用于创建变量数据层次结构节点、填充本地变量数据或附加外部源以定期获取变量数据的接口
- 用于跨所有节点层次结构或目标节点获取密钥值对的强大查询API
- 应用程序可以使用引用案例API来获取和管理动态变量
- 充当代理，使用插件框架从应用(例如，IP地址管理(IPAM)、GitHub、Gitlab、简单存储服务、NSO等)获取外部变量
- 通过资源组支持访问策略，以对节点进行细粒度访问
- 支持各种数据类型（例如JSON、CSV、YAML、属性和BPA通用表单）
主要好处
- 管理BPA内部或外部应用的任何平面或分层数据
- 使用插件可将数据刷新扩展到任何新的外部系统
- 统一控制面板允许用户轻松管理所有节点CRUD和搜索操作
- 使用访问策略和RBAC支持数据掩码和受控数据访问
支持的控制器和平台
| 域 | BPA | 控制器 |
|---|---|---|
| 通用 | 版本 4.1.1 | NSO |
有关详细信息，请参阅BPA用户指南参考数据管理。
BPA传统用户界面门户
本章详细介绍可使用BPA传统门户应用程序执行的所有用户界面操作。
基本应用程序导航
下图显示了用户访问应用时通常显示的应用。Home页根据授予已分配用户组的权限显示业务应用程序。 通知图标会通知用户来自应用的警报。
Home页上显示下列应用程序：
- 服务中心
- 表单生成器
- 设备管理器
- 操作系统升级
- 流程模板
- GCT
- 配置验证程序
- 工作流程
- 拓扑
- 市场差异
- 设备激活
- 迁移
- 服务目录
- 提交管理器
- 脚本运行者
- Ansible模板
- 配置合规性
- 调度程序
User Profile图标包括以下选项：
- 配置文件
- 管理员（对管理员用户可见）
- 首选项
- 注销
有关详细信息，请参阅使用业务应用程序部分。
通用图标说明表
下表说明了应用程序中使用的常用图标。
| 图标 | 描述 |
|---|---|
 |
查看应用程序列表 |
 |
包含以下选项：简档、管理员、首选项和注销 |
 |
查看有关业务流程自动化的详细信息，例如核心服务和身份验证服务版本详细信息 |
 |
查看通知 |
 |
执行编辑操作 |
 |
执行删除操作 |
 |
刷新数据 |
 |
查看和编辑设置 |
 |
查看图表 |
 |
暂停操作 |
 |
停止操作 |
 |
查看输出结果 |
 |
下载 |
 |
查看设备详细信息 |
 |
表示服务 |
通知
通知是在BPA中发生某些事件时向用户显示的警报。显示以下事件的警报：
- 已配置NSO的Netconf通知(每个NSO必须在conf/snmp-trap/config.json中配置)
- 更新的网络拓扑
- 密码过期
- 应用程序或工作流程在执行用户请求的操作时向用户发送消息
- 任务已分配给用户
从页面右角选择Notification图标以查看通知。
要查看所有通知，请选择查看全部。通知可以按严重性过滤。
启用通知首选项workflow.usertask.notifications时，工作流中的相关用户任务可作为通知接收。这允许用户直接从通知面板声明用户任务并对其执行操作。
要设置通知首选项，请选择首选项。
排序和搜索操作
应用程序中的各个页面在用户界面中提供排序和搜索选项。单击列标题对显示的列表进行排序。Search字段在某些页面（如Templates、Defined Workflows等）中可用，允许用户过滤特定数据。
登录到BPA应用
- 使用任何受支持的浏览器导航至应用。
- 输入用户名和密码，然后单击登录。如果打开以下安全断言标记语言(SAML)窗口，则启用身份验证。
如果需要单点登录身份验证，请使用SAML服务器选项进行身份验证。
- 单击Login with <SSO Server>导航到SAML服务器。
- 输入用户名和密码，然后单击登录。系统将显示BPA主页。如有必要，请与系统管理员联系以获取登录密钥详细信息。
如果启用双因素身份验证，用户必须提供凭证和一次性密码(OTP)进行登录。有关详细信息，请参阅BPA安装指南的启用OTP部分。
- 使用BPA凭证启用并登录到TACACS。有关详细信息，请参阅BPA安装指南的配置TACACS部分。
成功登录后，会显示主页。
注销BPA应用
为了防止其他用户进行未经授权的访问，建议用户在每次使用时注销BPA。要注销，请选择User Profile图标> Logout。
查看配置文件详细信息
Profile菜单选项允许用户查看和更新他们的信息，如名字、姓氏和电子邮件。它还列出所有分配的组，并允许用户更改其密码。
要查看配置文件详细信息，请选择User Profile图标> Profile。系统随即会显示Profile页面。
添加多个NSO时，系统会显示首选项选项。
编辑配置文件详细信息
要编辑用户凭证，请执行以下操作：
- 选择User Profile图标> Profile。系统随即会显示Profile页面。
- 编辑详细信息。
- Click Save.
要编辑密码，请执行以下操作：
- 选择User Profile图标> Profile。系统随即会显示Profile页面。
- 单击Change Password。
- 输入当前密码和新密码，然后确认新密码。
- Click Save.
建议用户定期（即每90天）更改密码，或者当他们怀疑自己的帐户安全可能受到威胁时更改密码。密码更改只能在成功登录后启动。
API密钥身份验证
当个人用户或管理员需要创建新的API密钥时，他们应该执行以下步骤：
- 选择User Profile图标> Profile。系统随即会显示Profile页面。
- 单击Manage API Keys。Manage admin API Keys窗口打开。
- 单击Generate New API Key，然后根据登录输入Alias。
- 单击Save以生成一次性API密钥。API Key窗口打开。
- 通过选择“复制”图标复制并保存API密钥，以自动将API密钥复制到剪贴板。生成密钥后，密钥便可在应用程序内的任何位置使用。
要使用API密钥从Reports选项卡生成报告，请执行以下操作：
- 单击Generate Report并输入保存的API密钥。其他或不正确的API密钥不起作用。
- 输入成功生成报告的API密钥后，单击OK。
系统配置
要首次登录，请执行以下操作：
- 使用管理员用户凭证登录。
- 检查并更新配置设置。有关详细信息，请参阅管理员设置部分。
- 通过选择Sync Services Schema图标将所有服务从NSO同步到BPA。
- 选择要设置为登录时的默认选项的NSO。有关详细信息，请参阅首选项。
BPA系统配置在两个场景中完成。
- 第一次BPA登录时
- 由于集成服务器详细信息已更改且必须在BPA中同步而需要更新时
管理员设置
要查看管理员选项，请选择User Profile图标> Admin。从此屏幕管理以下组件：
管理用户
Users选项允许用户添加、编辑和删除用户。要管理用户：
- 选择User Profile图标> Admin。系统随即会显示Admin页面。
- 选择Users磁贴以管理用户。
添加用户
可以通过点击Add Users添加用户，并使用Editing Users选项将用户分配到特定组。添加新用户的步骤：
- 从Admin页面中，选择Users磁贴。系统随即会显示Users页面。
- 单击Add User。New User窗口打开。
- 输入名字、姓氏、用户名、电子邮件ID和电子邮件，点击生成密码，然后选择User Group。
- 单击Save以创建用户。成功添加用户时，屏幕右上角会显示一条消息。
编辑用户
按照以下步骤编辑用户详细信息：
- 从所需用户的操作列中选择编辑图标。Edit User窗口打开。
- 编辑必要的字段。
- 要更改密码，请单击更改密码。Change Password窗口打开。
- 单击Generate Password获取新密码和Confirm Password。
- Click Save.
要将组分配给用户，请执行以下操作：
- 如果用户未分配到任何组，则会显示选择用户组字段。选中所需组的复选框。
- 如果用户已分配到组，则展开Select User Group(s)字段并选择所需的组以分配用户。
- 使用Search字段搜索特定组。组具有预定义的策略，权限或策略设置取决于资源类型。
- Click Save.
删除用户
要删除用户，请执行以下操作：
- 从所需用户的操作列中选择删除图标。系统将显示警告消息。
- 单击OK以删除用户。
管理组和权限
管理组的步骤：
- 选择User Profile图标> Admin。系统随即会显示Admin页面。
- 选择Groups磁贴以管理组。
Groups磁贴允许用户执行以下操作：
添加组
Add Groups（添加组）选项允许用户定义一组用户的应用访问和操作权限。管理员可以为属于某个组的用户提供对特定BPA应用的访问权限。管理员还可以为特定应用启用和禁用各种应用操作（例如，启动、暂停等）。使用Admin > Users菜单选项将用户分配到所需的组。
按照以下步骤添加新组：
- 从Admin页面中，选择Groups磁贴。系统随即会显示Groups页面。
- 单击Add Group。Add User Group窗口打开。
- 输入组的名称和说明。如果用户是组管理员，则启用Is Admin切换以指定用户为组管理员。
- 如果用户不是组管理员，有两个选项适用：
- 用户:单击Add将用户添加到组。将打开Existing Users窗口。选择用户，将其分配到组，然后单击保存。有关添加新用户的详细信息，请参阅添加用户。
- 权限:此选项卡列出所有BPA应用。选择要为组中的用户启用的应用。用户还可以启用或禁用应用程序中的单个元素。此选项适用于工作流和服务中心。在工作流中，用户可以启用“查看表单”、“申请任务”和“添加工作流”。
- Click Save.成功添加组后，将显示成功消息。
编辑组权限
管理员可以使用“编辑”选项编辑组权限。按照以下步骤编辑组详细信息：
- 从Groups页面中，选择所需用户组的Edit图标。将打开Edit Group窗口。
- 编辑名称和说明。如果用户是组管理员，则启用Is Admin切换。
- 如果用户不是组管理员，有两个选项适用：
- 用户:单击Add将用户添加到组。Existing Users窗口打开。选择要分配给组的用户，然后单击Save。有关添加新用户的详细信息，请参阅添加用户。
- 权限:此选项卡列出所有BPA应用。选择要为组中的用户启用的应用。用户还可以启用或禁用应用程序中的单个元素。此选项适用于工作流和服务中心。在工作流程中，可以启用“查看表单”、“申请任务”、“添加工作流程”以及工作流程应用中各个选项卡的访问权限。
- 单击Update以更新组的详细信息。成功更新后将显示成功消息。所有设备操作都显示为列。
- 为特定用户组的每个控制器实例选择适用的设备操作。
删除组
要删除组，请执行以下操作：
- 从Groups页面，选择所需组的Actions列中的Delete图标。系统将显示警告消息。
- 单击OK删除该组。
管理区域
区域允许用户设置对NSO的访问控制。如果用户具有管理员权限(admin)，则他们可创建区域以提高网络安全或管理NSO的访问控制。不同区域中的用户根据所属组和区域在门户中显示不同的NSO。用户还可以将NSO配置为区域。
在区域级别提供访问控制，允许访问该区域中的所有NSO。访问权限列表包括：
添加区域
- 选择User Profile图标> Admin。系统随即会显示Admin页面。
- 选择Zones磁贴。系统随即会显示“区域”页面。
- 点击Add Zone。将打开“添加区域”窗口。
- 输入Name和Description，然后从Groups下拉列表中选择所需组的复选框。要将用户分配到特定区域，请将用户添加到组并将组分配到特定区域。有关详细信息，请参阅管理用户和管理组和权限。
- 单击Save以创建区域。
编辑区域
- 在区域页面中，从所需区域的操作列中选择编辑图标。Edit Zone窗口打开。
- 编辑必要的字段。
- 单击Save以保存所做的更改。
删除区域
- 在区域页面中，从所需区域的操作列中选择删除图标。系统将显示警告消息。
- 单击OK删除该组。
管理设置
管理员设置允许用户管理以下内容的访问详细信息：
- 控制器
- SMTP
- 支持
- 密码设置
- 票证
- 数据清除
- Interactive-CLI
- Mask_Sensitive_Info
- 添加或删除自定义设置
要查看“设置”页面，请执行以下操作：
- 选择User Profile图标> Admin。系统随即会显示Admin页面。
- 选择设置磁贴。Settings页面显示列出所有类别。
- 要编辑任何组件详细信息，请单击所需的类别，编辑详细信息，然后单击保存。
控制器设置
BPA可以管理NSO、vManage、Ansible、Cisco Catalyst Center等的一个或多个控制器实例。控制器设置允许用户配置控制器实例。要管理控制器的设置，请在Admin页面上选择Settings磁贴，然后点击Controllers选项卡。
| 图标 | 详细信息 |
|---|---|
| 1 | 查看有关同步状态的详细信息 |
| 2 | 查看控制器详细信息 |
| 3 | 编辑控制器 |
| 4 | 启动设备同步 |
| 5 | 删除控制器 |
添加控制器的步骤：
- 在Controllers选项卡中，单击Add。Add Controller窗口打开。
- NSO的Add Controller窗口有一个NSO Controller Info部分，用于添加基础NSO控制器详细信息。
- 当NSO Controller Info部分展开且用户点击Add时，将显示以下图像。
- 部署BPA时，会自动添加名为Direct-to-Device的控制器实例。通过填写以下表格，可以添加其他控制器实例：
- 输入以下详细信息以连接到控制器：
- 名称：输入控制器名称
- 控制器类型:从下拉列表中选择
- 方案:从下拉列表中选择网络协议方案（HTTP或HTTPS）
- 主机名 :输入控制器实例的主机名
- 端口:输入控制器实例侦听的端口号
- username：输入用于连接到控制器API的用户名
- 密码：输入用于连接到控制器API的密码
- 区域:从下拉列表中选择一个区域。有关添加区域和向特定区域分配组的详细信息，请参阅管理区域。
- 默认:启用切换以使控制器实例成为默认值
- LSA节点:启用切换以配置分层服务架构(LSA)节点中的NSO控制器。这仅适用于NSO控制器。
- 版本:输入或从DCNM和Cisco Catalyst Center控制器类型的下拉列表中选择一个版本
- 启用直通:启用切换以在NSO端启用直通/外部身份验证。如果NSO设置为针对BPA执行外部身份验证（仅适用于NSO控制器），则可以启用该功能，以便对NSO身份验证使用BPA凭证
- 启用后，不再需要提供控制器凭证；因此Username和Password字段在UI中隐藏。通过当前BPA用户的凭证与此控制器进行所有交互
- 要使用当前BPA设置用于外部身份验证的任何NSO，请参阅位于Bpa-nso-utils-3.x.xxx.xxx-zip/Ciscoutils/Nso-pass-through/Scripts文件夹路径上的名为“ext-auth-BPA.py”的示例Python脚本，如下所示：
- 如果未启用，UI中会显示Username和Password字段。输入NSO凭证使其使用NSO本地身份验证
- 也可以为LSA节点启用
- 是大师级吗？:启用切换以指示vManage控制器实例为主控制器（仅适用于vManage控制器）。 每个BPA安装只能有一个主vManage实例；所有其他实例都是特定于区域的
NSO设置
在设置中启用LSA节点后，面向资源的服务(RFS)选项变为可用：
- 单击Sync RFS。系统将显示控制器设置下所有面向资源的服务(RFS)节点的列表。
- 单击Add RFS。Add RFS Node窗口打开。
- 输入Host、Port、Username和Password。
- 更新必填字段后，单击Save。
用户可以在创建RFS节点后编辑或删除RFS节点，方法是选择控制器，单击同步RFS，然后选择RFS节点的编辑图标或删除图标。
座席
代理列出在BPA上部署的所有控制器代理。用户可以获取每个座席的状态和详细信息。
- 在设置页面中，从所需座席的操作列中选择查看图标以查看其详细信息。View Screen窗口打开。
- 从设置页面中，从所需代理的操作列中选择齿轮图标> 检查状态，以确定该代理是否可ping通。
- 在设置页面中，从所需座席的操作列中选择齿轮图标> 功能，以查看座席的所有可用功能。
SMTP设置
BPA支持SMTP服务器配置，工作流或其他应用程序可以使用它向用户发送电子邮件通知。
要管理SMTP设置，请执行以下操作：
- 从Admin页面中，选择Settings磁贴。系统随即会显示Settings页面。
- 单击Settings页面上的SMTP选项卡。
- 输入以下详细信息以连接到SMTP服务器：
- 主机:SMTP服务器的主机名
- 端口:SMTP侦听的端口号
- username：用于连接到SMTP服务器的用户名
- 密码：连接到SMTP服务器的密码
- 发件人邮件ID:输入要从中发送邮件的邮件ID
- 更新必填字段后，单击Save。
要编辑其他设置，请参阅下面的相应部分。
支持设置
可以配置支持URL，以便在用户遇到问题时为其提供其他帮助。配置URL时，用户图标下会显示一个链接，将其重定向到“支持”选项卡。
- 输入Name和URL，然后单击Save。
- 再次单击Save以显示Support选项卡。
密码设置
BPA有助于添加密码参数以保护用户和数据。
- 根据需要在Settings页面的Password Settings选项卡上设置下表中列出的密码参数。
- Click Save.
| 密码参数 | 说明 |
|---|---|
| 启用到期 | 对本地非管理员用户强制密码到期 |
| 过期时间 | 用户密码在配置的天数后过期 |
| 警告之前 | 密码到期警告通知在配置的日期之前生成 |
| 失败的尝试 | 阻止用户登录之前允许的失败尝试次数 |
| 阻塞时间 | 用户因超过配置的失败尝试次数而被阻止的时间 |
票证
Settings页面上的Ticketing选项卡允许用户在BPA中配置更改管理系统。
- 单击 Add。将打开添加票证实例窗口。
- 输入名称、主机和用户凭证。
- 从下拉列表中选择Ticketing Type、Scheme和Port。
- Click Save.
Interactive-CLI
Settings页面上的interactive_cli选项卡允许用户配置组或用户可以根据RBAC执行的命令。有以下两种选项：
- 包括:包括用户可以使用交互式CLI在设备上执行的命令列表。
- 排除:包含不允许用户使用交互式CLI在设备上执行的命令的列表。
Mask_Sensitive_Info
Settings页面上的Mask_Sensitive_Info选项卡允许用户配置需要屏蔽的使用案例的敏感数据。
在下面的图像中，已包含interactive-cli;因此，在显示或下载设备响应时，敏感数据会被屏蔽。
添加自定义设置
可以通过添加更多选项卡并将其与Form Builder通用表单关联来创建其他配置元素。这允许用户创建可由工作流程使用的自定义配置。
执行以下步骤添加选项卡：
- 单击Settings页面顶部的Add图标。将打开Add Tab窗口。
- 添加名称并从表单下拉列表中选择通用（在Form Builder中创建），然后单击保存。系统随即会显示一个包含表单详细信息的新选项卡。
- 根据需要编辑并保存选项卡内容。
还可以通过API访问创建的所有自定义设置。
HOST>/bpa/api/v1.0/settings/custom-form/CustomSettings
Method: GET
Response
{
"_id": "5cac5c60e462ba27e5d85a05",
"createdBy": {
"name": "admin",
"firstName": "admin",
"lastName": "admin",
"id": "b90306e7-7e55-447b-a531-df36ea55aae3"
},
"formName": "CustomSettings",
"tabName": "CustomSettings",
"data": {
"Host": "10.1.1.XXX",
"Port": "8080"
},
"__v": 0
}在代码块示例中，CustomSettings是添加到设置应用程序的选项卡。
数据清除
此应用程序有助于根据清除策略分析和删除历史数据。可删除的数据包括模板执行、差异分析执行、工作流历史记录、合规性报告和完成的服务订单。
要计划数据清除，请执行以下操作：
- 输入Start Date和Start Time。
- 选中重复计划复选框。
- 根据需要选择重复计划的小时和天数。
- 输入End Date和End Time，然后单击Schedule。
- 单击Analyze可查看可被删除的记录的摘要。
- 单击View图标查看上次运行的详细信息。
- 要删除以前的运行，请选择任何执行，然后单击删除图标。
只有Admin用户可以运行并执行在“data-aging-policy-definition.json”文件中定义的数据清除。
示例：
{ "categories":{ "Process Templates Executions":{ "microservice":"core", "collection":"execution-outputs", "attribute":"executionDate", "age":365, "number_of_records_to_delete":2000 }, "Configuration compliance reports":{ "microservice":"core", "collection":"reports", "attribute":"modified_date", "age":365, "number_of_records_to_delete":2000 }, "Workflow History":{ "microservice":"core", "collection":"process-instances", "age":365, "number_of_records_to_delete":2000 }, "Completed orders from Service Catalog":{ "microservice":"serviceCatalog", "collection":"serviceorders", "attribute":"createdAt", "age":365, "number_of_records_to_delete":2000 } }}数据清除策略可定义如下：
- 微服务:需要清除数据的微服务的名称
- 集合:要从数据库中清除的数据收集
- 属性:用于评估清除标准的收集属性
- 年龄:以天为单位定义的删除记录的阈值（即保留记录的时间限制）
- 记录数_to_delete:要删除的已定义记录的最大数量
网络拓扑模板
BPA使用网络拓扑模板构建设备的网络拓扑。可以使用网络拓扑应用程序查看拓扑。
- 选择User Profile图标> Admin。
- 选择Network Topology Templates选项卡。系统将显示Network Topology Templates页面。
Network Topology Templates页面显示可用模板及其一般信息的列表，例如NED ID、创建日期和更新日期。网络拓扑模板允许用户执行以下操作：
- 通过点击Add（添加）添加网络拓扑模板
- 通过点击Build（建立）建立网络拓扑链路
- 通过点击同步来同步设备位置
- 选择Edit图标编辑网络拓扑模板
- 通过选择Delete（删除）图标删除网络拓扑模板
添加网络拓扑模板
要添加网络拓扑模板，请执行以下操作：
- 在网络拓扑模板页中，单击添加。Create Topology Template窗口打开。
- 从下拉列表中选择NSO、NED和模板。
- Click Save.屏幕右上角将显示弹出消息。
列出的模板是使用“流程模板”应用程序创建的。
建立网络拓扑链路
要从网络检索数据并构建拓扑中的链路，请从网络拓扑模板页面单击Build。用户可以添加或更新网络拓扑链路。网络拓扑链路更新后，系统将显示成功弹出窗口。
同步设备位置
从网络拓扑模板页中单击同步，以更新设备在网络拓扑中的最新位置。系统将打开一个成功弹出窗口。
编辑网络模板
执行以下步骤编辑网络模板：
- 从网络拓扑模板页面，从所需网络模板的操作列中选择编辑图标。Update Topology Template窗口打开。
- 从下拉列表中选择所需的模板，然后单击Update。
删除网络模板
执行以下步骤删除网络模板：
- 从网络拓扑模板页面，从所需网络模板的操作图标中选择删除图标。系统将打开一个删除确认窗口。
- Click OK.
标记管理
标签管理有助于管理标签。BPA工件（如流程模板、GCT、表单生成器表单等）可以使用一个或多个标记进行标记，这些标记可用于过滤工件。
添加标记
要添加标记，请执行以下步骤：
- 从Admin页面中，选择Tag Management磁贴。系统随即会显示Tag Management页面。
下表中的数字与上图“标记管理”中所示的图标相对应。
| 编号 | 图标 |
|---|---|
| 1 | 编辑 |
| 2 | 下载标记 |
| 3 | 删除标记 |
- 单击 Add。Add Tag窗口打开。
- 输入Tag Name，然后从Select App下拉列表中选择一个或多个应用。要在所有组件中使用标记，请勿选择任何应用程序。
- Click Save.
编辑标记
要编辑标记详细信息，请执行以下步骤：
- 从标记管理页面中，从所需标记的操作列中选择编辑图标。Edit Tag Item窗口打开。
- 根据需要编辑必填字段。
- Click Save.
删除标记
要删除标记，请执行以下步骤：
- 从标记管理页面中，从所需标记的操作列中选择删除图标。系统将显示警告消息。
- 单击OK以删除标记。
控制器数据 — 同步
要同步控制器数据，请执行以下步骤：
- 选择User Profile图标> Admin。系统随即会显示Admin页面。
- 选择Controller Data-Sync磁贴。系统将显示“选择要同步的控制器”页面。从列表中选择控制器的复选框，然后单击继续。
- 或者，可以选择操作部分下的同步图标来触发同步过程。对于NSO控制器，同步操作执行服务同步。对于所有其他控制器类型，同步进程将执行模板同步。
- 对于NSO，Controller Data Sync窗口显示从已配置的控制器检索的服务方案。用户可以查看将结果显示为true或false的同步状态。在该窗口中，提供了配置哪些组有权访问这些服务的选项。从Select Groups下拉列表中选择一个组，并根据需要更改权限。在选择下一个组之前单击Save。
需要安装CiscoOutlis软件包。有关详细信息，请参阅BPA安装指南。
- Cron计划程序自动执行控制器数据同步。在选择要同步的控制器页中，从所需控制器的操作列中选择齿轮图标。将打开Cron Scheduler to Sync窗口。配置控制器实例的Chron计划。可以为设备同步和模板同步选择相同或不同的计划。此功能适用于所有控制器类型。
管理服务目录
要管理服务目录，请执行以下操作：
- 选择User Profile图标> Admin。系统随即会显示Admin页面。
- 选择Service Catalog磁贴以管理服务
以下组件可通过Service Catalog（服务目录）选项进行添加：
- 服务类别
- 服务项目
- 订单
服务类别
此选项用于管理服务目录中的服务类别。
添加服务类别
要添加服务类别，请执行以下步骤：
- 从Admin页面中，选择Service Catalog磁贴。系统将显示Service Catalog页面。
- 点击Service Categories选项卡。
- 单击 Add。
- 输入服务类别的名称和说明。
- 启用活动切换以使订单的服务类别处于活动状态。
- 从列表中选择Parent Category。父类别用于在已存在的类别中添加新类别。
- Click Save.
编辑服务类别
要编辑服务类别详细信息，请执行以下步骤：
- 从Service Categories选项卡中，从所需类别的Actions列中选择Edit图标。Edit Service Category窗口打开。
- 更新必要的字段，然后单击Save。
删除服务类别
要删除类别，请执行以下步骤：
- 从Service Categories选项卡中，从所需类别的Actions列中选择Delete图标。系统将显示警告消息。
- 单击OK以删除类别。
服务项目
此选项用于管理服务目录中的服务项。
添加服务项目
- 从Admin页面，点击Service Catalog（服务目录）磁贴。系统将显示Service Catalog页面。
- 点击Service Items选项卡。
- 单击 Add。
- 输入名称和说明。
- 从下拉列表中选择Category。
- 选择Status。
- 浏览以选择映像文件并添加该文件。
- 从下拉列表中选择Tags。
- 从下拉列表中选择Order Form Type。
- 从下拉列表中选择Workflow和Version。
- 输入操作Name，选择Workflow、Version和Icon，然后输入Icon工具提示。选择Plus图标以添加操作。
- Click Save.
编辑服务项
要编辑服务项目详细信息，请执行以下操作：
- 从Service Items选项卡中，从所需服务项目的Actions列中选择Edit图标。Edit Service Item窗口打开。
- 进行所需的编辑。
- Click Save.
删除服务项目
要删除服务项，请执行以下操作：
- 从Service Items选项卡中，从所需服务项目的Actions列中选择Delete图标。系统将显示警告消息。
- 单击确定以删除项目。
订单
此选项用于查看用户订购的所有服务项目。用户可以按订单ID、服务、日期或订购项目的用户搜索订单。
在“订单”选项卡中，使用过滤器搜索状态为已完成或“处理中”的订单。
同步用户
Sync用户从配置的服务器导入用户。
如果启用LDAP集成，则用户可以与BPA数据库同步。
在Admin屏幕中，单击Sync Users以同步LDAP用户。
同步组
Sync用户从配置的服务器导入用户。
如果启用LDAP集成，则用户可以与BPA数据库同步。
在Admin页面中，选择Sync Users磁贴以同步LDAP用户。
适配器生成器
这支持由内部和外部服务提供商公开的主叫API。它可以链接API调用并使用内部BPA资源在API调用之间转换数据。有关详细信息，请参阅使用适配器生成器。
Ansible设置
这是为了配置表单，以便用户可以将数据输入为Ansible模板的输入。为了定义输入表单，此应用程序使用Form Builder应用程序。
有关详细信息，请参阅可能的设置。
激活模板
Ansible控制器中的所有模板都在此页面上可用。以“BPA”开头的模板名称用于BPA特定功能。
自定义模板可与Form Builder表单一起使用，用户可以在Ansible模板中启动作业。
事件处理程序
事件处理程序自动化是一个框架，可响应网络事件，并根据事件的严重性自动或手动触发操作。此框架可解决封闭式循环情景，帮助客户对可能由设备或保证和分析解决方案触发的事故做出反应。该框架有三个阶段：
- 数据扩充:此阶段可配置为获取其他数据，并将其扩充为触发事件时收到的数据
- 表达式评估：此阶段计算作为一组规则的表达式；评估值为布尔值。
- 操作评估:与布尔值计算关联的操作在此最后阶段触发
有关详细信息，请参阅BPA开发人员指南。
备份和恢复
备份和恢复框架使设备配置备份能够从各种控制器获取并存储在可配置的数据存储中。该框架还支持基于工作流程的方法，用于恢复特定设备上的备份配置。备份和还原管理应用程序具有以下组件：
- 策略
- 计划
- 设备配置 — 上传
- 备份历史记录
- 目标存储库
- 目标插件
策略
策略是在运行备份和还原流程时要遵守的元数据定义。
“列出策略”页
Policies选项卡提供系统中所有可用策略的网格视图。
它还提供了添加、编辑、删除、上传和下载策略的选项。策略可以从一个环境下载并上传到另一个环境。
添加或编辑策略
策略具有以下关键字段：
- 策略名称：策略的名称（必须是唯一的）
- 活动:这表示该策略处于活动状态。如果策略设置为非活动状态，则执行备份时不会向用户显示该策略。禁用所有相应的计划
备份详细信息:
- 目标回购:所创建的备份应存储到的目标存储库。
- 最大保留计数:每个设备保留的备份总数。一旦达到此值，就会删除旧设备备份
- 屏蔽敏感数据的模式:用于在显示期间遮蔽敏感数据的模式列表。这不会更改存储的配置
- 忽略模式:比较两个配置时用于忽略线路的模式列表。在创建校验和时使用此命令，以确定以前的备份和当前备份是否相同。这不会更改存储的配置
- 压缩:在存储之前压缩备份
- 加密:在存储之前加密备份
还原详细信息：
- 还原工作流:还原过程中要执行的工作流程
- 控制器类型:应用策略的控制器类型（例如，DCNM、NSO）
- 模板:用于添加一个或多个预/后模板和分析模板的部分。在恢复工作流程期间用于验证
- 筛选条件（标记）:可通过标记过滤恢复工作流程和模板
- 预检查模板:仅用于预检查的模板列表
- 检查后模板:仅用于后期检查的模板列表
- 启用票证集成:选中此复选框可启用与票证系统的集成使用案例提供与ServiceNow系统的开箱即用集成
计划
计划是根据策略创建的。用户可以选择设备列表并选择备份设备的时间。计划可以是一次性的，也可以是定期性的。
“计划”选项卡
此选项卡列出系统中配置的所有计划。管理员可以选择添加、编辑和删除计划。
添加或编辑计划
计划具有以下关键字段：
- 计划名称:用于标识计划的唯一名称
- 策略名称：按此计划执行备份时要使用的策略
- 标签:要附加到此计划中的所有备份的可选标签
- 资产:一个网格，用于根据要备份的设备列表选择资产组
- 计划详细信息和计划重复:提供用于定义各种计划参数的选项，如开始日期/时间、循环模式（包括cron）和结束日期
备份配置 — 上传
用户可以上传包含一个或多个设备配置的“tar.gz”或.tgz文件，以保存为配置备份。
上传文件结构如下：
sample.tar.gz到sample.tar到{{device-name}}.txt
“备份配置 — 上传”文件具有以下关键字段：
- 控制器类型:控制器实例所属的控制器类型（例如，DCNM、NSO）
- 控制器:控制器设备已入网的控制器实例
- Policy（策略）：通过此设备配置上载进行备份时要使用的策略
- 标签（可选）:要附加到此设备配置上传中执行的所有备份的可选标签
- 设备配置文件:要以“tgz”或“tar.gz”格式上传的配置文件
备份历史记录
此选项卡提供已完成备份的历史视图，以及日期、策略、计划和状态的参考。
用户可以查看每次执行的详细状态。
目标存储库
目标资料库是存储备份配置数据的数据系统的实例。默认的预配置目标存储库是内部数据库。
“目标存储库”选项卡
目标存储库选项卡列出了为此系统配置的目标存储库。管理员可以根据不同的目标类型定义存储库实例。
添加或编辑目标存储库
目标存储库的关键字段包括：
- 目标名称:存储库的名称
- 目标类型:目标类型以及来自“目标类型”列的值的列表
- 目标表单（可选）:选择目标表单并完成要用于此目标存储库实例的配置数据
- 批大小:选择目标批处理大小
目标插件
“目标插件”选项卡
备份和恢复框架提供了一个选项，可将外部系统配置为备份配置的存储。此功能由插件架构提供支持。每个插件必须实现一个预定义接口（具有函数、输入和输出参数列表）并上传到目标插件页面。
添加或编辑目标插件
目标插件具有以下字段：
- 目标类型:目标类型名称
- 执行环境:运行插件的执行环境。当前仅支持NodeJS
- 上传插件:要以.tgz或“tar.gz”格式上传的上传插件文件。这应该是节点包管理器包
备份限制
备份过程利用高级排队框架(AQF)，利用其限制实现高效操作。使用AQF，计划备份期间的请求处理得到优化，确保在定义的限制参数范围内无缝。
首选项
User Profile图标> Preferences选项允许用户选择首选的控制器实例。控制器实例可以属于任何控制器类型，例如Cisco Catalyst Center、DCNM、Ansible、NSO和vManage。在显示控制器实例选择框（配置多个控制器实例时显示）的应用中，默认情况下会选择首选控制器实例。
添加多个控制器实例时会显示首选项。
要设置默认控制器实例，请执行以下操作：
- 选择User Profile图标> Preferences。系统随即会显示Preferences页面。
默认情况下，All处于选中状态。用户可以根据自己的偏好更改到首选控制器实例。如果将All设置为首选控制器实例，则根据所选设备，由设备所在的系统为“设备管理器”、“命令模板”、“GCT”、“服务中心”和“表单生成器”页中的任何操作选取控制器实例。
- 从下拉列表中选择首选控制器实例，然后单击Save。这会将首选控制器实例设置为登录时的默认选项。
使用业务应用程序
本节概述有关BPA中可用的所有应用的详细信息。
使用Form Builder应用程序
Form Builder应用程序用于构建用户输入的表单。这些表单可嵌入工作流程中，以收集最终用户的输入。收集的数据可用于在工作流中做出进一步决策或在通过NSO调配设备之前构建负载。
用户可以在Form Builder应用程序中执行以下操作：
创建表单
要创建新表单，请执行以下操作：
- 在“表单构建器”页面，单击添加。系统随即会显示创建新表单页面。
- 输入表单名称，然后选择表单类型。有三种选项可供选择：
- 单一服务:使用此选项可添加/修改/删除特定NSO和服务模板的输入参数
- 多服务:使用此选项可添加/修改/删除NSO和多个服务模板的输入参数
- 通用:使用此选项可创建通用表单（不基于服务模板）
- 从下拉列表中选择Tags。
- 进行更改后，预览所做的更改，然后单击Save。这会将表单保存在数据库中。要编辑表单，请参阅编辑表单。
查看表单
要查看表单，请执行以下操作：
- 单击主页上的Form Builder应用程序。“表单生成器”页显示当前表单的列表。该列表还显示创建、修改日期，并包括可以执行的操作，如编辑和删除。
- 使用From Date、To Date和Search选项在所需时间过滤所需表单。
要启用经典UI，请启用启用经典UI切换。此外，还可以选择传统UI的不同版本。
单击View Tree时，用户可以展开和折叠所有字段。
使用v2在左侧面板中以更组织化的树格式查看表单生成器详细信息（列表或容器），在右侧面板中查看内容，从而能够在网格和制表符或列表视图之间切换。这会减少滚动以转至容器中的最后一个项目。
选择Expand图标以查看容器的详细信息。
选择Expand和Collapse图标以访问容器中的其他组件。
编辑表单
- 在“表单构建器”页上，为要编辑的表单选择编辑图标。系统将显示（创建/编辑）表单页面。自动呈现所选服务的模型。用户可以进一步自定义参数。
- 如果启用了JSON切换，则Form Builder运行时会从用户收集数据并创建存储在工作流上下文中的JSON负载。
- 如果启用了导入切换，则在运行时会提供一个导入选项，允许用户从文件导入输入数据。
- 在屏幕左侧面板的Palettes下提供了各种选项。用户可以将所需组件拖放到服务模板中。
- 要编辑单个元素，请点击该元素的Settings图标。相应的Configure Element窗口打开。
- 编辑元素名称和此元素的可见性。根据要求选择或清除Hide选项。
- 选择Hide复选框以根据需要隐藏任何输入参数或设备。
- 编辑Element Name字段。
- 如果元素是组合框或选择框，则可以选择数据源。
- 选择Leafref Path、API Path或Manual Path作为数据源。
- 使用Mandatory切换按钮将规则设置为强制或可选来编辑元素的规则设置。
- 选中Read Only复选框以使字段为可读字段。如果未选择此字段，则用户可以输入或更改该字段的值。
- 选中Hide复选框以在运行时隐藏元素。
- 如果需要，在Validation Pattern字段中编辑正则表达式。正则表达式模式是JavaScript正则表达式模式。
- 如果选择了可能的控制器，则可以添加元素（例如，密码、用户名和端口）。
- 要使用模式检查，请参阅W3Schools的Java脚本RegExp参考页，以获取有关正则表达式形成和使用情况的详细信息。
数据源选项 描述 枝叶参考 来自NSO YANG模型的枝叶参考路径。 API路径 根据指定的JSON路径值，API路径可以是任何BPA API URL和API响应解析。解析的内容用作此构件的数据元素(例如，API路径：/settings/nso/instances;JSON路径：jsonpath :名称)。 在API路径中，可以包含变量引用，以便在此表单中其他构件上选择的值可以作为查询参数传递到此API路径。这有助于根据其他构件(例如，API路径：/svcmgr/service/servicePoint?nsoInstance=${end-type};JSON路径：service_point)。 此处，end-type是同一表单中另一个构件的关键标识符。 手动路径 在表单中显式指定的一个或多个值。 - 仅当元素属于字符串类型时，才会显示验证模式字段。否则，该字段不会显示在窗体中。
- Click OK.
- 编辑元素和规则详细信息后，单击Save保存更改。
- 单击Download获取JSON格式的负载。
以下示例演示如何使用JSON路径从JSON数据结构中提取值。
示例JSON
{
"service_schema": {
"telemetry:telemetry": {
"containsMultipleServicePath": false,
"containsWhenStatement": true,
"subscription": {
"mandatory": true,
"isCustomElement": false,
"sort_order": 3,
"interface-id": {
"deps": [
"/telemetry:telemetry/subscription/source-interface"
],
"evaluated_when_entry": false,
"mandatory": true,
"isCustomElement": false,
"sort_order": 4,
"when": true,
"data-type": "String",
"namespace": "/telemetry:telemetry/subscription/interface-id",
"label": "interface-id",
"nodeType": "Leaf"
},
"source-interface": {
"isCustomElement": false,
"sort_order": 3,
"options": [
"HundredGigE",
"Bundle-Ether",
"FortyGigE",
"GigabitEthernet",
"TenGigE"
],
"data-type": "enumeration",
"namespace": "/telemetry:telemetry/subscription/source-interface",
"label": "source-interface",
"nodeType": "Leaf"
},
"destination-id": {
"mandatory": true,
"isCustomElement": false,
"sort_order": 2,
"id": {
"deps": [
"/telemetry:telemetry",
"/telemetry:telemetry/destination-group"
],
"key": true,
"leafref": "/telemetry:telemetry/destination-group/name",
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"data-type": "String",
"namespace": "/telemetry:telemetry/subscription/destination-id/id",
"label": "id",
"nodeType": "Leaf"
},
"keys": [
"id"
],
"namespace": "/telemetry:telemetry/subscription/destination-id",
"label": "destination-id",
"nodeType": "List"
},
"sensor-group-id": {
"mandatory": true,
"isCustomElement": false,
"sort_order": 1,
"interval": {
"isCustomElement": false,
"sort_order": 1,
"default": "30000",
"maxRange": 4294967295,
"minRange": 0,
"data-type": "int32",
"namespace":
"/telemetry:telemetry/subscription/sensor-group-id/interval",
"label": "interval",
"nodeType": "Leaf"
},
"sensor-group": {
"deps": [
"/telemetry:telemetry",
"/telemetry:telemetry/sensor-group"
],
"key": true,
"leafref": "/telemetry:telemetry/sensor-group/name",
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"options": [
"oc-platform",
"cisco-platform",
"oc-bgp",
"cisco-bgp-ipv4",
"cisco-bgp-ipv6",
"oc-bundle",
"cisco-bundle",
"cisco-isis",
"oc-bgp-rib",
"cisco-bgp-rib",
"cisco-qos",
"oc-mpls",
"oc-acl",
"cisco-lldp"
],
"data-type": "enumeration",
"namespace":
"/telemetry:telemetry/subscription/sensor-group-id/sensor-group",
"label": "sensor-group",
"nodeType": "Leaf"
},
"keys": [
"sensor-group"
],
"namespace": "/telemetry:telemetry/subscription/sensor-group-id",
"label": "sensor-group-id",
"nodeType": "List"
},
"subscription-group-name": {
"key": true,
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"data-type": "String",
"namespace":
"/telemetry:telemetry/subscription/subscription-group-name",
"label": "subscription-group-name",
"nodeType": "Leaf"
},
"keys": [
"subscription-group-name"
],
"namespace": "/telemetry:telemetry/subscription",
"label": "subscription",
"nodeType": "List"
},
"sensor-group": {
"mandatory": true,
"isCustomElement": false,
"sort_order": 2,
"name": {
"key": true,
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"options": [
"oc-platform",
"cisco-platform",
"oc-bgp",
"cisco-bgp-ipv4",
"cisco-bgp-ipv6",
"oc-bundle",
"cisco-bundle",
"cisco-isis",
"oc-bgp-rib",
"cisco-bgp-rib",
"cisco-qos",
"oc-mpls",
"oc-acl",
"cisco-lldp"
],
"data-type": "enumeration",
"namespace": "/telemetry:telemetry/sensor-group/name",
"label": "name",
"nodeType": "Leaf"
},
"keys": [
"name"
],
"namespace": "/telemetry:telemetry/sensor-group",
"label": "sensor-group",
"nodeType": "List"
},
"destination-group": {
"mandatory": true,
"isCustomElement": false,
"sort_order": 1,
"address-family": {
"mandatory": true,
"isCustomElement": false,
"sort_order": 2,
"protocol": {
"isCustomElement": false,
"sort_order": 3,
"options": [
"grpc",
"tcp",
"udp"
],
"default": "tcp",
"data-type": "enumeration",
"namespace":
"/telemetry:telemetry/destination-group/address-family/protocol",
"label": "protocol",
"nodeType": "Leaf"
},
"encoding": {
"isCustomElement": false,
"sort_order": 2,
"options": [
"gpb",
"json",
"self-describing-gpb"
],
"default": "self-describing-gpb",
"data-type": "enumeration",
"namespace": "/telemetry:telemetry/destination-group/address-family/encoding",
"label": "encoding",
"nodeType": "Leaf"
},
"port": {
"key": true,
"mandatory": true,
"isCustomElement": false,
"sort_order": 1,
"maxRange": 65535,
"minRange": 1,
"data-type": "int32",
"namespace":
"/telemetry:telemetry/destination-group/address-family/port",
"label": "port",
"nodeType": "Leaf"
},
"ip": {
"key": true,
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"data-type": "ipv4",
"namespace": "/telemetry:telemetry/destination-group/address-family/ip",
"label": "ip",
"nodeType": "Leaf"
},
"keys": [
"ip",
"port"
],
"namespace": "/telemetry:telemetry/destination-group/address-family",
"label": "address-family",
"nodeType": "List"
},
"vrf": {
"isCustomElement": false,
"sort_order": 1,
"default": "default",
"data-type": "String",
"namespace": "/telemetry:telemetry/destination-group/vrf",
"label": "vrf",
"nodeType": "Leaf"
},
"name": {
"key": true,
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"data-type": "String",
"namespace": "/telemetry:telemetry/destination-group/name",
"label": "name",
"nodeType": "Leaf"
},
"keys": [
"name"
],
"namespace": "/telemetry:telemetry/destination-group",
"label": "destination-group",
"nodeType": "List"
},
"device": {
"deps": [
"/ncs:devices/device"
],
"key": true,
"leafref": "/ncs:devices/device/name",
"mandatory": true,
"isCustomElement": false,
"sort_order": 0,
"data-type": "String",
"namespace": "/telemetry:telemetry/device",
"label": "device",
"nodeType": "Leaf"
},
"keys": [
"device"
],
"service-point": "/telemetry:telemetry",
"label": "telemetry:telemetry",
"nodeType": "service"
}
}
}JSON路径示例
- service_schema.telemetry:telemetry.subscription.keys
- 结果内容："subscription-group-name"
- service_schema.telemetry:telemetry.subscription.interface-id.deps
- 内容："/遥测：遥测/订用/源接口"
- service_schema.telemetry:telemetry.subscription.source-interface.options
- 结果内容：“HundredGigE”、“Bundle-Ether”、“FortyGigE”、“GigabitEthernet”、“TenGigE”
- service_schema.telemetry:telemetry.subscription.source-interface.options[0]
- 结果内容："百千焦E"
- service_schema.telemetry:telemetry.subscription.subscription-group-name.key
- 结果内容：true
示例二：
{
"_id": "5d336e66259cd02c05b14567",
"createdBy": {
"name": "admin",
"firstName": "admin",
"lastName": "admin",
"id": "6fea3c84-20c7-4a40-b3a5-5a861a4ffb86"
},
"formName": "TMO_Settings",
"tabName": "TMO_Settings",
"tabId": "5d336df75ff94c2c00facec3",
"data": {
"database": {
"host": "localhost",
"port": "8080",
"username": "admin",
"password": "admin"
},
"usecases": [
{
"usecase": "VNF",
"displayName": "Basic VNF Check",
"canSchedule": true,
"emailBody": ""
},
{
"usecase": "ESC",
"displayName": "Hello ESC Use Case",
"emailBody": "HHHHHEEEEE"
}
]
},
"__v": 0
}JSONPath示例：
- data.usecases[x].usecase
- 结果内容："VNF","ESC"
- data.usecases[x].displayName
- 结果内容："基本VNF检查","Hello ESC使用案例"
- data.database.host
- 结果内容："本地主机"
- data.usecases[0].usecase
- 结果内容："VNF"
- data.usecases[1].usecase
- 结果内容："ESC"
示例三
{
"success": true,
"response": {
"jsonrpc": "2.0",
"result": {
"current_position": 1,
"total_number_of_results": 6,
"number_of_results": 6,
"number_of_elements_per_result": 3,
"results": [
[
"arista-dcs",
"arista-dcs",
"5.2.4"
],
[
"cisco-ios",
"cisco-ios",
"6.10"
],
[
"cisco-iosxr",
"cisco-ios-xr",
"7.7"
],
[
"cisco-nx",
"cisco-nx",
"5.7.6"
],
[
"cisco-staros",
"cisco-staros",
"5.10.4"
],
[
"juniper-junos",
"junos",
"4.1.3"
]
]
},
"id": 2
}
}JSON路径示例：
- response.result.results[0]
- 结果内容："arista-dcs","arista-dcs","5.2.4"
- response.result.results[0].[0]
- 结果内容："arista-dcs"
- response.result.results[0].[2]
- 结果内容：“5.2.4 ”
- response.result.results[5]
- 结果内容："juniper-junos"、"junos"、"4.1.3"
- response.result.results[5].[0]
- 结果内容：“juniper-junos”
- response.result.results[5].[1]
- 结果内容："junos"
- response.result.total_number_of_results
- 结果内容：6
示例四：
[
{
"name": "All",
"defaultPreference": true,
"lsa": false,
"default": false
},
{
"name": "nso179",
"defaultPreference": false,
"lsa": false,
"default": true
},
{
"name": "nso226",
"defaultPreference": false,
"lsa": false,
"default": false
},
{
"name": "nso165",
"defaultPreference": false,
"lsa": false,
"default": false
},
{
"name": "USER_NSO",
"defaultPreference": false,
"lsa": false,
"default": false
}
]JSON路径示例：
- 名称：将列出所有名字
- 结果内容："All"、"nso179"、"nso226"、"nso165"、"USER_NSO"
- [0].name
- 结果内容：“全部”
- [1].名称：
- 结果内容：“nso179”
示例5:
[
{
"id": "6fea3c84-20c7-4a40-b3a5-5a861a4ffb86",
"username": "admin",
"email_address": "admin@bizapps.cisco.com",
"first_name": "admin",
"last_name": "admin",
"created_at": "2019-07-15T08:39:36.000Z",
"local_user": true,
"groups": [
{
"id": "1ef891d0-cb52-40bd-ae6d-61c829502489",
"group": "admin"
},
{
"id": "edfb066f-93b1-43e2-8ed1-5118f9651311",
"group": "workflow-admin"
}
]
},
{
"id": "21512d4a-5e0a-4f0e-8de6-55c344d25aba",
"username": "demo",
"email_address": "demo@bizapps.cisco.com",
"first_name": "demo",
"last_name": "demo",
"created_at": "2019-07-15T08:39:36.000Z",
"local_user": true,
"groups": [
{
"id": "1ef891d0-cb52-40bd-ae6d-61c829502489",
"group": "admin"
}
]
},
{
"id": "02244f9d-8168-4ddf-9212-5811e4b6d913",
"username": "svcuser",
"email_address": "svcuser@bizapps.cisco.com",
"first_name": "Service",
"last_name": "User",
"created_at": "2019-07-15T08:39:37.000Z",
"local_user": true,
"groups": [
{
"id": "1ef891d0-cb52-40bd-ae6d-61c829502489",
"group": "admin"
},
{
"id": "f7557a5e-0d75-4357-bcab-2a74680f2890
"group": "svcacct"
}
]
},
{
"id\": "7100d085-3067-46c0-8f0b-945162f5e011",
"username": "bpaadmin",
"email_address": "bpaadmin@bizapps.cisco.com",
"first_name": "bpa",
"last_name": "admin",
"created_at": "2019-07-15T08:39:37.000Z",
"local_user": true,
"groups": [
{
"id": "1ef891d0-cb52-40bd-ae6d-61c829502489",
"group": "admin"
}
]
},
{
"id": "9ebfd385-f7c9-40f7-aa50-8c27d88a5c93",
"username": "svcmgr",
"email_address": "svcmgr@bizapps.cisco.com",
"first_name": "Service",
"last_name": "Manager",
"created_at": "2019-07-15T08:39:37.000Z",
"local_user": true,
"groups": [
{
"id": "340d0431-52c0-4f43-9214-2a6db989b865",
"group": "service-manager"
}
]
},
{
"id": "3be6eca7-bf5c-48d6-98fc-65208be59589",
"username": "devmgr",
"email_address": "devmgr@bizapps.cisco.com",
"first_name": "Device",
"last_name": "Manager",
"created_at": "2019-07-15T08:39:37.000Z",
"local_user": true,
"groups": [
{
"id": "cc5b9f7e-12dc-46ec-b31c-529d7671d073",
"group": "device-manager"
}
]
},
{
"id": "dcab8603-e763-4d5c-958b-d57e4bc7ee12",
"username": "demouser",
"email_address": "demouser@bizapps.cisco.com",
"first_name": "demo",
"last_name": "user",
"created_at": "2019-07-15T08:39:37.000Z",
"local_user": true,
"groups": []
}
]JSON路径示例：
- groups[x].group
- 结果内容："admin"、"workflow-admin"、"admin"、"admin"、"svcacct"、"admin"、"service-manager"、"device-manager"
- [0].last_name :
- 结果内容：“管理员”
将文件配置到网格和文件配置到存储
“文件到存储”组件可帮助您上载和访问BPA应用程序中的文件，“文件到网格”组件可帮助您上载文件并在网格上即时呈现该文件。
要以如下形式配置“文件到存储”组件：
- 编辑元素名称
- 选择下拉列表的Data Type。
将文件配置为网格组件：
- 创建Group或List组件。
- 在窗体中将文件添加到网格组件。
- 编辑Element Name并为下拉列表选择Data Type。
配置按钮
用户可以配置按钮组件，并为该按钮提供用户或组访问权。
要配置按钮组件，请执行以下操作：
- 编辑元素名称和信息。
- 从下拉列表中选择Button Type、Candidate Users和Candidate Groups。
克隆表单
克隆表单使用户可以复制表单的一部分或整个表单，从而节省时间使过程更简单。克隆方法执行一组匹配元素的副本，即，它根据为克隆选择的表单及其服务来复制匹配的元素。要自定义它，请参阅编辑表单。
要克隆表单，请执行以下操作：
- 选择要克隆的表单的克隆图标。“（创建/编辑）表单”窗口打开。
- 输入新表单的名称，然后单击保存。此时将显示表单的详细信息。
- 自定义详细信息并单击Save以保存克隆的表单。
导入和导出表单
此功能允许用户通过导入或导出表单创建表单作为备份，供将来使用。导出的表单以JSON格式存储。
删除表单
要删除表单，请执行以下操作：
- 选择特定表单上的Delete图标。系统将显示警告消息。
- 单击OK删除表单。
运行时窗体
在BPA中，各种应用程序使用运行时表单来捕获用户输入并执行操作。随着BPA 5.1的发布，新的交互式、用户友好的运行时格式UI被引入，旨在通过实现在所有部分的无缝导航来增强用户体验，并且仅在新的BPA UI中可用。
| 标注编号 | 描述 |
|---|---|
| 1 | 显示表单名称 |
| 2 | 扩展窗体层次结构的宽度 |
| 3 | 表示表单状态 |
| 4 | 上传:上传表单数据；接受JSON文件 |
| 5 | 下载：下载表单负载 |
| 6 | 基本：显示表单元素；不以分层格式显示 高级：以JSON格式显示表单数据 注意：用户可以更新基本和高级的输入。 |
| 7 | 显示全局级痕迹路径；选择痕迹会加载该窗体部分，包括右部分中的子元素 |
| 8 | 显示从表单名称开始的表单层次并列出所有子元素；与breadcrumb路径类似，该路径也可进行选择，并可将所选部分加载到右侧部分中 |
| 9 | 查看实际层次结构中的表单预览 |
| 10 | 表单显示的右侧部分；此视图根据选项卡选择而变化 |
| 11 | 可以拖动以调整窗体左右部分可见性的竖线 |
| 12 | 使用切换按钮在旧运行时表单或新运行时表单之间切换 |
在Preview模式下，表单以实际层次结构显示，每个级别都有一个Edit图标。
选择Exit图标以退出预览模式。
使用设备管理器应用程序
设备管理器应用允许您管理网络中的设备。
可以在设备管理器应用中执行以下操作：
要查看设备，请执行以下操作：
在主页上点击设备管理器应用程序。系统随即会显示Device Manager屏幕。
Device Manager页面上显示网络中设备的列表、设备的Name、IP Address、Port、身份验证组、NED类型和协议。为NSO和直接到设备控制器启用Add按钮。Sync RFS按钮仅对NSO控制器启用。
设备操作
BPA允许用户使用Device Actions（设备操作）菜单对设备执行多项操作。
要访问设置，请执行以下操作：
- 选中设备的复选框。
- 单击Device Actions。系统将显示下拉列表。
Device Actions下的选项列表因控制器类型而异。
Device Actions说明如下：
| 选项 | 描述 |
|---|---|
| ping | Ping用于排除故障、测试与设备的连通性并确定其响应时间。  |
| 连接 | Connect建立与所选设备的连接并返回连接状态。  |
| 获取主机密钥 | 获取主机密钥从所选设备获取主机密钥信息。  |
| 检查同步 | 选中Sync检查NSO CDB中的设备配置是否与设备上的运行配置同步。  |
| 比较配置 | 比较配置操作将NSO CDB中的配置与所选设备上的运行配置进行比较。  |
| 查看配置 | View Config（查看配置）允许您查看列表中一个或多个所选设备的配置。如果您已在列表中选择多个设备，请在View Config窗口中选择设备名称以查看其结果。  |
| 同步源 | Sync From同步配置，以使用设备的运行配置更新NSO CDB。  |
| 同步到 | 同步将NSO CDB中存储的配置与设备运行配置同步。  |
| 备份配置 | Backup Config（备份配置）提供了触发所选设备的按需备份的选项。用户可以选择用于备份的策略和可选标签来标识备份。仅当控制器类型支持备用配置时（当前为DCNM），备用配置才适用。
 |
| 发现设备 | 在主网格中选择的设备将被视为种子设备。BPA通过CDP neighbor命令使用设备发现。目前，BPA发现设备深度可达5。“深度”表示种子设备紧邻的设备层。 Discover devices页面显示已发现设备的列表以及有关IP地址、主机名、平台和软件版本的信息。要将设备添加到资产，请选择设备并点击将设备添加到资产。 |
添加设备
通过设备管理器添加设备仅适用于NSO和直接到设备控制器。
要添加新设备，请执行以下步骤：
- 点击Device Manager页面上的Add。Add Device窗口打开。
- 对于NSO控制器，请输入以下字段：
- 名称：输入设备的名称
- 端口:输入端口号
- 纬度:输入设备的地理纬度信息
- 经度:输入设备的纵向地理信息
- Authgroup:从下拉列表中选择要添加的设备的身份验证组
- 管理状态:从Admin State下拉列表中选择Admin State类型，以便添加设备
- 地址 :输入设备的IP地址
- 描述:输入要添加到网络的设备的说明
- 设备类型：从下拉列表中选择要添加的设备的设备类型
- 对于直接到设备控制器，请输入以下字段：
- 名称：设备的名称
- 地址 :设备的IP地址
- 端口:端口号
- 描述:要添加到网络的设备的说明
- 纬度:设备的地理纬度信息
- 经度:设备的纵向地理信息
- Authgroup:从设备的下拉列表中选择Authgroup
- 设备类型：选择设备类型（例如Cisco IOS、IOS-XR）。
- 协议:选择SSH或Telnet
- Jump服务器:跳转服务器的详细信息（例如，IP地址、身份验证组、协议和端口）
- 单击OK将设备添加到网络。
编辑设备详细信息
通过设备管理器编辑设备详细信息仅适用于NSO、Ansible和直接到设备控制器。
要编辑设备详细信息，请执行以下操作：
- 在Home页上单击Device Manager以查看设备列表并选择设备。
- 选择Edit图标。Edit Device窗口打开。
- 根据控制器类型编辑设备详细信息。
- 点击 确定，保存更改。
删除设备
只有NSO和直接到设备控制器支持通过设备管理器删除设备。
删除设备的步骤：
- 选择特定设备的Delete图标。系统将显示警告消息。
- 单击OK以删除设备。
导入设备
只有NSO控制器支持通过设备管理器导入设备。
要导入设备，请执行以下操作：
- 单击Upload，在本地系统中查找配置文件。
- 如果需要，请下载设备模板并使用该模板导入设备列表。有关设备模板的详细信息，请参阅下载设备模板。
下载设备模板
仅NSO控制器支持下载设备模板。
要下载设备模板，请执行以下操作：
- 单击 Download。创建具有所需字段的模板文件(csv)并将其保存到本地系统。
- 使用同步RFS同步RFS和设备。
查看备份历史记录
以下内容支持查看备份历史记录：
- NSO
- CNC
- 思科Catalyst中心
- DCNM
- NDFC
用户可以选择View Backup History图标以查看Backup页。此页提供可用于所选设备的备份配置的列表。
此页还提供所选设备的主要功能，如下所述。
查看备份配置
此页面显示备份存储中的设备配置。该页面还提供用于下载配置的选项。
比较配置
此选项将备份与当前运行配置或其他备份配置进行比较。
恢复配置
用户可以为任何备份选择Restore Config图标。这将打开一个包含相关详细信息的确认对话框。确认后，将执行与相应策略关联的还原工作流。
凭证
凭证页主要支持NSO和直接到设备控制器。
系统会为Cisco Catalyst Center和Ansible控制器显示从底层控制器获取的现有凭证的只读列表。没有选项可添加、更新或删除Cisco Catalyst Center、DCNM、Ansible和vManage控制器的凭证。
Credentials页面允许用户使用相关的SSH身份验证信息将本地用户映射到远程用户。
要访问凭证，请在Device Manager页面上选择Credentials。
可以执行以下操作：
- 添加新凭据
- 编辑凭证
- 从可用凭证列表中删除
添加凭证
仅NSO和直接到设备控制器支持添加凭证。
要添加凭证，请执行以下操作：
- 在Credentials页面上，单击Add。Add Auth Group窗口打开。
- 输入以下字段：
- 身份验证组名称
- 远程名称
- 设备用户名
- 所需的远程密码
- 所需的远程辅助密码
- 单击Save以添加身份验证组。
编辑凭证
仅NSO和直接到设备控制器支持编辑凭证。
- 选择Credentials选项卡。
- 选择凭证并选择编辑图标。Edit Auth Group窗口打开。
- 编辑默认映射的详细信息，然后单击保存。
- 如果需要，可通过在以下一个或多个选项卡中输入信息来添加umap:
- admin
- nsouser
- 操作员
- 从下拉列表中选择Remote Name
- 输入设备用户名
- 从下拉列表中选择Remote Password
- 输入所需的远程密码
- 输入所需的远程辅助密码
- 单击Save以添加umap。
删除凭证
仅NSO和直接到设备控制器支持删除凭证。
要删除设备的凭证，请执行以下操作：
- 在Credentials页面上，选择特定组的Delete图标。系统将显示警告消息。
- 单击OK删除该组。
设备组
NSO和Cisco Catalyst Center控制器主要支持Device Groups页面。
将显示从底层控制器获取的现有设备组的只读列表，用于DCNM和Ansible控制器。没有为DCNM、Ansible和vManage控制器添加、更新或删除设备组的选项。
Device Groups页面允许用户创建设备组并为其分配特定名称。用户可以对组执行不同的操作，这些操作将应用于该特定组中的所有设备。
要访问设备组，请执行以下操作：
- 在Device Manager应用程序中选择Device Groups页。
- 系统随即会显示Device Group页面，其中包含以下选项：
- 添加设备组
- 编辑设备组
- 删除设备
添加设备组
仅支持NSO控制器和Cisco Catalyst Center添加设备组。
添加设备组的步骤：
- 点击Device Group页面上的Add。Add Device Group窗口打开。
- 输入新组的名称，然后单击Save。
编辑设备组
仅NSO控制器和Cisco Catalyst Center支持编辑设备组。
- 选择Device Groups。
- 点击要编辑的特定组的Edit图标。将打开Edit Group Details窗口，其中显示所有可用设备的列表。
- 在左侧窗格中输入设备名称并添加或删除设备。
- 在右侧窗格中，选择要添加的组，然后单击Update。
配置备份作业
Configuration Backup Jobs页显示所有最新备份配置的列表。网格显示每台设备的一个条目，以及最新备份的状态。数据可以按控制器类型、控制器实例、备份状态以及日期范围进行过滤。默认情况下，网格显示过去两周的数据。
网格具有以下操作：
查看备份配置
此操作显示备份存储中的设备配置。也可选择下载配置。
比较配置
此选项将备份与当前运行配置或其他备份配置进行比较。
配置恢复作业
查看错误详细信息
如果还原工作流程因错误而停止，则会显示查看错误详细信息图标。
查看里程碑
通过里程碑图标可大致了解里程碑列表及其相应的状态。
查看工作流实例详细信息
网格中的最后一个图标交叉将用户启动到工作流应用程序中的工作流实例页面。这样，用户就可以向下钻取到工作流程执行详细信息。
查看和领款申请任务详细信息
如果恢复工作流实例在用户任务活动中等待，则会显示Task图标。选择该图标将打开一个对话框，其中包含与用户任务对应的表单详细信息和操作。
使用操作系统升级应用程序
OS Upgrade应用程序允许用户监控对网络中的设备执行的升级操作。
通过在Market Variance应用程序中创建Device Type来配置OS Upgrade的工作流程。“设备类型”(Device Type)选项可以为给定操作系统升级任务指定自定义表单和工作流程。可以通过点击OS升级应用程序中的创建订单来启动操作系统升级任务。在创建订单页面中，用户需要选择用于操作系统升级的设备。
可以根据选择过滤器选择设备，如下所示：
- 选择控制器类型:NSO或vManage
- 选择NSO（如果配置了多个NSO）
- 选择Region/Market或Device Group过滤器
- 如果所选过滤器是Region/Market，则其他选项(例如Region、Market和Device Type)可供选择
- 如果选择Device Group过滤器，则可以选择Device Group和Device Type的其他选项：
- 选择vManage（适用于vManage设备）
- 选择过滤器:vManage控制器实例
- 选择设备类型：vManage_Cpntroller
OS升级应用程序显示分组到活动工作流程和已完成工作流程中的所有可用流程实例的列表。
支持IOS和IOS-XR平台的操作系统升级。
- 从主页单击OS Upgrade。系统随即会显示Os Upgrade页面，其中包含以下选项卡：
- “活动”选项卡：显示工作流程中的所有活动进程实例以及所选设备的操作系统升级状态
- “已完成”选项卡：显示工作流程中的所有已完成流程实例
- 待处理选项卡：显示工作流程中的所有待定流程实例
- 单击Create Order。
- 选择NSO、选择Region、选择Market、选择Device Type和Devices。单击 Next。
- 输入自定义CR编号，如果需要，请立即或稍后计划时间。选择Schedule Type。
- 单击Create Order。
下面的数字1、2、3和4与上图中的图标相对应。
| 编号 | 描述 |
|---|---|
| 1 | 查看设备列表 |
| 2 | 查看汇总 |
| 3 | 下载摘要 |
| 4 | 查看任务列表 |
用户可以查看完整工作流程的摘要。所选设备的操作系统升级成功完成后，设备将显示在Completed选项卡中。
单击View Summary图标查看设备的操作系统升级摘要的概述，其中包括升级摘要的图形表示。
选择View Device List图标查看设备列表，选择Eye图标查看Evaluation Results和Task List。
选择Download Summary图标下载摘要。
选择View Task List图标以查看Task List、Debug View和Incident List。
根据需要暂停、恢复或停止事件。任何设备都安排在指定的日期或时间显示在待处理选项卡中。
使用配置验证程序应用程序
Config Validator应用程序允许用户根据NSO服务器中的网络元件驱动程序(NED)验证配置命令。使用此应用，用户可以选择NED并在它上运行命令以检查验证。用户还可以导出可与TAC共享的验证报告（如果需要）。
验证NED
要验证NED，请执行以下步骤：
- 单击主页上的配置验证器。系统随即会显示Config Validator页面。
- 从下拉列表中选择NSO > NED。这些是NSO网络中的NED，在其上执行命令以确定它们是否有效（例如 — Cisco-ios、Cisco-iosxr等）。 如果命令未列出，请联系TAC支持将命令支持扩展到NED。
- 从下拉列表中选择Version。
- 在命令字段中输入要验证的命令，例如：
- ip vrf ccs-auto-02
- 说明ccs-auto-02.com
- rd 20057:800294
- route-target export 20057:800200
- route-target import 20057:800200
- route-target export 13979:103104
新行以及后续行上的单空格或双空格对确保命令准确性非常重要。
- 单击Upload Config上传配置文件。这些文件采用.txt格式。
- 单击Validate Config运行命令。
- 如果需要，可通过单击导出导出输出结果。文件以.csv格式导出。
在验证阶段，BPA对给定命令执行验证并显示输出。
使用工作流程应用
Workflows（工作流程）应用程序提供运行实例、打开的任务、打开的事件、单个任务和组任务的概述。它还显示工作流程的状态。
- 从Home页中选择Workflows应用。
- Workflows页面显示正在运行的实例、打开的任务、打开的事件、单个已分配或已声明的任务以及组任务的数量。
查看任务
要申请任务或查看分配的任务，请执行以下操作：
- 选择任务选项卡以查看任务。
- 任务页面显示以下类别：
- 所有任务:显示分配给或可由用户申请的所有任务；列出所有组任务和所有未分配任务
- 我的任务:显示分配给用户或由用户声明的任务；默认情况下，已分配的任务显示在此类别中
- 我的组:显示所有组任务
- 要将任务分配给特定组，请使用Camunda建模器。组名称在BPA应用程序中创建。
- 使用Camunda工作流程模型的候选用户或候选组的属性指明哪些用户可以执行这些用户任务
- 未申请的任务:显示可以声明的未声明任务
- 每个任务显示其历史、图和说明。单击每个部分以显示详细信息。默认情况下显示任务历史记录。
- 选择Diagram图标以查看任务的图表。
Note图标允许用户声明任务。它仅对有权声明任务的用户可见。此权限使用以下规则确定：
- 当前用户应是此任务的候选用户组的一部分，或者当前用户应与此任务的候选用户相同
- 当前用户拥有用户组级别的权限视图
- 单击Description选项查看任务的说明。
- 单击My Groups和Unassigned部分以查看相应的任务。
- 要完成已申请或已分配的任务，请在我的任务列表中单击View Form。系统随即会显示UI Task。
- 进行必要的更改后，单击Complete。
- 在旧用户界面和新UI之间切换，查看树结构，然后展开或折叠参数。
- File to Storage组件帮助用户上载文件。随后可使用文件处理程序API访问上传的文件。
- 文件到网格组件有助于上传文件并根据匹配的密钥在容器或列表内呈现数据。
- 单击File to Grid，然后选择.csv文件，自动填充行。如果选择.txt文件，请提供分隔符。
- 单击File to Storage，然后选择存储的文件。复制链接或删除文件。
查看定义的工作流程
- 选择Defined Workflow选项卡以查看已定义的工作流程列表。这些工作流程用于设备的升级过程。用户可以在Defined Workflow（定义的工作流程）页面执行以下操作：
- 添加新工作流程
- 查看任何工作流程的图表
- 启动、编辑和删除BPMN工作流程
- 查看与工作流关联的实例及其状态
- 下载工作流的BPMN/DMN文件
数字1、2、3和4对应于上图中的图标并在下表中定义。当前没有编辑DMN文件的选项。
| 图标 | 描述 |
|---|---|
| 1 | 查看图表。图中的设置图标表示自动进程，用户图标表示手动进程。 |
| 2 | 编辑工作流程（仅适用于BPMN） |
| 3 | 删除工作流程 |
| 4 | 下载工作流的BPMN/DMN文件 |
- 为特定工作流程选择查看图以查看图。该图显示在不同的窗口中。用户必须确保上传特定工作流程的BPMN文件以查看图表。
- 选择Auto Save可在特定时间段后自动保存更改。
- 单击Download获取BPMN文件。
- 单击另存为草稿以将工作流另存为草稿。
- 单击Deploy将工作流添加到Camunda引擎。
- 单击Instances查看运行的实例数。此时将打开一个弹出窗口，显示实例及其详细信息的列表。
- 单击Start启动工作流。
- 要删除工作流程，请点击特定工作流程的Delete图标。系统将显示警告消息。单击OK以删除工作流。
- 要下载工作流程，请点击特定工作流程的下载图标。
添加工作流程
要添加已定义的工作流程，请执行以下步骤：
- 单击Create，选择工作流类型（例如，BPMN或DMN），然后输入Workflow Name和唯一Key。
- 单击Proceed。
如果在创建工作流程时选择了DMN，则可以创建DMN文件并显示以下屏幕：
- 要导入已定义的工作流程，请单击Import。系统随即会显示新建进程定义页面。
- 单击Choose Files以选择并上传文件。
- 单击Deploy上传单个文件，或单击Deploy All上传多个文件。
在部署期间，可以将工作流程分配到一个或多个组。
导入工作流程作为草稿
要将已定义的工作流导入为草稿，请执行以下操作：
- 单击导入为草稿。Upload Draft窗口打开。
- 单击Choose Files以选择并上传文件。
- 单击Save As Draft上传文件。
删除多个工作流程
要删除多个工作流程，请执行以下操作：
- 选中要删除的工作流程的复选框。要全选，请选中行顶部的空白复选框。Delete All按钮启用。
- 单击全部删除。系统随即会显示确认。
- 单击Ok以删除所选的工作流程。将打开Delete Workflows详细信息窗口。
在Camunda中执行脚本
BPA中的Camunda工作流引擎支持脚本与JSR-223兼容的脚本引擎实现。要使用脚本，需要在Camunda工作流程中添加脚本任务。
- 脚本任务有一个Script Type选项，允许值为Inline Script或External Resource。
- 如果选择Inline Script，则需要在Script字段中指定脚本代码。
- 如果选择External Resource，则需要为Resource字段指定外部脚本文件的路径。
- 要使任何外部脚本作为Camunda工作流程中的Resource路径可访问，BPA安装中必须包含以下配置选项。
cd /opt/bpa/data/camunda/external_scripts/ EX: cat hello.js // generating a random number var a = Math.random(); print(a); print(\"Hello World\"); - 将以下参数设置为true(/opt/bpa/ bpa-helm-chart-<.version>/vaules.yaml)
cisco-bpa-platform-cs-camunda: enableExternalScripts: true
查看工作流实例
Workflow Instances选项卡显示工作流程的所有运行实例。用户可以查看图来查看工作流的状态、暂停和停止工作流程。
- 点击Workflows页面顶部的Workflow Instances选项卡。系统随即会显示工作流程实例列表。
- Workflow Instances选项卡显示工作流实例的名称、开始日期、状态和任务的列表。
- 选择Diagram图标可在单独的窗口中查看工作流实例图。
- 选择Pause图标以暂停当前实例。此时将打开一个弹出窗口，以确认实例中的暂停。
- 单击Yes暂停，或单击No取消暂停。
- 可以使用Resume按钮从Workflow Instances页面恢复暂停的工作流程。
- 暂停的工作流程在实例列表中列为已暂停。
- 选择Stop图标以停止当前实例。此时将打开一个弹出窗口，确认停止实例。
- 单击Yes暂停，或单击No取消停止。
- 选择View Tasks图标以查看相关任务、调试视图和事件列表。
- Task List显示所有相关任务。调试视图显示调试输出。Incident List显示事件列表。选择Eye图标以查看Task List选项中的任务变量，并查看Debug View选项中的变量历史记录。
- 用户可以使用按钮暂停、恢复或停止工作流程。
- 对于失败的实例，用户可以使用重置图标重新启动工作流。
- 选择Restart Task From 。如果需要，请添加变量。
- 单击Add，输入Name，然后选择Data type，如果选择了除Boolean之外的其他类型，则输入该数据类型的值。使用Edit更改变量类型和值。
- 单击Restart > Proceed以重新启动工作流。
使用拓扑
拓扑服务提供了一种使用图形表示对网络和网络元素进行建模的方法。拓扑服务应用程序显示服务拓扑、网络拓扑和网络拓扑模板。用户可以编辑和删除拓扑模板，并创建模板表单或网络拓扑链接（在网络拓扑模板中可用）。
先决条件:
- 使用流程模板应用程序创建包含拓扑相关命令的模板。
- 将一个或多个拓扑特定模板与特定NED关联并构建网络拓扑链路，以填充数据库中的拓扑数据。
完成上述操作后，即可使用拓扑数据查看网络拓扑。
不同的拓扑选项包括：
服务拓扑
服务拓扑显示设备和服务实例之间的关系。如果NSO中的设备上定义了纬度/经度值，它还会显示地理图上的拓扑。
如果在NSO设置中启用了LSA，并且用户为NSO选择一个LSA节点，则会自动填充RFS节点，并要求用户选择RFS节点。
要查看设备的拓扑，请执行以下步骤：
- 从选择服务下拉列表中选择服务。
- 单击Select Service Instance从下拉列表中选择所选设备的实例。
- 选择Map图标以显示映射视图。纬度和经度是在地图上为服务实例获得准确定位结果的先决条件。
服务实例的位置显示在映射上。绿色表示服务，蓝色表示映射上的设备。
- 如果有任何选择错误，请单击Reset按钮。
- 点击服务实例。打开一个包含两个按钮的窗口：预览并获取修改。
- 单击Preview以查看服务实例详细信息。在Preview窗口中，用户可以以JSON格式下载服务实例。
- 单击Get Modifications查看此服务实例在设备上所做的修改。
网络拓扑
网络拓扑是通信网络的各种要素（例如链路、节点、设备等）的布局，可以充当发送方或接收方。网络拓扑是网络的拓扑结构，可以用物理或逻辑来描述。
此功能允许用户根据需要应用搜索过滤器来轻松查找设备。
- 单击Network Topology选项查看拓扑详细信息。
- 从下拉列表中选择Change Rule选项以过滤拓扑视图的设备。
- 输入所需的设备规则。
- 如果有任何选择错误，请单击Reset按钮。
- 选择Map图标以显示映射视图。该经纬度被预先设置，以实现地图上服务实例的精确定位结果。
- 单击图中所示的可用设备，将会打开一个包含两个选项的窗口：设备配置和设备预览。
- 单击Device Config以显示设备的配置列表。
- 单击Device Preview查看设备详细信息。用户可以查看有关设备的基本信息，如名称、地址、端口、说明、身份验证组、设备类型、终端ID、协议和管理状态。
- 选择所需的选项（例如Search、NED、Device Group、Devices）以查看相应的详细信息。示例如下所示：
使用市场差异
市场变量是可以跨BPA平台利用的参数化数据集。NTP服务器、日志记录服务器、SNMP服务器等区域特定数据可以按地区、市场和设备类型进行存储。参数化的值可在GCT、服务调配和工作流程中使用。
Market Variance应用程序中使用的构造包括：
- 地区:定义一个或多个市场所在的地区（例如，西南和中西部）
- 市场:定义区域内的特定市场
- 设备类型:将设备类型与全局和市场差异表单/数据关联（例如IOS-XR）
- 差异:为特定设备类型定义，可以是全球或市场差异
- 全球差异数据在市场和各个地区都很常见
- 市场差异数据特定于区域和市场
以下任务可以在Market Variance中执行：
- 添加、编辑、删除、下载和克隆市场或全局差异
- 管理设备类型
- 管理区域
- 管理市场
- 管理差异到服务/GCT方案的映射
添加市场或全局差异
要添加市场差异，请执行以下操作：
- 单击Variances选项卡，然后单击Add Market Variance。系统将显示Market Variance页面。
- 选择Device Type、Region和Market。
- Click Save.
要添加全局差异，请执行以下操作：
- 选择Variances选项卡，然后单击Add Global Variance。系统随即会显示Global Variance页面。
- 选择Device Type，然后单击Save。
只有在用户在添加差异之前添加了Device Type、Region和Market时，用户才能创建市场或全局差异。
编辑市场和全局差异
要编辑市场差异，请选择Edit图标更改市场差异，然后单击Update。
要编辑全局差异，请选择Edit图标对全局差异进行更改，然后单击Update。
只有在用户在添加差异之前添加了Device Type、Region和Market时，他们才能创建市场或全局差异。
克隆市场差异
只有市场差异才支持克隆。选择复制图标，然后从“复制市场差异”窗口选择区域和市场。
下载或删除超差
- 选择下载图标以获取JSON格式的市场数据。
- 选择Delete图标以删除超差。
添加设备类型
设备类型可标识设备的类型，以及允许使用这些差异的相关全球或市场差异表单和应用。这些表单必须使用Form Builder构建。有关详细信息，请参阅使用Form Builder应用程序。
- 选择Device Type选项卡，然后单击Add Device Type。系统随即会显示Device Type页面。
- 输入Device Type Name，选择Global Variance Form和一个或多个Market Variance Form。
- 从Tags下拉列表中选择所需的标记。
- 如果选择Use In Device Activation，请选择Device Activation Form和Device Activation Workflow。
- 如果选中Use In OS Upgrade，请选择OS Upgrade Form和OS Upgrade Workflow。
- 如果选中Use In Pre-Post，请选择Pre-Post Form和Pre-Post Workflow。
- 如果要使用工作流的最新版本，请选择Latest。
- Click Save.
编辑和删除设备类型
- 选择Edit图标并进行所需的更改。
- Click Save.
- 选择Delete图标以删除超差。
添加和编辑区域
- 选择Regions选项卡，然后单击Add Region。Region窗口打开。
- 输入Region Name和Region Code。
- Click Save.
- 选择Edit图标并进行所需的更改。
- Click Save.
添加和编辑市场
- 选择Markets选项卡，然后单击Add Market，将打开Market窗口。
- 输入Market Name、Market Code，然后选择Region。
- Click Save.
- 选择Edit图标并进行所需的更改。
- Click Save.
将映射添加到超差
- 选择Mapping选项卡，然后单击Add Mapping。系统随即会显示添加映射页面。
- 输入Name并选择Source和Template。
- 单击Preview。如果模板为Service Schema，则选择NSO。
- 选择Global Variances和Market Variances。
- 将表单参数映射到服务架构或GCT模板参数，然后单击Save。
控制器模板变量映射
控制器数据映射功能可减少在应用配置等配置更新期间所需的手动工作。例如，如果用户要配置数百台设备，并且已预定义变量的配置，则用户可以使用控制器数据映射在应用配置期间启用配置的自动填充。
控制器模板变量映射可在Market Variance下找到。
选中Controller_Template_Variable复选框并选择Edit图标。
添加配置
有两种添加配置的方法。
手动添加配置
- 展开控制器模板变量映射标题。
- 单击Add List。将打开Add New List Item窗口，其中必须添加在应用配置期间用于自动填充的值。
下载和上传配置模板
要使用配置映射，必须下载现有配置模板。
- 选中Controller_Template_Variable复选框并选择Download图标。
示例格式如下。
[ { "status": true, "data": { "type": "globalvariance", "id": "63c157cd3f74a400270d1d96", "deviceType": "Controller_Template_Variable_Mapping", "forms": { "Controller_Template_Variable_Mapping": { "controller-template-variable-mapping": [ { "templateName": "temp_cEdge_8000", "siteId": "204", "variableName": "Interface Name(sit_vpn_10_interface)", "variableValue": "Gi 1/0/1" }, { "templateName": "BPA_tmp_C8000v_Device_Template_Ver2.0", "variableName": "Address(vpn_next_hop_ip_address_0)", "variableValue": "address-from-mv", "siteId": "1225" } ] } }, "newRegionCode": "", "deviceTypeId": "63c157cd3e9dfc008f70c709" } } ] - 更新templateName、siteId和variableName变量。
- 上传文件，以便Market Variance可以保存更新后的值。
要上传配置模板，请执行以下操作：
- 单击Upload。
- 导航到已更新的配置模板，然后单击Open。
上传过程完成后，在应用配置过程中应用配置，模板名称和siteID匹配；然后，Apply Config会自动填充Market Variance中的值。
为SD-WAN使用案例添加vManage控制器
要启用SD-WAN使用案例，应在默认区域中的vManage实例中设置主设备。
添加或配置全局管理员时，需要将具有全局管理员的用户组映射到默认区域。此外，全局管理员组（即，global-admin）应与其他国家/地区管理员区域进行映射。
例如，有一个名为Global的用户可以访问vManage master实例。在本例中，global-admin创建为一个组，而全局用户映射到global-admin组。此全局管理员组应分配有配置主vManager实例的默认区域。
例如，必须为亚洲和欧洲配置国家/地区管理员。在本例中，创建了asia-admin-group和europe-admin-group。需要添加各个用户并将其与各个组进行映射。需要创建两个新区域（例如，vmanage-asia-zone、vmanage-europe-zone），且之前创建的组（例如，asia-admin-group、europe-admin-group）需要映射到这些区域。asia-admin-group映射到asia-zone，europe-admin-group映射到europe-group。此外，全局国家/地区管理员映射到这些区域，以便全局管理员可以查看所有辅助vManage实例中的设备或模板。
当添加新的辅助控制器时，辅助控制器应映射到各个区域。例如，如果添加vmanage-asia实例，则实例应与asia-zone进行映射。
使用适配器生成器
适配器生成器启用由内部和外部服务提供商提供的调用API。它可以链接API调用并使用内部BPA资源在API调用之间转换数据。
适配器生成器功能包括：
- 用于与外部系统建立API连接的无代码方法
- 一种配置驱动的方法，用于构建Camunda元素模板，可以灵活配置多种身份验证机制，如基本身份验证、承载令牌和API密钥
- 利用Swagger文件或从头开始配置终端
- 指定每个终端的重试和超时参数以有效处理错误场景
- 构建适用于所有用途的元素模板（使用无身份验证机制）
- 从一台服务器下载适配器并无缝上传到另一台服务器
- 利用BPA的内置Script Runner功能构建请求和进程响应负载
- 一个公共Git存储库，用于存储所有可用的适配器。各交付团队和客户可以访问此存储库下载适配器，然后将同一适配器上传到他们的BPA安装中。Git存储库还包含每个适配器的其他文件，例如Readme.md、Postman集合和Camunda工作流程，用于演示如何使用该适配器
适配器库
Adapter Library选项卡列出了现有的适配器。
从适配器库，用户可以执行以下操作：
- 通过创建和上传自述文件收集信息
- 快速查看适配器功能
- 编辑适配器
- 将适配器详细信息下载为JSON文件
- 删除一个或多个适配器
管理凭证
Manage Credentials选项卡定义身份验证机制。提供以下身份验证机制：
- 承载令牌
- API密钥
- 基本身份验证
- 无身份验证
- OAuth令牌
承载令牌
对静态JSON Web令牌(JWT)执行以下操作：
- 输入凭证名称。
- 在Bearer Token下选择以下单选按钮之一：
- 静态JWT
- 动态JWT
- 根据管理员输入请求报头密钥。
- 根据用户使用特殊字符输入值。
- 输入实际JWT值。
- 点击保存凭证。
- 新凭证将添加到Manage Credentials（管理凭证）选项卡上的凭证列表的顶部。
- 选择Edit图标进行更改。
动态JWT是一个两步过程，包括更多功能：
- POST
- GET
- 管理员设置
- 手动输入
- 目标服务器
- 不同的服务器
- 用户名
- 密码
- 用于生成JWT的URL
- 从响应获取JWT
对动态JWT执行以下操作：
- 单击How to access credentials? 下的Admin Settings。
- 输入所需信息。建议输入已存储在BPA中的凭证。这也可以通过点击手动输入手动完成，必须输入用户名和密码。
- 输入来自BPA Postman的路径查询（即JWT），以及用户名和密码，以备复杂的数据转换时使用。
- 输入基本路径URL。
- 应输入请求报头密钥名称和值，如下所示：
- 信息可以通过密钥、值、JSON正文和URL编码形式传递。
API密钥
应该为API密钥输入以下数据：
- API密钥
- 价值
- 作为报头或查询参数的API密钥
基本身份验证
提供用户名和密码。
无身份验证
API可以直接完成。
OAuth令牌
此过程分为三步，需要两台服务器：oauth服务器和资源服务器。其执行方式如下：
- API调用1到OAuth服务器以生成OAuth令牌。
- API调用2到资源服务器，以生成JWT令牌。
- 对外部系统的实际API调用。
构建您自己的适配器
Build Your own Adapter选项卡用于创建新适配器。
要构建适配器，请执行以下操作：
- 输入适配器名称、版本、说明、轮询频率、重试次数和API超时。
- 如果外部系统中存在一个或多个服务器，则可以使用目标服务器配置这些服务器。在Configure target servers部分中，输入Host、Port、Base Path和Credentials。
- 选择Add图标以添加目标服务器。
- 输入所有条目后，单击Next。系统将显示新页面，其中配置了终端。
如果选择Expand图标，则会显示终端的单个详细信息。
- 单击下一步以提示新页面。
- 单击Save Changes将相应的适配器保存到数据库。
关于适配器生成器
关于适配器生成器选项卡提供适配器生成的文档。
路径查询
此页面允许用户构建JSONata路径查询，并使用输入JSON对象/数组对其进行验证。该页面提供响应，允许用户验证查询构建是否正确。
执行以下操作：
- 在左侧面板中输入JSON数据。
- 在右侧输入Path Query。
- 评估BPA应用中的输出，而不是引用其他门户。
使用提交管理器
“提交管理器”应用程序提供使用NSO提交队列的功能。提交管理器支持禁用或启用全局提交队列以及查看提交队列中的项目的功能。提交管理器支持NSO功能来锁定、解锁、修剪、删除提交队列项目等。用户可以基于标签回滚服务。
用户可以执行以下任务：
- 查看提交队列中的项目
- 设置全局选项
- 设置特定于项目的操作
- 基于标签的回滚
全局选项
执行以下操作以设置全局选项：
- 在Home屏幕上选择Commit Manger磁贴。系统将显示Commit Manager页面。
- 从选择NSO列表中选择NSO。将显示Running commit Queue。
- 单击完成查看完成的队列。
- 单击Global Options对提交队列执行全局配置。下表对每个选项都提供了详细说明。
| 选项 | 操作 |
|---|---|
| 锁定设备 | 将活动队列项添加到提交队列。任何影响进入commit-queue的相同设备的队列项都等待解锁或删除此锁定项。 |
| 清除队列 | 清除整个队列。执行此操作后，提交队列中存在的所有设备均不同步。建议不要在正常使用情况下执行此操作。 |
| 修剪设备 | 从提交队列中的所有队列项中删除所有指定的设备。执行此操作后，受影响的设备不同步。不会修剪当前提交到的设备。 |
| 设置原子 | 设置所有队列项的原子行为。如果设置为false，则当队列中其他非原子队列项前面的相同设备完成时，这些队列项中包含的设备可以开始执行。如果设置为true，则保留这些队列项的原子完整性。 |
| 默认启用 | 默认情况下为此NSO启用提交队列。 |
项目选项
选择所需项目，然后从操作下拉列表中选择操作。下表介绍了操作。
| 选项 | 操作 |
|---|---|
| 锁定 | 锁定现有队列项。锁定的队列项在解除锁定之前无法开始执行。 |
| 解锁 | 解除锁定队列项的锁定。将忽略解锁未锁定的队列项目。 |
| 修剪 | 从队列项中修剪指定的设备。不会修剪当前提交到的设备。 |
| 设置原子 | 设置队列项的原子行为。如果设置为false，则当队列中其他非原子队列项前面的相同设备完成时，此队列项中包含的设备可以开始执行。如果设置为true，则保留队列项的原子完整性。 |
| DELETE | 从队列中删除队列项。如果其他队列项目正在等待删除的项目，则会自动开始运行。如果已删除队列项目的设备尚未开始执行，则这些设备在执行操作后不同步。 |
选择Commit Manager页面上的View图标以查看项目详细信息。
回滚
在回滚选项卡上执行以下任务：
- 根据标签预览回滚。
- 基于标签回滚。
- 选中一个或多个“回滚”的复选框，然后单击回滚。如果需要选择性回滚，请选中Selective复选框。
- 选中回滚复选框，然后点击预览回滚。预览以本地、CLI或XML格式显示。如果需要选择性预览回滚，请选中Selective复选框。
可以从选择NSO下拉列表选择所需的NSO。对于回滚，Selective选项仅用于回滚特定提交。如果未选中Selective复选框，则会回滚之前的所有提交。
- 单击Rollback旁边的Config按钮，选择标签，然后单击Commit开始回滚。或者，选择Preview Rollback旁边的Config按钮，并选择标签以查看提交 — 干运行。
使用Script Runner应用程序
Script Runner应用程序允许用户运行Python和Ansible脚本。
- 从主页选择Script Runner图块。系统随即会显示Scripts页面。用户可以添加新脚本并执行以下操作：
- 运行：执行脚本
- 查看:查看脚本
- 编辑:对脚本进行任何更改
- DELETE :删除脚本
- 下载:获取该脚本的副本
以下数字与上图所示的图标相对应。
| 编号 | 描述 |
|---|---|
| 1 | 运行脚本 |
| 2 | 查看脚本 |
| 3 | 编辑脚本 |
| 4 | 删除脚本 |
| 5 | 下载脚本 |
执行选项卡显示脚本的状态。
- 单击 Add。
- 输入Key，从下拉列表中选择Type，输入Name和Script。
- Click Save.
用户可以在执行选项卡上查看状态，并通过选择操作列中的眼睛图标来检查日志。
元素模板
BPA支持从工作流程调用的常见任务的自定义元素模板。可以从工作流程应用中的集成建模器访问它们，也可以作为外部建模器的包下载。
本节列出所有支持的BPA元素模板。元素模板分为两类，如下所示：
- 基于服务任务的模板
- 基于用户任务的模板
基于服务任务的模板如下所示。
分析差异
- 目的:此元素模板支持分析比较模板的执行，通常用于生成前/后差异
- 参数:
- 分析模板ID:已在BPA中创建的分析模板的标识符
- 预检查执行ID:预检查执行标识符通常是在工作流程执行期间捕获的
- 后检查执行ID:检查后执行标识符通常是在工作流程执行期间捕获的
分析多重差异
- 目的:此元素模板支持执行多个分析差异模板，通常用于生成前/后差异
- 参数:
- 负载:要传递的负载，用于执行多个分析比较模板
- 负载示例:
{ "deviceList":[ { "deviceName":"iosxr1", "templateId":"migration-template", "variablesMap":{ "port_type":"TenGigE", "port_number":"0/2" } } ] }
创建Service commit试运行
- 目的:此元素模板支持NSO服务实例的commit dry run输出执行
- 参数:
- 负载:要传递的负载，用于执行NSO服务实例的commit dry run
- 负载示例:
{ "create":[ { "prefix-set-service:prefix-set-service":[ { "name":"pre-test", "prefix-set":[ ] } ] } ], "delete":[ ] }
创建服务实例
- 目的:此元素模板支持在NSO中提交服务实例
- 参数:
- 负载:要传递的负载，用于执行NSO服务实例的提交
- 负载示例:
{ "create":[ { "prefix-set-service:prefix-set-service":[ { "name":"pre-test", "prefix-set":[ ] } ] } ], "delete":[ ] }
执行模板
- 目的:此元素模板执行具有完整负载的流程模板
- 参数:
- 设备名称：设备的名称
- 模板ID:在BPA中创建的流程模板ID
执行命令模板
- 目的:此元素模板执行具有完整负载的流程模板
- 参数:
- 负载:执行命令模板时要传递的负载
- 负载示例:
{ "deviceName":"11.1.1.1", "templateId":"test2735", "commandList":[ { "command":"show version", "isConfigMode":false, "goToStepOnPass":"", "goToStepOnFail":"", "passExpr":"", "rules":[ ] } ] }
GCT试运行
- 目的:此元素模板支持GCT试运行
- 参数:
- 模板名:创建的GCT模板的名称
- 版本:创建的GCT模板的版本号
- 设备:用于干运行的设备
- 变量:自定义变量（如果有）
GCT提交
- 目的:此元素模板支持提交GCT
- 参数:
- 模板名:创建的GCT模板的名称
- 版本:创建的GCT模板的版本号
- 设备:用于干运行的设备
- 变量:自定义变量（如果有）
创建设备
- 目的:此元素模板用于载入设备
- 参数:
- 负载:创建设备时要传递的负载
- 负载示例:
[ { "address":"100.1.4.5", "admin-state":"unlocked", "authgroup":"default", "description":"", "latitude":"", "longitude":"", "device-type":"netconf", "name":"3.0.1.2", "ned-id":"lsa-netconf", "port":"8080", "protocol":"" } ]
获取主机密钥
- 目的:此元素模板获取设备的主机密钥
- 参数:
- 设备名称：要获取主机密钥的设备名称
设备同步源
- 目的:此元素模板对设备执行设备同步操作
- 参数:
- 设备名称：要执行与NSO同步的设备名称
连接到设备
- 目的:此元素模板连接到特定设备
- 参数:
- 设备名称：要执行与NSO同步的设备名称
创建设备组
- 目的:此元素模板在NSO中创建设备组
- 参数:
- 名称：组的名称
- 设备名称：要添加的设备名称
- 设备组:设备应添加到的设备组
发送邮件
- 目的:此元素模板支持发送电子邮件
- 参数:
- 接收方:接收人的邮件ID
- 主题：邮件主题
- 邮件文本：邮件内容
高级发送邮件
- 目的:此元素模板从BPA发送邮件
- 参数:
- 负载:从BPA发送邮件时要传递的负载
- 负载示例:
{ "to": "receiver@xyz.com", "subject": "Mail Subject", "text": "Mail Text" }
创建票证
- 目的:此元素模板将创建票证
- 参数:
- 票证实例名称:在BPA管理设置中提供的票证实例的名称
- 负载:更新票证实例的有效负载
外部任务模板
- 目的:此元素模板可避免在Camunda BPMN引擎中保留HTTP连接
- 参数:
- 重试:重试HTTP请求的次数
- 超时：HTTP请求超时分钟数
- URL:HTTP或HTTPS URL请求
- 方法:HTTP方法（例如GET、POST、DELETE）
- 负载:POST的HTTP负载
- 标头：HTTP请求报头
更新票证
- 目的:此元素模板更新票证
- 参数:
- 票证实例名称:在BPA管理设置中提供的票证实例的名称
- 票证ID:要更新的唯一票证ID
- 负载:更新票证实例的有效负载
创建通知
- 目的:此元素模板在BPA中创建通知
- 参数:
- 分类:通知类别
- 严重级别:Info、success、error、warning（信息的默认值）
- Title:通知标题
- 描述:通知的说明
- 用户名：通知的授权用户
- 组:要授权通知的组
- 应用密钥:通知的应用密钥
- 启用通知密钥:用于启用通知键烤面包机的布尔值
创建高级通知
- 目的:此元素模板通过传递负载在BPA中创建通知
- 参数:
- 负载:为创建通知而传递的负载
[ { "category":"nso.device.added", "severity":"error", "user":"admin", "payload":{ "title":"New device added", "description":"10.1.1.1 managed successfully at NSO1" }, "_options":{ "toaster":true } } ]
- 负载:为创建通知而传递的负载
基于用户任务的模板如下所示：
表单生成器任务
- 描述:用于查看表单运行时间的用户任务
- 组件类型:运行时窗体组件
- 输入参数:
- 服务表单名称
- 表单按钮
查看提交试运行任务
- 描述:查看提交干运行输出的用户任务
- 组件类型:提交试运行组件
- 输入参数:
- 表单按钮
- 有效载荷
命令模板任务
- 描述:查看命令模板执行的用户任务
- 组件类型:输出视图组件
- 输入参数:
- 表单按钮
- 执行输出Id
查看比较任务
- 描述:查看差异执行的用户任务
- 组件类型:比较视图组件
- 输入参数:
- 差异ID
- 表单按钮
操作系统升级任务 — 说明:用于执行操作系统升级操作的用户任务 — 组件类型:OS升级对话框组件 — 输入参数: — 表单按钮 — 负载
操作系统升级设备详细信息任务
- 描述:用于显示操作系统升级设备详细信息的用户任务
- 组件类型:OS升级设备详细信息组件
- 输入参数:
- 工作流程输入ID
- 表单按钮
UI性能改进
要提高UI性能，网格中的数据默认根据创建和修改日期显示一周的数据。如果用户想要获取较旧的数据，他们可以更改起始日期和至日期字段。
日期过滤器在以下应用程序中实施。
- 表单生成器
- 操作系统升级
- 流程模板
- GCT
- 设备激活
- 服务目录
- 售前
- 报告
- 脚本运行者
应用于工作流和服务目录的永久过滤器
如果用户在工作流或服务目录中执行特定过滤器后，导航至不同的选项卡或站点，过滤器将一直存在，直到用户从会话中注销。
以下操作可以应用于工作流程和服务目录中的持久性过滤器：
- 搜索
- 起始和结束日期筛选器
- 表过滤器
- 列字段排序
- 分页
工作流程
选项卡：任务、定义的工作流、工作流实例
- 搜索和表过滤器
- 列字段排序
- 起始和终止日期过滤器和分页
服务目录
选项卡：服务、活动服务、订单历史记录
以下操作在服务目录中应用了永久过滤器。
- 搜索
- 起始和至日期筛选器
- 表过滤器
- 列字段排序
- 分页
- 搜索和表过滤器
使用调度程序
“计划”选项卡
Schedules选项卡列出应用程序处理的所有计划，并包括根据时间范围过滤的选项。默认情况下，会显示过去两周的时间表。
用户还可以添加、编辑、删除、导入和导出计划。
用户还可以选择查看每个计划到目前为止发生的所有触发器。
添加和编辑计划
“添加和编辑调度”页具有以下字段：
- 计划名称:计划的名称； 必须唯一。
- 触发器类型:对于此版本，仅支持基于Kafka消息的触发器。
- 描述:计划的可选说明
- 切换以启用或禁用计划。
- 详细信息部分:
- 主题名称 :计划触发消息应发布到的卡夫卡主题名称。
- 主题消息:必须发布到卡夫卡主题的JSON消息
- 计划详情:通用计划程序组件UI，其中包括用于选择计划开始日期/时间的日历。
- “安排重复”部分：可选部分，用于通过UI字段选择循环或提供cron模式。
故障排除
访问ELK Kibana控制面板
要打开ELK Kibana控制面板，请执行以下操作：
- 将浏览器指向端口5601(例如http://localhost:5601)，启动Kibana网络界面。
- 将localhost替换为Kibana主机/ BPA服务器IP地址的名称。
- 使用ELK/Kibana帐户凭证登录。焦点指向基巴纳。
- 使用Elastic超级用户（例如admin）登录。
- 如果在创建集群时未提供密码，请重置密码。
- 在username字段中输入“admin”。
- 输入密码。
- 单击登录。用户被重定向到ELK主页。
要更改控制面板中显示的默认行数（最多10,000），请执行以下操作：
- 打开主菜单，然后选择Stack Management > Advanced Settings。
- 滚动或搜索设置行数。
- 更改要显示的行数，然后单击Save changes。
应用Kibana搜索和Kibana过滤器
Kibana发现
连接到Kibana时，用户将被重定向到Discover页面。此页显示所有ELK堆栈的最新日志。用户可以过滤日志，根据Search Queries查找特定日志消息，并使用Time Filter将搜索结果缩小到特定时间范围。
Kibana Discover包括以下内容：
- 搜索栏：直接在主导航菜单下，用于搜索特定字段或整个消息
- 时间过滤器：右上角（时钟图标），用于根据各种相对和绝对时间范围过滤日志
- 字段选择器：左侧，搜索栏下方，用于选择要在日志视图中修改和显示的字段
- 日期直方图：搜索栏下方的条形图，显示所有日志的计数和基于搜索和时间过滤器的时间（x轴）；用户可以点击条形图，或点击并拖动以缩小时间过滤器的范围
- 日志视图：右下角，用于查看单个日志消息和显示按字段过滤的日志数据；如果未选择任何字段，将显示整个日志消息
Kibana过滤
为了帮助用户进行搜索，Kibana包含一个过滤对话框，提供对主视图中显示的数据的简单过滤。
要使用对话框，请在搜索框下单击Add a filter +，然后尝试使用条件。过滤器可以固定到Discover页面，使用自定义标签命名，启用或禁用，并反向。
Kibana查询语言(KQL)和Lucene
在早期版本中，查询Kibana的唯一方法是使用Lucene语法。在版本6.2中，Kuery（现在称为KQL）可用于改善搜索体验。
自7.0版起，KQL是查询基巴纳的缺省语言，但用户可以恢复到Lucene。
Kibana搜索
在Elasticsearch中搜索特定日志消息或这些消息中的字符串是Kibana的基础。在最新版本中，对搜索执行方式进行了改进和更改。
默认情况下，用户现在使用称为KQL（Kibana查询语言）的新查询语言搜索其数据。习惯于以前方法（使用Lucene）的用户也可以选择这样做。
Kibana查询本身就是一门艺术，用户可以使用各种方法对您的数据执行搜索。以下是一些最常见的搜索类型：
自由文本搜索
- 自由文本搜索在所有字段内工作，包括源字段（包括所有其他字段）。如果搜索中没有指定特定字段，则对所有要分析的字段执行搜索。
- 在Discover页面顶部的搜索字段中，运行这些搜索并检查结果（将控制面板右上角的时间参数设置为过去一个月以捕获更多数据）：
- 分类
- 分类
- 类别
- cat*
- 类别？ry
- “分类”
- 类别/运行状况
- "类别/运行状况"
- 铬
- 合唱*
- 自由文本搜索提示：
- 不区分大小写:文本搜索不区分大小写。将文本置于双引号("")中可返回完全匹配的结果（例如，[category/health]和["category/health"]可返回不同的结果）。
- 通配符符号和搜索Kibana通配符搜索:用户可以输入[*]来表示任意数量的字符，或输入[?]来仅表示一个字符。
字段级搜索
- 使用以下格式的字段级别查询用于查找特定字段内的数据：<fieldname>：搜索
- 运行以下搜索以查看结果（某些搜索故意不返回任何结果）：
- 名称：chrome
- 名称：Chrome
- 名称：Chr*
- 响应：200
- 字节：65
- 字节：[65到*]
- 字节：[65 - 99]
- 字节：{65到99}
- _exists_：名称
- 现场级搜索提示
- 字段类型依赖项字段级别的搜索取决于字段类型。(对于Logz.io用户，默认情况下不分析任何字段，这表明Logz.io中的搜索区分大小写（与自由文本搜索不同），不能使用通配符搜索（同样，与自由文本搜索不同）。 将所有字段保存为“未分析”是为了节省索引中的空间，因为数据在名为“*_source*”的分析字段中重复
- review搜索范围用户可以使用方括号搜索字段中的范围。[ ]表示结果包含在内。{}表示结果为独占。
- _exists_使用_exists_前缀作为字段可搜索文档，以查看是否存在该字段。
- 大写和范围使用范围时，遵循非常严格的格式，并且使用大写字母指定范围。
逻辑语句
- 在搜索中使用逻辑语句的方式如下：
- 美国和Firefox
- 美国或Firefox
- （美国和Firefox）或Windows
- — 美国
- ！美国
- +美国
- 非美国
- 逻辑语句提示
- 用户应使用适当的格式（如大写字母）来定义AND或OR之类的逻辑术语
- 用户可以使用括号来定义复杂的逻辑语句
- 用户可以使用 — ,!NOT用于定义负值项
- Kibana特殊字符所有特殊字符都需要正确转义。以下是所有可用特殊字符的列表：+ - && || !(){ } [ ] ^ " ~ * ?:
邻近搜索
- 邻近搜索是Kibana的一个高级功能，它利用Lucene查询语言。
- [categovi~2]表示搜索[categovi]中两个更改范围内的所有术语。这意味着所有类别都匹配。
- 邻近搜索提示
- 邻近搜索使用许多系统资源，并且通常在Elasticsearch中触发内部断路器。需要过多内存才能运行的搜索可能不会返回结果。
- 有关搜索类型的提示和最佳实践列表，请参阅以下内容：
- 使用自由文本搜索快速搜索特定字符串。使用双引号("string")查找完全匹配项（例如，"USA"）。
- 使用星号通配符符号替换任意数量的字符，使用问号通配符符号仅替换一个字符。
- 使用_exists_前缀作为字段以搜索具有该字段的日志（例如_exists_:response）。
- 用户可以搜索字段中的范围（例如，使用方括号，这意味着结果包含在内）。使用花括号表示结果不包括在内)。
- 在搜索中使用逻辑语句（如AND、OR、TO）时，请使用大写字母。示例：答复：[400至500]
- 使用 — ,!并且不定义负面的术语（例如，response:[400至500] NOT response:404）。
- 近邻搜索可用于搜索特定字符近邻内的检索词。例如，[categovi~2]将搜索[categovi]中两个更改范围内的所有术语。近距离搜索使用大量资源 — 明智使用！
- 未分析字段的字段级搜索与自由文本搜索的工作方式不同。
- 示例：如果字段值为Error — 搜索字段：*rror不会返回正确的答案
- 如果用户未指定逻辑运算符，则默认运算符为OR。
- 示例：搜索错误例外运行搜索错误或例外
- 使用前导通配符是一个非常昂贵的查询，应尽可能避免使用。
在Kibana控制面板中写入查询
要在Kibana控制面板中写入查询以访问BPA设备日志，请执行以下操作：
- 打开主菜单并选择分析 > 发现。BPA特定日志显示在ELK门户的Discover页面中。
确认bpalogs*索引模式已按如下方式选中：
- 有关所有设备操作、PT和GCT特定日志，请参阅以下映像。
Kibana搜索和Kibana过滤器引用
有关Kibana的更多信息，请参阅以下参考资料：
日志记录问题
如果用户无法使用有效凭证登录，系统管理员可以确定以下可能问题之一：
- 微型服务容器可能未启动或有错误。
- Postgres数据库可能已关闭或连接中可能存在问题。
联系系统管理员，并检查服务器上的各种docker特定命令。
一般问题
问题：Services下拉列表中未显示任何服务。这通常在以下情况下发生：第一次登录
解决方案：导航到Admin部分并单击“Sync Services Schema”（同步服务架构）应用。它显示针对NSO服务器中每个可用服务的同步成功或错误消息。
问题：门户无法与NSO服务器通信。
解决方案：导航到Admin > Settings > NSO部分连接设置详细信息，并检查是否更新了正确的详细信息。
问题：在Service Manager中进行的更改不会反映。
解决方案：
- 在Service Manager UI中单击Commit必须将在Service Manager中完成的任何更改提交到NSO服务器。
- 确保更改并使用Commit Dry-Run进行审阅，然后单击Commit保存更改。
- 所做的更改特定于当前登录会话。如果您不点击Commit而注销，则必须重新进行更改。
问题：无论命令输出如何，命令模板执行都会将总体结果返回为true。
解决方案：
- 打开Process Templates应用程序并找到模板名称。
- 选择Edit图标并在屏幕上查看详细信息。
- 检查是否为模板设置了Pass Criteria值。如果将其留空，则默认情况下执行结果假设为真，并且不检查基础命令输出结果来确定整体结果。
BPA使用案例
修订历史记录
| 版本 | 发布日期 | 备注 |
|---|---|---|
1.0 |
24-Sep-2025
|
初始版本 |
反馈
