サードパーティのカスタムアプリケーションと Cisco Catalyst SD-WAN の統合

サードパーティのカスタムアプリケーションと Cisco Catalyst SD-WAN の統合

表 1. 機能の履歴

機能名

リリース情報

機能説明

サードパーティのカスタムアプリケーションとの統合

Cisco IOS XE Catalyst SD-WAN リリース 17.16.1a

Cisco Catalyst SD-WAN Manager リリース 20.16.1

Cisco SD-WAN Manager では、サードパーティが開発した Cisco IOx アプリケーションとの統合がサポートされています。こうしたカスタムアプリケーションによって、Cisco IOS XE Catalyst SD-WAN ソフトウェアを実行するデバイスに機能が追加されます。

Cisco Catalyst SD-WAN とサードパーティのカスタムアプリケーションの統合に関する情報

Cisco SD-WAN Manager では、サードパーティが開発した Cisco IOx アプリケーションとの統合がサポートされています。これらはカスタムアプリケーションと呼ばれ、Cisco IOS XE Catalyst SD-WAN ソフトウェアを実行するデバイスに機能を追加します。

接続

Cisco IOx アプリケーションは、Docker コンテナ内のデバイスで動作します。このアプリケーションには、次のような他のデータソースやコンポーネントへの接続設定が組み込まれている場合と、組み込まれていない場合があります。

仮想ポート グループ インターフェイス

サードパーティが開発したカスタムアプリケーションにネットワーク要件がある場合、Cisco SD-WAN Manager では可用性に基づいて、11 ～ 22 の範囲で仮想ポートグループ（VPG）インターフェイスが使用されます。特定の VPG インターフェイスを予約する必要はありません。

サードパーティのカスタムアプリケーションとの統合でサポートされるプラットフォーム

表 2. サポートされるプラットフォーム

プラットフォーム シリーズ

モデル

サポート対象の最低バージョン

Cisco Catalyst IR1100 高耐久性シリーズ ルータ

Cisco Catalyst IR1101

Cisco IOS XE Catalyst SD-WAN リリース 17.16.1a

Cisco Catalyst SD-WAN 制御コンポーネントリリース 20.16.1

Cisco Catalyst IR1800 高耐久性シリーズ ルータ

Cisco Catalyst IR1821

Cisco Catalyst IR1831

Cisco Catalyst IR1833

Cisco Catalyst IR1835

Cisco IOS XE Catalyst SD-WAN リリース 17.16.1a

Cisco Catalyst SD-WAN 制御コンポーネントリリース 20.16.1

サードパーティのカスタムアプリケーションとの統合における前提条件

リソース要件

サードパーティが開発したカスタムアプリケーションで必要とされる CPU、メモリ、ストレージリソースが各デバイスに備わっていることを確認します。リソース要件は、カスタムアプリケーションの詳細によって全く異なります。

デバイスでの Cisco IOx のアクティブ化

サードパーティのカスタムアプリケーションをインストールする前に、デバイスで Cisco IOx をアクティブ化します。デバイスでの Cisco IOx のアクティブ化を参照してください。

サードパーティのカスタムアプリケーションとの統合に関するガイドライン

サードパーティのカスタムアプリケーションとの統合に関する制約事項

アップグレードの制限事項

Cisco SD-WAN Manager は、カスタムアプリケーションのアップグレードをサポートしていません。新しいバージョンにアップグレードするには、現在のバージョンをアンインストールしてから、新しいバージョンのアプリケーションをインストールします。サードパーティのカスタムアプリケーションのアンインストールを参照してください。

アプリケーションの再起動

Cisco SD-WAN Manager では、サードパーティが開発したカスタムアプリケーションを再起動できません。

サードパーティのカスタムアプリケーションとの統合の設定（概要）

手順

ステップ 1

デバイスでの Cisco IOx のアクティブ化

ステップ 2

カスタムアプリケーションを追加した設定グループプロファイルの作成

ステップ 3

設定グループへのカスタムアプリケーション機能の追加

ステップ 4

