■VxRail Rest APIについて
VxRail ManagerではAPIを提供しており、APIを利用してVxRailのDNSやNTPの設定変更が可能です。
VxRail ManagerのAPIに関するドキュメントはAPI User Guideというものが提供されていますが、
Dell Technologies Developer というサイトにも各製品のProduct向けのAPIガイドがあり、
VxRailもこのサイトでAPI情報を提供しているため、Developer サイトにて新しい情報が展開されております。
Dell EMC VxRail API User Guide
Explore APIs
⇒ VxRail API
実際の利用法としては、下記のURLへアクセスすることでGUIベースでのAPI利用が可能となっております。
https:// <VxRail Manager IP>/rest/vxm/api-doc.html
APIのメニューでは下記のような画面が表示されます。
画面ははDNS情報を取得するGet DNSのAPI例（オレンジ枠）です。
画面上にはそのAPIに関する情報や実際に実行するRequest（赤枠）や、
Responseコードごとの項目の説明（黄色枠）が提供されています。
またResponse結果例（紫枠）やサンプルコード（緑枠）も提供されています。
なお英語版のみとなりますがYoutubeでも動画にて利用方法についてご案内しておりますのであわせてご参照ください。
API利用方法の参考手順としてDNSの変更手順をご紹介します。
※設定変更系のAPIを利用する際は作業前にVxRail ManagerやVCSAのスナップショットをご取得しておくことを推奨いたします
■DNS変更手順例
※NTPの場合は"Get DNS" や "Set DNS" の項目を"Get NTP" と "Set NTP" のAPIに置き換えて下さい
１．VxRail REST APIのページへアクセスします。
https:// <VxRail Manager IP>/rest/vxm/api-doc.html
下記のようなVxRail REST APIのOverviewが表示されます。
VxRail Manager Serverにて正しいVxRail Manager IP が表示されていることを確認してください。
画面左側に目的ごとにAPIが区分けされております。「＞」マークを押下することで、利用可能なAPIが表示されます
DNSやNTPに関するAPIはSystem informationを展開してください
２．現在のDNSの設定を確認するため、System information > Get DNS of VxRail cluster を選択します
３． Get DNSのAPIのメニューに遷移しますので、画面右側のAuth欄に、User(administrator@vsphere.local) / password を入力し、「Send Request」を押下することでAPIを実行できます。
APIの実行結果が"Response"として表示されます。
実行結果については、「Responses」にあるレスポンスコードごとに情報がございます。
４．次にDNSの値を変更するため、System information > Set DNS of VxRail cluster を選択します
５．Set DNSのAPIのメニューに遷移しますので、IPアドレスの変更をAPIを利用して実行します
・画面右側のAuth欄に、User(administrator@vsphere.local) / password を入力
・Body欄に必要な情報を入力します。入力に関する情報は画面左側の「Body」欄に情報があります。
- components："VXM" 又は "ALL" を入力してください
※VXMはVxRail Managerの変更、ALLはVxRail Manager/VCSA/ESXi の変更 (デフォルトではALL)
- 設定するServerが一つの場合は、下記のようにServersの項目を編集します（最後の","も削除してください）
情報を入力後、「Send Request」を押下することでAPIを実行できます。
※下記Bodyの実行例は、componentsを"VRM"、serversに２つのIPアドレスを指定しているため、
VxRail Managerの設定を指定した２つのIPアドレスに変更する、といったものとなります
APIの実行結果が"Response"として表示されます。
実行結果については、「Responses」にあるレスポンスコードごとに情報がございます。
（"200 OK"と出ていれば変更が正常に完了しています）
上記でAPIを利用したVxRailのDNS設定変更が完了します
■補足
●新しいDNSサーバーでの名前解決ができるかの確認について
VxRail Managerにmysticユーザーでログインし、
digコマンドを利用することで新しいDNSサーバーで名前解決ができるか確認することが可能です。
変更前に必ずVxRail ManagerやVCSA, ESXiの名前解決ができるか確認をお願いいたします。
# dig @<DNS IP> -x <確認対象のIPアドレス> +short
# dig @<DNS IP> <確認対象のFQDN> +short
問題ない場合には以下のようにそれぞれ正逆ともに結果が返ります。
mystic@vxm-XXX:~> dig @<DNS IP> -x <確認対象のIP(例 ESXiのIP)> +short
<確認対象のFQDN(例 ESXiのFQDN)>
mystic@vxm-XXX:~> dig @<DNS IP> <確認対象のFQDN(例 ESXiのFQDN)> +short
<確認対象のIP(例 ESXiのIP)>
Revision #:
4 of 4
Last update:
07-09-2023
07:51 PM
Updated by:
