この記事では、コマンドラインインターフェース（CLI）に慣れ親しんだネットワークエンジニアの方に、API を利用したネットワーク設定・監視に関する活用方法を紹介していきたいと思います。
そもそも、SD-WAN で API ってなんぞや？という方は、以下の記事から参照頂ければと思います。
Virtual Cloud Network への途：SD-WANのUI考察 其の弐
そもそも、VMware SD-WAN ってなんぞや？という方は、以下の記事から参照頂ければと思います。
なぜ VMware SD-WAN by VeloCloud はクラウド時代の企業 WAN に最適なソリューションであるのか
背景
SD-WAN の API を使ってみるシリーズ、初回はユーザーさんから非常にご質問の多い、「SD-WAN で識別して通信制御できるアプリケーションの一覧情報について知りたい」、というご要望に切り込んでみたいと思います。SD-WAN ではユーザー通信をアプリケーション情報をもとに識別する制御方法が特徴の一つとなるため、制御可能なアプリケーション情報は重要です。一方で、SaaS やインターネット上のアプリケーション情報は常に更新されており、SD-WAN のアプリケーション識別データベースも常に更新が行われています。この観点から、一覧情報を資料としては公開しておりませんが、少し裏技的に情報を確認頂く手法をご紹介していきたいと思います。
なお、以下２つの手順については、VMware SD-WAN オーケストレーター (VCO) へのアクセス権限が必要となります。
VMware SD-WAN オーケストレーターによる確認
簡単に実施頂く方法としては、VCO の GUI から確認頂くことができます。
Configure > Edges > (Edge を指定) > Business Policy > New Rule
のように画面遷移し、以下のように実際に選択できるアプリケーションの種別をご確認いただけます。
VMware SD-WAN API による確認
今回のメイントピックです。VMware {Code}™ のウェブサイトに情報がまとまっていますので詳細はこちらも確認下さい。
VMware SD-WAN では、これまでネットワーク製品が一般的に提供してきたコマンドラインインターフェースを提供しておらず、全てVCO GUI から導入・設定・運用を実施頂くことが可能です。しかしながら、自社のシステムとも連携させて使いたい、というようなご要望にも答えられるよう REST API にも対応しています。API 周りの背景は、先にご紹介したこちらの記事におまかせして、ここでは具体的にどのようにアプリケーションのリストを確認できるかをご紹介したいと思います。
今回は Postman （https://www.postman.com/）を使った例をご紹介したいと思います。
まず最初に VCO にログインします。
POST: https://<VCO の FQDN>/portal/rest/login/enterpriseLogin
ここで認証に成功すると HTTP Response Header に Cookie がインサートされ、この Cookie 情報を認証トークンとして保持することでこのあとの各種リクエストを実行することが可能になります。このあたりも詳しくはこちらの記事を参照下さい。
利用できる API は VMware {Code} に情報がまとまっています。DPI で識別可能なアプリケーションを表示するため、 ここでは /configuration/getIdentifiableApplications を利用します。
いざ、DPI 識別可能なアプリケーションのリストをゲットします。
POST: https://<VCO の FQDN>/portal/rest/configuration/getIdentifiableApplications
VCO ログインして、API 一つ叩くだけ、と非常に簡単に見れてしまいます。返ってきた Body に情報がありますので、内容の詳細についてはぜひ実際に確認してみて下さい。ちなみに、Body の内容はコピー可能なため、他のエディタに内容をペーストしていただくことで、検索や比較など柔軟に実施頂くことができますよ。
まとめ
今回は VMware SD-WAN API の活用例の一つをご紹介しました。私も長らくネットワークエンジニアをやっていて CLI に慣れ親しんだつもりの一人ですが、最初はとっつきづらい API も使い慣れてくるとパワフルなツールなのかなと感じます。よくユーザーの皆さんから「VMware SD-WAN は CLI は無いのでしょうか？」とご質問を頂くのですが、「（CLI だったらあんな情報こんな情報も取り扱い易いのに）」と思われているのかなぁと感じることもあります。そんなときこそ API！なのかと思いますので、今後も色々な活用例を紹介していきたいと思います。シリーズ化目指して頑張りたいと思います。
注意事項
アプリケーション識別データベースは逐次情報が更新される類のものとなります。一度取得して保存しておいても実際の環境では内容が更新されている可能性もあるため、あくまで取得時点での参考情報としてお使い頂ければと思います。
参考情報
今後のオンラインセミナー実施予定などはこちらからご確認頂けます
ハンズオンラボは、VMwareの最新の製品やソリューションを、様々なシナリオに沿って、オンデマンドで利用することができます。VMware SD-WAN 入門としては以下コースがございますのでご参照下さい。
-
- HOL-2140-01-NET – VMware SD-WAN by VeloCloud – Getting Started
- HOL-2140-91-NET – VMware SD-WAN by VeloCloud – Lightining Lab
VMware SD-WAN by VeloCloud の最新情報 (英語)
VMware SD-WAN の最新情報はこちらでご紹介しております。
ヴイエムウェア営業へご連絡を希望される場合は下記URLのフォームよりお問い合わせください。
