このドキュメント ページでは、Active Directory システムで Horizon Connection Server 管理者のパスワードをローテーションする場合に使用する API について説明します。この使用事例では、この API を使用して Horizon Cloud Connector で新しい値を使用します。
この機能は、Horizon Cloud Connector バージョン 2.4 以降で使用できます。
Horizon Cloud Connector は、オンボーディングおよびペアリング プロセス中に入力された管理者認証情報を使用して Horizon Connection Server と通信します。
時間の経過とともに、それらの管理者資格情報は Active Directory ドメインで変更されたり、期限切れになったり、無効になったりする可能性があります。Active Directory ドメインで管理者認証情報が更新されたときに Horizon Cloud Connector アプライアンスに新しい認証情報が通知されない場合、Horizon Cloud Connector は Horizon Connection Server との接続を失います。
管理者のパスワードを更新する必要がある場合は、この API を使用して、アプライアンスに保存されている管理者パスワードを更新し、Active Directory ドメイン アカウントで構成された値と一致させることができます。
- API エンドポイント
-
保存されたパスワードを更新するためのアプライアンス エンドポイントは、
https://appliance-address/viewproxyadapter/local/config/rotate です
ここで、appliance-address は以下のいずれかです。
- https://IP-address/viewproxyadapter/local/config/rotate。ここで、IP-address はアプライアンスの IP アドレスです。
- https://FQDN/viewproxyadapter/local/config/rotate。これは、アプライアンスの IP アドレスを DNS サーバの FQDN にマッピングした場合です。
- API メソッド
- PUT
- 要求ペイロード
-
ペイロードには、Active Directory DNS ドメイン名、アカウント名、アプライアンスに保存されているパスワード（以前のパスワード）、および新しいパスワードが必要です。
パスワードは、各文字を引用符で囲み、囲んだ文字をカンマで区切ります。以下の例では、アプライアンスに保存されているパスワードが abcd!efg で、tuvw$xyz が新しいパスワードです。
{ "domain":"AD-dns-domain-name", "userName":"admin-account-name", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] } - API が呼び出されたとき
-
Horizon Cloud Connector は、API ペイロードで指定した既存の認証情報を
Horizon Cloud Connector アプライアンスに保存されている認証情報と比較します。
検証が成功すると、システムは API ペイロードで提供された新しい認証情報を使用して Horizon Connection Server へのログインを試みます。
ログインの試行に成功すると、アプライアンス内のサービスが再ロードされ、新しい認証情報を取得して使用を開始します。
注： この API は、1 分あたり 1 回の要求にレート制限されます。試行回数がレート制限を超えると、HTTP エラー 429（要求が多すぎます）が返されます。 - API の承認
- 承認チェックは、要求ペイロードで提供された domain、 userName、および oldPassword を Horizon Cloud Connector で知られている認証情報と比較することによって行われます。既知の認証情報は、オンボーディングおよびペアリング プロセス中に提供されたものか、この API を使用した以前の認証情報のローテーション中に提供されたもののいずれかです。
前提条件
API コマンドを発行する前に、次の項目を確認します。
- Horizon Cloud Connector が、Horizon ポッドと、ポッドの Horizon Connection Server とペアリングされていること。
- Active Directory ドメインの DNS 名と Horizon Connection Server 管理者の認証情報を持っていること。
- Active Directory ドメインで、Horizon Connection Server 管理者アカウントのパスワードが使用する新しいパスワードに更新されていること。
- 以前に使用したパスワード（Horizon Cloud Connector アプライアンスが現在使用している、アプライアンスで認識された既存のパスワード）があること。
手順
- ♦要求ペイロードを使用して、API エンドポイント https://appliance-address/viewproxyadapter/local/config/rotate に PUT を発行します。
次の例では、AD ドメインは example.com、アカウントの名前は CSadmin、以前のパスワードは abcd!efg、新しいパスワードは tuvw$xyz です。
{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }パスワードが正常にローテーションされると、返される応答は 200 success になります。
