ネットワーク SD-WAN

Virtual Cloud Network への途：SD-WANのUI考察 其の弐

2025年までには楽になろう…

SD-WAN のUI考察：其の弐

前回のBlogでは、VMware SD-WAN by VeloCloud が如何に簡易的なインターフェイスにこだわって SD-WAN のユーザーインターフェイスを作っているかのこだわりをご紹介、なおかつそのメリットを享受して様々なお客様がネットワークサービスの展開スピードの迅速化、もしくはシステムのクラウド化と効率化を進めていますよ、というお話をさせていただきました。

今回はそれを踏まえ、これまでコマンドラインインターフェイス（CLI）を介してネットワークを管理してきたネットワークエンジニアの方にお贈りする、新しいクラウド時代のネットワーク”Virtual Cloud Network”のより効率的な運用に向けて、REST API で VMware SD-WAN by VeloCloud を制御する方法についてをお届けいたします。

 

REST API と VMware SD-WAN

すでにご存知の方が多いかとは思いますが、REST とは Representational State Transfer を略した用語で、REST API とか、Restful インターフェイスなどとも呼ばれるサービスオブジェクトを作成、編集、削除するリソースとして捉えるこでアプリケーションをネットワーク経由で操作することを可能とした構造型アーキテクチャ、もしくはプロトコルを示します。

REST API のアーキテクチャを利用すると、ちょっとした開発や作り込みによって例えばこんなことができるようになります。

  • 既存の OSS/BSS システムとの統合
    • 例： Splunk:  Splunk app をカスタマイズして VeloCloud Orchestrator (VCO)から定期的にイベントログを収集し、システムの利用率を Log として Splunk へ転送して分析
  • ユーザーポータルのカスタマイズ
    • 例： VMware SD-WAN by VeloCloud のサービスプロバイダが QoS イベントを監視し、トラフィック超過時に顧客へ通知
  • カスタムレポート
    • 例： 月毎の Edge アクティベーションの状況をレポートし課金情報として流用
    • VMware SD-WAN by VeloCloud が標準的に提供しているレポーティング以外の観点から可視化、報告を実施
  • 繰り返し作業の効率化
    • 例： 繰り返し行われるファイアウォールルールポリシーやルーティングの追加、削除、変更
  • ちょっとした機能拡張
    • 例： 時間に応じたポリシーの変更：夜間帯のバックアップトラフィックの Priority 変更
  • 設定変更のオーディット
    • 例： 設定情報の収集と履歴管理

VMware SD-WAN by VeloCloud では、クラウド上で提供されているオーケストレータを REST API のリクエストターゲットとすることが可能で、各種 Create（新規作成）, Read（読み込み）, Update（更新）, Delete（削除）といった日々の運用で繰り返し必要とされる作業を GUI を介さずに効率的、自動的に実行することが可能です。

それではやってみましょう

以下に我々のデモサイトに対して Postman（https://postman.com）でアクセスする実際の手順をご紹介することで、どのような形で利用できるのか、イメージをお伝えしたいと思います。

まず、基本的なルールからですが VMware SD-WAN オーケストレータへの REST API へのリクエストパスは、全て HTTP POST で転送される仕組みで提供しています。また、VMware SD-WAN by VeloCloud をご利用中のユーザーさまは、ご利用中のオーケストレータの FQDN の以下の Base Path に対して REST API のリクエストを転送することで各種オペレーションが実現可能な実装になっています。

https://<VCOのFQDN>/portal/rest/

 

Step.1 VCO にログインする

POST https://{VCOのFQDN}/portal/rest/login/enterpriseLogin

ログインに利用可能なユーザークレデンシャルをリクエストボディに記載して API URL に POST し認証が受け入れられると、HTTP Response Header に Cookie がインサートされます。この Cookie 情報を認証トークンとして保持することでこのあとの各種リクエストを実行することが可能になります。（Cookie の有効期限は24時間）

 

Step.2　Enterprise ID（お客様 ID）を取得する

POST https://{VCOのFQDN}/portal/rest/enterprise/getEnterprise

次はEnterprise ID（お客様 ID）の情報を取得します。リクエストボディには何も記載せず、上記 API URLに POST することで自分が利用しているアカウントの Enterprise ID を取得することができます。
このサンプルでは、”VeloDemo”というカスタマー IDを利用しているのですが、”VeloDemo”のEnterprise ID は”464”であることがレスポンスからわかります。

 

Step.3 Edge ID を取得する

POST https://{VCOのFQDN}/portal/rest/enterprise/getEnterpriseEdges

次に SD-WAN Edge 固有の ID を取得します。Step.2 と同じくリクエストボディには何も記載せず、上記 API URL に POST することで“VeloDemo”サイトで管理している SD-WAN Edge の ID 一覧情報を取得することが可能です。
このサンプルでは、”VeloDemoEdge_Fussa”という Edge を利用するので、API のレスポンス情報を検索すると”VeloDemoEdge_Fussa”の ID は”2781”であることがわかります。

 