カスタムアプリケーション機能を追加した設定グループの展開

次のタスク

設定手順が完了すると、デバイスで実行されているアプリケーションのアクティビティをモニターできます。デバイスでサードパーティのカスタムアプリケーションをモニターするを参照してください。

デバイスでの Cisco IOx のアクティブ化

この手順を実行すると、サードパーティのカスタム Cisco IOx アプリケーションを実行するために必要なデバイスで Cisco IOx がアクティブ化されます。

手順

ステップ 1

CLI アドオンプロファイルを使用して設定グループを作成します。

ステップ 2

CLI アドオンプロファイルに iox コマンドを含めて、Cisco IOx をアクティブ化します。 

iox

ステップ 3

『Cisco Catalyst SD-WAN Configuration Groups』の「standard configuration group deployment procedure」[英語] に従って、サードパーティのカスタム Cisco IOx アプリケーションをインストールする前に、デバイスに設定グループを展開します。

カスタムアプリケーションを追加した設定グループプロファイルの作成

サードパーティが開発するのは独自のカスタムアプリケーションであるため、Cisco SD-WAN Manager は共通の標準規格と照らし合わせて設定を検証できません。アプリケーションが正常に動作するように、アプリケーションの要件に従ってここでパラメータを設定してください。

始める前に

[Configuration] > [Configuration Groups]ページで、

  • [SD-WAN] または

  • [SD-Routing]

をソリューションタイプとして選択します。

手順

ステップ 1

Cisco SD-WAN Manager のメニューから、[Configuration] > [Configuration Groups] を選択します。

ステップ 2

その他のプロファイルでカスタムアプリケーション機能を作成して設定します。

  1. この機能の名前と説明を入力します。

    表 3. 名前と説明

    フィールド

    説明

    Name

    機能の名前。

    Description

    任意で説明を追加します。

  2. 基本設定は必須です。

    表 4. 基本設定

    フィールド

    説明

    Application Name

    カスタムアプリケーションの名前を入力します。大文字または小文字を使用できますが、スペースや特殊文字は使用できません。

    この名前は、[Monitor] > [Logs] > [Events]ページでイベント詳細の一部として表示されます。

    Virtual Image

    ドロップダウンリストからカスタムアプリケーションのイメージファイルを選択します。

    このリストには、[Maintenance] > [Software Repository] > [Virtual Images]で仮想イメージのリポジトリにアップロードしたカスタムアプリケーションのイメージが表示されます。

  3. カスタムアプリケーションにネットワーク設定の要件がある場合は、[Add Configuration] をクリックして、ネットワーク接続の詳細を最大 3 つ入力します。アプリケーションがサーバーと通信する場合、これにより Cisco IOx アプリケーションと

    • アプリケーションが動作しているデバイスや

    • サーバーなどの任意の外部アセット間の通信が設定されます。

    SD-WAN ソリューションのオプションは次のとおりです。

    表 5. ネットワークの設定、SD-WAN ソリューション

    フィールド

    説明

    Name

    接続を設定するエンティティを説明する名前。

    Service VPN

    アプリケーションと（a）デバイスまたは（b）外部アセット間を接続するサービス VPN。

    VPG IP Address

    カスタムアプリケーションとデバイスの仮想ポートグループ（VPG）インターフェイスまたは外部アセット間の通信用に、[Subnet Mask] フィールドで定義したサブネットマスク内の IP アドレスを入力します。

    Application IP Address

    デバイスの VPG インターフェイスにマッピングするために、カスタムアプリケーションに割り当てる IP アドレス。

    Subnet Mask

    VPG インターフェイスのサブネットマスク。サブネットマスクは、カスタムアプリケーションとデバイス VPG インターフェイスまたは外部アセット間の通信用に、サービス VPN のアドレス空間を定義します。

    Action

    行の削除オプションを指定します。

    SD-Routing ソリューションのオプションは次のとおりです。

    表 6. ネットワークの設定、SD-Routing ソリューション

    フィールド

    説明

    Network Configuration

    Name

    接続を設定するエンティティを説明する名前。

    Communication Interface

    アプリケーションと（a）デバイスまたは（b）外部アセット間を接続する物理または仮想インターフェイス。

    Action

    行の削除オプションを指定します。

  4. 一部のカスタムアプリケーションでは、情報をグローバル変数またはデバイス固有の変数として渡す必要があります。変数を追加するには、[Add Variable] をクリックして詳細を入力します。

    キーと値の有効なペアは、カスタムアプリケーションの仕様に完全に依存します。変数の設定については、カスタムアプリケーションのデペロッパーにお問い合わせください。これらの値では大文字と小文字が区別されます。

    変数の最大数：10

    表 7. 環境変数

    フィールド

    説明

    Key

    変数のキー名。

    Value

    変数の値各デバイスに固有のキー値を指定するには、[Device Specific] を選択します。

    Action

    行の削除オプションを指定します。

  5. 一部のカスタムアプリケーションでは、シリアルインターフェイスを介して提供されるデータ入力が使用されます。このオプションは、プラットフォームで使用可能な任意のシリアルポートをサポートします。

    データソースを追加するには、[Add Data Source] をクリックし、シリアルポートを入力します。

    シリアルポートの最大数：7

    表 8. データ設定

    フィールド

    説明

    Serial Line

    デバイスで使用可能なシリアルポートを入力します。シリアルポートの詳細については、プラットフォームのマニュアルを参照してください。

    例：/dev/ttySerial

    Action

    行の削除オプションを指定します。

