VMware環境向けに使用するPostmanの使い方

VMware環境向けに使用するPostmanの使い方

Postmanは、業界内でもユーザー屈指のAPI関連ツールです。

VMware製品トレーニングでも徐々に登場回数も増えてきたので、自分自身の復習や受講者様への参考資料も兼ねて本記事を準備してみました。

Postmanとは

公式サイト上の説明は次の通りです。

PostmanはAPIを構築し利用するためのAPIプラットフォームです。PostmanはAPIライフサイクルの各ステップを簡素化し、コラボレーションを合理化することで、より良いAPIをより早く作成できるようにします。

上述の通り、APIを使用した操作を行うためのインターフェイスとしてPostmanは活用出来ます。

本記事ではVMware製品で用意されているAPIを、Postmanを経由して実行をする方法をご紹介します。
なおPostmanが持つ機能はほかにもあると思いますが、今回の焦点はあくまでVMware環境でのPostmanの活用ですので、それ以外については触れません。ご容赦ください。

Postmanの使い方

今回は、VMware Hands on Labの環境内で既に準備されたPostmanを使用して図解を行います。

今回使用するHands on Labは、”VMware NSX-T Networking Fundamentals”です。

他のラボにもPostmanがインストールされている場合はそちらを使用してもよいです。

まず、PostmanはWindowsにインストール済みです。(タスクバーからも起動は可能です)

Postman起動後、次のような画面が表示されます。
Hands on Lab内ではいくつかの”コレクション”と呼ばれる命令セットが定義済みです。

コレクションにはクレデンシャル(ログインユーザー名とパスワード)と変数(リクエストで使用可能)が設定されています。
リクエストでは、命令(情報取得のためのGET、設定のためのPOST)が設定されています。

コレクションで定義された変数を確認している様子です。
各命令では、{{nsx_url}}と指定すると”https://nsxmgr-01a.corp.local”を代入してくれます。
変数を活用することで長いURLを毎回入力する手間が省けて効率が良いです。

下図内では、変数を使用した命令(上の行)、変数を使用しない命令(下の行)を掲示しています。
どちらで命令を行っても同じ結果が得られます。

Postmanで命令を実行する前の様子です。

GET命令では、情報の取得が可能です。”Send”をクリックすることで、NSX Managerに対してEdge Clusterの情報を取得するよう命令を送ることが出来ます。

Postmanで命令後の様子です。下図赤枠内にNSX Managerから取得した情報が表示されました。

上記で取得をしたデータをNSX Manager上の表示データと対比した様子がこちらです。

POST命令では、製品に対する設定が可能です。
下図では構成済みのNSX Edge2台(edgenode-03a及びedgenode-04a)を使用して、新しいNSX Edge Clusterを構成するという命令を実行します。現在は上記2台はClusterに組み込まれていないため、Cluster名の箇所が空欄ｄす。

命令実行後の様子
新規にEdge Clusterが作成されました。Postman上でのCluster IDがNSX UI上のCluster IDと一致していることが確認出来ます。

上記のように、Postmanを使用することでAPIを使用し管理タスクを行えることが確認出来ました。
勿論今回使用した構成済みの2種類以外に、新規で自分で設定をした命令をVMware Hands on Lab上で実行することも可能です。

今回はVMware製品をベースに開設をしましたが、Postmanを使用して他の製品にAPI命令を送ることは出来るので是非応用されてみてください。

関連URLまとめ