Step.4 Step２と３で得た情報を利用して Edge の設定情報を取得する

POST https://{VCOのFQDN}/portal/rest/edge/getEdgeConfigurationStack

最後にこれまで取得した情報を組み合わせて”VeloDemoEdge_Fussa”の設定情報を取得してみます。上記 API URL にリクエストを送信する際、Body 部分に”edgeId”と”enterpriseId”を投入して POST します。（書式は以下の画像を参照）

こうすることで customerID:464=”VeloDemo”のedgeID:2781=”VeloDemoEdge_Fussa”の設定情報一覧を取得することが可能となっています。

ここまで非常に基本的なオペレーションをご紹介してきましたが、もちろんもっと複雑な制御を自動化と共に実施いただくことが可能です。各種 API リファレンスや書式サンプル、投入可能な Valuable などの情報はこちらに記載がありますので、ご興味があれば見てみてください。

https://code.vmware.com/apis/926/velocloud-sdwan-vco-api

 

 

その他の使い方サンプル、日本語解説資料のご紹介

紙面の関係上、これ以上のご紹介はここでは割愛させていただきますが、もう少し詳細な日本語解説、情報取得だけではなく設定投入まで含めたユースケースのご紹介や How To についてもこちらの資料でご紹介しております。ぜひご参照ください。

VCO API を利用した情報の取得と設定の投入：VMware SD-WAN REST APIの使い方

 

また、そうは言っても VMware SD-WAN by VeloCloud を契約しないと試せないのでは？と思われた皆さま方、ご安心ください。VMwareでは “Hands-on Labs（HOL）” という無償のクラウドベースのトレーニングシステムをご提供しています。その中に VMware SD-WAN by VeloCloud のコースもございますので、そちらを受講していたいて、トレーニングマテリアルからしばし脱線しつつ、REST API の操作性も試していただければと思います。
（VMware SD-WAN by VeloCloud のHOLコース情報は記事末のお知らせ、に記載してあります。）

 

 

まとめ：

さて2回に渡ってご紹介してきました、SD-WAN の UI 考察、いかがでしたでしょうか。私個人的にもネットワーク OS や CLI の運用性といったものに一廉のこだわりがある、あった？ことは第一回の POST の冒頭でも少し触れましたが、一方でクラウドや SaaS 利用が本格化しつつある昨今、これまでと同じ運用方法では限界が見えてきているのも紛れもない事実。

そんな折り、誰でも触れる優しく簡易的な GUI で、これまでのルーターではとてもできないような複雑性や展開スピードの課題を超越し、さらなる効率化や自動化を要望されるケースには様々なプログライミング言語に流用可能な REST API による柔軟な制御を提供する、我らが VMware SD-WAN by VeloCloud。新しい仕様のネットワーク OS や CLI を新たに学習する、もしくは既存ネットワーク機器における日々のメンテナンス作業に忙殺され続ける、、、よりはよほど楽ちんな未来に近づける気が個人的にはいたしますが、皆さまおひとつ如何でしょうか？

 

〜お知らせ〜

 ※NSX-T Data Center、および VMware SD-WAN by VeloCloud について入門編から中級編まで各種セミナーも定期開催しております。
より詳細についてご興味を持っていただけたお客さまはこちらも併せてご参加をご検討ください。 

各種オンラインセミナーの開催日時はこちらから https://www.event-vmware.net/

  • VMware が提唱する Cloud をつなげるための新時代のネットワークについて概要説明を聞いたみたい！という方はこちら
    → はじめてのネットワーク仮想化セミナー 〜Virtual Cloud Network とは〜 【オンライン開催】
  • NSX-T Datacenterに関するより詳細な解説と動態デモ、デザイン、運用イメージについて説明を聞いたみたい！という方はこちら
    → ネットワーク仮想化セミナー 〜NSX データセンター編〜 【オンライン開催】
  • VMware SD-WANに関するより詳細な解説と動態デモ、デザイン、運用イメージについて説明を聞いたみたい！という方はこちら
    → ネットワーク仮想化セミナー 〜VMware SD-WAN 編〜【オンライン開催】 

 ※VMwareでは、各種製品をクラウド上でご評価いただくHands-on Labs（HOL） という仕組みを無償でご提供しています。
今回ご紹介した各種ソリューションへの最初の一歩の入り口としてぜひご活用ください。

おすすめのHOLメニューはこちらから ( http://labs.hol.vmware.com/HOL/catalogs/catalog/1212 )

  • HOL-2040-91-NET – Getting Started with VeloCloud Lightning lab
  • HOL-2026-01-NET – VMware NSX-T: Getting Started
  • HOL-2026-91-NET – VMware NSX-T Distributed Firewalling Lightning Lab
  • HOL-2037-01-NET – VMware NSX Advanced Load Balancer (Avi Networks) – Getting Started
  • HOL-2002-02-CMP – Network Insight and vRealize Network Insight – Getting Started 

 

 

 

 

関連記事