VMware Cloud サービスでは、REST API による管理をサポートしています。今回は、API による VMware Cloud サービスの管理において、最初のステップで必要となる「API Token」の作成方法についてご紹介します。
API Token と VMware Cloud サービス
VMware Cloud サービスは、他の VMware 製品と同様に REST API による管理をサポートしています。管理者は、これらの API を活用することによって反復的な運用タスクや複雑なオペレーションを自動化することができます（図1）。
図1 API によるクラウドサービス管理のイメージ図
API でクラウドサービスへアクセスする際、最初に必要なプロセスが認証です。VMware Cloud サービスでは、「API Token」を使用してトークンによる認可を行うことができます。REST API では、API Token を使ってセッション情報を入手する仕様になっており、VMware PowerCLI を使う場合は API Token だけで認可が完了します。
API Token の作成方法
早速、API Token の作成方法を見ていきましょう。API Token は、VMware Cloud サービスのコンソール画面で作成します。Token はアカウント単位で作成できます。はじめに、VMware Cloud サービスにログインして「マイアカウント」メニューを開きます（図1）。
図2 VMware Cloud サービスの画面サンプル
「マイアカウント」の画面に変わるので、そこから「API トークン」タブをクリックします（図2）。
図3 VMware Cloud サービス「マイアカウント」画面
画面下部の「新しい API トークンの生成」をクリックすると、Token を作成する画面に変わります（図4）。
図4 VMware Cloud サービス「API トークンの生成」画面
そこで「トークン名」を入力して「トークンの TTL」を選択します。安全性の観点から、トークンの TTL （有効期限）は必要最低限の期間で設定することをおすすめします。
同様に「範囲の定義」を設定します。この設定画面は、VMware Cloud サービスのアカウントに付与された権限によって表示される内容が変わりますが、最低限必要な範囲でアクセス権限と対象サービスを設定してください。
設定が終わったら「生成」ボタンをクリックします。直ちに Token が作成されます（図4）。尚、作成された Token は一度だけ画面に表示されますが、その後は画面上で Token 自体を取得することはできません。作成直後の Token は大切に保管してください。
図5 API トークン表示画面
作成した「トークン名」と「有効期限」は、いつでも一覧で確認できます（図5）。Token は任意のタイミングで削除ができますし、一覧から「トークン名」を選択すれば Token の再生成（更新）も可能です。
図6 作成済み API トークンの一覧
尚、Token は複数作成できますが、有効期限内であっても Token が不要になった場合は、速やかに削除することをおすすめします。
API Token を試してみる
それでは、作成した API Token を試してみましょう。ここでは、PowerCLI を組み込んだ PC から VMware Cloud on AWS へのアクセスを試してみます。PowerCLI の使用方法については、オフィシャルサイト「VMware PowerCLI」をご覧ください。
はじめに、API Token を使って VMware Cloud on AWS へ接続します。"Connect-Vmc -ApiToken" を実行して接続が成功すると、API Token を作成したユーザー名が表示されます。
次に、"Get-VmcSddc" を実行して SDDC の情報を取得してみます。SDDC の名前や作成者のユーザー名が取得できます。
取得した SDDC 名からクラスタの一覧を取得してみます。"Get-VmcSddcCluster -Sddc" を実行すると、展開済みのクラスタ名とホスト数が取得できます。
最後に接続を解除します。"Disconnect-Vmc" を実行すれば接続が解除されます。
上記コマンドは、ドキュメント「PowerCLI Reference – Getting Started with VMware Cloud on AWS cmdlets」に掲載されています。ぜひお試しください。
まとめ
今回は、VMware Cloud サービスへ REST API でアクセスするための「API Token」の作成方法についてご紹介しました。API の活用で運用の簡素化や定型化を加速し、運用負担を削減できます。是非とご活用ください！
関連情報リンク
- ブログ「VMware Cloud on AWS の REST API 管理で役立つ API Explorer」
- ブログ「VMware Cloud コンソールへのアクセス制御」
- ブログ「VMware Cloud on AWS の多要素認証 (MFA) サポート」
- ブログ「VMware {code} 〜 VMware のエキスパート向けのコミュニティサイト」
- オフィシャルサイト「VMware PowerCLI」
- ドキュメント「VMware Cloud の使用 – API トークンの生成」
- ドキュメント「Using VMware Cloud Services Console」
- ドキュメント「PowerCLI Reference – Getting Started with VMware Cloud Service cmdlets」
- ドキュメント「PowerCLI Reference – Getting Started with VMware Cloud on AWS cmdlets」
- ドキュメント「API Reference – VMware Cloud on AWS API Reference」
