Cisco SD-WAN Manager は RESTful（Representational State Transfer）API をサポートしており、Cisco Catalyst SD-WAN オーバーレイネットワークとネットワーク内のデバイスに関するリアルタイムの静的情報を取得したり、デバイス構成テンプレートやその他の構成関連情報をアップロードしたりするための呼び出しを実行できます。RESTful API を使用して、Cisco SD-WAN Manager と対話するためのカスタムポータルを設計できます。

Cisco SD-WAN Manager API ドキュメントは、Cisco SD-WAN Manager ソフトウェアの一部として、URL：https:// vmanage-ip-address/apidocs で提供されます。（より正確には、完全な URL には Cisco SD-WAN Manager のポート番号 https://vmanage-ip-address:8443/apidocs が含まれます）vmanage-ip-address は、Cisco SD-WAN Manager サーバーの IP アドレスです。

API 呼び出しは、次のカテゴリの操作に対して提供されます。

• 証明書の管理

• 設定

• デバイスとデバイスインベントリ

• モニターリング

• リアルタイム モニタリング

• トラブルシューティング ツール

REST API を使用した NAT 構成はサポートされていません。

（注）	Cisco SD-WAN リリース 20.6.1 以降、Cisco SD-WAN Manager では以下の API 制限がサポートされます。 API レート制限：100/秒 Bulk API レート制限：48/分 API のリアルタイム監視では CPU が集中的に使用されるため、トラブルシューティングの目的でのみ使用してください。デバイスのアクティブな監視のために継続的に使用しないでください。

API 呼び出しのグループごとに、[Show/Hide] をクリックして、個々の呼び出しと各呼び出しの URL を一覧表示します。各呼び出しには、その応答クラス、必要なパラメータ、および応答メッセージ（ステータスコード）が表示されます。

[Try It Out] をクリックして、各 API 呼び出しのリクエスト URL と応答本文の形式を表示します。リクエスト URL は、Cisco SD-WAN Manager の URL とそれに続く /dataservice で構成されます。例：https://10.0.1.32:8443/dataservice/device/interface/statistics/ge0/0?deviceId=172.16.255.11

以下に、API 呼び出しに使用する URL の例を示します。

ここでは、特定の場所で vEdge ルータを交換する方法について説明します。これは、vEdge ルータが完全に故障した場合や、ルータのコンポーネント（いずれかの電源装置など）が故障した場合に、ルータ全体を交換するために実行できます。 

大まかに言うと、vEdge ルータを交換する手順は、削除するルータから新しいルータに構成をコピーし、その新しいルータをネットワークに配置するだけです。

Cisco SD-WAN Manager の vEdge ルータを交換する前に、Cisco SD-WAN Manager が交換用 vEdge ルータのシャーシ番号とシリアル番号を学習しておく必要があります。

• 交換用 vEdge ルータが、以前に受け取ったルータ（スペアインベントリに含まれるルータなど）である場合は、以前にシリアル番号ファイルを Cisco SD-WAN Manager にアップロードしたときに、Cisco SD-WAN Manager がルータのシャーシ番号とシリアル番号をすでに学習しています。

• RMA プロセスを開始して、交換用の新しいルータを受け取った場合は、更新されたバージョンの vEdge 認定シリアル番号ファイルを Cisco SD-WAN Manager にアップロードする必要があります。

故障したルータを、Cisco SD-WAN Manager を使用して交換するには、次の手順を実行します。

1. 故障したルータから交換用ルータに構成をコピーします。

2. 故障したルータを無効にします。ルータを無効にすると、その証明書が非アクティブ化され、ルータがオーバーレイネットワークから削除されます。

3. 交換用ルータを検証して、その証明書をアクティブにします。

新しいルータは、故障したルータの完全な代替品となり、その構成は故障したルータと同じになります（ただし、各ルータは証明書に一意のシャーシ番号と一意のシリアル番号を持つことに注意してください）。故障したルータから交換用ルータに構成をコピーすると、両方のルータの構成は、IP アドレスを含めて同じになります。同じ IP アドレスを持つ 2 つのルータがネットワーク内に同時に存在することはできません。Cisco SD-WAN Manager で一方のルータが有効状態である場合はもう一方のルータが無効状態である必要があり、そうでなければ両方のルータが無効状態である必要があります。

はじめる前に

認定シリアル番号ファイルが Cisco SD-WAN Manager にアップロードされていることを確認してください。

故障したルータから交換用ルータへの構成のコピー

Cisco SD-WAN Manager で、故障した vEdge ルータから交換用ルータに構成をコピーします。

構成のコピー元の vEdge ルータとしては、オーバーレイネットワークでアクティブなデバイス（つまり、有効状態のデバイス）でも非アクティブなデバイス（つまり、無効状態のデバイス）でも使用できます。たとえば、2 つの電源装置の一方が故障したルータを交換する場合、そのルータはネットワーク内でまだアクティブである可能性がありますが、完全に故障したルータを交換する場合は、そのルータをネットワークから削除するために、すでに無効としてマークされている可能性があります。

