Dell開発者向けのパブリック ドキュメント
VxRail REST API(アプリケーション プログラミング インターフェイス)およびその他のDell製品の開発者向けドキュメント全文については、
Dell Developer APIを参照してください。VxRail固有のAPIをすばやく見つけるには、「ハイパーコンバージド インフラストラクチャ」でフィルタリングします。
DNSのクエリーまたはアップデートに関する具体的なドキュメントについては、「システム情報」の「DNSの取得と設定」を参照してください。
このドキュメントは、カスタムのcurlコマンドを作成したり、「postman」などのアプリケーションや経験豊富なユーザー向けの他のアプリケーションに統合したりするために使用できます。
VxRail組み込みAPIクライアント
VxRail APIを使用するための推奨される方法(REST APIにあまり詳しくないユーザーに推奨)は、ネイティブのVxRail Manager APIクライアントを活用することです
VxRailリリース7.0.350から、より優れた機能を備えたスポットライトに基づく新しいインターフェイスに移行しました
ブラウザーにVxRail Manager FQDN/IPを入力して、ネイティブAPIクライアントにアクセスします。
https://<VxRail_Manager_IP_or_FQDN>/rest/vxm/api-doc.html
たとえば、VxRail Manager IPが172.168.10.50であるため、URLは
https://172.168.10.50/rest/vxm/api-doc.html になります。
現在のVxRailクラスターDNS構成のクエリー
現在のDNS構成を照会するには、左側のパネルの[System Information]セクションにあるv1_sytem_dns_get APIを使用します。
- ダイレクトURLは https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_get されますが、バージョンによって変更される可能性があるため、UIで移動するのが最適です。
- VxRail vCenter Single Sign-On(SSO)認証情報を入力します。これは多くの場合、administrator@vsphere.localですが、ドメイン構成によって異なる場合があります。
- [要求の送信] ボタンをクリックして、GET 要求を実行します。
- APIクライアントが認証され、200 OK応答が返された場合は、要求された情報を返します。この場合、現在のDNSサーバーのラボIPは172.168.10.253で、VxRail Managerは「内部DNS」として構成されていません。つまり、お客様提供の外部DNSサーバーを使用しています。
VxRailクラスターのDNS IPサーバー情報の更新
現在のDNS構成を更新するには、左側のパネルの[System Information]セクションにあるv1_system_dns_post APIを使用します。
- ダイレクトURLは https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_post されますが、バージョンによって変更される可能性があるため、UIでナビゲートするのが最適です。
- [認証]セクションで、VxRail vCenter SSO認証情報を入力します。これは多くの場合、administrator@vsphere.localですが、ドメイン構成によって異なる場合があります。
- DNSサーバーをアップデートするには、次の3つの領域で[Body]セクションを編集します。
- 「components」セクションはオプションで、「ALL」がデフォルトです。ALLが設定されている場合は、VxRail Manager、vCenter、ESXiなど、クラスター内のすべてのDNSサーバーが置き換えられます。「VXM」が設定されている場合は、VxRail ManagerのDNSサーバーのみが置き換えられます。これは、すべてのコンポーネント構成の一貫性を保つことが推奨されるため、ユース ケースに制限されます。値「VXM」は、VCF on VxRail環境でのみサポートされていることに注意してください。
- [vCenter]セクションでは、管理者SSOのユーザー名とパスワードを渡す必要があります。通常、これは[Auth]セクションと同じ情報ですが、別の管理者レベルのSSOアカウントを指定することもできます。
- 「servers」セクションで、次の例ではDNSをIP 172.168.10.253に設定します。
- 複数の サーバーを追加する場合は、IPを「172.168.10.253,10.8.8.8」とコンマで区切る必要があります。
- [Send Request]ボタンをクリックして、POSTリクエストを実行します。
- クラスター内のESXiホストの数によっては、リクエストに数分かかる場合がありますが、リクエストが正常に完了すると、「200 OK」応答コードが返されます。
予期しない応答コードがある場合。
正常でないシステムや、ESXiホストなどから新しいDNSサーバーに到達できない場合があります。APIクライアントは、いくつかの基本的なエラー メッセージ ガイダンスを提供し、追加の応答エラー コードは、たとえば
https://restfulapi.net/http-status-codes/ が適切な場所であるなど、オンラインで見つけることができます
予期しないエラー コードが発生した場合は、それに応じてDellサポートに連絡して追加のトラブルシューティングを行います。
VxRail 8.0の初期のリリースでは、Solve Onlineの手順で、REST APIを使用したVxRail DNS IP設定のアップデートが参照されています。この機能はVxRail UIプラグインに追加されます
この記事では、VxRail REST APIを活用する経験が少ないお客様向けに、このアクティビティーに関するガイダンスと例を示します
この記事のIP情報は、一時的な仮想分離ラボからのものであり、顧客/機密IP情報は含まれません。