動的ランブックのインストール

事前定義済みのランブックに加えて、オンライン診断システム (ODS) 機能はランタイムで NSX をデバッグする動的ランブックもサポートします。

動的ランブックは NSX リリースに依存せず、いつでもインストールできます。動的ランブックは、次の問題に対処します。

事前定義されたランブックの開発とメンテナンスは、NSX リリースサイクルに従うので、リリースサイクル間のライブサイトで発生する問題のデバッグはできません。動的ランブックは、いつでも開発してインストールできるため、リリースサイクル間にデバッグ要件を実装できます。
部分的に NSX をアップグレードすると、ランブックとそれを呼び出す API の間に互換性がない可能性があります。たとえば、統合アプライアンス (UA) をアップグレードせずにトランスポートノードをアップグレードすると、アップグレードによってトランスポートノードに新しいバージョンのランブックがインストールされます。この場合、API が古くなっている可能性があるため、UA は古い API を使用して新しいバージョンのランブックを呼び出せなくなる可能性があります。

動的ランブックを作成できるのは VMware チームのみです。システムにインストールするためにダウンロードできます。ランブックはデータのバックアップとリストアをサポートしていません。

動的ランブックをインストールするには、動的ランブックインスタンスと呼ばれるグループを定義する必要があります。動的ランブックインスタンスは、ランブックをインストールするすべてのインストールノードグループを定義します。新しいノードがグループに追加されると、ランブックが新しいノードに自動的にインストールされます。

NSX 4.2 では、次のランブックをダウンロードできます。ランブックの詳細については、VMware の Web サイト https://support.broadcom.com/group/ecx/downloads からパッケージをダウンロードします。

表 1.
ランブック	説明
Hyperbus ランブック	動的 Hyperbus ランブックは、次の Hyperbus の問題を確認し、修正の提案を提供できます。 Hyperbus 接続 Hyperbus 接続の構成 vmknic Hyperbus 接続の状態このランブックは、vif-id を入力引数として使用します。

動的ランブックをインストールするには、次の手順を実行します。

前提条件

VMware の Web サイト https://support.broadcom.com/group/ecx/downloads から動的パッケージをダウンロードします。

手順

インストールノードグループに含めるトランスポートノードのパスを取得します。
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>