構成のコピー先の vEdge ルータは無効状態である必要があります。

vEdge ルータの状態を確認したり有効/無効状態を変更するには、「Validate or Invalidate a vEdge Router」を参照してください。

故障したルータから交換用ルータに構成をコピーするには、次の手順を実行します。

1. Cisco SD-WAN Manager メニューから、[Configuration] > [Devices] の順に選択します。

2. 故障したルータについて、[...] をクリックし、[Copy Configuration] を選択します。

3. [Copy Configuration] ウィンドウで、交換用ルータを選択します。

4. [Update] をクリックします。

故障したルータを削除します

1. Cisco SD-WAN Manager メニューから、[Configuration] > [Certificates] の順に選択します。

2. 故障したルータについて、[Validate] 列で、[Invalid] をクリックします。

3. [OK] をクリックして、デバイスの無効化を確認します。

4. [Send to Controllers] をクリックします。

交換用ルータの追加

1. Cisco SD-WAN Manager メニューから、[Configuration] > [Certificates] の順に選択します。

2. 交換用ルータについて、[Validate] 列で、[Valid] をクリックします。

3. [OK] をクリックして、デバイスの有効化を確認します。

4. [Send to Controllers] をクリックします。

ネットワーク内の別のルータと同じ IP アドレスを持つルータを検証しようとすると、エラーメッセージが表示され、検証プロセスが終了します。

リリース情報

リリース 15.4 で Cisco SD-WAN Manager に導入されました。

デバイスが完全に故障した場合、またはデバイスのコンポーネント（電源装置の 1 つなど）が故障した場合は、Cisco IOS XE Catalyst SD-WAN デバイス を交換することがあります。

一般に、Cisco IOS XE Catalyst SD-WAN デバイス を別のデバイスと交換するには、取り外すデバイスから新しいデバイスに構成をコピーしてから、新しいデバイスをネットワークに追加します。

A. 交換するデバイスの構成をコピーする

1. Cisco SD-WAN Manager メニューから、[Configuration] > [Devices]の順に選択します。

2. デバイスのリストで、交換するデバイスを見つけます。デバイスの行で [...] をクリックし、[Running Configuration] を選択します。

   （注）	Cisco SD-WAN Manager がデバイスに到達できない場合は、手順 4 にスキップして、デバイスに直接ログインして構成情報をコピーする手順を実行します。

3. 構成のテキストをコピーして、テキストエディタに貼り付けます。

   構成情報は、新しい交換用デバイスのオンボーディングに手動展開方式を選択した場合に特に役立ちます。

4. Cisco SD-WAN Manager がデバイスに到達できない場合は、デバイスに直接ログインし、デバイスで次のコマンドを使用して構成情報を表示します。出力から構成情報をコピーします。

   • 実行コンフィギュレーションを表示し、出力をテキストファイルに保存します。

     show running-config | redirect bootflash:sdwan/ios.cli

   • SD-WAN の実行コンフィギュレーションを表示し、出力をテキストファイルに保存します。

     show sdwan running-config | redirect bootflash:sdwan/sdwan.cli

B. オーバーレイネットワークからデバイスを削除する

1. Cisco SD-WAN Manager のメニューから[Configuration] > [Certificates]の順に選択します。

2. デバイスのリストで、交換するデバイスを見つけます。デバイスの行の [Validate] 列で、[Invalid]、[OK] の順にクリックします。

   （注）	この手順により、デバイスの制御接続がすべて失われます。

3. [Send to Controllers] をクリックします。

4. Cisco SD-WAN Manager メニューから、[Configuration] > [Devices]の順に選択します。

5. デバイスのリストで、交換するデバイスを見つけます。デバイスの行で […] をクリックし、[Delete WAN Edge] を選択します。

C. 交換用デバイスを Cisco SD-WAN Manager インベントリに追加する

1. 交換用デバイスのシャーシ番号とシリアル番号を取得します。

   （注）	デバイスで show sdwan certificate serial コマンドを使用して、各番号を表示できます。

2. 『Cisco Catalyst SD-WAN Getting Started Guide』で説明されているいずれかの方法を使用して、新しいデバイスをインベントリに追加します。

   （注）	新しいデバイスをインベントリに追加する方法は、一般的にデバイスのオンボーディングに関連した方法です。それらは、デバイスの交換に固有の方法ではありません。

D. 交換されるデバイスに適用されたテンプレートと同じデバイステンプレートを使用して、新しいデバイスにデバイステンプレートを適用する

1. Cisco SD-WAN Manager メニューから、[Configuration] > [Templates] の順に選択します。

2. 交換するデバイスに使用されていたテンプレートの行で、[…] をクリックし、[Export CSV] を選択します。CSV ファイルには、テンプレートが添付されている各デバイスのパラメータが表示されます。