次のタスク

「Deploy a configuration group」[英語] も参照してください。

設定グループへのカスタムアプリケーション機能の追加

手順

ステップ 1

Cisco SD-WAN Manager のメニューから、[Configuration] > [Configuration Groups] を選択します。

ステップ 2

[solution] ドロップダウンリストで、

  • [SD-WAN] または

  • [SD-Routing]

をソリューションタイプとして選択し、このソリューションの設定グループのみを表示します。

ステップ 3

[Configuration Groups] タブをクリックします。

ステップ 4

設定グループを作成する必要がある場合は、『Cisco Catalyst SD-WAN Configuration Groups』の「Using Configuration Groups」[英語] で説明されている手順に従います。

ステップ 5

既存の設定グループの場合は、[Add Profile] をクリックして、設定グループに [Other Profile] を追加します。

ステップ 6

設定グループで [Other Profile] ドロップダウンリストを見つけて、カスタム アプリケーション プロファイルを選択します。

カスタムアプリケーション機能を追加した設定グループの展開

始める前に

カスタムアプリケーション機能を追加した設定グループを展開する前に、サードパーティのカスタムアプリケーションとの統合でサポートされるプラットフォームを参照してください。

設定グループを展開する前に、デバイスで Cisco IOx をアクティブ化します。デバイスでの Cisco IOx のアクティブ化を参照してください。

手順

ステップ 1

『Cisco Catalyst SD-WAN Configuration Groups』の「standard configuration group deployment procedure」[英語] に従って、ネットワーク内のデバイスに設定グループを展開します。

ステップ 2

SD-WAN ソリューションタイプのデバイスに展開する場合は、展開時にルータごとに該当するデバイス固有の変数を入力します。

ステップ 3

デバイスにアプリケーションをインストールする際に進行状況をモニターするには、インストールのログメッセージを表示します。

  1. 右上近くにあるタスクリストボタンをクリックします。

  2. [Deploy configuration group] タスクをクリックします。

    この操作により、各デバイスに関する展開の進行状況を示すページが開きます。

  3. デバイスの横にある [Action] 列のログアイコンをクリックします。

    [View Logs] ペインが開き、そのデバイスに関する展開の進行状況が表示されます。展開が完了すると、「Config Group successfully deployed to device,」といった成功メッセージがログに表示されます。

    カスタムアプリケーション機能を追加した設定グループをはじめてデバイスに展開すると、デバイスでアプリケーションのインストールがトリガーされます。

CLI を使用してサードパーティのカスタムアプリケーションがデバイスで動作していることを確認する

