Ab Horizon 8 2406 können Sie Horizon Lifecycle Management-APIs (LCM) verwenden, um Installationen von Omnissa Horizon Connection Server- und Registrierungsserver-Instanzen zu automatisieren und zu vereinfachen. Diese Seite enthält allgemeine Beispiele für LCM-API-Anforderungen, mit denen Sie einen automatisierten Installations- oder Upgrade-Workflow implementieren können.
Informationen zu den LCM-APIs
Die LCM-APIs sind ein Teil der Horizon Server-APIs. Weitere Informationen finden Sie in der Dokumentation auf https://developer.omnissa.com:
-
Im Horizon Server API-Einführungshandbuch wird erläutert, wie APIs mithilfe des Basis-URL-Pfads von Horizon Connection Server aufgerufen werden.
-
Das Dokument LCM REST-APIs enthält Richtlinien für die Verwendung der LCM-APIs.
-
Die Horizon Server-API-Referenz bietet vollständige Referenzinformationen für jede API.
Verwenden von LCM-APIs in einem Terraform-Framework
Omnissa hat auch einen Terraform-Anbieter für Horizon 8 entwickelt. Sie können die LCM-APIs mit diesem Terraform-Anbieter verwenden, um das Lebenszyklusmanagement Ihrer Horizon 8-Bereitstellungen zu automatisieren.
Die Standardvoraussetzungen gelten, wenn die LCM-APIs mit dem Terraform-Anbieter verwendet werden.
Sie finden den Terraform-Anbieter für Horizon 8 unter https://github.com/euc-dev/horizon-terraform.
Voraussetzungen
Bevor Sie die LCM-APIs verwenden, müssen Sie die folgenden aufgeführten Voraussetzungen erfüllen. In den Abschnitten dieser Seite finden Sie Einzelheiten zu den einzelnen Voraussetzungen.
- Horizon Connection Server Version 2406 oder höher
- Konfigurieren von WinRM
- Vorbereiten einer Hosting-Methode
- Zuweisen eines Administratorkontos zum Aufrufen von LCM-APIs
- Konfigurieren eines Verbindungsserver-Hosts zum Einstufen einer Drittanbieter-Zertifizierungsstelle als vertrauenswürdig (sofern erforderlich)
Version 2406 oder höher
Installieren Sie mindestens eine Instanz von Horizon Connection Server 2406 oder höher oder führen Sie ein Upgrade auf diese Instanz durch. Die LCM-APIs sind erst ab Version 2406 auf dem Horizon Connection Server verfügbar.
Hinweis: Für eine neue Horizon 8-Bereitstellung können Sie ein Befehlszeilenskript verwenden, um die Erstinstallation von Horizon Connection Server zu automatisieren, und dann die LCM-APIs für nachfolgende Installationen verwenden.
Konfigurieren von WinRM
Konfigurieren Sie WinRM auf diesen Komponenten:
- Horizon Connection Server-Hostmaschine, von der aus Sie die LCM-APIs aufrufen
- Jede Zielmaschine, auf der Sie eine automatisierte Installation oder ein automatisiertes Upgrade durchführen
Vorbereiten einer eine Hosting-Methode
Bereiten Sie eine der folgenden Hosting-Methoden vor:
SMB-Dateifreigabe
Ab Version 2503 unterstützen die LCM REST-APIs SMB-Datei-URLs für die Registrierung von Verbindungsserver-Build-Paketen. Auf diese Weise können Administratoren Build-Dateien auf SMB-Freigaben hosten und sie mithilfe des fileUrl-Parameters registrieren.
Voraussetzungen für die Verwendung von SMB-Datei-URLs:
- Format der Datei-URL: Verwenden Sie das
smb://-Präfix imfileUrl-Parameter. Bei einer EXE-Datei mit dem NamenOmnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225wäre dasfileUrl-Parameterformat beispielsweisesmb://smb-share/share-name/Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe(wobeismb-share/share-namedie eindeutigen Informationen Ihrer SMB-Freigabe sind). - Zugriffsberechtigungen: Sowohl das Maschinenkonto der Verbindungsservermaschine als auch das LCM-Benutzerkonto müssen über Lesezugriff auf die SMB-Freigabe verfügen.
- Maschinenkonto: Dies ist das Konto, das die Maschine darstellt, von der die API aufgerufen wird. Es wird dargestellt als
DOMAIN\MACHINE$(z. B.example.com\CS$für eine Maschine mit dem Namen „CS“ in derexample.com-Domäne). - LCM-Benutzerkonto: Dies ist das Konto, das zum Aufrufen der LCM REST APIs verwendet wird.
So gewähren Sie die Lesezugriffsberechtigung für die Konten:
- Öffnen Sie die Eigenschaften der SMB-Freigabe (Eigenschaften) und navigieren Sie zu Sicherheit und Bearbeiten, um die Berechtigungen zu ändern.
- Fügen Sie das Maschinenkonto (z. B.
example.com\CS$) und das LCM-Benutzerkonto (z. B.example.com\LCMUser) hinzu. - Weisen Sie beiden Konten Leseberechtigungen zu und speichern Sie die Änderungen an den Eigenschaften (Übernehmen und OK).
Um dann die SMB-Dateifreigabe zum Hosten des Server-Build-Installationsprogramms und der LCM-Paketdatei zu verwenden, bereiten Sie die SMB-Dateifreigabe wie folgt vor:
- Laden Sie das .exe-Installationsprogramm für den Server und die Horizon Lifecycle Manager-Paketdatei (lcm.zip) von Omnissa Customer Connect herunter.
- Platzieren Sie das .exe-Installationsprogramm und lcm.zip zusammen im selben Verzeichnis auf der SMB-Dateifreigabe.
Webserver
Um einen Webserver zum Hosten des Server-Build-Installationsprogramms und der LCM-Paketdatei zu verwenden, bereiten Sie den Webserver wie folgt vor:
- Laden Sie das .exe-Installationsprogramm für den Server und die Horizon Lifecycle Manager-Paketdatei (lcm.zip) von Omnissa Customer Connect herunter.
- Platzieren Sie das .exe-Installationsprogramm und lcm.zip zusammen im selben Verzeichnis auf dem Host-Webserver.
Horizon Connection Server-Host
Um einen Horizon Connection Server zum Hosten des Server-Build-Installationsprogramms und der LCM-Paketdatei zu verwenden, bereiten Sie den Horizon Connection Server-Host wie folgt vor:
- Konfigurieren Sie den Serverhost bei Bedarf so, dass er einer Zertifizierungsstelle eines Drittanbieters im Trust Store vertraut.
- Laden Sie das .exe-Installationsprogramm für den Server und die Horizon Lifecycle Manager-Paketdatei (lcm.zip) von Omnissa Customer Connect herunter.
- Platzieren Sie das .exe-Installationsprogramm und lcm.zip zusammen im selben Verzeichnis auf dem Serverhost.
Zuweisen eines Administratorkontos zum Aufrufen von LCM-APIs
Weisen Sie das Horizon-Administratorkonto zu, das Sie zum Aufrufen der LCM-APIs verwenden werden. Stellen Sie sicher, dass dieses Konto zur lokalen Administratorgruppe auf jeder Zielmaschine gehört, die die Installation bzw. das Upgrade erhalten soll.
Vor dem Upgrade
Deaktivieren Sie vor der Durchführung eines Upgrades die Horizon Connection Server-Zielinstanzen. Nach Abschluss des Upgrades müssen Sie jede Horizon Connection Server-Instanz aktivieren, um sie wieder für die Verwendung zur Verfügung zu stellen.
Konfigurieren Sie bei Bedarf einen Serverhost, um eine Drittanbieter-Zertifizierungsstelle als vertrauenswürdig einzustufen
Konfigurieren Sie unter Befolgen des nachstehenden Verfahrens einen Horizon Connection Server-Host bei Bedarf so, dass er einer Zertifizierungsstelle eines Drittanbieters im Trust Store vertraut.
-
Öffnen Sie die Eingabeaufforderung (
cmd) als Administrator. -
Navigieren Sie zum Java-Verzeichnis bin, z. B.:
cd "C:\Program Files\Omnissa\Horizon\Server\jre\bin" -
Führen Sie den Befehl
keytoolaus, um das Zertifikat in das Trust Store zu importieren:keytool -trustcacerts -keystore "C:\Program Files\Omnissa\Horizon\Server\jre\lib\security\cacerts" -storepass changeit -importcert -alias {YOUR_ALIAS} -file {YOUR_CRT_FILE}Ersetzen Sie {YOUR_ALIAS} durch einen eindeutigen Alias für das Zertifikat (z. B.
MyCertAlias).Ersetzen Sie {YOUR_CRT_FILE} durch den vollständigen Pfad zu Ihrer Zertifikatsdatei (z. B.
C:\path\to\certificate.crt). -
Wenn Sie dazu aufgefordert werden, geben Sie
yesein und drücken Sie die Eingabetaste, um den Import des Zertifikats zu bestätigen und abzuschließen. -
Öffnen Sie
services.mscund starten Sie alle aufgelisteten Omnissa Horizon-Komponenten neu, um die Zertifikatsänderungen anzuwenden.Alternativ können Sie den Server neu starten, damit die Änderungen wirksam werden.
Workflowbeispiele
In den folgenden Abschnitten werden Beispiele für LCM-API-Anforderungen veranschaulicht, die in einem typischen Installations- oder Upgrade-Workflow verwendet werden.
1. Erstellen und Zuweisen von LCM-Berechtigungen
Um LCM-APIs auszuführen, müssen Sie die LCM_MANAGEMENT-Rolle erstellen und diese Rolle dem vorgesehenen Benutzerkonto zuweisen.
Erstellen Sie die LCM_MANAGEMENT-Rolle:
[POST] /config/v1/roles
{
"description": "Custom LCM role.",
"name": "LCM",
"privileges": [
"LCM_MANAGEMENT"
]
}
Weisen Sie dem vorgesehenen Konto die LCM_MANAGEMENT-Rolle zu:
[POST] /config/v1/permissions
[
{
"userOrGroup": "UserOrGroup/Uy0xLTUtMjEtMjMzNzczOTMxMC0yNjQ3NjI3MzY0LTE3NzczMzI0NzktNTAw",
"role": "Role/NmU4MjgwMmYtMDc4Yi00NGI0LWJiYmEtNGU1MWIxYzNhZWRj/TENN",
"accessGroup": "AccessGroup/NmU4MjgwMmYtMDc4Yi00NGI0LWJiYmEtNGU1MWIxYzNhZWRj/Um9vdA"
}
]
Hinweis: Sie können auch die LCM_VIEW-Rolle erstellen und Benutzerkonten zuweisen, die nur Statusinformationen für LCM-Workflows abrufen müssen. Benutzer mit LCM_VIEW-Rechten haben schreibgeschützten Zugriff und können keine POST-Anforderungen stellen.
2. Registrieren des Installer-Builds
Benutzer mit der Rolle LCM_MANAGEMENT können den Server-Build registrieren, der auf den Zielmaschinen installiert wird.
Hinweis: Wenn Sie ein Upgrade auf eine höhere Horizon 8-Version durchführen, müssen Sie den neuen Server-Build für diese neuere Version erneut registrieren.
- Geben Sie für den Anforderungsparameter die Datei-URL des .exe-Build-Installationsprogramms am Hosting-Speicherort an. Stellen Sie sicher, dass sich die Horizon Lifecycle Manager-Paketdatei (lcm.zip) im selben Verzeichnis wie das .exe-Build-Installationsprogramm befindet, wie unter Voraussetzungen beschrieben.
- Fügen Sie für den Anforderungstext die Build-Metadaten hinzu.
Hinweis: In den folgenden Beispielen sind die EXE-Dateien spezifische Build-Dateien des Horizon Connection Server-Installationsprogramms und die Angaben in geschweiften Klammern ({}) stellen Werte dar, die Sie aus Ihrem spezifischen Setup bereitstellen. Wenn Sie diese Befehle in Ihrer Bereitstellung ausführen, ersetzen Sie den Namen der angegebenen Installationsdatei sowie Ihre spezifischen Informationen zur SMB-Freigabe und zum Webserver.
Beispiel: SMB-Freigabe
[POST] /rest/config/v1/server-installer-packages/action/register?fileUrl=smb://{smb-share}/{share-name}/Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe
{
"file_size_in_bytes": 401860608,
"version": "8.15.0",
"checksum": "d814d56a30477d07e8128a18c5ec09ba38984129f40911ad332e96c143e4fabb",
"build_number": "13513405225",
"filename": "Omnissa-Horizon-Connection-Server-x86_64-2503-8.15.0-13513405225.exe",
"display_Name": "Omnissa Horizon Connection Server"
}
Beispiel: Webserver
[POST] /config/v1/server-installer-packages/action/register?fileUrl=https://{local-webserver}/installer/Omnissa-Horizon-Connection-Server-x86_64-2406-8.13.0-8565949332.exe
{
"build_number": "8565949332",
"checksum": "d2f31e1bc6de212f11a34b502ec16d66d5bf896947de3288a337c10df8c5be67",
"display_name": "Omnissa Horizon Connection Server",
"file_size_in_bytes": 365891976,
"filename": "Omnissa-Horizon-Connection-Server-x86_64-8.13.0-8565949332.exe",
"version": "2406"
}
Bei Erfolg gibt die Registrierungs-API die eindeutige server_installer_package_id des registrierten Installationspakets zurück.
Sie können auch die folgenden LCM-APIs verwenden, um andere Registrierungsaufgaben durchzuführen. Detaillierte Informationen finden Sie auf der Referenzseite für jede API.
| Aufgabe | API |
| Liste aller registrierten Installationsprogramm-Builds abrufen | [GET] /config/v1/server-installer-packages |
| Metadaten für den Installationsprogramm-Build mit der angegebenen ID (server_installer_package_id) abrufen | [GET] /config/v1/server-installer-packages/{id} |
| Registrierung des Installationsprogramm-Builds mit der angegebenen ID (server_installer_package_id) aufheben | [POST] /config/v1/server-installer-packages/{id}/action/unregister |
3. Überprüfen der Installationsvoraussetzungen auf der Zielmaschine
Mit Vorabprüfungs-APIs können Sie überprüfen, ob Zielmaschinen die entsprechenden Anforderungen erfüllen. Stellen Sie sicher, dass Sie positive Antworten auf die folgenden Vorabprüfungsanforderungen erhalten, bevor Sie Installationsbefehle aufrufen.
Systemvoraussetzungen für die Zielmaschine überprüfen:
[POST] /config/v1/connection-servers/action/validate-system-requirements
Active Directory-Voraussetzungen für die Zielmaschine überprüfen:
[POST] /config/v1/connection-servers/action/validate-ad-requirements
vCenter Server-Voraussetzungen für die Zielmaschine überprüfen:
[POST] /config/v1/connection-servers/action/validate-virtual-center-requirements
Überprüfen Sie den Replizierungsstatus des Schemamasters und des Servers für die zu aktualisierende Zielmaschine:
[POST] /config/v1/connection-servers/action/validate-ldap-requirements
4. Ausführen des Installationsbefehls
Nach der Überprüfung der Voraussetzungen für die Zielmaschinen können Sie die Installations- oder Upgrade-API aufrufen.
Fügen Sie die folgenden Elemente zum Anforderungstext hinzu:
| Schlüssel | Wert/Beschreibung |
| domain | Name der Active Directory-Domäne |
| server_installer_package_id | Server-Build-ID, die in der Antwort der Build-Registrierungs-API angegeben wurde |
| target_server_fqdn | Vollqualifizierter Domänenname (FQDN) auf der Zielmaschine |
| user_name | Name des Benutzerkontos, das zum Planen der Installation/des Upgrades auf der Zielmaschine verwendet wird. Der Benutzer muss über Horizon Administrator-Rechte verfügen und der lokalen Administratorgruppe der Zielmaschine angehören. |
| Kennwort | Kennwort des Benutzerkontos, das zum Planen der Installation/des Upgrades auf der Zielmaschine verwendet wird |
| server_msi_install_spec | Angegebene Installationsoptionen, nur für Installationsanforderungen erforderlich. Vollständige Informationen finden Sie im Abschnitt „Schema“ der Referenz [POST] /config/v1/connection-servers/action/install-connection-server. |
Aktualisieren Sie den Server-Build auf der Zielmaschine:
[POST] /config/v1/connection-servers/action/upgrade-connection-server
{
"domain": "AD-TEST-DOMAIN",
"password": "<password>",
"server_installer_package_id": "a3768752-77c6-45d0-8e20-908227bce79f",
"target_server_fqdn": "server.example.com",
"user_name": "Administrator"
}
Installieren Sie den Server-Build auf der Zielmaschine:
[POST] /config/v1/connection-servers/action/install-connection-server
{
"domain": "AD-TEST-DOMAIN",
"password": "<password>",
"server_installer_package_id": "a3768752-77c6-45d0-8e20-908227bce79f",
"server_msi_install_spec": {
"admin_sid": "string",
"deployment_type": "GENERAL",
"fips_enabled": false,
"fw_choice": true,
"html_access": true,
"install_directory": "%ProgramFiles%\\Omnissa\\Horizon\\Server",
"primary_connection_server_fqdn": "server.example.com",
"server_instance_type": "STANDARD_SERVER",
"server_recovery_pwd": "<password>",
"server_recovery_pwd_reminder": "<reminder>",
"vdm_ipprotocol_usage": "IPv4"
},
"target_server_fqdn": "server.example.com",
"user_name": "Administrator"
}
Überwachen des Installations-/Upgradeauftrags
Nach dem Planen eines Installations- oder Upgrade-Auftrags auf einer Zielmaschine können Sie den Auftragsstatus mit der folgenden Anforderung überprüfen. Nehmen Sie den FQDN der Zielmaschine als Anforderungsparameter auf.
[POST] /config/v1/connection-servers/action/retrieve-installer-status?{fqdn}
War diese Seite hilfreich?