Auf dieser Dokumentationsseite wird die API beschrieben, die zu verwenden ist, wenn Sie das Kennwort des Horizon Connection Server-Administrators in Ihrem Active Directory-System rotieren. In diesem Anwendungsbeispiel verwenden Sie diese API, damit Horizon Cloud Connector den neuen Wert verwendet.
Diese Funktion wird für die Verwendung mit Horizon Cloud Connector Version 2.4 und höher unterstützt.
Der Horizon Cloud Connector verwendet die Administratoranmeldedaten, die während des Onboarding- und Kopplungsvorgangs eingegeben wurden, um mit dem Horizon Connection Server zu kommunizieren.
Im Laufe der Zeit können sich diese Administratoranmeldedaten in Ihrer Active Directory-Domäne ändern, oder sie sind abgelaufen oder ungültig geworden. Wenn die Horizon Cloud Connector-Appliance nicht über die neuen Anmeldedaten informiert wird, wenn die Administratoranmeldedaten in der Active Directory-Domäne aktualisiert werden, verliert der Horizon Cloud Connector die Konnektivität mit dem Horizon Connection Server.
Wenn Sie das Administratorkennwort aktualisieren müssen, können Sie diese API verwenden, um das in der -Appliance gespeicherte Administratorkennwort so zu aktualisieren, dass es dem im Active Directory-Domänenkonto konfigurierten Wert entspricht.
-
API-Endpoint
Der Appliance-Endpoint für die Aktualisierung des gespeicherten Kennworts lautet
https://appliance-address/viewproxyadapter/local/config/rotateDabei ist appliance-address eine der folgenden Adressen:
https://IP-address/viewproxyadapter/local/config/rotate, wobeiIP-addressdie IP-Adresse der Appliance ist.https://FQDN/viewproxyadapter/local/config/rotate, wenn Sie die IP-Adresse der Appliance einem FQDN in Ihrem DNS-Server zugeordnet haben.
-
API-Methode
PUT -
Anforderungsnutzlast
Die Nutzlast erfordert den Active Directory-DNS-Domänennamen, den Kontonamen, das in der Appliance gespeicherte Kennwort (das vorherige Kennwort) und das neue Kennwort.
Setzen Sie bei den Kennwörtern jeden Buchstaben in Anführungszeichen und trennen Sie die umschlossenen Buchstaben durch Kommas. Im folgenden Beispiel lautet
abcd!efgdas in der -Appliance gespeicherte Kennwort undtuvw$xyzist das neue Kennwort.{ "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"] } -
Wenn die API aufgerufen wird
Der Horizon Cloud Connector vergleicht die vorhandenen Anmeldedaten, die Sie in der API-Nutzlast angeben, mit den in der Horizon Cloud Connector-Appliance gespeicherten Anmeldedaten.
Wenn die Validierung erfolgreich ist, versucht das System, sich mit den neuen Anmeldedaten, die in der API-Nutzlast angegeben sind, beim Horizon Connection Server anzumelden.
Wenn dieser Anmeldeversuch erfolgreich ist, laden die Dienste innerhalb der Appliance neu, um die neuen Anmeldedaten abzurufen und zu verwenden.
Hinweis: Diese API ist auf eine Anforderung pro Minute begrenzt. Wenn die Versuche den Ratengrenzwert überschreiten, wird der HTTP-Fehler 429 (Zu viele Anforderungen) zurückgegeben.
-
API-Autorisierung
Die Autorisierungsprüfung erfolgt durch den Vergleich
domainvon,userNameundoldPasswordin der Anforderungsnutzlast mit den Anmeldedaten, die Horizon Cloud Connector bekannt sind. Bei den bekannten Anmeldedaten handelt es sich entweder um diejenigen, die während des Onboarding- und Kopplungsvorgangs oder während einer vorherigen Rotation der Anmeldedaten mithilfe dieser API bereitgestellt wurden.
Voraussetzungen
Bevor Sie den API-Befehl ausgeben, überprüfen Sie die folgenden Elemente.
- Der Horizon Cloud Connector wird mit dem Horizon-Pod und dem Horizon Connection Server des Pods gekoppelt.
- Sie verfügen über den DNS-Namen der Active Directory-Domäne und die Anmeldedaten des Horizon Connection Server-Administrators.
- In Ihrer Active Directory-Domäne haben Sie das Kennwort des Horizon Connection Server-Administratorkontos auf das neue Kennwort aktualisiert, das Sie verwenden möchten.
- Sie verfügen über das zuvor verwendete Kennwort, das der Horizon Cloud Connector-Appliance, welche die Appliance derzeit verwendet, bekannt ist.
Vorgehensweise
-
Geben Sie eine
PUTan den API-Endpointhttps://appliance-address/viewproxyadapter/local/config/rotatemit der Anforderungsnutzlast aus.Im folgenden Beispiel ist
example.comdie AD-Domäne , das Konto heißtCSadmin, das vorherige Kennwort istabcd!efg, und das neue Kennwort isttuvw$xyz.{ "domain":"example.com", "userName":"CSadmin", "oldPassword":["a","b","c","d","!","e","f","g"], "newPassword":["t","u","v","w","$","x","y","z"] }Wenn die Kennwörter erfolgreich rotiert wurden, lautet die zurückgegebene Antwort .
200 success
Nächster Schritt
Um sicherzustellen, dass der Horizon Cloud Connector mithilfe des aktualisierten Kennworts eine Verbindung mit dem Horizon Connection Server herstellt, können Sie sich beim Horizon Cloud Connector-Konfigurationsportal anmelden, auf den Aktualisierungspfeil klicken und überprüfen, ob der Status des Verbindungsservers grün angezeigt wird.
War diese Seite hilfreich?