3. エクスポートされた CSV ファイルを確認します。

   • 新しいデバイスが交換されるデバイスと同一である場合、CSV ファイルのパラメータを更新する必要はありません。

   • 新しいデバイスが交換されるデバイスと同一でない場合、必要に応じて、新しいデバイスに一致するように CSV ファイルのパラメータ値を更新できます。たとえば、交換用デバイスで、交換されるデバイスとは異なるインターフェイスの番号付けが使用されている場合は、インターフェイスの番号付けを指定するパラメータを更新できます。

4. テンプレートを交換用デバイスに添付するには、次の手順を実行します。

   1. Cisco SD-WAN Manager メニューから、[Configuration] > [Templates] の順に選択します。

   2. [Device Template] をクリックします。

      （注）	Cisco vManage リリース 20.7.x 以前のリリースでは、[Device Templates] は [Device] と呼ばれます。

   3. 交換されるデバイスに使用されていたテンプレートの行で、[…] をクリックし、[Attach Devices] を選択します。

   4. [Attach Devices] ウィンドウで、交換用デバイスを [Selected Devices] ペインに移動し、[Attach] をクリックします。

   5. 必要に応じて、次のいずれかの方法を使用して、テンプレートをデバイスに適用する前にテンプレートのパラメータを更新できます。

      • 交換用デバイスの行で […] をクリックし、[Edit Device Template] を選択します。必要に応じてパラメータを編集します。

      • ダウンロードして編集した CSV ファイルをアップロードして、交換用デバイスのパラメータを更新します。CSV ファイルをアップロードするには、[Upload]（上矢印ボタン）をクリックして、CSV ファイルに移動します。

E. 新しいデバイスをオンボードする

次のいずれかの方法を使用して、新しいデバイスをオンボードします。

（注）	新しいデバイスをインベントリにオンボーディングする方法は、一般的にデバイスのオンボーディングに関連した方法です。それらは、デバイスの交換に固有の方法ではありません。

• プラグ アンド プレイ（PnP）

  詳細については、『Cisco Catalyst SD-WAN Getting Started Guide』の「Plug and Play Onboarding Workflow」セクションと、『Cisco Catalyst SD-WAN: WAN Edge Onboarding』ガイドを参照してください。

• Bootstrap

  詳細については、『Cisco Catalyst SD-WAN Getting Started Guide』の「Non-PnP Onboarding」セクションと、『Cisco Catalyst SD-WAN: WAN Edge Onboarding』を参照してください。

• 手動展開

  （注）	新しいデバイスを構成する際には、前述のパート A で保存した構成ファイルを使用できます。

  （注）	手動展開方法では、新しいデバイス用のルート認証局（CA）をインストールする必要があります。

  詳細については、『Cisco Catalyst SD-WAN: WAN Edge Onboarding』を参照してください。

  ルート CA のインストールについては、『Cisco Catalyst SD-WAN Getting Started Guide』の「Enterprise Certificates」セクションを参照してください。

　1 つ以上の Cisco SD-WAN Manager サーバーから次の操作を並行して実行できます。

• Cisco SD-WAN Manager メニューから[Maintenance] > [Software Upgrade]の順に選択して、次の操作を行います。

  • デバイスのソフトウェアイメージをアップグレードします。

  • デバイスのソフトウェアイメージをアクティブ化します。

  • デバイスからソフトウェアイメージを削除します。

  • ソフトウェアイメージをデバイスのデフォルトイメージに設定します。

• Cisco SD-WAN Manager メニューから[Maintenance] > [Device Reboot]の順に選択して、デバイスを再起動します。

• Cisco SD-WAN Manager メニューから[Configuration] > [Templates]の順に選択して、テンプレートを管理します。

  • デバイスをデバイステンプレートにアタッチします。

  • デバイステンプレートからデバイスをデタッチします。

  • デバイスがアタッチされているデバイステンプレートの変数値を変更します。

テンプレート操作には、次のルールが適用されます。

• デバイステンプレートがデバイスに既にアタッチされている場合は、その機能テンプレートの 1 つを変更できます。[Update] > [Configure Devices]をクリックすると、他のすべてのテンプレート操作（デバイスのアタッチ、デバイスのデタッチ、デバイス値の編集など）は、更新操作が完了するまで、すべての Cisco SD-WAN Manager サーバーでロックされます。つまり、更新が完了するまで、別の Cisco SD-WAN Manager サーバー上のユーザーはテンプレート操作を実行できません。

• 1 つまたは複数の Cisco SD-WAN Manager サーバーから、さまざまなデバイスでデバイステンプレートのアタッチおよびデタッチ操作を同時に実行できます。ただし、これらの操作のいずれかが 1 つの Cisco SD-WAN Manager サーバーで進行中の場合、アタッチまたはデタッチ操作が完了するまで、どのサーバーの機能テンプレートも編集できません。