除了预定义的操作手册外,联机诊断系统 (ODS) 功能还支持动态操作手册,以用于在运行时调试 NSX。
由于动态操作手册不依赖于 NSX 版本,因此您可以随时安装动态操作手册。动态操作手册解决了以下问题:
- 由于预定义操作手册的开发和维护遵循 NSX 发布周期,因此无法在发布周期之间对实时站点上出现的问题进行调试。而有了动态操作手册,便可以在发布周期之间实施任何调试要求,因为动态操作手册可以随时开发和安装。
- 如果只是部分升级 NSX,则操作手册与调用该操作的 API 可能不兼容。例如,您升级了传输节点,但没有升级 Unified Appliance (UA),并且升级会在传输节点上安装新版本的操作手册。在这种情况下,UA 可能无法使用较旧的 API 调用较新版本的操作手册,因为该 API 可能已过时。
只有 VMware 团队才能创建动态操作手册,但您可以下载动态操作手册,以便将其安装到您的系统。请注意,操作手册不支持数据备份和还原。
要安装动态操作手册,您需要定义一个名为动态操作手册实例的组。动态操作手册实例将定义要安装操作手册的所有安装节点组。如果向组添加新节点,则操作手册将自动安装在新节点上。
对于 NSX 4.2,可以下载以下操作手册。有关操作手册的详细信息,请从以下 VMware 站点下载软件包:https://support.broadcom.com/group/ecx/downloads。
表 1.
操作手册 |
描述 |
Hyperbus 操作手册 |
动态 Hyperbus 操作手册可以检查以下 Hyperbus 问题,并提供修复建议:
- Hyperbus 连接
- Hyperbus 连接的配置
- vmknic
- Hyperbus 连接的状态
此操作手册将 vif-id 作为输入参数。 |
要安装动态操作手册,请执行以下步骤:
过程
- 获取要包含在安装节点组中的传输节点的路径。
GET https://10.180.85.179/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes
- 创建安装节点组。该组可以是策略组、传输节点组或 UA 节点组。
PATCH https://<nsx-mgr>/policy/api/v1/infra/domains/default/groups/<group-name>
{
"expression":
[
{
"paths": [
"/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1"
],
"resource_type": "PathExpression"
}
],
"extended_expression": [],
"reference": false,
"group_type": [],
"resource_type": "Group"
}
- 创建包含所有安装节点组的动态操作手册实例。
POST https://{{MANAGER_IP}}/policy/api/v1/infra/sha/dynamic-runbook-instances/<dynamic-instanace-id>
{
"applied_to_group_paths": [
"/infra/domains/default/groups/TNGroup1" [Policy Group with node path]
],
"applied_to_nodes": [
"1e6314a2-a268-4a3a-bcae-4f23b2536ea8" [The node id can be a host/edge/UA node id]
],
"applied_to_all_appliances": true [All UA cluster]
}
- 将操作手册软件包上载到动态操作手册实例。
POST https://{{MANAGER_IP}}/policy/api/v1/infra/sha/dynamic-runbook-instances/<dynamic-instanace-id>/file
动态操作手册数据将应用于指定了此组的目标节点。
- 查询安装状态。
GET https://10.180.85.179/policy/api/v1/infra/sha/dynamic-runbook-instances/<dynamic-instanace-id>/state
{
"runbook_name": "Example",
"management_state": "INSTALL_FINISHED",
"install_state": [
{
"node_id": "084583fa-3ae7-4d0c-98f1-6fc4cb5044b1",
"node_name": "TN301",
"version": {
"major": 1,
"minor": 0
},
"status": "INSTALL_FINISHED"
}
}
- 使用以下 API 检查已安装操作手册的详细信息。
GET https://{{MANAGER_IP}}/policy/api/v1/infra/sha/dynamic-runbooks
- 使用主题 在运行时调试 NSX 中所述的步骤调用操作手册。
下一步做什么
要将动态操作手册实例扩展到其他节点,请运行以下 API。
PATCH https://10.180.85.179/policy/api/v1/infra/sha/dynamic-runbook-instances/<dynamic-instanace-id>
{
"applied_to_group_paths":["/infra/domains/default/groups/<tn-group-name>"],
"applied_to_nodes":["<target-edge-id>","<target-ua-id>"]
}
要卸载操作手册,请运行以下 API。
DELETE https://10.180.85.179/policy/api/v1/infra/sha/dynamic-runbook-instances/<dynamic-instanace-id>/file
要卸载动态操作手册实例,请运行以下 API。
DELETE https://10.180.85.179/policy/api/v1/infra/sha/dynamic-runbook-instances/<dynamic-instanace-id>