この検証方法は、SD-WAN または SD-Routing ソリューションのデバイスに適用できます。

始める前に

カスタムアプリケーション機能を追加した設定グループを 1 つ以上のデバイスに展開します。カスタムアプリケーション機能を追加した設定グループの展開を参照してください。

手順

ステップ 1

Cisco IOx アプリケーションを実行しているデバイスで、次のコマンドを実行します。

Device# show iox-service

ステップ 2

前のステップのコマンドの出力に基づいて、次のいずれかを実行します。

  • コマンド出力に IOxman サービスが実行中であることが示されている場合は、次の手順に進みます。

  • コマンド出力に IOxman サービスが実行中でないと表示される場合は、Cisco IOx アプリケーションが正しく動作していないことを示します。アプリケーションを再インストールします。カスタムアプリケーション機能を追加した設定グループの展開を参照してください。

ステップ 3

同じデバイスで、次のコマンドを実行します。確認しているアプリケーションが実行中の状態がであると出力に表示される場合は、そのアプリケーションが正常に動作していることを示します。

Device# show app-hosting detail appid application-id

例

カスタムアプリケーション機能に入力するアプリケーション名によって、 コマンド出力に表示されるアプリケーション ID が決まります。カスタムアプリケーションを追加した設定グループプロファイルの作成を参照してください。この例では、アプリケーション ID は abc です。

ここではコマンド出力が省略されます。

Device# show iox-service
IOx Infrastructure Summary:
IOx service (CAF)              : Running
IOx service (HA)               : Not Supported
IOx service (IOxman)           : Running
IOx service (Sec storage)      : Running
Libvirtd 5.5.0                 : Running
Dockerd v19.03.13-ce           : Running

Device# show app-hosting detail appid abc
App id                 : abc
Owner                  : iox
State                  : RUNNING
...

デバイスでサードパーティのカスタムアプリケーションをモニターする

始める前に

カスタムアプリケーション機能を追加した設定グループを 1 つ以上のデバイスに展開します。カスタムアプリケーション機能を追加した設定グループの展開を参照してください。

手順

ステップ 1

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

ステップ 2

SD-WAN ソリューションの対象デバイス名をクリックします。

（注）  

 

このモニタリング方法は、SD-WAN ソリューションのデバイスには適用できますが、SD-Routing ソリューションのデバイスには適用できません。

ステップ 3

[Real Time] タブをクリックします。

ステップ 4

[Device Options] フィールドに次のいずれかのアプリケーション ホスティング コマンドを入力して、デバイスで実行されているアプリケーション（サードパーティが開発したカスタムアプリケーションなど）のリソース使用状況やその他の詳細を表示します。

  • アプリケーション ホスティングの詳細

  • アプリケーション ホスティングの稼働率

  • アプリケーション ホスティング ネットワークの稼働率

  • アプリケーション ホスティング ストレージの使用率

  • アプリケーション ホスティング プロセス

  • アプリケーション ホスティングでアタッチされるデバイス

  • アプリケーション ホスティング ネットワーク インターフェイス

  • アプリケーション ホスティング ゲスト ルート

サードパーティのカスタムアプリケーションのアンインストール

サードパーティが開発したカスタムアプリケーションのアンインストールは、そのアプリケーションがインストールされていることが前提になります。サードパーティのカスタムアプリケーションとの統合の設定（概要）を参照してください。

手順

ステップ 1

設定グループからカスタムアプリケーション機能を削除します。

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

  2. [Configuration Groups] タブをクリックします。

  3. 設定グループの横にある [Actions] 列の矢印をクリックして行を展開し、アタッチされているプロファイルを表示します。

  4. [Other Profile] ドロップダウンリストの横にある鉛筆アイコンをクリックして、プロファイルを編集します。

  5. プロファイル内で、カスタムアプリケーション機能を削除します。

ステップ 2

設定グループをデバイスに展開します。カスタムアプリケーション機能を追加した設定グループの展開を参照してください。

この手順を実行すると、展開されたデバイスからカスタムアプリケーションがアンインストールされます。