Developer Center は、API 構造を管理するツールや、この構造を実行可能コードに変換するユーザー アクションを取得するツールを提供する開発者の窓口となります。

vSphere Client Developer Center には、自動化のエキスパート、DevOps エンジニア、開発者向けに、API 構造を管理したり、この構造を PowerCLI に変換する vSphere Client アクションを取得するリソースを探すためのさまざまな手段が用意されています。

vSphere API Explorer について

API Explorer を使用すると、システムでサポートされている vSphere REST API を参照して呼び出したり、API 呼び出しに関する情報やコンテキストを表示できます。

API Explorer では、環境内の API エンドポイントを選択して vSphere REST API のリストを取得できます。使用可能なパラメータ、予想される応答、応答状態コードなどの詳細を確認して、実際の環境に API を呼び出すことができます。使用可能な API は、選択したエンドポイントのロールによって異なります。

vSphere API Explorer を使用して API を取得する方法

API Explorer を使用すると、選択したエンドポイントから使用可能な vSphere REST API を取得して、API 呼び出しに関する情報やコンテキストを受け取ることができます。

手順

  1. vSphere Client のホーム ページで [ デベロッパー センター] をクリックし、[API Explorer] タブを選択します。
  2. [エンドポイントを選択] ドロップダウン メニューで、使用環境のエンドポイントを選択します。
  3. [API を選択] ドロップダウン メニューで、API を選択します。表示される API は、vCenter Server で API Explorer によって公開されたものです。
  4. （オプション） フィルタ テキスト ボックスにテキストを入力すると、結果をフィルタリングできます。たとえば、health と入力すると、選択した API の健全性の監視に関連するメソッドのリストが表示されます。
  5. リストから API カテゴリを選択します。
  6. リストからメソッドを選択します。
    廃止された API を確認するには、リストの各メソッドの横にある切り替えボタンを使用します。廃止された API を使用しないでください。廃止された API は、今後応答しなくなる可能性があります。また、自動化スクリプトで予期しないエラーが発生する可能性があります。
    メソッドの詳細情報が表示されます。
  7. 選択したメソッドのパラメータの詳細に関するセクションが表示される場合は、[Value] テキスト ボックスにメソッド パラメータ値を入力します。
  8. （オプション） ライブ環境に対してメソッドを呼び出すには、[実行] をクリックします。
    1. 警告ダイアログ ボックスが表示された場合は、[Yes] をクリックします。
    呼び出したメソッドの結果が応答ボックスに表示されます。
  9. （オプション） 呼び出したメソッドの結果をクリップボードにコピーするには、[応答 をコピー] をクリックします。
  10. （オプション） 呼び出したメソッドの結果をダウンロードするには、[ダウンロード] をクリックします。

vSphere コード キャプチャについて

コード キャプチャは、ユーザーのアクションを記録して実行可能なコードに変換します。

コード キャプチャは、 vSphere Client で実行されるアクションを記録して、使用可能な PowerCLI コードとして出力する機能を備えてます。コードをコピーまたはスクリプトとしてダウンロードし、PowerShell セッションで使用してタスクを実行します。
注： vCenter Server の呼び出しのみが記録されます。ロール、権限、タグ、コンテンツ ライブラリ、およびストレージ ポリシーに関する操作での呼び出しは記録されません。

vSphere コード キャプチャを使用してアクションを記録する方法

コード キャプチャを使用すると、vSphere Client で実行されたアクションを記録して、PowerCLI コードの出力を生成できます。

注： ロール、権限、タグ、コンテンツ ライブラリ、およびストレージ ポリシーに関する操作での呼び出しは記録されません。パスワードなどの機密データも記録されません。

前提条件

コード キャプチャを使用してセッションを記録するには、まずコード キャプチャを有効にする必要があります。

手順

  1. ホームのサイドバー メニューで、[Developer Center] をクリックして [コードのキャプチャ] タブに移動します。
  2. （オプション） コード キャプチャが有効でない場合は、コード キャプチャをクリックして有効にします。
  3. 記録を開始するには、該当のペインに移動して上部のペインにある赤色のレコード ボタンをクリックします。すぐに記録を開始するには、[記録の開始] をクリックします。
    記録の進行中は、上部のペインにある赤色のレコード ボタンが点滅します。
  4. （オプション） 前のセッションでキャプチャされたコードを消去して新しいセッションの記録を開始するには、[消去して別の記録を開始] をクリックします。
  5. 記録を停止するには、上部のペインにある赤色のレコード ボタンをクリックするか、Developer Center の [コードのキャプチャ] タブに移動して [記録の停止] をクリックします。
    記録されたコードは、コード ペインに表示されます。
  6. （オプション） [コピー] をクリックしてコードをコピーするか、[ダウンロード] をクリックしてコードを PowerCLI スクリプトとしてダウンロードします。
  7. 現在のコードを消去して別の記録を開始するには、[消去して別の記録を開始] をクリックするか、該当のペインに移動して上部のペインにある赤色のレコード ボタンをクリックします。

結果

記録されたコードは、コード ペインに表示されます。コードをコピーまたはダウンロードするか、コードを消去して別の記録を開始することができます。