このドキュメント ページでは、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、およびoldPasswordHorizon 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を発行します。次の例では、Active Directory ドメインは
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になります。
次のタスク
Horizon Cloud Connector が更新されたパスワードを使用して Horizon Connection Server に接続していることを確認するには、Horizon Cloud Connector 構成ポータルにログインし、更新矢印をクリックして、Connection Server のステータスが緑色で表示されることを確認します。
このページは役に立ちましたか?